返回包含 Google Analytics 事件数据的自定义报告。报告包含由 Google Analytics 跟踪代码收集的数据派生出的统计信息。从 API 返回的数据以表格的形式显示,其中包含请求的维度和指标对应的列。指标是指对您媒体资源上的用户活动进行的单独衡量,例如活跃用户数或事件数。维度用于按一些常见条件(例如国家/地区或事件名称)对指标进行细分。
如需了解如何构建请求和了解响应,请参阅创建报告。
HTTP 请求
POST https://analyticsdata.googleapis.com/v1beta/{property=properties/*}:runReport
网址采用 gRPC 转码语法。
路径参数
参数 | |
---|---|
property |
要跟踪事件的 Google Analytics 媒体资源标识符。在网址路径中指定,而不是在正文中指定。如需了解详情,请参阅如何查找媒体资源 ID。在批量请求中,此属性应未指定或与批量级属性一致。 示例:properties/1234 |
请求正文
请求正文中包含结构如下的数据:
JSON 表示法 |
---|
{ "dimensions": [ { object ( |
字段 | |
---|---|
dimensions[] |
请求和显示的维度。 |
metrics[] |
请求和显示的指标。 |
date |
要读取的数据的日期范围。如果请求多个日期范围,则每个响应行都将包含从零开始的日期范围编号。如果两个日期范围重叠,则重叠天数的事件数据会包含在两个日期范围的响应行中。在同类群组请求中,此 |
dimension |
借助维度过滤条件,您可以仅在报告中请求特定的维度值。如需了解详情,请参阅尺寸过滤条件基础知识,查看示例。此过滤条件不支持使用指标。 |
metric |
指标的过滤条件子句。在汇总报告行后应用,类似于 SQL having 子句。此过滤条件中无法使用维度。 |
offset |
起始行的行数。第一行计为第 0 行。 分页时,第一个请求不会指定偏移量;或者等同于将偏移量设置为 0;第一个请求会返回前 如需详细了解此分页参数,请参阅分页。 |
limit |
要返回的行数。如果未指定,则返回 10,000 行。无论您请求多少行,该 API 每个请求最多只会返回 25 万行。 如果维度值的数量不如 如需详细了解此分页参数,请参阅分页。 |
metric |
指标汇总。汇总指标值将显示在 dimensionValues 设置为“RESERVED_(MetricAggregation)”的行中。同时包含比较项和多个日期范围的汇总将根据日期范围进行汇总。 |
order |
指定响应中各行的排序方式。如果请求同时包含比较项和多个日期范围,系统会对比较项应用排序规则。 |
currency |
采用 ISO4217 格式的货币代码,例如“AED”“USD”“JPY”。如果此字段为空,报告将使用房源的默认币种。 |
cohort |
与此请求关联的同类群组。如果请求中包含同类群组,则必须包含“同类群组”维度。 |
keep |
如果为 false 或未指定,则系统不会返回所有指标均为 0 的每一行。如果为 true,则如果这些行未被过滤器单独移除,则会被返回。 无论 例如,如果某个媒体资源从未记录 |
return |
切换是否返回此 Google Analytics 媒体资源配额的当前状态。配额会在 PropertyQuota 中返回。 |
comparisons[] |
可选。请求和显示的比较项的配置。请求只需要包含 comparisons 字段,即可在响应中收到比较列。 |
响应正文
如果成功,则响应正文包含一个 RunReportResponse
实例。
授权范围
需要以下 OAuth 范围之一:
https://www.googleapis.com/auth/analytics.readonly
https://www.googleapis.com/auth/analytics