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