Guide de démarrage rapide pour les développeurs de l'API Google Analytics Data v1

Dans ce guide de démarrage rapide, vous allez créer et envoyer des requêtes list à la version 1 de l'API Google Analytics Data, puis afficher les réponses pour configurer et vérifier votre accès à l'API.

Vous pouvez suivre ce guide de démarrage rapide à l'aide d'un SDK, de l'API REST dans votre environnement local ou d'une instance de VM Google Cloud.

Voici un récapitulatif des étapes à suivre:

  • configurer un projet Google Cloud et activer l'API Google Analytics Data v1 ;
  • Sur votre ordinateur local ou votre instance de VM Cloud :
    • Installez, initialisez et authentifiez-vous auprès de Google Cloud.
    • Installez le SDK pour votre langue (facultatif).
  • Configurez l'authentification.
  • Configurez l'accès à Google Analytics.
  • Configurez un SDK.
  • Effectuez un appel d'API.

Configurer un projet Google Cloud

Cliquez sur le bouton Activer l'API Google Analytics Data v1 suivant pour sélectionner ou créer un projet Google Cloud et activer automatiquement l'API Google Analytics Data v1.

Activer l'API Google Analytics Data v1

Configurer Google Cloud

Sur votre ordinateur local ou une instance de VM Cloud, configurez et authentifiez-vous avec Google Cloud.

  1. Installez et initialisez Google Cloud.

  2. Pour vous assurer que vos composants gcloud sont à jour, exécutez la commande suivante.

    gcloud components update

Pour éviter de fournir votre ID de projet à Google Cloud, vous pouvez utiliser la commande gcloud config set pour définir un projet et une région par défaut.

Configurer l'authentification

Ce guide de démarrage rapide utilise les identifiants par défaut de l'application pour trouver automatiquement des identifiants en fonction de l'environnement de l'application. Vous n'avez donc pas besoin de modifier le code client pour vous authentifier.

La version 1 de l'API Google Analytics Data est compatible avec les comptes utilisateur et les comptes de service:

  • Les comptes utilisateur représentent un développeur, un administrateur ou toute autre personne qui interagit avec les API et les services Google.
  • Les comptes de service ne représentent pas un utilisateur humain spécifique. Ils permettent de gérer l'authentification et l'autorisation lorsqu'une personne n'est pas directement impliquée, par exemple lorsqu'une application doit accéder à des ressources Google Cloud.

Pour en savoir plus sur l'authentification et la configuration des identifiants de compte pour votre application, consultez la page Méthodes d'authentification chez Google.

Compte utilisateur

Générez un fichier ADC (Application Default Credentials) local en exécutant la commande suivante. Cette commande lance un flux Web dans lequel vous fournissez vos identifiants utilisateur.

  gcloud auth application-default login --scopes="https://www.googleapis.com/auth/cloud-platform,https://www.googleapis.com/auth/analytics.readonly"

N'oubliez pas de spécifier les portées requises par la version 1 de l'API Google Analytics Data dans la commande. Pour en savoir plus, consultez Configurer les identifiants par défaut de l'application.

Compte de service

Pour vous authentifier avec un compte de service à l'aide d'une instance de VM Cloud:

  1. Créez un compte de service.
  2. Associez le compte de service à votre instance de VM Cloud en exécutant la commande gcloud CLI suivante:
  gcloud compute instances stop YOUR-VM-INSTANCE-ID

  gcloud compute instances set-service-account YOUR-VM-INSTANCE-ID \
    --service-account YOUR-SERVICE-ACCOUNT-EMAIL-ALIAS  \
    --scopes="https://www.googleapis.com/auth/cloud-platform,https://www.googleapis.com/auth/analytics.readonly"

N'oubliez pas de spécifier les champs d'application requis par la version 1 de l'API Google Analytics Data dans la commande. Pour en savoir plus, consultez Configurer les identifiants par défaut de l'application.

Configurer l'accès à Google Analytics

Accordez à Google Analytics l'accès à l'adresse e-mail associée à votre compte utilisateur ou de service.

Configurer le SDK pour votre langage de programmation

Sur votre machine locale, installez le SDK pour votre langage de programmation.

Java

Guide d'installation de la bibliothèque cliente Java

PHP

Guide d'installation de la bibliothèque cliente PHP

Python

Guide d'installation de la bibliothèque cliente Python

Node.js

Guide d'installation de la bibliothèque cliente Node.js

.NET

Guide d'installation de la bibliothèque cliente.NET

Ruby

Guide d'installation de la bibliothèque cliente Ruby

Go

go get google.golang.org/genproto/googleapis/analytics/data/v1beta

REST

