Method: properties.runPivotReport

傳回 Google Analytics 事件資料的自訂樞紐分析表報表。樞紐分析報表比一般報表更進階，格式也更豐富。在樞紐分析表報表中，只有包含在樞紐分析表中的維度才會顯示。您可以指定多個樞紐，進一步剖析資料。

HTTP 要求

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

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

路徑參數

參數
property

string

要追蹤事件的 Google Analytics 資源 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,
  "comparisons": [
    {
      object (Comparison)
    }
  ]
}
欄位
dimensions[]

object (Dimension)

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

object (Metric)

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

object (DateRange)

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

object (Pivot)

說明報表維度在欄或列中的視覺格式。所有資料透視表中的 fieldNames (維度名稱) 聯集，必須是 Dimensions 中定義的維度名稱子集。兩個樞紐之間不能共用維度。只有出現在資料透視表中的維度才會顯示。
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)

(選用步驟) 要求和顯示的比較設定。要求必須包含比較欄位和比較維度，才能在回應中收到比較欄。

回應主體

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

授權範圍

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

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