Method: properties.reportTasks.query

擷取報表工作的內容。要求 reportTasks.create 後，您可以在報告狀態為「有效」時擷取報告內容。如果報表工作狀態不是 ACTIVE，這個方法就會傳回錯誤。查詢回應會傳回報表的表格列和欄值。

HTTP 要求

POST https://analyticsdata.googleapis.com/v1alpha/{name=properties/*/reportTasks/*}:query

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

路徑參數

參數
name

string

必填。報表來源名稱。格式：properties/{property}/reportTasks/{report}

要求主體

要求主體會包含結構如下的資料：

JSON 表示法 
{
  "offset": string,
  "limit": string
}
欄位
offset

string (int64 format)

(選用步驟) 報表起始列的列數。第一列會計為第 0 列。

分頁時，第一個要求不會指定偏移量，或等同於將偏移量設為 0；第一個要求會傳回前 limit 列。第二個要求會將偏移量設為第一個要求的 limit，並傳回第二個 limit 的資料列。

如要進一步瞭解這個分頁參數，請參閱「分頁」。
limit

string (int64 format)

(選用步驟) 要從報表傳回的列數。如未指定，系統會傳回 10,000 個資料列。無論您要求多少資料列，API 每次最多只會傳回 250,000 列。limit 必須為正數。

如果維度值的數量少於要求的 limit，API 也可能會傳回少於 limit 的資料列。QueryReportTaskRequest 可用的資料列數量，會進一步受到相關聯 ReportTask 的限制。查詢最多可擷取 ReportTask.limit 列。舉例來說，如果 ReportTask 的限制為 1,000，則 offset=900 且 limit=500 的 reportTasks.query 要求最多會傳回 100 列。

如要進一步瞭解這個分頁參數，請參閱「分頁」。

回應主體

與報表工作相應的報表內容。

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

JSON 表示法 
{
  "dimensionHeaders": [
    {
      object (DimensionHeader)
    }
  ],
  "metricHeaders": [
    {
      object (MetricHeader)
    }
  ],
  "rows": [
    {
      object (Row)
    }
  ],
  "totals": [
    {
      object (Row)
    }
  ],
  "maximums": [
    {
      object (Row)
    }
  ],
  "minimums": [
    {
      object (Row)
    }
  ],
  "rowCount": integer,
  "metadata": {
    object (ResponseMetaData)
  }
}
欄位
dimensionHeaders[]

object (DimensionHeader)

說明維度資料欄。DimensionHeaders 的數量和順序與資料列中的維度相符。
metricHeaders[]

object (MetricHeader)

說明指標資料欄。MetricHeaders 的數量和順序與資料列中的指標相符。
rows[]

object (Row)

報表中的維度值組合和指標值列。
totals[]

object (Row)

指標的總值 (如有要求)。
maximums[]

object (Row)

如果要求，指標的最大值。
minimums[]

object (Row)

如果要求，則為指標的最小值。
rowCount

integer

查詢結果中的資料列總數。
metadata

object (ResponseMetaData)

報表的中繼資料。

授權範圍

需要下列其中一種 OAuth 範圍：

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics