Method: properties.runPivotReport

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

HTTP 请求

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

网址采用 gRPC 转码语法。

路径参数

参数
property

string

跟踪事件的 Google Analytics(分析)GA4 媒体资源标识符。在网址路径(而非正文)中指定。如需了解详情,请参阅在哪里可以找到您的媒体资源 ID。在批处理请求中,此属性应未指定或与批次级属性保持一致。

示例:properties/1234

请求正文

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

JSON 表示法
{
  "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
}
字段
dimensions[]

object (Dimension)

所请求的维度。所有定义的维度都必须使用下列维度之一:dimension 表达式、dimensionFilter、数据透视表、orderBy。

metrics[]

object (Metric)

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

dateRanges[]

object (DateRange)

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

pivots[]

object (Pivot)

以列或行的形式说明报告维度的视觉格式。所有数据透视中的字段名(维度名称)的并集必须是维度中定义的维度名称的子集。两个数据透视不能共享维度。维度仅在数据透视中显示。

dimensionFilter

object (FilterExpression)

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

metricFilter

object (FilterExpression)

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

currencyCode

string

采用 ISO4217 格式的货币代码,例如“AED”、“AUSD”和“JPY”。如果此字段为空,则报告将使用媒体资源的默认币种。

cohortSpec

object (CohortSpec)

与此请求关联的同类群组组。如果请求中有一个同类群组组,则必须提供“同类群组”维度。{0}{/1}

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