WebhookNotification

• Representasi JSON

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 saat status resource operasi yang berjalan lama berubah. Permintaan POST akan berisi versi JSON dari resource operasi yang berjalan lama di bagian isi dan kolom sentTimestamp. Stempel waktu yang dikirim akan menentukan mikrodetik unix sejak epoch permintaan dikirim; ini memungkinkan Anda mengidentifikasi notifikasi yang diputar ulang. 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 harus memiliki panjang string maksimum 128 karakter & hanya gunakan karakter yang diizinkan dari RFC 1738. Saat menerima notifikasi, server webhook Anda diharapkan akan 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 [e-mail]. Untuk mempelajari token ID lebih lanjut, lihat https://cloud.google.com/docs/authentication/token-types#id. Untuk Google Cloud Functions, konfigurasi ini memungkinkan Anda mengonfigurasi fungsi untuk mewajibkan autentikasi. Di Cloud IAM, Anda perlu memberikan izin akun layanan ke Cloud Run Invoker (roles/run.invoker) & Peran Cloud Functions Invoker (roles/cloudfunctions.invoker) untuk permintaan postingan webhook agar dapat meneruskan autentikasi Google Cloud Functions. API ini dapat mengirim notifikasi webhook ke URI arbitrer; untuk server webhook selain Google Cloud Functions, token ID di header pemilik 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 dari pesan yang dipalsukan. Token channel akan ditentukan di header HTTP X-Goog-Channel-Token dari permintaan POST webhook. Token channel tidak diperlukan untuk menggunakan notifikasi webhook.