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

Cette page explique comment utiliser l'API Google Analytics Data v1 à l'aide de la commande ligne.

Étape 1 : Activer l'API

Cliquez sur le bouton suivant pour créer automatiquement un projet Google Cloud activer la version 1 de l'API Google Analytics Data et créer les identifiants OAuth2 nécessaires tutoriel:

Activer l'API Google Analytics Data v1

Vous serez automatiquement redirigé vers la configuration des identifiants OAuth2. . Lorsque la boîte de dialogue affiche le message D'où appelez-vous ?, sélectionnez Ordinateur :

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 un protocole OAuth2 les identifiants d'un compte manuellement.

Étape 2 : Installer et initialiser le SDK Cloud

Vous avez besoin de l'outil de ligne de commande gcloud installé sur votre ordinateur de développement.

Étape 3: Effectuer un appel d'API

Vous pouvez désormais utiliser l'API Google Analytics Data pour interroger un compte Google Analytics .

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

Dans ce tutoriel, nous allons utiliser la variable d'environnement GA_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 GA_PROPERTY_ID:

export GA_PROPERTY_ID=[YOUR_GA_PROPERTY_ID]

Remplacez [YOUR_GA_PROPERTY_ID] par votre propriété Google Analytics. identifiant. Exemple :

export GA_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 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 dans cet exemple, exécutez la commande suivante et utilisez le chemin d'accès au fichier JSON des 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 corps du contenu du fichier request.json pour envoyer la requête au API Data de Google Analytics. Saisissez ce qui suit dans votre 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/$GA_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 Faites précéder le nom de fichier du symbole @. Ce fichier doit se trouver dans le même répertoire dans laquelle vous exécutez la commande curl.