傳回資源的即時事件資料的自訂報表。事件傳送到 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[] |
指標匯總。匯總指標值會顯示在 dimensionValues 設為「RESERVED_(MetricAggregation)」的資料列中。 |
orderBys[] |
指定在回應中資料列的排序方式。 |
returnPropertyQuota |
切換是否要傳回這項 Analytics 資源的即時配額目前狀態。配額會在 PropertyQuota 中傳回。 |
minuteRanges[] |
要讀取的事件資料的分鐘範圍。如未指定,系統會使用過去 30 分鐘的一分鐘範圍。如果要求多個分鐘範圍,則每個回應列都會含有一分鐘的範圍索引 (以分鐘為單位)。如果兩分鐘範圍重疊,重疊分鐘數的事件資料就會納入這兩分鐘範圍的回應列中。 |
回應主體
與要求相對應的回應即時報表表格。
如果成功,回應主體會含有以下結構的資料:
JSON 表示法 |
---|
{ "dimensionHeaders": [ { object ( |
欄位 | |
---|---|
dimensionHeaders[] |
說明維度欄。DimensionsHeaders 的數量和順序與資料列中的維度相符。 |
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 |
查詢的結束分鐘 (含在現在的分鐘數) 中。不得早於 如果未指定, |