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。

示例：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 每个请求最多只会返回 25 万行。limit 必须为正数。

如果维度值的数量不如 limit 多，API 返回的行数也可能少于请求的 limit。例如，维度 country 的可取值少于 300 个，因此，如果仅针对 country 生成报告，则即使您将 limit 设置为更大的值，也无法获得超过 300 行的报告。
metricAggregations[]

enum (MetricAggregation)

指标汇总。汇总指标值将显示在 dimensionValues 设置为“RESERVED_(MetricAggregation)”的行中。
orderBys[]

object (OrderBy)

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

boolean

切换是否返回此 Google Analytics 媒体资源的实时配额的当前状态。配额会在 PropertyQuota 中返回。
minuteRanges[]

object (MinuteRange)

要读取的事件数据的分钟范围。如果未指定，则使用过去 30 分钟内的 1 分钟范围。如果请求多个分钟范围，则每个响应行都将包含一个从零开始的分钟范围索引。如果两个分钟范围重叠，则重叠分钟数的事件数据会包含在两个分钟范围的响应行中。

响应正文

与请求对应的响应实时报告表。

如果成功，响应正文将包含结构如下的数据：

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)

描述维度列。DimensionHeader 的数量和顺序与行中的维度一致。
metricHeaders[]

object (MetricHeader)

介绍指标列。MetricHeader 的数量和顺序与行中显示的指标一致。
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。标准版 Google Analytics 媒体资源最多可以请求过去 30 分钟内的事件数据 (startMinutesAgo <= 29)，而 360 版 Google Analytics 媒体资源最多可以请求过去 60 分钟内的事件数据 (startMinutesAgo <= 59)。
endMinutesAgo

integer

查询的结束分钟数（以距离现在的分钟数表示）。不能早于 startMinutesAgo。例如，"endMinutesAgo": 15 指定报告应包含 15 分钟之前的事件数据。

如果未指定，endMinutesAgo 默认为 0。标准版 Google Analytics 媒体资源可以请求过去 30 分钟内的任意时刻的事件数据 (endMinutesAgo <= 29)，而 360 版 Google Analytics 媒体资源可以请求过去 60 分钟内的任意时刻的事件数据 (endMinutesAgo <= 59)。