Cette page a été traduite par l'API Cloud Translation.

WebhookNotification

Représentation JSON

Configure une ressource d'opération de longue durée pour envoyer une notification webhook à partir de l'API Data de Google Analytics à votre serveur de webhook lorsque la ressource est mise à jour.

Les configurations de notification contiennent des valeurs privées et ne sont visibles que par votre projet GCP. Différents projets GCP peuvent associer différentes notifications webhook à la même ressource d'opération de longue durée.

Représentation JSON
{ "uri": string, "channelToken": string }

Champs

Champs
`uri`	`string` Facultatif. Adresse Web qui recevra la notification webhook. Cette adresse recevra des requêtes POST lorsque l'état de la ressource d'opération de longue durée change. La requête POST contiendra à la fois une version JSON de la ressource d'opération de longue durée dans le corps et un champ `sentTimestamp`. Le code temporel d'envoi spécifie les microsecondes Unix depuis l'epoch d'envoi de la requête. Cela vous permet d'identifier les notifications relues. Voici un exemple d'URI : `https://us-central1-example-project-id.cloudfunctions.net/example-function-1`. L'URI doit utiliser HTTPS et pointer vers un site disposant d'un certificat SSL valide sur le serveur Web. L'URI doit comporter une chaîne maximale de 128 caractères et ne contenir que les caractères figurant sur la liste d'autorisation conformément au document RFC 1738. Lorsque votre serveur de webhook reçoit une notification, il doit renvoyer un code d'état de réponse HTTP 200 dans les cinq secondes. Veuillez indiquer un URI pour utiliser les notifications Webhook. Les requêtes adressées à ce serveur de webhook contiennent un jeton d'ID authentifiant le compte de service `google-analytics-audience-export@system.gserviceaccount.com`. Pour en savoir plus sur les jetons d'ID, consultez la page https://cloud.google.com/docs/authentication/token-types#id. Pour Google Cloud Functions, cela vous permet de configurer votre fonction pour qu'elle exige une authentification. Dans Cloud IAM, vous devez accorder les autorisations de compte de service aux rôles Demandeur Cloud Run (`roles/run.invoker`) et Demandeur Cloud Functions (`roles/cloudfunctions.invoker`) pour que la requête post-web puisse réussir l'authentification Google Cloud Functions. Cette API peut envoyer des notifications webhook à des URI arbitraires. Pour les serveurs de webhooks autres que Google Cloud Functions, ce jeton d'ID dans l'en-tête du support d'autorisation doit être ignoré s'il n'est pas nécessaire.
`channelToken`	`string` Facultatif. Le jeton de canal est une valeur de chaîne arbitraire et ne doit pas dépasser 64 caractères. Les jetons de canal vous permettent de vérifier la source d'une notification webhook. Cela permet d'éviter que le message ne soit usurpé. Le jeton de canal sera spécifié dans l'en-tête HTTP `X-Goog-Channel-Token` de la requête POST du webhook. Aucun jeton de canal n'est requis pour utiliser des notifications Webhook.

uri

string

Facultatif. Adresse Web qui recevra la notification webhook. Cette adresse recevra des requêtes POST lorsque l'état de la ressource d'opération de longue durée change. La requête POST contiendra à la fois une version JSON de la ressource d'opération de longue durée dans le corps et un champ sentTimestamp. Le code temporel d'envoi spécifie les microsecondes Unix depuis l'epoch d'envoi de la requête. Cela vous permet d'identifier les notifications relues.

Voici un exemple d'URI : https://us-central1-example-project-id.cloudfunctions.net/example-function-1.

L'URI doit utiliser HTTPS et pointer vers un site disposant d'un certificat SSL valide sur le serveur Web. L'URI doit comporter une chaîne maximale de 128 caractères et ne contenir que les caractères figurant sur la liste d'autorisation conformément au document RFC 1738.

Lorsque votre serveur de webhook reçoit une notification, il doit renvoyer un code d'état de réponse HTTP 200 dans les cinq secondes.

Veuillez indiquer un URI pour utiliser les notifications Webhook.

Les requêtes adressées à ce serveur de webhook contiennent un jeton d'ID authentifiant le compte de service google-analytics-audience-export@system.gserviceaccount.com. Pour en savoir plus sur les jetons d'ID, consultez la page https://cloud.google.com/docs/authentication/token-types#id. Pour Google Cloud Functions, cela vous permet de configurer votre fonction pour qu'elle exige une authentification. Dans Cloud IAM, vous devez accorder les autorisations de compte de service aux rôles Demandeur Cloud Run (roles/run.invoker) et Demandeur Cloud Functions (roles/cloudfunctions.invoker) pour que la requête post-web puisse réussir l'authentification Google Cloud Functions. Cette API peut envoyer des notifications webhook à des URI arbitraires. Pour les serveurs de webhooks autres que Google Cloud Functions, ce jeton d'ID dans l'en-tête du support d'autorisation doit être ignoré s'il n'est pas nécessaire.

channelToken

string

Facultatif. Le jeton de canal est une valeur de chaîne arbitraire et ne doit pas dépasser 64 caractères. Les jetons de canal vous permettent de vérifier la source d'une notification webhook. Cela permet d'éviter que le message ne soit usurpé. Le jeton de canal sera spécifié dans l'en-tête HTTP X-Goog-Channel-Token de la requête POST du webhook.

Aucun jeton de canal n'est requis pour utiliser des notifications Webhook.