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 dalam Chat, seperti pesan baru dalam ruang. Aplikasi Chat Anda dapat menggunakan peristiwa untuk memahami apa yang terjadi dan mengambil tindakan atau menanggapi dengan bagi pengguna Anda.

Berikut beberapa contoh cara menggunakan peristiwa:

  • Memantau dan merespons pesan baru dalam ruang, seperti memeriksa kunci kata atau frasa.
  • Untuk menjelaskan ruang, kirim pesan selamat datang kepada pengguna saat mereka bergabung ke ruang panduan atau berbagi kiat tentang cara menggunakan Aplikasi Chat.
  • Melacak dan menganalisis aktivitas Chat. Misalnya, untuk mengirim laporan bulanan tentang anggota baru atau pesan yang paling banyak menerima reaksi atau balasan.
  • Berkomunikasi di berbagai platform pesan. Misalnya, pengguna dapat mengirim dan menerima pesan dari pengguna pada platform pesan yang berbeda tanpa keluar dari Chat.

Cara kerja peristiwa

Setiap kali sesuatu terjadi di Google Chat, resource Google Chat API dibuat, diperbarui, atau dihapus. Chat menggunakan peristiwa untuk mengirim informasi ke aplikasi Chat Anda tentang jenis yang terjadi, dan resource Chat API yang terpengaruh.

Contoh bagaimana pesan yang diposting ke ruang Google Chat memicu suatu peristiwa.
Gambar 1. Seorang pengguna memposting pesan di Ruang Chat, yang membuat resource Message. Chat kemudian membuat peristiwa yang berisi data tentang untuk membuat pesan email baru.

Chat mengategorikan acara berdasarkan jenis. Jenis peristiwa membantu Anda memfilter dan hanya menerima jenis informasi yang dibutuhkan, dan memungkinkan Anda menangani aktivitas dengan cara yang sama.

Tabel berikut menunjukkan pengaruh aktivitas di Chat terhadap resource Chat API terkait, dan jenis peristiwa yang Aplikasi Chat menerima:

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 berikut ini:

  • Berlangganan ke acara menggunakan Google Workspace Events API untuk menerima acara saat kemunculannya.
  • Buat kueri untuk peristiwa terbaru dengan memanggil Chat API.

Tabel berikut menjelaskan perbedaan dan alasan untuk membuat kueri atau berlangganan acara:

Berlangganan peristiwa Kueri untuk peristiwa
Kasus penggunaan
  • Memproses atau merespons peristiwa secara real time.
  • Memantau pengguna aktivitas keanggotaan dan menemukan ruang baru untuk memantau.
  • Memproses atau merespons peristiwa secara berkala, atau melalui pemicu.
  • Mengambil peristiwa yang terlewat dari langganan (karena pemadaman layanan atau langganan tidak aktif).
API Google Workspace Events API Chat API
Sumber peristiwa Ruang dan pengguna Hanya spasi
Peristiwa yang didukung
  • Pesan
  • Langganan
  • Reaksi
  • Spasi

Untuk daftar jenis peristiwa yang didukung, lihat Jenis peristiwa untuk membuat langganan di Dokumentasi Google Workspace Events API.
  • Pesan
  • Langganan
  • Reaksi
  • Spasi

Untuk mengetahui daftar jenis peristiwa yang didukung, lihat Resource spaceEvents di Chat API dokumentasi referensi.
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. Misalnya 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 beberapa ruang, kegiatan keanggotaan berikut terjadi:

  • Pengguna bergabung ke ruang, yang membuat resource Membership dan memicu acara 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 dan memicu peristiwa penghapusan anggota.

Berlangganan acara keanggotaan

Untuk menerima peristiwa secara real time, Aplikasi Chat memanggil Google Workspace Events API subscriptions.create() untuk berlangganan ruang untuk semua jenis acara keanggotaan. Sesudah membuat langganan, aplikasi Chat dapat mulai menerima acara keanggotaan.

Aplikasi Chat yang berlangganan peristiwa menggunakan
      Google Workspace Events API.
Gambar 2. Aplikasi Chat menerima acara keanggotaan melalui langganan menggunakan Google Workspace Events API.

Pada Gambar 2, aplikasi Chat memiliki langganan aktif ruang, sehingga aplikasi menerima peristiwa setiap kali keanggotaan dalam ruang perubahan. Aplikasi Chat kemudian dapat memproses atau merespons dalam waktu nyata untuk aktivitas apa pun, seperti memposting pesan selamat datang pribadi ke 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

Alih-alih menerima acara keanggotaan saat acara tersebut berlangsung, Aplikasi Chat dapat memanggil Chat API untuk mencantumkan peristiwa ruang angkasa terbaru yang terkait dengan aktivitas keanggotaan.

Aplikasi Chat yang mengkueri peristiwa menggunakan
        API Chat.
Gambar 3. J Aplikasi Chat menerima peristiwa keanggotaan terbaru melalui membuat kueri untuk peristiwa ruang menggunakan Chat API.

Pada Gambar 3, aplikasi Chat memanggil Chat API spaces.spaceEvents.list() setelah semua aktivitas keanggotaan terjadi, dan memfilter kueri untuk acara keanggotaan baru, yang diperbarui, dan dihapus. Chat API menampilkan daftar spaceEvent resource yang mewakili setiap perubahan keanggotaan. Aplikasi Chat kemudian dapat memproses atau merespons berdasarkan aktivitas terbaru, seperti memposting pesan mingguan dengan ringkasan aktivitas keanggotaan space dalam 7 hari terakhir.

Untuk membuat kueri peristiwa menggunakan Chat API, lihat Mencantumkan peristiwa dari ruang Google Chat.

Batasan

  • Untuk langganan bagi pengguna, acara tentang 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 menerima acara keanggotaan tersebut. Untuk memahami cara kerja keanggotaan Google Grup, lihat Menambahkan grup Google ke ruang.