Method: properties.checkCompatibility

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

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

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

HTTP リクエスト

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

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

パスパラメータ

パラメータ
property

string

イベントがトラッキングされる Google アナリティクスの GA4 プロパティの識別子。詳しくは、プロパティ 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

互換性

1 つのディメンションまたは指標の互換性タイプ。

列挙型
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)

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