Premiers pas

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 répertoire Maven Central un dépôt de clés.

La dépendance Maven est la suivante:

<dependency>
  <groupId>com.google.api-ads</groupId>
  <artifactId>google-ads</artifactId>
  <version>33.0.0</version>
</dependency>

La dépendance Gradle est:

implementation 'com.google.api-ads:google-ads:33.0.0'

Vous pouvez également compiler à partir de la source. Dans le cadre de ce dans ce guide, nous partons du principe que vous disposez d'un projet configuré avec les dépendances 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 développeur API Google Ads à partir d'un jeton d'accès. Cette section explique ce que sont ces outils, comment ils sont utilisés et comment obtenues.

Jeton de développeur (pour accéder à l'API)

Le jeton de développeur est associé à un administrateur. et sont disponibles dans l'interface Web Google Ads.

Même si le jeton de développeur est associé à un compte administrateur, il ne fournit l'accès à 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 doit fournir un ensemble d'identifiants OAuth.

Deux flux OAuth sont généralement utilisés: l'application de bureau (installée) ou Web. La principale différence entre les deux est que les applications de bureau ouvrir le navigateur système et fournir un URI de redirection locale pour gérer les réponses par le serveur d'autorisation de Google, tandis que les applications Web peuvent rediriger à un navigateur tiers pour terminer l'autorisation et renvoyer les identifiants à votre serveur. La bibliothèque accepte aussi le compte de service, le moins utilisé, le flux de travail.

Si vous l'autorisez à l'aide de vos propres identifiants (flux des applications de bureau)
Consultez l'application de bureau OAuth le flux de travail. Cela inclut tous les détails que vous avec vos propres identifiants.
Si vous vous autorisez en tant qu'utilisateur Google tiers (flux Web)
Consultez le flux d'application Web OAuth. Ce donne un exemple de configuration d'autorisation OAuth pour des tiers arbitraires utilisateurs.
Si vous donnez l'autorisation en tant qu'utilisateur d'un domaine Google Apps (flux du compte de service)
Consultez la page Compte de service OAuth le flux de travail. Cela donne un exemple de la façon de configurer l'autorisation OAuth pour les utilisateurs de domaines Google Apps.

Si vous accédez au compte client Google Ads via un administrateur Google Ads compte, 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)

Si vous le souhaitez, indiquez le numéro client d'un compte administrateur qui donne accès à le compte de diffusion. Vous devez l'indiquer si votre accès au client via un compte administrateur. Il n'est pas nécessaire de spécifier tous les administrateurs sur le chemin vers le numéro client, seul l'identifiant de gestionnaire de niveau supérieur que vous que vous utilisez pour les autorisations d'accès. Pour en savoir plus, consultez les documentation.

Configurez la bibliothèque cliente avec vos identifiants.

Vous pouvez configurer la bibliothèque cliente avec un fichier de configuration, des variables d'environnement, ou par programmation. Pour ce guide, nous utiliserons fichier de configuration et concentrez-vous sur les flux Web et de bureau. Avec un fichier de configuration est généralement une bonne approche si vous n'avez qu'un seul jeu (par exemple, si vous gérez des comptes sous un seul compte administrateur).

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 Indiquez 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 la commande GetCampagnes exemple.

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 à votre Numéro client du 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 paramètres. Vous pouvez soit transmettre les paramètres en tant qu'arguments (recommandé), soit modifier les valeurs INSERT_XXXXX_HERE dans le code source. Afficher une déclaration d'utilisation Pour un 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 lister tous les exemples, exemples dans un sous-répertoire, ou des exemples où la description inclut une requête de mots clés.

# 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'