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 à votre serveur de webhooks depuis l'API Data de Google Analytics 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 de webhook. Cette adresse recevra des requêtes POST lorsque l'état de la ressource de l'opération de longue durée sera modifié. Le corps de la requête POST contiendra à la fois une version JSON de la ressource de l'opération de longue durée et un champ `sentTimestamp`. Le code temporel d'envoi spécifie les microsecondes unix depuis l'époque d'envoi de la requête. cela vous permet d'identifier les notifications relancées. 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. La chaîne de l'URI ne doit pas dépasser 128 caractères. n'utilisez que les caractères figurant sur la liste d'autorisation de la norme RFC 1738. Lorsque votre serveur de webhook reçoit une notification, il doit répondre avec un code d'état de réponse HTTP 200 dans un délai de cinq secondes. Un URI est requis 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 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 devrez accorder des autorisations de compte de service au demandeur Cloud Run (`roles/run.invoker`). Rôles de demandeur Cloud Functions (`roles/cloudfunctions.invoker`) pour que la requête de publication du webhook puisse transmettre 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 valider la source d'une notification webhook. Cela permet d'éviter le spoofing du message. Le jeton de canal sera spécifié dans l'en-tête HTTP `X-Goog-Channel-Token` de la requête POST du webhook. Un jeton de canal n'est pas nécessaire pour utiliser les notifications Webhook.

uri

string

Facultatif. Adresse Web qui recevra la notification de webhook. Cette adresse recevra des requêtes POST lorsque l'état de la ressource de l'opération de longue durée sera modifié. Le corps de la requête POST contiendra à la fois une version JSON de la ressource de l'opération de longue durée et un champ sentTimestamp. Le code temporel d'envoi spécifie les microsecondes unix depuis l'époque d'envoi de la requête. cela vous permet d'identifier les notifications relancées.

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. La chaîne de l'URI ne doit pas dépasser 128 caractères. n'utilisez que les caractères figurant sur la liste d'autorisation de la norme RFC 1738.

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

Un URI est requis 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 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 devrez accorder des autorisations de compte de service au demandeur Cloud Run (roles/run.invoker). Rôles de demandeur Cloud Functions (roles/cloudfunctions.invoker) pour que la requête de publication du webhook puisse transmettre 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 valider la source d'une notification webhook. Cela permet d'éviter le spoofing du message. Le jeton de canal sera spécifié dans l'en-tête HTTP X-Goog-Channel-Token de la requête POST du webhook.

Un jeton de canal n'est pas nécessaire pour utiliser les notifications Webhook.