Halaman ini menjelaskan cara aplikasi Google Chat dapat menerima dan merespons peristiwa di Google Chat.
Peristiwa Google Chat mewakili aktivitas atau perubahan dalam Chat, seperti pesan baru dalam ruang. Aplikasi Chat Anda dapat menggunakan peristiwa untuk memahami apa yang terjadi dan mengambil tindakan atau merespons dengan cara yang bermakna bagi pengguna Anda.
Berikut beberapa contoh cara menggunakan peristiwa:
- Pantau dan tanggapi pesan baru dalam ruang, seperti memeriksa kata kunci atau frasa.
- Kirim pesan selamat datang kepada pengguna saat mereka bergabung ke ruang, untuk menjelaskan panduan ruang atau bagikan tips tentang cara menggunakan aplikasi Chat secara efektif.
- Melacak dan menganalisis aktivitas Chat. Misalnya, untuk mengirim laporan bulanan tentang anggota baru atau pesan yang mendapatkan reaksi atau balasan terbanyak.
- Berkomunikasi di berbagai platform pesan. Misalnya, pengguna dapat mengirim dan menerima pesan dari pengguna di platform pesan lain tanpa keluar dari Chat.
Cara kerja peristiwa
Setiap kali terjadi sesuatu di Google Chat, resource Google Chat API dibuat, diperbarui, atau dihapus. Chat menggunakan peristiwa untuk mengirimkan informasi ke aplikasi Chat Anda tentang jenis aktivitas yang terjadi, dan resource Chat API yang terpengaruh.
Chat mengategorikan acara berdasarkan jenis. Jenis peristiwa membantu Anda memfilter dan menerima hanya jenis informasi yang diperlukan, serta memungkinkan Anda menangani aktivitas serupa dengan cara yang sama.
Tabel berikut menunjukkan pengaruh aktivitas di Chat terhadap resource Chat API terkait, dan jenis peristiwa yang diterima aplikasi Chat Anda:
Aktivitas | Resource Chat API | Jenis peristiwa |
---|---|---|
Pengguna memposting pesan di ruang Chat | Resource Message dibuat. |
Pesan baru |
Pengguna akan menjadi pengelola ruang. | Resource Membership diperbarui. |
Keanggotaan diperbarui |
Pengguna bereaksi pada pesan. | Resource Reaction dibuat. |
Reaksi baru |
Pengguna keluar dari ruang. | Resource Membership dihapus. |
Keanggotaan dihapus |
Menerima peristiwa dari Google Chat
Untuk menerima peristiwa, aplikasi Chat Anda dapat melakukan salah satu hal berikut:
- Berlangganan peristiwa menggunakan Google Workspace Events API untuk menerima peristiwa saat terjadi.
- Buat kueri untuk peristiwa terbaru dengan memanggil Chat API.
Tabel berikut menjelaskan perbedaan dan alasan untuk membuat kueri atau berlangganan peristiwa:
Berlangganan peristiwa | Kueri untuk peristiwa | |
---|---|---|
Kasus penggunaan |
|
|
API | Google Workspace Events API | Chat API |
Sumber peristiwa | Ruang dan pengguna | Hanya spasi |
Peristiwa yang didukung |
Untuk mengetahui daftar jenis peristiwa yang didukung, lihat Jenis peristiwa untuk membuat langganan dalam dokumentasi Google Workspace Events API. |
Untuk mengetahui daftar jenis peristiwa yang didukung, lihat resource spaceEvents dalam dokumentasi referensi Chat API.
|
Format peristiwa | Pesan Google Cloud Pub/Sub, yang diformat sesuai dengan spesifikasi CloudEvent. Untuk mengetahui detailnya, lihat Struktur peristiwa Google Workspace. |
Resource Chat API
(
spaces.spaceEvent )
|
Data peristiwa | String berenkode base64 dengan atau tanpa data resource. Untuk contoh payload, lihat Data peristiwa. | Payload JSON yang berisi data resource. Beberapa jenis peristiwa hanya menyertakan kolom resource tertentu. Untuk contoh payload, lihat dokumentasi referensi. |
Contoh: Membuat kueri atau berlangganan ke peristiwa tentang keanggotaan dalam ruang
Dalam contoh ini, aplikasi Chat ingin menerima informasi tentang perubahan pada anggota ruang Chat. Di ruang, aktivitas keanggotaan berikut terjadi:
- Pengguna bergabung ke ruang, yang membuat resource
Membership
dan memicu peristiwa anggota baru. - Pengguna menjadi pengelola ruang, yang memperbarui resource
Membership
untuk pengguna dan memicu peristiwa anggota yang diperbarui. - Pengguna meninggalkan ruang, yang akan menghapus resource
Membership
untuk pengguna dan memicu peristiwa penghapusan anggota.
Berlangganan acara keanggotaan
Untuk menerima peristiwa secara real time, aplikasi Chat memanggil metode subscriptions.create()
Google Workspace Events API untuk berlangganan ruang bagi semua jenis acara langganan. Setelah
membuat langganan, aplikasi Chat dapat mulai
menerima peristiwa keanggotaan.
Pada Gambar 2, aplikasi Chat memiliki langganan aktif ruang, sehingga aplikasi menerima peristiwa setiap kali keanggotaan dalam ruang berubah. Kemudian, aplikasi Chat dapat memproses atau merespons aktivitas apa pun secara real time, seperti memposting pesan selamat datang pribadi kepada anggota yang bergabung ke ruang.
Untuk mempelajari cara membuat langganan menggunakan Google Workspace Events API, lihat dokumentasi Google Workspace Events API.
Kueri untuk peristiwa keanggotaan terbaru
Daripada menerima peristiwa keanggotaan saat terjadi, aplikasi Chat dapat memanggil Chat API untuk mencantumkan peristiwa ruang terbaru yang terkait dengan aktivitas keanggotaan.
Pada Gambar 3, aplikasi Chat memanggil metode
spaces.spaceEvents.list()
Chat API setelah semua aktivitas keanggotaan terjadi, dan memfilter kueri
untuk peristiwa keanggotaan baru, yang diperbarui, dan dihapus. Chat API menampilkan
daftar resource spaceEvent
yang mewakili setiap perubahan keanggotaan.
Kemudian, aplikasi Chat dapat memproses atau merespons berdasarkan
aktivitas terbaru, seperti memposting pesan mingguan yang berisi ringkasan
aktivitas keanggotaan ruang dalam 7 hari terakhir.
Untuk membuat kueri peristiwa menggunakan Chat API, lihat Mencantumkan peristiwa dari ruang Google Chat.
Batasan
-
Untuk langganan bagi pengguna, peristiwa terkait anggota baru di pesan langsung atau chat grup tanpa nama (
google.workspace.chat.membership.v1.created
), hanya dipicu setelah pesan pertama diposting. - Untuk menerima acara keanggotaan, pengguna harus menjadi anggota langsung ruang. Jika pengguna ditambahkan, diperbarui, atau dihapus secara tidak langsung ke ruang melalui grup Google, langganan tidak akan menerima peristiwa keanggotaan tersebut. Untuk memahami cara kerja keanggotaan Google Grup, lihat Menambahkan grup Google ke ruang.
Topik terkait
- Ringkasan Google Workspace Events API
- Membuat langganan
- Mendapatkan detail tentang acara ruang Google Chat
- Mencantumkan peristiwa dari ruang Google Chat
- Untuk contoh cara menggunakan peristiwa, lihat tutorial Menjawab pertanyaan berdasarkan percakapan Chat dengan aplikasi Gemini AI Chat atau fitur bantuan inklusivitas aplikasi Chat pengelolaan masalah di codelab Membangun aplikasi untuk Google Chat dengan Gemini.