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 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. 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.
[[["Leicht verständlich","easyToUnderstand","thumb-up"],["Mein Problem wurde gelöst","solvedMyProblem","thumb-up"],["Sonstiges","otherUp","thumb-up"]],[["Benötigte Informationen nicht gefunden","missingTheInformationINeed","thumb-down"],["Zu umständlich/zu viele Schritte","tooComplicatedTooManySteps","thumb-down"],["Nicht mehr aktuell","outOfDate","thumb-down"],["Problem mit der Übersetzung","translationIssue","thumb-down"],["Problem mit Beispielen/Code","samplesCodeIssue","thumb-down"],["Sonstiges","otherDown","thumb-down"]],["Zuletzt aktualisiert: 2025-07-26 (UTC)."],[[["\u003cp\u003eWebhook notifications can be configured for long-running operations in the Google Analytics Data API to send updates to your server.\u003c/p\u003e\n"],["\u003cp\u003eThese notifications are project-specific and include a JSON payload with operation details and a timestamp.\u003c/p\u003e\n"],["\u003cp\u003eThe webhook configuration requires a URI using HTTPS with a valid SSL certificate, and optionally, a channel token for verification.\u003c/p\u003e\n"],["\u003cp\u003eWhen receiving a notification, your server should respond with an HTTP 200 status code within 5 seconds.\u003c/p\u003e\n"],["\u003cp\u003eAuthentication for Google Cloud Functions is provided through an ID token representing the service account \u003ccode\u003egoogle-analytics-audience-export@system.gserviceaccount.com\u003c/code\u003e, while other webhook servers can ignore this token.\u003c/p\u003e\n"]]],["This document outlines the configuration for webhook notifications from the Google Analytics Data API. You can set up a webhook server (`uri`) to receive POST requests containing long-running operation resource updates in JSON format, along with a `sentTimestamp`. The `uri` must be HTTPS with a valid SSL certificate and is required for webhook notifications. Optionally, use a `channelToken` for source verification, which is included in the `X-Goog-Channel-Token` header. Notifications will include an ID token for authentication.\n"],null,[]]
