Method: properties.checkCompatibility

这种兼容性方法会列出可添加到报表请求并保持兼容性的维度和指标。如果请求的维度和指标不兼容,此方法会失败。

在 Google Analytics(分析)中,如果报告请求不兼容的维度和/或指标,则会失败;在这种情况下,您需要从不兼容的报告中移除维度和/或指标,直到报告兼容为止。

“实时”报告和“核心”报告采用不同的兼容性规则。此方法会检查核心报告的兼容性。

HTTP 请求

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

网址采用 gRPC 转码语法。

路径参数

参数
property

string

用于跟踪事件的 Google Analytics(分析)GA4 媒体资源标识符。如需了解详情,请参阅如何找到媒体资源 IDproperty 应与 runReport 请求中的值相同。

示例:properties/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)

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

metricFilter

object (FilterExpression)

指标的 filter 子句。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)

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