adsensehost

package
Version: v0.48.0 Latest Latest
Warning

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

Go to latest
Published: Jun 7, 2021 License: BSD-3-Clause Imports: 15 Imported by: 0

Documentation

Overview

Package adsensehost provides access to the AdSense Host API.

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

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 for authentication.

For information on how to create and obtain Application Default Credentials, see https://developers.google.com/identity/protocols/application-default-credentials.

Other authentication options

To use an API key for authentication (note: some APIs do not support API keys), use 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 OAuth flow), use option.WithTokenSource:

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

See https://godoc.org/google.golang.org/api/option/ for details on options.

Index

Constants

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

OAuth2 scopes used by this API.

Variables

This section is empty.

Functions

This section is empty.

Types

type Account

type Account struct {
	// Id: Unique identifier of this account.
	Id string `json:"id,omitempty"`

	// Kind: Kind of resource this is, in this case adsensehost#account.
	Kind string `json:"kind,omitempty"`

	// Name: Name of this account.
	Name string `json:"name,omitempty"`

	// Status: Approval status of this account. One of: PENDING, APPROVED,
	// DISABLED.
	Status string `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 values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	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. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

func (*Account) MarshalJSON

func (s *Account) MarshalJSON() ([]byte, error)

type Accounts

type Accounts struct {
	// Etag: ETag of this response for caching purposes.
	Etag string `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.
	Kind string `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 values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	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. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

func (*Accounts) MarshalJSON

func (s *Accounts) MarshalJSON() ([]byte, error)

type AccountsAdclientsGetCall

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

func (*AccountsAdclientsGetCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*AccountsAdclientsGetCall) Do

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

func (*AccountsAdclientsGetCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*AccountsAdclientsGetCall) Header

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

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*AccountsAdclientsGetCall) IfNoneMatch

func (c *AccountsAdclientsGetCall) IfNoneMatch(entityTag string) *AccountsAdclientsGetCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type AccountsAdclientsListCall

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

func (*AccountsAdclientsListCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*AccountsAdclientsListCall) Do

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

func (*AccountsAdclientsListCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*AccountsAdclientsListCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*AccountsAdclientsListCall) IfNoneMatch

func (c *AccountsAdclientsListCall) IfNoneMatch(entityTag string) *AccountsAdclientsListCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*AccountsAdclientsListCall) MaxResults

func (c *AccountsAdclientsListCall) MaxResults(maxResults int64) *AccountsAdclientsListCall

MaxResults sets the optional parameter "maxResults": The maximum number of ad 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 this parameter 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.

type AccountsAdclientsService

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

func NewAccountsAdclientsService

func NewAccountsAdclientsService(s *Service) *AccountsAdclientsService

func (*AccountsAdclientsService) Get

func (r *AccountsAdclientsService) Get(accountId string, adClientId string) *AccountsAdclientsGetCall

Get: Get information about one of the ad clients in the specified publisher'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.

type AccountsAdunitsDeleteCall

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

func (*AccountsAdunitsDeleteCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*AccountsAdunitsDeleteCall) Do

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

func (*AccountsAdunitsDeleteCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*AccountsAdunitsDeleteCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type AccountsAdunitsGetAdCodeCall

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

func (*AccountsAdunitsGetAdCodeCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*AccountsAdunitsGetAdCodeCall) Do

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

func (*AccountsAdunitsGetAdCodeCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*AccountsAdunitsGetAdCodeCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*AccountsAdunitsGetAdCodeCall) HostCustomChannelId

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

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

func (*AccountsAdunitsGetAdCodeCall) IfNoneMatch

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type AccountsAdunitsGetCall

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

func (*AccountsAdunitsGetCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*AccountsAdunitsGetCall) Do

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

func (*AccountsAdunitsGetCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*AccountsAdunitsGetCall) Header

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

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*AccountsAdunitsGetCall) IfNoneMatch

func (c *AccountsAdunitsGetCall) IfNoneMatch(entityTag string) *AccountsAdunitsGetCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type AccountsAdunitsInsertCall

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

func (*AccountsAdunitsInsertCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*AccountsAdunitsInsertCall) Do

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

func (*AccountsAdunitsInsertCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*AccountsAdunitsInsertCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type AccountsAdunitsListCall

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

func (*AccountsAdunitsListCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*AccountsAdunitsListCall) Do

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

func (*AccountsAdunitsListCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*AccountsAdunitsListCall) Header

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

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*AccountsAdunitsListCall) IfNoneMatch

func (c *AccountsAdunitsListCall) IfNoneMatch(entityTag string) *AccountsAdunitsListCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*AccountsAdunitsListCall) IncludeInactive

func (c *AccountsAdunitsListCall) IncludeInactive(includeInactive bool) *AccountsAdunitsListCall

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

func (*AccountsAdunitsListCall) MaxResults

func (c *AccountsAdunitsListCall) MaxResults(maxResults int64) *AccountsAdunitsListCall

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

func (*AccountsAdunitsListCall) PageToken

func (c *AccountsAdunitsListCall) PageToken(pageToken string) *AccountsAdunitsListCall

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

func (*AccountsAdunitsListCall) Pages

func (c *AccountsAdunitsListCall) Pages(ctx context.Context, f func(*AdUnits) error) error

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.

type AccountsAdunitsPatchCall

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

func (*AccountsAdunitsPatchCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*AccountsAdunitsPatchCall) Do

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

func (*AccountsAdunitsPatchCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*AccountsAdunitsPatchCall) Header

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

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type AccountsAdunitsService

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

func NewAccountsAdunitsService

func NewAccountsAdunitsService(s *Service) *AccountsAdunitsService

func (*AccountsAdunitsService) Delete

func (r *AccountsAdunitsService) Delete(accountId string, adClientId string, adUnitId string) *AccountsAdunitsDeleteCall

Delete: Delete the specified ad unit from the specified publisher AdSense account.

- 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(accountId string, adClientId string, adUnitId string) *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(accountId string, adClientId string, adUnitId string) *AccountsAdunitsGetAdCodeCall

GetAdCode: Get ad code for the specified ad unit, attaching the specified host 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(accountId string, adClientId string, adunit *AdUnit) *AccountsAdunitsInsertCall

Insert: Insert the supplied ad unit into the specified publisher AdSense account.

- 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(accountId string, adClientId string) *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(accountId string, adClientId string, adUnitId string, adunit *AdUnit) *AccountsAdunitsPatchCall

Patch: Update the supplied ad unit in the specified publisher AdSense account. 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(accountId string, adClientId string, adunit *AdUnit) *AccountsAdunitsUpdateCall

Update: Update the supplied ad unit in the specified publisher AdSense account.

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

type AccountsAdunitsUpdateCall

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

func (*AccountsAdunitsUpdateCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*AccountsAdunitsUpdateCall) Do

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

func (*AccountsAdunitsUpdateCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*AccountsAdunitsUpdateCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type AccountsGetCall

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

func (*AccountsGetCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*AccountsGetCall) Do

func (c *AccountsGetCall) Do(opts ...googleapi.CallOption) (*Account, error)

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

func (*AccountsGetCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*AccountsGetCall) Header

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

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*AccountsGetCall) IfNoneMatch

func (c *AccountsGetCall) IfNoneMatch(entityTag string) *AccountsGetCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type AccountsListCall

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

func (*AccountsListCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*AccountsListCall) Do

func (c *AccountsListCall) Do(opts ...googleapi.CallOption) (*Accounts, error)

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

func (*AccountsListCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*AccountsListCall) Header

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

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*AccountsListCall) IfNoneMatch

func (c *AccountsListCall) IfNoneMatch(entityTag string) *AccountsListCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type AccountsReportsGenerateCall

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

func (*AccountsReportsGenerateCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*AccountsReportsGenerateCall) Dimension

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

func (*AccountsReportsGenerateCall) Do

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

func (*AccountsReportsGenerateCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*AccountsReportsGenerateCall) Filter

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

func (*AccountsReportsGenerateCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*AccountsReportsGenerateCall) IfNoneMatch

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*AccountsReportsGenerateCall) Locale

Locale sets the optional parameter "locale": Optional locale to use for translating report output to a local language. Defaults to "en_US" if not specified.

func (*AccountsReportsGenerateCall) MaxResults

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

func (*AccountsReportsGenerateCall) Metric

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

func (*AccountsReportsGenerateCall) Sort

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

func (*AccountsReportsGenerateCall) StartIndex

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

type AccountsReportsService

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

func NewAccountsReportsService

func NewAccountsReportsService(s *Service) *AccountsReportsService

func (*AccountsReportsService) Generate

func (r *AccountsReportsService) Generate(accountId string, startDate string, endDate string) *AccountsReportsGenerateCall

Generate: Generate an AdSense report based on the report request sent in the query parameters. Returns the result as JSON; to retrieve output in CSV format 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.

type AccountsService

type AccountsService struct {
	Adclients *AccountsAdclientsService

	Adunits *AccountsAdunitsService

	Reports *AccountsReportsService
	// contains filtered or unexported fields
}

func NewAccountsService

func NewAccountsService(s *Service) *AccountsService

func (*AccountsService) Get

func (r *AccountsService) Get(accountId string) *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 client id.

- filterAdClientId: Ad clients to list accounts for.

type AdClient

type AdClient struct {
	// ArcOptIn: Whether this ad client is opted in to ARC.
	ArcOptIn bool `json:"arcOptIn,omitempty"`

	// Id: Unique identifier of this ad client.
	Id string `json:"id,omitempty"`

	// Kind: Kind of resource this is, in this case adsensehost#adClient.
	Kind string `json:"kind,omitempty"`

	// ProductCode: This ad client's product code, which corresponds to the
	// PRODUCT_CODE report dimension.
	ProductCode string `json:"productCode,omitempty"`

	// SupportsReporting: Whether this ad client supports being reported on.
	SupportsReporting bool `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 values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	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. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

func (*AdClient) MarshalJSON

func (s *AdClient) MarshalJSON() ([]byte, error)

type AdClients

type AdClients struct {
	// Etag: ETag of this response for caching purposes.
	Etag string `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.
	Kind string `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.
	NextPageToken string `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 values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	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. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

func (*AdClients) MarshalJSON

func (s *AdClients) MarshalJSON() ([]byte, error)

type AdCode

type AdCode struct {
	// AdCode: The ad code snippet.
	AdCode string `json:"adCode,omitempty"`

	// Kind: Kind this is, in this case adsensehost#adCode.
	Kind string `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 values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	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. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

func (*AdCode) MarshalJSON

func (s *AdCode) MarshalJSON() ([]byte, error)

type AdStyle

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).
	Corners string `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.
	Kind string `json:"kind,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Colors") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	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. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

