Les appels à l'API Search Ads 360 Reporting s'effectuent généralement via votre bibliothèque cliente. Pour en savoir plus, consultez la section Présentation des bibliothèques clientes. Cependant, il peut être utile de connaître la structure des détails de requête sous-jacents lors des tests et du débogage.
L'API Search Ads 360 Reporting est une API gRPC avec des liaisons REST. Cela signifie que vous pouvez appeler l'API de deux manières alternatives:
- Méthode préférée
- Utilisez une bibliothèque cliente :
- Créez le corps de la requête en tant que tampon de protocole.
- Envoyez la requête au serveur à l'aide de HTTP/2.
- Désérialiser la réponse à un tampon de protocole
- Interprétez les résultats.
- Autre méthode facultative
- Utilisez REST :
- Créez le corps de la requête en tant qu'objet JSON.
- Envoyez la requête au serveur à l'aide du protocole HTTP 1.1.
- Désérialisez la réponse en tant qu'objet JSON.
- Interprétez les résultats.
Pour en savoir plus, consultez la page API Google Cloud.
Les sections suivantes s'appliquent aux protocoles gRPC et REST.
Noms de ressources
La plupart des objets de l'API sont identifiés par leurs chaînes de nom de ressource. Ces chaînes servent également d'URL lorsque vous utilisez l'interface REST.
Pour en savoir plus sur les ressources compatibles et leur représentation de chemin d'accès, consultez la section Référence > REST. Le même format est utilisé pour d'autres services.
ID composites
Si l'ID d'un objet n'est pas unique, un ID composite pour cet objet est créé en ajoutant un préfixe à son ID parent et un tilde (~).
Par exemple, étant donné qu'un identifiant d'annonce de groupe d'annonces n'est pas unique, l'ID d'objet parent (groupe d'annonces) est ajouté au début, ce qui génère un ID composite unique.
Exemple: AdGroupId sur 123 + ~ + AdGroupAdId sur 45678 = ID d'annonce du groupe d'annonces composite 123~45678.
En-têtes de requête
Les en-têtes HTTP (ou les métadonnées gRPC) des sections suivantes doivent être inclus dans le corps de la requête.
Autorisation
Vous devez inclure un jeton d'accès OAuth2 dans le formulaire:
Authorization: Bearer [OAUTH_2.0_ACCESS_TOKEN]
Le jeton doit identifier soit un compte administrateur agissant pour le compte d'un client, soit un annonceur gérant directement son propre compte administrateur secondaire ou client. Pour en savoir plus, consultez À propos des comptes administrateur Search Ads 360 et Authentification.
En-tête du numéro client de connexion
L'en-tête login-customer-id est requis lorsque vous utilisez un compte administrateur pour accéder à un compte administrateur secondaire ou client. Il n'est pas nécessaire pour accéder directement à un compte administrateur secondaire ou client. Bien que cela ne soit pas strictement nécessaire, nous vous recommandons de toujours spécifier login-customer-id pour les utilisateurs authentifiés qui ont accès à plusieurs comptes. Cela évite toute ambiguïté et évite de définir involontairement le contexte sur le mauvais compte.
La requête doit inclure l'ID client de l'utilisateur autorisé, sans trait d'union (-), par exemple:
https://searchads360.googleapis.com/VERSION_NUMBER/customers/CUSTOMER_ID/campaignBudgets
Définir la valeur login-customer-id revient à choisir un compte dans l'interface utilisateur de Search Ads 360 après vous être connecté ou avoir cliqué sur votre image de profil en haut à droite.
En-têtes de réponse
Les en-têtes suivants (ou gRPC fins-metadata) sont renvoyés avec le corps de la réponse. Nous vous recommandons de consigner ces valeurs à des fins de débogage.
Numéro de demande
L'en-tête request-id est une chaîne qui identifie la requête de manière unique.