WebhookNotification
Tetap teratur dengan koleksi
Simpan dan kategorikan konten berdasarkan preferensi Anda.
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 dalam isi dan kolom sentTimestamp . Stempel waktu yang dikirim akan menentukan mikrodetik Unix sejak epoch saat permintaan dikirim; hal 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 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, hal ini memungkinkan Anda 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 ) agar permintaan postingan webhook dapat lulus autentikasi Google Cloud Functions. API ini dapat mengirim notifikasi webhook ke URI arbitrer; untuk server webhook selain Google Cloud Functions, token ID ini di header pembawa otorisasi harus diabaikan jika tidak diperlukan.
|
channelToken |
string
Opsional. Token saluran adalah nilai string arbitrer dan harus memiliki panjang string maksimum 64 karakter. Token channel memungkinkan Anda memverifikasi sumber notifikasi webhook. Hal ini mencegah pesan di-spoofing. Token saluran akan ditentukan di header HTTP X-Goog-Channel-Token dari permintaan POST webhook. Token saluran tidak diperlukan untuk menggunakan notifikasi webhook.
|
Kecuali dinyatakan lain, konten di halaman ini dilisensikan berdasarkan Lisensi Creative Commons Attribution 4.0, sedangkan contoh kode dilisensikan berdasarkan Lisensi Apache 2.0. Untuk mengetahui informasi selengkapnya, lihat Kebijakan Situs Google Developers. Java adalah merek dagang terdaftar dari Oracle dan/atau afiliasinya.
Terakhir diperbarui pada 2024-11-20 UTC.
[[["Mudah dipahami","easyToUnderstand","thumb-up"],["Memecahkan masalah saya","solvedMyProblem","thumb-up"],["Lainnya","otherUp","thumb-up"]],[["Informasi yang saya butuhkan tidak ada","missingTheInformationINeed","thumb-down"],["Terlalu rumit/langkahnya terlalu banyak","tooComplicatedTooManySteps","thumb-down"],["Sudah usang","outOfDate","thumb-down"],["Masalah terjemahan","translationIssue","thumb-down"],["Masalah kode / contoh","samplesCodeIssue","thumb-down"],["Lainnya","otherDown","thumb-down"]],["Terakhir diperbarui pada 2024-11-20 UTC."],[[["Webhook notifications can be configured for long-running operations in the Google Analytics Data API to send updates to your server."],["These notifications are project-specific and include a JSON payload with operation details and a timestamp."],["The webhook configuration requires a URI using HTTPS with a valid SSL certificate, and optionally, a channel token for verification."],["When receiving a notification, your server should respond with an HTTP 200 status code within 5 seconds."],["Authentication for Google Cloud Functions is provided through an ID token representing the service account `google-analytics-audience-export@system.gserviceaccount.com`, while other webhook servers can ignore this token."]]],[]]