WebhookNotification

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.