傳回 Google Analytics 事件資料的自訂資料透視報表。資料透視報表比一般報表更先進生動的格式。在資料透視報表中,只有包含在資料透視表中的維度才會顯示。您可以指定多個資料透視來進一步解析資料。
HTTP 要求
POST https://analyticsdata.googleapis.com/v1beta/{property=properties/*}:runPivotReport
這個網址使用 gRPC 轉碼語法。
路徑參數
參數 | |
---|---|
property |
要追蹤事件的 Google Analytics GA4 資源 ID。指定在網址路徑,而不是內文。詳情請參閱「如何查看資源 ID」一文。在批次要求中,這個屬性應未指定或與批次層級屬性一致。 範例:properties/1234 |
要求主體
要求主體的資料會採用以下結構:
JSON 表示法 |
---|
{ "dimensions": [ { object ( |
欄位 | |
---|---|
dimensions[] |
要求的維度。所有定義的維度都必須用於下列任一項目:dimensionExpression、dimensionFilter、樞紐分析、orderBys。 |
metrics[] |
要求的指標,至少需指定一項。所有已定義的指標都必須由以下其中一項使用:metric_expression、metricFilter、orderBys。 |
dateRanges[] |
用來擷取報表事件資料的日期範圍。如果指定多個日期範圍,則報表會使用每個日期範圍的事件資料。欄位名稱為「dateRange」的特殊維度即可加入資料透視欄位名稱;若有的話,報表就會比較不同日期範圍。在同類群組要求中,您必須指定這個 |
pivots[] |
說明欄或列中的報表維度視覺格式。所有資料透視表中欄位名稱 (維度名稱) 的聯集,必須是維度中定義的維度名稱子集。兩個資料透視表無法共用同一個維度。維度只有在資料透視表中才會顯示。 |
dimensionFilter |
維度的篩選器子句,這個篩選器必須使用維度。無法在這個篩選器中使用指標。 |
metricFilter |
指標的篩選器子句。會在匯總後階段套用,與 SQL 含子句類似。如要在這個篩選器中使用指標,則須要求指標。無法在這個篩選器中使用維度。 |
currencyCode |
採用 ISO4217 格式的貨幣代碼,例如「AED」、「USD」、「JPY」。如果該欄位空白,報表就會採用資源的預設貨幣。 |
cohortSpec |
與這項要求相關聯的同類群組。如果要求中已有同類群組群組維度。 |
keepEmptyRows |
如果為 false 或未指定,系統不會傳回所有指標都等於 0 的資料列。在設為 true 的情況下,如果篩選器沒有個別移除這些資料列,系統就會傳回這些資料列。 無論這項 舉例來說,如果資源從未記錄 |
returnPropertyQuota |
切換是否要傳回這項 Analytics 資源的配額目前狀態。配額會在 PropertyQuota 中傳回。 |
comparisons[] |
選用設定。要求及顯示的比較設定。這項要求中必須同時使用比較欄位和比較維度,才能在回應中接收比較資料欄。 |
回應主體
如果成功,回應主體會包含 RunPivotReportResponse
的執行例項。
授權範圍
需要下列其中一種 OAuth 範圍:
https://www.googleapis.com/auth/analytics.readonly
https://www.googleapis.com/auth/analytics