Dans ce guide de démarrage rapide, vous allez créer et envoyer des requêtes list à l'API Google Analytics Admin, 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 Admin ;
- 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 Admin suivant pour sélectionner ou créer un projet Google Cloud et activer automatiquement l'API Google Analytics Admin.
Configurer Google Cloud
Sur votre ordinateur local ou une instance de VM Cloud, configurez et authentifiez-vous avec Google Cloud.
-
Installez et initialisez Google Cloud.
-
Pour vous assurer que vos composants
gcloudsont à 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.
L'API Google Analytics Admin 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.
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 d'indiquer les champs d'application requis par l'API Google Analytics Admin dans la commande. Pour en savoir plus, consultez Configurer les identifiants par défaut de l'application.
Pour vous authentifier avec un compte de service, procédez comme suit:
- Créez un compte de service.
- 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 l'API Google Analytics Admin 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.
go get google.golang.org/genproto/googleapis/analytics/admin/v1beta
Configurez vos variables d'environnement en saisissant les informations suivantes.
Remplacez PROJECT_ID par l'ID de votre projet Google Cloud.
EXPORT PROJECT_ID=PROJECT_ID
Effectuer un appel d'API
Exécutez le code suivant pour effectuer votre premier appel:
import com.google.analytics.admin.v1beta.Account; import com.google.analytics.admin.v1beta.AnalyticsAdminServiceClient; import com.google.analytics.admin.v1beta.AnalyticsAdminServiceClient.ListAccountsPage; import com.google.analytics.admin.v1beta.AnalyticsAdminServiceClient.ListAccountsPagedResponse; import com.google.analytics.admin.v1beta.ListAccountsRequest; /** * This application demonstrates the usage of the Analytics Admin API using service account * credentials. For more information on service accounts, see * https://cloud.google.com/iam/docs/understanding-service-accounts. * * <p>The following document provides instructions on setting service account credentials for your * application: https://cloud.google.com/docs/authentication/production * * <p>In a nutshell, you need to: * * <ol> * <li>Create a service account and download the key JSON file as described at * https://cloud.google.com/docs/authentication/production#creating_a_service_account. * <li>Provide service account credentials using one of the following options: * <ul> * <li>Set the {@code GOOGLE_APPLICATION_CREDENTIALS} environment variable. The API client * will use the value of this variable to find the service account key JSON file. See * https://cloud.google.com/docs/authentication/production#setting_the_environment_variable * for more information. * <p>OR * <li>Manually pass the path to the service account key JSON file to the API client by * specifying the {@code keyFilename} parameter in the constructor. See * https://cloud.google.com/docs/authentication/production#passing_the_path_to_the_service_account_key_in_code * for more information. * </ul> * </ol> * * <p>To run this sample using Maven: * * <pre>{@code * cd google-analytics-data * mvn compile exec:java -Dexec.mainClass="com.google.analytics.admin.samples.QuickstartSample" * }</pre> */ public class QuickstartSample { public static void main(String... args) throws Exception { listAccounts(); } // This is an example snippet that calls the Google Analytics Admin API and lists all Google // Analytics accounts available to the authenticated user. static void listAccounts() throws Exception { // Instantiates a client using default credentials. // See https://cloud.google.com/docs/authentication/production for more information // about managing credentials. try (AnalyticsAdminServiceClient analyticsAdmin = AnalyticsAdminServiceClient.create()) { // Calls listAccounts() method of the Google Analytics Admin API and prints // the response for each account. ListAccountsPagedResponse response = analyticsAdmin.listAccounts(ListAccountsRequest.newBuilder().build()); for (ListAccountsPage page : response.iteratePages()) { for (Account account : page.iterateAll()) { System.out.printf("Account name: %s%n", account.getName()); System.out.printf("Display name: %s%n", account.getDisplayName()); System.out.printf("Country code: %s%n", account.getRegionCode()); System.out.printf("Create time: %s%n", account.getCreateTime().getSeconds()); System.out.printf("Update time: %s%n", account.getUpdateTime().getSeconds()); System.out.println(); } } } } }
require 'vendor/autoload.php'; use Google\Analytics\Admin\V1beta\Account; use Google\Analytics\Admin\V1beta\Client\AnalyticsAdminServiceClient; use Google\Analytics\Admin\V1beta\ListAccountsRequest; /** * 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. // See https://cloud.google.com/docs/authentication/production for more information // about managing credentials. $client = new AnalyticsAdminServiceClient(); // Calls listAccounts() method of the Google Analytics Admin API and prints // the response for each account. $request = new ListAccountsRequest(); $response = $client->listAccounts($request); print 'Result:' . PHP_EOL; foreach ($response->iterateAllElements() as $account) { print 'Account name: ' . $account->getName() . PHP_EOL; print 'Display name: ' . $account->getDisplayName() . PHP_EOL; print 'Country code: ' . $account->getRegionCode() . PHP_EOL; print 'Create time: ' . $account->getCreateTime()->getSeconds() . PHP_EOL; print 'Update time: ' . $account->getUpdateTime()->getSeconds() . PHP_EOL; }
def list_accounts(transport: str = None): """ Lists the available Google Analytics accounts. Args: transport(str): The transport to use. For example, "grpc" or "rest". If set to None, a transport is chosen automatically. """ from google.analytics.admin import AnalyticsAdminServiceClient # Using a default constructor instructs the client to use the credentials # specified in GOOGLE_APPLICATION_CREDENTIALS environment variable. client = AnalyticsAdminServiceClient(transport=transport) results = client.list_accounts() # Displays the configuration information for all Google Analytics accounts # available to the authenticated user. print("Result:") for account in results: print(account)
// Imports the Google Analytics Admin API client library. const analyticsAdmin = require('@google-analytics/admin'); // Using a default constructor instructs the client to use the credentials // specified in GOOGLE_APPLICATION_CREDENTIALS environment variable. const analyticsAdminClient = new analyticsAdmin.AnalyticsAdminServiceClient(); // Lists all Google Analytics accounts available to the authenticated user. async function listAccounts() { // Uses listAccounts() with no arguments to fetch all pages. For more // information on pagination in the Node.js library, see: // https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#auto-pagination const [response] = await analyticsAdminClient.listAccounts(); console.log('Accounts:'); for (const account of response) { console.log('Account name:', account.name); console.log('Display name:', account.displayName); console.log('Region code:', account.regionCode); console.log('Create time:', account.createTime.seconds); console.log('Update time:', account.updateTime.seconds); } } listAccounts();
using Google.Analytics.Admin.V1Beta; using Google.Api.Gax; using System; namespace AnalyticsSamples { class QuickStart { static void Main(string[] args) { AnalyticsAdminServiceClient client = AnalyticsAdminServiceClient.Create(); PagedEnumerable<ListAccountsResponse, Account> response = client.ListAccounts( new ListAccountsRequest() ); foreach( Account account in response ) { Console.WriteLine("Account name: {0}", account.Name); Console.WriteLine("Display name: {0}", account.DisplayName); Console.WriteLine("Region code: {0}", account.RegionCode); Console.WriteLine("Update time: {0}", account.UpdateTime); Console.WriteLine("Create time: {0}", account.CreateTime); Console.WriteLine(); } } } }
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 -H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \ -H "x-goog-user-project: ${PROJECT_ID}" \ -H "Content-Type: application/json" \ https://analyticsadmin.googleapis.com/v1beta/accounts
L'exemple de réponse du code liste les comptes Google Analytics auxquels votre utilisateur ou votre compte de service a accès:
{
"accounts": [
{
"name": "accounts/123456789",
"createTime": "2025-01-01T00:12:23.456Z",
"createTime": "2025-01-01T00:12:23.456Z",
"displayName": "Demo Account",
"regionCode": "US",
"gmpOrganization": "marketingplatformadmin.googleapis.com/organizations/abcdef12345678"
}
}