WebhookNotification

Mit dieser Konfiguration wird eine Vorgangsressource mit langer Ausführungszeit so konfiguriert, dass eine Webhook-Benachrichtigung von der Google Analytics Data API an Ihren Webhook-Server gesendet wird, 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 Vorgangsressource mit langer Ausführungszeit anhängen.

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

string

Optional. Die Webadresse, an die die Webhook-Benachrichtigung gesendet wird. Diese Adresse erhält POST-Anfragen, wenn sich der Status der Vorgangsressource mit langer Ausführungszeit ändert. Die POST-Anfrage enthält sowohl eine JSON-Version der Vorgangsressource mit langer Ausführungszeit im Text als auch ein sentTimestamp-Feld. Der Zeitstempel „Gesendet“ gibt die Unix-Mikrosekunden seit der Epoche an, in der die Anfrage gesendet wurde. So kannst du wiederholte Benachrichtigungen erkennen.

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. Die URI darf maximal eine Stringlänge von 128 Zeichen haben. Verwenden Sie nur die Zeichen aus der Zulassungsliste aus RFC 1738.

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

Zur Verwendung von 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 die Funktion so konfigurieren, dass eine Authentifizierung erforderlich ist. In Cloud IAM müssen Sie dem Cloud Run-Aufrufer (roles/run.invoker) die Dienstkontoberechtigungen gewähren und Cloud Functions-Invoker-Rollen (roles/cloudfunctions.invoker) für die Webhook-Post-Anfrage, um die Google Cloud Functions-Authentifizierung zu bestehen. Diese API kann Webhook-Benachrichtigungen an beliebige URIs senden. Bei anderen Webhook-Servern als Google Cloud Functions sollte dieses ID-Token im Autorisierungsinhaber-Header ignoriert werden, wenn es nicht benötigt wird.

channelToken

string

Optional. Das Kanaltoken ist ein beliebiger Stringwert und muss eine maximale Stringlänge von 64 Zeichen haben. Mit Kanaltokens können Sie die Quelle einer Webhook-Benachrichtigung überprüfen. Dies schützt vor Spoofing. Das Kanaltoken wird im X-Goog-Channel-Token-HTTP-Header der Webhook-POST-Anfrage angegeben.

Für Webhook-Benachrichtigungen ist kein Kanaltoken erforderlich.