Nous vous recommandons d'utiliser la bibliothèque cliente avec Apache Maven (ou Gradle).
Créer un projet Maven/Gradle
Créez un projet Maven/Gradle dans l'IDE de votre choix. Nos artefacts sont publiés dans le dépôt central Maven.
La dépendance Maven est la suivante:
<dependency>
<groupId>com.google.api-ads</groupId>
<artifactId>google-ads</artifactId>
<version>31.0.0</version>
</dependency>
La dépendance Gradle est:
implementation 'com.google.api-ads:google-ads:31.0.0'
Vous pouvez également compiler à partir de la source. Pour les besoins de ce guide, nous partons du principe que vous disposez d'un projet configuré avec les dépendances requises disponibles.
Obtenir des identifiants pour s'authentifier auprès de l'API
L'accès à l'API Google Ads nécessite des identifiants OAuth et un jeton de développeur pour l'API Google Ads. Cette section explique ce que sont ces attributs, comment ils sont utilisés et comment ils peuvent être obtenus.
Jeton de développeur (pour accéder à l'API)
Le jeton de développeur est associé à un compte administrateur. Vous le trouverez dans l'interface Web de Google Ads.
Bien que le jeton de développeur soit associé à un compte administrateur, il ne permet pas d'accéder à ce compte. À la place, le jeton de développeur accorde l'accès à l'API en général, et l'accès au niveau du compte est configuré via OAuth.
Identifiants OAuth (pour l'accès aux comptes Google Ads)
Pour autoriser l'accès aux comptes Google Ads en tant qu'utilisateurs d'un compte Google, vous devez fournir un ensemble d'identifiants OAuth.
Deux flux OAuth sont généralement utilisés: une application de bureau (installée) ou une application Web. La principale différence entre les deux est que les applications de bureau doivent ouvrir le navigateur système et fournir un URI de redirection local pour gérer les réponses du serveur d'autorisation de Google, tandis que les applications Web peuvent rediriger un navigateur tiers arbitraire pour terminer l'autorisation et renvoyer les identifiants à votre serveur. La bibliothèque accepte également le flux de compte de service, le moins utilisé.
- Si vous l'autorisez à l'aide de vos propres identifiants (flux des applications de bureau)
- Consultez le parcours d'application de bureau OAuth. Cela inclut toutes les informations dont vous avez besoin pour autoriser l'accès avec vos propres identifiants.
- Si vous vous autorisez en tant qu'utilisateur Google tiers (flux Web)
- Consultez le flux d'application Web OAuth. Vous trouverez ici un exemple de configuration d'une autorisation OAuth pour des utilisateurs tiers arbitraires.
- Si vous donnez l'autorisation en tant qu'utilisateur d'un domaine Google Apps (flux du compte de service)
- Consultez le parcours de compte de service OAuth. Voici un exemple de configuration d'autorisation OAuth pour les utilisateurs de domaines Google Apps.
Si vous accédez au compte client Google Ads via un compte administrateur Google Ads, vous devez également spécifier un numéro client de connexion, comme décrit ci-dessous.
Numéro client de connexion (pour accéder aux comptes Google Ads via un compte administrateur)
Vous pouvez également spécifier le numéro client d'un compte administrateur qui donne accès au compte de diffusion. Vous devez spécifier cette valeur si votre accès au compte client s'effectue via un compte administrateur. Il n'est pas nécessaire de spécifier tous les comptes administrateur dans le chemin d'accès au numéro client, mais uniquement l'ID administrateur de niveau supérieur que vous utilisez pour les autorisations d'accès. Pour en savoir plus, consultez la documentation associée.
Configurez la bibliothèque cliente avec vos identifiants.
Vous pouvez configurer la bibliothèque cliente avec un fichier de configuration ou des variables d'environnement, ou de manière automatisée. Dans ce guide, nous utiliserons l'approche du fichier de configuration, et nous nous concentrerons sur les flux Web et pour ordinateur. L'utilisation d'un fichier de configuration est généralement une bonne approche si vous ne disposez que d'un seul ensemble d'identifiants (par exemple, si vous gérez des comptes sous un seul gestionnaire).
Créez un fichier ~/ads.properties avec le contenu suivant :
api.googleads.clientId=INSERT_CLIENT_ID_HERE
api.googleads.clientSecret=INSERT_CLIENT_SECRET_HERE
api.googleads.refreshToken=INSERT_REFRESH_TOKEN_HERE
api.googleads.developerToken=INSERT_DEVELOPER_TOKEN_HERE
Remplacez les espaces réservés par les identifiants obtenus à l'étape précédente.
De plus, si votre jeton d'actualisation est associé à un compte administrateur, vous devez spécifier le numéro client de ce compte en tant que client de connexion:
api.googleads.loginCustomerId=INSERT_LOGIN_CUSTOMER_ID_HERE
Valider les identifiants
Pour nous assurer que tout est correctement configuré, nous allons exécuter l'exemple GetCampagnes.
Tout d'abord, accédez au répertoire google-ads-examples.
$ cd google-ads-examples
Cet exemple nécessite un paramètre --customerId dont la valeur correspond au numéro client de votre compte Google Ads, sans tirets.
Pour l'exécuter avec Gradle:
$ ./gradlew -q runExample --example="basicoperations.GetCampaigns --customerId INSERT_CUSTOMER_ID_HERE"
Découvrir d'autres exemples
Le package examples dans google-ads-examples contient plusieurs exemples utiles. La plupart des exemples nécessitent des paramètres. Vous pouvez transmettre les paramètres en tant qu'arguments (recommandé) ou modifier les valeurs INSERT_XXXXX_HERE dans le code source. Pour afficher une instruction d'utilisation par exemple, transmettez --help comme seul argument.
Avec Gradle:
$ ./gradlew -q runExample --example="basicoperations.GetCampaigns --help"
Vous pouvez également utiliser la tâche listExamples dans Gradle pour répertorier tous les exemples, ceux d'un sous-répertoire ou ceux dont la description inclut un terme de recherche.
# List all examples:
$ ./gradlew -q listExamples
# List examples in the 'basicoperations' subdirectory:
$ ./gradlew -q listExamples --subdirectory='basicoperations'
# Search for examples where the description includes 'Performance Max':
$ ./gradlew -q listExamples --searchTerm='Performance Max'