En esta página, se da por sentado que conoces las guías para desarrolladores sobre diseño orientado a recursos y nombres de recursos, y se las complementa con detalles de implementación específicos de la API de Google Ads.
Diseño orientado a recursos
Por lo general, la API de Google Ads sigue un diseño orientado a los recursos, que se modela 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 mediante 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 la API específico, conforman las URLs de la interfaz REST. Por ejemplo, la siguiente URL se puede desglosar en estos componentes individuales según la siguiente tabla:
https://googleads.googleapis.com/v18/customers/1234567890:mutate
| Prefijo de la versión de la API | Nombre del recurso (relativo) | Método |
|---|---|---|
https://googleads.googleapis.com/v18
|
customers/1234567890
|
mutate
|
Todas las URLs de REST para una versión en particular de la API (p.ej., v18) comparten un prefijo de versión de API común. El nombre y el método del recurso juntos identifican a qué servicio de API se llama.
La API de Google Ads usa mucho los métodos personalizados, a diferencia de la mayoría de las APIs de REST tradicionales que usan métodos REST estándar, como list, get, create, update y delete. Entre algunos ejemplos de métodos personalizados en la API de Google Ads, se incluyen search, searchStream y mutate.
En las siguientes páginas, se proporcionan más detalles sobre los nombres de los recursos, los métodos de servicio y las convenciones de nombres de JSON de la API de Google Ads para ilustrar cómo se usan en conjunto para definir los extremos de la interfaz REST.