WebhookNotification

Mengonfigurasi resource operasi yang berjalan lama untuk mengirim notifikasi webhook dari Google Analytics Data API ke server webhook Anda saat resource diperbarui.

Konfigurasi notifikasi berisi nilai pribadi & hanya dapat dilihat oleh project GCP Anda. Project GCP yang berbeda dapat melampirkan notifikasi webhook yang berbeda ke resource operasi yang berjalan lama yang sama.

Representasi JSON 
{
  "uri": string,
  "channelToken": string
}
Kolom
uri

string

Opsional. Alamat web yang akan menerima notifikasi webhook. Alamat ini akan menerima permintaan POST karena status resource operasi yang berjalan lama berubah. Permintaan POST akan berisi versi JSON dari resource operasi yang berjalan lama dalam isi dan kolom sentTimestamp. Stempel waktu yang dikirim akan menentukan mikrodetik unix sejak epoch permintaan dikirim; hal ini memungkinkan Anda mengidentifikasi notifikasi yang di-replay.

Contoh URI adalah https://us-central1-example-project-id.cloudfunctions.net/example-function-1.

URI harus menggunakan HTTPS dan mengarah ke situs dengan sertifikat SSL yang valid di server web. URI ini harus memiliki panjang string maksimum 128 karakter & hanya menggunakan karakter yang diizinkan dari RFC 1738.

Saat menerima notifikasi, server webhook Anda diharapkan membalas dengan kode status respons HTTP 200 dalam waktu 5 detik.

URI diperlukan untuk menggunakan notifikasi webhook.

Permintaan ke server webhook ini akan berisi token ID yang mengautentikasi akun layanan google-analytics-audience-export@system.gserviceaccount.com. Untuk mempelajari token ID lebih lanjut, lihat https://cloud.google.com/docs/authentication/token-types#id. Untuk Google Cloud Functions, Anda dapat mengonfigurasi fungsi agar mewajibkan autentikasi. Di Cloud IAM, Anda harus memberikan izin akun layanan ke peran Cloud Run Invoker (roles/run.invoker) & Cloud Functions Invoker (roles/cloudfunctions.invoker) untuk permintaan postingan webhook agar dapat lulus autentikasi Google Cloud Functions. API ini dapat mengirim notifikasi webhook ke URI arbitrer; untuk server webhook selain Google Cloud Functions, token ID dalam header pembawa otorisasi ini harus diabaikan jika tidak diperlukan.
channelToken

string

Opsional. Token saluran adalah nilai string arbitrer dan harus memiliki panjang string maksimum 64 karakter. Token saluran memungkinkan Anda memverifikasi sumber notifikasi webhook. Hal ini melindungi pesan yang di-spoofing. Token saluran akan ditentukan dalam header HTTP X-Goog-Channel-Token dari permintaan POST webhook.

Token saluran tidak diperlukan untuk menggunakan notifikasi webhook.