Method: properties.batchRunReports

以批处理方式返回多个报告。所有报告都必须针对同一 Google Analytics 媒体资源。

HTTP 请求

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

网址采用 gRPC 转码语法。

路径参数

参数
property

string

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

示例：properties/1234

请求正文

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

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

object (RunReportRequest)

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

响应正文

包含多个报告的批处理响应。

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

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

object (RunReportResponse)

单个响应。每个响应都有单独的报告请求。
kind

string

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

授权范围

需要以下 OAuth 范围之一：

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

RunReportRequest

用于生成报告的请求。

JSON 表示法 
{
  "property": string,
  "dimensions": [
    {
      object (Dimension)
    }
  ],
  "metrics": [
    {
      object (Metric)
    }
  ],
  "dateRanges": [
    {
      object (DateRange)
    }
  ],
  "dimensionFilter": {
    object (FilterExpression)
  },
  "metricFilter": {
    object (FilterExpression)
  },
  "offset": string,
  "limit": string,
  "metricAggregations": [
    enum (MetricAggregation)
  ],
  "orderBys": [
    {
      object (OrderBy)
    }
  ],
  "currencyCode": string,
  "cohortSpec": {
    object (CohortSpec)
  },
  "keepEmptyRows": boolean,
  "returnPropertyQuota": boolean,
  "comparisons": [
    {
      object (Comparison)
    }
  ]
}
字段
property

string

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

示例：properties/1234
dimensions[]

object (Dimension)

请求和显示的维度。
metrics[]

object (Metric)

请求和显示的指标。
dateRanges[]

object (DateRange)

要读取的数据的日期范围。如果请求了多个日期范围，则每个响应行都将包含一个从零开始的日期范围索引。如果两个日期范围重叠，则重叠日期的事件数据会包含在两个日期范围的响应行中。在群组请求中，此 dateRanges 必须未指定。
dimensionFilter

object (FilterExpression)

借助维度过滤条件，您可以在报告中仅请求特定维度值。如需了解详情，请参阅维度过滤条件基础知识中的示例。此过滤条件中不能使用指标。
metricFilter

object (FilterExpression)

指标的过滤子句。在汇总报告的行后应用，类似于 SQL having 子句。此过滤条件中不能使用维度。
offset

string (int64 format)

起始行的行数。第一行计为第 0 行。

进行分页时，第一个请求不会指定偏移量；或者，将偏移量设置为 0；第一个请求会返回前 limit 行。第二个请求会将偏移量设置为第一个请求的 limit；第二个请求会返回第二个 limit 行。

如需详细了解此分页参数，请参阅分页。
limit

string (int64 format)

要返回的行数。如果未指定，则返回 10,000 行。无论您请求多少行，API 每个请求最多返回 250,000 行。limit 必须为正数。

如果维度值的数量少于 limit，API 也可能会返回少于请求的 limit 的行数。例如，维度 country 的可能值少于 300 个，因此，如果仅报告 country，即使您将 limit 设置为更高的值，也无法获得超过 300 行。

如需详细了解此分页参数，请参阅分页。
metricAggregations[]

enum (MetricAggregation)

指标的聚合。聚合的指标值将显示在 dimensionValues 设置为“RESERVED_(MetricAggregation)”的行中。同时包含比较和多个日期范围的聚合将根据日期范围进行聚合。
orderBys[]

object (OrderBy)

指定响应中行的排序方式。同时包含比较和多个日期范围的请求将对比较应用排序依据。
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 字段，即可在响应中接收比较列。