Conception de l'interface REST

Cette page suppose que vous connaissez les guides du développeur Conception orientée ressources et Noms de ressources, et les complète avec des informations d'implémentation spécifiques de l'API Google Ads.

Conception orientée ressources

En général, l'API Google Ads suit une conception orientée ressources, modélisée sous la forme de collections de ressources adressables individuellement (les noms de l'API). Les ressources sont référencées avec leurs noms de ressources et manipulées à l'aide d'un petit ensemble de méthodes (également appelées verbes ou opérations).

Ces noms de ressources et méthodes, combinés à un préfixe de version d'API spécifique, constituent les URL de l'interface REST. Par exemple, l'URL ci-dessous peut être décomposée en composants individuels conformément au tableau suivant:

https://googleads.googleapis.com/v18/customers/1234567890:mutate
Préfixe de version de l'API Nom de la ressource (relatif) Méthode
https://googleads.googleapis.com/v18 customers/1234567890 mutate

Toutes les URL REST d'une version particulière de l'API (par exemple, v18) partagent un préfixe de version d'API commun. Le nom et la méthode de la ressource identifient ensemble le service d'API appelé.

L'API Google Ads utilise largement des méthodes personnalisées, contrairement à la plupart des API REST traditionnelles qui utilisent des méthodes REST standards telles que list, get, create, update et delete. search, searchStream et mutate sont des exemples de méthodes personnalisées dans l'API Google Ads.

Les pages suivantes fournissent plus d'informations sur les noms de ressources, les méthodes de service et les conventions d'attribution de noms JSON de l'API Google Ads pour illustrer comment ils sont utilisés ensemble pour définir des points de terminaison d'interface REST.