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 tendrás que preocuparte por los detalles de la solicitud subyacente. Sin embargo, saber un poco sobre ellas puede ser útil a la hora de probar y depurar.

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

1. [Preferred] Crea el cuerpo de la solicitud como un búfer de protocolo, envíalo al servidor mediante HTTP/2, deserializa la respuesta a un búfer 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 mediante HTTP 1.1, deserializa la respuesta como un objeto JSON y, luego, interpreta los resultados. Consulta la guía de la interfaz de REST para obtener más información sobre el uso de REST.

Nombres de recursos

La mayoría de los objetos de la API se identifican por sus strings de nombre de recurso. Estas strings también sirven como URL cuando se usa la interfaz REST. Consulta los Nombres de recursos de la interfaz REST para conocer su estructura.

ID compuestos

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

Por ejemplo, como el ID de un anuncio del grupo de anuncios no es único a nivel global, se antepone su ID de objeto superior (grupo de anuncios) a fin de crear un ID compuesto único:

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

Encabezados de la solicitud

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

Autorización

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

token del desarrollador

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

ID de cliente de acceso

Este es el ID de cliente del cliente autorizado para 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 debe configurarse con el ID de cliente de la cuenta de administrador.

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

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

ID del cliente vinculado

Solo los proveedores de estadísticas de aplicaciones de terceros suben las 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 para la cuenta B a través de un ThirdPartyAppAnalyticsLink. Una vez vinculado, un usuario de la cuenta B puede realizar llamadas a la API en la cuenta A, sujeto a los permisos proporcionados por el vínculo. En este caso, los permisos de llamada a la API para la cuenta A están determinados por el vínculo de terceros a la cuenta B, en lugar de la relación de 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: La cuenta de estadísticas de apps de terceros que sube los datos (cuenta B)
• customer-id: La cuenta de Google Ads a la que se suben los datos (cuenta A)
• Encabezado login-customer-id y Authorization: Una combinación de valores para identificar a un usuario que tiene acceso a la cuenta B.

Encabezados de respuesta

Los siguientes encabezados (o metadatos finales de grpc) se muestran con el cuerpo de la respuesta. Te recomendamos que registres estos valores para fines de depuración.

ID de solicitud

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