adsensehost

package
v0.0.0-...-c37129a Latest Latest
Warning

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

 Go to latest Published: Feb 16, 2016 License: BSD-3-Clause Imports: 11 Imported by: 0

Documentation

Overview

Package adsensehost provides access to the AdSense Host API.

See https://developers.google.com/adsense/host/

Usage example: 

import "google.golang.org/api/adsensehost/v4.1"
...
adsensehostService, err := adsensehost.New(oauthHttpClient)

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"`
}

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"`
}

type AccountsAdclientsGetCall 

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

func (*AccountsAdclientsGetCall) Do 

func (c *AccountsAdclientsGetCall) Do() (*AdClient, error)

func (*AccountsAdclientsGetCall) Fields 

func (c *AccountsAdclientsGetCall) Fields(s ...googleapi.Field) *AccountsAdclientsGetCall

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

type AccountsAdclientsListCall 

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

func (*AccountsAdclientsListCall) Do 

func (c *AccountsAdclientsListCall) Do() (*AdClients, error)

func (*AccountsAdclientsListCall) Fields 

func (c *AccountsAdclientsListCall) Fields(s ...googleapi.Field) *AccountsAdclientsListCall

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

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 

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

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.

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.

func (*AccountsAdclientsService) List 

func (r *AccountsAdclientsService) List(accountId string) *AccountsAdclientsListCall

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

type AccountsAdunitsDeleteCall 

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

func (*AccountsAdunitsDeleteCall) Do 

func (c *AccountsAdunitsDeleteCall) Do() (*AdUnit, error)

func (*AccountsAdunitsDeleteCall) Fields 

func (c *AccountsAdunitsDeleteCall) Fields(s ...googleapi.Field) *AccountsAdunitsDeleteCall

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

type AccountsAdunitsGetAdCodeCall 

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

func (*AccountsAdunitsGetAdCodeCall) Do 

func (c *AccountsAdunitsGetAdCodeCall) Do() (*AdCode, error)

func (*AccountsAdunitsGetAdCodeCall) Fields 

func (c *AccountsAdunitsGetAdCodeCall) Fields(s ...googleapi.Field) *AccountsAdunitsGetAdCodeCall

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

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.

type AccountsAdunitsGetCall 

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

func (*AccountsAdunitsGetCall) Do 

func (c *AccountsAdunitsGetCall) Do() (*AdUnit, error)

func (*AccountsAdunitsGetCall) Fields 

func (c *AccountsAdunitsGetCall) Fields(s ...googleapi.Field) *AccountsAdunitsGetCall

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

type AccountsAdunitsInsertCall 

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

func (*AccountsAdunitsInsertCall) Do 

func (c *AccountsAdunitsInsertCall) Do() (*AdUnit, error)

func (*AccountsAdunitsInsertCall) Fields 

func (c *AccountsAdunitsInsertCall) Fields(s ...googleapi.Field) *AccountsAdunitsInsertCall

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

type AccountsAdunitsListCall 

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

func (*AccountsAdunitsListCall) Do 

func (c *AccountsAdunitsListCall) Do() (*AdUnits, error)

func (*AccountsAdunitsListCall) Fields 

func (c *AccountsAdunitsListCall) Fields(s ...googleapi.Field) *AccountsAdunitsListCall

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

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.

type AccountsAdunitsPatchCall 

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

func (*AccountsAdunitsPatchCall) Do 

func (c *AccountsAdunitsPatchCall) Do() (*AdUnit, error)

func (*AccountsAdunitsPatchCall) Fields 

func (c *AccountsAdunitsPatchCall) Fields(s ...googleapi.Field) *AccountsAdunitsPatchCall

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

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.

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.

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.

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.

func (*AccountsAdunitsService) List 

func (r *AccountsAdunitsService) List(accountId string, adClientId string) *AccountsAdunitsListCall

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

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.

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.

type AccountsAdunitsUpdateCall 

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

func (*AccountsAdunitsUpdateCall) Do 

func (c *AccountsAdunitsUpdateCall) Do() (*AdUnit, error)

func (*AccountsAdunitsUpdateCall) Fields 

func (c *AccountsAdunitsUpdateCall) Fields(s ...googleapi.Field) *AccountsAdunitsUpdateCall

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

type AccountsGetCall 

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

func (*AccountsGetCall) Do 

