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

房源的当前时区。旨在用于解读基于时间的维度,例如 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

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

枚举
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