Présentation de l'API Google Analytics Data

Vous pouvez utiliser l'API Data pour accéder de manière programmatique aux données des rapports Google Analytics.

En savoir plus sur les propriétés Google Analytics

Les données renvoyées par l'API sont cohérentes avec celles affichées dans l'interface utilisateur de Google Analytics et respectent entièrement les paramètres d'identité pour le reporting (par exemple, "Mixte", "Observée" ou "Basée sur l'appareil") configurés pour votre propriété Google Analytics.

Voici quelques exemples de rapports que vous pouvez générer à l'aide de la version 1 de l'API Google Analytics Data :

  • Combien d'utilisateurs actifs par jour ont ouvert votre application Android au cours des sept derniers jours ?
  • Nombre de pages vues des 10 pages les plus consultées de votre site au cours des 28 derniers jours.
  • Combien d'utilisateurs actifs par pays ont ouvert votre application iOS au cours des 30 dernières minutes.

Vous pouvez également utiliser la version 1 de l'API Google Analytics Data pour :

  • créer des tableaux de bord personnalisés pour afficher les données Google Analytics ;
  • gagner du temps en automatisant les tâches de reporting complexes ;
  • Intégrez vos données Google Analytics à d'autres applications métiers.

Cohérence des données et identité pour le reporting

L'API Google Analytics Data v1 accède aux mêmes données de rapport que l'interface Google Analytics. Les données renvoyées par l'API respectent entièrement les paramètres d'identité pour le reporting configurés pour votre propriété Google Analytics. Ainsi, le nombre d'utilisateurs, la déduplication et la modélisation des données s'alignent sur l'espace d'identité choisi (par exemple, "Mixte", "Observé" ou "Basé sur l'appareil") dans les paramètres de votre propriété.

Pour en savoir plus sur l'impact des différents espaces d'identité sur vos rapports, consultez Identité pour le reporting.

Commencer

Pour commencer à utiliser une bibliothèque cliente en Java, Python, Node.js, PHP, C#, Go ou Ruby, consultez le guide de démarrage rapide de la bibliothèque cliente. Pour savoir comment créer des requêtes, filtrer des dimensions et lire des réponses, consultez Créer un rapport ou testez des requêtes de manière interactive dans l'explorateur de requêtes.

Exemple de requête et de réponse runReport

Pour interroger les données d'événement via REST, envoyez une requête POST au point de terminaison runReport avec un corps JSON RunReportRequest spécifiant vos dateRanges, dimensions et metrics :

POST https://analyticsdata.googleapis.com/v1beta/properties/GA_PROPERTY_ID:runReport
{
  "dateRanges": [
    { "startDate": "7daysAgo", "endDate": "yesterday" }
  ],
  "dimensions": [
    { "name": "country" }
  ],
  "metrics": [
    { "name": "activeUsers" }
  ]
}

Vous pouvez également exécuter la commande curl équivalente à l'aide des identifiants par défaut de l'application :

curl -X POST \
  "https://analyticsdata.googleapis.com/v1beta/properties/GA_PROPERTY_ID:runReport" \
  -H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \
  -H "x-goog-user-project: PROJECT_ID" \
  -H "Content-Type: application/json" \
  -d '{
    "dateRanges": [
      { "startDate": "7daysAgo", "endDate": "yesterday" }
    ],
    "dimensions": [
      { "name": "country" }
    ],
    "metrics": [
      { "name": "activeUsers" }
    ]
  }'

L'API renvoie un RunReportResponse contenant des en-têtes de colonne et des lignes de données :

{
  "dimensionHeaders": [
    { "name": "country" }
  ],
  "metricHeaders": [
    { "name": "activeUsers", "type": "TYPE_INTEGER" }
  ],
  "rows": [
    {
      "dimensionValues": [{ "value": "United States" }],
      "metricValues": [{ "value": "4820" }]
    },
    {
      "dimensionValues": [{ "value": "Japan" }],
      "metricValues": [{ "value": "2541" }]
    }
  ],
  "rowCount": 2,
  "kind": "analyticsData#runReport"
}

Méthodes disponibles

Voici la liste des méthodes de l'API Data. Pour en savoir plus, consultez la documentation de référence.

  • runReport : cette méthode renvoie un rapport personnalisé de vos données d'événements Google Analytics. Il s'agit de la méthode privilégiée pour les requêtes de rapport simples.
  • batchRunReports : version par lot de la méthode runReport, qui vous permet de générer plusieurs rapports à l'aide d'un seul appel d'API.
  • runPivotReport Cette méthode renvoie un rapport de tableau croisé dynamique personnalisé de vos données d'événements Google Analytics. Les rapports de tableau croisé dynamique sont des formats plus avancés et plus expressifs que les rapports standards. Chaque tableau croisé dynamique décrit les colonnes et les lignes de dimension visibles dans la réponse du rapport.
  • batchRunPivotReports Il s'agit d'une version par lot de la méthode runPivotReport, qui vous permet de générer plusieurs rapports à l'aide d'un seul appel d'API.
  • getMetadata : cette méthode renvoie les métadonnées des dimensions et des métriques disponibles dans les méthodes de création de rapports. Utilisé pour explorer les dimensions et les métriques. La réponse de cette méthode inclut également les dimensions et métriques personnalisées disponibles pour la propriété Google Analytics spécifiée.
  • checkCompatibility Cette méthode liste les dimensions et les métriques qui peuvent être ajoutées à une demande de rapport tout en maintenant la compatibilité.
  • runRealtimeReport Cette méthode renvoie un rapport personnalisé sur les données d'événements en temps réel pour votre propriété. Les événements apparaissent dans les rapports "Temps réel" quelques secondes après avoir été envoyés à Google Analytics. Les rapports "Temps réel" affichent les événements et les données d'utilisation pour les périodes allant du moment présent à 30 minutes auparavant (jusqu'à 60 minutes pour les propriétés Google Analytics 360).
  • properties.audienceExports Groupe de méthodes permettant de générer des exportations d'audience, qui incluent un instantané des utilisateurs d'une audience.
  • properties.recurringAudienceLists (Preview anticipée) Groupe de méthodes permettant de gérer les exportations d'audience récurrentes. Une exportation d'audience récurrente génère de nouvelles listes d'audience chaque jour.
  • runFunnelReport (Preview anticipée) Cette méthode renvoie un rapport personnalisé sur l'entonnoir de vos données d'événements Google Analytics. L'exploration de l'entonnoir vous permet de visualiser les étapes suivies par vos utilisateurs afin d'exécuter une tâche. Ainsi, vous voyez rapidement s'ils réussissent ou s'ils échouent à chacune des étapes.
  • properties.chat (Preview anticipée) Cette méthode fournit un accès conversationnel programmatique à Ask Advisor dans Google Analytics. Vous pouvez poser des questions en langage naturel sur vos données d'événement, diagnostiquer les changements de performances et recevoir des insights structurés sous forme de texte et de tableau.

Dimensions et métriques acceptées

Pour obtenir la liste de toutes les dimensions et métriques compatibles avec l'API Data, consultez la documentation sur le schéma de l'API.