Guide de démarrage rapide pour utiliser l'API via la ligne de commande

Cette page vous explique comment utiliser la ligne de commande pour utiliser la version 1 de l'API Data de Google Analytics.

Étape 1. Activer l'API

Cliquez sur ce bouton pour créer un projet Cloud Platform, activer automatiquement l'API Data de Google Analytics v1 et générer les identifiants OAuth2 nécessaires pour ce tutoriel:

Activer l'API Google Analytics Data v1

Vous serez automatiquement redirigé vers la boîte de dialogue de configuration des identifiants OAuth2. Sélectionnez "Ordinateur" à la question "De quel pays appelez-vous ?".

Dans la boîte de dialogue qui s'affiche, cliquez sur TÉLÉCHARGER LA CONFIGURATION DU CLIENT et enregistrez le fichier credentials.json dans votre répertoire de travail.

Vous pouvez également suivre ces étapes pour créer manuellement des identifiants OAuth2 dans un projet existant.

Étape 2. Installer et initialiser le SDK Cloud

L'outil de ligne de commande gcloud doit être installé sur votre ordinateur de développement.

Étape 3: Effectuez un appel d'API

Vous pouvez maintenant utiliser l'API Google Analytics Data pour interroger une propriété Google Analytics 4.

Sélectionner une entité à l'origine du signalement

Dans ce tutoriel, nous allons utiliser la variable d'environnement GA4_PROPERTY_ID pour stocker l'ID de la propriété à utiliser dans les requêtes API.

Saisissez la commande suivante dans votre ligne de commande pour définir la variable GA4_PROPERTY_ID:

export GA4_PROPERTY_ID=[YOUR-GA4-PROPERTY-ID]

Remplacez [YOUR-GA4-PROPERTY-ID] par l'identifiant de votre propriété Google Analytics 4. Exemple :

export GA4_PROPERTY_ID=1234567890

Créer la requête JSON

Le fichier request.json suivant montre comment créer un rapport simple.

Créez le fichier de requête JSON avec le texte suivant, puis enregistrez-le en tant que fichier texte brut request.json dans votre répertoire de travail:

request.json

{
  "dateRanges": [{ "startDate": "2020-09-01", "endDate": "2020-09-15" }],
  "dimensions": [{ "name": "country" }],
  "metrics": [{ "name": "activeUsers" }]
}

Authentifier

Pour obtenir les identifiants utilisateur de cet exemple, exécutez la commande suivante en indiquant le chemin d'accès au fichier JSON d'identifiants téléchargé à l'étape 1:

gcloud auth application-default login \
    --scopes=https://www.googleapis.com/auth/analytics.readonly \
    --client-id-file=[PATH/TO/credentials.json]

Une boîte de dialogue de recueil du consentement de l'utilisateur OAuth s'ouvre dans une nouvelle fenêtre du navigateur.

Envoyer la requête

Utilisez curl et le contenu du corps du fichier request.json pour envoyer la requête à l'API Data de Google Analytics. Saisissez la commande suivante dans la ligne de commande:

  curl -X POST \
  -H "Authorization: Bearer "$(gcloud auth application-default print-access-token) \
  -H "Content-Type: application/json; charset=utf-8" \
  https://analyticsdata.googleapis.com/v1beta/properties/$GA4_PROPERTY_ID:runReport -d @request.json

La commande curl utilise la commande gcloud auth application-default print-access-token pour obtenir un jeton d'authentification.

Notez que pour indiquer un nom de fichier dans curl, vous devez utiliser l'option -d (pour "data") et faire précéder le nom de fichier du signe @. Ce fichier doit se trouver dans le même répertoire dans lequel vous exécutez la commande curl.

Félicitations ! Vous avez envoyé votre première requête à l'API Google Analytics Data.