Présentation de l'API Google Analytics Data

Vous pouvez utiliser l'API Data pour accéder de manière programmatique aux données de rapport 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 Google Analytics et respectent pleinement les paramètres d'identité de reporting ( par exemple, combinée, 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 l'API Google Analytics Data v1 :

  • Combien d'utilisateurs actifs par jour ont ouvert votre application Android au cours des sept derniers jours ?
  • Combien de pages vues les 10 principales pages de votre site ont-elles enregistrées 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 l'API Google Analytics Data v1 pour effectuer les opérations suivantes :

  • 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égrer vos données Google Analytics à d'autres applications métiers

Cohérence des données et identité de 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 pleinement les paramètres d'identité de reporting configurés pour votre propriété Google Analytics. Ainsi, le nombre d'utilisateurs, la déduplication et la modélisation des données sont alignés sur l'espace d'identité choisi (par exemple, combiné, 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é de reporting.

Commencer

Pour commencer à utiliser une bibliothèque cliente en C#, Go, Java, Node.js, PHP, Python 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 tester des requêtes de manière interactive dans l' explorateur de requêtes.

Exemple de requête et de réponse runReport

Pour interroger des données d'événement via REST, envoyez une POST requête au runReport point de terminaison avec un RunReportRequest corps JSON 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 une 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é sur vos données d'événements Google Analytics. Il s'agit de la méthode recommandée pour les requêtes de rapport simples.
  • batchRunReports : il s'agit d'une 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 This method returns a customized pivot report of your Google Analytics event data. : cette méthode renvoie un rapport croisé personnalisé sur vos données d'événements Google Analytics. Les rapports croisés sont des formats plus avancés et 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 des métadonnées pour les dimensions et les métriques disponibles dans les méthodes de reporting. Elle permet d'explorer les dimensions et les métriques. La réponse de cette méthode inclut également les dimensions et les 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 requête de rapport tout en conservant 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 Il s'agit d'un groupe de méthodes qui vous permettent de générer des exportations d'audience, qui incluent un instantané des utilisateurs d'une audience.
  • properties.recurringAudienceLists (preview anticipée) : il s'agit d'un groupe de méthodes qui vous permettent 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énements, diagnostiquer les changements de performances et recevoir des insights narratifs et tabulaires structurés.

Dimensions et métriques acceptées

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