Method: properties.checkCompatibility

此兼容性方法会列出可添加到报告请求并保持兼容性的维度和指标。如果请求的维度和指标不兼容，则此方法将失败。

在 Google Analytics 中，如果报告请求不兼容的维度和/或指标，则会失败；在这种情况下，您需要从不兼容的报告中移除维度和/或指标，直到该报告能够兼容为止。

实时报告和核心报告具有不同的兼容性规则。此方法可检查核心报告的兼容性。

HTTP 请求

POST https://analyticsdata.googleapis.com/v1beta/{property=properties/*}:checkCompatibility

网址采用 gRPC 转码语法。

路径参数

参数
property

string

用于跟踪事件的 Google Analytics GA4 媒体资源标识符。如需了解详情，请参阅在哪里可以找到媒体资源 ID。property 的值应与 runReport 请求中的值相同。

示例：property/1234

请求正文

请求正文中包含结构如下的数据：

JSON 表示法 
{
  "dimensions": [
    {
      object (Dimension)
    }
  ],
  "metrics": [
    {
      object (Metric)
    }
  ],
  "dimensionFilter": {
    object (FilterExpression)
  },
  "metricFilter": {
    object (FilterExpression)
  },
  "compatibilityFilter": enum (Compatibility)
}
字段
dimensions[]

object (Dimension)

此报告中的维度。dimensions 的值应与 runReport 请求中的值相同。
metrics[]

object (Metric)

此报告中的指标。metrics 的值应与 runReport 请求中的值相同。
dimensionFilter

object (FilterExpression)

维度的过滤子句。dimensionFilter 的值应与 runReport 请求中的值相同。
metricFilter

object (FilterExpression)

指标的过滤子句。metricFilter 应该与您的 runReport 请求中的值相同
compatibilityFilter

enum (Compatibility)

对响应中的维度和指标进行过滤，以便仅应用这种兼容性。通常用作 ”compatibilityFilter”: “COMPATIBLE”，以便仅返回兼容的尺寸和指标。

响应正文

兼容性响应包含每个维度的兼容性，指标。

如果成功，响应正文将包含结构如下的数据：

JSON 表示法 
{
  "dimensionCompatibilities": [
    {
      object (DimensionCompatibility)
    }
  ],
  "metricCompatibilities": [
    {
      object (MetricCompatibility)
    }
  ]
}
字段
dimensionCompatibilities[]

object (DimensionCompatibility)

每个维度的兼容性。
metricCompatibilities[]

object (MetricCompatibility)

每个指标的兼容性。

授权范围

需要以下 OAuth 范围之一：

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics

兼容性

单个维度或指标的兼容性类型。

枚举
COMPATIBILITY_UNSPECIFIED 未指定的兼容性。
COMPATIBLE 维度或指标兼容。您可以将此维度或指标成功添加到报告中。
INCOMPATIBLE 维度或指标不兼容。此维度或指标无法成功添加到报告中。

DimensionCompatibility

单个维度的兼容性。

JSON 表示法 
{
  "dimensionMetadata": {
    object (DimensionMetadata)
  },
  "compatibility": enum (Compatibility)
}
字段
dimensionMetadata

object (DimensionMetadata)

维度元数据包含此兼容性信息的 API 名称。维度元数据还包含其他实用信息，例如界面名称和说明。
compatibility

enum (Compatibility)

此维度的兼容性。如果兼容性是兼容的，则此维度可以成功添加到报告中。

MetricCompatibility

单个指标的兼容性。

JSON 表示法 
{
  "metricMetadata": {
    object (MetricMetadata)
  },
  "compatibility": enum (Compatibility)
}
字段
metricMetadata

object (MetricMetadata)

指标元数据包含此兼容性信息的 API 名称。指标元数据还包含界面名称和说明等其他实用信息。
compatibility

enum (Compatibility)

此指标的兼容性。如果兼容性为“兼容”，则此指标可以成功添加到报告中。