Halaman ini menjelaskan peristiwa Google Chat yang dapat diikuti aplikasi Google Chat menggunakan Google Workspace Events API. Setelah menentukan jenis peristiwa yang diperlukan, buat langganan untuk mulai menerima peristiwa dari Google Chat.
Selain berlangganan peristiwa, Anda juga dapat membuat kueri untuk peristiwa dengan memanggil Chat API. Dengan memanggil Chat API, Anda dapat mengambil peristiwa secara berkala, atau mengejar peristiwa yang mungkin terlewatkan dari langganan karena pemadaman layanan. Untuk mempelajari cara menerima dan merespons peristiwa Chat, lihat Menggunakan peristiwa dari Google Chat dalam dokumentasi Chat.
Resource target Chat yang didukung
Google Workspace Events API mendukung langganan untuk:
- Ruang, yang direpresentasikan sebagai resource
space
- Pengguna, yang direpresentasikan sebagai resource
user
Cloud Identity API
Peristiwa Chat yang didukung
Langganan Google Workspace memungkinkan Anda menerima peristiwa tentang jenis perubahan Chat berikut:
- Pesan baru, diperbarui, atau dihapus di ruang.
- Reaksi baru atau yang dihapus terhadap pesan.
- Anggota yang baru, diperbarui, atau dihapus di ruang.
- Perubahan pada ruang langganan Anda, seperti nama atau deskripsi ruang yang diperbarui.
Jenis peristiwa untuk membuat langganan
Saat membuat langganan, Anda dapat menggunakan kolom
eventTypes[]
untuk menentukan jenis peristiwa yang ingin diterima. Jenis peristiwa diformat sesuai dengan spesifikasi CloudEvents, seperti google.workspace.APPLICATION.RESOURCE.VERSION.ACTION
.
Misalnya, untuk menerima peristiwa tentang pengguna yang bergabung ke ruang
Chat, Anda harus menentukan ruang sebagai resource target, dan jenis peristiwa sebagai
google.workspace.chat.membership.v1.created
. Untuk menerima peristiwa tentang pengguna tertentu
yang bergabung ke ruang mana pun, Anda harus menentukan pengguna sebagai resource target, dan
jenis peristiwa sebagai google.workspace.chat.membership.v1.created
. Untuk mempelajari lebih lanjut
cara kerja peristiwa, lihat Struktur peristiwa
Google Workspace.
Tabel berikut menampilkan jenis peristiwa yang didukung untuk langganan ke ruang dan langganan bagi pengguna. Untuk mempelajari pengecualian tentang hal yang memicu peristiwa, lihat Batasan.
Jenis peristiwa | Format | Data resource | ||
---|---|---|---|---|
Langganan ruang | ||||
Pesan diposting. |
|
|
||
Pesan diperbarui. |
|
|
||
Pesan dihapus. |
|
|
||
Reaksi dibuat. |
|
|
||
Reaksi dihapus. |
|
|
||
Anggota ditambahkan ke ruang. |
|
|
||
Anggota diperbarui di ruang. |
|
|
||
Anggota akan dihapus dari ruang. |
|
|
||
Ruang diperbarui. |
|
|
||
Ruang akan dihapus. |
|
|
||
Langganan untuk pengguna | ||||
Pengguna menjadi anggota ruang.
Tidak semua anggota baru memicu peristiwa. Untuk mengetahui detailnya, lihat Batasan |
|
|
||
Keanggotaan pengguna ke ruang diperbarui. |
|
|
||
Pengguna dihapus sebagai anggota langsung ruang. |
|
|
Jenis peristiwa batch (khusus output)
Selain menerima jenis peristiwa langganan Anda, aplikasi Chat Anda mungkin juga menerima peristiwa batch. Peristiwa batch adalah peristiwa yang mewakili banyak peristiwa dari jenis yang sama yang terjadi dalam jangka waktu singkat. Payload peristiwa batch berisi daftar semua resource yang diubah.
Misalnya, jika pengguna menambahkan 20 pengguna ke ruang secara bersamaan, aplikasi Chat Anda mungkin menerima peristiwa batch (google.workspace.chat.membership.v1.batchCreated
). Payload peristiwa berisi daftar semua resource Membership
baru yang dibuat saat pengguna menambahkan anggota ke ruang.
Anda menerima peristiwa batch untuk semua jenis peristiwa langganan, sehingga
Anda tidak perlu menentukan peristiwa batch saat membuat langganan. Misalnya, jika Anda berlangganan reaksi baru (google.workspace.chat.reaction.v1.created
), aplikasi Chat Anda akan otomatis dikonfigurasi untuk menerima peristiwa reaksi batch (google.workspace.chat.reaction.v1.batchCreated
).
Tabel berikut menampilkan kemungkinan peristiwa batch untuk langganan:
Jenis peristiwa batch | Format |
---|---|
Beberapa pesan akan diposting. |
|
Beberapa pesan diperbarui. |
|
Beberapa pesan dihapus. |
|
Beberapa reaksi dibuat. |
|
Beberapa reaksi dihapus. |
|
Beberapa anggota ditambahkan ke ruang yang berlangganan, atau pengguna yang berlangganan telah ditambahkan ke beberapa ruang. |
|
Beberapa keanggotaan diperbarui di ruang langganan, atau untuk pengguna yang berlangganan. |
|
Beberapa anggota dihapus dari ruang yang berlangganan, atau pengguna yang berlangganan telah dihapus dari beberapa ruang. |
|
Ruang memiliki beberapa pembaruan. |
|
Data peristiwa
Bagian ini menjelaskan data peristiwa dan contoh payload untuk peristiwa di Chat.
Saat langganan Google Workspace menerima peristiwa dari
Chat, kolom
data
berisi payload untuk peristiwa tersebut. Payload ini memiliki informasi tentang
resource Google Workspace yang berubah. Misalnya, jika Anda telah berlangganan peristiwa keanggotaan dalam ruang, payload untuk peristiwa ini berisi informasi tentang resource spaces.membership
yang berubah.
Data resource dalam payload peristiwa
Saat membuat langganan, Anda dapat menentukan apakah ingin payload menyertakan detail tentang resource, atau hanya nama resource. Misalnya, jika ingin menerima peristiwa tentang anggota di ruang Chat, Anda dapat menentukan kolom resource keanggotaan yang ingin diterima dalam payload peristiwa.
Tabel berikut menyediakan contoh payload JSON untuk langganan
ke ruang Chat spaces/AAAABBBBBB
. Untuk setiap peristiwa yang
diterima langganan, payload akan muncul di kolom data
peristiwa:
Contoh | Jenis peristiwa | Payload JSON |
---|---|---|
Pengguna memposting pesan di ruang yang bertuliskan "Halo dunia". |
|
Menyertakan data resource
{ "message": { "name": "spaces/AAAABBBBBB/messages/CCCCCCCCC.DDDDDDDDD", "sender": { "name": "users/1234567890987654321", "type": "HUMAN" }, "createTime": "2023-09-07T21:37:36.260127Z", "text": "Hello world", "thread": { "name": "spaces/AAAABBBBBB/threads/EEEEEEEEEEEE" }, "space": { "name": "spaces/AAAABBBBBB" }, "argumentText": "Hello world" } } Mengecualikan data resource
{ "message": { "name": "spaces/AAAABBBBBB/messages/CCCCCCCCC.DDDDDDDDD" } } |
Pengguna akan menjadi pengelola ruang. |
|
Menyertakan data resource
{ "membership": { "name": "spaces/AAAABBBBBB/members/1234567890987654321", "state": "JOINED", "member": { "name": "users/1234567890987654321", "type": "HUMAN" }, "createTime": "1970-01-01T00:00:00Z", "role": "ROLE_MANAGER" } } Mengecualikan data resource
{ "membership": { "name": "spaces/AAAABBBBBB/members/1234567890987654321" } } |
Pengguna memperbarui deskripsi ruang menjadi "Tim penjualan untuk Cymbal Labs". | google.workspace.chat.space.v1.updated |
Menyertakan data resource
{ "space": { "name": "spaces/AAAABBBBBB", "displayName": "Cymbal Sales", "spaceThreadingState": "THREADED_MESSAGES", "spaceType": "SPACE", "spaceDetails": { "description": "Sales team for Cymbal Labs." }, "spaceHistoryState": "HISTORY_ON" } } Mengecualikan data resource
{ "space": { "name": "spaces/AAAABBBBBB" } } |
Dua pengguna Chat ditambahkan ke ruang secara bersamaan. | google.workspace.chat.membership.v1.batchCreated |
Menyertakan data resource
{ "memberships": [ { "membership": { "name": "spaces/AAAABBBBBB/members/1234567890987654321", "state": "JOINED", "member": { "name": "users/1234567890987654321", "type": "HUMAN" }, "createTime": "1970-01-01T00:00:00Z", "role": "ROLE_MEMBER" } }, { "membership": { "name": "spaces/AAAABBBBBB/members/987654321234567890", "state": "JOINED", "member": { "name": "users/987654321234567890", "type": "HUMAN" }, "createTime": "1970-01-01T00:00:00Z", "role": "ROLE_MEMBER" } } ] } Mengecualikan data resource
{ "memberships": [ { "membership": { "name": "spaces/AAAABBBBBB/members/1234567890987654321" } }, { "membership": { "name": "spaces/AAAABBBBBB/members/98765432123456789019" } } ] } |
Pengguna bereaksi pada pesan dengan emoji minimal. | google.workspace.chat.reaction.v1.created |
Menyertakan data resource
{ "reaction": { "name": "spaces/AAAABBBBBB/messages/123456789.123456789/reactions/1111111111111111.222222222222222", "user": { "name": "users/1234567890987654321", "type": "HUMAN" }, "emoji": { "unicode": "😊" } } } Menghapus data resource
{ "reaction": { "name": "spaces/AAAABBBBBB/messages/123456789.123456789/reactions/1111111111111111.222222222222222" } } |
Pengguna bereaksi terhadap pesan dengan emoji minimal dan Support emoji. | google.workspace.chat.reaction.v1.batchCreated |
Menyertakan data resource
{ "reactions": [ { "reaction": { "name": "spaces/AAAABBBBBB/messages/123456789.123456789/reactions/1111111111111111.222222222222222", "user": { "name": "users/1234567890987654321", "type": "HUMAN" }, "emoji": { "unicode": "😊" } } }, { "reaction": { "name": "spaces/AAAABBBBBB/messages/123456789.123456789/reactions/3333333333333333.444444444444444", "user": { "name": "users/98765431234564321", "type": "HUMAN" }, "emoji": { "unicode": "😸" } } } ] } Menghapus data resource
{ "reactions": [ { "reaction": { "name": "spaces/AAAABBBBBB/messages/123456789.123456789/reactions/1111111111111111.222222222222222" }, "reaction": { "name": "spaces/AAAABBBBBB/messages/123456789.123456789/reactions/3333333333333333.444444444444444", } } ] } |
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. - Perubahan pada histori ruang tidak memicu peristiwa ruang yang diperbarui (Jenis peristiwa:
google.workspace.chat.spaces.v1.updated
). - 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
- Struktur peristiwa Google Workspace
- Memilih cakupan OAuth
- Buat langganan untuk menerima peristiwa Chat