Estructura de la llamada a la API

En esta guía, se describe la estructura común de todas las llamadas a la API.

Si usas una biblioteca cliente para interactuar con la API, no necesitarás preocuparte por los detalles subyacentes de la solicitud. Sin embargo, conocer un poco sobre ellos puede ser útil cuando se prueba y depura.

La API de Google Ads es una API de gRPC, con vinculaciones de REST. Esto significa que hay dos maneras de realizar llamadas a la API.

1. [Opción preferida] Crea el cuerpo de la solicitud como un buffer de protocolo, envíalo al servidor con HTTP/2, desserializa la respuesta a un buffer de protocolo y, luego, interpreta los resultados. En la mayor parte de nuestra documentación, se describe el uso de gRPC.

2. [Opcional] Crea el cuerpo de la solicitud como un objeto JSON, envíalo al servidor con HTTP 1.1, deserializa la respuesta como un objeto JSON y, luego, interpreta los resultados. Consulta la guía de la interfaz REST para obtener más información sobre el uso de REST.

Nota: En esta guía, se describen la estructura y los encabezados de transporte comunes a los protocolos gRPC y REST.

Nombres de recursos

La mayoría de los objetos de la API se identifican por sus cadenas de nombres de recursos. Estas cadenas también funcionan como URLs cuando se usa la interfaz REST. Consulta los Nombres de recursos de la interfaz REST para conocer su estructura.

Punto clave: Consulta la documentación de recursos para ver todos los recursos admitidos y su representación de ruta de acceso (resource_name). El mismo formato se usa para otros servicios.

IDs compuestos

Si el ID de un objeto no es único a nivel global, se construye un ID compuesto para ese objeto con el ID superior y una virgulilla (~) al principio.

Por ejemplo, como el ID de anuncio de un grupo de anuncios no es único a nivel global, le anteponemos el ID de su objeto superior (grupo de anuncios) para crear un ID compuesto único:

• AdGroupId de 123 + ~ + AdGroupAdId de 45678 = ID de anuncio del grupo de anuncios compuesto de 123~45678.

Encabezados de la solicitud

Estos son los encabezados HTTP (o metadatos de RPC) que acompañan al cuerpo en la solicitud:

Autorización

Debes incluir un token de acceso de OAuth2 en forma de Authorization: Bearer YOUR_ACCESS_TOKEN que identifique una cuenta de administrador que actúa en nombre de un cliente o un anunciante que administra directamente su propia cuenta. Puedes encontrar instrucciones para recuperar un token de acceso en la guía de OAuth2. Un token de acceso es válido durante una hora después de que lo adquieres. Cuando vence, actualiza el token de acceso para recuperar uno nuevo. Ten en cuenta que nuestras bibliotecas cliente actualizan automáticamente los tokens vencidos.

developer-token

Un token de desarrollador es una cadena de 22 caracteres que identifica de forma única a un desarrollador de la API de Google Ads. Un ejemplo de cadena de token de desarrollador es ABcdeFGH93KL-NOPQ_STUv. El token de desarrollador debe incluirse en el formato developer-token : ABcdeFGH93KL-NOPQ_STUv.

login-customer-id

Este es el ID de cliente autorizado que se debe usar en la solicitud, sin guiones (-). Si tu acceso a la cuenta de cliente es a través de una cuenta de administrador, este encabezado es obligatorio y se debe establecer en el ID de cliente de la cuenta de administrador.

Término clave: El cliente operativo es el ID de cliente en la carga útil de la solicitud. Por ejemplo, el cliente operativo en la siguiente solicitud de CampaignBudgetService es 1234567890:

https://googleads.googleapis.com/v19/customers/1234567890/campaignBudgets:mutate

Configurar login-customer-id equivale a elegir una cuenta en la IU de Google Ads después de acceder o hacer clic en tu imagen de perfil en la parte superior derecha. Si no incluyes este encabezado, el valor predeterminado es el cliente operativo.

Nota: Puedes recuperar la lista de cuentas a las que se puede acceder directamente con tus credenciales de OAuth si emites una solicitud CustomerService.ListAccessibleCustomers. No se requiere login-customer-id para este tipo de solicitud y no tiene ningún efecto en la lista de clientes que se muestra.

linked-customer-id

Solo los proveedores de estadísticas de aplicaciones de terceros usan este encabezado cuando suben conversiones a una cuenta de Google Ads vinculada.

Considera la situación en la que los usuarios de la cuenta A proporcionan acceso de lectura y edición a sus entidades a la cuenta B a través de un ThirdPartyAppAnalyticsLink. Una vez que se realiza la vinculación, un usuario de la cuenta B puede realizar llamadas a la API de la cuenta A, sujeto a los permisos que proporciona la vinculación. En este caso, el vínculo de terceros a la cuenta B determina los permisos de llamada a la API a la cuenta A, en lugar de la relación cuenta de administrador que se usa en otras llamadas a la API.

El proveedor de estadísticas de aplicaciones de terceros realiza una llamada a la API de la siguiente manera:

• linked-customer-id: Es la cuenta de estadísticas de aplicaciones de terceros que sube los datos (cuenta B).
• customer-id: Es la cuenta de Google Ads a la que se suben los datos (cuenta A).
• Encabezado login-customer-id y Authorization: Es una combinación de valores para identificar a un usuario que tiene acceso a la cuenta B.

Encabezados de respuesta

Los siguientes encabezados (o grpc trailing-metadata) se muestran con el cuerpo de la respuesta. Te recomendamos que registres estos valores para depurar.

request-id

request-id es una cadena que identifica esta solicitud de forma única.