Bagian ini menjelaskan cara aplikasi Google Chat dapat 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. Masing-masing 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). Agak besar metode mendukung otentikasi pengguna dan otentikasi aplikasi.
Untuk mempelajari lebih lanjut autentikasi di Chat, lihat Ringkasan autentikasi.
Resource dan metode API
Resource dan metode REST memberikan akses asinkron ke Chat ruang, anggota ruang, pesan, reaksi pesan, dan lampiran pesan.
- Ruang
Ruang adalah tempat orang dan aplikasi dapat berkomunikasi dan berbagi file. Ada adalah beberapa jenis ruang. Pesan langsung (DM) adalah percakapan 1:1 antara dua pengguna atau pengguna dan aplikasi Chat. Grup percakapan adalah percakapan antara tiga pengguna atau lebih dan Aplikasi Chat. Ruang bernama adalah tempat persisten yang digunakan pengguna untuk mengirim mengirim pesan, berbagi file, dan berkolaborasi.
Tujuan Referensi
spaces
mewakili sebuah spasi.Ruang mendukung metode berikut:
- Membuat ruang, tempat orang dan aplikasi dapat berkomunikasi dan berbagi file.
- Menyiapkan ruang untuk membuat ruang, serta menambahkan orang dan aplikasi Chat ke dalamnya spasi.
- Mendapatkan ruang untuk melihat detail tentang ruang.
- Menampilkan daftar ruang untuk melihat daftar ruang yang diberi nomor halaman dan dapat difilter.
- Memperbarui ruang untuk mengubah atribut tentang ruang, seperti nama tampilan yang terlihat oleh pengguna, deskripsi, dan pedoman.
- Menghapus ruang saat tidak lagi diperlukan.
- Menemukan pesan langsung (DM) untuk menampilkan DM antara dua pengguna, atau DM antara pengguna dan panggilan Aplikasi Chat.
- Anggota
Anggota adalah pengguna dan aplikasi Chat yang telah bergabung atau diundang ke ruang.
Tujuan Referensi
spaces.members
mewakili anggota.Pelanggan mendukung metode berikut:
- Membuat langganan untuk menambahkan pengguna atau aplikasi ke ruang.
- Mendapatkan langganan untuk melihat detail tentang langganan.
- Keanggotaan daftar untuk melihat daftar keanggotaan yang diberi nomor halaman dan dapat difilter dalam ruang.
- Memperbarui langganan untuk mengubah atribut tentang keanggotaan, seperti mengubah anggota ruang menjadi pengelola ruang, atau mengubah pengelola ruang menjadi anggota ruang.
- Menghapus langganan untuk menghapus pengguna atau aplikasi dari ruang.
- Pesan
Pesan meliputi teks dan kartu komunikasi yang diposting di ruang. Pesan dapat memiliki file yang dilampirkan. Pengguna dapat bereaksi terhadap pesan dengan menambahkan emoji ke pesan tersebut.
Tujuan Referensi
spaces.messages
mewakili sebuah pesan.Message mendukung metode berikut:
- Membuat pesan untuk memposting teks atau pesan kartu. Anda juga dapat memulai atau membalas rangkaian pesan.
- Mendapatkan pesan untuk mendapatkan detail tentang pesan, seperti kapan pesan dikirim atau isi pesannya.
- Membuat daftar 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 bisa menambahkan teks menjadi pesan kartu, atau kartu ke pesan teks.
- Menghapus pesan saat tidak lagi diperlukan.
- Reaksi
Reaksi menunjukkan emoji yang digunakan orang untuk bereaksi terhadap pesan, seperti 👍, 🔒, dan resource.
Tujuan Referensi
spaces.messages.reactions
mewakili suatu reaksi.Reaksi mendukung metode berikut:
- Membuat reaksi untuk menambahkan emoji ke pesan.
- Membuat daftar reaksi untuk melihat daftar reaksi yang diberi nomor halaman dan dapat difilter terhadap pesan.
- Menghapus reaksi untuk menghapus emoji dari pesan.
- Media dan lampiran
Media mewakili file yang diupload ke Google Chat, seperti gambar, video, dan yang informatif serta dipersonalisasi.
Tujuan Referensi
media
mewakili media yang dilampirkan pada pesan.Lampiran adalah media (file) yang dilampirkan ke pesan.
Tujuan Referensi
spaces.messages.attachments
mewakili lampiran. Lampiran berisi media dan elemen metadata yang dilampirkan ke pesan.Media dan lampiran mendukung metode berikut:
- Mengupload media sebagai lampiran untuk mengupload media ke Google Chat, lalu melampirkannya ke pesan.
- Mendownload media sebagai lampiran untuk mendownload media dari Google Chat sebagai file biner.
- Mendapatkan lampiran untuk mengambil metadata tentang lampiran pesan.
- Acara ruang
Peristiwa ruang mewakili perubahan pada ruang atau resource turunan, termasuk anggota, pesan, dan reaksinya.
Referensi
spaces.spaceEvent
mewakili peristiwa ruang angkasa.Peristiwa ruang mendukung metode berikut:
- Mendapatkan acara antariksa untuk menampilkan detail tentang peristiwa yang terjadi dalam 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 yang terakhir dibaca oleh pengguna tertentu di ruang atau pesan Google Chat .
Referensi
users.spaces
merepresentasikan status baca pengguna dalam ruang.Referensi
users.spaces.threads
merepresentasikan status baca pengguna dalam thread pesan.Status baca pengguna mendukung metode berikut:
- Mendapatkan status baca ruang untuk menampilkan detail tentang status baca pengguna dalam ruang.
- Memperbarui status pembacaan ruang untuk memperbarui status baca pengguna dalam ruang.
- Mendapatkan status pembacaan thread untuk menampilkan detail tentang status baca pengguna dalam thread.