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ète avec des informations spécifiques sur l'implémentation de l'API Google Ads.
Conception orientée ressources
En règle générale, l'API Google Ads suit une conception axée sur les 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 ces composants individuels conformément au tableau suivant:
https://googleads.googleapis.com/v17/customers/1234567890:mutate
Préfixe de version de l'API | Nom de ressource (relatif) | Méthode |
---|---|---|
https://googleads.googleapis.com/v17
|
customers/1234567890
|
mutate
|
Toutes les URL REST pour une version particulière de l'API (par exemple, v17
) partagent un préfixe de version d'API commun. Le nom de ressource et la méthode permettent
d'identifier le service d'API appelé.
L'API Google Ads fait beaucoup appel aux méthodes personnalisées, par opposition à 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 expliquent 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 comment ces éléments sont utilisés ensemble pour définir les points de terminaison de l'interface REST.