Method: properties.checkCompatibility

這個相容性方法會列出可新增至報表要求的維度和指標，並維持相容性。如果要求的維度和指標不相容，這個方法就會失敗。

如果報表要求不相容的維度和/或指標，就會失敗。在這種情況下，您必須從不相容的報表中移除維度和/或指標，直到報表相容為止。

即時和核心報表的相容性規則不同。這個方法會檢查核心報表的相容性。

HTTP 要求

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

這個網址使用 gRPC 轉碼語法。

路徑參數

參數
property

string

要追蹤事件的 Google Analytics 資源 ID。詳情請參閱「如何查看資源 ID」一文。property 應與 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)

維度的篩選器子句。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 名稱。指標中繼資料也包含其他實用資訊，例如 UI 名稱和說明。
compatibility

enum (Compatibility)

這個指標的相容性。如果相容性為「相容」，這項指標就能成功加入報表。