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(分析)GA4 媒体资源标识符。在网址路径(而非正文)中指定。如需了解详情,请参阅在哪里查找媒体资源 ID。 示例:properties/1234
|
请求正文
请求正文中包含结构如下的数据:
字段 |
dimensions[] |
object (Dimension )
请求和显示的维度。
|
metrics[] |
object (Metric )
请求和显示的指标。
|
dimensionFilter |
object (FilterExpression )
维度的 filter 子句。此过滤条件中不能使用指标。
|
metricFilter |
object (FilterExpression )
指标的过滤条件子句。在汇总后阶段应用,类似于 SQL 包含子句。维度不能在此过滤条件中使用。
|
limit |
string (int64 format)
要返回的行数。如果未指定,将返回 10,000 行。无论您请求返回多少行,每个请求最多返回 250,000 行。“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 )
描述维度列。DimensionHeader 的数量和 DimensionHeader 的顺序与行中显示的维度一致。
|
metricHeaders[] |
object (MetricHeader )
说明指标列。MetricHeader 的数量和 MetricHeader 的顺序与行中显示的指标一致。
|
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 ),360 Analytics 媒体资源最多可以请求过去 60 分钟的事件数据 (startMinutesAgo <= 59 )。
|
endMinutesAgo |
integer
查询的结束分钟(含),以距现在的分钟数表示的分钟数。不得早于 startMinutesAgo 。例如,"endMinutesAgo": 15 指定报告应包含 15 分钟前的事件数据。 如果未指定,endMinutesAgo 默认为 0。标准 Google Analytics(分析)媒体资源可以请求过去 30 分钟内任何一分钟的事件数据 (endMinutesAgo <= 29 ),而 360 Analytics 媒体资源可以请求过去 60 分钟内任何一分钟的事件数据 (endMinutesAgo <= 59 )。
|
如未另行说明,那么本页面中的内容已根据知识共享署名 4.0 许可获得了许可,并且代码示例已根据 Apache 2.0 许可获得了许可。有关详情,请参阅 Google 开发者网站政策。Java 是 Oracle 和/或其关联公司的注册商标。
最后更新时间 (UTC):2024-05-02。
[{
"type": "thumb-down",
"id": "missingTheInformationINeed",
"label":"没有我需要的信息"
},{
"type": "thumb-down",
"id": "tooComplicatedTooManySteps",
"label":"太复杂/步骤太多"
},{
"type": "thumb-down",
"id": "outOfDate",
"label":"内容需要更新"
},{
"type": "thumb-down",
"id": "translationIssue",
"label":"翻译问题"
},{
"type": "thumb-down",
"id": "samplesCodeIssue",
"label":"示例/代码问题"
},{
"type": "thumb-down",
"id": "otherDown",
"label":"其他"
}]
[{
"type": "thumb-up",
"id": "easyToUnderstand",
"label":"易于理解"
},{
"type": "thumb-up",
"id": "solvedMyProblem",
"label":"解决了我的问题"
},{
"type": "thumb-up",
"id": "otherUp",
"label":"其他"
}]