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)

指標匯總。匯總指標值會顯示在 dimensionValues 設為「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)

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

object (MetricHeader)

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

object (Row)

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

object (Row)

如有要求，則指標總值。
maximums[]

object (Row)

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

object (Row)

視需要提供指標的最小值。
rowCount

integer

查詢結果中的總列數 (不論回應傳回的資料列數為何)。舉例來說，如果查詢在 API 要求中傳回 175 列，並將 limit = 50，回應就會包含 rowCount = 175，但只有 50 個資料列。
propertyQuota

object (PropertyQuota)

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

授權範圍

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

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