Method: properties.batchRunReports

分批傳回多份報表。所有報表都必須屬於同一個 Google Analytics 資源。

HTTP 要求

POST https://analyticsdata.googleapis.com/v1beta/{property=properties/*}:batchRunReports

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

路徑參數

參數
property

string

要追蹤事件的 Google Analytics 資源 ID。在網址路徑中指定，而非在內容中指定。詳情請參閱「如何查看資源 ID」一文。必須為批次指定此屬性。RunReportRequest 中的屬性可以未指定，也可以與這個屬性一致。

範例：properties/1234

要求主體

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

JSON 表示法 
{
  "requests": [
    {
      object (RunReportRequest)
    }
  ]
}
欄位
requests[]

object (RunReportRequest)

個別要求。每項要求都有獨立的報表回應。每個批次要求最多可包含 5 個要求。

回應主體

包含多份報表的批次回應。

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

JSON 表示法 
{
  "reports": [
    {
      object (RunReportResponse)
    }
  ],
  "kind": string
}
欄位
reports[]

object (RunReportResponse)

個別回應。每個回應都有獨立的報表要求。
kind

string

表示訊息的資源類型。這個 kind 一律是固定字串「analyticsData#batchRunReports」。可用於區分 JSON 中的回應類型。

授權範圍

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

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

RunReportRequest

產生報表的要求。

JSON 表示法 
{
  "property": string,
  "dimensions": [
    {
      object (Dimension)
    }
  ],
  "metrics": [
    {
      object (Metric)
    }
  ],
  "dateRanges": [
    {
      object (DateRange)
    }
  ],
  "dimensionFilter": {
    object (FilterExpression)
  },
  "metricFilter": {
    object (FilterExpression)
  },
  "offset": string,
  "limit": string,
  "metricAggregations": [
    enum (MetricAggregation)
  ],
  "orderBys": [
    {
      object (OrderBy)
    }
  ],
  "currencyCode": string,
  "cohortSpec": {
    object (CohortSpec)
  },
  "keepEmptyRows": boolean,
  "returnPropertyQuota": boolean,
  "comparisons": [
    {
      object (Comparison)
    }
  ]
}
欄位
property

string

要追蹤事件的 Google Analytics 資源 ID。在網址路徑中指定，而非在內容中指定。詳情請參閱「如何查看資源 ID」一文。在批次要求中，這個屬性應為未指定，或與批次層級屬性一致。

範例：properties/1234
dimensions[]

object (Dimension)

要求及顯示的維度。
metrics[]

object (Metric)

要求及顯示的指標。
dateRanges[]

object (DateRange)

要讀取的資料日期範圍。如果要求多個日期範圍，每個回應資料列都會包含以零為基底的日期範圍索引。如果兩個日期範圍重疊，重疊天數的事件資料會納入兩個日期範圍的回應列。在同類群組要求中，此 dateRanges 必須未指定。
dimensionFilter

object (FilterExpression)

使用維度篩選器，即可只在報表中要求特定維度值。如需進一步瞭解相關範例，請參閱「維度篩選器的基本概念」。這個篩選條件無法使用指標。
metricFilter

object (FilterExpression)

指標的篩選器子句。在匯總報表資料列後套用，類似於 SQL 的 having 子句。這個篩選器無法使用維度。
offset

string (int64 format)

起始資料列的列數。第一列會計為第 0 列。

分頁時，第一個要求不會指定偏移量，也就是將偏移量設為 0；第一個要求會傳回第一個 limit 資料列。第二個要求會將偏移量設為第一個要求的 limit；第二個要求會傳回資料列的第二個 limit。

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

string (int64 format)

代表要傳回的列數。如未指定，系統會傳回 10,000 列。無論您要求多少資料列，API 每項要求最多會傳回 250,000 列。limit 必須為正數。

如果維度值的數量不如 limit 多，API 傳回的資料列可能會比要求的 limit 少。舉例來說，維度 country 的可能值少於 300 個，因此如果只針對 country 製作報表，即使將 limit 設為較高的值，也無法取得超過 300 列的資料。

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

enum (MetricAggregation)

匯總指標。匯總指標值會顯示在維度值設為「RESERVED_(MetricAggregation)」的資料列中。匯總資料包含比較項目和多個日期範圍，會根據日期範圍進行匯總。
orderBys[]

object (OrderBy)

指定回應中列的排序方式。要求同時包含比較項目和多個日期範圍時，系統會在比較項目上套用排序依據。
currencyCode

string

貨幣代碼，格式為 ISO4217，例如「AED」、「USD」、「JPY」。如果這個欄位留白，報表會使用資源的預設貨幣。
cohortSpec

object (CohortSpec)

與這項要求相關聯的分析群組。如果要求中包含同類群組，則必須提供「同類群組」維度。
keepEmptyRows

boolean

如果為 false 或未指定，則系統不會傳回所有指標皆為 0 的資料列。如果為 true，如果這些資料列未經過篩選器個別移除，就會傳回。

無論 keepEmptyRows 設定為何，報表中只會顯示 Google Analytics 資源記錄的資料。

舉例來說，如果資源從未記錄 purchase 事件，則針對 eventName 維度和 eventCount 指標的查詢就不會包含資料列 eventName: "purchase" 和 eventCount: 0。
returnPropertyQuota

boolean

切換是否要傳回此 Google Analytics 資源配額的目前狀態。配額會以 PropertyQuota 的形式傳回。
comparisons[]

object (Comparison)

選用設定。所要求及顯示的比較項目設定。要求只需要比較欄位，即可在回應中接收比較欄。