批量返回多个数据透视报告。所有报告都必须针对同一 GA4 媒体资源。
HTTP 请求
POST https://analyticsdata.googleapis.com/v1beta/{property=properties/*}:batchRunPivotReports
网址采用 gRPC 转码语法。
路径参数
参数 | |
---|---|
property |
用于跟踪事件的 Google Analytics(分析)GA4 媒体资源标识符。在网址路径(而非正文)中指定。如需了解详情,请参阅在哪里查找媒体资源 ID。必须为批次指定此属性。RunPivotReportRequest 中的属性可能未指定或与此属性一致。 示例:properties/1234 |
请求正文
请求正文中包含结构如下的数据:
JSON 表示法 |
---|
{
"requests": [
{
object ( |
字段 | |
---|---|
requests[] |
个别请求。每个请求都有单独的数据透视报告响应。每个批量请求最多允许 5 个请求。 |
响应正文
包含多个数据透视报告的批量响应。
如果成功,响应正文将包含结构如下的数据:
JSON 表示法 |
---|
{
"pivotReports": [
{
object ( |
字段 | |
---|---|
pivotReports[] |
具体回答。每个响应都有一个单独的数据透视报告请求。 |
kind |
标识此消息属于哪种资源。此 |
授权范围
需要以下 OAuth 范围之一:
https://www.googleapis.com/auth/analytics.readonly
https://www.googleapis.com/auth/analytics
RunPivotReportRequest
生成数据透视报告的请求。
JSON 表示法 |
---|
{ "property": string, "dimensions": [ { object ( |
字段 | |
---|---|
property |
用于跟踪事件的 Google Analytics(分析)GA4 媒体资源标识符。在网址路径(而非正文)中指定。如需了解详情,请参阅在哪里查找媒体资源 ID。在批量请求中,此属性应未指定或与批次级属性一致。 示例:properties/1234 |
dimensions[] |
请求的维度。所有已定义的维度都必须由以下对象之一使用:dimension 表达式、dimensionFilter、数据透视表、orderBys。 |
metrics[] |
所请求的指标,至少需要指定一个指标。所有定义的指标都必须由以下项之一使用:metric_expression、metricFilter、orderBys。 |
dateRanges[] |
用于检索报告中事件数据的日期范围。如果指定了多个日期范围,则报告中会使用每个日期范围内的事件数据。数据透视的字段名称中可以包含字段名称为“dateRange”的特殊维度;如果包含该维度,则报告将比较不同日期范围。在同类群组请求中,必须未指定此 |
pivots[] |
以列或行的形式显示报告维度的直观格式。所有数据透视中的字段名称(维度名称)的并集必须是“维度”中定义的维度名称的子集。任何两个数据透视都不能共用一个维度。维度仅在数据透视中显示时才会显示。 |
dimensionFilter |
维度的 filter 子句。必须请求维度,才能在此过滤器中使用。此过滤条件中不能使用指标。 |
metricFilter |
指标的过滤条件子句。在汇总后阶段应用,类似于 SQL 包含子句。必须请求指标,才能在此过滤条件中使用。维度不能在此过滤条件中使用。 |
currencyCode |
ISO4217 格式的货币代码,例如“AED”“USD”“JPY”。如果该字段的值为空,报告将使用媒体资源的默认币种。 |
cohortSpec |
与此请求相关联的同类群组。如果请求中包含同类群组,则必须提供“同类群组”维度。 |
keepEmptyRows |
如果为 false 或未指定,则不会返回所有指标都等于 0 的每一行。如果为 true,则返回这些行(前提是它们未被过滤器单独移除)。 无论这项 例如,如果某个媒体资源从未记录过 |
returnPropertyQuota |
切换是否返回此 Google Analytics(分析)媒体资源配额的当前状态。配额在 PropertyQuota 中返回。 |
comparisons[] |
可选。已请求和显示的比较项的配置。该请求需要比较字段和比较维度才能在响应中接收比较列。 |