func (c *AccountsGetCall) Do() (*Account, error)

func (*AccountsGetCall) Fields 

func (c *AccountsGetCall) Fields(s ...googleapi.Field) *AccountsGetCall

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

type AccountsListCall 

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

func (*AccountsListCall) Do 

func (c *AccountsListCall) Do() (*Accounts, error)

func (*AccountsListCall) Fields 

func (c *AccountsListCall) Fields(s ...googleapi.Field) *AccountsListCall

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

type AccountsReportsGenerateCall 

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

func (*AccountsReportsGenerateCall) Dimension 

func (c *AccountsReportsGenerateCall) Dimension(dimension string) *AccountsReportsGenerateCall

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

func (*AccountsReportsGenerateCall) Do 

func (c *AccountsReportsGenerateCall) Do() (*Report, error)

func (*AccountsReportsGenerateCall) Fields 

func (c *AccountsReportsGenerateCall) Fields(s ...googleapi.Field) *AccountsReportsGenerateCall

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

func (*AccountsReportsGenerateCall) Filter 

func (c *AccountsReportsGenerateCall) Filter(filter string) *AccountsReportsGenerateCall

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

func (*AccountsReportsGenerateCall) Locale 

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

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 

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

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

func (*AccountsReportsGenerateCall) Metric 

func (c *AccountsReportsGenerateCall) Metric(metric string) *AccountsReportsGenerateCall

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

func (*AccountsReportsGenerateCall) Sort 

func (c *AccountsReportsGenerateCall) Sort(sort string) *AccountsReportsGenerateCall

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 

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

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.

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.

func (*AccountsService) List 

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

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

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"`
}

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"`
}

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"`
}

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. Possible values are
	// SQUARE, SLIGHTLY_ROUNDED and VERY_ROUNDED.
	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"`
}

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"`
}

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"`
}

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).
	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).
	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"`
}

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"`
}

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"`
}

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"`
}

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"`
}

type AdclientsGetCall 

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

func (*AdclientsGetCall) Do 

func (c *AdclientsGetCall) Do() (*AdClient, error)

func (*AdclientsGetCall) Fields 

func (c *AdclientsGetCall) Fields(s ...googleapi.Field) *AdclientsGetCall

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

type AdclientsListCall 

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

func (*AdclientsListCall) Do 

func (c *AdclientsListCall) Do() (*AdClients, error)

func (*AdclientsListCall) Fields 

func (c *AdclientsListCall) Fields(s ...googleapi.Field) *AdclientsListCall

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

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.

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.

func (*AdclientsService) List 

func (r *AdclientsService) List() *AdclientsListCall

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,
	// AFF, AFS, AFMC
	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"`
}

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.

func (*AssociationsessionsService) Verify 

func (r *AssociationsessionsService) Verify(token string) *AssociationsessionsVerifyCall

Verify: Verify an association session after the association callback returns from AdSense signup.

type AssociationsessionsStartCall 

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

func (*AssociationsessionsStartCall) Do 

func (c *AssociationsessionsStartCall) Do() (*AssociationSession, error)

func (*AssociationsessionsStartCall) Fields 

func (c *AssociationsessionsStartCall) Fields(s ...googleapi.Field) *AssociationsessionsStartCall

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

func (*AssociationsessionsStartCall) UserLocale 

func (c *AssociationsessionsStartCall) UserLocale(userLocale string) *AssociationsessionsStartCall

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) Do 

func (c *AssociationsessionsVerifyCall) Do() (*AssociationSession, error)

func (*AssociationsessionsVerifyCall) Fields 

func (c *AssociationsessionsVerifyCall) Fields(s ...googleapi.Field) *AssociationsessionsVerifyCall

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

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"`
}

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"`
}

type CustomchannelsDeleteCall 

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

func (*CustomchannelsDeleteCall) Do 

func (c *CustomchannelsDeleteCall) Do() (*CustomChannel, error)

func (*CustomchannelsDeleteCall) Fields 

func (c *CustomchannelsDeleteCall) Fields(s ...googleapi.Field) *CustomchannelsDeleteCall

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

type CustomchannelsGetCall 

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

func (*CustomchannelsGetCall) Do 

func (c *CustomchannelsGetCall) Do() (*CustomChannel, error)

func (*CustomchannelsGetCall) Fields 

