Autorisation et en-têtes HTTP

Vidéo: Authentification

Vous avez besoin d'identifiants d'application OAuth 2.0 et d'un compte de développeur lors de l'appel de l'API Google Ads. Si vous effectuez des appels d'API avec un compte administrateur Google Ads, vous devez également spécifier un login-customer-id avec chaque requête. Cette page explique comment définir ces valeurs et documente plusieurs en-têtes HTTP supplémentaires spécifiques aux API qui sont envoyés et reçues lors de l'utilisation de l'interface REST.

Identifiants OAuth 2.0

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

Si vous ne connaissez pas bien les API Google, vous pouvez utiliser oauth2l ou OAuth 2.0, Playground pour faire des expérimentations des identifiants d'application et de l'API Google Ads avant d'écrire le code de la l'application.

Utiliser des flux d'applications de bureau ou Web

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

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

Utiliser les comptes de service

Suivez les instructions courantes de la page Comptes pour configurer l'accès au compte de service pour l'API Google Ads.

Une fois que vous avez configuré un compte de service pour accéder à votre compte Google Ads, suivez les instructions Utiliser OAuth 2.0 pour une connexion de serveur à serveur Applications en veillant à sélectionner l'onglet HTTP/REST. scope à utiliser pour l'API Google Ads l'accès 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 dans les appels d'API avec 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

Vous utilisez ensuite le jeton d'accès renvoyé par la requête curl dans la section En-tête HTTP Authorization de chaque appel d'API à l'API Google Ads:

GET /v17/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 nécessite également un jeton de développeur pour appeler des l'API. Vous pouvez demander un jeton pour votre compte administrateur directement à partir de la UI Google Ads. Pour savoir comment configurer un jeton de développeur, consultez Obtenir votre jeton de développeur

Vous devez inclure la valeur de votre jeton de développeur dans le protocole HTTP developer-token de chaque appel d'API à l'API Google Ads:

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

Numéro client associé à la connexion

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

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

GET /v17/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é par les fournisseurs de solutions d'analyse d'applications tiers que lorsque importer des conversions dans un compte Google Ads associé compte. Consultez le Guide sur la structure des appels d'API pour en savoir plus.

...
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.

Numéro de demande

request-id est une chaîne qui identifie la requête API de manière unique. Quand ? déboguer ou résoudre des problèmes liés à des appels d'API spécifiques, le request-id est un identifiant important à avoir à portée de main lorsque vous contactez un développeur Google de l'assistance.

request-id: 2a5Cj89VV7CNhya1DZjjrC