Method: properties.checkCompatibility

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

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

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

HTTP リクエスト

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

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

パスパラメータ

パラメータ
property

string

イベントがトラッキングされる Google アナリティクスのプロパティの 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)

このディメンションの互換性。互換性が COMPATIBLE の場合、このディメンションはレポートに正常に追加できます。

MetricCompatibility

単一の指標の互換性。

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

object (MetricMetadata)

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

enum (Compatibility)

この指標の互換性。互換性が COMPATIBLE の場合、この指標はレポートに正常に追加できます。