Configurez vos variables d'environnement en saisissant les informations suivantes. Remplacez PROJECT_ID par l'ID de votre projet Google Cloud et PROPERTY_ID par l'ID de votre propriété Google Analytics.

  export PROJECT_ID=PROJECT_ID
  export PROPERTY_ID=PROPERTY_ID

Effectuer un appel d'API

Exécutez le code suivant pour effectuer votre premier appel:

Java

import com.google.analytics.data.v1beta.BetaAnalyticsDataClient;
import com.google.analytics.data.v1beta.DateRange;
import com.google.analytics.data.v1beta.Dimension;
import com.google.analytics.data.v1beta.Metric;
import com.google.analytics.data.v1beta.Row;
import com.google.analytics.data.v1beta.RunReportRequest;
import com.google.analytics.data.v1beta.RunReportResponse;

/**
 * Google Analytics Data API sample quickstart application.
 *
 * <p>This application demonstrates the usage of the Analytics Data API using service account
 * credentials.
 *
 * <p>Before you start the application, please review the comments starting with "TODO(developer)"
 * and update the code to use correct values.
 *
 * <p>To run this sample using Maven:
 *
 * <pre>{@code
 * cd google-analytics-data
 * mvn compile exec:java -Dexec.mainClass="com.google.analytics.data.samples.QuickstartSample"
 * }</pre>
 */
public class QuickstartSample {

  public static void main(String... args) throws Exception {
    /**
     * TODO(developer): Replace this variable with your Google Analytics 4 property ID before
     * running the sample.
     */
    String propertyId = "YOUR-GA4-PROPERTY-ID";
    sampleRunReport(propertyId);
  }

  // This is an example snippet that calls the Google Analytics Data API and runs a simple report
  // on the provided GA4 property id.
  static void sampleRunReport(String propertyId) throws Exception {
    // Using a default constructor instructs the client to use the credentials
    // specified in GOOGLE_APPLICATION_CREDENTIALS environment variable.
    try (BetaAnalyticsDataClient analyticsData = BetaAnalyticsDataClient.create()) {

      RunReportRequest request =
          RunReportRequest.newBuilder()
              .setProperty("properties/" + propertyId)
              .addDimensions(Dimension.newBuilder().setName("city"))
              .addMetrics(Metric.newBuilder().setName("activeUsers"))
              .addDateRanges(DateRange.newBuilder().setStartDate("2020-03-31").setEndDate("today"))
              .build();

      // Make the request.
      RunReportResponse response = analyticsData.runReport(request);

      System.out.println("Report result:");
      // Iterate through every row of the API response.
      for (Row row : response.getRowsList()) {
        System.out.printf(
            "%s, %s%n", row.getDimensionValues(0).getValue(), row.getMetricValues(0).getValue());
      }
    }
  }
}

PHP

require 'vendor/autoload.php';

use Google\Analytics\Data\V1beta\Client\BetaAnalyticsDataClient;
use Google\Analytics\Data\V1beta\DateRange;
use Google\Analytics\Data\V1beta\Dimension;
use Google\Analytics\Data\V1beta\Metric;
use Google\Analytics\Data\V1beta\RunReportRequest;

/**
 * TODO(developer): Replace this variable with your Google Analytics 4
 *   property ID before running the sample.
 */
$property_id = 'YOUR-GA4-PROPERTY-ID';

// Using a default constructor instructs the client to use the credentials
// specified in GOOGLE_APPLICATION_CREDENTIALS environment variable.
$client = new BetaAnalyticsDataClient();

// Make an API call.
$request = (new RunReportRequest())
    ->setProperty('properties/' . $property_id)
    ->setDateRanges([
        new DateRange([
            'start_date' => '2020-03-31',
            'end_date' => 'today',
        ]),
    ])
    ->setDimensions([new Dimension([
            'name' => 'city',
        ]),
    ])
    ->setMetrics([new Metric([
            'name' => 'activeUsers',
        ])
    ]);
$response = $client->runReport($request);

// Print results of an API call.
print 'Report result: ' . PHP_EOL;

foreach ($response->getRows() as $row) {
    print $row->getDimensionValues()[0]->getValue()
        . ' ' . $row->getMetricValues()[0]->getValue() . PHP_EOL;
}

Python

from google.analytics.data_v1beta import BetaAnalyticsDataClient
from google.analytics.data_v1beta.types import (
    DateRange,
    Dimension,
    Metric,
    RunReportRequest,
)


