Bagian ini menjelaskan cara aplikasi Google Chat memanggil Chat API, yang memungkinkan aplikasi Chat melakukan hal-hal seperti membuat ruang, menambahkan orang ke dalamnya, dan memposting pesan tanpa diminta oleh peristiwa interaksi aplikasi Chat.
Autentikasi
Memanggil Chat API secara asinkron memerlukan autentikasi. Setiap metode Chat API memerlukan autentikasi pengguna (untuk melakukan tindakan atau mengakses data atas nama pengguna) atau autentikasi aplikasi (untuk melakukan tindakan atau mengakses data sebagai aplikasi Chat). Beberapa metode mendukung autentikasi pengguna dan autentikasi aplikasi.
Untuk mempelajari autentikasi di Chat lebih lanjut, baca Ringkasan autentikasi.
Resource dan metode API
Resource dan metode REST memberikan akses asinkron ke ruang Chat, anggota ruang, pesan, reaksi pesan, dan lampiran pesan.
- Ruang
Ruang adalah tempat orang dan aplikasi dapat berkomunikasi dan berbagi file. Ada beberapa jenis ruang. Pesan langsung (DM) adalah percakapan 1:1 antara dua pengguna atau pengguna dan aplikasi Chat. Chat grup adalah percakapan antara tiga pengguna atau lebih dan aplikasi Chat. Ruang bernama adalah tempat persisten tempat pengguna mengirim pesan, berbagi file, dan berkolaborasi.
Resource
spaces
mewakili ruang.Ruang mendukung metode berikut:
- Buat ruang, tempat orang dan aplikasi dapat berkomunikasi dan berbagi file.
- Menyiapkan ruang untuk membuat ruang, serta menambahkan orang dan aplikasi Chat ke ruang tersebut.
- Mendapatkan ruang untuk melihat detail tentang suatu ruang.
- Daftar ruang untuk melihat daftar ruang yang diberi nomor halaman dan dapat difilter.
- Memperbarui ruang untuk mengubah atribut tentang ruang, seperti nama tampilan, deskripsi, dan panduan yang terlihat oleh pengguna.
- Menghapus ruang saat tidak diperlukan lagi.
- Temukan pesan langsung (DM) untuk menampilkan DM antara dua pengguna, atau DM antara pengguna dan aplikasi Chat yang memanggil.
- Anggota
Anggota adalah pengguna dan aplikasi Chat yang telah bergabung atau diundang ke ruang.
Resource
spaces.members
mewakili anggota.Pelanggan mendukung metode berikut:
- Buat keanggotaan untuk menambahkan pengguna atau aplikasi ke ruang.
- Dapatkan langganan untuk melihat detail tentang langganan.
- Keanggotaan daftar untuk melihat daftar keanggotaan yang diberi nomor halaman dan dapat difilter dalam ruang.
- Memperbarui keanggotaan untuk mengubah atribut tentang keanggotaan, seperti mengubah anggota ruang menjadi pengelola ruang, atau mengubah pengelola ruang menjadi anggota ruang.
- Menghapus keanggotaan untuk menghapus pengguna atau aplikasi dari ruang.
- Pesan
Pesan mencakup komunikasi teks dan kartu yang diposting di ruang. Pesan dapat memiliki file yang dilampirkan. Pengguna dapat bereaksi terhadap pesan dengan menambahkan emoji ke pesan tersebut.
Resource
spaces.messages
mewakili pesan.Message mendukung metode berikut:
- Buat pesan untuk memposting pesan teks atau kartu. Anda juga dapat memulai atau membalas rangkaian pesan.
- Mendapatkan pesan untuk mendapatkan detail tentang pesan, seperti waktu pengiriman atau isi pesannya.
- Mencantumkan pesan untuk melihat daftar pesan yang diberi nomor halaman dan dapat difilter dalam ruang.
- Memperbarui pesan untuk mengubah atribut pesan, seperti isi pesannya. Anda juga dapat menambahkan teks ke pesan kartu, atau kartu ke pesan teks.
- Hapus pesan saat tidak diperlukan lagi.
- Reaksi
Reaksi mewakili emoji yang digunakan orang untuk bereaksi terhadap pesan, seperti 👍, widget, dan resources.
Resource
spaces.messages.reactions
mewakili reaksi.Reaksi mendukung metode berikut:
- Buat reaksi untuk menambahkan emoji ke pesan.
- Daftar reaksi untuk melihat daftar reaksi yang diberi nomor halaman dan dapat difilter terhadap pesan.
- Hapus reaksi untuk menghapus emoji dari pesan.
- Media dan lampiran
Media mewakili file yang diupload ke Google Chat, seperti gambar, video, dan dokumen.
Resource
media
mewakili media yang dilampirkan ke pesan.Lampiran adalah media (file) yang dilampirkan ke pesan.
Resource
spaces.messages.attachments
mewakili lampiran. Lampiran berisi media dan metadata terkait yang dilampirkan ke pesan.Media dan lampiran mendukung metode berikut:
- Upload media sebagai lampiran untuk mengupload media ke Google Chat, lalu lampirkan ke pesan.
- Download media sebagai lampiran untuk mendownload media dari Google Chat sebagai file biner.
- Dapatkan lampiran untuk mengambil metadata tentang lampiran pesan.
- Acara ruang
Peristiwa ruang mewakili perubahan pada ruang atau resource turunannya, termasuk anggota, pesan, dan reaksinya.
Resource
spaces.spaceEvent
mewakili peristiwa ruang.Peristiwa ruang mendukung metode berikut:
- Mendapatkan peristiwa ruang untuk menampilkan detail tentang peristiwa yang terjadi di ruang.
- Mencantumkan peristiwa ruang untuk mendapatkan daftar peristiwa yang terjadi dalam ruang.
- Status pembacaan pengguna
Status baca pengguna adalah resource singleton yang mewakili detail tentang pesan telah dibaca terakhir dari pengguna tertentu di ruang Google Chat atau thread pesan.
Resource
users.spaces
mewakili status baca pengguna dalam ruang.Resource
users.spaces.threads
mewakili status baca pengguna dalam thread pesan.Status baca pengguna mendukung metode berikut:
- Mendapatkan status operasi baca ruang untuk menampilkan detail tentang status baca pengguna dalam ruang.
- Memperbarui status baca ruang untuk memperbarui status baca pengguna dalam ruang.
- Mendapatkan status pembacaan thread untuk menampilkan detail tentang status baca pengguna dalam thread.