Movatterモバイル変換


[0]ホーム

URL:


adsensehost

package
v0.257.0Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 2, 2025 License:BSD-3-ClauseImports:18Imported by:0

Details

Repository

github.com/googleapis/google-api-go-client

Links

Documentation

Overview

Package adsensehost provides access to the AdSense Host API.

For product documentation, see:https://developers.google.com/adsense/host/

Library status

These client libraries are officially supported by Google. However, thislibrary is considered complete and is in maintenance mode. This meansthat we will address critical bugs and security issues but will not addany new features.

When possible, we recommend using our newer[Cloud Client Libraries for Go](https://pkg.go.dev/cloud.google.com/go)that are still actively being worked and iterated on.

Creating a client

Usage example:

import "google.golang.org/api/adsensehost/v4.1"...ctx := context.Background()adsensehostService, err := adsensehost.NewService(ctx)

In this example, Google Application Default Credentials are used forauthentication. For information on how to create and obtain ApplicationDefault Credentials, seehttps://developers.google.com/identity/protocols/application-default-credentials.

Other authentication options

To use an API key for authentication (note: some APIs do not support APIkeys), usegoogle.golang.org/api/option.WithAPIKey:

adsensehostService, err := adsensehost.NewService(ctx, option.WithAPIKey("AIza..."))

To use an OAuth token (e.g., a user token obtained via a three-legged OAuthflow, usegoogle.golang.org/api/option.WithTokenSource:

config := &oauth2.Config{...}// ...token, err := config.Exchange(ctx, ...)adsensehostService, err := adsensehost.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))

Seegoogle.golang.org/api/option.ClientOption for details on options.

Index

Constants

View Source
const (// View and manage your AdSense host data and associated accountsAdsensehostScope = "https://www.googleapis.com/auth/adsensehost")

OAuth2 scopes used by this API.

Variables

This section is empty.

Functions

This section is empty.

Types

typeAccount

type Account struct {// Id: Unique identifier of this account.Idstring `json:"id,omitempty"`// Kind: Kind of resource this is, in this case adsensehost#account.Kindstring `json:"kind,omitempty"`// Name: Name of this account.Namestring `json:"name,omitempty"`// Status: Approval status of this account. One of: PENDING, APPROVED,// DISABLED.Statusstring `json:"status,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "Id") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Id") to include in API requests// with the JSON null value. By default, fields with empty values are omitted// from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (Account)MarshalJSON

func (sAccount) MarshalJSON() ([]byte,error)

typeAccounts

type Accounts struct {// Etag: ETag of this response for caching purposes.Etagstring `json:"etag,omitempty"`// Items: The accounts returned in this list response.Items []*Account `json:"items,omitempty"`// Kind: Kind of list this is, in this case adsensehost#accounts.Kindstring `json:"kind,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "Etag") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Etag") to include in API requests// with the JSON null value. By default, fields with empty values are omitted// from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (Accounts)MarshalJSON

func (sAccounts) MarshalJSON() ([]byte,error)

typeAccountsAdclientsGetCall

type AccountsAdclientsGetCall struct {// contains filtered or unexported fields}

func (*AccountsAdclientsGetCall)Context

Context sets the context to be used in this call's Do method.

func (*AccountsAdclientsGetCall)Do

Do executes the "adsensehost.accounts.adclients.get" call.Any non-2xx status code is an error. Response headers are in either*AdClient.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*AccountsAdclientsGetCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*AccountsAdclientsGetCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*AccountsAdclientsGetCall)IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

typeAccountsAdclientsListCall

type AccountsAdclientsListCall struct {// contains filtered or unexported fields}

func (*AccountsAdclientsListCall)Context

Context sets the context to be used in this call's Do method.

func (*AccountsAdclientsListCall)Do

Do executes the "adsensehost.accounts.adclients.list" call.Any non-2xx status code is an error. Response headers are in either*AdClients.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*AccountsAdclientsListCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*AccountsAdclientsListCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*AccountsAdclientsListCall)IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

func (*AccountsAdclientsListCall)MaxResults

MaxResults sets the optional parameter "maxResults": The maximum number ofad clients to include in the response, used for paging.

func (*AccountsAdclientsListCall)PageToken

PageToken sets the optional parameter "pageToken": A continuation token,used to page through ad clients. To retrieve the next page, set thisparameter to the value of "nextPageToken" from the previous response.

func (*AccountsAdclientsListCall)Pages

Pages invokes f for each page of results.A non-nil error returned from f will halt the iteration.The provided context supersedes any context provided to the Context method.

typeAccountsAdclientsService

type AccountsAdclientsService struct {// contains filtered or unexported fields}

funcNewAccountsAdclientsService

func NewAccountsAdclientsService(s *Service) *AccountsAdclientsService

func (*AccountsAdclientsService)Get

Get: Get information about one of the ad clients in the specifiedpublisher's AdSense account.

- accountId: Account which contains the ad client.- adClientId: Ad client to get.

func (*AccountsAdclientsService)List

List: List all hosted ad clients in the specified hosted account.

- accountId: Account for which to list ad clients.

typeAccountsAdunitsDeleteCall

type AccountsAdunitsDeleteCall struct {// contains filtered or unexported fields}

func (*AccountsAdunitsDeleteCall)Context

Context sets the context to be used in this call's Do method.

func (*AccountsAdunitsDeleteCall)Do

Do executes the "adsensehost.accounts.adunits.delete" call.Any non-2xx status code is an error. Response headers are in either*AdUnit.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*AccountsAdunitsDeleteCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*AccountsAdunitsDeleteCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeAccountsAdunitsGetAdCodeCall

type AccountsAdunitsGetAdCodeCall struct {// contains filtered or unexported fields}

func (*AccountsAdunitsGetAdCodeCall)Context

Context sets the context to be used in this call's Do method.

func (*AccountsAdunitsGetAdCodeCall)Do

Do executes the "adsensehost.accounts.adunits.getAdCode" call.Any non-2xx status code is an error. Response headers are in either*AdCode.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*AccountsAdunitsGetAdCodeCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*AccountsAdunitsGetAdCodeCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*AccountsAdunitsGetAdCodeCall)HostCustomChannelId

func (c *AccountsAdunitsGetAdCodeCall) HostCustomChannelId(hostCustomChannelId ...string) *AccountsAdunitsGetAdCodeCall

HostCustomChannelId sets the optional parameter "hostCustomChannelId": Hostcustom channel to attach to the ad code.

func (*AccountsAdunitsGetAdCodeCall)IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

typeAccountsAdunitsGetCall

type AccountsAdunitsGetCall struct {// contains filtered or unexported fields}

func (*AccountsAdunitsGetCall)Context

Context sets the context to be used in this call's Do method.

func (*AccountsAdunitsGetCall)Do

Do executes the "adsensehost.accounts.adunits.get" call.Any non-2xx status code is an error. Response headers are in either*AdUnit.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*AccountsAdunitsGetCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*AccountsAdunitsGetCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*AccountsAdunitsGetCall)IfNoneMatch

func (c *AccountsAdunitsGetCall) IfNoneMatch(entityTagstring) *AccountsAdunitsGetCall

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

typeAccountsAdunitsInsertCall

type AccountsAdunitsInsertCall struct {// contains filtered or unexported fields}

func (*AccountsAdunitsInsertCall)Context

Context sets the context to be used in this call's Do method.

func (*AccountsAdunitsInsertCall)Do

Do executes the "adsensehost.accounts.adunits.insert" call.Any non-2xx status code is an error. Response headers are in either*AdUnit.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*AccountsAdunitsInsertCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*AccountsAdunitsInsertCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeAccountsAdunitsListCall

type AccountsAdunitsListCall struct {// contains filtered or unexported fields}

func (*AccountsAdunitsListCall)Context

Context sets the context to be used in this call's Do method.

func (*AccountsAdunitsListCall)Do

Do executes the "adsensehost.accounts.adunits.list" call.Any non-2xx status code is an error. Response headers are in either*AdUnits.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*AccountsAdunitsListCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*AccountsAdunitsListCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*AccountsAdunitsListCall)IfNoneMatch

func (c *AccountsAdunitsListCall) IfNoneMatch(entityTagstring) *AccountsAdunitsListCall

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

func (*AccountsAdunitsListCall)IncludeInactive

func (c *AccountsAdunitsListCall) IncludeInactive(includeInactivebool) *AccountsAdunitsListCall

IncludeInactive sets the optional parameter "includeInactive": Whether toinclude inactive ad units. Default: true.

func (*AccountsAdunitsListCall)MaxResults

func (c *AccountsAdunitsListCall) MaxResults(maxResultsint64) *AccountsAdunitsListCall

MaxResults sets the optional parameter "maxResults": The maximum number ofad units to include in the response, used for paging.

func (*AccountsAdunitsListCall)PageToken

PageToken sets the optional parameter "pageToken": A continuation token,used to page through ad units. To retrieve the next page, set this parameterto the value of "nextPageToken" from the previous response.

func (*AccountsAdunitsListCall)Pages

Pages invokes f for each page of results.A non-nil error returned from f will halt the iteration.The provided context supersedes any context provided to the Context method.

typeAccountsAdunitsPatchCall

type AccountsAdunitsPatchCall struct {// contains filtered or unexported fields}

func (*AccountsAdunitsPatchCall)Context

Context sets the context to be used in this call's Do method.

func (*AccountsAdunitsPatchCall)Do

Do executes the "adsensehost.accounts.adunits.patch" call.Any non-2xx status code is an error. Response headers are in either*AdUnit.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*AccountsAdunitsPatchCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*AccountsAdunitsPatchCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeAccountsAdunitsService

type AccountsAdunitsService struct {// contains filtered or unexported fields}

funcNewAccountsAdunitsService

func NewAccountsAdunitsService(s *Service) *AccountsAdunitsService

func (*AccountsAdunitsService)Delete

func (r *AccountsAdunitsService) Delete(accountIdstring, adClientIdstring, adUnitIdstring) *AccountsAdunitsDeleteCall

Delete: Delete the specified ad unit from the specified publisher AdSenseaccount.

- accountId: Account which contains the ad unit.- adClientId: Ad client for which to get ad unit.- adUnitId: Ad unit to delete.

func (*AccountsAdunitsService)Get

func (r *AccountsAdunitsService) Get(accountIdstring, adClientIdstring, adUnitIdstring) *AccountsAdunitsGetCall

Get: Get the specified host ad unit in this AdSense account.

- accountId: Account which contains the ad unit.- adClientId: Ad client for which to get ad unit.- adUnitId: Ad unit to get.

func (*AccountsAdunitsService)GetAdCode

func (r *AccountsAdunitsService) GetAdCode(accountIdstring, adClientIdstring, adUnitIdstring) *AccountsAdunitsGetAdCodeCall

GetAdCode: Get ad code for the specified ad unit, attaching the specifiedhost custom channels.

- accountId: Account which contains the ad client.- adClientId: Ad client with contains the ad unit.- adUnitId: Ad unit to get the code for.

func (*AccountsAdunitsService)Insert

func (r *AccountsAdunitsService) Insert(accountIdstring, adClientIdstring, adunit *AdUnit) *AccountsAdunitsInsertCall

Insert: Insert the supplied ad unit into the specified publisher AdSenseaccount.

- accountId: Account which will contain the ad unit.- adClientId: Ad client into which to insert the ad unit.

func (*AccountsAdunitsService)List

func (r *AccountsAdunitsService) List(accountIdstring, adClientIdstring) *AccountsAdunitsListCall

List: List all ad units in the specified publisher's AdSense account.

- accountId: Account which contains the ad client.- adClientId: Ad client for which to list ad units.

func (*AccountsAdunitsService)Patch

func (r *AccountsAdunitsService) Patch(accountIdstring, adClientIdstring, adUnitIdstring, adunit *AdUnit) *AccountsAdunitsPatchCall

Patch: Update the supplied ad unit in the specified publisher AdSenseaccount. This method supports patch semantics.

- accountId: Account which contains the ad client.- adClientId: Ad client which contains the ad unit.- adUnitId: Ad unit to get.

func (*AccountsAdunitsService)Update

func (r *AccountsAdunitsService) Update(accountIdstring, adClientIdstring, adunit *AdUnit) *AccountsAdunitsUpdateCall

Update: Update the supplied ad unit in the specified publisher AdSenseaccount.

- accountId: Account which contains the ad client.- adClientId: Ad client which contains the ad unit.

typeAccountsAdunitsUpdateCall

type AccountsAdunitsUpdateCall struct {// contains filtered or unexported fields}

func (*AccountsAdunitsUpdateCall)Context

Context sets the context to be used in this call's Do method.

func (*AccountsAdunitsUpdateCall)Do

Do executes the "adsensehost.accounts.adunits.update" call.Any non-2xx status code is an error. Response headers are in either*AdUnit.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*AccountsAdunitsUpdateCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*AccountsAdunitsUpdateCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeAccountsGetCall

type AccountsGetCall struct {// contains filtered or unexported fields}

func (*AccountsGetCall)Context

Context sets the context to be used in this call's Do method.

func (*AccountsGetCall)Do

Do executes the "adsensehost.accounts.get" call.Any non-2xx status code is an error. Response headers are in either*Account.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*AccountsGetCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*AccountsGetCall)Header

func (c *AccountsGetCall) Header()http.Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*AccountsGetCall)IfNoneMatch

func (c *AccountsGetCall) IfNoneMatch(entityTagstring) *AccountsGetCall

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

typeAccountsListCall

type AccountsListCall struct {// contains filtered or unexported fields}

func (*AccountsListCall)Context

Context sets the context to be used in this call's Do method.

func (*AccountsListCall)Do

Do executes the "adsensehost.accounts.list" call.Any non-2xx status code is an error. Response headers are in either*Accounts.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*AccountsListCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*AccountsListCall)Header

func (c *AccountsListCall) Header()http.Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*AccountsListCall)IfNoneMatch

func (c *AccountsListCall) IfNoneMatch(entityTagstring) *AccountsListCall

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

typeAccountsReportsGenerateCall

type AccountsReportsGenerateCall struct {// contains filtered or unexported fields}

func (*AccountsReportsGenerateCall)Context

Context sets the context to be used in this call's Do method.

func (*AccountsReportsGenerateCall)Dimension

Dimension sets the optional parameter "dimension": Dimensions to base thereport on.

func (*AccountsReportsGenerateCall)Do

Do executes the "adsensehost.accounts.reports.generate" call.Any non-2xx status code is an error. Response headers are in either*Report.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*AccountsReportsGenerateCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*AccountsReportsGenerateCall)Filter

Filter sets the optional parameter "filter": Filters to be run on thereport.

func (*AccountsReportsGenerateCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*AccountsReportsGenerateCall)IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

func (*AccountsReportsGenerateCall)Locale

Locale sets the optional parameter "locale": Optional locale to use fortranslating report output to a local language. Defaults to "en_US" if notspecified.

func (*AccountsReportsGenerateCall)MaxResults

MaxResults sets the optional parameter "maxResults": The maximum number ofrows of report data to return.

func (*AccountsReportsGenerateCall)Metric

Metric sets the optional parameter "metric": Numeric columns to include inthe report.

func (*AccountsReportsGenerateCall)Sort

Sort sets the optional parameter "sort": The name of a dimension or metricto sort the resulting report on, optionally prefixed with "+" to sortascending or "-" to sort descending. If no prefix is specified, the columnis sorted ascending.

func (*AccountsReportsGenerateCall)StartIndex

StartIndex sets the optional parameter "startIndex": Index of the first rowof report data to return.

typeAccountsReportsService

type AccountsReportsService struct {// contains filtered or unexported fields}

funcNewAccountsReportsService

func NewAccountsReportsService(s *Service) *AccountsReportsService

func (*AccountsReportsService)Generate

func (r *AccountsReportsService) Generate(accountIdstring, startDatestring, endDatestring) *AccountsReportsGenerateCall

Generate: Generate an AdSense report based on the report request sent in thequery parameters. Returns the result as JSON; to retrieve output in CSVformat specify "alt=csv" as a query parameter.

  • accountId: Hosted account upon which to report.
  • endDate: End of the date range to report on in "YYYY-MM-DD" format,inclusive.
  • startDate: Start of the date range to report on in "YYYY-MM-DD" format,inclusive.

typeAccountsService

type AccountsService struct {Adclients *AccountsAdclientsServiceAdunits *AccountsAdunitsServiceReports *AccountsReportsService// contains filtered or unexported fields}

funcNewAccountsService

func NewAccountsService(s *Service) *AccountsService

func (*AccountsService)Get

func (r *AccountsService) Get(accountIdstring) *AccountsGetCall

Get: Get information about the selected associated AdSense account.

- accountId: Account to get information about.

func (*AccountsService)List

func (r *AccountsService) List(filterAdClientId []string) *AccountsListCall

List: List hosted accounts associated with this AdSense account by ad clientid.

- filterAdClientId: Ad clients to list accounts for.

typeAdClient

type AdClient struct {// ArcOptIn: Whether this ad client is opted in to ARC.ArcOptInbool `json:"arcOptIn,omitempty"`// Id: Unique identifier of this ad client.Idstring `json:"id,omitempty"`// Kind: Kind of resource this is, in this case adsensehost#adClient.Kindstring `json:"kind,omitempty"`// ProductCode: This ad client's product code, which corresponds to the// PRODUCT_CODE report dimension.ProductCodestring `json:"productCode,omitempty"`// SupportsReporting: Whether this ad client supports being reported on.SupportsReportingbool `json:"supportsReporting,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "ArcOptIn") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ArcOptIn") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (AdClient)MarshalJSON

func (sAdClient) MarshalJSON() ([]byte,error)

typeAdClients

type AdClients struct {// Etag: ETag of this response for caching purposes.Etagstring `json:"etag,omitempty"`// Items: The ad clients returned in this list response.Items []*AdClient `json:"items,omitempty"`// Kind: Kind of list this is, in this case adsensehost#adClients.Kindstring `json:"kind,omitempty"`// NextPageToken: Continuation token used to page through ad clients. To// retrieve the next page of results, set the next request's "pageToken" value// to this.NextPageTokenstring `json:"nextPageToken,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "Etag") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Etag") to include in API requests// with the JSON null value. By default, fields with empty values are omitted// from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (AdClients)MarshalJSON

func (sAdClients) MarshalJSON() ([]byte,error)

typeAdCode

type AdCode struct {// AdCode: The ad code snippet.AdCodestring `json:"adCode,omitempty"`// Kind: Kind this is, in this case adsensehost#adCode.Kindstring `json:"kind,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "AdCode") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "AdCode") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (AdCode)MarshalJSON

func (sAdCode) MarshalJSON() ([]byte,error)

typeAdStyle

type AdStyle struct {// Colors: The colors included in the style. These are represented as six// hexadecimal characters, similar to HTML color codes, but without the leading// hash.Colors *AdStyleColors `json:"colors,omitempty"`// Corners: The style of the corners in the ad (deprecated: never populated,// ignored).Cornersstring `json:"corners,omitempty"`// Font: The font which is included in the style.Font *AdStyleFont `json:"font,omitempty"`// Kind: Kind this is, in this case adsensehost#adStyle.Kindstring `json:"kind,omitempty"`// ForceSendFields is a list of field names (e.g. "Colors") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Colors") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (AdStyle)MarshalJSON

func (sAdStyle) MarshalJSON() ([]byte,error)

typeAdStyleColors

type AdStyleColors struct {// Background: The color of the ad background.Backgroundstring `json:"background,omitempty"`// Border: The color of the ad border.Borderstring `json:"border,omitempty"`// Text: The color of the ad text.Textstring `json:"text,omitempty"`// Title: The color of the ad title.Titlestring `json:"title,omitempty"`// Url: The color of the ad url.Urlstring `json:"url,omitempty"`// ForceSendFields is a list of field names (e.g. "Background") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Background") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

AdStyleColors: The colors included in the style. These are represented assix hexadecimal characters, similar to HTML color codes, but without theleading hash.

func (AdStyleColors)MarshalJSON

func (sAdStyleColors) MarshalJSON() ([]byte,error)

typeAdStyleFont

type AdStyleFont struct {// Family: The family of the font. Possible values are: ACCOUNT_DEFAULT_FAMILY,// ADSENSE_DEFAULT_FAMILY, ARIAL, TIMES and VERDANA.Familystring `json:"family,omitempty"`// Size: The size of the font. Possible values are: ACCOUNT_DEFAULT_SIZE,// ADSENSE_DEFAULT_SIZE, SMALL, MEDIUM and LARGE.Sizestring `json:"size,omitempty"`// ForceSendFields is a list of field names (e.g. "Family") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Family") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

AdStyleFont: The font which is included in the style.

func (AdStyleFont)MarshalJSON

func (sAdStyleFont) MarshalJSON() ([]byte,error)

typeAdUnit

type AdUnit struct {// Code: Identity code of this ad unit, not necessarily unique across ad// clients.Codestring `json:"code,omitempty"`// ContentAdsSettings: Settings specific to content ads (AFC) and highend// mobile content ads (AFMC - deprecated).ContentAdsSettings *AdUnitContentAdsSettings `json:"contentAdsSettings,omitempty"`// CustomStyle: Custom style information specific to this ad unit.CustomStyle *AdStyle `json:"customStyle,omitempty"`// Id: Unique identifier of this ad unit. This should be considered an opaque// identifier; it is not safe to rely on it being in any particular format.Idstring `json:"id,omitempty"`// Kind: Kind of resource this is, in this case adsensehost#adUnit.Kindstring `json:"kind,omitempty"`// MobileContentAdsSettings: Settings specific to WAP mobile content ads (AFMC// - deprecated).MobileContentAdsSettings *AdUnitMobileContentAdsSettings `json:"mobileContentAdsSettings,omitempty"`// Name: Name of this ad unit.Namestring `json:"name,omitempty"`// Status: Status of this ad unit. Possible values are:// NEW: Indicates that the ad unit was created within the last seven days and// does not yet have any activity associated with it.//// ACTIVE: Indicates that there has been activity on this ad unit in the last// seven days.//// INACTIVE: Indicates that there has been no activity on this ad unit in the// last seven days.Statusstring `json:"status,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "Code") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Code") to include in API requests// with the JSON null value. By default, fields with empty values are omitted// from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (AdUnit)MarshalJSON

func (sAdUnit) MarshalJSON() ([]byte,error)

typeAdUnitContentAdsSettings

type AdUnitContentAdsSettings struct {// BackupOption: The backup option to be used in instances where no ad is// available.BackupOption *AdUnitContentAdsSettingsBackupOption `json:"backupOption,omitempty"`// Size: Size of this ad unit. Size values are in the form// SIZE_{width}_{height}.Sizestring `json:"size,omitempty"`// Type: Type of this ad unit. Possible values are TEXT, TEXT_IMAGE, IMAGE and// LINK.Typestring `json:"type,omitempty"`// ForceSendFields is a list of field names (e.g. "BackupOption") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "BackupOption") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

AdUnitContentAdsSettings: Settings specific to content ads (AFC) and highendmobile content ads (AFMC - deprecated).

func (AdUnitContentAdsSettings)MarshalJSON

func (sAdUnitContentAdsSettings) MarshalJSON() ([]byte,error)

typeAdUnitContentAdsSettingsBackupOption

type AdUnitContentAdsSettingsBackupOption struct {// Color: Color to use when type is set to COLOR. These are represented as six// hexadecimal characters, similar to HTML color codes, but without the leading// hash.Colorstring `json:"color,omitempty"`// Type: Type of the backup option. Possible values are BLANK, COLOR and URL.Typestring `json:"type,omitempty"`// Url: URL to use when type is set to URL.Urlstring `json:"url,omitempty"`// ForceSendFields is a list of field names (e.g. "Color") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Color") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

AdUnitContentAdsSettingsBackupOption: The backup option to be used ininstances where no ad is available.

func (AdUnitContentAdsSettingsBackupOption)MarshalJSON

typeAdUnitMobileContentAdsSettings

type AdUnitMobileContentAdsSettings struct {// MarkupLanguage: The markup language to use for this ad unit.MarkupLanguagestring `json:"markupLanguage,omitempty"`// ScriptingLanguage: The scripting language to use for this ad unit.ScriptingLanguagestring `json:"scriptingLanguage,omitempty"`// Size: Size of this ad unit.Sizestring `json:"size,omitempty"`// Type: Type of this ad unit.Typestring `json:"type,omitempty"`// ForceSendFields is a list of field names (e.g. "MarkupLanguage") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "MarkupLanguage") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

AdUnitMobileContentAdsSettings: Settings specific to WAP mobile content ads(AFMC - deprecated).

func (AdUnitMobileContentAdsSettings)MarshalJSON

func (sAdUnitMobileContentAdsSettings) MarshalJSON() ([]byte,error)

typeAdUnits

type AdUnits struct {// Etag: ETag of this response for caching purposes.Etagstring `json:"etag,omitempty"`// Items: The ad units returned in this list response.Items []*AdUnit `json:"items,omitempty"`// Kind: Kind of list this is, in this case adsensehost#adUnits.Kindstring `json:"kind,omitempty"`// NextPageToken: Continuation token used to page through ad units. To retrieve// the next page of results, set the next request's "pageToken" value to this.NextPageTokenstring `json:"nextPageToken,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "Etag") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Etag") to include in API requests// with the JSON null value. By default, fields with empty values are omitted// from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (AdUnits)MarshalJSON

func (sAdUnits) MarshalJSON() ([]byte,error)

typeAdclientsGetCall

type AdclientsGetCall struct {// contains filtered or unexported fields}

func (*AdclientsGetCall)Context

Context sets the context to be used in this call's Do method.

func (*AdclientsGetCall)Do

Do executes the "adsensehost.adclients.get" call.Any non-2xx status code is an error. Response headers are in either*AdClient.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*AdclientsGetCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*AdclientsGetCall)Header

func (c *AdclientsGetCall) Header()http.Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*AdclientsGetCall)IfNoneMatch

func (c *AdclientsGetCall) IfNoneMatch(entityTagstring) *AdclientsGetCall

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

typeAdclientsListCall

type AdclientsListCall struct {// contains filtered or unexported fields}

func (*AdclientsListCall)Context

Context sets the context to be used in this call's Do method.

func (*AdclientsListCall)Do

Do executes the "adsensehost.adclients.list" call.Any non-2xx status code is an error. Response headers are in either*AdClients.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*AdclientsListCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*AdclientsListCall)Header

func (c *AdclientsListCall) Header()http.Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*AdclientsListCall)IfNoneMatch

func (c *AdclientsListCall) IfNoneMatch(entityTagstring) *AdclientsListCall

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

func (*AdclientsListCall)MaxResults

func (c *AdclientsListCall) MaxResults(maxResultsint64) *AdclientsListCall

MaxResults sets the optional parameter "maxResults": The maximum number ofad clients to include in the response, used for paging.

func (*AdclientsListCall)PageToken

func (c *AdclientsListCall) PageToken(pageTokenstring) *AdclientsListCall

PageToken sets the optional parameter "pageToken": A continuation token,used to page through ad clients. To retrieve the next page, set thisparameter to the value of "nextPageToken" from the previous response.

func (*AdclientsListCall)Pages

Pages invokes f for each page of results.A non-nil error returned from f will halt the iteration.The provided context supersedes any context provided to the Context method.

typeAdclientsService

type AdclientsService struct {// contains filtered or unexported fields}

funcNewAdclientsService

func NewAdclientsService(s *Service) *AdclientsService

func (*AdclientsService)Get

func (r *AdclientsService) Get(adClientIdstring) *AdclientsGetCall

Get: Get information about one of the ad clients in the Host AdSenseaccount.

- adClientId: Ad client to get.

func (*AdclientsService)List

List: List all host ad clients in this AdSense account.

typeAssociationSession

type AssociationSession struct {// AccountId: Hosted account id of the associated publisher after association.// Present if status is ACCEPTED.AccountIdstring `json:"accountId,omitempty"`// Id: Unique identifier of this association session.Idstring `json:"id,omitempty"`// Kind: Kind of resource this is, in this case adsensehost#associationSession.Kindstring `json:"kind,omitempty"`// ProductCodes: The products to associate with the user. Options: AFC, AFG,// AFV, AFS (deprecated), AFMC (deprecated)ProductCodes []string `json:"productCodes,omitempty"`// RedirectUrl: Redirect URL of this association session. Used to redirect// users into the AdSense association flow.RedirectUrlstring `json:"redirectUrl,omitempty"`// Status: Status of the completed association, available once the association// callback token has been verified. One of ACCEPTED, REJECTED, or ERROR.Statusstring `json:"status,omitempty"`// UserLocale: The preferred locale of the user themselves when going through// the AdSense association flow.UserLocalestring `json:"userLocale,omitempty"`// WebsiteLocale: The locale of the user's hosted website.WebsiteLocalestring `json:"websiteLocale,omitempty"`// WebsiteUrl: The URL of the user's hosted website.WebsiteUrlstring `json:"websiteUrl,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "AccountId") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "AccountId") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (AssociationSession)MarshalJSON

func (sAssociationSession) MarshalJSON() ([]byte,error)

typeAssociationsessionsService

type AssociationsessionsService struct {// contains filtered or unexported fields}

funcNewAssociationsessionsService

func NewAssociationsessionsService(s *Service) *AssociationsessionsService

func (*AssociationsessionsService)Start

func (r *AssociationsessionsService) Start(productCode []string, websiteUrlstring) *AssociationsessionsStartCall

Start: Create an association session for initiating an association with anAdSense user.

- productCode: Products to associate with the user.- websiteUrl: The URL of the user's hosted website.

func (*AssociationsessionsService)Verify

Verify: Verify an association session after the association callback returnsfrom AdSense signup.

- token: The token returned to the association callback URL.

typeAssociationsessionsStartCall

type AssociationsessionsStartCall struct {// contains filtered or unexported fields}

func (*AssociationsessionsStartCall)CallbackUrladded inv0.21.0

CallbackUrl sets the optional parameter "callbackUrl": The URL to redirectthe user to once association is completed. It receives a token parameterthat can then be used to retrieve the associated account.

func (*AssociationsessionsStartCall)Context

Context sets the context to be used in this call's Do method.

func (*AssociationsessionsStartCall)Do

Do executes the "adsensehost.associationsessions.start" call.Any non-2xx status code is an error. Response headers are in either*AssociationSession.ServerResponse.Header or (if a response was returned atall) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*AssociationsessionsStartCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*AssociationsessionsStartCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*AssociationsessionsStartCall)IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

func (*AssociationsessionsStartCall)UserLocale

UserLocale sets the optional parameter "userLocale": The preferred locale ofthe user.

func (*AssociationsessionsStartCall)WebsiteLocale

WebsiteLocale sets the optional parameter "websiteLocale": The locale of theuser's hosted website.

typeAssociationsessionsVerifyCall

type AssociationsessionsVerifyCall struct {// contains filtered or unexported fields}

func (*AssociationsessionsVerifyCall)Context

Context sets the context to be used in this call's Do method.

func (*AssociationsessionsVerifyCall)Do

Do executes the "adsensehost.associationsessions.verify" call.Any non-2xx status code is an error. Response headers are in either*AssociationSession.ServerResponse.Header or (if a response was returned atall) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*AssociationsessionsVerifyCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*AssociationsessionsVerifyCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*AssociationsessionsVerifyCall)IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

typeCustomChannel

type CustomChannel struct {// Code: Code of this custom channel, not necessarily unique across ad clients.Codestring `json:"code,omitempty"`// Id: Unique identifier of this custom channel. This should be considered an// opaque identifier; it is not safe to rely on it being in any particular// format.Idstring `json:"id,omitempty"`// Kind: Kind of resource this is, in this case adsensehost#customChannel.Kindstring `json:"kind,omitempty"`// Name: Name of this custom channel.Namestring `json:"name,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "Code") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Code") to include in API requests// with the JSON null value. By default, fields with empty values are omitted// from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (CustomChannel)MarshalJSON

func (sCustomChannel) MarshalJSON() ([]byte,error)

typeCustomChannels

type CustomChannels struct {// Etag: ETag of this response for caching purposes.Etagstring `json:"etag,omitempty"`// Items: The custom channels returned in this list response.Items []*CustomChannel `json:"items,omitempty"`// Kind: Kind of list this is, in this case adsensehost#customChannels.Kindstring `json:"kind,omitempty"`// NextPageToken: Continuation token used to page through custom channels. To// retrieve the next page of results, set the next request's "pageToken" value// to this.NextPageTokenstring `json:"nextPageToken,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "Etag") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Etag") to include in API requests// with the JSON null value. By default, fields with empty values are omitted// from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (CustomChannels)MarshalJSON

func (sCustomChannels) MarshalJSON() ([]byte,error)

typeCustomchannelsDeleteCall

type CustomchannelsDeleteCall struct {// contains filtered or unexported fields}

func (*CustomchannelsDeleteCall)Context

Context sets the context to be used in this call's Do method.

func (*CustomchannelsDeleteCall)Do

Do executes the "adsensehost.customchannels.delete" call.Any non-2xx status code is an error. Response headers are in either*CustomChannel.ServerResponse.Header or (if a response was returned at all)in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*CustomchannelsDeleteCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*CustomchannelsDeleteCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeCustomchannelsGetCall

type CustomchannelsGetCall struct {// contains filtered or unexported fields}

func (*CustomchannelsGetCall)Context

Context sets the context to be used in this call's Do method.

func (*CustomchannelsGetCall)Do

Do executes the "adsensehost.customchannels.get" call.Any non-2xx status code is an error. Response headers are in either*CustomChannel.ServerResponse.Header or (if a response was returned at all)in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*CustomchannelsGetCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*CustomchannelsGetCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*CustomchannelsGetCall)IfNoneMatch

func (c *CustomchannelsGetCall) IfNoneMatch(entityTagstring) *CustomchannelsGetCall

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

typeCustomchannelsInsertCall

type CustomchannelsInsertCall struct {// contains filtered or unexported fields}

func (*CustomchannelsInsertCall)Context

Context sets the context to be used in this call's Do method.

func (*CustomchannelsInsertCall)Do

Do executes the "adsensehost.customchannels.insert" call.Any non-2xx status code is an error. Response headers are in either*CustomChannel.ServerResponse.Header or (if a response was returned at all)in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*CustomchannelsInsertCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*CustomchannelsInsertCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeCustomchannelsListCall

type CustomchannelsListCall struct {// contains filtered or unexported fields}

func (*CustomchannelsListCall)Context

Context sets the context to be used in this call's Do method.

func (*CustomchannelsListCall)Do

Do executes the "adsensehost.customchannels.list" call.Any non-2xx status code is an error. Response headers are in either*CustomChannels.ServerResponse.Header or (if a response was returned at all)in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*CustomchannelsListCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*CustomchannelsListCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*CustomchannelsListCall)IfNoneMatch

func (c *CustomchannelsListCall) IfNoneMatch(entityTagstring) *CustomchannelsListCall

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

func (*CustomchannelsListCall)MaxResults

func (c *CustomchannelsListCall) MaxResults(maxResultsint64) *CustomchannelsListCall

MaxResults sets the optional parameter "maxResults": The maximum number ofcustom channels to include in the response, used for paging.

func (*CustomchannelsListCall)PageToken

PageToken sets the optional parameter "pageToken": A continuation token,used to page through custom channels. To retrieve the next page, set thisparameter to the value of "nextPageToken" from the previous response.

func (*CustomchannelsListCall)Pages

Pages invokes f for each page of results.A non-nil error returned from f will halt the iteration.The provided context supersedes any context provided to the Context method.

typeCustomchannelsPatchCall

type CustomchannelsPatchCall struct {// contains filtered or unexported fields}

func (*CustomchannelsPatchCall)Context

Context sets the context to be used in this call's Do method.

func (*CustomchannelsPatchCall)Do

Do executes the "adsensehost.customchannels.patch" call.Any non-2xx status code is an error. Response headers are in either*CustomChannel.ServerResponse.Header or (if a response was returned at all)in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*CustomchannelsPatchCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*CustomchannelsPatchCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeCustomchannelsService

type CustomchannelsService struct {// contains filtered or unexported fields}

funcNewCustomchannelsService

func NewCustomchannelsService(s *Service) *CustomchannelsService

func (*CustomchannelsService)Delete

func (r *CustomchannelsService) Delete(adClientIdstring, customChannelIdstring) *CustomchannelsDeleteCall

Delete: Delete a specific custom channel from the host AdSense account.

- adClientId: Ad client from which to delete the custom channel.- customChannelId: Custom channel to delete.

func (*CustomchannelsService)Get

func (r *CustomchannelsService) Get(adClientIdstring, customChannelIdstring) *CustomchannelsGetCall

Get: Get a specific custom channel from the host AdSense account.

- adClientId: Ad client from which to get the custom channel.- customChannelId: Custom channel to get.

func (*CustomchannelsService)Insert

func (r *CustomchannelsService) Insert(adClientIdstring, customchannel *CustomChannel) *CustomchannelsInsertCall

Insert: Add a new custom channel to the host AdSense account.

- adClientId: Ad client to which the new custom channel will be added.

func (*CustomchannelsService)List

List: List all host custom channels in this AdSense account.

- adClientId: Ad client for which to list custom channels.

func (*CustomchannelsService)Patch

func (r *CustomchannelsService) Patch(adClientIdstring, customChannelIdstring, customchannel *CustomChannel) *CustomchannelsPatchCall

Patch: Update a custom channel in the host AdSense account. This methodsupports patch semantics.

- adClientId: Ad client in which the custom channel will be updated.- customChannelId: Custom channel to get.

func (*CustomchannelsService)Update

func (r *CustomchannelsService) Update(adClientIdstring, customchannel *CustomChannel) *CustomchannelsUpdateCall

Update: Update a custom channel in the host AdSense account.

- adClientId: Ad client in which the custom channel will be updated.

typeCustomchannelsUpdateCall

type CustomchannelsUpdateCall struct {// contains filtered or unexported fields}

func (*CustomchannelsUpdateCall)Context

Context sets the context to be used in this call's Do method.

func (*CustomchannelsUpdateCall)Do

Do executes the "adsensehost.customchannels.update" call.Any non-2xx status code is an error. Response headers are in either*CustomChannel.ServerResponse.Header or (if a response was returned at all)in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*CustomchannelsUpdateCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*CustomchannelsUpdateCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeReport

type Report struct {// Averages: The averages of the report. This is the same length as any other// row in the report; cells corresponding to dimension columns are empty.Averages []string `json:"averages,omitempty"`// Headers: The header information of the columns requested in the report. This// is a list of headers; one for each dimension in the request, followed by one// for each metric in the request.Headers []*ReportHeaders `json:"headers,omitempty"`// Kind: Kind this is, in this case adsensehost#report.Kindstring `json:"kind,omitempty"`// Rows: The output rows of the report. Each row is a list of cells; one for// each dimension in the request, followed by one for each metric in the// request. The dimension cells contain strings, and the metric cells contain// numbers.Rows [][]string `json:"rows,omitempty"`// TotalMatchedRows: The total number of rows matched by the report request.// Fewer rows may be returned in the response due to being limited by the row// count requested or the report row limit.TotalMatchedRowsint64 `json:"totalMatchedRows,omitempty,string"`// Totals: The totals of the report. This is the same length as any other row// in the report; cells corresponding to dimension columns are empty.Totals []string `json:"totals,omitempty"`// Warnings: Any warnings associated with generation of the report.Warnings []string `json:"warnings,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "Averages") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Averages") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (Report)MarshalJSON

func (sReport) MarshalJSON() ([]byte,error)

typeReportHeaders

type ReportHeaders struct {// Currency: The currency of this column. Only present if the header type is// METRIC_CURRENCY.Currencystring `json:"currency,omitempty"`// Name: The name of the header.Namestring `json:"name,omitempty"`// Type: The type of the header; one of DIMENSION, METRIC_TALLY, METRIC_RATIO,// or METRIC_CURRENCY.Typestring `json:"type,omitempty"`// ForceSendFields is a list of field names (e.g. "Currency") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Currency") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (ReportHeaders)MarshalJSON

func (sReportHeaders) MarshalJSON() ([]byte,error)

typeReportsGenerateCall

type ReportsGenerateCall struct {// contains filtered or unexported fields}

func (*ReportsGenerateCall)Context

Context sets the context to be used in this call's Do method.

func (*ReportsGenerateCall)Dimension

func (c *ReportsGenerateCall) Dimension(dimension ...string) *ReportsGenerateCall

Dimension sets the optional parameter "dimension": Dimensions to base thereport on.

func (*ReportsGenerateCall)Do

Do executes the "adsensehost.reports.generate" call.Any non-2xx status code is an error. Response headers are in either*Report.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ReportsGenerateCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ReportsGenerateCall)Filter

func (c *ReportsGenerateCall) Filter(filter ...string) *ReportsGenerateCall

Filter sets the optional parameter "filter": Filters to be run on thereport.

func (*ReportsGenerateCall)Header

func (c *ReportsGenerateCall) Header()http.Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ReportsGenerateCall)IfNoneMatch

func (c *ReportsGenerateCall) IfNoneMatch(entityTagstring) *ReportsGenerateCall

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

func (*ReportsGenerateCall)Locale

Locale sets the optional parameter "locale": Optional locale to use fortranslating report output to a local language. Defaults to "en_US" if notspecified.

func (*ReportsGenerateCall)MaxResults

func (c *ReportsGenerateCall) MaxResults(maxResultsint64) *ReportsGenerateCall

MaxResults sets the optional parameter "maxResults": The maximum number ofrows of report data to return.

func (*ReportsGenerateCall)Metric

func (c *ReportsGenerateCall) Metric(metric ...string) *ReportsGenerateCall

Metric sets the optional parameter "metric": Numeric columns to include inthe report.

func (*ReportsGenerateCall)Sort

Sort sets the optional parameter "sort": The name of a dimension or metricto sort the resulting report on, optionally prefixed with "+" to sortascending or "-" to sort descending. If no prefix is specified, the columnis sorted ascending.

func (*ReportsGenerateCall)StartIndex

func (c *ReportsGenerateCall) StartIndex(startIndexint64) *ReportsGenerateCall

StartIndex sets the optional parameter "startIndex": Index of the first rowof report data to return.

typeReportsService

type ReportsService struct {// contains filtered or unexported fields}

funcNewReportsService

func NewReportsService(s *Service) *ReportsService

func (*ReportsService)Generate

func (r *ReportsService) Generate(startDatestring, endDatestring) *ReportsGenerateCall

Generate: Generate an AdSense report based on the report request sent in thequery parameters. Returns the result as JSON; to retrieve output in CSVformat specify "alt=csv" as a query parameter.

  • endDate: End of the date range to report on in "YYYY-MM-DD" format,inclusive.
  • startDate: Start of the date range to report on in "YYYY-MM-DD" format,inclusive.

typeService

type Service struct {BasePathstring// API endpoint base URLUserAgentstring// optional additional User-Agent fragmentAccounts *AccountsServiceAdclients *AdclientsServiceAssociationsessions *AssociationsessionsServiceCustomchannels *CustomchannelsServiceReports *ReportsServiceUrlchannels *UrlchannelsService// contains filtered or unexported fields}

funcNewdeprecated

func New(client *http.Client) (*Service,error)

New creates a new Service. It uses the provided http.Client for requests.

Deprecated: please use NewService instead.To provide a custom HTTP client, use option.WithHTTPClient.If you are using google.golang.org/api/googleapis/transport.APIKey, use option.WithAPIKey with NewService instead.

funcNewServiceadded inv0.3.0

func NewService(ctxcontext.Context, opts ...option.ClientOption) (*Service,error)

NewService creates a new Service.

typeUrlChannel

type UrlChannel struct {// Id: Unique identifier of this URL channel. This should be considered an// opaque identifier; it is not safe to rely on it being in any particular// format.Idstring `json:"id,omitempty"`// Kind: Kind of resource this is, in this case adsensehost#urlChannel.Kindstring `json:"kind,omitempty"`// UrlPattern: URL Pattern of this URL channel. Does not include "http://" or// "https://". Example: www.example.com/homeUrlPatternstring `json:"urlPattern,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "Id") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Id") to include in API requests// with the JSON null value. By default, fields with empty values are omitted// from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (UrlChannel)MarshalJSON

func (sUrlChannel) MarshalJSON() ([]byte,error)

typeUrlChannels

type UrlChannels struct {// Etag: ETag of this response for caching purposes.Etagstring `json:"etag,omitempty"`// Items: The URL channels returned in this list response.Items []*UrlChannel `json:"items,omitempty"`// Kind: Kind of list this is, in this case adsensehost#urlChannels.Kindstring `json:"kind,omitempty"`// NextPageToken: Continuation token used to page through URL channels. To// retrieve the next page of results, set the next request's "pageToken" value// to this.NextPageTokenstring `json:"nextPageToken,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "Etag") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Etag") to include in API requests// with the JSON null value. By default, fields with empty values are omitted// from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (UrlChannels)MarshalJSON

func (sUrlChannels) MarshalJSON() ([]byte,error)

typeUrlchannelsDeleteCall

type UrlchannelsDeleteCall struct {// contains filtered or unexported fields}

func (*UrlchannelsDeleteCall)Context

Context sets the context to be used in this call's Do method.

func (*UrlchannelsDeleteCall)Do

Do executes the "adsensehost.urlchannels.delete" call.Any non-2xx status code is an error. Response headers are in either*UrlChannel.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*UrlchannelsDeleteCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*UrlchannelsDeleteCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeUrlchannelsInsertCall

type UrlchannelsInsertCall struct {// contains filtered or unexported fields}

func (*UrlchannelsInsertCall)Context

Context sets the context to be used in this call's Do method.

func (*UrlchannelsInsertCall)Do

Do executes the "adsensehost.urlchannels.insert" call.Any non-2xx status code is an error. Response headers are in either*UrlChannel.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*UrlchannelsInsertCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*UrlchannelsInsertCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeUrlchannelsListCall

type UrlchannelsListCall struct {// contains filtered or unexported fields}

func (*UrlchannelsListCall)Context

Context sets the context to be used in this call's Do method.

func (*UrlchannelsListCall)Do

Do executes the "adsensehost.urlchannels.list" call.Any non-2xx status code is an error. Response headers are in either*UrlChannels.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*UrlchannelsListCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*UrlchannelsListCall)Header

func (c *UrlchannelsListCall) Header()http.Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*UrlchannelsListCall)IfNoneMatch

func (c *UrlchannelsListCall) IfNoneMatch(entityTagstring) *UrlchannelsListCall

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

func (*UrlchannelsListCall)MaxResults

func (c *UrlchannelsListCall) MaxResults(maxResultsint64) *UrlchannelsListCall

MaxResults sets the optional parameter "maxResults": The maximum number ofURL channels to include in the response, used for paging.

func (*UrlchannelsListCall)PageToken

func (c *UrlchannelsListCall) PageToken(pageTokenstring) *UrlchannelsListCall

PageToken sets the optional parameter "pageToken": A continuation token,used to page through URL channels. To retrieve the next page, set thisparameter to the value of "nextPageToken" from the previous response.

func (*UrlchannelsListCall)Pages

Pages invokes f for each page of results.A non-nil error returned from f will halt the iteration.The provided context supersedes any context provided to the Context method.

typeUrlchannelsService

type UrlchannelsService struct {// contains filtered or unexported fields}

funcNewUrlchannelsService

func NewUrlchannelsService(s *Service) *UrlchannelsService

func (*UrlchannelsService)Delete

func (r *UrlchannelsService) Delete(adClientIdstring, urlChannelIdstring) *UrlchannelsDeleteCall

Delete: Delete a URL channel from the host AdSense account.

- adClientId: Ad client from which to delete the URL channel.- urlChannelId: URL channel to delete.

func (*UrlchannelsService)Insert

func (r *UrlchannelsService) Insert(adClientIdstring, urlchannel *UrlChannel) *UrlchannelsInsertCall

Insert: Add a new URL channel to the host AdSense account.

- adClientId: Ad client to which the new URL channel will be added.

func (*UrlchannelsService)List

func (r *UrlchannelsService) List(adClientIdstring) *UrlchannelsListCall

List: List all host URL channels in the host AdSense account.

- adClientId: Ad client for which to list URL channels.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f orF : Jump to
y orY : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic.Learn more.

[8]ページ先頭

©2009-2025 Movatter.jp