Autorisation et en-têtes HTTP

Vous avez besoin d'identifiants d'application OAuth 2.0 pour appeler l'API Search Ads 360 Reporting. Si vous effectuez des appels d'API en tant que compte administrateur Search Ads 360, vous devez également spécifier un en-tête login-customer-id avec chaque requête. Cette page explique comment définir ces valeurs et décrit plusieurs en-têtes HTTP spécifiques à l'API supplémentaires qui sont envoyés et reçus lorsque vous utilisez l'interface REST.

Identifiants OAuth 2.0

L'API Search Ads 360 Reporting utilise des identifiants d'application pour identifier et autoriser les requêtes d'API. Les clients OAuth 2.0 peuvent être configurés. Tous les appels à l'API Search Ads 360 Reporting doivent être autorisés via OAuth2. OAuth2 permet à votre application cliente de l'API Search Ads 360 Reporting d'accéder au compte Search Ads 360 d'un utilisateur sans avoir à gérer ni à stocker ses informations de connexion.

Si vous débutez avec les API Google, vous pouvez utiliser oauth2l ou le OAuth 2.0 Playground pour tester les identifiants d'application et l'API Search Ads 360 Reporting avant d'écrire le code de votre application. Vous pouvez également générer un jeton d'actualisation OAuth en exécutant le script de génération d'identifiants utilisateur fourni.

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

Une fois que vous disposez d'un ID client, d'un secret client et d'un jeton d'actualisation, vous pouvez générer un nouveau jeton d'accès à utiliser dans les appels d'API à l'aide de 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

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

GET /v0/customers:listAccessibleCustomers HTTP/1.1
Host: searchads360.googleapis.com
Authorization: Bearer ACCESS_TOKEN

En-têtes de requête

Numéro client utilisé pour la connexion

Pour les appels d'API Search Ads 360 Reporting effectués par un administrateur auprès d'un compte client (c'est-à-dire lorsque vous vous connectez en tant qu'administrateur pour effectuer des appels d'API auprès de l'un de ses comptes client), vous devez également fournir l'en-tête HTTP login-customer-id. Cette valeur représente l'ID client Search Ads 360 de l'administrateur effectuant l'appel d'API.

L'inclusion de cet en-tête équivaut à choisir un compte dans l'interface utilisateur de Search Ads 360 après vous être connecté ou avoir cliqué sur votre photo de profil en haut à droite de la page. Lorsque vous spécifiez l'ID client, veillez à supprimer les traits d'union (-), par exemple: 1234567890, et non 123-456-7890.

GET /v0/customers:listAccessibleCustomers HTTP/1.1
Host: searchads360.googleapis.com
Authorization: Bearer ACCESS_TOKEN
login-customer-id: MANAGER_CUSTOMER_ID

En-têtes de réponse

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

Identifiant de la demande

request-id est une chaîne qui identifie de manière unique la requête d'API. Lorsque vous déboguez ou corrigez des problèmes liés à des appels d'API spécifiques, l'request-id est un identifiant important à avoir à portée de main lorsque vous contactez l'assistance Google pour les développeurs.

request-id: 2a5Cj89VV7CNhya1DZjjrC