WebhookNotification

• JSON-Darstellung

Hiermit wird eine langlaufende Vorgangsressource konfiguriert, um bei einer Aktualisierung der Ressource eine Webhook-Benachrichtigung von der Google Analytics Data API an Ihren Webhook-Server zu senden.

Benachrichtigungskonfigurationen enthalten private Werte und sind nur für Ihr GCP-Projekt sichtbar. Unterschiedliche GCP-Projekte können derselben Ressource für langlaufende Vorgänge unterschiedliche Webhook-Benachrichtigungen zuordnen.

JSON-Darstellung
{ "uri": string, "channelToken": string }

Felder
uri	string Optional. Die Webadresse, an die die Webhook-Benachrichtigung gesendet werden soll. Diese Adresse erhält POST-Anfragen, wenn sich der Status der Ressource für den lang laufenden Vorgang ändert. Die POST-Anfrage enthält sowohl eine JSON-Version der Ressource für den lang laufenden Vorgang im Text als auch ein sentTimestamp-Feld. Der gesendete Zeitstempel gibt die Unix-Mikrosekunden seit der Epoche an, zu der die Anfrage gesendet wurde. So können Sie wiederholte Benachrichtigungen erkennen. Ein Beispiel für einen URI ist https://us-central1-example-project-id.cloudfunctions.net/example-function-1. Der URI muss HTTPS verwenden und auf eine Website mit einem gültigen SSL-Zertifikat auf dem Webserver verweisen. Der URI darf maximal 128 Zeichen lang sein und nur die Zeichen aus der Zulassungsliste von RFC 1738 enthalten. Wenn Ihr Webhook-Server eine Benachrichtigung empfängt, sollte er innerhalb von 5 Sekunden mit dem HTTP-Antwortstatuscode 200 antworten. Für die Verwendung von Webhook-Benachrichtigungen ist ein URI erforderlich. Anfragen an diesen Webhook-Server enthalten ein ID-Token, mit dem das Dienstkonto [e-mail] authentifiziert wird. Weitere Informationen zu ID-Tokens finden Sie unter https://cloud.google.com/docs/authentication/token-types#id. Bei Google Cloud Functions können Sie Ihre Funktion so konfigurieren, dass eine Authentifizierung erforderlich ist. In Cloud IAM müssen Sie dem Dienstkonto die Berechtigungen für die Rollen „Cloud Run-Aufrufer“ (roles/run.invoker) und „Cloud Functions-Aufrufer“ (roles/cloudfunctions.invoker) erteilen, damit die Webhook-Postanfrage die Google Cloud Functions-Authentifizierung besteht. Diese API kann Webhook-Benachrichtigungen an beliebige URIs senden. Bei anderen Webhook-Servern als Google Cloud Functions sollte dieses ID-Token im Autorisierungs-Bearer-Header ignoriert werden, wenn es nicht benötigt wird.
channelToken	string Optional. Das Kanaltoken ist ein beliebiger Stringwert und darf maximal 64 Zeichen lang sein. Mit Kanaltokens kannst du die Quelle einer Webhook-Benachrichtigung überprüfen. So wird verhindert, dass die Nachricht gefälscht wird. Das Kanaltoken wird im X-Goog-Channel-Token-HTTP-Header der Webhook-POST-Anfrage angegeben. Für die Verwendung von Webhook-Benachrichtigungen ist kein Kanaltoken erforderlich.