ResponseMetaData

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

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

boolean

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

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

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

如需了解详情,请参阅“(其他)”行和数据抽样简介

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

媒体资源的当前时区。旨在用于解读基于时间的维度,例如 hourminute。格式为 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

SamplingMetadata

如果此报告结果为抽样,则表示此报告中使用的事件所占的百分比。抽样是指分析所有数据的一个子集,以在较大的数据集中发现有意义的信息。

JSON 表示法
{
  "samplesReadCount": string,
  "samplingSpaceSize": string
}
字段
samplesReadCount

string (int64 format)

在此抽样报告中读取的事件总数。这是该报告中分析的该媒体资源数据的子集的大小。

samplingSpaceSize

string (int64 format)

在相应日期范围内,此媒体资源的数据中本来可以分析的事件总数。抽样揭示了有关较大数据集的有用信息,这表明较大数据集的规模。

如需计算此报告中使用的可用数据的百分比,请计算 samplesReadCount/samplingSpaceSize