此页面由 Cloud Translation API 翻译。

Method: properties.runReport

HTTP 请求
路径参数
请求正文
- JSON 表示法
响应正文
授权范围
试试看！

返回包含 Google Analytics 事件数据的自定义报告。报告包含根据 Google Analytics 跟踪代码收集的数据衍生的统计信息。API 返回的数据是一个表格，其中包含所请求的维度和指标的相关列。指标是对您媒体资源上用户活动的各个衡量结果，例如活跃用户数或事件数。维度可按一些常见的条件（例如国家/地区或事件名称）对指标进行细分。

如需获取构建请求的指南以及请参阅创建报告。

HTTP 请求

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

网址采用 gRPC 转码语法。

路径参数

参数

参数
`property`	`string` 用于跟踪事件的 Google Analytics GA4 媒体资源标识符。在网址路径（而非正文）中指定。如需了解详情，请参阅在哪里可以找到您的媒体资源 ID。在批处理请求中，此属性应未指定或与批处理级属性一致。示例：property/1234

property

string

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

示例：property/1234

请求正文

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

JSON 表示法

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, "comparisons": [ { object (`Comparison`) } ] }

{
  "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)
    }
  ]
}

字段
`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)` 要返回的行数。如果未指定，则返回 10,000 行。无论您要求返回多少行，对于每个请求，API 最多只能返回 25 万行。`limit` 必须为正数。如果维度值没有 `limit` 那么多，API 返回的行数也可能少于所请求的 `limit` 行数。例如，如果维度“`country`”的可能值少于 300 个，那么当针对“`country`”生成报告时，即使您将“`limit`”设置为更大的值，行数也不会超过 300 行。如需详细了解此分页参数，请参阅分页。
`metricAggregations[]`	`enum (MetricAggregation)` 指标汇总。汇总的指标值显示在维度值设为“RESERVED_(MetricAggregation)”的行中。
`orderBys[]`	`object (OrderBy)` 指定响应中各行的排序方式。
`currencyCode`	`string` 采用 ISO4217 格式的货币代码，例如“AED”“USD”“JPY”。如果此字段为空，报告将使用媒体资源的默认货币。
`cohortSpec`	`object (CohortSpec)` 与此请求关联的同类群组。如果请求中包含同类群组组，则为“同类群组”维度。
`keepEmptyRows`	`boolean` 如果为 false 或未指定，则系统不会返回所有指标都等于 0 的每一行。如果为 true，系统将返回这些行，前提是它们没有被过滤器单独移除。无论这项 `keepEmptyRows` 设置为何，报告中都只能显示由 Google Analytics (GA4) 媒体资源记录的数据。例如，如果媒体资源从不记录 `purchase` 事件，那么针对 `eventName` 维度和 `eventCount` 指标的查询将不会有行 eventName：“purchase”和 eventCount：0。
`returnPropertyQuota`	`boolean` 切换是否返回此 Google Analytics 媒体资源配额的当前状态。配额在 PropertyQuota 中返回。
`comparisons[]`	`object (Comparison)` 可选。请求和显示的比较项的配置。该请求只需要一个比较字段，这样就可以在响应中收到一个比较列。

响应正文

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

授权范围

需要以下 OAuth 范围之一：

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