ResponseMetaData

• JSON 表示法
• SchemaRestrictionResponse
  • JSON 表示法
• ActiveMetricRestriction
  • JSON 表示法
• RestrictedMetricType
• SamplingMetadata
  • JSON 表示法
• DataTruncationReason
  • JSON 表示法
• DataTruncationType
• DataTruncationDateRange
  • JSON 表示法

响应的元数据，包含有关报告内容的附加信息。

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

字段
dataLossFromOtherRow	boolean 如果为 true，则表示某些维度组合的桶会汇总到“（其他）”行中。高基数报告可能会出现这种情况。 metadata 参数 dataLossFromOtherRow 会根据报告中使用的汇总数据表进行填充。无论报告中存在哪些过滤条件和限制，系统都会准确填充相应参数。 例如，由于请求包含针对 sessionSource = google 的过滤条件，因此报告中可能会舍弃“(other)”行。如果用于生成此报告的输入汇总数据中存在来自其他行的数据丢失，系统仍会填充此参数。 如需了解详情，请参阅“（其他）”行和数据抽样简介。
samplingMetadatas[]	object (SamplingMetadata) 如果此报告的结果是抽样的，则此属性会说明此报告中使用的事件百分比。每个日期范围都会填充一个 samplingMetadatas。每个 samplingMetadatas 对应于请求中指定的日期范围（按日期范围在请求中指定的顺序）。 不过，如果结果未经过抽样，则不会定义此字段。
dataTruncationReasons[]	object (DataTruncationReason) 如果设置，则表示报告中存在数据截断。
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。

SamplingMetadata

如果此报告的结果是抽样的，则此属性会说明此报告中使用的事件百分比。抽样是指：从全部数据中选择部分数据进行分析，以发掘适用于更大数据集的有用信息。

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

字段
samplesReadCount	string (int64 format) 相应日期范围内此抽样报告中读取的事件总数。这是相应媒体资源的数据子集的大小，该子集的数据已在此报告中进行分析。
samplingSpaceSize	string (int64 format) 相应日期范围内，相应媒体资源的数据中可在此报告中进行分析的事件总数。抽样可发掘出有关更大数据集的有意义信息，而这是更大数据集的大小。 如需计算此报告中使用的可用数据百分比，请计算 samplesReadCount/samplingSpaceSize。

DataTruncationReason

说明报告中数据截断的原因。

JSON 表示法
{ "dataTruncationDateRanges": [ { object (DataTruncationDateRange) } ], "dataTruncationType": enum (DataTruncationType), "dataTruncationMessage": string, "dataTruncationDate": string }

字段
dataTruncationDateRanges[]	object (DataTruncationDateRange) 截断的日期范围。
dataTruncationType	enum (DataTruncationType) 数据截断的类型。
dataTruncationMessage	string 说明数据截断的描述性消息。
dataTruncationDate	string 数据截断日期，格式为 YYYY-MM-DD。表示此日期之前的数据已被截断。

DataTruncationType

数据截断的类型。

枚举
DATA_TRUNCATION_TYPE_UNSPECIFIED	未指定的类型。
DATA_TRUNCATION_TYPE_RULES_BASED_MODELS	对于基于规则的模型的黄金日期，归因报告中的数据会被截断。
DATA_TRUNCATION_TYPE_DATA_DRIVEN_ATTRIBUTION	以数据为依据的归因黄金日期对应的归因报告中的数据被截断。
DATA_TRUNCATION_TYPE_DV360	由于 DV360 政策不允许返回 2 年前的数据，因此数据被截断。
DATA_TRUNCATION_TYPE_CM360	数据被截断，因为 CM360 政策不允许返回 2 年前的数据。
DATA_TRUNCATION_TYPE_ITEM_SCOPED_ECOMMERCE_METRICS	新的商品级范围的电子商务指标仅在特定日期之后才有数据。
DATA_TRUNCATION_TYPE_EVENT_SCOPED_ECOMMERCE_METRICS	新的事件级范围的电子商务指标仅包含特定日期之后的数据。
DATA_TRUNCATION_TYPE_DATE_RANGE	查询日期范围可能未完全覆盖。
DATA_TRUNCATION_TYPE_PROPERTY	数据被截断，因为查询尝试读取保留日期之前的事件数据。
DATA_TRUNCATION_TYPE_CONVERSIONS	转化报告中的数据被截断。
DATA_TRUNCATION_TYPE_GOOGLE_ADS	由于 Google Ads 的 36 个月数据保留政策，数据已被截断。

DataTruncationDateRange

定义从 startDate 到 endDate 的截断日期范围。

JSON 表示法
{ "startDate": string, "endDate": string }

字段
startDate	string 开始日期，格式为 YYYY-MM-DD（含）。
endDate	string 结束日期，格式为 YYYY-MM-DD（含）。