Accesses AdSense publishers' inventory and generates performance reports.
Get Auto ad code for a given ad client.
Name | Data Type | Description |
---|---|---|
adClientId
|
string |
Ad client to get the code for. |
accountId
|
string |
Account which contains the ad client. |
Name | Data Type | Description |
---|---|---|
userIp
|
string |
Deprecated. Please use quotaUser instead. |
quotaUser
|
string |
An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
prettyPrint
|
boolean Default value: true
|
Returns response with indentations and line breaks. |
oauth_token
|
string |
OAuth 2.0 token for the current user. |
key
|
string |
API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. |
fields
|
string |
Selector specifying which fields to include in a partial response. |
alt
|
string Default value: json Allowed values: - csv - json |
Data format for the response. |
Name | Data Type | Description |
---|---|---|
AdCode
|
object |
kind
|
string Default value: adsense#adCode
|
Kind this is, in this case adsense#adCode. |
ampHead
|
string |
The AMP Auto ad code snippet that goes in the head of an AMP page. |
ampBody
|
string |
The AMP Auto ad code snippet that goes in the body of an AMP page. |
adCode
|
string |
The Auto ad code snippet. The ad code snippet. |
Get ad code for the specified ad unit.
Name | Data Type | Description |
---|---|---|
adUnitId
|
string |
Ad unit to get the code for. |
adClientId
|
string |
Ad client with contains the ad unit. |
accountId
|
string |
Account which contains the ad client. |
Name | Data Type | Description |
---|---|---|
userIp
|
string |
Deprecated. Please use quotaUser instead. |
quotaUser
|
string |
An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
prettyPrint
|
boolean Default value: true
|
Returns response with indentations and line breaks. |
oauth_token
|
string |
OAuth 2.0 token for the current user. |
key
|
string |
API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. |
fields
|
string |
Selector specifying which fields to include in a partial response. |
alt
|
string Default value: json Allowed values: - csv - json |
Data format for the response. |
Name | Data Type | Description |
---|---|---|
AdCode
|
object |
kind
|
string Default value: adsense#adCode
|
Kind this is, in this case adsense#adCode. |
ampHead
|
string |
The AMP Auto ad code snippet that goes in the head of an AMP page. |
ampBody
|
string |
The AMP Auto ad code snippet that goes in the body of an AMP page. |
adCode
|
string |
The Auto ad code snippet. The ad code snippet. |
List all custom channels which the specified ad unit belongs to.
Name | Data Type | Description |
---|---|---|
adUnitId
|
string |
Ad unit for which to list custom channels. |
adClientId
|
string |
Ad client which contains the ad unit. |
accountId
|
string |
Account to which the ad client belongs. |
Name | Data Type | Description |
---|---|---|
userIp
|
string |
Deprecated. Please use quotaUser instead. |
quotaUser
|
string |
An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
prettyPrint
|
boolean Default value: true
|
Returns response with indentations and line breaks. |
oauth_token
|
string |
OAuth 2.0 token for the current user. |
key
|
string |
API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. |
fields
|
string |
Selector specifying which fields to include in a partial response. |
alt
|
string Default value: json Allowed values: - csv - json |
Data format for the response. |
pageToken
|
string |
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. |
maxResults
|
integer Minimum: 0 Maximum: 10000 |
The maximum number of custom channels to include in the response, used for paging. |
Name | Data Type | Description |
---|---|---|
CustomChannels
|
object |
nextPageToken
|
string |
Continuation token used to page through custom channels. To retrieve the next page of results, set the next request's "pageToken" value to this. |
|||||||||||||||||||
kind
|
string Default value: adsense#customChannels
|
Kind of list this is, in this case adsense#customChannels. |
|||||||||||||||||||
items
|
array [CustomChannel] |
The custom channels returned in this list response. |
|||||||||||||||||||
Properties
|
|||||||||||||||||||||
etag
|
string |
ETag of this response for caching purposes. |
Gets the specified ad unit in the specified ad client for the specified account.
Name | Data Type | Description |
---|---|---|
adUnitId
|
string |
Ad unit to retrieve. |
adClientId
|
string |
Ad client for which to get the ad unit. |
accountId
|
string |
Account to which the ad client belongs. |
Name | Data Type | Description |
---|---|---|
userIp
|
string |
Deprecated. Please use quotaUser instead. |
quotaUser
|
string |
An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
prettyPrint
|
boolean Default value: true
|
Returns response with indentations and line breaks. |
oauth_token
|
string |
OAuth 2.0 token for the current user. |
key
|
string |
API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. |
fields
|
string |
Selector specifying which fields to include in a partial response. |
alt
|
string Default value: json Allowed values: - csv - json |
Data format for the response. |
Name | Data Type | Description |
---|---|---|
AdUnit
|
object |
status
|
string |
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. |
||||||||||||||||
savedStyleId
|
string |
ID of the saved ad style which holds this ad unit's style information. |
||||||||||||||||
name
|
string |
Name of this ad unit. |
||||||||||||||||
mobileContentAdsSettings
|
||||||||||||||||||
kind
|
string Default value: adsense#adUnit
|
Kind of resource this is, in this case adsense#adUnit. |
||||||||||||||||
id
|
string |
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. |
||||||||||||||||
feedAdsSettings
|
||||||||||||||||||
customStyle
|
AdStyle |
Custom style information specific to this ad unit. |
||||||||||||||||
Properties
|
||||||||||||||||||
contentAdsSettings
|
||||||||||||||||||
code
|
string |
Identity code of this ad unit, not necessarily unique across ad clients. |
List all ad units in the specified ad client for the specified account.
Name | Data Type | Description |
---|---|---|
adClientId
|
string |
Ad client for which to list ad units. |
accountId
|
string |
Account to which the ad client belongs. |
Name | Data Type | Description |
---|---|---|
userIp
|
string |
Deprecated. Please use quotaUser instead. |
quotaUser
|
string |
An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
prettyPrint
|
boolean Default value: true
|
Returns response with indentations and line breaks. |
oauth_token
|
string |
OAuth 2.0 token for the current user. |
key
|
string |
API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. |
fields
|
string |
Selector specifying which fields to include in a partial response. |
alt
|
string Default value: json Allowed values: - csv - json |
Data format for the response. |
pageToken
|
string |
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. |
maxResults
|
integer Minimum: 0 Maximum: 10000 |
The maximum number of ad units to include in the response, used for paging. |
includeInactive
|
boolean |
Whether to include inactive ad units. Default: true. |
Name | Data Type | Description |
---|---|---|
AdUnits
|
object |
nextPageToken
|
string |
Continuation token used to page through ad units. To retrieve the next page of results, set the next request's "pageToken" value to this. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||
kind
|
string Default value: adsense#adUnits
|
Kind of list this is, in this case adsense#adUnits. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||
items
|
array [AdUnit] |
The ad units returned in this list response. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||
etag
|
string |
ETag of this response for caching purposes. |
List all ad units in the specified custom channel.
Name | Data Type | Description |
---|---|---|
customChannelId
|
string |
Custom channel for which to list ad units. |
adClientId
|
string |
Ad client which contains the custom channel. |
accountId
|
string |
Account to which the ad client belongs. |
Name | Data Type | Description |
---|---|---|
userIp
|
string |
Deprecated. Please use quotaUser instead. |
quotaUser
|
string |
An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
prettyPrint
|
boolean Default value: true
|
Returns response with indentations and line breaks. |
oauth_token
|
string |
OAuth 2.0 token for the current user. |
key
|
string |
API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. |
fields
|
string |
Selector specifying which fields to include in a partial response. |
alt
|
string Default value: json Allowed values: - csv - json |
Data format for the response. |
pageToken
|
string |
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. |
maxResults
|
integer Minimum: 0 Maximum: 10000 |
The maximum number of ad units to include in the response, used for paging. |
includeInactive
|
boolean |
Whether to include inactive ad units. Default: true. |
Name | Data Type | Description |
---|---|---|
AdUnits
|
object |
nextPageToken
|
string |
Continuation token used to page through ad units. To retrieve the next page of results, set the next request's "pageToken" value to this. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||
kind
|
string Default value: adsense#adUnits
|
Kind of list this is, in this case adsense#adUnits. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||
items
|
array [AdUnit] |
The ad units returned in this list response. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||
etag
|
string |
ETag of this response for caching purposes. |
Get the specified custom channel from the specified ad client for the specified account.
Name | Data Type | Description |
---|---|---|
customChannelId
|
string |
Custom channel to retrieve. |
adClientId
|
string |
Ad client which contains the custom channel. |
accountId
|
string |
Account to which the ad client belongs. |
Name | Data Type | Description |
---|---|---|
userIp
|
string |
Deprecated. Please use quotaUser instead. |
quotaUser
|
string |
An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
prettyPrint
|
boolean Default value: true
|
Returns response with indentations and line breaks. |
oauth_token
|
string |
OAuth 2.0 token for the current user. |
key
|
string |
API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. |
fields
|
string |
Selector specifying which fields to include in a partial response. |
alt
|
string Default value: json Allowed values: - csv - json |
Data format for the response. |
Name | Data Type | Description |
---|---|---|
CustomChannel
|
object |
targetingInfo
|
||
name
|
string |
Name of this custom channel. |
kind
|
string Default value: adsense#customChannel
|
Kind of resource this is, in this case adsense#customChannel. |
id
|
string |
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. |
code
|
string |
Code of this custom channel, not necessarily unique across ad clients. |
List all custom channels in the specified ad client for the specified account.
Name | Data Type | Description |
---|---|---|
adClientId
|
string |
Ad client for which to list custom channels. |
accountId
|
string |
Account to which the ad client belongs. |
Name | Data Type | Description |
---|---|---|
userIp
|
string |
Deprecated. Please use quotaUser instead. |
quotaUser
|
string |
An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
prettyPrint
|
boolean Default value: true
|
Returns response with indentations and line breaks. |
oauth_token
|
string |
OAuth 2.0 token for the current user. |
key
|
string |
API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. |
fields
|
string |
Selector specifying which fields to include in a partial response. |
alt
|
string Default value: json Allowed values: - csv - json |
Data format for the response. |
pageToken
|
string |
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. |
maxResults
|
integer Minimum: 0 Maximum: 10000 |
The maximum number of custom channels to include in the response, used for paging. |
Name | Data Type | Description |
---|---|---|
CustomChannels
|
object |
nextPageToken
|
string |
Continuation token used to page through custom channels. To retrieve the next page of results, set the next request's "pageToken" value to this. |
|||||||||||||||||||
kind
|
string Default value: adsense#customChannels
|
Kind of list this is, in this case adsense#customChannels. |
|||||||||||||||||||
items
|
array [CustomChannel] |
The custom channels returned in this list response. |
|||||||||||||||||||
Properties
|
|||||||||||||||||||||
etag
|
string |
ETag of this response for caching purposes. |
List all URL channels in the specified ad client for the specified account.
Name | Data Type | Description |
---|---|---|
adClientId
|
string |
Ad client for which to list URL channels. |
accountId
|
string |
Account to which the ad client belongs. |
Name | Data Type | Description |
---|---|---|
userIp
|
string |
Deprecated. Please use quotaUser instead. |
quotaUser
|
string |
An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
prettyPrint
|
boolean Default value: true
|
Returns response with indentations and line breaks. |
oauth_token
|
string |
OAuth 2.0 token for the current user. |
key
|
string |
API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. |
fields
|
string |
Selector specifying which fields to include in a partial response. |
alt
|
string Default value: json Allowed values: - csv - json |
Data format for the response. |
pageToken
|
string |
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. |
maxResults
|
integer Minimum: 0 Maximum: 10000 |
The maximum number of URL channels to include in the response, used for paging. |
Name | Data Type | Description |
---|---|---|
UrlChannels
|
object |
nextPageToken
|
string |
Continuation token used to page through URL channels. To retrieve the next page of results, set the next request's "pageToken" value to this. |
|||||||||||||
kind
|
string Default value: adsense#urlChannels
|
Kind of list this is, in this case adsense#urlChannels. |
|||||||||||||
items
|
array [UrlChannel] |
The URL channels returned in this list response. |
|||||||||||||
Properties
|
|||||||||||||||
etag
|
string |
ETag of this response for caching purposes. |
List all ad clients in the specified account.
Name | Data Type | Description |
---|---|---|
accountId
|
string |
Account for which to list ad clients. |
Name | Data Type | Description |
---|---|---|
userIp
|
string |
Deprecated. Please use quotaUser instead. |
quotaUser
|
string |
An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
prettyPrint
|
boolean Default value: true
|
Returns response with indentations and line breaks. |
oauth_token
|
string |
OAuth 2.0 token for the current user. |
key
|
string |
API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. |
fields
|
string |
Selector specifying which fields to include in a partial response. |
alt
|
string Default value: json Allowed values: - csv - json |
Data format for the response. |
pageToken
|
string |
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. |
maxResults
|
integer Minimum: 0 Maximum: 10000 |
The maximum number of ad clients to include in the response, used for paging. |
Name | Data Type | Description |
---|---|---|
AdClients
|
object |
nextPageToken
|
string |
Continuation token used to page through ad clients. To retrieve the next page of results, set the next request's "pageToken" value to this. |
|||||||||||||||||||
kind
|
string Default value: adsense#adClients
|
Kind of list this is, in this case adsense#adClients. |
|||||||||||||||||||
items
|
array [AdClient] |
The ad clients returned in this list response. |
|||||||||||||||||||
Properties
|
|||||||||||||||||||||
etag
|
string |
ETag of this response for caching purposes. |
Dismiss (delete) the specified alert from the specified publisher AdSense account.
Name | Data Type | Description |
---|---|---|
alertId
|
string |
Alert to delete. |
accountId
|
string |
Account which contains the ad unit. |
Name | Data Type | Description |
---|---|---|
userIp
|
string |
Deprecated. Please use quotaUser instead. |
quotaUser
|
string |
An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
prettyPrint
|
boolean Default value: true
|
Returns response with indentations and line breaks. |
oauth_token
|
string |
OAuth 2.0 token for the current user. |
key
|
string |
API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. |
fields
|
string |
Selector specifying which fields to include in a partial response. |
alt
|
string Default value: json Allowed values: - csv - json |
Data format for the response. |
List the alerts for the specified AdSense account.
Name | Data Type | Description |
---|---|---|
accountId
|
string |
Account for which to retrieve the alerts. |
Name | Data Type | Description |
---|---|---|
userIp
|
string |
Deprecated. Please use quotaUser instead. |
quotaUser
|
string |
An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
prettyPrint
|
boolean Default value: true
|
Returns response with indentations and line breaks. |
oauth_token
|
string |
OAuth 2.0 token for the current user. |
key
|
string |
API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. |
fields
|
string |
Selector specifying which fields to include in a partial response. |
alt
|
string Default value: json Allowed values: - csv - json |
Data format for the response. |
locale
|
string |
The locale to use for translating alert messages. The account locale will be used if this is not supplied. The AdSense default (English) will be used if the supplied locale is invalid or unsupported. |
Name | Data Type | Description |
---|---|---|
Alerts
|
object |
kind
|
string Default value: adsense#alerts
|
Kind of list this is, in this case adsense#alerts. |
||||||||||||||||||||||
items
|
array [Alert] |
The alerts returned in this list response. |
||||||||||||||||||||||
Properties
|
List the payments for the specified AdSense account.
Name | Data Type | Description |
---|---|---|
accountId
|
string |
Account for which to retrieve the payments. |
Name | Data Type | Description |
---|---|---|
userIp
|
string |
Deprecated. Please use quotaUser instead. |
quotaUser
|
string |
An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
prettyPrint
|
boolean Default value: true
|
Returns response with indentations and line breaks. |
oauth_token
|
string |
OAuth 2.0 token for the current user. |
key
|
string |
API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. |
fields
|
string |
Selector specifying which fields to include in a partial response. |
alt
|
string Default value: json Allowed values: - csv - json |
Data format for the response. |
Name | Data Type | Description |
---|---|---|
Payments
|
object |
kind
|
string Default value: adsense#payments
|
Kind of list this is, in this case adsense#payments. |
|||||||||||||||||||
items
|
array [Payment] |
The list of Payments for the account. One or both of a) the account's most recent payment; and b) the account's upcoming payment. |
|||||||||||||||||||
Properties
|
List all saved reports in the specified AdSense account.
Name | Data Type | Description |
---|---|---|
accountId
|
string |
Account to which the saved reports belong. |
Name | Data Type | Description |
---|---|---|
userIp
|
string |
Deprecated. Please use quotaUser instead. |
quotaUser
|
string |
An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
prettyPrint
|
boolean Default value: true
|
Returns response with indentations and line breaks. |
oauth_token
|
string |
OAuth 2.0 token for the current user. |
key
|
string |
API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. |
fields
|
string |
Selector specifying which fields to include in a partial response. |
alt
|
string Default value: json Allowed values: - csv - json |
Data format for the response. |
pageToken
|
string |
A continuation token, used to page through saved reports. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response. |
maxResults
|
integer Minimum: 0 Maximum: 100 |
The maximum number of saved reports to include in the response, used for paging. |
Name | Data Type | Description |
---|---|---|
SavedReports
|
object |
nextPageToken
|
string |
Continuation token used to page through saved reports. To retrieve the next page of results, set the next request's "pageToken" value to this. |
|||||||||||||
kind
|
string Default value: adsense#savedReports
|
Kind of list this is, in this case adsense#savedReports. |
|||||||||||||
items
|
array [SavedReport] |
The saved reports returned in this list response. |
|||||||||||||
Properties
|
|||||||||||||||
etag
|
string |
ETag of this response for caching purposes. |
Generate an AdSense report based on the saved report ID sent in the query parameters.
Name | Data Type | Description |
---|---|---|
savedReportId
|
string |
The saved report to retrieve. |
accountId
|
string |
Account to which the saved reports belong. |
Name | Data Type | Description |
---|---|---|
userIp
|
string |
Deprecated. Please use quotaUser instead. |
quotaUser
|
string |
An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
prettyPrint
|
boolean Default value: true
|
Returns response with indentations and line breaks. |
oauth_token
|
string |
OAuth 2.0 token for the current user. |
key
|
string |
API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. |
fields
|
string |
Selector specifying which fields to include in a partial response. |
alt
|
string Default value: json Allowed values: - csv - json |
Data format for the response. |
startIndex
|
integer Minimum: 0 Maximum: 5000 |
Index of the first row of report data to return. |
maxResults
|
integer Minimum: 0 Maximum: 50000 |
The maximum number of rows of report data to return. |
locale
|
string |
Optional locale to use for translating report output to a local language. Defaults to "en_US" if not specified. |
Name | Data Type | Description |
---|---|---|
AdsenseReportsGenerateResponse
|
object |
warnings
|
array [string] |
Any warnings associated with generation of the report. |
totals
|
array [string] |
The totals of the report. This is the same length as any other row in the report; cells corresponding to dimension columns are empty. |
totalMatchedRows
|
string |
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. |
startDate
|
string |
The requested start date in yyyy-mm-dd format. |
rows
|
array [array] |
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. |
kind
|
string Default value: adsense#report
|
Kind this is, in this case adsense#report. |
headers
|
array [object] |
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. |
endDate
|
string |
The requested end date in yyyy-mm-dd format. |
averages
|
array [string] |
The averages of the report. This is the same length as any other row in the report; cells corresponding to dimension columns are empty. |
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.
Name | Data Type | Description |
---|---|---|
accountId
|
string |
Account upon which to report. |
Name | Data Type | Description |
---|---|---|
userIp
|
string |
Deprecated. Please use quotaUser instead. |
quotaUser
|
string |
An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
prettyPrint
|
boolean Default value: true
|
Returns response with indentations and line breaks. |
oauth_token
|
string |
OAuth 2.0 token for the current user. |
key
|
string |
API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. |
fields
|
string |
Selector specifying which fields to include in a partial response. |
alt
|
string Default value: json Allowed values: - csv - json |
Data format for the response. |
useTimezoneReporting
|
boolean |
Whether the report should be generated in the AdSense account's local timezone. If false default PST/PDT timezone will be used. |
startIndex
|
integer Minimum: 0 Maximum: 5000 |
Index of the first row of report data to return. |
startDate
|
string |
Start of the date range to report on in "YYYY-MM-DD" format, inclusive. |
sort
|
array |
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. |
metric
|
array |
Numeric columns to include in the report. |
maxResults
|
integer Minimum: 0 Maximum: 50000 |
The maximum number of rows of report data to return. |
locale
|
string |
Optional locale to use for translating report output to a local language. Defaults to "en_US" if not specified. |
filter
|
array |
Filters to be run on the report. |
endDate
|
string |
End of the date range to report on in "YYYY-MM-DD" format, inclusive. |
dimension
|
array |
Dimensions to base the report on. |
currency
|
string |
Optional currency to use when reporting on monetary metrics. Defaults to the account's currency if not set. |
Name | Data Type | Description |
---|---|---|
AdsenseReportsGenerateResponse
|
object |
warnings
|
array [string] |
Any warnings associated with generation of the report. |
totals
|
array [string] |
The totals of the report. This is the same length as any other row in the report; cells corresponding to dimension columns are empty. |
totalMatchedRows
|
string |
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. |
startDate
|
string |
The requested start date in yyyy-mm-dd format. |
rows
|
array [array] |
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. |
kind
|
string Default value: adsense#report
|
Kind this is, in this case adsense#report. |
headers
|
array [object] |
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. |
endDate
|
string |
The requested end date in yyyy-mm-dd format. |
averages
|
array [string] |
The averages of the report. This is the same length as any other row in the report; cells corresponding to dimension columns are empty. |
List a specific saved ad style for the specified account.
Name | Data Type | Description |
---|---|---|
savedAdStyleId
|
string |
Saved ad style to retrieve. |
accountId
|
string |
Account for which to get the saved ad style. |
Name | Data Type | Description |
---|---|---|
userIp
|
string |
Deprecated. Please use quotaUser instead. |
quotaUser
|
string |
An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
prettyPrint
|
boolean Default value: true
|
Returns response with indentations and line breaks. |
oauth_token
|
string |
OAuth 2.0 token for the current user. |
key
|
string |
API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. |
fields
|
string |
Selector specifying which fields to include in a partial response. |
alt
|
string Default value: json Allowed values: - csv - json |
Data format for the response. |
Name | Data Type | Description |
---|---|---|
SavedAdStyle
|
object |
name
|
string |
The user selected name of this SavedAdStyle. |
||||||||||||||||
kind
|
string Default value: adsense#savedAdStyle
|
Kind of resource this is, in this case adsense#savedAdStyle. |
||||||||||||||||
id
|
string |
Unique identifier of this saved ad style. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format. |
||||||||||||||||
adStyle
|
AdStyle |
The AdStyle itself. |
||||||||||||||||
Properties
|
List all saved ad styles in the specified account.
Name | Data Type | Description |
---|---|---|
accountId
|
string |
Account for which to list saved ad styles. |
Name | Data Type | Description |
---|---|---|
userIp
|
string |
Deprecated. Please use quotaUser instead. |
quotaUser
|
string |
An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
prettyPrint
|
boolean Default value: true
|
Returns response with indentations and line breaks. |
oauth_token
|
string |
OAuth 2.0 token for the current user. |
key
|
string |
API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. |
fields
|
string |
Selector specifying which fields to include in a partial response. |
alt
|
string Default value: json Allowed values: - csv - json |
Data format for the response. |
pageToken
|
string |
A continuation token, used to page through saved ad styles. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response. |
maxResults
|
integer Minimum: 0 Maximum: 10000 |
The maximum number of saved ad styles to include in the response, used for paging. |
Name | Data Type | Description |
---|---|---|
SavedAdStyles
|
object |
nextPageToken
|
string |
Continuation token used to page through ad units. To retrieve the next page of results, set the next request's "pageToken" value to this. |
|||||||||||||||||||||||||||||||||||
kind
|
string Default value: adsense#savedAdStyles
|
Kind of list this is, in this case adsense#savedAdStyles. |
|||||||||||||||||||||||||||||||||||
items
|
array [SavedAdStyle] |
The saved ad styles returned in this list response. |
|||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||
etag
|
string |
ETag of this response for caching purposes. |
Get information about the selected AdSense account.
Name | Data Type | Description |
---|---|---|
accountId
|
string |
Account to get information about. |
Name | Data Type | Description |
---|---|---|
userIp
|
string |
Deprecated. Please use quotaUser instead. |
quotaUser
|
string |
An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
prettyPrint
|
boolean Default value: true
|
Returns response with indentations and line breaks. |
oauth_token
|
string |
OAuth 2.0 token for the current user. |
key
|
string |
API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. |
fields
|
string |
Selector specifying which fields to include in a partial response. |
alt
|
string Default value: json Allowed values: - csv - json |
Data format for the response. |
tree
|
boolean |
Whether the tree of sub accounts should be returned. |
Name | Data Type | Description |
---|---|---|
Account
|
object |
timezone
|
string |
AdSense timezone of this account. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||
subAccounts
|
array [Account] |
Sub accounts of the this account. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||
premium
|
boolean |
Whether this account is premium. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||
name
|
string |
Name of this account. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||
kind
|
string Default value: adsense#account
|
Kind of resource this is, in this case adsense#account. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||
id
|
string |
Unique identifier of this account. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||
creation_time
|
string |
List all accounts available to this AdSense account.
Name | Data Type | Description |
---|---|---|
userIp
|
string |
Deprecated. Please use quotaUser instead. |
quotaUser
|
string |
An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
prettyPrint
|
boolean Default value: true
|
Returns response with indentations and line breaks. |
oauth_token
|
string |
OAuth 2.0 token for the current user. |
key
|
string |
API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. |
fields
|
string |
Selector specifying which fields to include in a partial response. |
alt
|
string Default value: json Allowed values: - csv - json |
Data format for the response. |
pageToken
|
string |
A continuation token, used to page through accounts. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response. |
maxResults
|
integer Minimum: 0 Maximum: 10000 |
The maximum number of accounts to include in the response, used for paging. |
Name | Data Type | Description |
---|---|---|
Accounts
|
object |
nextPageToken
|
string |
Continuation token used to page through accounts. To retrieve the next page of results, set the next request's "pageToken" value to this. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||
kind
|
string Default value: adsense#accounts
|
Kind of list this is, in this case adsense#accounts. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||
items
|
array [Account] |
The accounts returned in this list response. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||
etag
|
string |
ETag of this response for caching purposes. |
List all ad clients in this AdSense account.
Name | Data Type | Description |
---|---|---|
userIp
|
string |
Deprecated. Please use quotaUser instead. |
quotaUser
|
string |
An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
prettyPrint
|
boolean Default value: true
|
Returns response with indentations and line breaks. |
oauth_token
|
string |
OAuth 2.0 token for the current user. |
key
|
string |
API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. |
fields
|
string |
Selector specifying which fields to include in a partial response. |
alt
|
string Default value: json Allowed values: - csv - json |
Data format for the response. |
pageToken
|
string |
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. |
maxResults
|
integer Minimum: 0 Maximum: 10000 |
The maximum number of ad clients to include in the response, used for paging. |
Name | Data Type | Description |
---|---|---|
AdClients
|
object |
nextPageToken
|
string |
Continuation token used to page through ad clients. To retrieve the next page of results, set the next request's "pageToken" value to this. |
|||||||||||||||||||
kind
|
string Default value: adsense#adClients
|
Kind of list this is, in this case adsense#adClients. |
|||||||||||||||||||
items
|
array [AdClient] |
The ad clients returned in this list response. |
|||||||||||||||||||
Properties
|
|||||||||||||||||||||
etag
|
string |
ETag of this response for caching purposes. |
Get ad code for the specified ad unit.
Name | Data Type | Description |
---|---|---|
adUnitId
|
string |
Ad unit to get the code for. |
adClientId
|
string |
Ad client with contains the ad unit. |
Name | Data Type | Description |
---|---|---|
userIp
|
string |
Deprecated. Please use quotaUser instead. |
quotaUser
|
string |
An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
prettyPrint
|
boolean Default value: true
|
Returns response with indentations and line breaks. |
oauth_token
|
string |
OAuth 2.0 token for the current user. |
key
|
string |
API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. |
fields
|
string |
Selector specifying which fields to include in a partial response. |
alt
|
string Default value: json Allowed values: - csv - json |
Data format for the response. |
Name | Data Type | Description |
---|---|---|
AdCode
|
object |
kind
|
string Default value: adsense#adCode
|
Kind this is, in this case adsense#adCode. |
ampHead
|
string |
The AMP Auto ad code snippet that goes in the head of an AMP page. |
ampBody
|
string |
The AMP Auto ad code snippet that goes in the body of an AMP page. |
adCode
|
string |
The Auto ad code snippet. The ad code snippet. |
List all custom channels which the specified ad unit belongs to.
Name | Data Type | Description |
---|---|---|
adUnitId
|
string |
Ad unit for which to list custom channels. |
adClientId
|
string |
Ad client which contains the ad unit. |
Name | Data Type | Description |
---|---|---|
userIp
|
string |
Deprecated. Please use quotaUser instead. |
quotaUser
|
string |
An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
prettyPrint
|
boolean Default value: true
|
Returns response with indentations and line breaks. |
oauth_token
|
string |
OAuth 2.0 token for the current user. |
key
|
string |
API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. |
fields
|
string |
Selector specifying which fields to include in a partial response. |
alt
|
string Default value: json Allowed values: - csv - json |
Data format for the response. |
pageToken
|
string |
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. |
maxResults
|
integer Minimum: 0 Maximum: 10000 |
The maximum number of custom channels to include in the response, used for paging. |
Name | Data Type | Description |
---|---|---|
CustomChannels
|
object |
nextPageToken
|
string |
Continuation token used to page through custom channels. To retrieve the next page of results, set the next request's "pageToken" value to this. |
|||||||||||||||||||
kind
|
string Default value: adsense#customChannels
|
Kind of list this is, in this case adsense#customChannels. |
|||||||||||||||||||
items
|
array [CustomChannel] |
The custom channels returned in this list response. |
|||||||||||||||||||
Properties
|
|||||||||||||||||||||
etag
|
string |
ETag of this response for caching purposes. |
Gets the specified ad unit in the specified ad client.
Name | Data Type | Description |
---|---|---|
adUnitId
|
string |
Ad unit to retrieve. |
adClientId
|
string |
Ad client for which to get the ad unit. |
Name | Data Type | Description |
---|---|---|
userIp
|
string |
Deprecated. Please use quotaUser instead. |
quotaUser
|
string |
An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
prettyPrint
|
boolean Default value: true
|
Returns response with indentations and line breaks. |
oauth_token
|
string |
OAuth 2.0 token for the current user. |
key
|
string |
API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. |
fields
|
string |
Selector specifying which fields to include in a partial response. |
alt
|
string Default value: json Allowed values: - csv - json |
Data format for the response. |
Name | Data Type | Description |
---|---|---|
AdUnit
|
object |
status
|
string |
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. |
||||||||||||||||
savedStyleId
|
string |
ID of the saved ad style which holds this ad unit's style information. |
||||||||||||||||
name
|
string |
Name of this ad unit. |
||||||||||||||||
mobileContentAdsSettings
|
||||||||||||||||||
kind
|
string Default value: adsense#adUnit
|
Kind of resource this is, in this case adsense#adUnit. |
||||||||||||||||
id
|
string |
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. |
||||||||||||||||
feedAdsSettings
|
||||||||||||||||||
customStyle
|
AdStyle |
Custom style information specific to this ad unit. |
||||||||||||||||
Properties
|
||||||||||||||||||
contentAdsSettings
|
||||||||||||||||||
code
|
string |
Identity code of this ad unit, not necessarily unique across ad clients. |
List all ad units in the specified ad client for this AdSense account.
Name | Data Type | Description |
---|---|---|
adClientId
|
string |
Ad client for which to list ad units. |
Name | Data Type | Description |
---|---|---|
userIp
|
string |
Deprecated. Please use quotaUser instead. |
quotaUser
|
string |
An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
prettyPrint
|
boolean Default value: true
|
Returns response with indentations and line breaks. |
oauth_token
|
string |
OAuth 2.0 token for the current user. |
key
|
string |
API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. |
fields
|
string |
Selector specifying which fields to include in a partial response. |
alt
|
string Default value: json Allowed values: - csv - json |
Data format for the response. |
pageToken
|
string |
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. |
maxResults
|
integer Minimum: 0 Maximum: 10000 |
The maximum number of ad units to include in the response, used for paging. |
includeInactive
|
boolean |
Whether to include inactive ad units. Default: true. |
Name | Data Type | Description |
---|---|---|
AdUnits
|
object |
nextPageToken
|
string |
Continuation token used to page through ad units. To retrieve the next page of results, set the next request's "pageToken" value to this. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||
kind
|
string Default value: adsense#adUnits
|
Kind of list this is, in this case adsense#adUnits. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||
items
|
array [AdUnit] |
The ad units returned in this list response. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||
etag
|
string |
ETag of this response for caching purposes. |
Dismiss (delete) the specified alert from the publisher's AdSense account.
Name | Data Type | Description |
---|---|---|
alertId
|
string |
Alert to delete. |
Name | Data Type | Description |
---|---|---|
userIp
|
string |
Deprecated. Please use quotaUser instead. |
quotaUser
|
string |
An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
prettyPrint
|
boolean Default value: true
|
Returns response with indentations and line breaks. |
oauth_token
|
string |
OAuth 2.0 token for the current user. |
key
|
string |
API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. |
fields
|
string |
Selector specifying which fields to include in a partial response. |
alt
|
string Default value: json Allowed values: - csv - json |
Data format for the response. |
List the alerts for this AdSense account.
Name | Data Type | Description |
---|---|---|
userIp
|
string |
Deprecated. Please use quotaUser instead. |
quotaUser
|
string |
An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
prettyPrint
|
boolean Default value: true
|
Returns response with indentations and line breaks. |
oauth_token
|
string |
OAuth 2.0 token for the current user. |
key
|
string |
API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. |
fields
|
string |
Selector specifying which fields to include in a partial response. |
alt
|
string Default value: json Allowed values: - csv - json |
Data format for the response. |
locale
|
string |
The locale to use for translating alert messages. The account locale will be used if this is not supplied. The AdSense default (English) will be used if the supplied locale is invalid or unsupported. |
Name | Data Type | Description |
---|---|---|
Alerts
|
object |
kind
|
string Default value: adsense#alerts
|
Kind of list this is, in this case adsense#alerts. |
||||||||||||||||||||||
items
|
array [Alert] |
The alerts returned in this list response. |
||||||||||||||||||||||
Properties
|
List all ad units in the specified custom channel.
Name | Data Type | Description |
---|---|---|
customChannelId
|
string |
Custom channel for which to list ad units. |
adClientId
|
string |
Ad client which contains the custom channel. |
Name | Data Type | Description |
---|---|---|
userIp
|
string |
Deprecated. Please use quotaUser instead. |
quotaUser
|
string |
An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
prettyPrint
|
boolean Default value: true
|
Returns response with indentations and line breaks. |
oauth_token
|
string |
OAuth 2.0 token for the current user. |
key
|
string |
API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. |
fields
|
string |
Selector specifying which fields to include in a partial response. |
alt
|
string Default value: json Allowed values: - csv - json |
Data format for the response. |
pageToken
|
string |
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. |
maxResults
|
integer Minimum: 0 Maximum: 10000 |
The maximum number of ad units to include in the response, used for paging. |
includeInactive
|
boolean |
Whether to include inactive ad units. Default: true. |
Name | Data Type | Description |
---|---|---|
AdUnits
|
object |
nextPageToken
|
string |
Continuation token used to page through ad units. To retrieve the next page of results, set the next request's "pageToken" value to this. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||
kind
|
string Default value: adsense#adUnits
|
Kind of list this is, in this case adsense#adUnits. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||
items
|
array [AdUnit] |
The ad units returned in this list response. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||
etag
|
string |
ETag of this response for caching purposes. |
Get the specified custom channel from the specified ad client.
Name | Data Type | Description |
---|---|---|
customChannelId
|
string |
Custom channel to retrieve. |
adClientId
|
string |
Ad client which contains the custom channel. |
Name | Data Type | Description |
---|---|---|
userIp
|
string |
Deprecated. Please use quotaUser instead. |
quotaUser
|
string |
An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
prettyPrint
|
boolean Default value: true
|
Returns response with indentations and line breaks. |
oauth_token
|
string |
OAuth 2.0 token for the current user. |
key
|
string |
API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. |
fields
|
string |
Selector specifying which fields to include in a partial response. |
alt
|
string Default value: json Allowed values: - csv - json |
Data format for the response. |
Name | Data Type | Description |
---|---|---|
CustomChannel
|
object |
targetingInfo
|
||
name
|
string |
Name of this custom channel. |
kind
|
string Default value: adsense#customChannel
|
Kind of resource this is, in this case adsense#customChannel. |
id
|
string |
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. |
code
|
string |
Code of this custom channel, not necessarily unique across ad clients. |
List all custom channels in the specified ad client for this AdSense account.
Name | Data Type | Description |
---|---|---|
adClientId
|
string |
Ad client for which to list custom channels. |
Name | Data Type | Description |
---|---|---|
userIp
|
string |
Deprecated. Please use quotaUser instead. |
quotaUser
|
string |
An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
prettyPrint
|
boolean Default value: true
|
Returns response with indentations and line breaks. |
oauth_token
|
string |
OAuth 2.0 token for the current user. |
key
|
string |
API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. |
fields
|
string |
Selector specifying which fields to include in a partial response. |
alt
|
string Default value: json Allowed values: - csv - json |
Data format for the response. |
pageToken
|
string |
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. |
maxResults
|
integer Minimum: 0 Maximum: 10000 |
The maximum number of custom channels to include in the response, used for paging. |
Name | Data Type | Description |
---|---|---|
CustomChannels
|
object |
nextPageToken
|
string |
Continuation token used to page through custom channels. To retrieve the next page of results, set the next request's "pageToken" value to this. |
|||||||||||||||||||
kind
|
string Default value: adsense#customChannels
|
Kind of list this is, in this case adsense#customChannels. |
|||||||||||||||||||
items
|
array [CustomChannel] |
The custom channels returned in this list response. |
|||||||||||||||||||
Properties
|
|||||||||||||||||||||
etag
|
string |
ETag of this response for caching purposes. |
List the metadata for the dimensions available to this AdSense account.
Name | Data Type | Description |
---|---|---|
userIp
|
string |
Deprecated. Please use quotaUser instead. |
quotaUser
|
string |
An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
prettyPrint
|
boolean Default value: true
|
Returns response with indentations and line breaks. |
oauth_token
|
string |
OAuth 2.0 token for the current user. |
key
|
string |
API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. |
fields
|
string |
Selector specifying which fields to include in a partial response. |
alt
|
string Default value: json Allowed values: - csv - json |
Data format for the response. |
Name | Data Type | Description |
---|---|---|
Metadata
|
object |
kind
|
string Default value: adsense#metadata
|
Kind of list this is, in this case adsense#metadata. |
|||||||||||||||||||||||||
items
|
array [ReportingMetadataEntry] | ||||||||||||||||||||||||||
Properties
|
List the metadata for the metrics available to this AdSense account.
Name | Data Type | Description |
---|---|---|
userIp
|
string |
Deprecated. Please use quotaUser instead. |
quotaUser
|
string |
An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
prettyPrint
|
boolean Default value: true
|
Returns response with indentations and line breaks. |
oauth_token
|
string |
OAuth 2.0 token for the current user. |
key
|
string |
API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. |
fields
|
string |
Selector specifying which fields to include in a partial response. |
alt
|
string Default value: json Allowed values: - csv - json |
Data format for the response. |
Name | Data Type | Description |
---|---|---|
Metadata
|
object |
kind
|
string Default value: adsense#metadata
|
Kind of list this is, in this case adsense#metadata. |
|||||||||||||||||||||||||
items
|
array [ReportingMetadataEntry] | ||||||||||||||||||||||||||
Properties
|
List the payments for this AdSense account.
Name | Data Type | Description |
---|---|---|
userIp
|
string |
Deprecated. Please use quotaUser instead. |
quotaUser
|
string |
An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
prettyPrint
|
boolean Default value: true
|
Returns response with indentations and line breaks. |
oauth_token
|
string |
OAuth 2.0 token for the current user. |
key
|
string |
API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. |
fields
|
string |
Selector specifying which fields to include in a partial response. |
alt
|
string Default value: json Allowed values: - csv - json |
Data format for the response. |
Name | Data Type | Description |
---|---|---|
Payments
|
object |
kind
|
string Default value: adsense#payments
|
Kind of list this is, in this case adsense#payments. |
|||||||||||||||||||
items
|
array [Payment] |
The list of Payments for the account. One or both of a) the account's most recent payment; and b) the account's upcoming payment. |
|||||||||||||||||||
Properties
|
List all saved reports in this AdSense account.
Name | Data Type | Description |
---|---|---|
userIp
|
string |
Deprecated. Please use quotaUser instead. |
quotaUser
|
string |
An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
prettyPrint
|
boolean Default value: true
|
Returns response with indentations and line breaks. |
oauth_token
|
string |
OAuth 2.0 token for the current user. |
key
|
string |
API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. |
fields
|
string |
Selector specifying which fields to include in a partial response. |
alt
|
string Default value: json Allowed values: - csv - json |
Data format for the response. |
pageToken
|
string |
A continuation token, used to page through saved reports. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response. |
maxResults
|
integer Minimum: 0 Maximum: 100 |
The maximum number of saved reports to include in the response, used for paging. |
Name | Data Type | Description |
---|---|---|
SavedReports
|
object |
nextPageToken
|
string |
Continuation token used to page through saved reports. To retrieve the next page of results, set the next request's "pageToken" value to this. |
|||||||||||||
kind
|
string Default value: adsense#savedReports
|
Kind of list this is, in this case adsense#savedReports. |
|||||||||||||
items
|
array [SavedReport] |
The saved reports returned in this list response. |
|||||||||||||
Properties
|
|||||||||||||||
etag
|
string |
ETag of this response for caching purposes. |
Generate an AdSense report based on the saved report ID sent in the query parameters.
Name | Data Type | Description |
---|---|---|
savedReportId
|
string |
The saved report to retrieve. |
Name | Data Type | Description |
---|---|---|
userIp
|
string |
Deprecated. Please use quotaUser instead. |
quotaUser
|
string |
An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
prettyPrint
|
boolean Default value: true
|
Returns response with indentations and line breaks. |
oauth_token
|
string |
OAuth 2.0 token for the current user. |
key
|
string |
API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. |
fields
|
string |
Selector specifying which fields to include in a partial response. |
alt
|
string Default value: json Allowed values: - csv - json |
Data format for the response. |
startIndex
|
integer Minimum: 0 Maximum: 5000 |
Index of the first row of report data to return. |
maxResults
|
integer Minimum: 0 Maximum: 50000 |
The maximum number of rows of report data to return. |
locale
|
string |
Optional locale to use for translating report output to a local language. Defaults to "en_US" if not specified. |
Name | Data Type | Description |
---|---|---|
AdsenseReportsGenerateResponse
|
object |
warnings
|
array [string] |
Any warnings associated with generation of the report. |
totals
|
array [string] |
The totals of the report. This is the same length as any other row in the report; cells corresponding to dimension columns are empty. |
totalMatchedRows
|
string |
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. |
startDate
|
string |
The requested start date in yyyy-mm-dd format. |
rows
|
array [array] |
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. |
kind
|
string Default value: adsense#report
|
Kind this is, in this case adsense#report. |
headers
|
array [object] |
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. |
endDate
|
string |
The requested end date in yyyy-mm-dd format. |
averages
|
array [string] |
The averages of the report. This is the same length as any other row in the report; cells corresponding to dimension columns are empty. |
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.
Name | Data Type | Description |
---|---|---|
userIp
|
string |
Deprecated. Please use quotaUser instead. |
quotaUser
|
string |
An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
prettyPrint
|
boolean Default value: true
|
Returns response with indentations and line breaks. |
oauth_token
|
string |
OAuth 2.0 token for the current user. |
key
|
string |
API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. |
fields
|
string |
Selector specifying which fields to include in a partial response. |
alt
|
string Default value: json Allowed values: - csv - json |
Data format for the response. |
useTimezoneReporting
|
boolean |
Whether the report should be generated in the AdSense account's local timezone. If false default PST/PDT timezone will be used. |
startIndex
|
integer Minimum: 0 Maximum: 5000 |
Index of the first row of report data to return. |
startDate
|
string |
Start of the date range to report on in "YYYY-MM-DD" format, inclusive. |
sort
|
array |
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. |
metric
|
array |
Numeric columns to include in the report. |
maxResults
|
integer Minimum: 0 Maximum: 50000 |
The maximum number of rows of report data to return. |
locale
|
string |
Optional locale to use for translating report output to a local language. Defaults to "en_US" if not specified. |
filter
|
array |
Filters to be run on the report. |
endDate
|
string |
End of the date range to report on in "YYYY-MM-DD" format, inclusive. |
dimension
|
array |
Dimensions to base the report on. |
currency
|
string |
Optional currency to use when reporting on monetary metrics. Defaults to the account's currency if not set. |
accountId
|
array |
Accounts upon which to report. |
Name | Data Type | Description |
---|---|---|
AdsenseReportsGenerateResponse
|
object |
warnings
|
array [string] |
Any warnings associated with generation of the report. |
totals
|
array [string] |
The totals of the report. This is the same length as any other row in the report; cells corresponding to dimension columns are empty. |
totalMatchedRows
|
string |
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. |
startDate
|
string |
The requested start date in yyyy-mm-dd format. |
rows
|
array [array] |
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. |
kind
|
string Default value: adsense#report
|
Kind this is, in this case adsense#report. |
headers
|
array [object] |
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. |
endDate
|
string |
The requested end date in yyyy-mm-dd format. |
averages
|
array [string] |
The averages of the report. This is the same length as any other row in the report; cells corresponding to dimension columns are empty. |
Get a specific saved ad style from the user's account.
Name | Data Type | Description |
---|---|---|
savedAdStyleId
|
string |
Saved ad style to retrieve. |
Name | Data Type | Description |
---|---|---|
userIp
|
string |
Deprecated. Please use quotaUser instead. |
quotaUser
|
string |
An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
prettyPrint
|
boolean Default value: true
|
Returns response with indentations and line breaks. |
oauth_token
|
string |
OAuth 2.0 token for the current user. |
key
|
string |
API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. |
fields
|
string |
Selector specifying which fields to include in a partial response. |
alt
|
string Default value: json Allowed values: - csv - json |
Data format for the response. |
Name | Data Type | Description |
---|---|---|
SavedAdStyle
|
object |
name
|
string |
The user selected name of this SavedAdStyle. |
||||||||||||||||
kind
|
string Default value: adsense#savedAdStyle
|
Kind of resource this is, in this case adsense#savedAdStyle. |
||||||||||||||||
id
|
string |
Unique identifier of this saved ad style. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format. |
||||||||||||||||
adStyle
|
AdStyle |
The AdStyle itself. |
||||||||||||||||
Properties
|
List all saved ad styles in the user's account.
Name | Data Type | Description |
---|---|---|
userIp
|
string |
Deprecated. Please use quotaUser instead. |
quotaUser
|
string |
An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
prettyPrint
|
boolean Default value: true
|
Returns response with indentations and line breaks. |
oauth_token
|
string |
OAuth 2.0 token for the current user. |
key
|
string |
API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. |
fields
|
string |
Selector specifying which fields to include in a partial response. |
alt
|
string Default value: json Allowed values: - csv - json |
Data format for the response. |
pageToken
|
string |
A continuation token, used to page through saved ad styles. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response. |
maxResults
|
integer Minimum: 0 Maximum: 10000 |
The maximum number of saved ad styles to include in the response, used for paging. |
Name | Data Type | Description |
---|---|---|
SavedAdStyles
|
object |
nextPageToken
|
string |
Continuation token used to page through ad units. To retrieve the next page of results, set the next request's "pageToken" value to this. |
|||||||||||||||||||||||||||||||||||
kind
|
string Default value: adsense#savedAdStyles
|
Kind of list this is, in this case adsense#savedAdStyles. |
|||||||||||||||||||||||||||||||||||
items
|
array [SavedAdStyle] |
The saved ad styles returned in this list response. |
|||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||
etag
|
string |
ETag of this response for caching purposes. |
List all URL channels in the specified ad client for this AdSense account.
Name | Data Type | Description |
---|---|---|
adClientId
|
string |
Ad client for which to list URL channels. |
Name | Data Type | Description |
---|---|---|
userIp
|
string |
Deprecated. Please use quotaUser instead. |
quotaUser
|
string |
An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
prettyPrint
|
boolean Default value: true
|
Returns response with indentations and line breaks. |
oauth_token
|
string |
OAuth 2.0 token for the current user. |
key
|
string |
API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. |
fields
|
string |
Selector specifying which fields to include in a partial response. |
alt
|
string Default value: json Allowed values: - csv - json |
Data format for the response. |
pageToken
|
string |
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. |
maxResults
|
integer Minimum: 0 Maximum: 10000 |
The maximum number of URL channels to include in the response, used for paging. |
Name | Data Type | Description |
---|---|---|
UrlChannels
|
object |
nextPageToken
|
string |
Continuation token used to page through URL channels. To retrieve the next page of results, set the next request's "pageToken" value to this. |
|||||||||||||
kind
|
string Default value: adsense#urlChannels
|
Kind of list this is, in this case adsense#urlChannels. |
|||||||||||||
items
|
array [UrlChannel] |
The URL channels returned in this list response. |
|||||||||||||
Properties
|
|||||||||||||||
etag
|
string |
ETag of this response for caching purposes. |
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
timezone
|
string |
AdSense timezone of this account. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
subAccounts
|
array [Account] |
Sub accounts of the this account. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
premium
|
boolean |
Whether this account is premium. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
name
|
string |
Name of this account. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
kind
|
string Default value: adsense#account
|
Kind of resource this is, in this case adsense#account. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
id
|
string |
Unique identifier of this account. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
creation_time
|
string |
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
nextPageToken
|
string |
Continuation token used to page through accounts. To retrieve the next page of results, set the next request's "pageToken" value to this. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
kind
|
string Default value: adsense#accounts
|
Kind of list this is, in this case adsense#accounts. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
items
|
array [Account] |
The accounts returned in this list response. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
etag
|
string |
ETag of this response for caching purposes. |
Name | Data Type | Description |
---|---|---|
supportsReporting
|
boolean |
Whether this ad client supports being reported on. |
productCode
|
string |
This ad client's product code, which corresponds to the PRODUCT_CODE report dimension. |
kind
|
string Default value: adsense#adClient
|
Kind of resource this is, in this case adsense#adClient. |
id
|
string |
Unique identifier of this ad client. |
arcOptIn
|
boolean |
Whether this ad client is opted in to ARC. |
Name | Data Type | Description | |||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
nextPageToken
|
string |
Continuation token used to page through ad clients. To retrieve the next page of results, set the next request's "pageToken" value to this. |
|||||||||||||||||||
kind
|
string Default value: adsense#adClients
|
Kind of list this is, in this case adsense#adClients. |
|||||||||||||||||||
items
|
array [AdClient] |
The ad clients returned in this list response. |
|||||||||||||||||||
Properties
|
|||||||||||||||||||||
etag
|
string |
ETag of this response for caching purposes. |
Name | Data Type | Description |
---|---|---|
kind
|
string Default value: adsense#adCode
|
Kind this is, in this case adsense#adCode. |
ampHead
|
string |
The AMP Auto ad code snippet that goes in the head of an AMP page. |
ampBody
|
string |
The AMP Auto ad code snippet that goes in the body of an AMP page. |
adCode
|
string |
The Auto ad code snippet. The ad code snippet. |
Name | Data Type | Description |
---|---|---|
kind
|
string Default value: adsense#adStyle
|
Kind this is, in this case adsense#adStyle. |
font
|
||
corners
|
string |
The style of the corners in the ad (deprecated: never populated, ignored). |
colors
|
Name | Data Type | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
status
|
string |
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. |
||||||||||||||||
savedStyleId
|
string |
ID of the saved ad style which holds this ad unit's style information. |
||||||||||||||||
name
|
string |
Name of this ad unit. |
||||||||||||||||
mobileContentAdsSettings
|
||||||||||||||||||
kind
|
string Default value: adsense#adUnit
|
Kind of resource this is, in this case adsense#adUnit. |
||||||||||||||||
id
|
string |
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. |
||||||||||||||||
feedAdsSettings
|
||||||||||||||||||
customStyle
|
AdStyle |
Custom style information specific to this ad unit. |
||||||||||||||||
Properties
|
||||||||||||||||||
contentAdsSettings
|
||||||||||||||||||
code
|
string |
Identity code of this ad unit, not necessarily unique across ad clients. |
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
nextPageToken
|
string |
Continuation token used to page through ad units. To retrieve the next page of results, set the next request's "pageToken" value to this. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||
kind
|
string Default value: adsense#adUnits
|
Kind of list this is, in this case adsense#adUnits. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||
items
|
array [AdUnit] |
The ad units returned in this list response. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||
etag
|
string |
ETag of this response for caching purposes. |
Name | Data Type | Description |
---|---|---|
warnings
|
array [string] |
Any warnings associated with generation of the report. |
totals
|
array [string] |
The totals of the report. This is the same length as any other row in the report; cells corresponding to dimension columns are empty. |
totalMatchedRows
|
string |
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. |
startDate
|
string |
The requested start date in yyyy-mm-dd format. |
rows
|
array [array] |
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. |
kind
|
string Default value: adsense#report
|
Kind this is, in this case adsense#report. |
headers
|
array [object] |
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. |
endDate
|
string |
The requested end date in yyyy-mm-dd format. |
averages
|
array [string] |
The averages of the report. This is the same length as any other row in the report; cells corresponding to dimension columns are empty. |
Name | Data Type | Description |
---|---|---|
type
|
string |
Type of this alert. Possible values: SELF_HOLD, MIGRATED_TO_BILLING3, ADDRESS_PIN_VERIFICATION, PHONE_PIN_VERIFICATION, CORPORATE_ENTITY, GRAYLISTED_PUBLISHER, API_HOLD. |
severity
|
string |
Severity of this alert. Possible values: INFO, WARNING, SEVERE. |
message
|
string |
The localized alert message. |
kind
|
string Default value: adsense#alert
|
Kind of resource this is, in this case adsense#alert. |
isDismissible
|
boolean |
Whether this alert can be dismissed. |
id
|
string |
Unique identifier of this alert. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format. |
Name | Data Type | Description | ||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
kind
|
string Default value: adsense#alerts
|
Kind of list this is, in this case adsense#alerts. |
||||||||||||||||||||||
items
|
array [Alert] |
The alerts returned in this list response. |
||||||||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
targetingInfo
|
||
name
|
string |
Name of this custom channel. |
kind
|
string Default value: adsense#customChannel
|
Kind of resource this is, in this case adsense#customChannel. |
id
|
string |
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. |
code
|
string |
Code of this custom channel, not necessarily unique across ad clients. |
Name | Data Type | Description | |||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
nextPageToken
|
string |
Continuation token used to page through custom channels. To retrieve the next page of results, set the next request's "pageToken" value to this. |
|||||||||||||||||||
kind
|
string Default value: adsense#customChannels
|
Kind of list this is, in this case adsense#customChannels. |
|||||||||||||||||||
items
|
array [CustomChannel] |
The custom channels returned in this list response. |
|||||||||||||||||||
Properties
|
|||||||||||||||||||||
etag
|
string |
ETag of this response for caching purposes. |
Name | Data Type | Description | |||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
kind
|
string Default value: adsense#metadata
|
Kind of list this is, in this case adsense#metadata. |
|||||||||||||||||||||||||
items
|
array [ReportingMetadataEntry] | ||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
paymentDate
|
string |
The date this payment was/will be credited to the user, or none if the payment threshold has not been met. |
paymentAmountCurrencyCode
|
string |
The currency code for the amount to be paid. |
paymentAmount
|
string |
The amount to be paid. |
kind
|
string Default value: adsense#payment
|
Kind of resource this is, in this case adsense#payment. |
id
|
string |
Unique identifier of this Payment. |
Name | Data Type | Description | |||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
kind
|
string Default value: adsense#payments
|
Kind of list this is, in this case adsense#payments. |
|||||||||||||||||||
items
|
array [Payment] |
The list of Payments for the account. One or both of a) the account's most recent payment; and b) the account's upcoming payment. |
|||||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
supportedProducts
|
array [string] |
The codes of the projects supported by the dimension or metric this reporting metadata entry describes. |
requiredMetrics
|
array [string] |
The names of the metrics which the dimension or metric this reporting metadata entry describes requires to also be present in order for the report to be valid. Omitting these will not cause an error or warning, but may result in data which cannot be correctly interpreted. |
requiredDimensions
|
array [string] |
The names of the dimensions which the dimension or metric this reporting metadata entry describes requires to also be present in order for the report to be valid. Omitting these will not cause an error or warning, but may result in data which cannot be correctly interpreted. |
kind
|
string Default value: adsense#reportingMetadataEntry
|
Kind of resource this is, in this case adsense#reportingMetadataEntry. |
id
|
string |
Unique identifier of this reporting metadata entry, corresponding to the name of the appropriate dimension or metric. |
compatibleMetrics
|
array [string] |
The names of the metrics the dimension or metric this reporting metadata entry describes is compatible with. |
compatibleDimensions
|
array [string] |
For metrics this is a list of dimension IDs which the metric is compatible with, for dimensions it is a list of compatibility groups the dimension belongs to. |
Name | Data Type | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
name
|
string |
The user selected name of this SavedAdStyle. |
||||||||||||||||
kind
|
string Default value: adsense#savedAdStyle
|
Kind of resource this is, in this case adsense#savedAdStyle. |
||||||||||||||||
id
|
string |
Unique identifier of this saved ad style. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format. |
||||||||||||||||
adStyle
|
AdStyle |
The AdStyle itself. |
||||||||||||||||
Properties
|
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
nextPageToken
|
string |
Continuation token used to page through ad units. To retrieve the next page of results, set the next request's "pageToken" value to this. |
|||||||||||||||||||||||||||||||||||
kind
|
string Default value: adsense#savedAdStyles
|
Kind of list this is, in this case adsense#savedAdStyles. |
|||||||||||||||||||||||||||||||||||
items
|
array [SavedAdStyle] |
The saved ad styles returned in this list response. |
|||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||
etag
|
string |
ETag of this response for caching purposes. |
Name | Data Type | Description |
---|---|---|
name
|
string |
This saved report's name. |
kind
|
string Default value: adsense#savedReport
|
Kind of resource this is, in this case adsense#savedReport. |
id
|
string |
Unique identifier of this saved report. |
Name | Data Type | Description | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
nextPageToken
|
string |
Continuation token used to page through saved reports. To retrieve the next page of results, set the next request's "pageToken" value to this. |
|||||||||||||
kind
|
string Default value: adsense#savedReports
|
Kind of list this is, in this case adsense#savedReports. |
|||||||||||||
items
|
array [SavedReport] |
The saved reports returned in this list response. |
|||||||||||||
Properties
|
|||||||||||||||
etag
|
string |
ETag of this response for caching purposes. |
Name | Data Type | Description |
---|---|---|
urlPattern
|
string |
URL Pattern of this URL channel. Does not include "http://" or "https://". Example: www.example.com/home |
kind
|
string Default value: adsense#urlChannel
|
Kind of resource this is, in this case adsense#urlChannel. |
id
|
string |
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. |
Name | Data Type | Description | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
nextPageToken
|
string |
Continuation token used to page through URL channels. To retrieve the next page of results, set the next request's "pageToken" value to this. |
|||||||||||||
kind
|
string Default value: adsense#urlChannels
|
Kind of list this is, in this case adsense#urlChannels. |
|||||||||||||
items
|
array [UrlChannel] |
The URL channels returned in this list response. |
|||||||||||||
Properties
|
|||||||||||||||
etag
|
string |
ETag of this response for caching purposes. |
'OAuth' Authentication Scheme
Reference: RFC5849, Section 3.5.1
Oauth 2.0 accessCode authentication
Flow:authorizationCode
https://accounts.google.com/o/oauth2/auth
https://accounts.google.com/o/oauth2/token
https://www.googleapis.com/auth/adsense
: View and manage your AdSense datahttps://www.googleapis.com/auth/adsense.readonly
: View your AdSense data
'OAuth' Authentication Scheme
Reference: RFC5849, Section 3.5.1
Oauth 2.0 implicit authentication
Flow:implicit
https://accounts.google.com/o/oauth2/auth
https://www.googleapis.com/auth/adsense
: View and manage your AdSense datahttps://www.googleapis.com/auth/adsense.readonly
: View your AdSense dataName | Google |
External URL | https://google.com |
Api Client Registration | https://console.developers.google.com |
Origin - Format | google |
Origin - Url | https://www.googleapis.com/discovery/v1/apis/adsense/v1.4/rest |
Origin - Version | v1 |
Preferred | Yes |
Provider Name | googleapis.com |
Service Name | adsense |
API Version | v1.4 |