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