func (*AdStyle) MarshalJSON

func (s *AdStyle) MarshalJSON() ([]byte, error)

type AdStyleColors

type AdStyleColors struct {
	// Background: The color of the ad background.
	Background string `json:"background,omitempty"`

	// Border: The color of the ad border.
	Border string `json:"border,omitempty"`

	// Text: The color of the ad text.
	Text string `json:"text,omitempty"`

	// Title: The color of the ad title.
	Title string `json:"title,omitempty"`

	// Url: The color of the ad url.
	Url string `json:"url,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Background") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	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. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

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

func (*AdStyleColors) MarshalJSON

func (s *AdStyleColors) MarshalJSON() ([]byte, error)

type AdStyleFont

type AdStyleFont struct {
	// Family: The family of the font. Possible values are:
	// ACCOUNT_DEFAULT_FAMILY, ADSENSE_DEFAULT_FAMILY, ARIAL, TIMES and
	// VERDANA.
	Family string `json:"family,omitempty"`

	// Size: The size of the font. Possible values are:
	// ACCOUNT_DEFAULT_SIZE, ADSENSE_DEFAULT_SIZE, SMALL, MEDIUM and LARGE.
	Size string `json:"size,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Family") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	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. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

AdStyleFont: The font which is included in the style.

func (*AdStyleFont) MarshalJSON

