WebhookNotification

Kaynak güncellendiğinde Google Analytics Data API'den webhook sunucunuza 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 içerir 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. Uzun süren işlem kaynağının durumu değiştikçe bu adres POST istekleri alır. POST isteği, gövdede hem uzun süren işlem kaynağının JSON sürümünü hem de bir sentTimestamp alanı içerir. Gönderilen zaman damgası, isteğin gönderildiği epoch'tan sonraki unix mikrosaniyelerini belirtir. Bu, yeniden oynatılan bildirimleri belirlemenize olanak tanır.

Örnek bir URI: https://us-central1-example-project-id.cloudfunctions.net/example-function-1.

URI, HTTPS'yi kullanmalı ve web sunucusunda geçerli bir SSL sertifikası olan bir siteye işaret etmelidir. URI'nin maksimum dize uzunluğu 128 karakter olmalı ve yalnızca RFC 1738'deki izin verilen karakterleri kullanmalıdır.

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

Webhook bildirimlerini kullanmak için bir URI gereklidir.

Bu webhook sunucusuna gönderilen istekler, google-analytics-audience-export@system.gserviceaccount.com hizmet hesabının kimliğini doğrulayan bir kimlik jetonu içerir. 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. Webhook gönderme isteğinin Google Cloud Functions kimlik doğrulamasını geçmesi için Cloud IAM'da hizmet hesabına Cloud Run Çağırıcı (roles/run.invoker) ve Cloud Functions Çağırıcı (roles/cloudfunctions.invoker) rollerine izin vermeniz gerekir. Bu API, rastgele URI'lere webhook bildirimleri gönderebilir. Google Cloud Functions dışındaki webhook sunucuları için, yetkilendirme taşıyıcı başlığındaki bu kimlik jetonu gerekmiyorsa yoksayılmalıdır.

channelToken

string

İsteğe bağlı. Kanal jetonu, rastgele bir dize değeridir ve maksimum 64 karakter uzunluğunda olmalıdır. Kanal jetonları, webhook bildiriminin kaynağını doğrulamanıza olanak tanır. Bu, mesajın adres sahteciliğine karşı korunmasını sağlar. Kanal jetonu, webhook POST isteğinin X-Goog-Channel-Token HTTP üst bilgisinde belirtilir.

Webhook bildirimlerini kullanmak için kanal jetonu gerekmez.