Method: runPivotReport

返回 Google Analytics(分析)事件数据的自定义透视报告。与常规报表相比,数据透视报表是更高级且更具表现力的格式。在数据透视报告中,只有包含在数据透视中的维度才会显示。您可以指定多个数据透视来进一步剖析数据。

HTTP 请求

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

网址采用 gRPC 转码语法。

请求正文

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

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)

请求的维度。所有已定义的维度都必须由以下对象之一使用:dimension 表达式、dimensionFilter、数据透视表、orderBys。

metrics[]

object (Metric)

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

dimensionFilter

object (FilterExpression)

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

metricFilter

object (FilterExpression)

指标的过滤条件子句。在汇总后阶段应用,类似于 SQL 包含子句。必须请求指标,才能在此过滤条件中使用。维度不能在此过滤条件中使用。

pivots[]

object (Pivot)

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

dateRanges[]

object (DateRange)

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

currencyCode

string

ISO4217 格式的货币代码,例如“AED”“USD”“JPY”。如果该字段留空,则报告会使用实体的默认货币。

cohortSpec

object (CohortSpec)

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

keepEmptyRows

boolean

如果为 false 或未指定,则不会返回所有指标都等于 0 的每一行。如果为 true,则返回这些行(前提是它们未被过滤器单独移除)。

returnPropertyQuota

boolean

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

响应正文

如果成功,则响应正文包含一个 RunPivotReportResponse 实例。

授权范围

需要以下 OAuth 范围之一:

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