Method: properties.checkCompatibility

この互換性メソッドでは、レポート リクエストに追加して互換性を維持するために利用できるディメンションと指標を指定します。このメソッドは、リクエストのディメンションと指標に互換性がない場合、失敗します。

Google アナリティクスで、互換性のないディメンションまたは指標がリクエストされると、レポートは失敗します。その場合は、互換性のないレポートからディメンションや指標を削除する必要があります。

リアルタイム レポートと主要レポートでは、互換性ルールが異なります。この方法では、Core レポートの互換性を確認します。

HTTP リクエスト

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

この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
property

string

イベントがトラッキングされる Google アナリティクス GA4 プロパティ 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 名が含まれます。ディメンションのメタデータには、UI の名前や説明などのその他の有用な情報も含まれています。
compatibility

enum (Compatibility)

このディメンションの互換性。互換性が「互換」であれば、このディメンションは正常にレポートに追加できます。

MetricCompatibility

単一の指標の互換性。

JSON 表現 
{
  "metricMetadata": {
    object (MetricMetadata)
  },
  "compatibility": enum (Compatibility)
}
フィールド
metricMetadata

object (MetricMetadata)

指標メタデータには、この互換性情報の API 名が含まれます。指標メタデータには、UI の名前や説明などのその他の有用な情報も含まれています。
compatibility

enum (Compatibility)

この指標の互換性。互換性が「互換」であれば、この指標をレポートに追加できます。