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 de implementación específicos de la API de Google Ads.
Diseño orientado a recursos
En general, la API de Google Ads 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 y se manipulan con un conjunto pequeño 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, conforman las URL de la interfaz REST. Por ejemplo, la siguiente URL se puede desglosar en estos componentes individuales de acuerdo con la siguiente tabla:
https://googleads.googleapis.com/v17/customers/1234567890:mutate
| Prefijo de la versión de la API | Nombre del recurso (relativo) | Método |
|---|---|---|
https://googleads.googleapis.com/v17
|
customers/1234567890
|
mutate
|
Todas las URLs de REST de una versión específica de la API (p.ej., v17) comparten un prefijo de versión de API común. El nombre y el método del recurso en conjunto identifican a qué servicio de API se llama.
La API de Google Ads hace un uso intensivo de los métodos personalizados, a diferencia de la mayoría de las APIs de REST tradicionales que usan métodos de REST estándares, como list, get, create, update y delete. Algunos ejemplos de métodos personalizados en la API de Google Ads son search, searchStream y mutate.
En las siguientes páginas, se brinda 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 Google Ads a fin de ilustrar cómo se usan en conjunto para definir los extremos de la interfaz de REST.