Method: runReport

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

HTTP 请求

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

网址采用 gRPC 转码语法。

请求正文

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

JSON 表示法 
{
  "entity": {
    object (Entity)
  },
  "dimensions": [
    {
      object (Dimension)
    }
  ],
  "metrics": [
    {
      object (Metric)
    }
  ],
  "dateRanges": [
    {
      object (DateRange)
    }
  ],
  "offset": string,
  "limit": string,
  "metricAggregations": [
    enum (MetricAggregation)
  ],
  "dimensionFilter": {
    object (FilterExpression)
  },
  "metricFilter": {
    object (FilterExpression)
  },
  "orderBys": [
    {
      object (OrderBy)
    }
  ],
  "currencyCode": string,
  "cohortSpec": {
    object (CohortSpec)
  },
  "keepEmptyRows": boolean,
  "returnPropertyQuota": boolean
}
字段
entity

object (Entity)

跟踪其事件的媒体资源。在批量请求中，此实体应未指定或与批量级实体一致。
dimensions[]

object (Dimension)

请求并显示的维度。
metrics[]

object (Metric)

请求并显示的指标。
dateRanges[]

object (DateRange)

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

string (int64 format)

起始行的行数。第一行计为第 0 行。
limit

string (int64 format)

要返回的行数。如果未指定 limit 参数，则返回 10,000 行。无论您要求返回多少行，对于每个请求，API 最多只能返回 10 万行。
metricAggregations[]

enum (MetricAggregation)

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

object (FilterExpression)

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

object (FilterExpression)

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

object (OrderBy)

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

string

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

object (CohortSpec)

与此请求关联的同类群组。如果请求中包含同类群组组，则为“同类群组”维度。
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