Caution: You are viewing documentation for the API's REST interface. Most of our official client libraries use gRPC. See the REST Introduction for details.

Autorisation et en-têtes HTTP

Vidéo: Authentification

Lorsque vous appelez l'API Google Ads, vous devez disposer des identifiants de l'application OAuth 2.0 et d'un jeton de développeur. Si vous effectuez des appels d'API en tant que compte administrateur Google Ads, vous devez également spécifier un en-tête login-customer-id pour chaque requête. Cette page explique comment définir ces valeurs et documenter plusieurs en-têtes HTTP spécifiques à l'API qui sont envoyés et reçus via l'interface REST.

Identifiants OAuth 2.0

L'API Google Ads utilise les identifiants d'application pour identifier et autoriser les requêtes API. Les clients OAuth 2.0 et les comptes de service peuvent être configurés. Pour en savoir plus sur la configuration de l'autorisation côté client, consultez la section OAuth2 dans l'API Google Ads.

Si vous débutez avec les API Google, vous pouvez utiliser oauth2l ou OAuth 2.0 Playground pour tester les identifiants d'application et l'API Google Ads avant d'écrire le code de votre application.

Utiliser des flux d'application Web ou de bureau

Suivez la procédure permettant de configurer un projet de console Google APIs pour l'API Google Ads. Enregistrez l'ID client et le code secret du client, puis revenez sur cette page.

Une fois que vous avez créé un client OAuth, suivez les instructions de flux d'application de bureau ou les instructions de flux d'application Web pour générer un jeton d'actualisation et un jeton d'accès.

Utiliser les comptes de service

Suivez les instructions courantes dans le guide Service Accounts pour configurer l'accès des comptes de service à l'API Google Ads.

Une fois que vous avez configuré un compte de service pour accéder à votre compte Google Ads, suivez le guide Utiliser OAuth 2.0 pour les applications de serveur à serveur en veillant à sélectionner l'onglet HTTP/REST. scope à utiliser pour l'accès à l'API Google Ads est https://www.googleapis.com/auth/adwords.

Générer de nouveaux jetons d'accès

Une fois que vous disposez d'un ID client, d'un code secret du client et d'un jeton d'actualisation, vous pouvez générer un nouveau jeton d'accès à utiliser lors des appels d'API avec l'outil de ligne de commande curl:

curl \
  --data "grant_type=refresh_token" \
  --data "client_id=CLIENT_ID" \
  --data "client_secret=CLIENT_SECRET" \
  --data "refresh_token=REFRESH_TOKEN" \
  https://www.googleapis.com/oauth2/v3/token

Ensuite, vous utilisez le jeton d'accès renvoyé par la requête curl dans l'en-tête HTTP Authorization de chaque appel d'API vers l'API Google Ads:

GET /v11/customers:listAccessibleCustomers HTTP/1.1
Host: googleads.googleapis.com
Authorization: Bearer ACCESS_TOKEN
developer-token: DEVELOPER_TOKEN

En-têtes de requête

Jeton de développeur

L'API Google Ads requiert également un jeton de développeur pour pouvoir appeler l'API. Vous pouvez demander un jeton pour votre compte administrateur directement à partir de l'interface utilisateur Google Ads. Pour en savoir plus sur la configuration d'un jeton de développeur, consultez la page Obtenir votre jeton de développeur.

Vous devez inclure la valeur de votre jeton de développeur dans l'en-tête HTTP developer-token de chaque appel d'API vers l'API Google Ads:

GET /v11/customers:listAccessibleCustomers HTTP/1.1
Host: googleads.googleapis.com
Authorization: Bearer ACCESS_TOKEN
developer-token: DEVELOPER_TOKEN

Numéro client de connexion

Pour les appels d'API Google Ads effectués par un administrateur sur un compte client (c'est-à-dire, lorsque vous vous connectez en tant qu'administrateur pour effectuer des appels d'API vers l'un de ses comptes client), vous devez également fournir l'en-tête HTTP login-customer-id. Cette valeur représente le numéro client Google Ads du responsable qui effectue l'appel d'API.

Cet en-tête équivaut à sélectionner un compte dans l'UI Google Ads après vous être connecté ou en cliquant sur votre image de profil en haut à droite de la page. Lorsque vous spécifiez le numéro client, veillez à supprimer tous les traits d'union (—). Par exemple: 1234567890, et non 123-456-7890.

GET /v11/customers:listAccessibleCustomers HTTP/1.1
Host: googleads.googleapis.com
Authorization: Bearer ACCESS_TOKEN
developer-token: DEVELOPER_TOKEN
login-customer-id: MANAGER_CUSTOMER_ID

Numéro client associé

Cet en-tête n'est utilisé que par les fournisseurs de solution d'analyse d'applications tiers qui importent des conversions dans un compte Google Ads associé. Pour en savoir plus, consultez le guide sur la structure des appels d'API.

...
Authorization: Bearer ACCESS_TOKEN
developer-token: DEVELOPER_TOKEN
login-customer-id: MANAGER_CUSTOMER_ID
linked-customer-id: LINKED_CUSTOMER_ID

En-têtes de réponse

Les en-têtes suivants sont renvoyés dans les réponses HTTP de l'API.

ID de requête

Le request-id est une chaîne qui identifie de manière unique la requête API. Lors du débogage ou du dépannage des problèmes liés à des appels d'API spécifiques, l'identifiant request-id est essentiel pour contacter l'assistance dédiée aux développeurs Google.

request-id: 2a5Cj89VV7CNhya1DZjjrC