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 行。

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

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

string (int64 format)

可选。要从报告返回的行数。如果未指定，将返回 10,000 行。无论您请求返回多少行，每个请求最多返回 250,000 行。“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)

描述维度列。DimensionHeader 的数量和 DimensionHeader 的顺序与行中显示的维度一致。
metricHeaders[]

object (MetricHeader)

说明指标列。MetricHeader 的数量和 MetricHeader 的顺序与行中显示的指标一致。
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

ResponseMetaData

响应的元数据，其中包含有关报告内容的额外信息。

JSON 表示法 
{
  "dataLossFromOtherRow": boolean,
  "schemaRestrictionResponse": {
    object (SchemaRestrictionResponse)
  },
  "currencyCode": string,
  "timeZone": string,
  "emptyReason": string,
  "subjectToThresholding": boolean
}
字段
dataLossFromOtherRow

boolean

如果为 true，则表示某些维度组合类别已汇总到“（其他）”行中。高基数报告可能会发生这种情况。

系统会根据报告中使用的汇总数据表填充元数据参数 dataLossFromOtherRow。无论报告中的过滤条件和限制如何，该参数都会准确填充。

例如，系统可能会从报告中移除“(other)”行，因为相应请求包含针对 sessionSource = google 的过滤条件。如果用于生成此报告的输入汇总数据中存在来自其他行的数据丢失，系统仍会填充此参数。

如需了解详情，请参阅“（其他）”行和数据抽样简介。
schemaRestrictionResponse

object (SchemaRestrictionResponse)

描述在创建此报告时主动强制执行的架构限制。如需了解详情，请参阅访问权限和数据限制管理。
currencyCode

string

此报告中使用的货币代码。旨在用于为货币指标设置格式，例如为可视化图表设置 purchaseRevenue 格式。如果请求中指定了 currencyCode，则此响应参数会回显请求参数；否则，此响应参数就是媒体资源的当前 currencyCode。

货币代码是 ISO 4217 标准 (https://en.wikipedia.org/wiki/ISO_4217) 中货币类型的字符串编码，例如“USD”“EUR”“JPY”。如需了解详情，请参阅 https://support.google.com/analytics/answer/9796179。
timeZone

string

媒体资源的当前时区。旨在用于解读基于时间的维度，例如 hour 和 minute。格式为 IANA 时区数据库 (https://www.iana.org/time-zones) 中的字符串，例如“America/New_York”或“Asia/Tokyo”。
emptyReason

string

如果指定的原因为空，则由于该原因，报告为空。
subjectToThresholding

boolean

如果 subjectToThresholding 为 true，则表示此报告存在阈值限制，仅返回达到最低汇总阈值的数据。请求可能会受到阈值限制，并且报告中不会缺少数据，当所有数据超过阈值时，就会发生这种情况。要了解详情，请参阅最低数据量和受众特征和兴趣简介。

SchemaRestrictionResponse

系统会在创建此报告时主动强制执行架构限制。如需了解详情，请参阅访问权限和数据限制管理。

JSON 表示法 
{
  "activeMetricRestrictions": [
    {
      object (ActiveMetricRestriction)
    }
  ]
}
字段
activeMetricRestrictions[]

object (ActiveMetricRestriction)

系统会在创建报告时主动强制执行所有限制。例如，purchaseRevenue 的限制类型始终为 REVENUE_DATA。不过，只有当用户的自定义角色禁止访问 REVENUE_DATA 时，系统才会填充这一有效响应限制。

ActiveMetricRestriction

创建报告时受到积极限制的指标。

JSON 表示法 
{
  "restrictedMetricTypes": [
    enum (RestrictedMetricType)
  ],
  "metricName": string
}
字段
restrictedMetricTypes[]

enum (RestrictedMetricType)

此指标的限制原因。
metricName

string

受限指标的名称。

RestrictedMetricType

在某些 GA4 媒体资源中，您可能无法查看的数据类别。

枚举
RESTRICTED_METRIC_TYPE_UNSPECIFIED 未指定类型。
COST_DATA 费用指标，例如 adCost。
REVENUE_DATA 收入指标，例如 purchaseRevenue。