AdSense Management API (adsense:v2)

Updates

Methods


• ▼ ▲ adsense.accounts.reports.generate

  Parameters :

  dimensions

  Description : Dimensions to base the report on.

  Location : query

  Repeated : Yes

  Type : string

  Enum Descriptions :

  • Unspecified dimension.
  • Date dimension in YYYY-MM-DD format (e.g. "2010-02-10").
  • Week dimension in YYYY-MM-DD format, representing the first day of each week (e.g. "2010-02-08"). The first day of the week is determined by the language_code specified in a report generation request (so e.g. this would be a Monday for "en-GB" or "es", but a Sunday for "en" or "fr-CA").
  • Month dimension in YYYY-MM format (e.g. "2010-02").
  • Account name. The members of this dimension match the values from Account.display_name.
  • Unique ID of an ad client. The members of this dimension match the values from AdClient.reporting_dimension_id.
  • Unique ID of a sub-account's ad client. The members of this dimension match the values from AdClient.reporting_dimension_id (for the sub-account).
  • Localized product name (e.g. "AdSense for Content", "AdSense for Search").
  • Product code (e.g. "AFC", "AFS"). The members of this dimension match the values from AdClient.product_code.
  • Ad unit name (within which an ad was served). The members of this dimension match the values from AdUnit.display_name.
  • Unique ID of an ad unit (within which an ad was served). The members of this dimension match the values from AdUnit.reporting_dimension_id.
  • Localized size of an ad unit (e.g. "728x90", "Responsive").
  • The size code of an ad unit (e.g. "728x90", "responsive").
  • Custom channel name. The members of this dimension match the values from CustomChannel.display_name.
  • Unique ID of a custom channel. The members of this dimension match the values from CustomChannel.reporting_dimension_id.
  • Not supported.
  • Domain name of a verified site (e.g. "example.com"). The members of this dimension match the values from Site.domain.
  • Unique ID of a verified site. The members of this dimension match the values from Site.reporting_dimension_id.
  • URL of the page upon which the ad was served. This is a complete URL including scheme and query parameters. Note that the URL that appears in this dimension may be a canonicalized version of the one that was used in the original request, and so may not exactly match the URL that a user might have seen. Note that there are also some caveats to be aware of when using this dimension. For more information, see [Page URL breakdown](https://support.google.com/adsense/answer/11988478).
  • Name of a URL channel. The members of this dimension match the values from UrlChannel.uri_pattern.
  • Unique ID of a URL channel. The members of this dimension match the values from UrlChannel.reporting_dimension_id.
  • Name of an ad network that returned the winning ads for an ad request (e.g. "Google AdWords"). Note that unlike other "NAME" dimensions, the members of this dimensions are not localized.
  • Unique (opaque) ID of an ad network that returned the winning ads for an ad request.
  • Localized bid type name (e.g. "CPC bids", "CPM bids") for a served ad.
  • Type of a bid (e.g. "cpc", "cpm") for a served ad.
  • Localized creative size name (e.g. "728x90", "Dynamic") of a served ad.
  • Creative size code (e.g. "728x90", "dynamic") of a served ad.
  • Localized name of a host on which an ad was served, after IDNA decoding (e.g. "www.google.com", "Web caches and other", "bücher.example").
  • Name of a host on which an ad was served (e.g. "www.google.com", "webcaches", "xn--bcher-kva.example").
  • Localized region name of a user viewing an ad (e.g. "United States", "France").
  • CLDR region code of a user viewing an ad (e.g. "US", "FR").
  • Localized platform type name (e.g. "High-end mobile devices", "Desktop").
  • Platform type code (e.g. "HighEndMobile", "Desktop").
  • Localized targeting type name (e.g. "Contextual", "Personalized", "Run of Network").
  • Targeting type code (e.g. "Keyword", "UserInterest", "RunOfNetwork").
  • Localized content platform name an ad request was made from (e.g. "AMP", "Web").
  • Content platform code an ad request was made from (e.g. "AMP", "HTML").
  • Localized ad placement name (e.g. "Ad unit", "Global settings", "Manual").
  • Ad placement code (e.g. "AD_UNIT", "ca-pub-123456:78910", "OTHER").
  • Localized requested ad type name (e.g. "Display", "Link unit", "Other").
  • Requested ad type code (e.g. "IMAGE", "RADLINK", "OTHER").
  • Localized served ad type name (e.g. "Display", "Link unit", "Other").
  • Served ad type code (e.g. "IMAGE", "RADLINK", "OTHER").
  • Localized ad format name indicating the way an ad is shown to the users on your site (e.g. "In-page", "Anchor", "Vignette").
  • Ad format code indicating the way an ad is shown to the users on your site (e.g. "ON_PAGE", "ANCHOR", "INTERSTITIAL").
  • Custom search style name.
  • Custom search style id.
  • Domain registrants.
  • Query strings for web searches.

  Enumdeprecated :

  • No
  • No
  • No
  • No
  • No
  • No
  • No
  • No
  • No
  • No
  • No
  • No
  • No
  • No
  • No
  • Yes
  • No
  • No
  • No
  • No
  • No
  • No
  • No
  • No
  • No
  • No
  • No
  • No
  • No
  • No
  • No
  • No
  • No
  • No
  • No
  • No
  • No
  • No
  • No
  • No
  • No
  • No
  • No
  • No
  • No
  • No
  • No
  • No
  • No

  Enum :

  • DIMENSION_UNSPECIFIED
  • DATE
  • WEEK
  • MONTH
  • ACCOUNT_NAME
  • AD_CLIENT_ID
  • HOSTED_AD_CLIENT_ID
  • PRODUCT_NAME
  • PRODUCT_CODE
  • AD_UNIT_NAME
  • AD_UNIT_ID
  • AD_UNIT_SIZE_NAME
  • AD_UNIT_SIZE_CODE
  • CUSTOM_CHANNEL_NAME
  • CUSTOM_CHANNEL_ID
  • HOSTED_CUSTOM_CHANNEL_ID
  • OWNED_SITE_DOMAIN_NAME
  • OWNED_SITE_ID
  • PAGE_URL
  • URL_CHANNEL_NAME
  • URL_CHANNEL_ID
  • BUYER_NETWORK_NAME
  • BUYER_NETWORK_ID
  • BID_TYPE_NAME
  • BID_TYPE_CODE
  • CREATIVE_SIZE_NAME
  • CREATIVE_SIZE_CODE
  • DOMAIN_NAME
  • DOMAIN_CODE
  • COUNTRY_NAME
  • COUNTRY_CODE
  • PLATFORM_TYPE_NAME
  • PLATFORM_TYPE_CODE
  • TARGETING_TYPE_NAME
  • TARGETING_TYPE_CODE
  • CONTENT_PLATFORM_NAME
  • CONTENT_PLATFORM_CODE
  • AD_PLACEMENT_NAME
  • AD_PLACEMENT_CODE
  • REQUESTED_AD_TYPE_NAME
  • REQUESTED_AD_TYPE_CODE
  • SERVED_AD_TYPE_NAME
  • SERVED_AD_TYPE_CODE
  • AD_FORMAT_NAME
  • AD_FORMAT_CODE
  • CUSTOM_SEARCH_STYLE_NAME
  • CUSTOM_SEARCH_STYLE_ID
  • DOMAIN_REGISTRANT
  • WEBSEARCH_QUERY_STRING

• ▼ ▲ adsense.accounts.reports.generateCsv

  Parameters :

  dimensions

  Description : Dimensions to base the report on.

  Location : query

  Repeated : Yes

  Type : string

  Enum Descriptions :

  • Unspecified dimension.
  • Date dimension in YYYY-MM-DD format (e.g. "2010-02-10").
  • Week dimension in YYYY-MM-DD format, representing the first day of each week (e.g. "2010-02-08"). The first day of the week is determined by the language_code specified in a report generation request (so e.g. this would be a Monday for "en-GB" or "es", but a Sunday for "en" or "fr-CA").
  • Month dimension in YYYY-MM format (e.g. "2010-02").
  • Account name. The members of this dimension match the values from Account.display_name.
  • Unique ID of an ad client. The members of this dimension match the values from AdClient.reporting_dimension_id.
  • Unique ID of a sub-account's ad client. The members of this dimension match the values from AdClient.reporting_dimension_id (for the sub-account).
  • Localized product name (e.g. "AdSense for Content", "AdSense for Search").
  • Product code (e.g. "AFC", "AFS"). The members of this dimension match the values from AdClient.product_code.
  • Ad unit name (within which an ad was served). The members of this dimension match the values from AdUnit.display_name.
  • Unique ID of an ad unit (within which an ad was served). The members of this dimension match the values from AdUnit.reporting_dimension_id.
  • Localized size of an ad unit (e.g. "728x90", "Responsive").
  • The size code of an ad unit (e.g. "728x90", "responsive").
  • Custom channel name. The members of this dimension match the values from CustomChannel.display_name.
  • Unique ID of a custom channel. The members of this dimension match the values from CustomChannel.reporting_dimension_id.
  • Not supported.
  • Domain name of a verified site (e.g. "example.com"). The members of this dimension match the values from Site.domain.
  • Unique ID of a verified site. The members of this dimension match the values from Site.reporting_dimension_id.
  • URL of the page upon which the ad was served. This is a complete URL including scheme and query parameters. Note that the URL that appears in this dimension may be a canonicalized version of the one that was used in the original request, and so may not exactly match the URL that a user might have seen. Note that there are also some caveats to be aware of when using this dimension. For more information, see [Page URL breakdown](https://support.google.com/adsense/answer/11988478).
  • Name of a URL channel. The members of this dimension match the values from UrlChannel.uri_pattern.
  • Unique ID of a URL channel. The members of this dimension match the values from UrlChannel.reporting_dimension_id.
  • Name of an ad network that returned the winning ads for an ad request (e.g. "Google AdWords"). Note that unlike other "NAME" dimensions, the members of this dimensions are not localized.
  • Unique (opaque) ID of an ad network that returned the winning ads for an ad request.
  • Localized bid type name (e.g. "CPC bids", "CPM bids") for a served ad.
  • Type of a bid (e.g. "cpc", "cpm") for a served ad.
  • Localized creative size name (e.g. "728x90", "Dynamic") of a served ad.
  • Creative size code (e.g. "728x90", "dynamic") of a served ad.
  • Localized name of a host on which an ad was served, after IDNA decoding (e.g. "www.google.com", "Web caches and other", "bücher.example").
  • Name of a host on which an ad was served (e.g. "www.google.com", "webcaches", "xn--bcher-kva.example").
  • Localized region name of a user viewing an ad (e.g. "United States", "France").
  • CLDR region code of a user viewing an ad (e.g. "US", "FR").
  • Localized platform type name (e.g. "High-end mobile devices", "Desktop").
  • Platform type code (e.g. "HighEndMobile", "Desktop").
  • Localized targeting type name (e.g. "Contextual", "Personalized", "Run of Network").
  • Targeting type code (e.g. "Keyword", "UserInterest", "RunOfNetwork").
  • Localized content platform name an ad request was made from (e.g. "AMP", "Web").
  • Content platform code an ad request was made from (e.g. "AMP", "HTML").
  • Localized ad placement name (e.g. "Ad unit", "Global settings", "Manual").
  • Ad placement code (e.g. "AD_UNIT", "ca-pub-123456:78910", "OTHER").
  • Localized requested ad type name (e.g. "Display", "Link unit", "Other").
  • Requested ad type code (e.g. "IMAGE", "RADLINK", "OTHER").
  • Localized served ad type name (e.g. "Display", "Link unit", "Other").
  • Served ad type code (e.g. "IMAGE", "RADLINK", "OTHER").
  • Localized ad format name indicating the way an ad is shown to the users on your site (e.g. "In-page", "Anchor", "Vignette").
  • Ad format code indicating the way an ad is shown to the users on your site (e.g. "ON_PAGE", "ANCHOR", "INTERSTITIAL").
  • Custom search style name.
  • Custom search style id.
  • Domain registrants.
  • Query strings for web searches.

  Enumdeprecated :

  • No
  • No
  • No
  • No
  • No
  • No
  • No
  • No
  • No
  • No
  • No
  • No
  • No
  • No
  • No
  • Yes
  • No
  • No
  • No
  • No
  • No
  • No
  • No
  • No
  • No
  • No
  • No
  • No
  • No
  • No
  • No
  • No
  • No
  • No
  • No
  • No
  • No
  • No
  • No
  • No
  • No
  • No
  • No
  • No
  • No
  • No
  • No
  • No
  • No

  Enum :

  • DIMENSION_UNSPECIFIED
  • DATE
  • WEEK
  • MONTH
  • ACCOUNT_NAME
  • AD_CLIENT_ID
  • HOSTED_AD_CLIENT_ID
  • PRODUCT_NAME
  • PRODUCT_CODE
  • AD_UNIT_NAME
  • AD_UNIT_ID
  • AD_UNIT_SIZE_NAME
  • AD_UNIT_SIZE_CODE
  • CUSTOM_CHANNEL_NAME
  • CUSTOM_CHANNEL_ID
  • HOSTED_CUSTOM_CHANNEL_ID
  • OWNED_SITE_DOMAIN_NAME
  • OWNED_SITE_ID
  • PAGE_URL
  • URL_CHANNEL_NAME
  • URL_CHANNEL_ID
  • BUYER_NETWORK_NAME
  • BUYER_NETWORK_ID
  • BID_TYPE_NAME
  • BID_TYPE_CODE
  • CREATIVE_SIZE_NAME
  • CREATIVE_SIZE_CODE
  • DOMAIN_NAME
  • DOMAIN_CODE
  • COUNTRY_NAME
  • COUNTRY_CODE
  • PLATFORM_TYPE_NAME
  • PLATFORM_TYPE_CODE
  • TARGETING_TYPE_NAME
  • TARGETING_TYPE_CODE
  • CONTENT_PLATFORM_NAME
  • CONTENT_PLATFORM_CODE
  • AD_PLACEMENT_NAME
  • AD_PLACEMENT_CODE
  • REQUESTED_AD_TYPE_NAME
  • REQUESTED_AD_TYPE_CODE
  • SERVED_AD_TYPE_NAME
  • SERVED_AD_TYPE_CODE
  • AD_FORMAT_NAME
  • AD_FORMAT_CODE
  • CUSTOM_SEARCH_STYLE_NAME
  • CUSTOM_SEARCH_STYLE_ID
  • DOMAIN_REGISTRANT
  • WEBSEARCH_QUERY_STRING