Vous souhaitez nous faire part de vos commentaires sur l'API Google Ads ? Inscrivez-vous pour être invité à participer à des recherches sur l'expérience utilisateur.

Cette page a été traduite par l'API Cloud Translation.

Structure de l'appel d'API

Ce guide décrit la structure commune de tous les appels d'API.

Si vous utilisez une bibliothèque cliente pour interagir avec l'API, vous n'avez pas à vous soucier des détails de la requête sous-jacente. Toutefois, en savoir un peu sur eux peut s'avérer utile lors des tests et du débogage.

L'API Google Ads est une API gRPC, avec des liaisons REST. Cela signifie qu'il existe deux façons d'appeler l'API.

[Recommandé] Créez le corps de la requête en tant que tampon de protocole, envoyez-le au serveur à l'aide de HTTP/2, sérialisez la réponse dans un tampon de protocole et interprétez les résultats. La plupart de notre documentation décrit l'utilisation de gRPC.
[Facultatif] Créez le corps de la requête en tant qu'objet JSON, envoyez-le au serveur à l'aide de HTTP 1.1, désérialisez la réponse en tant qu'objet JSON et interprétez les résultats. Pour en savoir plus sur l'utilisation de REST, consultez le guide de l'interface 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 connaître leur structure, consultez les noms de ressources de l'interface REST.

ID composites

Si l'ID d'un objet n'est pas unique au niveau mondial, un ID composite de cet objet est créé en ajoutant son ID parent et un tilde (~).

Par exemple, comme l'ID d'une annonce de groupe d'annonces n'est pas unique au niveau mondial, nous lui ajoutons l'ID de son objet parent (groupe d'annonces) pour créer un ID composite unique:

AdGroupId de 123 + ~ + AdGroupAdId de 45678 = ID d'annonce du groupe d'annonces composite de 123~45678.

En-têtes de requête

Voici les en-têtes HTTP (ou métadonnées grpc) qui accompagnent le corps de la requête:

Autorisation

Vous devez inclure un jeton d'accès OAuth2 au format Authorization: Bearer YOUR_ACCESS_TOKEN qui identifie un compte administrateur agissant au nom d'un client ou un annonceur qui gère directement son propre compte. Pour savoir comment récupérer un jeton d'accès, consultez le guide OAuth2. Un jeton d'accès est valide pendant une heure après son acquisition. Lorsqu'il expire, actualisez le jeton d'accès pour en récupérer un nouveau. Notez que nos bibliothèques clientes actualisent automatiquement les jetons expirés.

developer-token

Un jeton de développeur est une chaîne de 22 caractères qui identifie de manière unique un développeur de l'API Google Ads. Voici un exemple de chaîne de jeton de développeur : ABcdeFGH93KL-NOPQ_STUv. Le jeton de développeur doit être inclus au format developer-token : ABcdeFGH93KL-NOPQ_STUv.

login-customer-id

Il s'agit de l'ID client autorisé à utiliser dans la requête, sans tirets (-). Si vous accédez au compte client via un compte administrateur, cet en-tête est obligatoire et doit être défini sur l'ID client du compte administrateur.

https://googleads.googleapis.com/v19/customers/1234567890/campaignBudgets:mutate

Définir login-customer-id équivaut à choisir un compte dans l'interface utilisateur de Google Ads après vous être connecté ou avoir cliqué sur votre image de profil en haut à droite. Si vous n'incluez pas cet en-tête, il est défini par défaut sur le client exploitant.

linked-customer-id

Cet en-tête n'est utilisé que par les fournisseurs tiers de solutions d'analyse d'applications lorsqu'ils importent des conversions dans un compte Google Ads associé.

Imaginons que les utilisateurs du compte A accordent un accès en lecture et en modification à ses entités au compte B via un ThirdPartyAppAnalyticsLink. Une fois l'association effectuée, un utilisateur du compte B peut effectuer des appels d'API sur le compte A, sous réserve des autorisations fournies par l'association. Dans ce cas, les autorisations d'appel d'API au compte A sont déterminées par le lien tiers au compte B, plutôt que par la relation compte administrateur utilisée dans d'autres appels d'API.

Le fournisseur de solutions d'analyse d'applications tiers effectue un appel d'API comme suit:

linked-customer-id: compte d'analyse d'applications tierce qui importe les données (compte B).
customer-id: compte Google Ads auquel les données sont importées (compte A).
En-tête login-customer-id et Authorization: combinaison de valeurs permettant d'identifier un utilisateur ayant accès au compte B.

En-têtes de réponse

Les en-têtes suivants (ou grpc trailing-metadata) sont renvoyés avec le corps de la réponse. Nous vous recommandons de consigner ces valeurs à des fins de débogage.

request-id

request-id est une chaîne qui identifie de manière unique cette requête.

Métadonnées de ressources