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)

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

object (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,
  "samplingMetadatas": [
    {
      object (SamplingMetadata)
    }
  ],
  "schemaRestrictionResponse": {
    object (SchemaRestrictionResponse)
  },
  "currencyCode": string,
  "timeZone": string,
  "emptyReason": string,
  "subjectToThresholding": boolean
}
字段
dataLossFromOtherRow

boolean

如果为 true，则表示某些维度组合的存储分区会汇总到“（其他）”行中。高基数报告可能会出现这种情况。

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

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

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

object (SamplingMetadata)

如果此报告结果是抽样的，则此值表示此报告中所用事件的百分比。系统会为每个日期范围填充一个 samplingMetadatas。每个 samplingMetadatas 都对应于一个日期范围，以便在请求中指定日期范围。

不过，如果未对结果进行抽样，则不会定义此字段。
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

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

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