WebhookNotification

Konfiguruje zasób długo trwającej operacji, który wysyła powiadomienie webhook z interfejsu Google Analytics Data API do serwera webhooka, gdy zasób jest aktualizowany.

Konfiguracje powiadomień zawierają wartości prywatne & są widoczne tylko dla Twojego projektu GCP. Różne projekty GCP mogą dołączać różne powiadomienia webhook 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 w miarę zmian zasobów długo trwającej operacji. Żądanie POST będzie zawierać zarówno wersję JSON zasobu długo trwającej operacji w treści, jak i pole sentTimestamp. Sygnatura czasowa wysłania będzie określać liczbę mikrosekund uniksowych od początku epoki, w której wysłano żądanie. pozwala zidentyfikować ponownie odtwarzane powiadomienia.

Przykładowy identyfikator URI to https://us-central1-example-project-id.cloudfunctions.net/example-function-1.

Identyfikator URI musi korzystać z protokołu HTTPS i wskazywać witrynę na serwerze WWW z ważnym certyfikatem SSL. Identyfikator URI może mieć maksymalnie 128 znaków w ciągu znaków & używaj tylko znaków dozwolonych w standardzie RFC 1738.

Gdy serwer webhooka otrzyma powiadomienie, powinien w ciągu 5 sekund odpowiedzieć z kodem stanu odpowiedzi HTTP 200.

Do korzystania z powiadomień webhooka wymagany jest identyfikator URI.

Żądania wysyłane do tego serwera webhooka będą zawierać token identyfikatora służący do uwierzytelniania konta usługi google-analytics-audience-export@system.gserviceaccount.com. Więcej informacji o tokenach identyfikatorów znajdziesz na stronie https://cloud.google.com/docs/authentication/token-types#id. W przypadku Google Cloud Functions umożliwia to skonfigurowanie funkcji tak, aby wymagała uwierzytelniania. W Cloud IAM musisz przyznać uprawnienia konta usługi wywołującemu Cloud Run (roles/run.invoker) oraz Role wywołującego funkcje Cloud Functions (roles/cloudfunctions.invoker) w żądaniu postu webhooka, który przekazuje uwierzytelnianie Google Cloud Functions. Ten interfejs API może wysyłać powiadomienia webhook do dowolnych identyfikatorów URI. w przypadku serwerów webhooków innych niż Google Cloud Functions, token identyfikatora w nagłówku okaziciela autoryzacji powinien zostać zignorowany, jeśli nie jest potrzebny.

channelToken

string

Opcjonalnie: Token kanału jest wartością dowolnego ciągu znaków, o maksymalnej długości 64 znaków. Tokeny kanału umożliwiają zweryfikowanie źródła powiadomienia webhook. Zapewnia to ochronę przed sfałszowaniem wiadomości. Token kanału zostanie określony w nagłówku HTTP X-Goog-Channel-Token żądania POST webhooka.

Do korzystania z powiadomień webhook nie jest wymagany token kanału.