En esta página, se asume que conoces las guías para desarrolladores sobre Diseño orientado a recursos y Nombres de recursos, y se complementan con detalles específicos de la implementación de la API de informes de Search Ads 360.
Diseño orientado a recursos
En general, la API de informes de Search Ads 360 sigue un diseño orientado a los recursos, modelado como colecciones de recursos abordables de manera individual (los sustantivos de la API). Se hace referencia a los recursos con sus nombres de recursos y se manipulan mediante un pequeño conjunto de métodos (también conocidos como operaciones o verbos).
Estos nombres de recursos y métodos, combinados con un prefijo de versión de API específico, componen las URLs de la interfaz de REST. Por ejemplo, la siguiente URL se puede desglosar en estos componentes individuales de acuerdo con la tabla a continuación:
https://searchads360.googleapis.com/v0/customers/1234567890/searchAds360:search
| Prefijo de la versión de la API | Nombre del recurso (relativo) | Método |
|---|---|---|
https://searchads360.googleapis.com/v0
|
customers/1234567890
|
search
|
Todas las URLs de REST de una versión particular de la API (p.ej., v0) comparten un prefijo de versión de API común. El nombre y el método del recurso juntos identifican a qué servicio de la API se está llamando.
La API de informes de Search Ads 360 usa en gran medida los métodos personalizados, a diferencia de la mayoría de las APIs de REST tradicionales que usan métodos de REST estándar, como list y get. La API de informes de Search Ads 360 incluye dos métodos personalizados: search y searchStream.
En las siguientes páginas, se proporciona más información sobre los nombres de recursos, los métodos de servicio y las convenciones de nombres de JSON de la API de informes de Search Ads 360 a fin de ilustrar cómo se usan en conjunto para definir los extremos de la interfaz de REST.