Les appels à l'API Search Ads 360 Reporting sont généralement effectués via votre bibliothèque cliente. Pour en savoir plus, consultez la section Présentation des bibliothèques clientes. Toutefois, la connaissance de la structure des détails de la requête sous-jacente peut être utile lors des tests et du débogage.
L'API Search Ads 360 Reporting est une API gRPC avec des liaisons REST. Vous pouvez donc appeler l'API de deux manières différentes:
- Méthode privilégiée
- Utiliser 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érialisez la réponse dans un tampon de protocole.
- Interprétez les résultats.
- Autre méthode facultative
- Utiliser REST :
- Créez le corps de la requête en tant qu'objet JSON.
- Envoyez la requête au serveur à l'aide de HTTP 1.1.
- Désérialiser 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 noms de ressources. 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, consultez Référence > REST. Le même format est utilisé pour les autres services.
ID composites
Si l'ID d'un objet n'est pas unique au niveau mondial, un ID composite pour cet objet est créé en ajoutant à l'ID de son parent un tilde (~).
Par exemple, comme l'ID d'annonce d'un groupe d'annonces n'est pas unique au niveau mondial, l'ID de l'objet parent (groupe d'annonces) est ajouté au début, ce qui donne un ID composite unique.
Exemple: AdGroupId de 123 + ~ + AdGroupAdId de 45678
= ID d'annonce du groupe d'annonces composite de 123~45678.
En-têtes de requête
Les en-têtes HTTP (ou 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 un compte administrateur agissant au nom d'un client ou d'un annonceur qui gère 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 utilisé pour la connexion
L'en-tête login-customer-id est obligatoire lorsque vous utilisez un compte administrateur pour accéder à un compte administrateur secondaire ou client. Il n'est pas nécessaire lorsque vous accédez directement à un compte administrateur secondaire ou client. Bien que ce 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 empêche de définir le contexte sur le compte incorrect par inadvertance.
La requête doit inclure le numéro client de l'utilisateur autorisé, sans tirets (-), par exemple:
https://searchads360.googleapis.com/VERSION_NUMBER/customers/CUSTOMER_ID/campaignBudgets
Définir login-customer-id équivaut à 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 métadonnées de fin gRPC) sont renvoyés avec le corps de la réponse. Nous vous recommandons de consigner ces valeurs à des fins de débogage.
Identifiant de la demande
L'en-tête request-id est une chaîne qui identifie de manière unique la requête.