Se usó la API de Cloud Translation para traducir esta página.

WebhookNotification

Representación JSON

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 actualice el recurso.

Las configuraciones de notificaciones contienen valores privados y solo son visibles para tu proyecto de GCP. Los diferentes proyectos de GCP pueden adjuntar diferentes notificaciones de webhook al mismo recurso de operación de larga duración.

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

Campos

Campos
`uri`	`string` Opcional. Es la dirección web que recibirá la notificación del webhook. Esta dirección recibirá solicitudes POST a medida que cambie el estado del recurso de 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 la época en que se envió la solicitud. Esto te permite identificar las notificaciones reproducidas. Un ejemplo de URI es `https://us-central1-example-project-id.cloudfunctions.net/example-function-1`. El URI debe usar HTTPS y apuntar 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 de la lista de entidades permitidas de la RFC 1738. Cuando el servidor de tu webhook recibe una notificación, se espera que responda con un código de estado de respuesta HTTP de 200 en un plazo de 5 segundos. Se requiere un URI para usar las notificaciones de webhook. Las solicitudes a este servidor de webhook contendrán un token de ID que autenticará la cuenta de servicio `[email protected]`. 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 IAM de Cloud, 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 solicitud de publicación del webhook pase la autenticación de Google Cloud Functions. Esta API puede enviar notificaciones de webhook a URIs arbitrarios. En el caso de los servidores de webhook que no son 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 del canal es un valor de cadena arbitrario y debe tener una longitud máxima de 64 caracteres. Los tokens de canal te permiten verificar la fuente de una notificación de webhook. Esto evita que se falsifique el mensaje. El token del canal se especificará en el encabezado HTTP `X-Goog-Channel-Token` de la solicitud POST del webhook. No se requiere un token de canal para usar notificaciones de webhook.

uri

string

Opcional. Es la dirección web que recibirá la notificación del webhook. Esta dirección recibirá solicitudes POST a medida que cambie el estado del recurso de 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 la época en que se envió la solicitud. Esto te permite identificar las notificaciones reproducidas.

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

El URI debe usar HTTPS y apuntar 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 de la lista de entidades permitidas de la RFC 1738.

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

Se requiere un URI para usar las notificaciones de webhook.

Las solicitudes a este servidor de webhook contendrán un token de ID que autenticará la cuenta de servicio [email protected]. 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 IAM de Cloud, 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 solicitud de publicación del webhook pase la autenticación de Google Cloud Functions. Esta API puede enviar notificaciones de webhook a URIs arbitrarios. En el caso de los servidores de webhook que no son 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 del canal es un valor de cadena arbitrario y debe tener una longitud máxima de 64 caracteres. Los tokens de canal te permiten verificar la fuente de una notificación de webhook. Esto evita que se falsifique el mensaje. El token del canal se especificará en el encabezado HTTP X-Goog-Channel-Token de la solicitud POST del webhook.

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