- HTTP リクエスト
- パスパラメータ
- リクエストの本文
- レスポンスの本文
- 認可スコープ
- 対応するデバイス
- DimensionCompatibility
- MetricCompatibility
- 試してみる
この互換性メソッドでは、レポート リクエストに追加可能なディメンションと指標のリストを指定します。これにより、互換性を維持できます。リクエストのディメンションと指標に互換性がない場合、このメソッドは失敗します。
Google アナリティクスでは、互換性のないディメンションや指標がリクエストされた場合、レポートは失敗します。そのような場合は、互換性のないレポートからディメンションと指標を削除する必要があります。
リアルタイム レポートと主要レポートでは、互換性ルールが異なります。このメソッドは、Core レポートの互換性をチェックします。
HTTP リクエスト
POST https://analyticsdata.googleapis.com/v1beta/{property=properties/*}:checkCompatibility
この URL は gRPC Transcoding 構文を使用します。
パスパラメータ
パラメータ | |
---|---|
property |
イベントがトラッキングされる Google アナリティクス GA4 プロパティの識別子。詳しくは、プロパティ ID を確認する方法をご覧ください。 例: properties/1234 |
リクエスト本文
リクエストの本文には、次の構造のデータが含まれます。
JSON 表現 |
---|
{ "dimensions": [ { object ( |
フィールド | |
---|---|
dimensions[] |
このレポートのディメンション。 |
metrics[] |
このレポートの指標。 |
dimensionFilter |
ディメンションのフィルタ句。 |
metricFilter |
指標のフィルタ句。 |
compatibilityFilter |
この互換性のみに基づいてレスポンスのディメンションと指標をフィルタします。通常は、互換性のあるディメンションと指標のみを返すために |
レスポンスの本文
各ディメンションと指標の互換性に関する互換性のレスポンス。
成功すると、レスポンスの本文に次の構造のデータが含まれます。
JSON 表現 |
---|
{ "dimensionCompatibilities": [ { object ( |
フィールド | |
---|---|
dimensionCompatibilities[] |
各ディメンションの互換性。 |
metricCompatibilities[] |
各指標の互換性。 |
承認スコープ
次の OAuth スコープのいずれかが必要です。
https://www.googleapis.com/auth/analytics.readonly
https://www.googleapis.com/auth/analytics
互換性
1 つのディメンションまたは指標の互換性タイプ。
列挙型 | |
---|---|
COMPATIBILITY_UNSPECIFIED |
互換性が指定されていません。 |
COMPATIBLE |
ディメンションまたは指標に互換性がある。このディメンションまたは指標はレポートに正常に追加できます。 |
INCOMPATIBLE |
このディメンションまたは指標に互換性がありません。このディメンションまたは指標はレポートに追加できません。 |
DimensionCompatibility
単一のディメンションの互換性。
JSON 表現 |
---|
{ "dimensionMetadata": { object ( |
フィールド | |
---|---|
dimensionMetadata |
ディメンション メタデータには、この互換性情報の API 名が含まれます。ディメンション メタデータには、UI の名前や説明など、その他の有用な情報も含まれます。 |
compatibility |
このディメンションの互換性。互換性が「互換」であれば、このディメンションは正常にレポートに追加できます。 |
MetricCompatibility
単一の指標の互換性。
JSON 表現 |
---|
{ "metricMetadata": { object ( |
フィールド | |
---|---|
metricMetadata |
指標メタデータには、この互換性情報の API 名が含まれます。指標メタデータには、UI の名前や説明などの他の有用な情報も含まれます。 |
compatibility |
この指標の互換性。互換性が「互換」であれば、この指標をレポートに正常に追加できます。 |