Konfiguruje zasób długotrwałej operacji, aby wysyłać powiadomienie webhooka z interfejsu Google Analytics Data API do serwera webhooka, gdy zasób zostanie zaktualizowany.
Konfiguracje powiadomień zawierają wartości prywatne i są widoczne tylko dla Twojego projektu w Google Cloud Platform. Różne projekty GCP mogą dołączać różne powiadomienia webhooka do tego samego zasobu długotrwałej operacji.
Zapis JSON
{"uri": string,"channelToken": string}
Pola
uri
string
Opcjonalnie: Adres internetowy, na który będzie wysyłane powiadomienie webhook. Ten adres będzie otrzymywać żądania POST, gdy zmienia się stan zasobu długotrwałej operacji. Żądanie POST zawiera w treści zarówno wersję zasobu operacji długotrwałej w formacie JSON, jak i pole sentTimestamp. Wysłana sygnatura czasowa będzie określać mikrosekundy w systemie Unix od początku epoki, w której wysłano żądanie. Pozwoli to zidentyfikować odtworzone powiadomienia.
Przykładowy identyfikator URI to https://us-central1-example-project-id.cloudfunctions.net/example-function-1.
Identyfikator URI musi używać protokołu HTTPS i wskazywać witrynę z prawidłowym certyfikatem SSL na serwerze WWW. Adres URI musi mieć maksymalnie 128 znaków i zawierać tylko znaki wymienione w specyfikacji RFC 1738.
Gdy serwer webhooka otrzyma powiadomienie, powinien w ciągu 5 sekund odpowiedzieć kodem stanu odpowiedzi HTTP 200.
Aby korzystać z powiadomień webhook, musisz podać identyfikator URI.
Żądania wysyłane do tego serwera webhooka będą zawierać token identyfikacyjny uwierzytelniający konto usługi google-analytics-audience-export@system.gserviceaccount.com. Więcej informacji o tokenach tożsamości znajdziesz na stronie https://cloud.google.com/docs/authentication/token-types#id. W przypadku Google Cloud Functions możesz skonfigurować funkcję tak, aby wymagała uwierzytelniania. Aby przekazać żądanie przesłania webhooka do uwierzytelniania Google Cloud Functions, musisz w Cloud IAM przyznać uprawnienia do konta usługi do roli Wywołujący Cloud Run (roles/run.invoker) i Wywołujący Cloud Functions (roles/cloudfunctions.invoker). Ten interfejs API może wysyłać powiadomienia webhook do dowolnych adresów URI. W przypadku serwerów webhook innych niż Google Cloud Functions ten identyfikator tożsamości w nagłówku autoryzacji z uprawnieniami „Bearer” należy zignorować, jeśli nie jest potrzebny.
channelToken
string
Opcjonalnie: Token kanału to dowolny ciąg znaków, który może mieć maksymalnie 64 znaki. Tokeny kanału umożliwiają weryfikację źródła powiadomienia webhook. Zapobiega to podszywania się pod inną osobę. Token kanału będzie określony w nagłówku HTTP X-Goog-Channel-Token żądania POST webhooka.
Aby korzystać z powiadomień webhook, nie musisz mieć tokenu kanału.
[[["Łatwo zrozumieć","easyToUnderstand","thumb-up"],["Rozwiązało to mój problem","solvedMyProblem","thumb-up"],["Inne","otherUp","thumb-up"]],[["Brak potrzebnych mi informacji","missingTheInformationINeed","thumb-down"],["Zbyt skomplikowane / zbyt wiele czynności do wykonania","tooComplicatedTooManySteps","thumb-down"],["Nieaktualne treści","outOfDate","thumb-down"],["Problem z tłumaczeniem","translationIssue","thumb-down"],["Problem z przykładami/kodem","samplesCodeIssue","thumb-down"],["Inne","otherDown","thumb-down"]],["Ostatnia aktualizacja: 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,[]]
