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, conocer un poco sobre ellas puede ser útil cuando se realizan pruebas y depuraciones.

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

1. [Preferido] Crea el cuerpo de la solicitud como un búfer de protocolo, envíalo al servidor con HTTP/2, deserializa la respuesta en 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 con 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 cómo usar REST.

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

Nombres de recursos

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

Punto clave: Consulta la documentación de recursos para obtener información sobre todos los recursos compatibles y su representación de ruta (resource_name). Se usa el mismo formato 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 anteponiendo su ID superior y una virgulilla (~).

Por ejemplo, dado que el ID de un grupo de anuncios no es único a nivel global, antecedimos su ID de objeto principal (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 grpc) 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. Las instrucciones para recuperar un token de acceso se encuentran en la guía de OAuth2. Un token de acceso es válido durante 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-de-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. Una string de token de desarrollador de ejemplo es ABcdeFGH93KL-NOPQ_STUv. El token de desarrollador se debe incluir en el formato de developer-token : ABcdeFGH93KL-NOPQ_STUv.

login-customer-id

Este es el ID de cliente del cliente autorizado que se usará en la solicitud, sin guiones (-). Si tienes acceso a la cuenta de cliente mediante una cuenta de administrador, este encabezado es obligatorio y debe establecerse 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 que opera en la siguiente solicitud CampaignBudgetService es 1234567890:

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

Configurar el 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: Para recuperar la lista de cuentas a las que se puede acceder directamente con tus credenciales de OAuth, emite una solicitud CustomerService.ListAccessibleCustomers. El login-customer-id no es necesario para este tipo de solicitud y no tiene efecto en la lista de clientes que se muestran.

ID-de-cliente-vinculado

Solo los proveedores de estadísticas de apps de terceros utilizan este encabezado cuando se 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 para la cuenta B a través de un ThirdPartyAppAnalyticsLink. Una vez vinculada, un usuario de la cuenta B puede realizar llamadas a la API contra la cuenta A, sujeto a los permisos que proporciona el vínculo. En este caso, los permisos de llamada a la API de la cuenta A se determinan a través de la vinculación 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: 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 matching-metadata) se muestran con el cuerpo de la respuesta. Te recomendamos que registres estos valores para fines de depuración.

request-id

El request-id es una cadena que identifica esta solicitud de forma exclusiva.