1<html><body> 2<style> 3 4body, h1, h2, h3, div, span, p, pre, a { 5 margin: 0; 6 padding: 0; 7 border: 0; 8 font-weight: inherit; 9 font-style: inherit; 10 font-size: 100%; 11 font-family: inherit; 12 vertical-align: baseline; 13} 14 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, h2, h3 { 50 border-bottom: solid #CCC 1px; 51} 52 53.toc_element { 54 margin-top: 0.5em; 55} 56 57.firstline { 58 margin-left: 2 em; 59} 60 61.method { 62 margin-top: 1em; 63 border: solid 1px #CCC; 64 padding: 1em; 65 background: #EEE; 66} 67 68.details { 69 font-weight: bold; 70 font-size: 14px; 71} 72 73</style> 74 75<h1><a href="adsense_v2.html">AdSense Management API</a> . <a href="adsense_v2.accounts.html">accounts</a> . <a href="adsense_v2.accounts.reports.html">reports</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="adsense_v2.accounts.reports.saved.html">saved()</a></code> 79</p> 80<p class="firstline">Returns the saved Resource.</p> 81 82<p class="toc_element"> 83 <code><a href="#close">close()</a></code></p> 84<p class="firstline">Close httplib2 connections.</p> 85<p class="toc_element"> 86 <code><a href="#generate">generate(account, currencyCode=None, dateRange=None, dimensions=None, endDate_day=None, endDate_month=None, endDate_year=None, filters=None, languageCode=None, limit=None, metrics=None, orderBy=None, reportingTimeZone=None, startDate_day=None, startDate_month=None, startDate_year=None, x__xgafv=None)</a></code></p> 87<p class="firstline">Generates an ad hoc report.</p> 88<p class="toc_element"> 89 <code><a href="#generateCsv">generateCsv(account, currencyCode=None, dateRange=None, dimensions=None, endDate_day=None, endDate_month=None, endDate_year=None, filters=None, languageCode=None, limit=None, metrics=None, orderBy=None, reportingTimeZone=None, startDate_day=None, startDate_month=None, startDate_year=None, x__xgafv=None)</a></code></p> 90<p class="firstline">Generates a csv formatted ad hoc report.</p> 91<h3>Method Details</h3> 92<div class="method"> 93 <code class="details" id="close">close()</code> 94 <pre>Close httplib2 connections.</pre> 95</div> 96 97<div class="method"> 98 <code class="details" id="generate">generate(account, currencyCode=None, dateRange=None, dimensions=None, endDate_day=None, endDate_month=None, endDate_year=None, filters=None, languageCode=None, limit=None, metrics=None, orderBy=None, reportingTimeZone=None, startDate_day=None, startDate_month=None, startDate_year=None, x__xgafv=None)</code> 99 <pre>Generates an ad hoc report. 100 101Args: 102 account: string, Required. The account which owns the collection of reports. Format: accounts/{account} (required) 103 currencyCode: string, The [ISO-4217 currency code](https://en.wikipedia.org/wiki/ISO_4217) to use when reporting on monetary metrics. Defaults to the account's currency if not set. 104 dateRange: string, Date range of the report, if unset the range will be considered CUSTOM. 105 Allowed values 106 REPORTING_DATE_RANGE_UNSPECIFIED - Unspecified date range. 107 CUSTOM - A custom date range specified using the `start_date` and `end_date` fields. This is the default if no ReportingDateRange is provided. 108 TODAY - Current day. 109 YESTERDAY - Yesterday. 110 MONTH_TO_DATE - From the start of the current month to the current day. e.g. if the current date is 2020-03-12 then the range will be [2020-03-01, 2020-03-12]. 111 YEAR_TO_DATE - From the start of the current year to the current day. e.g. if the current date is 2020-03-12 then the range will be [2020-01-01, 2020-03-12]. 112 LAST_7_DAYS - Last 7 days, excluding current day. 113 LAST_30_DAYS - Last 30 days, excluding current day. 114 dimensions: string, Dimensions to base the report on. (repeated) 115 Allowed values 116 DIMENSION_UNSPECIFIED - Unspecified dimension. 117 DATE - Date dimension in YYYY-MM-DD format (e.g. "2010-02-10"). 118 WEEK - 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"). 119 MONTH - Month dimension in YYYY-MM format (e.g. "2010-02"). 120 ACCOUNT_NAME - Account name. The members of this dimension match the values from Account.display_name. 121 AD_CLIENT_ID - Unique ID of an ad client. The members of this dimension match the values from AdClient.reporting_dimension_id. 122 PRODUCT_NAME - Localized product name (e.g. "AdSense for Content", "AdSense for Search"). 123 PRODUCT_CODE - Product code (e.g. "AFC", "AFS"). The members of this dimension match the values from AdClient.product_code. 124 AD_UNIT_NAME - Ad unit name (within which an ad was served). The members of this dimension match the values from AdUnit.display_name. 125 AD_UNIT_ID - 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. 126 AD_UNIT_SIZE_NAME - Localized size of an ad unit (e.g. "728x90", "Responsive"). 127 AD_UNIT_SIZE_CODE - The size code of an ad unit (e.g. "728x90", "responsive"). 128 CUSTOM_CHANNEL_NAME - Custom channel name. The members of this dimension match the values from CustomChannel.display_name. 129 CUSTOM_CHANNEL_ID - Unique ID of a custom channel. The members of this dimension match the values from CustomChannel.reporting_dimension_id. 130 OWNED_SITE_DOMAIN_NAME - Domain name of a verified site (e.g. "example.com"). The members of this dimension match the values from Site.domain. 131 OWNED_SITE_ID - Unique ID of a verified site. The members of this dimension match the values from Site.reporting_dimension_id. 132 URL_CHANNEL_NAME - Name of a URL channel. The members of this dimension match the values from UrlChannel.uri_pattern. 133 URL_CHANNEL_ID - Unique ID of a URL channel. The members of this dimension match the values from UrlChannel.reporting_dimension_id. 134 BUYER_NETWORK_NAME - 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. 135 BUYER_NETWORK_ID - Unique (opaque) ID of an ad network that returned the winning ads for an ad request. 136 BID_TYPE_NAME - Localized bid type name (e.g. "CPC bids", "CPM bids") for a served ad. 137 BID_TYPE_CODE - Type of a bid (e.g. "cpc", "cpm") for a served ad. 138 CREATIVE_SIZE_NAME - Localized creative size name (e.g. "728x90", "Dynamic") of a served ad. 139 CREATIVE_SIZE_CODE - Creative size code (e.g. "728x90", "dynamic") of a served ad. 140 DOMAIN_NAME - 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"). 141 DOMAIN_CODE - Name of a host on which an ad was served (e.g. "www.google.com", "webcaches", "xn--bcher-kva.example"). 142 COUNTRY_NAME - Localized region name of a user viewing an ad (e.g. "United States", "France"). 143 COUNTRY_CODE - CLDR region code of a user viewing an ad (e.g. "US", "FR"). 144 PLATFORM_TYPE_NAME - Localized platform type name (e.g. "High-end mobile devices", "Desktop"). 145 PLATFORM_TYPE_CODE - Platform type code (e.g. "HighEndMobile", "Desktop"). 146 TARGETING_TYPE_NAME - Localized targeting type name (e.g. "Contextual", "Personalized", "Run of Network"). 147 TARGETING_TYPE_CODE - Targeting type code (e.g. "Keyword", "UserInterest", "RunOfNetwork"). 148 CONTENT_PLATFORM_NAME - Localized content platform name an ad request was made from (e.g. "AMP", "Web"). 149 CONTENT_PLATFORM_CODE - Content platform code an ad request was made from (e.g. "AMP", "HTML"). 150 AD_PLACEMENT_NAME - Localized ad placement name (e.g. "Ad unit", "Global settings", "Manual"). 151 AD_PLACEMENT_CODE - Ad placement code (e.g. "AD_UNIT", "ca-pub-123456:78910", "OTHER"). 152 REQUESTED_AD_TYPE_NAME - Localized requested ad type name (e.g. "Display", "Link unit", "Other"). 153 REQUESTED_AD_TYPE_CODE - Requested ad type code (e.g. "IMAGE", "RADLINK", "OTHER"). 154 SERVED_AD_TYPE_NAME - Localized served ad type name (e.g. "Display", "Link unit", "Other"). 155 SERVED_AD_TYPE_CODE - Served ad type code (e.g. "IMAGE", "RADLINK", "OTHER"). 156 AD_FORMAT_NAME - Localized ad format name indicating the way an ad is shown to the users on your site (e.g. "In-page", "Anchor", "Vignette"). 157 AD_FORMAT_CODE - Ad format code indicating the way an ad is shown to the users on your site (e.g. "ON_PAGE", "ANCHOR", "INTERSTITIAL"). 158 CUSTOM_SEARCH_STYLE_NAME - Custom search style name. 159 CUSTOM_SEARCH_STYLE_ID - Custom search style id. 160 DOMAIN_REGISTRANT - Domain registrants. 161 WEBSEARCH_QUERY_STRING - Query strings for web searches. 162 endDate_day: integer, Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. 163 endDate_month: integer, Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. 164 endDate_year: integer, Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. 165 filters: string, Filters to be run on the report. (repeated) 166 languageCode: string, The language to use for translating report output. If unspecified, this defaults to English ("en"). If the given language is not supported, report output will be returned in English. The language is specified as an [IETF BCP-47 language code](https://en.wikipedia.org/wiki/IETF_language_tag). 167 limit: integer, The maximum number of rows of report data to return. Reports producing more rows than the requested limit will be truncated. If unset, this defaults to 100,000 rows for `Reports.GenerateReport` and 1,000,000 rows for `Reports.GenerateCsvReport`, which are also the maximum values permitted here. Report truncation can be identified (for `Reports.GenerateReport` only) by comparing the number of rows returned to the value returned in `total_matched_rows`. 168 metrics: string, Required. Reporting metrics. (repeated) 169 Allowed values 170 METRIC_UNSPECIFIED - Unspecified metric. 171 PAGE_VIEWS - Number of page views. 172 AD_REQUESTS - Number of ad units that requested ads (for content ads) or search queries (for search ads). An ad request may result in zero, one, or multiple individual ad impressions depending on the size of the ad unit and whether any ads were available. 173 MATCHED_AD_REQUESTS - Requests that returned at least one ad. 174 TOTAL_IMPRESSIONS - Impressions. An impression is counted for each ad request where at least one ad has been downloaded to the user’s device and has begun to load. It is the number of ad units (for content ads) or search queries (for search ads) that showed ads. 175 IMPRESSIONS - Impressions. An impression is counted for each ad request where at least one ad has been downloaded to the user’s device and has begun to load. It is the number of ad units (for content ads) or search queries (for search ads) that showed ads. 176 INDIVIDUAL_AD_IMPRESSIONS - Ads shown. Different ad formats will display varying numbers of ads. For example, a vertical banner may consist of 2 or more ads. Also, the number of ads in an ad unit may vary depending on whether the ad unit is displaying standard text ads, expanded text ads or image ads. 177 CLICKS - Number of times a user clicked on a standard content ad. 178 PAGE_VIEWS_SPAM_RATIO - Fraction of page views considered to be spam. Only available to premium accounts. 179 AD_REQUESTS_SPAM_RATIO - Fraction of ad requests considered to be spam. Only available to premium accounts. 180 MATCHED_AD_REQUESTS_SPAM_RATIO - Fraction of ad requests that returned ads considered to be spam. Only available to premium accounts. 181 IMPRESSIONS_SPAM_RATIO - Fraction of impressions considered to be spam. Only available to premium accounts. 182 INDIVIDUAL_AD_IMPRESSIONS_SPAM_RATIO - Fraction of ad impressions considered to be spam. Only available to premium accounts. 183 CLICKS_SPAM_RATIO - Fraction of clicks considered to be spam. Only available to premium accounts. 184 AD_REQUESTS_COVERAGE - Ratio of requested ad units or queries to the number returned to the site. 185 PAGE_VIEWS_CTR - Ratio of individual page views that resulted in a click. 186 AD_REQUESTS_CTR - Ratio of ad requests that resulted in a click. 187 MATCHED_AD_REQUESTS_CTR - Ratio of clicks to matched requests. 188 IMPRESSIONS_CTR - Ratio of IMPRESSIONS that resulted in a click. 189 INDIVIDUAL_AD_IMPRESSIONS_CTR - Ratio of individual ad impressions that resulted in a click. 190 ACTIVE_VIEW_MEASURABILITY - Ratio of requests that were measurable for viewability. 191 ACTIVE_VIEW_VIEWABILITY - Ratio of requests that were viewable. 192 ACTIVE_VIEW_TIME - Mean time an ad was displayed on screen. 193 ESTIMATED_EARNINGS - Estimated earnings of the publisher. Note that earnings up to yesterday are accurate, more recent earnings are estimated due to the possibility of spam, or exchange rate fluctuations. 194 PAGE_VIEWS_RPM - Revenue per thousand page views. This is calculated by dividing the estimated revenue by the number of page views multiplied by 1000. 195 AD_REQUESTS_RPM - Revenue per thousand ad requests. This is calculated by dividing estimated revenue by the number of ad requests multiplied by 1000. 196 MATCHED_AD_REQUESTS_RPM - Revenue per thousand matched ad requests. This is calculated by dividing estimated revenue by the number of matched ad requests multiplied by 1000. 197 IMPRESSIONS_RPM - Revenue per thousand ad impressions. This is calculated by dividing estimated revenue by the number of ad impressions multiplied by 1000. 198 INDIVIDUAL_AD_IMPRESSIONS_RPM - Revenue per thousand individual ad impressions. This is calculated by dividing estimated revenue by the number of individual ad impressions multiplied by 1000. 199 COST_PER_CLICK - Amount the publisher earns each time a user clicks on an ad. CPC is calculated by dividing the estimated revenue by the number of clicks received. 200 ADS_PER_IMPRESSION - Number of ad views per impression. 201 TOTAL_EARNINGS - Total earnings. 202 WEBSEARCH_RESULT_PAGES - Number of results pages. 203 orderBy: string, The name of a dimension or metric to sort the resulting report on, can be prefixed with "+" to sort ascending or "-" to sort descending. If no prefix is specified, the column is sorted ascending. (repeated) 204 reportingTimeZone: string, Timezone in which to generate the report. If unspecified, this defaults to the account timezone. For more information, see [changing the time zone of your reports](https://support.google.com/adsense/answer/9830725). 205 Allowed values 206 REPORTING_TIME_ZONE_UNSPECIFIED - Unspecified timezone. 207 ACCOUNT_TIME_ZONE - Use the account timezone in the report. 208 GOOGLE_TIME_ZONE - Use the Google timezone in the report (America/Los_Angeles). 209 startDate_day: integer, Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. 210 startDate_month: integer, Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. 211 startDate_year: integer, Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. 212 x__xgafv: string, V1 error format. 213 Allowed values 214 1 - v1 error format 215 2 - v2 error format 216 217Returns: 218 An object of the form: 219 220 { # Result of a generated report. 221 "averages": { # Row representation. # The averages of the report. This is the same length as any other row in the report; cells corresponding to dimension columns are empty. 222 "cells": [ # Cells in the row. 223 { # Cell representation. 224 "value": "A String", # Value in the cell. The dimension cells contain strings, and the metric cells contain numbers. 225 }, 226 ], 227 }, 228 "endDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # Required. End date of the range (inclusive). 229 "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. 230 "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. 231 "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. 232 }, 233 "headers": [ # The header information; one for each dimension in the request, followed by one for each metric in the request. 234 { # The header information of the columns requested in the report. 235 "currencyCode": "A String", # The [ISO-4217 currency code](https://en.wikipedia.org/wiki/ISO_4217) of this column. Only present if the header type is METRIC_CURRENCY. 236 "name": "A String", # Required. Name of the header. 237 "type": "A String", # Required. Type of the header. 238 }, 239 ], 240 "rows": [ # The output rows of the report. Each row is a list of cells; one for each dimension in the request, followed by one for each metric in the request. 241 { # Row representation. 242 "cells": [ # Cells in the row. 243 { # Cell representation. 244 "value": "A String", # Value in the cell. The dimension cells contain strings, and the metric cells contain numbers. 245 }, 246 ], 247 }, 248 ], 249 "startDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # Required. Start date of the range (inclusive). 250 "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. 251 "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. 252 "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. 253 }, 254 "totalMatchedRows": "A String", # The total number of rows matched by the report request. 255 "totals": { # Row representation. # The totals of the report. This is the same length as any other row in the report; cells corresponding to dimension columns are empty. 256 "cells": [ # Cells in the row. 257 { # Cell representation. 258 "value": "A String", # Value in the cell. The dimension cells contain strings, and the metric cells contain numbers. 259 }, 260 ], 261 }, 262 "warnings": [ # Any warnings associated with generation of the report. These warnings are always returned in English. 263 "A String", 264 ], 265}</pre> 266</div> 267 268<div class="method"> 269 <code class="details" id="generateCsv">generateCsv(account, currencyCode=None, dateRange=None, dimensions=None, endDate_day=None, endDate_month=None, endDate_year=None, filters=None, languageCode=None, limit=None, metrics=None, orderBy=None, reportingTimeZone=None, startDate_day=None, startDate_month=None, startDate_year=None, x__xgafv=None)</code> 270 <pre>Generates a csv formatted ad hoc report. 271 272Args: 273 account: string, Required. The account which owns the collection of reports. Format: accounts/{account} (required) 274 currencyCode: string, The [ISO-4217 currency code](https://en.wikipedia.org/wiki/ISO_4217) to use when reporting on monetary metrics. Defaults to the account's currency if not set. 275 dateRange: string, Date range of the report, if unset the range will be considered CUSTOM. 276 Allowed values 277 REPORTING_DATE_RANGE_UNSPECIFIED - Unspecified date range. 278 CUSTOM - A custom date range specified using the `start_date` and `end_date` fields. This is the default if no ReportingDateRange is provided. 279 TODAY - Current day. 280 YESTERDAY - Yesterday. 281 MONTH_TO_DATE - From the start of the current month to the current day. e.g. if the current date is 2020-03-12 then the range will be [2020-03-01, 2020-03-12]. 282 YEAR_TO_DATE - From the start of the current year to the current day. e.g. if the current date is 2020-03-12 then the range will be [2020-01-01, 2020-03-12]. 283 LAST_7_DAYS - Last 7 days, excluding current day. 284 LAST_30_DAYS - Last 30 days, excluding current day. 285 dimensions: string, Dimensions to base the report on. (repeated) 286 Allowed values 287 DIMENSION_UNSPECIFIED - Unspecified dimension. 288 DATE - Date dimension in YYYY-MM-DD format (e.g. "2010-02-10"). 289 WEEK - 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"). 290 MONTH - Month dimension in YYYY-MM format (e.g. "2010-02"). 291 ACCOUNT_NAME - Account name. The members of this dimension match the values from Account.display_name. 292 AD_CLIENT_ID - Unique ID of an ad client. The members of this dimension match the values from AdClient.reporting_dimension_id. 293 PRODUCT_NAME - Localized product name (e.g. "AdSense for Content", "AdSense for Search"). 294 PRODUCT_CODE - Product code (e.g. "AFC", "AFS"). The members of this dimension match the values from AdClient.product_code. 295 AD_UNIT_NAME - Ad unit name (within which an ad was served). The members of this dimension match the values from AdUnit.display_name. 296 AD_UNIT_ID - 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. 297 AD_UNIT_SIZE_NAME - Localized size of an ad unit (e.g. "728x90", "Responsive"). 298 AD_UNIT_SIZE_CODE - The size code of an ad unit (e.g. "728x90", "responsive"). 299 CUSTOM_CHANNEL_NAME - Custom channel name. The members of this dimension match the values from CustomChannel.display_name. 300 CUSTOM_CHANNEL_ID - Unique ID of a custom channel. The members of this dimension match the values from CustomChannel.reporting_dimension_id. 301 OWNED_SITE_DOMAIN_NAME - Domain name of a verified site (e.g. "example.com"). The members of this dimension match the values from Site.domain. 302 OWNED_SITE_ID - Unique ID of a verified site. The members of this dimension match the values from Site.reporting_dimension_id. 303 URL_CHANNEL_NAME - Name of a URL channel. The members of this dimension match the values from UrlChannel.uri_pattern. 304 URL_CHANNEL_ID - Unique ID of a URL channel. The members of this dimension match the values from UrlChannel.reporting_dimension_id. 305 BUYER_NETWORK_NAME - 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. 306 BUYER_NETWORK_ID - Unique (opaque) ID of an ad network that returned the winning ads for an ad request. 307 BID_TYPE_NAME - Localized bid type name (e.g. "CPC bids", "CPM bids") for a served ad. 308 BID_TYPE_CODE - Type of a bid (e.g. "cpc", "cpm") for a served ad. 309 CREATIVE_SIZE_NAME - Localized creative size name (e.g. "728x90", "Dynamic") of a served ad. 310 CREATIVE_SIZE_CODE - Creative size code (e.g. "728x90", "dynamic") of a served ad. 311 DOMAIN_NAME - 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"). 312 DOMAIN_CODE - Name of a host on which an ad was served (e.g. "www.google.com", "webcaches", "xn--bcher-kva.example"). 313 COUNTRY_NAME - Localized region name of a user viewing an ad (e.g. "United States", "France"). 314 COUNTRY_CODE - CLDR region code of a user viewing an ad (e.g. "US", "FR"). 315 PLATFORM_TYPE_NAME - Localized platform type name (e.g. "High-end mobile devices", "Desktop"). 316 PLATFORM_TYPE_CODE - Platform type code (e.g. "HighEndMobile", "Desktop"). 317 TARGETING_TYPE_NAME - Localized targeting type name (e.g. "Contextual", "Personalized", "Run of Network"). 318 TARGETING_TYPE_CODE - Targeting type code (e.g. "Keyword", "UserInterest", "RunOfNetwork"). 319 CONTENT_PLATFORM_NAME - Localized content platform name an ad request was made from (e.g. "AMP", "Web"). 320 CONTENT_PLATFORM_CODE - Content platform code an ad request was made from (e.g. "AMP", "HTML"). 321 AD_PLACEMENT_NAME - Localized ad placement name (e.g. "Ad unit", "Global settings", "Manual"). 322 AD_PLACEMENT_CODE - Ad placement code (e.g. "AD_UNIT", "ca-pub-123456:78910", "OTHER"). 323 REQUESTED_AD_TYPE_NAME - Localized requested ad type name (e.g. "Display", "Link unit", "Other"). 324 REQUESTED_AD_TYPE_CODE - Requested ad type code (e.g. "IMAGE", "RADLINK", "OTHER"). 325 SERVED_AD_TYPE_NAME - Localized served ad type name (e.g. "Display", "Link unit", "Other"). 326 SERVED_AD_TYPE_CODE - Served ad type code (e.g. "IMAGE", "RADLINK", "OTHER"). 327 AD_FORMAT_NAME - Localized ad format name indicating the way an ad is shown to the users on your site (e.g. "In-page", "Anchor", "Vignette"). 328 AD_FORMAT_CODE - Ad format code indicating the way an ad is shown to the users on your site (e.g. "ON_PAGE", "ANCHOR", "INTERSTITIAL"). 329 CUSTOM_SEARCH_STYLE_NAME - Custom search style name. 330 CUSTOM_SEARCH_STYLE_ID - Custom search style id. 331 DOMAIN_REGISTRANT - Domain registrants. 332 WEBSEARCH_QUERY_STRING - Query strings for web searches. 333 endDate_day: integer, Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. 334 endDate_month: integer, Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. 335 endDate_year: integer, Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. 336 filters: string, Filters to be run on the report. (repeated) 337 languageCode: string, The language to use for translating report output. If unspecified, this defaults to English ("en"). If the given language is not supported, report output will be returned in English. The language is specified as an [IETF BCP-47 language code](https://en.wikipedia.org/wiki/IETF_language_tag). 338 limit: integer, The maximum number of rows of report data to return. Reports producing more rows than the requested limit will be truncated. If unset, this defaults to 100,000 rows for `Reports.GenerateReport` and 1,000,000 rows for `Reports.GenerateCsvReport`, which are also the maximum values permitted here. Report truncation can be identified (for `Reports.GenerateReport` only) by comparing the number of rows returned to the value returned in `total_matched_rows`. 339 metrics: string, Required. Reporting metrics. (repeated) 340 Allowed values 341 METRIC_UNSPECIFIED - Unspecified metric. 342 PAGE_VIEWS - Number of page views. 343 AD_REQUESTS - Number of ad units that requested ads (for content ads) or search queries (for search ads). An ad request may result in zero, one, or multiple individual ad impressions depending on the size of the ad unit and whether any ads were available. 344 MATCHED_AD_REQUESTS - Requests that returned at least one ad. 345 TOTAL_IMPRESSIONS - Impressions. An impression is counted for each ad request where at least one ad has been downloaded to the user’s device and has begun to load. It is the number of ad units (for content ads) or search queries (for search ads) that showed ads. 346 IMPRESSIONS - Impressions. An impression is counted for each ad request where at least one ad has been downloaded to the user’s device and has begun to load. It is the number of ad units (for content ads) or search queries (for search ads) that showed ads. 347 INDIVIDUAL_AD_IMPRESSIONS - Ads shown. Different ad formats will display varying numbers of ads. For example, a vertical banner may consist of 2 or more ads. Also, the number of ads in an ad unit may vary depending on whether the ad unit is displaying standard text ads, expanded text ads or image ads. 348 CLICKS - Number of times a user clicked on a standard content ad. 349 PAGE_VIEWS_SPAM_RATIO - Fraction of page views considered to be spam. Only available to premium accounts. 350 AD_REQUESTS_SPAM_RATIO - Fraction of ad requests considered to be spam. Only available to premium accounts. 351 MATCHED_AD_REQUESTS_SPAM_RATIO - Fraction of ad requests that returned ads considered to be spam. Only available to premium accounts. 352 IMPRESSIONS_SPAM_RATIO - Fraction of impressions considered to be spam. Only available to premium accounts. 353 INDIVIDUAL_AD_IMPRESSIONS_SPAM_RATIO - Fraction of ad impressions considered to be spam. Only available to premium accounts. 354 CLICKS_SPAM_RATIO - Fraction of clicks considered to be spam. Only available to premium accounts. 355 AD_REQUESTS_COVERAGE - Ratio of requested ad units or queries to the number returned to the site. 356 PAGE_VIEWS_CTR - Ratio of individual page views that resulted in a click. 357 AD_REQUESTS_CTR - Ratio of ad requests that resulted in a click. 358 MATCHED_AD_REQUESTS_CTR - Ratio of clicks to matched requests. 359 IMPRESSIONS_CTR - Ratio of IMPRESSIONS that resulted in a click. 360 INDIVIDUAL_AD_IMPRESSIONS_CTR - Ratio of individual ad impressions that resulted in a click. 361 ACTIVE_VIEW_MEASURABILITY - Ratio of requests that were measurable for viewability. 362 ACTIVE_VIEW_VIEWABILITY - Ratio of requests that were viewable. 363 ACTIVE_VIEW_TIME - Mean time an ad was displayed on screen. 364 ESTIMATED_EARNINGS - Estimated earnings of the publisher. Note that earnings up to yesterday are accurate, more recent earnings are estimated due to the possibility of spam, or exchange rate fluctuations. 365 PAGE_VIEWS_RPM - Revenue per thousand page views. This is calculated by dividing the estimated revenue by the number of page views multiplied by 1000. 366 AD_REQUESTS_RPM - Revenue per thousand ad requests. This is calculated by dividing estimated revenue by the number of ad requests multiplied by 1000. 367 MATCHED_AD_REQUESTS_RPM - Revenue per thousand matched ad requests. This is calculated by dividing estimated revenue by the number of matched ad requests multiplied by 1000. 368 IMPRESSIONS_RPM - Revenue per thousand ad impressions. This is calculated by dividing estimated revenue by the number of ad impressions multiplied by 1000. 369 INDIVIDUAL_AD_IMPRESSIONS_RPM - Revenue per thousand individual ad impressions. This is calculated by dividing estimated revenue by the number of individual ad impressions multiplied by 1000. 370 COST_PER_CLICK - Amount the publisher earns each time a user clicks on an ad. CPC is calculated by dividing the estimated revenue by the number of clicks received. 371 ADS_PER_IMPRESSION - Number of ad views per impression. 372 TOTAL_EARNINGS - Total earnings. 373 WEBSEARCH_RESULT_PAGES - Number of results pages. 374 orderBy: string, The name of a dimension or metric to sort the resulting report on, can be prefixed with "+" to sort ascending or "-" to sort descending. If no prefix is specified, the column is sorted ascending. (repeated) 375 reportingTimeZone: string, Timezone in which to generate the report. If unspecified, this defaults to the account timezone. For more information, see [changing the time zone of your reports](https://support.google.com/adsense/answer/9830725). 376 Allowed values 377 REPORTING_TIME_ZONE_UNSPECIFIED - Unspecified timezone. 378 ACCOUNT_TIME_ZONE - Use the account timezone in the report. 379 GOOGLE_TIME_ZONE - Use the Google timezone in the report (America/Los_Angeles). 380 startDate_day: integer, Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. 381 startDate_month: integer, Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. 382 startDate_year: integer, Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. 383 x__xgafv: string, V1 error format. 384 Allowed values 385 1 - v1 error format 386 2 - v2 error format 387 388Returns: 389 An object of the form: 390 391 { # Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged. 392 "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body. 393 "data": "A String", # The HTTP request/response body as raw binary. 394 "extensions": [ # Application specific response metadata. Must be set in the first response for streaming APIs. 395 { 396 "a_key": "", # Properties of the object. Contains field @type with type URL. 397 }, 398 ], 399}</pre> 400</div> 401 402</body></html>