func (s *AdStyleFont) MarshalJSON() ([]byte, error)

type AdUnit

type AdUnit struct {
	// Code: Identity code of this ad unit, not necessarily unique across ad
	// clients.
	Code string `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.
	Id string `json:"id,omitempty"`

	// Kind: Kind of resource this is, in this case adsensehost#adUnit.
	Kind string `json:"kind,omitempty"`

	// MobileContentAdsSettings: Settings specific to WAP mobile content ads
	// (AFMC - deprecated).
	MobileContentAdsSettings *AdUnitMobileContentAdsSettings `json:"mobileContentAdsSettings,omitempty"`

	// Name: Name of this ad unit.
	Name string `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.
	Status string `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 values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	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. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

func (*AdUnit) MarshalJSON

func (s *AdUnit) MarshalJSON() ([]byte, error)

type AdUnitContentAdsSettings

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}.
	Size string `json:"size,omitempty"`

	// Type: Type of this ad unit. Possible values are TEXT, TEXT_IMAGE,
	// IMAGE and LINK.
	Type string `json:"type,omitempty"`

	// ForceSendFields is a list of field names (e.g. "BackupOption") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	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. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

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

func (*AdUnitContentAdsSettings) MarshalJSON

func (s *AdUnitContentAdsSettings) MarshalJSON() ([]byte, error)

type AdUnitContentAdsSettingsBackupOption

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.
	Color string `json:"color,omitempty"`

	// Type: Type of the backup option. Possible values are BLANK, COLOR and
	// URL.
	Type string `json:"type,omitempty"`

	// Url: URL to use when type is set to URL.
	Url string `json:"url,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Color") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	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. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

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

