En esta página, se da por sentado que ya sabes usar las funciones de Diseño y Recurso Nombres y guías para desarrolladores las complementa 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 de la siguiente manera: colecciones de recursos abordables de manera individual (los sustantivos de la API). Se hace referencia a los recursos con sus nombres de recurso y se manipulan con 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 comprenden 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/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 juntos
identifica a qué servicio de API se llama.
La API de Google Ads usa en gran medida 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, get,
create, update y delete. Ejemplos de métodos personalizados en la API de Google Ads
incluyen search, searchStream y mutate.
Las siguientes páginas brindan más detalles sobre el recurso de la API de Google Ads nombres, métodos de servicio y Convenciones de nomenclatura JSON para ilustrar cómo se usan para definir los extremos de la interfaz de REST.