Precaución: Estás viendo la documentación de la interfaz REST de la API. La mayoría de nuestras bibliotecas cliente oficiales usan gRPC. Consulta la Introducción a REST para obtener más detalles.

Diseño de la interfaz REST

Organiza tus páginas con colecciones Guarda y categoriza el contenido según tus preferencias.

En esta página, se supone que estás familiarizado con las guías para desarrolladores Diseño orientado a recursos y Nombres de recursos, y 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 como colecciones de recursos abordables de manera individual (los sustantivos de la API). Se hace referencia a los recursos con sus nombres de recursos 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, componen las URL de la interfaz REST. Por ejemplo, la URL a continuación se puede desglosar en estos componentes individuales según la siguiente tabla:

https://googleads.googleapis.com/v12/customers/1234567890:mutate
Prefijo de versión de API Nombre del recurso (relativo) Método
https://googleads.googleapis.com/v12 customers/1234567890 mutate

Todas las URL de REST para una versión particular de la API (p.ej., v12) comparten un prefijo de versión de API común. El nombre y el método del recurso juntos identifican el servicio de API que se llama.

La API de Google Ads hace un uso intensivo de los métodos personalizados, a diferencia de la mayoría de las API de REST tradicionales que usan métodos de REST estándar, como list, get, create, update y delete. Los ejemplos de métodos personalizados en la API de Google Ads 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 JSON de la API de Google Ads a fin de ilustrar cómo se usan juntas para definir los extremos de la interfaz de REST.