Method: properties.checkCompatibility

Cette méthode de compatibilité liste les dimensions et les métriques pouvant être ajoutées à une requête de rapport et qui restent compatibles. 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 "Core" ont des règles de compatibilité différentes. Cette méthode vérifie la compatibilité des rapports Core.

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

Identifiant d'une propriété Google Analytics dont les événements sont suivis. Pour en savoir plus, consultez Où trouver votre ID de propriété. property doit être identique à la valeur de 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 identique à la valeur de votre requête runReport.
metrics[]

object (Metric)

Métriques de ce rapport metrics doit être identique à la valeur de votre requête runReport.
dimensionFilter

object (FilterExpression)

Clause de filtre des dimensions. dimensionFilter doit être identique à la valeur de votre requête runReport.
metricFilter

object (FilterExpression)

Clause de filtre des métriques. metricFilter doit être identique à la valeur de votre requête runReport.
compatibilityFilter

enum (Compatibility)

Filtre les dimensions et les métriques de la réponse uniquement en fonction de cette compatibilité. Utilisé couramment comme ”compatibilityFilter”: “COMPATIBLE” pour ne renvoyer que des dimensions et des métriques compatibles.

Corps de la réponse

Réponse de compatibilité avec la compatibilité de chaque dimension et 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. Vous pouvez ajouter cette dimension ou métrique à un rapport.
INCOMPATIBLE La dimension ou la métrique n'est pas compatible. Vous ne pouvez pas ajouter cette dimension ou cette 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 la dimension contiennent également d'autres informations utiles, comme le nom et la description de l'UI.
compatibility

enum (Compatibility)

Compatibilité de cette dimension. Si la compatibilité est COMPATIBLE, vous pouvez ajouter cette dimension 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 la métrique contiennent le nom de l'API pour ces informations de compatibilité. Les métadonnées de la métrique contiennent également d'autres informations utiles, comme le nom et la description de l'UI.
compatibility

enum (Compatibility)

Compatibilité de cette métrique. Si la compatibilité est COMPATIBLE, vous pouvez ajouter cette métrique au rapport.