func (c *CustomchannelsGetCall) Fields(s ...googleapi.Field) *CustomchannelsGetCall

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

type CustomchannelsInsertCall 

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

func (*CustomchannelsInsertCall) Do 

func (c *CustomchannelsInsertCall) Do() (*CustomChannel, error)

func (*CustomchannelsInsertCall) Fields 

func (c *CustomchannelsInsertCall) Fields(s ...googleapi.Field) *CustomchannelsInsertCall

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

type CustomchannelsListCall 

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

func (*CustomchannelsListCall) Do 

func (c *CustomchannelsListCall) Do() (*CustomChannels, error)

func (*CustomchannelsListCall) Fields 

func (c *CustomchannelsListCall) Fields(s ...googleapi.Field) *CustomchannelsListCall

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

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.

type CustomchannelsPatchCall 

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

func (*CustomchannelsPatchCall) Do 

func (c *CustomchannelsPatchCall) Do() (*CustomChannel, error)

func (*CustomchannelsPatchCall) Fields 

func (c *CustomchannelsPatchCall) Fields(s ...googleapi.Field) *CustomchannelsPatchCall

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

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.

func (*CustomchannelsService) Get 

func (r *CustomchannelsService) Get(adClientId string, customChannelId string) *CustomchannelsGetCall

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

func (*CustomchannelsService) Insert 

func (r *CustomchannelsService) Insert(adClientId string, customchannel *CustomChannel) *CustomchannelsInsertCall

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

func (*CustomchannelsService) List 

func (r *CustomchannelsService) List(adClientId string) *CustomchannelsListCall

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

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.

func (*CustomchannelsService) Update 

func (r *CustomchannelsService) Update(adClientId string, customchannel *CustomChannel) *CustomchannelsUpdateCall

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

type CustomchannelsUpdateCall 

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

func (*CustomchannelsUpdateCall) Do 

func (c *CustomchannelsUpdateCall) Do() (*CustomChannel, error)

func (*CustomchannelsUpdateCall) Fields 

func (c *CustomchannelsUpdateCall) Fields(s ...googleapi.Field) *CustomchannelsUpdateCall

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

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"`
}

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"`
}

type ReportsGenerateCall 

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

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 

func (c *ReportsGenerateCall) Do() (*Report, error)

func (*ReportsGenerateCall) Fields 

func (c *ReportsGenerateCall) Fields(s ...googleapi.Field) *ReportsGenerateCall

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) 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 

func (c *ReportsGenerateCall) Sort(sort string) *ReportsGenerateCall

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.

type Service 

type Service struct {
	BasePath string // API endpoint base URL

	Accounts *AccountsService

	Adclients *AdclientsService

	Associationsessions *AssociationsessionsService

	Customchannels *CustomchannelsService

	Reports *ReportsService

	Urlchannels *UrlchannelsService
	// contains filtered or unexported fields
}

func New 

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

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"`
}

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"`
}

type UrlchannelsDeleteCall 

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

func (*UrlchannelsDeleteCall) Do 

func (c *UrlchannelsDeleteCall) Do() (*UrlChannel, error)

func (*UrlchannelsDeleteCall) Fields 

func (c *UrlchannelsDeleteCall) Fields(s ...googleapi.Field) *UrlchannelsDeleteCall

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

type UrlchannelsInsertCall 

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

func (*UrlchannelsInsertCall) Do 

func (c *UrlchannelsInsertCall) Do() (*UrlChannel, error)

func (*UrlchannelsInsertCall) Fields 

func (c *UrlchannelsInsertCall) Fields(s ...googleapi.Field) *UrlchannelsInsertCall

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

type UrlchannelsListCall 

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

func (*UrlchannelsListCall) Do 

func (c *UrlchannelsListCall) Do() (*UrlChannels, error)

func (*UrlchannelsListCall) Fields 

func (c *UrlchannelsListCall) Fields(s ...googleapi.Field) *UrlchannelsListCall

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

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.

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.

func (*UrlchannelsService) Insert 

func (r *UrlchannelsService) Insert(adClientId string, urlchannel *UrlChannel) *UrlchannelsInsertCall

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

func (*UrlchannelsService) List 

func (r *UrlchannelsService) List(adClientId string) *UrlchannelsListCall

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

Source Files

View all Source files

Jump to

Keyboard shortcuts

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