Menggunakan acara dari Google Chat

Halaman ini menjelaskan cara aplikasi Google Chat dapat menerima dan merespons peristiwa di Google Chat.

Peristiwa Google Chat mewakili aktivitas atau perubahan di 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.

Berikut beberapa contoh cara menggunakan peristiwa:

  • Pantau dan balas 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 membagikan 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 paling banyak.
  • Berkomunikasi di seluruh platform pesan. Misalnya, pengguna dapat mengirim dan menerima pesan dari pengguna dari 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. Peristiwa mengirimkan informasi tentang kapan aktivitas terjadi dan resource Chat API yang terpengaruh.

Chat mengategorikan acara menurut jenis. Jenis peristiwa hanya membantu Anda memfilter dan meminta jenis informasi yang Anda butuhkan, dan memungkinkan Anda menangani peristiwa serupa dengan cara yang sama.

Tabel berikut menunjukkan pengaruh aktivitas di Chat terhadap resource Chat API terkait, serta jenis peristiwa yang diterima aplikasi Chat Anda:

Aktivitas Referensi Chat API Jenis peristiwa
Pengguna memposting pesan di ruang Chat Resource Message dibuat. Pesan baru
Pengguna menjadi pengelola ruang. Resource Membership diperbarui. Keanggotaan yang diperbarui
Pengguna bereaksi pada pesan. Resource Reaction dibuat. Reaksi baru
Pengguna keluar dari ruang. Resource Membership dihapus. Langganan yang dihapus

Terima 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 dengan memanggil Chat API.

Google Workspace Events API dan Chat API mendukung dan mengirimkan jenis peristiwa yang sama. Untuk memahami apakah Anda harus berlangganan atau membuat kueri untuk peristiwa, tinjau tabel berikut:

Berlangganan peristiwa Kueri untuk peristiwa
Kasus penggunaan
  • Memproses atau merespons peristiwa secara real time.
  • Pantau aktivitas keanggotaan pengguna dan temukan ruang baru untuk dipantau.
  • Memproses atau merespons peristiwa secara berkala, atau melalui pemicu.
  • Mengambil peristiwa yang terlewatkan dari langganan (karena gangguan atau langganan tidak aktif).
API Google Workspace Events API Chat API
Sumber peristiwa Ruang dan pengguna Hanya spasi
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 mengetahui contoh payload, lihat dokumentasi referensi SpaceEvents.

Untuk mempelajari cara membuat langganan menggunakan Google Workspace Events API, lihat dokumentasi Google Workspace Events API. Untuk membuat kueri peristiwa menggunakan Chat API, lihat panduan berikut:

Batasan

  • Untuk langganan bagi pengguna, peristiwa tentang anggota baru dalam pesan langsung, atau chat grup tanpa nama (google.workspace.chat.membership.v1.created), hanya dipicu setelah pesan pertama diposting.
  • Perubahan pada histori ruang tidak memicu peristiwa ruang yang diperbarui (Jenis peristiwa: google.workspace.chat.spaces.v1.updated).
  • Untuk menerima peristiwa keanggotaan, pengguna harus menjadi anggota langsung ruang tersebut. Jika pengguna ditambahkan, diperbarui, atau dihapus secara tidak langsung ke ruang melalui Google Grup, langganan tidak akan menerima peristiwa keanggotaan tersebut. Untuk memahami cara kerja keanggotaan Google Grup, lihat Menambahkan grup Google ke ruang.