Authentication

Ce document explique comment s'authentifier auprès de l'API Ad Manager. La façon dont vous vous authentifiez dépend de l'interface que vous utilisez et de l'environnement dans lequel votre code s'exécute. Toutefois, toutes les requêtes d'API doivent inclure un jeton d'accès avec un champ d'application de l'API Ad Manager.

Les bibliothèques clientes Ad Manager utilisent les identifiants par défaut de l'application pour générer des jetons d'accès avec des niveaux d'accès à l'API Ad Manager. Ce guide vous explique comment configurer les identifiants par défaut de l'application.

Si vous n'utilisez pas de bibliothèque cliente, vous devez quand même créer des identifiants et les utiliser pour autoriser vos requêtes.

Pour en savoir plus sur l'authentification et l'autorisation, consultez le guide Utiliser OAuth 2.0.

Déterminer votre type d'authentification

Type d'authentification Description
Compte de service Choisissez cette option si vous souhaitez vous authentifier en tant que compte dédié plutôt qu'en tant que personne spécifique.
En savoir plus
Application Web Choisissez cette option si vous souhaitez vous authentifier en tant qu'utilisateur qui accorde l'autorisation à votre application d'accéder à ses données Ad Manager.
En savoir plus
Développement local Choisissez cette option si vous souhaitez vous authentifier en tant que compte Google ou compte de service depuis votre environnement de développement local.

Activer l'API Ad Manager

  1. Activez l'API Ad Manager dans votre projet Google API Console Cloud.

  2. Si vous y êtes invité, sélectionnez un projet ou créez-en un.

Créer des identifiants

Cliquez sur l'onglet correspondant à votre type d'authentification, puis suivez les instructions pour créer vos identifiants :

Compte de service

Sur Google Cloud

Pour authentifier une charge de travail exécutée sur Google Cloud, vous devez utiliser les identifiants du compte de service associé à la ressource de calcul où votre code est exécuté.

Par exemple, vous pouvez associer un compte de service à une instance de machine virtuelle (VM) Compute Engine, à un service Cloud Run ou à un job Dataflow. Cette approche est la méthode d'authentification recommandée pour le code exécuté sur une ressource de calcul Google Cloud.

Pour en savoir plus sur les ressources auxquelles vous pouvez associer un compte de service et sur l'association de ce compte de service, consultez la documentation sur l'association d'un compte de service.

Sur site ou chez un autre fournisseur cloud

La méthode recommandée pour configurer l'authentification en dehors de Google Cloud consiste à utiliser la fédération d'identité de charge de travail. Il vous suffit de créer un fichier de configuration d'identifiants et de définir la variable d'environnement GOOGLE_APPLICATION_CREDENTIALS sur son emplacement. Cette approche est plus sécurisée que la création d'une clé de compte de service.

Si vous ne parvenez pas à configurer la fédération d'identité de charge de travail, vous devez créer un compte de service et une clé pour ce compte :

  1. Ouvrez la page Identifiants de la console Google API.

  2. Sur la page "Identifiants", sélectionnez Créer des identifiants, puis Compte de service.

  3. Cliquez sur l'adresse e-mail du compte de service pour lequel vous souhaitez créer une clé.

  4. Cliquez sur l'onglet Clés.

  5. Cliquez sur le menu déroulant Ajouter une clé, puis sélectionnez Créer une clé.

  6. Sélectionnez le type de clé JSON et cliquez sur Créer.

  7. Définissez la variable d'environnement GOOGLE_APPLICATION_CREDENTIALS sur le chemin du fichier JSON.

Linux ou macOS

export GOOGLE_APPLICATION_CREDENTIALS=KEY_FILE_PATH

Windows

set GOOGLE_APPLICATION_CREDENTIALS=KEY_FILE_PATH

