Method: accounts.reports.search

擷取由搜尋查詢定義的報表。回應中列數可能少於 pageSize 指定的數量。請依據 nextPageToken 判斷是否還有更多列可供要求。

HTTP 要求

POST https://merchantapi.googleapis.com/reports/v1beta/{parent=accounts/*}/reports:search

這個網址使用 gRPC 轉碼語法。

路徑參數

參數
parent

string

必要欄位。發出呼叫的帳戶 ID。必須是獨立帳戶或 MCA 子帳戶。格式：accounts/{account}

要求主體

要求主體的資料會採用以下結構：

JSON 表示法 
{
  "query": string,
  "pageSize": integer,
  "pageToken": string
}
欄位
query

string

必要欄位。定義要擷取的報表的查詢。

如要進一步瞭解如何建構查詢，請參閱「查詢語言」指南。如需可用表格和欄位的完整清單，請參閱「可用欄位」。
pageSize

integer

選用設定。在單一頁面中擷取的 ReportRows 數量。預設值為 1000。超過 5000 的值會強制設為 5000。
pageToken

string

選用設定。要擷取的頁面符記。如未指定，系統會傳回第一頁結果。如要要求下一頁的結果，請使用先前回應中 nextPageToken 取得的值。

回應主體

ReportService.Search 方法的回應訊息。

如果成功，回應主體會含有以下結構的資料：

JSON 表示法 
{
  "results": [
    {
      object (ReportRow)
    }
  ],
  "nextPageToken": string
}
欄位
results[]

object (ReportRow)

與搜尋查詢相符的資料列。
nextPageToken

string

可做為 pageToken 傳送的符記，用於擷取後續網頁。如果省略這個欄位，就不會有後續頁面。

授權範圍

需要下列 OAuth 範圍：

  • https://www.googleapis.com/auth/content

詳情請參閱 OAuth 2.0 總覽。