func (*AdUnitContentAdsSettingsBackupOption) MarshalJSON

func (s *AdUnitContentAdsSettingsBackupOption) MarshalJSON() ([]byte, error)

type AdUnitMobileContentAdsSettings

type AdUnitMobileContentAdsSettings struct {
	// MarkupLanguage: The markup language to use for this ad unit.
	MarkupLanguage string `json:"markupLanguage,omitempty"`

	// ScriptingLanguage: The scripting language to use for this ad unit.
	ScriptingLanguage string `json:"scriptingLanguage,omitempty"`

	// Size: Size of this ad unit.
	Size string `json:"size,omitempty"`

	// Type: Type of this ad unit.
	Type string `json:"type,omitempty"`

	// ForceSendFields is a list of field names (e.g. "MarkupLanguage") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	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. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

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

func (*AdUnitMobileContentAdsSettings) MarshalJSON

func (s *AdUnitMobileContentAdsSettings) MarshalJSON() ([]byte, error)

type AdUnits

type AdUnits struct {
	// Etag: ETag of this response for caching purposes.
	Etag string `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.
	Kind string `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.
	NextPageToken string `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 values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	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. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

func (*AdUnits) MarshalJSON

func (s *AdUnits) MarshalJSON() ([]byte, error)

type AdclientsGetCall

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

func (*AdclientsGetCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*AdclientsGetCall) Do

func (c *AdclientsGetCall) Do(opts ...googleapi.CallOption) (*AdClient, error)

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

func (*AdclientsGetCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*AdclientsGetCall) Header

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

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*AdclientsGetCall) IfNoneMatch

func (c *AdclientsGetCall) IfNoneMatch(entityTag string) *AdclientsGetCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type AdclientsListCall

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

func (*AdclientsListCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*AdclientsListCall) Do

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

func (*AdclientsListCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*AdclientsListCall) Header

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

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*AdclientsListCall) IfNoneMatch

func (c *AdclientsListCall) IfNoneMatch(entityTag string) *AdclientsListCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*AdclientsListCall) MaxResults

func (c *AdclientsListCall) MaxResults(maxResults int64) *AdclientsListCall

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

func (*AdclientsListCall) PageToken

func (c *AdclientsListCall) PageToken(pageToken string) *AdclientsListCall

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

func (*AdclientsListCall) Pages

func (c *AdclientsListCall) Pages(ctx context.Context, f func(*AdClients) error) error

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.

type AdclientsService

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

func NewAdclientsService

func NewAdclientsService(s *Service) *AdclientsService

func (*AdclientsService) Get

func (r *AdclientsService) Get(adClientId string) *AdclientsGetCall

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

- adClientId: Ad client to get.

func (*AdclientsService) List

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

type AssociationSession

type AssociationSession struct {
	// AccountId: Hosted account id of the associated publisher after
	// association. Present if status is ACCEPTED.
	AccountId string `json:"accountId,omitempty"`

	// Id: Unique identifier of this association session.
	Id string `json:"id,omitempty"`

	// Kind: Kind of resource this is, in this case
	// adsensehost#associationSession.
	Kind string `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.
	RedirectUrl string `json:"redirectUrl,omitempty"`

	// Status: Status of the completed association, available once the
	// association callback token has been verified. One of ACCEPTED,
	// REJECTED, or ERROR.
	Status string `json:"status,omitempty"`

	// UserLocale: The preferred locale of the user themselves when going
	// through the AdSense association flow.
	UserLocale string `json:"userLocale,omitempty"`

	// WebsiteLocale: The locale of the user's hosted website.
	WebsiteLocale string `json:"websiteLocale,omitempty"`

	// WebsiteUrl: The URL of the user's hosted website.
	WebsiteUrl string `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 values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	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. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

func (*AssociationSession) MarshalJSON

func (s *AssociationSession) MarshalJSON() ([]byte, error)

type AssociationsessionsService

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

func NewAssociationsessionsService

func NewAssociationsessionsService(s *Service) *AssociationsessionsService

func (*AssociationsessionsService) Start

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

Start: Create an association session for initiating an association with an AdSense 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 returns from AdSense signup.

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

type AssociationsessionsStartCall

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

func (*AssociationsessionsStartCall) CallbackUrl

CallbackUrl sets the optional parameter "callbackUrl": The URL to redirect the user to once association is completed. It receives a token parameter that 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. Any pending HTTP request will be aborted if the provided context is canceled.

func (*AssociationsessionsStartCall) Do

Do executes the "adsensehost.associationsessions.start" call. Exactly one of *AssociationSession or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *AssociationSession.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*AssociationsessionsStartCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*AssociationsessionsStartCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*AssociationsessionsStartCall) IfNoneMatch

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*AssociationsessionsStartCall) UserLocale

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

func (*AssociationsessionsStartCall) WebsiteLocale

func (c *AssociationsessionsStartCall) WebsiteLocale(websiteLocale string) *AssociationsessionsStartCall

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

type AssociationsessionsVerifyCall

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

func (*AssociationsessionsVerifyCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*AssociationsessionsVerifyCall) Do

Do executes the "adsensehost.associationsessions.verify" call. Exactly one of *AssociationSession or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *AssociationSession.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*AssociationsessionsVerifyCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*AssociationsessionsVerifyCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*AssociationsessionsVerifyCall) IfNoneMatch

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type CustomChannel

type CustomChannel struct {
	// Code: Code of this custom channel, not necessarily unique across ad
	// clients.
	Code string `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.
	Id string `json:"id,omitempty"`

	// Kind: Kind of resource this is, in this case
	// adsensehost#customChannel.
	Kind string `json:"kind,omitempty"`

	// Name: Name of this custom channel.
	Name string `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 values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	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. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

func (*CustomChannel) MarshalJSON

func (s *CustomChannel) MarshalJSON() ([]byte, error)

type CustomChannels

type CustomChannels struct {
	// Etag: ETag of this response for caching purposes.
	Etag string `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.
	Kind string `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.
	NextPageToken string `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 values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	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. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

func (*CustomChannels) MarshalJSON

func (s *CustomChannels) MarshalJSON() ([]byte, error)

type CustomchannelsDeleteCall

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

func (*CustomchannelsDeleteCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*CustomchannelsDeleteCall) Do

Do executes the "adsensehost.customchannels.delete" call. Exactly one of *CustomChannel or error will be non-nil. 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 check whether the returned error was because http.StatusNotModified was returned.

func (*CustomchannelsDeleteCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*CustomchannelsDeleteCall) Header

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

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type CustomchannelsGetCall

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

func (*CustomchannelsGetCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*CustomchannelsGetCall) Do

Do executes the "adsensehost.customchannels.get" call. Exactly one of *CustomChannel or error will be non-nil. 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 check whether the returned error was because http.StatusNotModified was returned.

func (*CustomchannelsGetCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*CustomchannelsGetCall) Header

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

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*CustomchannelsGetCall) IfNoneMatch

func (c *CustomchannelsGetCall) IfNoneMatch(entityTag string) *CustomchannelsGetCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type CustomchannelsInsertCall

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

func (*CustomchannelsInsertCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*CustomchannelsInsertCall) Do

Do executes the "adsensehost.customchannels.insert" call. Exactly one of *CustomChannel or error will be non-nil. 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 check whether the returned error was because http.StatusNotModified was returned.

func (*CustomchannelsInsertCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*CustomchannelsInsertCall) Header

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

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type CustomchannelsListCall

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

func (*CustomchannelsListCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*CustomchannelsListCall) Do

Do executes the "adsensehost.customchannels.list" call. Exactly one of *CustomChannels or error will be non-nil. 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 check whether the returned error was because http.StatusNotModified was returned.

func (*CustomchannelsListCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*CustomchannelsListCall) Header

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

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*CustomchannelsListCall) IfNoneMatch

