Conception de l'interface REST

Cette page part du principe que vous connaissez les guides du développeur sur la conception orientée ressources et les noms de ressources, et les complètent avec des informations d'implémentation spécifiques pour l'API Google Ads.

Conception orientée ressources

En règle générale, 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 leur nom de ressource 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, associé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 ces composants individuels selon le tableau suivant:

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

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

L'API Google Ads fait largement appel aux 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 décrivent plus en détail les noms de ressources, les méthodes de service et les conventions d'attribution de noms JSON de l'API Google Ads pour illustrer la façon dont ils sont utilisés ensemble pour définir les points de terminaison de l'interface REST.