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 多層檢視,對實際資料呼叫此方法並查看回應。

傳送您對下列選項的寶貴意見...

這個網頁
AdSense Host API
AdSense Host API