En esta página, se supone que conoces las guías para desarrolladores de Diseño orientado a recursos y Nombres de recursos, y se complementan con detalles específicos de la implementación 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 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 de REST. Por ejemplo, la siguiente URL se puede desglosar en estos componentes individuales según la siguiente tabla:
https://googleads.googleapis.com/v21/customers/1234567890:mutate
| Prefijo de versión de la API | Nombre del recurso (relativo) | Método |
|---|---|---|
https://googleads.googleapis.com/v21
|
customers/1234567890
|
mutate
|
Todas las URLs de REST para una versión en particular de la API (p.ej., v21)
comparten un prefijo de versión de API común. El nombre y el método del recurso juntos identifican qué servicio de API se llama.
La API de Google Ads utiliza en gran medida los métodos personalizados, a diferencia de la mayoría de las APIs de REST tradicionales que utilizan métodos REST estándar, como list, get, create, update y delete. Entre los ejemplos de métodos personalizados en la API de Google Ads, se incluyen search, searchStream y mutate.
En las siguientes páginas, se explican con más detalle los nombres de recursos, los métodos de servicio y las convenciones de nomenclatura de JSON de la API de Google Ads para ilustrar cómo se usan en conjunto para definir los extremos de la interfaz de REST.
Documento de descubrimiento
Para facilitar y automatizar el descubrimiento de los métodos disponibles en la API de Google Ads, puedes usar el documento de descubrimiento publicado para cada versión.
Está disponible en https://googleads.googleapis.com/$discovery/rest?version=<API_VERSION>.
Por ejemplo, este es el documento de descubrimiento de la versión más reciente de la API de Google Ads.
El documento de descubrimiento contiene información sobre todos los servicios, métodos, recursos y entidades que se usan en la API de Google Ads, como la documentación de referencia, pero en un formato JSON legible por máquina.