En esta página, se da por sentado que el usuario está familiarizado con 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
En general, la API de Google Ads sigue un diseño orientado a 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 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 API específico, comprenden 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/v25/customers/1234567890:mutate
| Prefijo de versión de API | Nombre de recurso (relativo) | Método |
|---|---|---|
https://googleads.googleapis.com/v25
|
customers/1234567890
|
mutate
|
Todas las URLs de REST para una versión en particular de la API (p.ej., v25) comparten un prefijo de versión de API común. El nombre del recurso y el método juntos identifican qué servicio de API se está llamando.
La API de Google Ads hace un uso intensivo de métodos personalizados, a diferencia de la mayoría de las
APIs de REST que usan 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 proporcionan más detalles sobre 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 juntos para definir los extremos de la interfaz de REST.
Administración de errores
Consulta Comprende los errores de la API para obtener instrucciones 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áquina.