Reports: generate

需要授权

根据查询参数中发送的报告请求生成 AdSense 报告。返回 JSON 作为结果;要获取 CSV 格式的输出,请将“alt=csv”指定为查询参数。立即尝试

请求

HTTP 请求

GET https://www.googleapis.com/adsensehost/v4.1/reports

参数

参数名称 说明
必需参数
endDate string 要生成报告的日期范围的结束日期(包含此结束日期),格式为“YYYY-MM-DD”。
startDate string 要生成报告的日期范围的开始日期(包含此开始日期),格式为“YYYY-MM-DD”。
可选参数
dimension string

报告依据的维度。可用的维度包括:

  • DATE
  • WEEK
  • MONTH
  • AD_CLIENT_ID
  • HOSTED_AD_CLIENT_ID
  • PRODUCT_CODE
  • PRODUCT_NAME
  • CUSTOM_CHANNEL_ID
  • CUSTOM_CHANNEL_CODE
  • CUSTOM_CHANNEL_NAME
  • URL_CHANNEL_ID
  • URL_CHANNEL_NAME
  • AD_FORMAT_CODE
  • AD_FORMAT_NAME
  • BID_TYPE_CODE
  • BID_TYPE_NAME
  • TARGETING_TYPE_CODE
  • TARGETING_TYPE_NAME
filter string 要在报告中运行的过滤器
locale string 用于将报告输出翻译为本地语言的可选区域设置。如果未指定,则默认为“en_US”。
maxResults unsigned integer

要返回的报告数据行数上限。

如果 startIndex 未设置或为零,则 API 将返回 maxResults 值指定的所有行。如果未设置 maxResults,则 API 将返回尽可能多的行,最多可达 50,000。

如果 startIndex 设为一个非零值,则 startIndexmaxResults 的和不得大于 5000,否则将返回一个错误:不支持超过 5000 行的分页。

可接受的值包括 050000(闭区间)。
metric string 要包含在报告中的数字列。可用的指标包括:
  • PAGE_VIEWS
  • PAGE_VIEWS_CTR
  • PAGE_VIEWS_RPM
  • AD_REQUESTS
  • AD_REQUESTS_COVERAGE
  • AD_REQUESTS_CTR
  • AD_REQUESTS_RPM
  • MATCHED_AD_REQUESTS
  • MATCHED_AD_REQUESTS_CTR
  • MATCHED_AD_REQUESTS_RPM
  • INDIVIDUAL_AD_IMPRESSIONS
  • INDIVIDUAL_AD_IMPRESSIONS_CTR
  • INDIVIDUAL_AD_IMPRESSIONS_RPM
  • CLICKS
  • EARNINGS
  • TOTAL_EARNINGS
  • COST_PER_CLICK
sort string

对生成的报告进行排序所使用的维度或指标的名称,可以选择性加上“+”前缀(按升序排序)或“-”前缀(按降序排序)。如果未指定任何前缀,则列将按升序排序。

维度和指标的合集如下所示:

  • DATE
  • WEEK
  • MONTH
  • AD_CLIENT_ID
  • HOSTED_AD_CLIENT_ID
  • PRODUCT_CODE
  • PRODUCT_NAME
  • CUSTOM_CHANNEL_ID
  • CUSTOM_CHANNEL_CODE
  • CUSTOM_CHANNEL_NAME
  • URL_CHANNEL_ID
  • URL_CHANNEL_NAME
  • AD_FORMAT_CODE
  • AD_FORMAT_NAME
  • BID_TYPE_CODE
  • BID_TYPE_NAME
  • TARGETING_TYPE_CODE
  • TARGETING_TYPE_NAME
  • PAGE_VIEWS
  • PAGE_VIEWS_CTR
  • PAGE_VIEWS_RPM
  • AD_REQUESTS
  • AD_REQUESTS_COVERAGE
  • AD_REQUESTS_CTR
  • AD_REQUESTS_RPM
  • MATCHED_AD_REQUESTS
  • MATCHED_AD_REQUESTS_CTR
  • MATCHED_AD_REQUESTS_RPM
  • INDIVIDUAL_AD_IMPRESSIONS
  • INDIVIDUAL_AD_IMPRESSIONS_CTR
  • INDIVIDUAL_AD_IMPRESSIONS_RPM
  • CLICKS
  • EARNINGS
  • TOTAL_EARNINGS
  • COST_PER_CLICK
startIndex unsigned integer

要返回的第一行报告数据的索引。

如果 startIndex 未设置或为零,则 API 将返回 maxResults 值指定的所有行。如果未设置 maxResults,则 API 将返回尽可能多的行,最多可达 50,000。

如果 startIndex 设为一个非零值,则 startIndexmaxResults 的和不得大于 5000,否则将返回一个错误:不支持超过 5000 行的分页。

可接受的值包括 05000(闭区间)。

授权

此请求至少需要获得下列其中一个范围的授权(详细了解身份验证和授权)。

范围
https://www.googleapis.com/auth/adsensehost

请求正文

不要使用此方法提供请求正文。

响应

如果成功,此方法将返回具有以下结构的响应正文:

JSON

{
  "kind": "adsensehost#report",
  "totalMatchedRows": long,
  "headers": [
    {
      "name": string,
      "type": string,
      "currency": string
    }
  ],
  "rows": [
    [
      string
    ]
  ],
  "totals": [
    string
  ],
  "averages": [
    string
  ],
  "warnings": [
    string
  ]
}
属性名称 说明 备注
kind string 种类,在此示例中为 adsensehost#report。
totalMatchedRows long 与报告请求匹配的总行数。由于受到所请求的行数或报告行的限制,响应中返回的行数可能较少。
headers[] list 报告中所请求列的标头信息。此为标头列表;每个标头对应请求中的相应维度,后跟对应请求中相应指标的标头。
headers[].name string 标头的名称。
headers[].type string 标头的类型;其中有 DIMENSION、METRIC_TALLY、METRIC_RATIO 或 METRIC_CURRENCY。
headers[].currency string 此列的币种。只有标头类型为 METRIC_CURRENCY 时才显示币种。
rows[] list 报告的输出行。每一行都是一个单元格列表;一个针对请求中每个维度的列表,后跟针对请求中每个指标的列表。维度单元格包含字符串,而指标单元格包含数字。
totals[] list 报告的总计行。该行与报告中的其他行长度相同;与维度列对应的单元格为空。
averages[] list 报告的平均行。该行与报告中的其他行长度相同;与维度列对应的单元格为空。
warnings[] list 与生成报告相关的所有警告。

CSV

"(dynamic)"
(foreach)
  (value)
(/foreach)
属性名称 说明 备注
(dynamic)"> (dynamic) (any)

立即尝试!

请使用下面的 API Explorer 针对实际数据调用此方法并查看响应。