Method: properties.runPivotReport

傳回 Google Analytics (分析) 事件資料的自訂資料透視報表。資料透視報表比一般報表更進階且更豐富的格式，在資料透視報表中，維度必須納入資料透視表中才會顯示。您可以指定多個資料透視，進一步分析資料。

HTTP 要求

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

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

路徑參數

參數
property

string

Google Analytics (分析) GA4 資源 ID，其中包含追蹤事件的相關資料。已在網址路徑指定，而非主體。詳情請參閱「查看資源 ID 的方式」一文。在批次要求中，此屬性應未指定，或是與批次層級屬性一致。

範例：properties/1234

要求主體

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

JSON 表示法 
{
  "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
}
欄位
dimensions[]

object (Dimension)

要求的維度。所有已定義的維度都必須用於以下其中一項：dimensionExpression、dimensionFilter、Pivots、orderBys。
metrics[]

object (Metric)

要求的指標，必須至少指定一個指標。所有已定義的指標都必須用於下列任一項目：metric_expression、metricFilter、orderBys。
dateRanges[]

object (DateRange)

要擷取報表事件資料的日期範圍。如果指定多個日期範圍，報表就會使用各個日期範圍內的事件資料。資料透視的欄位名稱可以包含名為「dateRange」的特殊維度；如果納入該維度，報表會比較不同日期範圍。在同類群組要求中，不得指定這個 dateRanges。
pivots[]

object (Pivot)

在欄或列中，說明報表維度的視覺化格式。所有資料透視表中的 fieldName (維度名稱) 聯集必須是維度名稱的一部分。兩個資料透視不能共用一個維度。只有出現在資料透視表中的維度才會顯示。
dimensionFilter

object (FilterExpression)

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

object (FilterExpression)

指標的篩選器子句。套用於匯總後階段，與 SQL 有子句類似。您必須要求指標，才能在這個篩選器中使用。無法在這個篩選器中使用維度。
currencyCode

string

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

object (CohortSpec)

與這項要求相關聯的同類群組。如果請求中有同類群組群組，就必須顯示「同類群組」維度。
keepEmptyRows

boolean

如為 false 或未指定，則不會傳回所有指標等於 0 的每一列。如果設為 true，如果未遭到篩選器單獨移除，系統就會傳回這些資料列。

無論這項 keepEmptyRows 設定為何，只有 Google Analytics (分析) (GA4) 資源記錄的資料才能在報表中顯示。

舉例來說，如果資源從未記錄 purchase 事件，則 eventName 維度和 eventCount 指標查詢不會出現資料列 eventName：「purchase」和「eventCount: 0」。
returnPropertyQuota

boolean

切換是否要傳回這項 Analytics (分析) 資源的配額目前的狀態。系統會在 PropertyQuota 中傳回配額。

回應主體

如果成功，回應主體會包含 RunPivotReportResponse 的執行例項。

授權範圍

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

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