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 分钟内的一分钟范围。如果请求了多个分钟范围，则每个响应行都将包含一个从零开始的分钟范围索引。如果两个分钟范围重叠，则重叠分钟的事件数据会包含在两个分钟范围的响应行中。

响应正文

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

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

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)

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

object (MetricHeader)

描述指标列。MetricHeaders 的数量和顺序与行中存在的指标相匹配。
rows[]

object (Row)

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

object (Row)

如果请求了指标，则为指标的总计值。
maximums[]

object (Row)

如果请求，则为指标的最大值。
minimums[]

object (Row)

如果请求，则为指标的最小值。
rowCount

integer

查询结果中的总行数。rowCount 与响应中返回的行数和 limit 请求参数无关。例如，如果查询返回 175 行，并且 API 请求中包含 50 的 limit，则响应将包含 175 的 rowCount，但只有 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)，而 Google Analytics 360 媒体资源最多可以请求过去 60 分钟的事件数据 (startMinutesAgo <= 59)。
endMinutesAgo

integer

查询的包含性结束时间（以“现在”之前的时间表示，单位为分钟）。不得早于 startMinutesAgo。例如，"endMinutesAgo": 15 表示报告应包含 15 分钟之前发生的事件数据。

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