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。

示例：property/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 最多只能返回 10 万行。
dimensionFilter

object (FilterExpression)

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

object (FilterExpression)

指标的过滤子句。应用于聚合后阶段，类似于 SQL 的包含子句。必须请求在此过滤器中使用指标。维度不能用于此过滤条件。
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