func (c *CustomchannelsListCall) IfNoneMatch(entityTag string) *CustomchannelsListCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*CustomchannelsListCall) MaxResults

func (c *CustomchannelsListCall) MaxResults(maxResults int64) *CustomchannelsListCall

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

func (*CustomchannelsListCall) PageToken

func (c *CustomchannelsListCall) PageToken(pageToken string) *CustomchannelsListCall

PageToken sets the optional parameter "pageToken": A continuation token, used to page through custom channels. To retrieve the next page, set this parameter 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.

type CustomchannelsPatchCall

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

func (*CustomchannelsPatchCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*CustomchannelsPatchCall) Do

Do executes the "adsensehost.customchannels.patch" call. Exactly one of *CustomChannel or error will be non-nil. 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 check whether the returned error was because http.StatusNotModified was returned.

func (*CustomchannelsPatchCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*CustomchannelsPatchCall) Header

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

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type CustomchannelsService

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

func NewCustomchannelsService

func NewCustomchannelsService(s *Service) *CustomchannelsService

func (*CustomchannelsService) Delete

func (r *CustomchannelsService) Delete(adClientId string, customChannelId string) *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(adClientId string, customChannelId string) *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(adClientId string, 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(adClientId string, customChannelId string, customchannel *CustomChannel) *CustomchannelsPatchCall

Patch: Update a custom channel in the host AdSense account. This method supports 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(adClientId string, customchannel *CustomChannel) *CustomchannelsUpdateCall

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

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

type CustomchannelsUpdateCall

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

func (*CustomchannelsUpdateCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*CustomchannelsUpdateCall) Do

Do executes the "adsensehost.customchannels.update" call. Exactly one of *CustomChannel or error will be non-nil. 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 check whether the returned error was because http.StatusNotModified was returned.

func (*CustomchannelsUpdateCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*CustomchannelsUpdateCall) Header

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

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type Report

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.
	Kind string `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.
	TotalMatchedRows int64 `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 values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	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. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

func (*Report) MarshalJSON

func (s *Report) MarshalJSON() ([]byte, error)

type ReportHeaders

type ReportHeaders struct {
	// Currency: The currency of this column. Only present if the header
	// type is METRIC_CURRENCY.
	Currency string `json:"currency,omitempty"`

	// Name: The name of the header.
	Name string `json:"name,omitempty"`

	// Type: The type of the header; one of DIMENSION, METRIC_TALLY,
	// METRIC_RATIO, or METRIC_CURRENCY.
	Type string `json:"type,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Currency") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	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. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

func (*ReportHeaders) MarshalJSON

func (s *ReportHeaders) MarshalJSON() ([]byte, error)

type ReportsGenerateCall

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

func (*ReportsGenerateCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ReportsGenerateCall) Dimension

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

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

func (*ReportsGenerateCall) Do

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

func (*ReportsGenerateCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ReportsGenerateCall) Filter

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

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

func (*ReportsGenerateCall) Header

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

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ReportsGenerateCall) IfNoneMatch

func (c *ReportsGenerateCall) IfNoneMatch(entityTag string) *ReportsGenerateCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*ReportsGenerateCall) Locale

func (c *ReportsGenerateCall) Locale(locale string) *ReportsGenerateCall

Locale sets the optional parameter "locale": Optional locale to use for translating report output to a local language. Defaults to "en_US" if not specified.

func (*ReportsGenerateCall) MaxResults

func (c *ReportsGenerateCall) MaxResults(maxResults int64) *ReportsGenerateCall

MaxResults sets the optional parameter "maxResults": The maximum number of rows 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 in the report.

func (*ReportsGenerateCall) Sort

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

func (*ReportsGenerateCall) StartIndex

func (c *ReportsGenerateCall) StartIndex(startIndex int64) *ReportsGenerateCall

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

type ReportsService

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

func NewReportsService

func NewReportsService(s *Service) *ReportsService

func (*ReportsService) Generate

func (r *ReportsService) Generate(startDate string, endDate string) *ReportsGenerateCall

Generate: Generate an AdSense report based on the report request sent in the query parameters. Returns the result as JSON; to retrieve output in CSV format 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.

type Service

type Service struct {
	BasePath  string // API endpoint base URL
	UserAgent string // optional additional User-Agent fragment

	Accounts *AccountsService

	Adclients *AdclientsService

	Associationsessions *AssociationsessionsService

	Customchannels *CustomchannelsService

	Reports *ReportsService

	Urlchannels *UrlchannelsService
	// contains filtered or unexported fields
}

func New deprecated

This function has been deprecated.
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.

func NewService

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

NewService creates a new Service.

type UrlChannel

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.
	Id string `json:"id,omitempty"`

	// Kind: Kind of resource this is, in this case adsensehost#urlChannel.
	Kind string `json:"kind,omitempty"`

	// UrlPattern: URL Pattern of this URL channel. Does not include
	// "http://" or "https://". Example: www.example.com/home
	UrlPattern string `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 values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	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. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

func (*UrlChannel) MarshalJSON

func (s *UrlChannel) MarshalJSON() ([]byte, error)

type UrlChannels

type UrlChannels struct {
	// Etag: ETag of this response for caching purposes.
	Etag string `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.
	Kind string `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.
	NextPageToken string `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 values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	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. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

func (*UrlChannels) MarshalJSON

func (s *UrlChannels) MarshalJSON() ([]byte, error)

type UrlchannelsDeleteCall

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

func (*UrlchannelsDeleteCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*UrlchannelsDeleteCall) Do

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

func (*UrlchannelsDeleteCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*UrlchannelsDeleteCall) Header

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

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type UrlchannelsInsertCall

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

func (*UrlchannelsInsertCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*UrlchannelsInsertCall) Do

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

func (*UrlchannelsInsertCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*UrlchannelsInsertCall) Header

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

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type UrlchannelsListCall

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

func (*UrlchannelsListCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*UrlchannelsListCall) Do

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

func (*UrlchannelsListCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*UrlchannelsListCall) Header

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

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*UrlchannelsListCall) IfNoneMatch

func (c *UrlchannelsListCall) IfNoneMatch(entityTag string) *UrlchannelsListCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*UrlchannelsListCall) MaxResults

func (c *UrlchannelsListCall) MaxResults(maxResults int64) *UrlchannelsListCall

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

func (*UrlchannelsListCall) PageToken

func (c *UrlchannelsListCall) PageToken(pageToken string) *UrlchannelsListCall

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

func (*UrlchannelsListCall) Pages

func (c *UrlchannelsListCall) Pages(ctx context.Context, f func(*UrlChannels) error) error

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.

type UrlchannelsService

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

func NewUrlchannelsService

func NewUrlchannelsService(s *Service) *UrlchannelsService

func (*UrlchannelsService) Delete

func (r *UrlchannelsService) Delete(adClientId string, urlChannelId string) *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(adClientId string, 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(adClientId string) *UrlchannelsListCall

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

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

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
t or T : Toggle theme light dark auto