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)

要求的維度。所有已定義的維度都必須透過以下其中一種方式使用:DimensionsExpression、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