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'effectuer des appels à l'API.

Méthode préférée :

1. Créez le corps de la requête en tant que tampon de protocole.
2. Envoyez-le au serveur à l'aide de HTTP/2.
3. Désérialisez la réponse dans un tampon de protocole.
4. Interprétez les résultats.

La plupart de notre documentation décrit l'utilisation de gRPC.

Facultatif :

1. Créez le corps de la requête en tant qu'objet JSON.
2. Envoyez-le au serveur à l'aide de HTTP 1.1.
3. Désérialisez la réponse en tant qu'objet JSON.
4. Interprétez les résultats.

Pour en savoir plus sur l' utilisation de REST, consultez le guide de l'interface REST.

Remarque : Ce guide décrit la structure et les en-têtes de transport communs aux protocoles gRPC et REST.

Noms de ressources

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

Point clé: : Consultez la documentation sur les ressources, pour connaître toutes les ressources compatibles et leur représentation de chemin d'accès (resource_name). Le même format est utilisé pour les autres services.

ID composites

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

Par exemple, étant donné qu'un ID d'annonce de groupe d'annonces n'est pas globalement unique, nous ajoutons l'ID de son objet parent (groupe d'annonces) pour créer un ID composite unique :

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

En-têtes de requête

Il s'agit des 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 au format Authorization: Bearer YOUR_ACCESS_TOKEN qui identifie un compte administrateur agissant au nom de un client ou un annonceur gérant directement son propre compte. Vous trouverez des instructions pour récupérer un jeton d'accès dans le guide OAuth2. Un jeton d'accès est valide pendant 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. 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 du 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 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 se produit. Pour en savoir plus sur ce type d'erreur, consultez Erreurs courantes. Pour obtenir une explication détaillée de la résolution de l'accès au compte, consultez le guide sur le modèle d'accès OAuth.

Terme clé : Le client opérationnel est le numéro client dans la charge utile de la requête. Par exemple, le client opérationnel dans la requête suivante CampaignBudgetService est 1234567890:

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

Définir login-customer-id revient à choisir un compte dans l'interface utilisateur 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 opérationnel.

Remarque : Vous pouvez récupérer la liste des comptes directement accessibles avec vos identifiants OAuth en envoyant une requête CustomerService.ListAccessibleCustomers. L'élément login-customer-id n'est pas obligatoire pour ce type de requête et n'a aucun effet sur la liste des clients renvoyés.

linked-customer-id

Cet en-tête est obligatoire et utilisé par les partenaires (tels que les fournisseurs d'analyse d'applications tiers ou les partenaires pour les 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 annonceur est spécifié dans la requête. Dans REST, il s'agit du customerId paramètre de chemin d'accès (par exemple, customers/1111111111/...), et dans gRPC, il s'agit du champ customer_id de la requête.
• Partenaire : compte partenaire (par exemple, un fournisseur d'analyse d'applications tiers ou un partenaire pour les données).
• Compte associé : compte Google Ads qui a établi un lien vers un produit avec le partenaire, ce qui lui permet d'accéder à l'annonceur.

Un utilisateur ayant accès au compte Partenaire effectue des appels d'API pour agir sur des 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 au partenaire.
• login-customer-id: numéro client du partenaire. L'utilisateur authentifié doit avoir accès à ce compte.
• linked-customer-id: numéro client du compte associé. Cet en-tête indique que l'autorisation de cette requête repose sur le lien vers le produit du compte associé avec le partenaire.

Il existe deux scénarios d'association :

• Si le compte Annonceur dispose d'un lien direct vers un produit avec le compte Partenaire, le compte associé est Annonceur, et linked-customer-id doit être défini sur le numéro client du compte Annonceur.
• Si le compte Annonceur est géré par un compte administrateur qui dispose d'un lien vers un produit avec le compte Partenaire, le compte associé est le compte administrateur, et linked-customer-id doit être défini sur le numéro 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 les 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 de manière unique cette requête.