WebhookNotification

Konfiguruje zasób długotrwałej operacji do wysłania powiadomienia webhooka z interfejsu Google Analytics Data API do serwera webhooka po zaktualizowaniu zasobu.

Konfiguracje powiadomień zawierają wartości prywatne i są widoczne tylko dla Twojego projektu GCP. Różne projekty GCP mogą dołączać różne powiadomienia webhooka do tego samego zasobu długo trwającej operacji.

Zapis JSON 
{
  "uri": string,
  "channelToken": string
}
Pola
uri

string

Opcjonalnie. Adres internetowy, na który ma zostać wysłane powiadomienie webhook. Ten adres będzie otrzymywać żądania POST w miarę zmian stanu zasobów długo trwającej operacji. Żądanie POST będzie zawierać wersję JSON zasobu długo trwającej operacji w treści oraz pole sentTimestamp. Sygnatura czasowa wysłania określa liczbę mikrosekund uniksowych od momentu wysłania żądania. Pozwala to na identyfikowanie powiadomień odtwarzanych ponownie.

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

Identyfikator URI musi korzystać z protokołu HTTPS i wskazywać witrynę z prawidłowym certyfikatem SSL na serwerze WWW. Identyfikator URI musi mieć maksymalnie 128 znaków i może zawierać wyłącznie znaki dozwolone w RFC 1738.

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

Aby korzystać z powiadomień webhook, wymagany jest identyfikator URI.

Żądania wysyłane do tego serwera webhooka będą zawierać token identyfikatora uwierzytelniający konto 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 w taki sposób, aby wymagała uwierzytelniania. W Cloud IAM musisz przyznać uprawnienia konta usługi rolom wywołującego w Cloud Run (roles/run.invoker) i wywołującego funkcje Cloud Functions (roles/cloudfunctions.invoker) na potrzeby żądania posta webhooka, aby przejść uwierzytelnianie w 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 ten token identyfikatora w nagłówku okaziciela autoryzacji należy zignorować.
channelToken

string

Opcjonalnie. Token kanału to dowolny ciąg znaków o maksymalnej długości 64 znaków. Tokeny kanału umożliwiają weryfikację źródła powiadomienia webhooka. Chroni to 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.