Por lo general, las llamadas a la API de informes de Search Ads 360 se realizan a través de la biblioteca cliente. Consulta Explicación de las bibliotecas cliente para obtener más información. Sin embargo, conocer la estructura de los detalles de la solicitud subyacente puede ser útil durante las pruebas y la depuración.
La API de informes de Search Ads 360 es una API de gRPC con vinculaciones de REST. Esto significa que puedes realizar llamadas a la API de dos maneras alternativas:
- Método preferido
- Usa una biblioteca cliente:
- Crea el cuerpo de la solicitud como un búfer de protocolo.
- Envía la solicitud al servidor mediante HTTP/2.
- Deserializa la respuesta a un búfer de protocolo.
- Interpreta los resultados.
- Método alternativo opcional
- Usa REST:
- Crea el cuerpo de la solicitud como un objeto JSON.
- Envía la solicitud al servidor con HTTP 1.1.
- Deserializa la respuesta como un objeto JSON.
- Interpreta los resultados.
Consulta las APIs de Google Cloud para obtener más información.
Las siguientes secciones se aplican a los protocolos gRPC y REST.
Nombres de recursos
La mayoría de los objetos en 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 Referencia > REST para obtener más información sobre los recursos compatibles y su representación de ruta de acceso. Se usa el mismo formato para otros servicios.
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, debido a que el ID del anuncio de un grupo de anuncios no es único a nivel global, se le antepone el ID de objeto superior (grupo de anuncios), lo que genera un ID compuesto único.
Ejemplo: AdGroupId de 123 + ~ + AdGroupAdId de 45678 = ID de anuncio del grupo de anuncios compuesto de 123~45678.
Encabezados de la solicitud
Se deben incluir los encabezados HTTP (o metadatos de gRPC) de las siguientes secciones en el cuerpo de la solicitud.
Autorización
Debes incluir un token de acceso de OAuth2 en el formulario:
Authorization: Bearer [OAUTH_2.0_ACCESS_TOKEN]
El token debe identificar una cuenta de administrador que actúa en nombre de un cliente o un anunciante que administra directamente su propia cuenta de subadministrador o cliente. Consulta Acerca de las cuentas de administrador de Search Ads 360 y Authentication para obtener más información.
Encabezado del ID de cliente de acceso
El encabezado login-customer-id es obligatorio cuando se usa una cuenta de administrador para acceder a una cuenta de subadministrador o de cliente. No es necesario cuando se accede directamente a una cuenta de subadministrador o cliente. Aunque no es estrictamente necesario, recomendamos especificar siempre el login-customer-id para los usuarios autenticados que tienen acceso a más de una cuenta. Esto evita la ambigüedad y evita que se establezca el contexto de la cuenta incorrecta de manera no intencional.
La solicitud debe incluir el ID de cliente del usuario autorizado, sin guiones (-), por ejemplo:
https://searchads360.googleapis.com/VERSION_NUMBER/customers/CUSTOMER_ID/campaignBudgets
Configurar la login-customer-id equivale a elegir una cuenta en la IU de Search Ads 360 después de acceder o hacer clic en tu imagen de perfil en la parte superior derecha.
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 con fines de depuración.
ID de solicitud
El encabezado request-id es una string que identifica la solicitud de manera única.