Method: properties.runRealtimeReport

傳回資源的即時事件資料自訂報表。事件傳送至 Google Analytics 後，即時報表會在幾秒內顯示事件。即時報表會顯示從目前到 30 分鐘前這段時間的事件和使用情況資料 (Google Analytics 360 資源最多可顯示 60 分鐘前的資料)。

如需建構即時要求及解讀回應的指南，請參閱「建立即時報表」。

HTTP 要求

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

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

路徑參數

參數
property

string

要追蹤事件的 Google Analytics 資源 ID。指定於網址路徑，而非主體。詳情請參閱「如何找出資源 ID」。

範例：properties/1234

要求主體

要求主體會包含結構如下的資料：

JSON 表示法 
{
  "dimensions": [
    {
      object (Dimension)
    }
  ],
  "metrics": [
    {
      object (Metric)
    }
  ],
  "dimensionFilter": {
    object (FilterExpression)
  },
  "metricFilter": {
    object (FilterExpression)
  },
  "limit": string,
  "metricAggregations": [
    enum (MetricAggregation)
  ],
  "orderBys": [
    {
      object (OrderBy)
    }
  ],
  "returnPropertyQuota": boolean,
  "minuteRanges": [
    {
      object (MinuteRange)
    }
  ]
}
欄位
dimensions[]

object (Dimension)

要求和顯示的維度。
metrics[]

object (Metric)

要求和顯示的指標。
dimensionFilter

object (FilterExpression)

維度的篩選子句。這個篩選條件無法使用指標。
metricFilter

object (FilterExpression)

指標的篩選子句。在彙整後套用，類似於 SQL 的 having 子句。這個篩選器無法使用維度。
limit

string (int64 format)

要傳回的列數。如未指定，系統會傳回 10,000 個資料列。無論您要求多少資料列，API 每次最多只會傳回 250,000 列。limit 必須為正數。

如果維度值的數量少於要求的 limit，API 也可能會傳回少於 limit 的資料列。舉例來說，維度 country 的可能值少於 300 個，因此即使將 limit 設為較高的值，只針對 country 產生報表時，最多也只會顯示 300 列。
metricAggregations[]

enum (MetricAggregation)

匯總指標。如果 dimensionValues 設為「RESERVED_(MetricAggregation)」，系統會在對應的資料列中顯示匯總指標值。
orderBys[]

object (OrderBy)

指定回應中的資料列排序方式。
returnPropertyQuota

boolean

切換是否要傳回這個 Google Analytics 資源的即時配額目前狀態。配額會以 PropertyQuota 形式傳回。
minuteRanges[]

object (MinuteRange)

要讀取的事件資料分鐘範圍。如未指定，系統會使用過去 30 分鐘內的一分鐘範圍。如果要求多個分鐘範圍，每個回應列都會包含以零為準的分鐘範圍索引。如果兩個分鐘範圍重疊，這兩個範圍的回應列都會包含重疊分鐘的事件資料。

回應主體

與要求相應的回應即時報表表格。

如果成功，回應主體會含有以下結構的資料：

JSON 表示法 
{
  "dimensionHeaders": [
    {
      object (DimensionHeader)
    }
  ],
  "metricHeaders": [
    {
      object (MetricHeader)
    }
  ],
  "rows": [
    {
      object (Row)
    }
  ],
  "totals": [
    {
      object (Row)
    }
  ],
  "maximums": [
    {
      object (Row)
    }
  ],
  "minimums": [
    {
      object (Row)
    }
  ],
  "rowCount": integer,
  "propertyQuota": {
    object (PropertyQuota)
  },
  "kind": string
}
欄位
dimensionHeaders[]

object (DimensionHeader)

說明維度資料欄。DimensionHeaders 的數量和順序與資料列中的維度相符。
metricHeaders[]

object (MetricHeader)

說明指標資料欄。MetricHeaders 的數量和順序與資料列中的指標相符。
rows[]

object (Row)

報表中的維度值組合和指標值列。
totals[]

object (Row)

指標的總值 (如有要求)。
maximums[]

object (Row)

如果要求，指標的最大值。
minimums[]

object (Row)

如果要求，則為指標的最小值。
rowCount

integer

查詢結果中的資料列總數。rowCount 與回應中傳回的資料列數和 limit 要求參數無關。舉例來說，如果查詢傳回 175 列，且 API 要求包含 limit 為 50，則回應會包含 rowCount 為 175，但只有 50 列。
propertyQuota

object (PropertyQuota)

這項 Google Analytics 資源的即時配額狀態，包括這項要求。
kind

string

表示這則訊息的資源種類。這個 kind 一律是固定字串「analyticsData#runRealtimeReport」。有助於區分 JSON 中的回應類型。

授權範圍

需要下列其中一種 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

string

為這個分鐘範圍指派名稱。報表回應中的維度 dateRange 會以這個名稱表示。如果設定，開頭不得為 date_range_ 或 RESERVED_。如未設定，系統會根據要求中的以零為準的索引，為分鐘範圍命名：date_range_0、date_range_1 等。
startMinutesAgo

integer

查詢的開始時間 (含)，以目前時間前幾分鐘表示。舉例來說，"startMinutesAgo": 29 指定報表應納入 29 分鐘前和之後的事件資料。不得晚於 endMinutesAgo。

如未指定，startMinutesAgo 預設為 29。標準版 Analytics 資源最多可要求最近 30 分鐘的事件資料 (startMinutesAgo <= 29)，360 版 Analytics 資源則最多可要求最近 60 分鐘的事件資料 (startMinutesAgo <= 59)。
endMinutesAgo

integer

查詢的結束時間 (含)，以目前時間前幾分鐘表示。不得早於 startMinutesAgo。舉例來說，"endMinutesAgo": 15 指定報表應納入 15 分鐘前發生的事件資料。

如未指定，endMinutesAgo 預設為 0。標準版 Analytics 資源可要求過去 30 分鐘內任何時間的事件資料 (endMinutesAgo <= 29)，360 版 Analytics 資源則可要求過去 60 分鐘內任何時間的事件資料 (endMinutesAgo <= 59)。