Application Web

  1. Ouvrez la page Identifiants de la console Google API.

  2. Si vous y êtes invité, sélectionnez le projet dans lequel vous avez activé l'API Ad Manager.

  3. Sur la page "Identifiants", sélectionnez Créer des identifiants, puis ID client OAuth.

  4. Sélectionnez le type d'application Application Web.

  5. Remplissez le formulaire, puis cliquez sur Créer. Les applications qui utilisent des langages et des frameworks tels que PHP, Java, Python, Ruby et .NET doivent spécifier des URI de redirection autorisées. Les URI de redirection sont les points de terminaison vers lesquels le serveur OAuth 2.0 peut envoyer des réponses. Ces points de terminaison doivent respecter les règles de validation de Google.

  6. Après avoir créé vos identifiants, téléchargez le fichier client_secret.json. Stockez le fichier de manière sécurisée dans un emplacement auquel seule votre application peut accéder.

À partir de là, suivez les étapes pour obtenir des jetons d'accès OAuth 2.0.

Développement local

Configurez les identifiants par défaut de l'application (ADC) dans votre environnement local.

Installez Google Cloud CLI, puis initialisez-la en exécutant la commande suivante :

gcloud init

Créez des identifiants d'authentification locaux pour votre compte Google et définissez l'ID du projet sur un projet dans lequel l'API Ad Manager est activée :

gcloud auth application-default login --scopes="https://www.googleapis.com/auth/admanager"
gcloud auth application-default set-quota-project PROJECT_ID

Vous pouvez également vous authentifier en tant que compte de service en définissant la variable d'environnement GOOGLE_APPLICATION_CREDENTIALS sur le chemin d'accès à votre fichier de clé.

Linux ou macOS

export GOOGLE_APPLICATION_CREDENTIALS=KEY_FILE_PATH

Windows

set GOOGLE_APPLICATION_CREDENTIALS=KEY_FILE_PATH

Configurer votre réseau Ad Manager

Compte de service

  1. Accédez à votre réseau Ad Manager.
  2. Cliquez sur l'onglet Admin.
  3. Assurez-vous que l'accès aux API est activé.
  4. Cliquez sur le bouton Ajouter un utilisateur au compte de service.
  5. Remplissez le formulaire en utilisant l'adresse e-mail du compte de service. L'utilisateur du compte de service doit être ajouté aux rôles et équipes appropriés pour votre intégration d'API.
  6. Cliquez sur le bouton Enregistrer. Un message devrait s'afficher pour confirmer l'ajout de votre compte de service.
  7. Affichez les utilisateurs de compte de service existants en accédant à l'onglet "Utilisateurs", puis en cliquant sur le filtre Compte de service.

Application Web

  1. Accédez à votre réseau Ad Manager.
  2. Cliquez sur l'onglet Admin.
  3. Assurez-vous que l'accès aux API est activé.

Développement local

  1. Accédez à votre réseau Ad Manager.
  2. Cliquez sur l'onglet Admin.
  3. Assurez-vous que l'accès aux API est activé.

Sans bibliothèque cliente

Si vous n'utilisez pas de bibliothèque cliente, nous vous recommandons vivement d'utiliser une bibliothèque OAuth2 pour l'authentification.

Pour obtenir des instructions détaillées sur l'obtention de jetons d'accès, consultez Utiliser OAuth2 avec les API Google.

Jetons d'accès

Incluez votre jeton d'accès dans une requête à l'API en incluant un paramètre de requête access_token ou une valeur d'en-tête HTTP Authorization Bearer. Dans la mesure du possible, privilégiez l'en-tête HTTP, car les chaînes de requête ont tendance à être visibles dans les journaux du serveur.

Exemple :

GET /v1/networks/1234
Host: admanager.googleapis.com
Authorization: Bearer ya29.a0Ad52N3_shYLX

GET https://admanager.googleapis.com/v1/networks/1234?access_token=1/fFAGRNJru1FTz70BzhT3Zg

Champ d'application

Chaque jeton d'accès est associé à un ou plusieurs niveaux d'accès. Un champ d'application contrôle l'ensemble des ressources et des opérations qu'un jeton d'accès autorise. L'API Ad Manager comporte deux niveaux d'accès. Nous vous recommandons d'utiliser le champ d'application admanager.readonly plus étroit si votre application n'a pas besoin d'écrire des données.

Champ d'application Autorisations
https://www.googleapis.com/auth/admanager Affichez et gérez vos campagnes dans Google Ad Manager.
https://www.googleapis.com/auth/admanager.readonly Consultez vos campagnes et données dans Google Ad Manager.