Google utilise la technologie IA pour traduire le contenu dans votre langue préférée. Les traductions générées par IA peuvent contenir des erreurs.

Structure des appels 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'aurez pas besoin de connaître les détails de la requête sous-jacente. Toutefois, certaines connaissances sur la structure des appels d'API peuvent être utiles 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.

Préféré :

Créez le corps de la requête en tant que tampon de protocole.
Envoyez-le au serveur à l'aide de HTTP/2.
Désérialisez la réponse dans un tampon de protocole.
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 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 sur l'utilisation de REST, consultez le guide de l'interface REST.

Identifiants de ressources

Les objets de l'API Google Ads sont adressés à l'aide de noms de ressources structurés et d'identifiants composites.

Noms de ressources

La plupart des objets de l'API sont identifiés par leur chaîne de nom de ressource. Ces chaînes servent également d'URL lorsque vous utilisez l'interface REST. Consultez la section Noms de ressources de l'interface REST pour connaître leur structure.

ID composites

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

Par exemple, un AdGroupAd possède le modèle de nom de ressource customers/{customer_id}/adGroupAds/{ad_group_id}~{ad_id}. Étant donné que son identifiant composite combine l'ID du groupe d'annonces parent (ad_group.id) et l'ID de l'annonce sous-jacente (ad_group_ad.ad.id), nous ajoutons l'ID du groupe d'annonces à l'ID de l'annonce :

AdGroupId de 123 + ~ + AdId de 45678 = ID d'annonce composite du groupe d'annonces 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 OAuth 2.0 sous la forme Authorization: Bearer YOUR_ACCESS_TOKEN qui identifie un compte administrateur agissant au nom d'un client ou un annonceur gérant 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 valable une heure après son acquisition. Lorsqu'il expire, actualisez-le pour en récupérer un nouveau. Notez que nos bibliothèques clientes actualisent automatiquement les jetons expirés.

Si vous rencontrez des erreurs d'autorisation, assurez-vous d'utiliser les identifiants appropriés et de disposer des autorisations suffisantes. Une erreur USER_PERMISSION_DENIED indique que l'utilisateur authentifié n'a peut-être pas accès au compte client spécifié dans la requête. Si votre projet Google Cloud n'est approuvé que pour l'accès Test et que vous envoyez une requête ciblant un compte de production, l'API renvoie AuthorizationError.CLOUD_PROJECT_NOT_APPROVED_FOR_PRODUCTION dans la version 25 et ultérieures (ou AuthorizationError.ACTION_NOT_PERMITTED dans la version 24 et antérieures). Pour en savoir plus sur la gestion des autorisations, consultez Niveaux d'accès Google Ads.

login-customer-id

Il s'agit du numéro client autorisé à utiliser dans la demande, 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 le numéro client du compte administrateur. Si vous n'incluez pas login-customer-id lorsque vous vous authentifiez via un compte administrateur, une erreur AuthorizationError.USER_PERMISSION_DENIED s'affiche. Pour en savoir plus sur ce type d'erreur, consultez les erreurs fréquentes. Pour obtenir une explication détaillée sur la façon dont l'accès au compte est résolu, consultez le guide Modèle d'accès OAuth.

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

Définir login-customer-id équivaut à choisir un compte dans l'UI 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, la valeur par défaut est operating_customer.

linked-customer-id

Cet en-tête est obligatoire et utilisé par les partenaires (tels que les fournisseurs d'analyse des applications tierces ou les partenaires de données) lorsqu'ils agissent sur un compte Google Ads associé. Cet en-tête doit spécifier le numéro client du compte Google Ads qui contient le lien vers le produit.

Prenons l'exemple d'un partenaire qui doit effectuer des appels d'API vers un compte Google Ads en fonction d'un lien vers un produit.

Annonceur : compte Google Ads géré ou mis à jour par l'appel d'API. L'ID du compte de l'annonceur est spécifié dans la requête. Dans REST, il s'agit du paramètre de chemin d'accès customerId (par exemple, customers/1111111111/...), et dans gRPC, il s'agit du champ customer_id dans la requête.
Partenaire : compte partenaire (par exemple, un fournisseur d'analyse d'applications tierces ou un partenaire pour les données).
Compte associé : compte Google Ads qui a établi une association de produits avec le partenaire, lui accordant l'accès à l'annonceur.

Un utilisateur ayant accès au compte Partenaire effectue des appels d'API pour agir sur les entités du compte Annonceur (par exemple, pour importer des conversions ou gérer des listes d'utilisateurs). Le compte associé peut être le compte Annonceur lui-même ou un compte administrateur du compte Annonceur.

Les en-têtes de requête doivent être définis comme suit :

Authorization : jeton d'accès OAuth 2.0 pour un utilisateur ayant accès à Partner.
login-customer-id : ID client du compte partenaire. L'utilisateur authentifié doit avoir accès à ce compte.
linked-customer-id : ID client du compte associé. Cet en-tête indique que l'autorisation de cette requête repose sur l'association de compte à un produit avec le partenaire.

Il existe deux scénarios d'association :

Si le compte Annonceur est directement associé à un produit du compte Partenaire, le compte associé est Annonceur et linked-customer-id doit être défini sur l'ID client du compte Annonceur.
Si le compte Annonceur est géré par un compte administrateur associé au compte Partenaire, le compte associé est le compte administrateur et linked-customer-id doit être défini sur l'ID client de l'administrateur.

Exemple 1 : Lien direct

Si le compte annonceur 1111111111 est directement associé au compte partenaire 2222222222 et que l'appel d'API cible customers/1111111111/... :

Authorization: Bearer YOUR_ACCESS_TOKEN
login-customer-id: 2222222222
linked-customer-id: 1111111111

Exemple 2 : Lien administrateur

Si le compte annonceur 1111111111 est géré par le compte administrateur 3333333333, que le compte administrateur 3333333333 est associé au compte partenaire 2222222222 et que l'appel d'API cible customers/1111111111/... :

Authorization: Bearer YOUR_ACCESS_TOKEN
login-customer-id: 2222222222
linked-customer-id: 3333333333

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.

request-id

request-id est une chaîne qui identifie cette requête de manière unique. Fournissez cette valeur lorsque vous contactez l'assistance pour résoudre les problèmes liés aux requêtes API ayant échoué ou inattendues.

Métadonnées de ressources