Authentication
Restez organisé à l'aide des collections
Enregistrez et classez les contenus selon vos préférences.
Ce document explique comment s'authentifier auprès de l'API Ad Manager. Comment vous
dépend de l'interface que vous utilisez et de l'environnement dans lequel
s'exécute, mais toutes les requêtes API doivent inclure un jeton d'accès avec le paramètre
Champ d'application de l'API Ad Manager.
Les bibliothèques clientes Ad Manager utilisent les identifiants par défaut de l'application.
afin de générer des jetons d'accès pour le champ d'application de 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 les
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 comme n'importe quel utilisateur
qui autorise votre application à accéder
leurs données Ad Manager.
En savoir plus |
Développement local
|
Choisissez cette option si vous souhaitez vous authentifier
un compte Google ou un compte de service
environnement de développement Google. |
Activer l'API Ad Manager
Activez l'API Ad Manager dans votre projet Cloud de la Google API Console.
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 et suivez les instructions pour
Créez 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
une instance de machine virtuelle (VM), un service Cloud Run ou une tâche 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 comment associer le compte de service à la ressource, consultez la
documentation sur l'association d'un compte de service.
Sur site ou chez un autre fournisseur cloud
La méthode privilégiée pour configurer l'authentification depuis l'extérieur de Google Cloud est
pour utiliser la fédération d'identité de charge de travail ; vous créez
fichier de configuration des identifiants et définissez le paramètre GOOGLE_APPLICATION_CREDENTIALS
variable d'environnement pour qu'elle pointe vers elle. 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éez un compte de service et créez une clé pour ce compte:
Ouvrez la page "Identifiants" de la console Google APIs.
Sur la page "Identifiants", sélectionnez Créer des identifiants, puis Compte de service.
Cliquez sur l'adresse e-mail du compte de service pour lequel vous souhaitez créer une clé.
Cliquez sur l'onglet Clés.
Cliquez sur le menu déroulant Ajouter une clé, puis sélectionnez Créer une clé.
Sélectionnez le type de clé JSON et cliquez sur Créer.
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
Ouvrez la page Identifiants de la console Google API.
Si vous y êtes invité, sélectionnez le projet dans lequel vous avez activé l'API Ad Manager.
Sur la page "Identifiants", sélectionnez Créer des identifiants, puis
sélectionnez ID client OAuth.
Sélectionnez le type d'application Application Web.
Remplissez le formulaire, puis cliquez sur Créer. Les applications qui utilisent des langages et
comme PHP, Java, Python, Ruby et .NET doivent spécifier des autorisations
URI de redirection. Les URI de redirection sont les points de terminaison vers lesquels
peut envoyer des réponses. Ces points de terminaison doivent respecter les règles de validation de Google.
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.
Suivez ensuite la procédure 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 de 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 aussi vous authentifier en tant que compte de service définissant l'environnement
la variable GOOGLE_APPLICATION_CREDENTIALS
au chemin du fichier de clé.
Linux ou macOS
export GOOGLE_APPLICATION_CREDENTIALS=KEY_FILE_PATH
Windows
set GOOGLE_APPLICATION_CREDENTIALS=KEY_FILE_PATH
Compte de service
- Accédez à votre réseau Ad Manager.
- Cliquez sur l'onglet Admin.
- Assurez-vous que l'accès à l'API est activé.
- Cliquez sur le bouton Ajouter un utilisateur au compte de service.
- Remplissez le formulaire avec l'adresse e-mail du compte de service. L'utilisateur du compte de service doit être ajouté aux rôles et aux équipes appropriés pour votre intégration d'API.
- Cliquez sur le bouton Enregistrer. Un message de confirmation doit s'afficher
l'ajout de votre compte de service.
- Affichez les utilisateurs existants du compte de service en accédant à l'onglet "Utilisateurs",
en cliquant sur le filtre Compte de service.
Application Web
- Accédez à votre réseau Ad Manager.
- Cliquez sur l'onglet Admin.
- Assurez-vous que l'accès à l'API est activé.
Développement local
- Accédez à votre réseau Ad Manager.
- Cliquez sur l'onglet Admin.
- Assurez-vous que l'accès aux API est activé.
Sans bibliothèque cliente
Même 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 adressée à l'API en incluant un
Paramètre de requête access_token
ou une valeur Bearer
d'en-tête HTTP Authorization
.
Lorsque c'est possible, l'en-tête HTTP est préférable, car les chaînes de requête ont tendance
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
Portée
Chaque jeton d'accès est associé à un ou plusieurs champs d'application. Un champ d'application contrôle
un ensemble de ressources et d'opérations
autorisé par un jeton d'accès. L'API Ad Manager n'a qu'une seule portée. L'autorisation doit être effectuée au niveau
au niveau du produit.
Portée |
Autorisations |
https://www.googleapis.com/auth/admanager
|
Afficher et gérer vos campagnes
sur Google Ad Manager. |
Sauf indication contraire, le contenu de cette page est régi par une licence Creative Commons Attribution 4.0, et les échantillons de code sont régis par une licence Apache 2.0. Pour en savoir plus, consultez les Règles du site Google Developers. Java est une marque déposée d'Oracle et/ou de ses sociétés affiliées.
Dernière mise à jour le 2025/08/31 (UTC).
[null,null,["Dernière mise à jour le 2025/08/31 (UTC)."],[[["\u003cp\u003eGoogle Ad Manager API authentication depends on the interface and environment but always requires an access token.\u003c/p\u003e\n"],["\u003cp\u003eChoose between service account, web application, or local development authentication based on your needs.\u003c/p\u003e\n"],["\u003cp\u003eEnable the Ad Manager API in your Google API Console and create the necessary credentials for your chosen authentication type.\u003c/p\u003e\n"],["\u003cp\u003eConfigure your Ad Manager network settings and add the service account user or enable API access depending on authentication type.\u003c/p\u003e\n"],["\u003cp\u003eInclude your access token in API requests using either a query parameter or an HTTP header.\u003c/p\u003e\n"]]],["To access the Ad Manager API, you need an access token, generated using Application Default Credentials (ADC) or custom credentials. First, enable the Ad Manager API in your Google Cloud project. Then, choose an authentication type: Service Account, Web application, or Local development. Create credentials via the Google API Console, selecting the appropriate method. If not using a client library, use an OAuth2 library. Finally, include the access token in API requests, preferably in the `Authorization` HTTP header. Each access token should be associated with the `https://www.googleapis.com/auth/admanager` scope.\n"],null,["# Authentication\n\nThis document describes how to authenticate to the Ad Manager API. How you\nauthenticate depends on the interface you use and the environment where your\ncode is running, but all API requests must include an access token with the\nAd Manager API [scope](#scope).\n\nThe Ad Manager client libraries use [Application Default Credentials](//cloud.google.com/docs/authentication/application-default-credentials)\nto generate access tokens with the Ad Manager API scope. This guide shows\nhow to configure Application Default Credentials.\n\nIf you aren't using a client library, you still need to create credentials\nand use them to authorize your requests.\n\nFor more information about authentication and authorization, see the\n[Using OAuth 2.0](/identity/protocols/oauth2) guide.\n\nDetermine your authentication type\n----------------------------------\n\n| Authentication type | Description |\n|---------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| Service Account | Choose this if you want to authenticate as dedicated account rather than a particular person. [Learn more](//cloud.google.com/iam/docs/service-account-overview). |\n| Web application | Choose this if you want to authenticate as any user who grants permission to your application to access their Ad Manager data. [Learn more](/identity/oauth2/web/guides/overview) |\n| Local development | Choose this if you want to authenticate as your own Google Account or a Service Account from your local development environment. |\n\nEnable the Ad Manager API\n-------------------------\n\n1. Enable the [Ad Manager API](https://console.cloud.google.com/apis/library/admanager.googleapis.com) in your\n Google API Console Cloud Project.\n\n2. If prompted, select a project, or create a new one.\n\nCreate credentials\n------------------\n\nClick the tab for your authentication type and follow the instructions to\ncreate your credentials: \n\n### Service Account\n\n### On Google Cloud\n\nTo authenticate a workload running on Google Cloud, you use the credentials of\nthe service account attached to the compute resource where your code is\nrunning.\n\nFor example, you can attach a service account to a Compute Engine virtual\nmachine (VM) instance, a Cloud Run service, or a Dataflow job. This approach\nis the preferred authentication method for code running on a Google Cloud\ncompute resource.\n\nFor information about which resources you can attach a service account to,\nand help with attaching the service account to the resource, see the\n[documentation on attaching a service account](//cloud.google.com/iam/docs/attach-service-accounts).\n\n### On-premises or on a different cloud provider\n\nThe preferred method to set up authentication from outside of Google Cloud is\nto use [workload identity federation](//cloud.google.com/iam/docs/workload-identity-federation); you create a\ncredential configuration file and set the `GOOGLE_APPLICATION_CREDENTIALS`\nenvironment variable to point to it. This approach is more secure than\ncreating a service account key.\n\nIf you are not able to configure workload identity federation, then you must\ncreate a service account and create a key for the service account:\n\n1. Open the [Google API Console Credentials page](https://console.cloud.google.com/apis/credentials).\n\n2. On the Credentials page, select **Create credentials** , then\n select **Service Account**.\n\n3. Click the email address of the service account that you want to create\n a key for.\n\n4. Click the **Keys** tab.\n\n5. Click the **Add key** drop-down menu, then select **Create new key**.\n\n6. Select **JSON** as the **Key type** and click **Create**.\n\n7. Set the environment variable `GOOGLE_APPLICATION_CREDENTIALS` to the path\n of the JSON file.\n\n#### Linux or macOS\n\n export GOOGLE_APPLICATION_CREDENTIALS=\u003cvar label=\"key file\" translate=\"no\"\u003eKEY_FILE_PATH\u003c/var\u003e\n\n#### Windows\n\n set GOOGLE_APPLICATION_CREDENTIALS=\u003cvar label=\"key file\" translate=\"no\"\u003eKEY_FILE_PATH\u003c/var\u003e\n\n### Web application\n\n1. Open the [Google API Console Credentials page](https://console.cloud.google.com/apis/credentials).\n\n2. If prompted, select the project where you enabled the Ad Manager API.\n\n3. On the Credentials page, select **Create credentials** , then\n select **OAuth client ID**.\n\n4. Select the **Web application** application type.\n\n5. Fill in the form and click **Create** . Applications that use languages and\n frameworks like PHP, Java, Python, Ruby, and .NET must specify authorized\n **redirect URIs** . The redirect URIs are the endpoints to which the OAuth 2.0\n server can send responses. These endpoints must adhere to [Google's\n validation rules](/identity/protocols/oauth2/web-server#uri-validation).\n\n6. After creating your credentials, download the **client_secret.json** file. Securely store the file in a location that only your application can access.\n\nFrom here, follow the steps to [obtain OAuth 2.0 access tokens](/identity/protocols/oauth2/web-server#obtainingaccesstokens)\n\n### Local development\n\nSet up Application Default Credentials (ADC) in your local environment.\n\nInstall the Google Cloud CLI, then initialize it by running the following\ncommand: \n\n gcloud init\n\nCreate local authentication credentials for your Google Account and set\nthe project ID to a project where the Ad Manager API is enabled: \n\n gcloud auth application-default login --scopes=\"https://www.googleapis.com/auth/admanager\"\n gcloud auth application-default set-quota-project \u003cvar label=\"project id\" translate=\"no\"\u003ePROJECT_ID\u003c/var\u003e\n\nAlternatively, authenticate as a Service Account setting the environment\nvariable `GOOGLE_APPLICATION_CREDENTIALS` to the path of your key file.\n\n#### Linux or macOS\n\n export GOOGLE_APPLICATION_CREDENTIALS=\u003cvar label=\"key file\" translate=\"no\"\u003eKEY_FILE_PATH\u003c/var\u003e\n\n#### Windows\n\n set GOOGLE_APPLICATION_CREDENTIALS=\u003cvar label=\"key file\" translate=\"no\"\u003eKEY_FILE_PATH\u003c/var\u003e\n\nConfigure your Ad Manager network\n---------------------------------\n\n**Tip:** If you are a third-party developer, ask your client to complete this step for you. Send them to [Add a service account user for API access](//support.google.com/admanager/answer/6078734) and provide the email address of your service account. \n\n### Service Account\n\n1. Go to your [Ad Manager network](//admanager.google.com).\n2. Click the **Admin** tab.\n3. Ensure that **API access** is enabled.\n4. Click the **Add a service account user** button.\n5. Fill in the form using the service account email. The service account user must be added to appropriate roles and teams for your API integration.\n6. Click the **Save** button. A message should appear, confirming the addition of your service account.\n7. View existing service account users by going to the Users tab and then clicking the **Service Account** filter.\n\n### Web application\n\n1. Go to your [Ad Manager network](//admanager.google.com).\n2. Click the **Admin** tab.\n3. Ensure that **API access** is enabled.\n\n### Local Development\n\n1. Go to your [Ad Manager network](//admanager.google.com).\n2. Click the **Admin** tab.\n3. Ensure that **API access** is enabled.\n\nWithout a client library\n------------------------\n\nIf you are not using a client library, we still strongly recommend using\nan OAuth2 library for authentication.\n\nFor detailed instructions on obtaining access tokens, see\n[Using OAuth2 with Google APIs](/identity/protocols/oauth2).\n\n### Access tokens\n\nInclude your access token in a request to the API by including either an\n`access_token` query parameter or an `Authorization` HTTP header `Bearer` value.\nWhen possible, the HTTP header is preferable, because query strings tend to be\nvisible in server logs.\n\nFor example: \n\n GET /v1/networks/1234\n Host: admanager.googleapis.com\n Authorization: Bearer ya29.a0Ad52N3_shYLX\n\n GET https://admanager.googleapis.com/v1/networks/1234?access_token=1/fFAGRNJru1FTz70BzhT3Zg\n\n### Scope\n\nEach access token is associated with one or more scopes. A scope controls the\nset of resources and operations that an access token permits. The Ad Manager\nAPI has only one scope. Authorization should be performed at the user\nlevel within the product.\n\n| Scope | Permissions |\n|---------------------------------------------|------------------------------------------------------|\n| `https://www.googleapis.com/auth/admanager` | View and manage your campaigns on Google Ad Manager. |"]]