Method: properties.reportTasks.query

检索报告任务的内容。请求 reportTasks.create 后，一旦报告变为 ACTIVE 状态，您就可以检索报告内容。如果报告任务的状态不是 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)

描述维度列。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，则表示部分维度组合汇总到“(other)”项中。高基数报告可能会出现这种情况。

系统会根据报告中使用的汇总数据表填充元数据参数 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”或“亚洲/东京”
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。