def sample_run_report(property_id="YOUR-GA4-PROPERTY-ID"):
    """Runs a simple report on a Google Analytics 4 property."""
    # TODO(developer): Uncomment this variable and replace with your
    #  Google Analytics 4 property ID before running the sample.
    # property_id = "YOUR-GA4-PROPERTY-ID"

    # Using a default constructor instructs the client to use the credentials
    # specified in GOOGLE_APPLICATION_CREDENTIALS environment variable.
    client = BetaAnalyticsDataClient()

    request = RunReportRequest(
        property=f"properties/{property_id}",
        dimensions=[Dimension(name="city")],
        metrics=[Metric(name="activeUsers")],
        date_ranges=[DateRange(start_date="2020-03-31", end_date="today")],
    )
    response = client.run_report(request)

    print("Report result:")
    for row in response.rows:
        print(row.dimension_values[0].value, row.metric_values[0].value)

Node.js

  /**
   * TODO(developer): Uncomment this variable and replace with your
   *   Google Analytics 4 property ID before running the sample.
   */
  // propertyId = 'YOUR-GA4-PROPERTY-ID';

  // Imports the Google Analytics Data API client library.
  const {BetaAnalyticsDataClient} = require('@google-analytics/data');

  // Using a default constructor instructs the client to use the credentials
  // specified in GOOGLE_APPLICATION_CREDENTIALS environment variable.
  const analyticsDataClient = new BetaAnalyticsDataClient();

  // Runs a simple report.
  async function runReport() {
    const [response] = await analyticsDataClient.runReport({
      property: `properties/${propertyId}`,
      dateRanges: [
        {
          startDate: '2020-03-31',
          endDate: 'today',
        },
      ],
      dimensions: [
        {
          name: 'city',
        },
      ],
      metrics: [
        {
          name: 'activeUsers',
        },
      ],
    });

    console.log('Report result:');
    response.rows.forEach((row) => {
      console.log(row.dimensionValues[0], row.metricValues[0]);
    });
  }

  runReport();

.NET

using Google.Analytics.Data.V1Beta;
using System;

namespace AnalyticsSamples
{
    class QuickStart
    {
        static void SampleRunReport(string propertyId="YOUR-GA4-PROPERTY-ID")
        {
            /**
             * TODO(developer): Uncomment this variable and replace with your
             *  Google Analytics 4 property ID before running the sample.
             */
            // propertyId = "YOUR-GA4-PROPERTY-ID";

            // Using a default constructor instructs the client to use the credentials
            // specified in GOOGLE_APPLICATION_CREDENTIALS environment variable.
            BetaAnalyticsDataClient client = BetaAnalyticsDataClient.Create();

            // Initialize request argument(s)
            RunReportRequest request = new RunReportRequest
            {
                Property = "properties/" + propertyId,
                Dimensions = { new Dimension{ Name="city"}, },
                Metrics = { new Metric{ Name="activeUsers"}, },
                DateRanges = { new DateRange{ StartDate="2020-03-31", EndDate="today"}, },
            };

            // Make the request
            RunReportResponse response = client.RunReport(request);

            Console.WriteLine("Report result:");
            foreach(Row row in response.Rows)
            {
                Console.WriteLine("{0}, {1}", row.DimensionValues[0].Value, row.MetricValues[0].Value);
            }
        }
        static int Main(string[] args)
        {
            if (args.Length > 0) {
                SampleRunReport(args[0]);
            } else {
                SampleRunReport();
            }
            return 0;
        }
    }
}

REST

Pour envoyer cette requête, exécutez la commande curl à partir de la ligne de commande ou incluez l'appel REST dans votre application.

curl -X POST \
  -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": "2025-01-01",
        "endDate": "2025-02-01"
      }
    ],
    "dimensions": [
      {
        "name": "country"
      }
    ],
    "metrics": [
      {
        "name": "activeUsers"
      }
    ]
  }'  https://analyticsdata.googleapis.com/v1beta/properties/${PROPERTY_ID}:runReport

La réponse contient un rapport sur les utilisateurs actifs ventilés par pays, par exemple:

{
  "dimensionHeaders": [
    {
      "name": "country"
    }
  ],
  "metricHeaders": [
    {
      "name": "activeUsers",
      "type": "TYPE_INTEGER"
    }
  ],
  "rows": [
    {
      "dimensionValues": [
        {
          "value": "United States"
        }
      ],
      "metricValues": [
        {
          "value": "3242"
        }
      ]
    },
    {
      "dimensionValues": [
        {
          "value": "(not set)"
        }
      ],
      "metricValues": [
        {
          "value": "3015"
        }
      ]
    },
    {
      "dimensionValues": [
        {
          "value": "India"
        }
      ],
      "metricValues": [
        {
          "value": "805"
        }
      ]
    }
  ],
  "rowCount": 3,
  "metadata": {
    "currencyCode": "USD",
    "timeZone": "America/Los_Angeles"
  },
  "kind": "analyticsData#runReport"
}