傳回資源的即時事件資料自訂報表。事件傳送到 Google Analytics (分析) 後幾秒內,即時報表就會列出。即時報表會顯示過去到 30 分鐘 (Google Analytics (分析) 360 資源最長 60 分鐘) 的事件和使用資料。
如要瞭解如何建立即時要求及解讀回應,請參閱「建立即時報表」一文。
HTTP 要求
POST https://analyticsdata.googleapis.com/v1beta/{property=properties/*}:runRealtimeReport
這個網址使用 gRPC 轉碼語法。
路徑參數
參數 | |
---|---|
property |
Google Analytics (分析) GA4 資源 ID,其中包含追蹤事件的相關資料。已在網址路徑指定,而非主體。詳情請參閱「查看資源 ID 的方式」一文。 範例:properties/1234 |
要求主體
要求主體的資料會採用以下結構:
JSON 表示法 |
---|
{ "dimensions": [ { object ( |
欄位 | |
---|---|
dimensions[] |
要求及顯示的維度。 |
metrics[] |
要求及顯示的指標, |
dimensionFilter |
維度的篩選器子句。這個篩選器無法使用指標。 |
metricFilter |
指標的篩選器子句。套用於匯總後階段,與 SQL 有子句類似。無法在這個篩選器中使用維度。 |
limit |
要傳回的列數。如果未指定,則會傳回 10,000 列。無論您要求的數量為何,API 每個要求最多只能傳回 250,000 個資料列。 如果維度值數量不是 |
metricAggregations[] |
指標匯總。匯總指標值會顯示在 DimensionsValue 設為「RESERVED_(MetricAggregation)」的資料列中。 |
orderBys[] |
指定資料列在回應中的排序方式。 |
returnPropertyQuota |
切換是否要傳回這個 Analytics (分析) 資源的即時配額的目前狀態。系統會在 PropertyQuota 中傳回配額。 |
minuteRanges[] |
要讀取的事件資料分鐘範圍。如未指定,系統會使用過去 30 分鐘的一分鐘範圍。如果要求多個分鐘範圍,則每個回應列將包含以零為基準的範圍索引。如果兩分鐘範圍重疊,這兩個分鐘範圍的回應列中會含有重疊分鐘數的事件資料。 |
回應主體
與要求對應的回應即時報表表格。
如果成功,回應主體即會包含具有以下結構的資料:
JSON 表示法 |
---|
{ "dimensionHeaders": [ { object ( |
欄位 | |
---|---|
dimensionHeaders[] |
說明維度欄。DimensionsHeader 數量和 DimensionsHeader 數量的按順序與列數相符。 |
metricHeaders[] |
說明指標欄。MetricHeaders 的數量和 MetricHeaders 的數量與資料列中顯示的指標相符。 |
rows[] |
報表中維度值組合和指標值的資料列。 |
totals[] |
依要求,指標的總計值。 |
maximums[] |
如果收到要求,指標值的最大值。 |
minimums[] |
按要求表示指標的最小值。 |
rowCount |
查詢結果中的資料列總數。 |
propertyQuota |
這項 Analytics (分析) 資源的即時配額狀態,包括這項要求。 |
kind |
識別此訊息的資源種類。這個 |
授權範圍
需要下列其中一種 OAuth 範圍:
https://www.googleapis.com/auth/analytics.readonly
https://www.googleapis.com/auth/analytics
MinuteRange
連續分鐘數:startMinutesAgo
、startMinutesAgo + 1
、...、endMinutesAgo
。最多可以要求 2 分鐘的範圍。
JSON 表示法 |
---|
{ "name": string, "startMinutesAgo": integer, "endMinutesAgo": integer } |
欄位 | |
---|---|
name |
指派這個分鐘範圍的名稱。報表回應中的維度 |
startMinutesAgo |
包含查詢的開始分鐘數,以分鐘為單位。舉例來說, 如果未指定, |
endMinutesAgo |
查詢的結束分鐘數,以分鐘為單位。不得早於 如果未指定, |