WebhookNotification

Kaynak güncellendiğinde Google Analytics Data API'den webhook sunucunuza bir webhook bildirimi göndermek için uzun süreli bir işlem kaynağını yapılandırır.

Bildirim yapılandırmaları gizli değerler ve yalnızca GCP projeniz tarafından görülebilir. Farklı GCP projeleri, aynı uzun süreli işlem kaynağına farklı webhook bildirimleri ekleyebilir.

JSON gösterimi
{
  "uri": string,
  "channelToken": string
}
Alanlar
uri

string

İsteğe bağlı. Webhook bildirimini alacak web adresi. Bu adres, uzun süreli işlem kaynağının durumu değiştikçe POST istekleri alır. POST isteği, gövdede hem uzun çalışan işlem kaynağının JSON sürümünü hem de sentTimestamp alanını içerir. Gönderilen zaman damgası, isteğin gönderildiği dönemden bu yana geçen unix mikrosaniyeyi belirtir. bu, tekrar oynatılan bildirimleri tanımlamanızı sağlar.

https://us-central1-example-project-id.cloudfunctions.net/example-function-1 URI'sı buna örnek olarak verilebilir.

URI, HTTPS kullanmalı ve web sunucusunda geçerli bir SSL sertifikası olan bir siteyi göstermelidir. URI'nın en fazla 128 karakter uzunluğunda bir dize olması gerekir. yalnızca RFC 1738'de izin verilenler listesindeki karakterleri kullanın.

Webhook sunucunuz bir bildirim aldığında, 5 saniye içinde 200 kodlu bir HTTP yanıt durum koduyla yanıt vermesi beklenir.

Webhook bildirimlerini kullanmak için URI gereklidir.

Bu webhook sunucusuna gönderilen istekler, google-analytics-audience-export@system.gserviceaccount.com hizmet hesabını doğrulayan bir kimlik jetonu içerecek. Kimlik jetonları hakkında daha fazla bilgi edinmek için https://cloud.google.com/docs/authentication/token-types#id adresini ziyaret edin. Google Cloud Functions için bu, işlevinizi kimlik doğrulama gerektirecek şekilde yapılandırmanıza olanak tanır. Cloud IAM'de hizmet hesabı izinlerini Cloud Run Çağırıcısı'na (roles/run.invoker) ve Google Cloud Functions kimlik doğrulamasını geçen webhook yayını isteği için Cloud Functions Çağırıcısı (roles/cloudfunctions.invoker) rolleri. Bu API, rastgele URI'lere webhook bildirimleri gönderebilir; Yetkilendirme sahibi başlığındaki bu kimlik jetonu, gerekli değilse yoksayılmalıdır.

channelToken

string

İsteğe bağlı. Kanal jetonu rastgele bir dize değeridir ve en fazla 64 karakter uzunluğunda olmalıdır. Kanal jetonları, bir webhook bildiriminin kaynağını doğrulamanıza olanak tanır. Bu da iletinin adres sahteciliğine maruz bırakılmasına karşı koruma sağlar. Kanal jetonu, webhook POST isteğinin X-Goog-Channel-Token HTTP başlığında belirtilir.

Webhook bildirimlerini kullanmak için kanal jetonu gerekli değildir.