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

示例: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 参数,系统将返回 10000 行。无论您请求返回多少行,每个请求最多返回 100,000 行。

dimensionFilter

object (FilterExpression)

维度的 filter 子句。必须请求维度才能在此过滤器中使用。此过滤条件中不能使用指标。

metricFilter

object (FilterExpression)

指标的 filter 子句。在汇总后阶段应用,类似于 SQL has-clause。必须请求要在此过滤器中使用的指标。此过滤条件中不能使用维度。

metricAggregations[]

enum (MetricAggregation)

指标聚合。如果维度值设为“RESERVED_(MetricAggregation)”,汇总的指标值就会显示在相应的行中。

orderBys[]

object (OrderBy)

指定响应中的行排序方式。

returnPropertyQuota

boolean

用于切换是否返回此 Google 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)

描述维度列。DimensionHeader 的数量和 DimensionHeader 的顺序与行中显示的维度一致。

metricHeaders[]

object (MetricHeader)

描述指标列。MetricHeader 的数量和 MetricHeader 的顺序与行中显示的指标一致。

rows[]

object (Row)

报告中的维度值组合和指标值行。

totals[]

object (Row)

指标的总计值(如已请求)。

maximums[]

object (Row)

指标的最大值(如果请求)。

minimums[]

object (Row)

指标的最小值(如果请求了)。

rowCount

integer

查询结果中的总行数,与响应中返回的行数无关。例如,如果查询返回 175 行,并在 API 请求中包含 limit = 50,则响应将包含“rowCount = 175”但仅包含 50 行。

propertyQuota

object (PropertyQuota)

此 Google Analytics(分析)媒体资源的实时配额状态,包括此请求。

授权范围

需要以下 OAuth 范围之一:

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