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 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, modelado como colecciones de recursos direccionables de forma 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 verbos u operaciones). Estos nombres de recursos y métodos, combinados con un prefijo de versión de API específico, conforman las URLs de la interfaz de REST. Por ejemplo, esta URL de ejemplo se puede desglosar en estos componentes individuales según la siguiente tabla:
https://googleads.googleapis.com/v26/customers/1234567890:mutate
| Prefijo de la versión de la API | Nombre del recurso (relativo) | Método |
|---|---|---|
https://googleads.googleapis.com/v26
|
customers/1234567890
|
mutate
|
Todas las URLs de REST para una versión particular de la API (p.ej., v26)
comparten un prefijo de versión de API común. El nombre del recurso y el método juntos
identifican qué servicio de la 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 que usan métodos de 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 proporcionan más detalles sobre los nombres de 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 de REST.
Administración de errores
Consulta Información sobre los errores de la API para obtener orientación sobre cómo analizar y depurar los errores que surjan.
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áquinas.