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étera avec des informations spécifiques sur l'implémentation de l'API Search Ads 360 Reporting.
Conception orientée ressources
En règle générale, l'API Search Ads 360 Reporting 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, 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 selon le tableau suivant:
https://searchads360.googleapis.com/v0/customers/1234567890/searchAds360:search
| Préfixe de version de l'API | Nom de la ressource (relatif) | Méthode |
|---|---|---|
https://searchads360.googleapis.com/v0
|
customers/1234567890
|
search
|
Toutes les URL REST d'une version particulière de l'API (par exemple, v0) partagent un préfixe de version d'API commun. Ensemble, le nom de la ressource et la méthode identifient le service d'API appelé.
L'API Search Ads 360 Reporting fait largement appel aux méthodes personnalisées, par opposition à la plupart des API REST traditionnelles qui utilisent des méthodes REST standards telles que list et get. L'API Search Ads 360 Reporting comprend deux méthodes personnalisées: search et searchStream.
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 Search Ads 360 Reporting afin d'illustrer la manière dont ils sont utilisés ensemble pour définir les points de terminaison de l'interface REST.