Method: properties.batchRunPivotReports

一次傳回多個透視報表。所有報表都必須屬於同一個 Google Analytics 資源。

HTTP 要求

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

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

路徑參數

參數
property

string

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

範例：properties/1234

要求主體

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

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

object (RunPivotReportRequest)

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

回應主體

包含多個樞紐報表的批次回應。

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

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

object (RunPivotReportResponse)

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

string

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

授權範圍

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

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

RunPivotReportRequest

產生樞紐報表的要求。

JSON 表示法 
{
  "property": string,
  "dimensions": [
    {
      object (Dimension)
    }
  ],
  "metrics": [
    {
      object (Metric)
    }
  ],
  "dateRanges": [
    {
      object (DateRange)
    }
  ],
  "pivots": [
    {
      object (Pivot)
    }
  ],
  "dimensionFilter": {
    object (FilterExpression)
  },
  "metricFilter": {
    object (FilterExpression)
  },
  "currencyCode": string,
  "cohortSpec": {
    object (CohortSpec)
  },
  "keepEmptyRows": boolean,
  "returnPropertyQuota": boolean,
  "comparisons": [
    {
      object (Comparison)
    }
  ]
}
欄位
property

string

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

範例：properties/1234
dimensions[]

object (Dimension)

要求的尺寸。所有定義的維度都必須使用下列其中一種：維度運算式、維度篩選器、資料透視、orderBy。
metrics[]

object (Metric)

所要求的指標，至少需要指定一項指標。所有定義的指標都必須使用下列其中一個：metric_expression、metricFilter、orderBys。
dateRanges[]

object (DateRange)

擷取報表事件資料的日期範圍。如果指定多個日期範圍，報表就會使用各個日期範圍的事件資料。您可以在樞紐分析表的欄位名稱中加入特殊維度，其欄位名稱為「dateRange」；如果加入此維度，報表就會比較不同日期範圍。在同類群組要求中，此 dateRanges 必須未指定。
pivots[]

object (Pivot)

說明報表在欄或列中維度的視覺格式。所有樞紐圖中的欄位名稱 (維度名稱) 聯集必須是「維度」中定義的維度名稱子集。兩個資料透視不得共用一個維度。只有在樞紐分析表中，維度才會顯示。
dimensionFilter

object (FilterExpression)

維度的篩選器子句。您必須要求維度才能在這個篩選器中使用。這個篩選條件無法使用指標。
metricFilter

object (FilterExpression)

指標的篩選器子句。在後聚合階段套用，類似於 SQL 的 having 子句。您必須要求指標才能在這個篩選器中使用。這個篩選器無法使用維度。
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)

選用設定。所要求及顯示的比較項目設定。要求必須同時提供比較欄位和比較維度，才能在回應中收到比較欄。