Resource: Ruang
Ruang di Google Chat. Ruang adalah percakapan antara dua pengguna atau lebih, atau pesan 1:1 antara pengguna dan aplikasi Chat.
Representasi JSON |
---|
{ "name": string, "type": enum ( |
Kolom | |
---|---|
name |
Nama resource ruang. Format: Dengan |
type |
Hanya output. Tidak digunakan lagi: Sebagai gantinya, gunakan |
space |
Jenis ruang. Wajib saat membuat ruang atau memperbarui jenis ruang. Output hanya untuk penggunaan lain. |
single |
Opsional. Apakah ruang adalah DM antara aplikasi Chat dan satu orang. |
threaded |
Hanya output. Tidak digunakan lagi: Gunakan |
display |
Nama tampilan ruang. Diperlukan saat membuat ruang dengan Untuk pesan langsung, kolom ini mungkin kosong. Mendukung hingga 128 karakter. |
external |
Tidak dapat diubah. Apakah ruang ini mengizinkan pengguna Google Chat sebagai anggota. Input saat membuat ruang di organisasi Google Workspace. Hapus kolom ini saat membuat ruang dalam kondisi berikut:
Untuk ruang yang sudah ada, kolom ini hanya output. |
space |
Hanya output. Status rangkaian pesan di ruang Chat. |
space |
Detail tentang ruang, termasuk deskripsi dan aturan. |
space |
Status histori pesan untuk pesan dan rangkaian pesan di ruang ini. |
import |
Opsional. Apakah ruang ini dibuat di Membuat ruang di |
create |
Opsional. Tidak dapat diubah. Untuk ruang yang dibuat di Chat, waktu ruang dibuat. Kolom ini hanya output, kecuali jika digunakan dalam ruang mode impor. Untuk ruang mode impor, tetapkan kolom ini ke stempel waktu historis saat ruang dibuat di sumber untuk mempertahankan waktu pembuatan asli. Hanya diisi dalam output jika |
last |
Hanya output. Stempel waktu pesan terakhir dalam ruang. |
admin |
Hanya output. Untuk ruang pesan langsung (DM) dengan aplikasi Chat, baik ruang tersebut dibuat oleh administrator Google Workspace. Administrator dapat menginstal dan menyiapkan pesan langsung dengan aplikasi Chat atas nama pengguna di organisasi mereka. Untuk mendukung penginstalan oleh admin, aplikasi Chat Anda harus memiliki fitur pesan langsung. |
membership |
Hanya output. Jumlah langganan yang bergabung yang dikelompokkan menurut jenis anggota. Diisi saat |
access |
Opsional. Menentukan setelan akses ruang. Hanya diisi jika |
space |
Hanya output. URI untuk pengguna agar dapat mengakses ruang. |
customer |
Opsional. Tidak dapat diubah. ID pelanggan domain ruang. Hanya diperlukan saat membuat ruang dengan autentikasi aplikasi dan Dalam format Untuk DM, kolom ini tidak diisi. |
Kolom union Memerlukan autentikasi pengguna. |
|
predefined |
Opsional. Input saja. Setelan izin ruang yang telah ditentukan sebelumnya, hanya masukkan saat membuat ruang. Jika kolom tidak ditetapkan, ruang kolaborasi akan dibuat. Setelah Anda membuat ruang, setelan akan diisi di kolom |
permission |
Opsional. Setelan izin ruang untuk ruang yang ada. Input untuk memperbarui setelan izin ruang yang tepat, dengan setelan izin yang ada diganti. Output mencantumkan setelan izin saat ini. |
Jenis
Tidak digunakan lagi: Gunakan SpaceType
sebagai gantinya.
Enum | |
---|---|
TYPE_UNSPECIFIED |
Direservasi. |
ROOM |
Percakapan antara dua orang atau lebih. |
DM |
Pesan Langsung 1:1 antara manusia dan aplikasi Chat, dengan semua pesan bersifat datar. Perhatikan bahwa hal ini tidak mencakup pesan langsung antara dua orang. |
SpaceType
Jenis ruang. Diperlukan saat membuat atau memperbarui ruang. Output hanya untuk penggunaan lain.
Enum | |
---|---|
SPACE_TYPE_UNSPECIFIED |
Direservasi. |
SPACE |
Tempat orang mengirim pesan, berbagi file, dan berkolaborasi. SPACE dapat menyertakan aplikasi Chat. |
GROUP_CHAT |
Percakapan grup antara 3 orang atau lebih. GROUP_CHAT dapat menyertakan aplikasi Chat. |
DIRECT_MESSAGE |
Pesan 1:1 antara dua orang atau antara orang dan aplikasi Chat. |
SpaceThreadingState
Menentukan jenis status rangkaian pesan di ruang Chat.
Enum | |
---|---|
SPACE_THREADING_STATE_UNSPECIFIED |
Direservasi. |
THREADED_MESSAGES |
Ruang bernama yang mendukung rangkaian pesan. Saat merespons pesan, pengguna dapat membalas dalam rangkaian pesan, yang akan mempertahankan respons mereka dalam konteks pesan asli. |
GROUPED_MESSAGES |
Ruang bernama tempat percakapan diatur menurut topik. Topik dan balasannya dikelompokkan bersama. |
UNTHREADED_MESSAGES |
Pesan langsung (DM) antara dua orang dan percakapan grup antara 3 orang atau lebih. |
SpaceDetails
Detail tentang ruang, termasuk deskripsi dan aturan.
Representasi JSON |
---|
{ "description": string, "guidelines": string } |
Kolom | |
---|---|
description |
Opsional. Deskripsi ruang. Misalnya, jelaskan topik diskusi, tujuan fungsional, atau peserta ruang. Mendukung hingga 150 karakter. |
guidelines |
Opsional. Aturan, ekspektasi, dan etika ruang. Mendukung hingga 5.000 karakter. |
HistoryState
Status histori untuk pesan dan ruang. Menentukan berapa lama pesan dan rangkaian pesan percakapan disimpan setelah dibuat.
Enum | |
---|---|
HISTORY_STATE_UNSPECIFIED |
Nilai default. Jangan gunakan. |
HISTORY_OFF |
Histori nonaktif. Pesan dan rangkaian pesan disimpan selama 24 jam. |
HISTORY_ON |
Histori aktif. Aturan retensi Vault organisasi menentukan durasi penyimpanan pesan dan rangkaian pesan. |
MembershipCount
Merepresentasikan jumlah keanggotaan ruang, yang dikelompokkan ke dalam kategori.
Representasi JSON |
---|
{ "joinedDirectHumanUserCount": integer, "joinedGroupCount": integer } |
Kolom | |
---|---|
joined |
Jumlah pengguna manusia yang telah langsung bergabung ke ruang, bukan termasuk pengguna yang bergabung dengan memiliki keanggotaan dalam grup gabungan. |
joined |
Jumlah semua grup yang telah bergabung langsung ke ruang. |
AccessSettings
Merepresentasikan setelan akses ruang.
Representasi JSON |
---|
{
"accessState": enum ( |
Kolom | |
---|---|
access |
Hanya output. Menunjukkan status akses ruang. |
audience |
Opsional. Nama resource target audiens yang dapat menemukan ruang, bergabung ke ruang, dan melihat pratinjau pesan dalam ruang. Jika tidak disetel, hanya pengguna atau Google Grup yang telah diundang atau ditambahkan secara terpisah ke ruang yang dapat mengaksesnya. Untuk mengetahui detailnya, lihat Membuat ruang yang dapat ditemukan oleh target audiens. Format: Untuk menggunakan target audiens default untuk organisasi Google Workspace, tetapkan ke Membaca target audiens mendukung:
Kolom ini tidak diisi saat menggunakan cakupan Menetapkan audiens target memerlukan autentikasi pengguna. |
AccessState
Menampilkan status akses ruang.
Enum | |
---|---|
ACCESS_STATE_UNSPECIFIED |
Status akses tidak diketahui atau tidak didukung dalam API ini. |
PRIVATE |
Hanya pengguna atau Google Grup yang telah ditambahkan atau diundang secara terpisah oleh pengguna lain atau administrator Google Workspace yang dapat menemukan dan mengakses ruang. |
DISCOVERABLE |
Pengelola ruang telah memberikan akses ke ruang kepada target audiens. Pengguna atau Google Grup yang telah ditambahkan atau diundang ke ruang satu per satu juga dapat menemukan dan mengakses ruang tersebut. Untuk mempelajari lebih lanjut, lihat Membuat ruang dapat ditemukan oleh pengguna tertentu. Membuat ruang yang dapat ditemukan memerlukan autentikasi pengguna. |
PredefinedPermissionSettings
Setelan izin standar yang hanya dapat Anda tentukan saat membuat ruang bernama. Setelan lainnya mungkin ditambahkan di masa mendatang. Untuk mengetahui detail tentang setelan izin untuk ruang bernama, lihat Mempelajari ruang.
Enum | |
---|---|
PREDEFINED_PERMISSION_SETTINGS_UNSPECIFIED |
Tidak ditentukan. Jangan gunakan. |
COLLABORATION_SPACE |
Setelan untuk membuat ruang menjadi ruang kolaborasi tempat semua anggota dapat memposting pesan. |
ANNOUNCEMENT_SPACE |
Setelan untuk menjadikan ruang sebagai ruang pengumuman tempat hanya pengelola ruang yang dapat memposting pesan. |
PermissionSettings
Setelan izin yang dapat Anda tentukan saat memperbarui ruang bernama yang sudah ada.
Untuk menetapkan setelan izin saat membuat ruang, tentukan kolom PredefinedPermissionSettings
dalam permintaan Anda.
Representasi JSON |
---|
{ "manageMembersAndGroups": { object ( |
Kolom | |
---|---|
manage |
Setelan untuk mengelola anggota dan grup dalam ruang. |
modify |
Setelan untuk memperbarui nama, avatar, deskripsi, dan panduan ruang. |
toggle |
Setelan untuk mengaktifkan dan menonaktifkan histori ruang. |
use |
Setelan untuk menggunakan @semua di ruang. |
manage |
Setelan untuk mengelola aplikasi dalam ruang. |
manage |
Setelan untuk mengelola webhook di ruang. |
post |
Hanya output. Setelan untuk memposting pesan dalam ruang. |
reply |
Setelan untuk membalas pesan dalam ruang. |
PermissionSetting
Mewakili setelan izin ruang.
Representasi JSON |
---|
{ "managersAllowed": boolean, "membersAllowed": boolean } |
Kolom | |
---|---|
managers |
Apakah pengelola ruang memiliki izin ini. |
members |
Apakah anggota non-pengelola memiliki izin ini. |
Metode |
|
---|---|
|
Menyelesaikan proses impor untuk ruang yang ditentukan dan membuatnya terlihat oleh pengguna. |
|
Membuat ruang tanpa anggota. |
|
Menghapus ruang bernama. |
|
Menampilkan pesan langsung yang ada dengan pengguna yang ditentukan. |
|
Menampilkan detail tentang ruang. |
|
Mencantumkan ruang yang anggotanya adalah pemanggil. |
|
Memperbarui ruang. |
|
Menampilkan daftar ruang di organisasi Google Workspace berdasarkan penelusuran administrator. |
|
Membuat ruang dan menambahkan pengguna yang ditentukan ke dalamnya. |