Method: properties.runReport

返回 Google Analytics(分析)事件数据的自定义报告。报告包含源自 Google Analytics(分析)跟踪代码所收集的数据的统计信息。从 API 返回的数据会以表格形式列出所请求的维度和指标。指标是指对您媒体资源上的用户活动(例如活跃用户数或事件数)的各项衡量。维度用于按照一些常用条件(例如国家/地区或事件名称)对指标进行细分。

有关构建请求和了解响应的指南,请参阅创建报告

HTTP 请求

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

网址采用 gRPC 转码语法。

路径参数

参数
property

string

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

示例:properties/1234

请求正文

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

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

object (Dimension)

请求和显示的维度。

metrics[]

object (Metric)

请求和显示的指标。

dateRanges[]

object (DateRange)

要读取的数据的日期范围。如果请求了多个日期范围,则每个响应行都会包含一个从零开始的日期范围索引。如果两个日期范围发生重叠,则重叠日期范围的事件数据会同时添加到两个日期范围的响应行中。在同类群组请求中,未指定此 dateRanges

dimensionFilter

object (FilterExpression)

通过维度过滤条件,您可以仅要求在报告中提供特定的维度值。如需了解详情,请参阅维度过滤条件基础知识。此过滤条件中不能使用指标。

metricFilter

object (FilterExpression)

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

offset

string (int64 format)

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

进行分页时,第一个请求未指定偏移量;或将等效项设置为 0;第一个请求返回行的第一个 limit。第二个请求会将偏移量设置为第一个请求的 limit;第二个请求会返回第二个行的 limit

如需详细了解此分页参数,请参阅分页

limit

string (int64 format)

要返回的行数。如果未指定,则返回 10000 行。无论您要求返回多少行,该 API 最多可为每个请求返回 10 万行。“limit”必须为正数。

如果维度值数量少于 limit,该 API 返回的行数也可能低于请求的 limit。例如,维度 country 的值可能少于 300 个,当仅针对 country 生成报告时,即使您将 limit 设为更高的值,也不能超过 300 行。

如需详细了解此分页参数,请参阅分页

metricAggregations[]

enum (MetricAggregation)

指标汇总。汇总指标值将显示在将维度值设为“RESERVED_(MetricAggregation)”的行。

orderBys[]

object (OrderBy)

指定响应中各行的排序方式。

currencyCode

string

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

cohortSpec

object (CohortSpec)

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

keepEmptyRows

boolean

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

returnPropertyQuota

boolean

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

响应正文

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

授权范围

需要以下 OAuth 范围之一:

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