Method: properties.batchRunPivotReports

批量返回多个数据透视报告。所有报告都必须针对同一 Google Analytics 媒体资源。

HTTP 请求

POST https://analyticsdata.googleapis.com/v1beta/{property=properties/*}:batchRunPivotReports

网址采用 gRPC 转码语法。

路径参数

参数
property

string

Google Analytics 媒体资源标识符，用于跟踪事件。在网址路径中指定，而不是在正文中指定。如需了解详情，请参阅在哪里查找媒体资源 ID。必须为批次指定此属性。RunPivotReportRequest 中的属性可以未指定，也可以与此属性保持一致。

示例：properties/1234

请求正文

请求正文中包含结构如下的数据：

JSON 表示法 
{
  "requests": [
    {
      object (RunPivotReportRequest)
    }
  ]
}
字段
requests[]

object (RunPivotReportRequest)

单个请求。每个请求都有单独的数据透视报告响应。每个批量请求最多允许 5 个请求。

响应正文

包含多个数据透视报告的批次响应。

如果成功，响应正文将包含结构如下的数据：

JSON 表示法 
{
  "pivotReports": [
    {
      object (RunPivotReportResponse)
    }
  ],
  "kind": string
}
字段
pivotReports[]

object (RunPivotReportResponse)

单个响应。每个响应都有单独的数据透视报告请求。
kind

string

指明此消息是哪类资源。此 kind 始终是固定字符串“analyticsData#batchRunPivotReports”。有助于区分 JSON 中的响应类型。

授权范围

需要以下 OAuth 范围之一：

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics

RunPivotReportRequest

用于生成数据透视报告的请求。

JSON 表示法 
{
  "property": string,
  "dimensions": [
    {
      object (Dimension)
    }
  ],
  "metrics": [
    {
      object (Metric)
    }
  ],
  "dateRanges": [
    {
      object (DateRange)
    }
  ],
  "pivots": [
    {
      object (Pivot)
    }
  ],
  "dimensionFilter": {
    object (FilterExpression)
  },
  "metricFilter": {
    object (FilterExpression)
  },
  "currencyCode": string,
  "cohortSpec": {
    object (CohortSpec)
  },
  "keepEmptyRows": boolean,
  "returnPropertyQuota": boolean,
  "comparisons": [
    {
      object (Comparison)
    }
  ]
}
字段
property

string

Google Analytics 媒体资源标识符，用于跟踪事件。在网址路径中指定，而不是在正文中指定。如需了解详情，请参阅在哪里查找媒体资源 ID。在批量请求中，此属性应未指定，或与批次级属性保持一致。

示例：properties/1234
dimensions[]

object (Dimension)

请求的维度。所有已定义的维度都必须由以下项之一使用：dimensionExpression、dimensionFilter、pivots、orderBys。
metrics[]

object (Metric)

请求的指标，至少需要指定一个指标。所有已定义的指标都必须由以下项之一使用：metric_expression、metricFilter、orderBys。
dateRanges[]

object (DateRange)

用于检索报告的事件数据的日期范围。如果指定了多个日期范围，则报告中使用每个日期范围的事件数据。字段名称为“dateRange”的特殊维度可以包含在数据透视表的字段名称中；如果包含，报告会在日期范围之间进行比较。在同类群组请求中，此 dateRanges 必须未指定。
pivots[]

object (Pivot)

描述报告的维度在列或行中的视觉格式。所有数据透视表中的 fieldNames（维度名称）的并集必须是 Dimensions 中定义的维度名称的子集。任何两个数据透视表都不能共用一个维度。只有在数据透视表中显示的维度才可见。
dimensionFilter

object (FilterExpression)

维度的过滤子句。必须请求维度才能在此过滤条件中使用。指标不能在此过滤条件中使用。
metricFilter

object (FilterExpression)

指标的过滤子句。在聚合后阶段应用，类似于 SQL having 子句。必须请求指标才能在此过滤条件中使用。维度不能在此过滤条件中使用。
currencyCode

string

ISO4217 格式的货币代码，例如“AED”“USD”“JPY”。如果该字段为空，报告将使用媒体资源的默认货币。
cohortSpec

object (CohortSpec)

与此请求关联的同类群组。如果请求中存在同类群组，则必须存在“cohort”维度。
keepEmptyRows

boolean

如果为 false 或未指定，则不会返回所有指标都等于 0 的每一行。如果为 true，则这些行将返回，除非它们被过滤条件单独移除。

无论此 keepEmptyRows 设置如何，报告中都只能显示 Google Analytics 媒体资源记录的数据。

例如，如果媒体资源从未记录 purchase 事件，则对 eventName 维度和 eventCount 指标的查询将不会有行 eventName: "purchase" 和 eventCount: 0。
returnPropertyQuota

boolean

切换是否返回此 Google Analytics 媒体资源的配额的当前状态。配额在 PropertyQuota 中返回。
comparisons[]

object (Comparison)

可选。请求和显示的比较的配置。该请求需要同时包含 comparisons 字段和 comparisons 维度，才能在响应中收到比较列。