Cette page suppose 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 d'implémentation spécifiques de l'API Search Ads 360 Reporting.
Conception orientée ressources
En général, 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 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://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. Le nom et la méthode de la ressource identifient ensemble le service d'API appelé.
L'API Search Ads 360 Reporting utilise de nombreuses méthodes personnalisées, contrairement à la plupart des API REST traditionnelles qui utilisent des méthodes REST standards telles que list
et get
. L'API Search Ads 360 Reporting inclut deux méthodes personnalisées: search
et searchStream
.
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 Search Ads 360 Reporting afin d'illustrer comment ils sont utilisés ensemble pour définir les points de terminaison de l'interface REST.