Method: properties.reportTasks.query

检索报告任务的内容。请求 reportTasks.create 后，您可以在报告处于“有效”状态时检索报告内容。如果报告任务的状态不是 ACTIVE，此方法将返回错误。查询响应将返回报告的表格行和列值。

HTTP 请求

POST https://analyticsdata.googleapis.com/v1alpha/{name=properties/*/reportTasks/*}:query

网址采用 gRPC 转码语法。

路径参数

参数
name

string

必需。报告源名称。格式：properties/{property}/reportTasks/{report}

请求正文

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

JSON 表示法 
{
  "offset": string,
  "limit": string
}
字段
offset

string (int64 format)

可选。报告中起始行的行数。第一行计为第 0 行。

分页时，第一个请求不指定偏移量；或者等效地将偏移量设置为 0；第一个请求返回前 limit 行。第二个请求将偏移量设置为第一个请求的 limit；第二个请求返回第二个 limit 行。

如需详细了解此分页参数，请参阅分页。
limit

string (int64 format)

可选。要从报告中返回的行数。如果未指定，则返回 10,000 行。无论您请求多少行，该 API 每次请求最多返回 25 万行。limit 必须为正值。

如果维度值的数量少于 limit，API 也可能会返回少于所请求的 limit 行。QueryReportTaskRequest 可用的行数进一步受关联的 ReportTask 的限制。一个查询最多可以检索 ReportTask.limit 行。例如，如果 ReportTask 的上限为 1,000，那么 offset=900 且 limit=500 的 reportTasks.query 请求最多会返回 100 行。

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

响应正文

与报告任务对应的报告内容。

如果成功，响应正文将包含结构如下的数据：

JSON 表示法 
{
  "dimensionHeaders": [
    {
      object (DimensionHeader)
    }
  ],
  "metricHeaders": [
    {
      object (MetricHeader)
    }
  ],
  "rows": [
    {
      object (Row)
    }
  ],
  "totals": [
    {
      object (Row)
    }
  ],
  "maximums": [
    {
      object (Row)
    }
  ],
  "minimums": [
    {
      object (Row)
    }
  ],
  "rowCount": integer,
  "metadata": {
    object (ResponseMetaData)
  }
}
字段
dimensionHeaders[]

object (DimensionHeader)

描述维度列。DimensionHeaders 的数量和顺序与行中存在的维度一致。
metricHeaders[]

object (MetricHeader)

描述指标列。MetricHeaders 的数量和顺序与行中存在的指标相匹配。
rows[]

object (Row)

报告中维度值组合和指标值的行。
totals[]

object (Row)

如果请求了指标，则为指标的总计值。
maximums[]

object (Row)

如果请求，则为指标的最大值。
minimums[]

object (Row)

如果请求，则为指标的最小值。
rowCount

integer

查询结果中的总行数。
metadata

object (ResponseMetaData)

报告的元数据。

授权范围

需要以下 OAuth 范围之一：

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