WebhookNotification

Configura un recurso de operación de larga duración para enviar una notificación de webhook desde la API de datos de Google Analytics a tu servidor de webhook cuando se actualiza el recurso.

Los parámetros de configuración de las notificaciones contienen valores privados y solo son visibles para tu proyecto de GCP. Los diferentes proyectos de GCP pueden adjuntar distintas notificaciones de webhook al mismo recurso de operación de larga duración.

Representación JSON
{
  "uri": string,
  "channelToken": string
}
Campos
uri

string

Opcional. La dirección web que recibirá la notificación del webhook. Esta dirección recibirá solicitudes POST a medida que cambie el estado de los recursos de la operación de larga duración. La solicitud POST contendrá una versión JSON del recurso de operación de larga duración en el cuerpo y un campo sentTimestamp. La marca de tiempo enviada especificará los microsegundos de Unix desde el ciclo de entrenamiento en el que se envió la solicitud; esto te permite identificar las notificaciones repetidas.

Un URI de ejemplo es https://us-central1-example-project-id.cloudfunctions.net/example-function-1.

El URI debe usar HTTPS y dirigir a un sitio con un certificado SSL válido en el servidor web. El URI debe tener una longitud máxima de cadena de 128 caracteres y usar solo los caracteres incluidos en la lista de entidades permitidas de RFC 1738.

Cuando tu servidor de webhook recibe una notificación, se espera que responda con un código de estado de respuesta HTTP de 200 en 5 segundos.

Se requiere un URI para usar notificaciones de webhook.

Las solicitudes a este servidor de webhook contendrán un token de ID que autentica la cuenta de servicio google-analytics-audience-export@system.gserviceaccount.com. Para obtener más información sobre los tokens de ID, consulta https://cloud.google.com/docs/authentication/token-types#id. En el caso de Google Cloud Functions, esto te permite configurar la función para que requiera autenticación. En Cloud IAM, deberás otorgar los permisos de la cuenta de servicio a los roles de Invocador de Cloud Run (roles/run.invoker) y de Invocador de Cloud Functions (roles/cloudfunctions.invoker) para que la webhook después de la solicitud pase la autenticación de Google Cloud Functions. Esta API puede enviar notificaciones de webhook a URI arbitrarios. En el caso de servidores de webhook que no sean de Google Cloud Functions, se debe ignorar este token de ID en el encabezado del portador de autorización si no es necesario.

channelToken

string

Opcional. El token de canal es un valor de cadena arbitrario y debe tener una longitud máxima de cadena de 64 caracteres. Los tokens de canal te permiten verificar el origen de una notificación de webhook. Esto protege contra la falsificación de identidad del mensaje. El token de canal se especificará en el encabezado HTTP X-Goog-Channel-Token de la solicitud POST de webhook.

No se requiere un token de canal para usar las notificaciones de webhook.