Method: properties.checkCompatibility

Cette méthode de compatibilité répertorie les dimensions et les métriques qui peuvent être ajoutées à une demande de rapport tout en préservant la compatibilité. Cette méthode échoue si les dimensions et les métriques de la requête sont incompatibles.

Dans Google Analytics, les rapports échouent s'ils demandent des dimensions et/ou des métriques incompatibles. Dans ce cas, vous devez supprimer les dimensions et/ou les métriques du rapport incompatible jusqu'à ce qu'il soit compatible.

Les rapports "Temps réel" et "Principal" présentent des règles de compatibilité différentes. Cette méthode vérifie la compatibilité des rapports principaux.

Requête HTTP

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

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
property

string

Un identifiant de propriété GA4 Google Analytics dont les événements sont suivis. Pour en savoir plus, consultez Où trouver votre ID de propriété. property doit être la même valeur que dans votre requête runReport.

Exemple: Properties/1234

Corps de la requête

Le corps de la requête contient des données présentant la structure suivante :

Représentation JSON 
{
  "dimensions": [
    {
      object (Dimension)
    }
  ],
  "metrics": [
    {
      object (Metric)
    }
  ],
  "dimensionFilter": {
    object (FilterExpression)
  },
  "metricFilter": {
    object (FilterExpression)
  },
  "compatibilityFilter": enum (Compatibility)
}
Champs
dimensions[]

object (Dimension)

Dimensions de ce rapport. dimensions doit être la même valeur que dans votre requête runReport.
metrics[]

object (Metric)

Métriques de ce rapport. metrics doit être la même valeur que dans votre requête runReport.
dimensionFilter

object (FilterExpression)

Clause de filtre des dimensions. dimensionFilter doit être la même valeur que dans votre requête runReport.
metricFilter

object (FilterExpression)

Clause de filtre des métriques. metricFilter doit être la même valeur que celle indiquée dans votre requête runReport
compatibilityFilter

enum (Compatibility)

Filtre les dimensions et les métriques dans la réponse uniquement à cette compatibilité. Utilisé en tant que ”compatibilityFilter”: “COMPATIBLE” pour ne renvoyer que les dimensions compatibles et métriques.

Corps de la réponse

Réponse de compatibilité avec la compatibilité de chaque dimension et la métrique.

Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :

Représentation JSON 
{
  "dimensionCompatibilities": [
    {
      object (DimensionCompatibility)
    }
  ],
  "metricCompatibilities": [
    {
      object (MetricCompatibility)
    }
  ]
}
Champs
dimensionCompatibilities[]

object (DimensionCompatibility)

Compatibilité de chaque dimension.
metricCompatibilities[]

object (MetricCompatibility)

Compatibilité de chaque métrique.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics

Compatibilité

Types de compatibilité d'une seule dimension ou métrique.

Enums
COMPATIBILITY_UNSPECIFIED Compatibilité non spécifiée.
COMPATIBLE La dimension ou la métrique est compatible. Cette dimension ou métrique peut être correctement ajoutée à un rapport.
INCOMPATIBLE La dimension ou la métrique est incompatible. Impossible d'ajouter cette dimension ou métrique à un rapport.

DimensionCompatibility

Compatibilité d'une seule dimension.

Représentation JSON 
{
  "dimensionMetadata": {
    object (DimensionMetadata)
  },
  "compatibility": enum (Compatibility)
}
Champs
dimensionMetadata

object (DimensionMetadata)

Les métadonnées de la dimension contiennent le nom de l'API pour ces informations de compatibilité. Les métadonnées de dimension contiennent également d'autres informations utiles, comme le nom et la description de l'interface utilisateur.
compatibility

enum (Compatibility)

Compatibilité de cette dimension. Si la compatibilité est COMPATIBLE, cette dimension peut être correctement ajoutée au rapport.

MetricCompatibility

Compatibilité d'une seule métrique.

Représentation JSON 
{
  "metricMetadata": {
    object (MetricMetadata)
  },
  "compatibility": enum (Compatibility)
}
Champs
metricMetadata

object (MetricMetadata)

Les métadonnées de métrique contiennent le nom de l'API pour ces informations de compatibilité. Les métadonnées de métrique contiennent également d'autres informations utiles, comme le nom et la description de l'interface utilisateur.
compatibility

enum (Compatibility)

Compatibilité de cette métrique. Si la compatibilité est COMPATIBLE, cette métrique peut être correctement ajoutée au rapport.