Por lo general, las llamadas a la API de informes de Search Ads 360 se realizan a través de tu biblioteca cliente. Consulta Explicación de bibliotecas cliente para obtener más información. Sin embargo, el conocimiento de la estructura de los detalles de la solicitud subyacente puede ser útil cuando se realizan pruebas y depuraciones.
La API de Search Ads 360 Reporting es una API de gRPC con vinculaciones de REST. Esto significa que puedes realizar llamadas a la API de dos maneras alternativas:
- Método de preferencia
- Usa una biblioteca cliente:
- Crea el cuerpo de la solicitud como un búfer de protocolo.
- Envía la solicitud al servidor con 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 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 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 Referencia > REST para obtener más información sobre los recursos compatibles y su representación de ruta. 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, como el ID de un anuncio de grupo de anuncios no es único a nivel global, se le antepone el ID del 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
Los encabezados HTTP (o los metadatos de gRPC) de las siguientes secciones deben incluirse 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 Autenticación para obtener más información.
Encabezado de 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 obligatorio cuando se accede directamente a una cuenta de subadministrador o de cliente. Aunque no es estrictamente necesario, te recomendamos que siempre especifiques 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 configure el contexto en la cuenta incorrecta de forma 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 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 para debugging.
ID de solicitud
El encabezado request-id es una cadena que identifica la solicitud de forma exclusiva.