Diese Seite wurde von der Cloud Translation API übersetzt.

WebhookNotification

JSON-Darstellung

Konfiguriert eine Ressource mit langer Ausführungszeit, um eine Webhook-Benachrichtigung von der Google Analytics Data API an Ihren Webhook-Server zu senden, wenn die Ressource aktualisiert wird.

Benachrichtigungskonfigurationen enthalten private Werte und sind nur für Ihr GCP-Projekt sichtbar. Verschiedene GCP-Projekte können unterschiedliche Webhook-Benachrichtigungen an dieselbe Ressource für Vorgänge mit langer Ausführungszeit anhängen.

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

Felder

Felder
`uri`	`string` Optional. Die Webadresse, an die die Webhook-Benachrichtigung gesendet wird. An diese Adresse werden POST-Anfragen gesendet, wenn sich der Status der Ressource für Vorgänge mit langer Ausführungszeit ändert. Die POST-Anfrage enthält im Text eine JSON-Version der Ressource für Vorgänge mit langer Ausführungszeit und ein `sentTimestamp`-Feld. Der Zeitstempel für den Sendevorgang gibt die Unix-Mikrosekunden seit der Epoche an, in denen die Anfrage gesendet wurde. So können Sie wiederholte Benachrichtigungen identifizieren. Ein Beispiel-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 darf nur die Zeichen aus RFC 1738 auf der Zulassungsliste enthalten. Wenn Ihr Webhook-Server eine Benachrichtigung erhält, sollte er innerhalb von fünf Sekunden mit dem HTTP-Antwortstatuscode „200“ antworten. Für Webhook-Benachrichtigungen ist ein URI erforderlich. Anfragen an diesen Webhook-Server enthalten ein ID-Token, mit dem das Dienstkonto `google-analytics-audience-export@system.gserviceaccount.com` authentifiziert wird. Weitere Informationen zu ID-Tokens finden Sie unter https://cloud.google.com/docs/authentication/token-types#id. Für Google Cloud Functions können Sie auf diese Weise Ihre Funktion so konfigurieren, dass eine Authentifizierung erforderlich ist. In Cloud IAM müssen Sie den Rollen „Cloud Run Invoker“ (`roles/run.invoker`) und „Cloud Functions Invoker“ (`roles/cloudfunctions.invoker`) dem Dienstkonto Berechtigungen für die Webhook-Post-Anfrage gewähren, um die Google Cloud Functions-Authentifizierung zu übergeben. Diese API kann Webhook-Benachrichtigungen an beliebige URIs senden. Bei anderen Webhook-Servern als Google Cloud Functions sollte dieses ID-Token im Autorisierungsinhaberheader 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 können Sie die Quelle einer Webhook-Benachrichtigung überprüfen. So ist die Nachricht vor Spoofing geschützt. Das Kanaltoken wird im HTTP-Header `X-Goog-Channel-Token` der Webhook-POST-Anfrage angegeben. Für Webhook-Benachrichtigungen ist kein Kanaltoken erforderlich.

uri

string

Optional. Die Webadresse, an die die Webhook-Benachrichtigung gesendet wird. An diese Adresse werden POST-Anfragen gesendet, wenn sich der Status der Ressource für Vorgänge mit langer Ausführungszeit ändert. Die POST-Anfrage enthält im Text eine JSON-Version der Ressource für Vorgänge mit langer Ausführungszeit und ein sentTimestamp-Feld. Der Zeitstempel für den Sendevorgang gibt die Unix-Mikrosekunden seit der Epoche an, in denen die Anfrage gesendet wurde. So können Sie wiederholte Benachrichtigungen identifizieren.

Ein Beispiel-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 darf nur die Zeichen aus RFC 1738 auf der Zulassungsliste enthalten.

Wenn Ihr Webhook-Server eine Benachrichtigung erhält, sollte er innerhalb von fünf Sekunden mit dem HTTP-Antwortstatuscode „200“ antworten.

Für Webhook-Benachrichtigungen ist ein URI erforderlich.

Anfragen an diesen Webhook-Server enthalten ein ID-Token, mit dem das Dienstkonto google-analytics-audience-export@system.gserviceaccount.com authentifiziert wird. Weitere Informationen zu ID-Tokens finden Sie unter https://cloud.google.com/docs/authentication/token-types#id. Für Google Cloud Functions können Sie auf diese Weise Ihre Funktion so konfigurieren, dass eine Authentifizierung erforderlich ist. In Cloud IAM müssen Sie den Rollen „Cloud Run Invoker“ (roles/run.invoker) und „Cloud Functions Invoker“ (roles/cloudfunctions.invoker) dem Dienstkonto Berechtigungen für die Webhook-Post-Anfrage gewähren, um die Google Cloud Functions-Authentifizierung zu übergeben. Diese API kann Webhook-Benachrichtigungen an beliebige URIs senden. Bei anderen Webhook-Servern als Google Cloud Functions sollte dieses ID-Token im Autorisierungsinhaberheader 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 können Sie die Quelle einer Webhook-Benachrichtigung überprüfen. So ist die Nachricht vor Spoofing geschützt. Das Kanaltoken wird im HTTP-Header X-Goog-Channel-Token der Webhook-POST-Anfrage angegeben.

Für Webhook-Benachrichtigungen ist kein Kanaltoken erforderlich.