Method: batchRunPivotReports

批量返回多个数据透视报告。所有报告都必须针对同一实体。

HTTP 请求

POST https://analyticsdata.googleapis.com/v1alpha:batchRunPivotReports

网址采用 gRPC 转码语法。

请求正文

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

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

object (Entity)

跟踪其事件的属性。必须为批次指定此实体。RunPivotReportRequest 中的实体可能未指定或与此实体一致。

requests[]

object (RunPivotReportRequest)

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

响应正文

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

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

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

object (RunPivotReportResponse)

逐条回复。每个响应都有一个单独的数据透视报告请求。

授权范围

需要以下 OAuth 范围之一:

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

RunPivotReportRequest

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

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

object (Entity)

跟踪其事件的属性。在批量请求中,应不指定此实体或与批量级实体保持一致。

dimensions[]

object (Dimension)

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

metrics[]

object (Metric)

对于所请求的指标,至少需要指定一项指标。所有定义的指标都必须由以下项之一使用:metric_expression、metricFilter、orderBys。

dimensionFilter

object (FilterExpression)

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

metricFilter

object (FilterExpression)

指标的 filter 子句。在汇总后阶段应用,类似于 SQL has-clause。必须请求要在此过滤器中使用的指标。此过滤条件中不能使用维度。

pivots[]

object (Pivot)

以列或行的形式显示报告维度的直观格式。所有数据透视中的 fieldsName(维度名称)的并集必须是“维度”中定义的维度名称的子集。任何两个数据透视不能共用同一维度。仅当某个维度显示在数据透视中时,该维度才会显示。

dateRanges[]

object (DateRange)

用于检索报告中事件数据的日期范围。如果指定了多个日期范围,则报告中会使用每个日期范围内的事件数据。数据透视字段名称中可以包含字段名称为“dateRange”的特殊维度;如果包含该维度,则报告会比较不同日期范围的数据。在同类群组请求中,不得指定此 dateRanges

currencyCode

string

采用 ISO4217 格式的货币代码,例如“AED”“USD”“JPY”。如果此字段为空,报表会使用实体的默认货币。

cohortSpec

object (CohortSpec)

与此请求关联的同类群组。如果请求中包含同类群组组,则必须提供“同类群组”维度。

keepEmptyRows

boolean

如果为 false 或未指定,则不会返回所有指标等于 0 的每一行。如果为 true,则只要过滤器未单独移除这些行,就会返回这些行。

returnPropertyQuota

boolean

切换是否返回此 Google Analytics(分析)媒体资源配额的当前状态。配额在 PropertyQuota 中返回。