返回针对您媒体资源的实时事件数据的自定义报告。事件发送到 Google Analytics(分析)几秒钟后,就会显示在实时报告中。实时报告会显示从现在到 30 分钟前(对于 Google Analytics 360 媒体资源,最长为 60 分钟)这段时间的事件和使用情况数据。
有关构建实时请求和理解响应的指南,请参阅创建实时报告。
HTTP 请求
POST https://analyticsdata.googleapis.com/v1beta/{property=properties/*}:runRealtimeReport
网址采用 gRPC 转码语法。
路径参数
参数 | |
---|---|
property |
用于跟踪事件的 Google Analytics(分析)GA4 媒体资源标识符。在网址路径(而非正文)中指定。如需了解详情,请参阅在哪里查找媒体资源 ID。 示例:properties/1234 |
请求正文
请求正文中包含结构如下的数据:
JSON 表示法 |
---|
{ "dimensions": [ { object ( |
字段 | |
---|---|
dimensions[] |
请求和显示的维度。 |
metrics[] |
请求和显示的指标。 |
dimensionFilter |
维度的 filter 子句。此过滤条件中不能使用指标。 |
metricFilter |
指标的过滤条件子句。在汇总后阶段应用,类似于 SQL 包含子句。维度不能在此过滤条件中使用。 |
limit |
要返回的行数。如果未指定,将返回 10,000 行。无论您请求返回多少行,每个请求最多返回 250,000 行。“ 如果维度值没有 |
metricAggregations[] |
指标聚合。汇总的指标值将在“dimensionValues”设置为“RESERVED_(MetricAggregation)”的行中显示。 |
orderBys[] |
指定响应中行的排序方式。 |
returnPropertyQuota |
切换是否要返回此 Google Analytics(分析)媒体资源的“实时”配额的当前状态。配额在 PropertyQuota 中返回。 |
minuteRanges[] |
要读取的事件数据的分钟范围。如果未指定,系统将使用过去 30 分钟的一分钟范围。如果请求多个分钟范围,则每个响应行将包含一个从零开始的分钟范围索引。如果两分钟范围重叠,则重叠时间的事件数据将包含两分钟范围的响应行中。 |
响应正文
与请求对应的响应实时报告表格。
如果成功,响应正文将包含结构如下的数据:
JSON 表示法 |
---|
{ "dimensionHeaders": [ { object ( |
字段 | |
---|---|
dimensionHeaders[] |
描述维度列。DimensionHeader 的数量和 DimensionHeader 的顺序与行中显示的维度一致。 |
metricHeaders[] |
说明指标列。MetricHeader 的数量和 MetricHeader 的顺序与行中显示的指标一致。 |
rows[] |
报告中维度值组合和指标值的行。 |
totals[] |
指标的总计值(如果需要)。 |
maximums[] |
指标的最大值(如果请求的话)。 |
minimums[] |
指标的最小值(如果请求的话)。 |
rowCount |
查询结果中的总行数。 |
propertyQuota |
此 Google Analytics(分析)媒体资源的实时配额状态,包括此请求。 |
kind |
用于标识此消息的类型。此 |
授权范围
需要以下 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 |
用于为此分钟范围指定一个名称。在报告响应中,维度 |
startMinutesAgo |
查询的开始时间(含),以距现在的分钟数表示的分钟数。例如, 如果未指定, |
endMinutesAgo |
查询的结束分钟(含),以距现在的分钟数表示的分钟数。不得早于 如果未指定, |