WebhookNotification

Kaynak güncellendiğinde Google Analytics Data API'den webhook sunucunuza bir webhook bildirimi göndermek için uzun süreli 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üreli işlem kaynağının durumu değiştikçe bu adres POST istekleri alır. POST isteği, gövdede uzun süre çalışan işlem kaynağının hem 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 mikrosaniye değerlerini belirtir. Bu sayede, tekrar oynatılan bildirimleri belirleyebilirsiniz.

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

URI HTTPS kullanmalı ve web sunucusunda geçerli SSL sertifikası olan bir siteyi işaret etmelidir. URI'nın en fazla 128 karakter uzunluğunda olması ve yalnızca RFC 1738'deki izin verilenler listesine eklenmiş karakterleri kullanması gerekir.

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

Webhook bildirimlerini kullanmak için URI gerekir.

Bu webhook sunucusuna yapılan istekler, google-analytics-audience-export@system.gserviceaccount.com hizmet hesabını 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ğrulaması gerektirecek şekilde yapılandırmanıza olanak tanır. Cloud IAM'de, webhook yayın isteğinin Google Cloud Functions kimlik doğrulamasını geçmesi için Cloud Run Çağırıcısı (roles/run.invoker) ve Cloud Functions Çağırıcısı (roles/cloudfunctions.invoker) rollerine hizmet hesabı izinlerini 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, 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 bir dize olmalıdır. Kanal jetonları, webhook bildirimlerinin kaynağını doğrulamanıza olanak tanır. Bu seçenek, adres sahteciliğine karşı koruma sağlar. Kanal jetonu, webhook POST isteğinin X-Goog-Channel-Token HTTP üst bilgisinde belirtilir.

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