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 個，因此如果只針對 country 製作報表，即使將 limit 設為較高的值，也無法取得超過 300 列的資料。
metricAggregations[]

enum (MetricAggregation)

匯總指標。匯總指標值會顯示在維度值設為「RESERVED_(MetricAggregation)」的資料列中。
orderBys[]

object (OrderBy)

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

boolean

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

object (MinuteRange)

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

回應主體

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

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

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)，而 Analytics 360 資源最多可要求過去 60 分鐘的事件資料 (startMinutesAgo <= 59)。
endMinutesAgo

integer

查詢的包含性結束分鐘，以分鐘為單位計算。不得早於 startMinutesAgo。舉例來說，"endMinutesAgo": 15 會指定報表應納入 15 分鐘前之前的事件資料。

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