Method: properties.runRealtimeReport

Google Analytics (分析) Realtime API 會針對資源傳回即時事件資料的自訂報表。這些報告會顯示過去 30 分鐘內的事件和使用情況。

HTTP 要求

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

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

路徑參數

參數
property

string

Google Analytics (分析) GA4 資源 ID，其中包含追蹤事件的相關資料。已在網址路徑指定，而非主體。詳情請參閱「查看資源 ID 的方式」一文。

範例：properties/1234

要求主體

要求主體的資料會採用以下結構：

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

object (Dimension)

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

object (Metric)

要求及顯示的指標，
limit

string (int64 format)

要傳回的列數。如未指定 limit 參數，則會傳回 10,000 列。無論您要求的數量為何，API 每個要求最多只能傳回 100,000 個資料列。
dimensionFilter

object (FilterExpression)

維度的篩選器子句。必須要求在這個篩選器中使用維度。這個篩選器無法使用指標。
metricFilter

object (FilterExpression)

指標的篩選器子句。套用於匯總後階段，與 SQL 有子句類似。您必須要求指標，才能在這個篩選器中使用。無法在這個篩選器中使用維度。
metricAggregations[]

enum (MetricAggregation)

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

object (OrderBy)

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

boolean

切換是否要傳回這個 Analytics (分析) 資源的即時配額的目前狀態。系統會在 PropertyQuota 中傳回配額。

回應主體

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

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

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

object (DimensionHeader)

說明維度欄。DimensionsHeader 數量和 DimensionsHeader 數量的按順序與列數相符。
metricHeaders[]

object (MetricHeader)

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

object (Row)

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

object (Row)

依要求，指標的總計值。
maximums[]

object (Row)

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

object (Row)

按要求表示指標的最小值。
rowCount

integer

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

object (PropertyQuota)

這項 Analytics (分析) 資源的即時配額狀態，包括這項要求。

授權範圍

需要下列其中一種 OAuth 範圍：

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics