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 de l'API Google Analytics Data à votre serveur 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 de 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 du webhook. Cette adresse recevra des requêtes POST à mesure que l'état de la ressource d'opération de longue durée changera. La requête POST contient à 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 envoyé spécifie les microsecondes Unix depuis l'époque à laquelle la requête a été envoyée. Cela vous permet d'identifier les notifications rejouées. 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. La longueur maximale de la chaîne de l'URI doit être de 128 caractères et ne doit utiliser que les caractères de la liste d'autorisation de la RFC 1738. Lorsque votre serveur webhook reçoit une notification, il doit répondre avec un code d'état de réponse HTTP 200 dans les cinq secondes. Un URI est nécessaire pour utiliser les notifications webhook. Les requêtes envoyées à ce serveur 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'identification, 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 nécessite une authentification. Dans Cloud IAM, vous devez accorder les autorisations du 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 du webhook puisse transmettre l'authentification Google Cloud Functions. Cette API peut envoyer des notifications webhook à des URI arbitraires. Pour les serveurs webhook autres que Google Cloud Functions, ce jeton d'identification dans l'en-tête de l'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 doit comporter 64 caractères maximum. Les jetons de canal vous permettent de vérifier la source d'une notification webhook. Cela permet d'éviter que le message ne soit falsifié. Le jeton de chaîne sera spécifié dans l'en-tête HTTP `X-Goog-Channel-Token` de la requête POST du webhook. Vous n'avez pas besoin d'un jeton de canal pour utiliser les notifications webhook.

uri

string

Facultatif. Adresse Web qui recevra la notification du webhook. Cette adresse recevra des requêtes POST à mesure que l'état de la ressource d'opération de longue durée changera. La requête POST contient à 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 envoyé spécifie les microsecondes Unix depuis l'époque à laquelle la requête a été envoyée. Cela vous permet d'identifier les notifications rejouées.

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. La longueur maximale de la chaîne de l'URI doit être de 128 caractères et ne doit utiliser que les caractères de la liste d'autorisation de la RFC 1738.

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

Un URI est nécessaire pour utiliser les notifications webhook.

Les requêtes envoyées à ce serveur 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'identification, 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 nécessite une authentification. Dans Cloud IAM, vous devez accorder les autorisations du 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 du webhook puisse transmettre l'authentification Google Cloud Functions. Cette API peut envoyer des notifications webhook à des URI arbitraires. Pour les serveurs webhook autres que Google Cloud Functions, ce jeton d'identification dans l'en-tête de l'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 doit comporter 64 caractères maximum. Les jetons de canal vous permettent de vérifier la source d'une notification webhook. Cela permet d'éviter que le message ne soit falsifié. Le jeton de chaîne sera spécifié dans l'en-tête HTTP X-Goog-Channel-Token de la requête POST du webhook.

Vous n'avez pas besoin d'un jeton de canal pour utiliser les notifications webhook.