REST Resource: spaces

Resource: Space

Ruang di Google Chat. Ruang adalah percakapan antara dua pengguna atau lebih atau pesan pribadi antara pengguna dan aplikasi Chat.

Representasi JSON 
{   "name": string,   "type": enum (Type),   "spaceType": enum (SpaceType),   "singleUserBotDm": boolean,   "threaded": boolean,   "displayName": string,   "externalUserAllowed": boolean,   "spaceThreadingState": enum (SpaceThreadingState),   "spaceDetails": {     object (SpaceDetails)   },   "spaceHistoryState": enum (HistoryState),   "importMode": boolean,   "createTime": string,   "lastActiveTime": string,   "adminInstalled": boolean,   "membershipCount": {     object (MembershipCount)   },   "accessSettings": {     object (AccessSettings)   },   "spaceUri": string,   "importModeExpireTime": string,   "customer": string,    // Union field space_permission_settings can be only one of the following:   "predefinedPermissionSettings": enum (PredefinedPermissionSettings),   "permissionSettings": {     object (PermissionSettings)   }   // End of list of possible types for union field space_permission_settings. }
Kolom
name

string

ID. Nama resource ruang.

Format: spaces/{space}

Dengan {space} merepresentasikan ID yang ditetapkan sistem untuk ruang. Anda bisa mendapatkan ID ruang dengan memanggil metode spaces.list() atau dari URL ruang. Misalnya, jika URL ruang adalah https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA, ID ruang adalah AAAAAAAAA.
type
(deprecated)

enum (Type)

Hanya output. Tidak digunakan lagi: Gunakan spaceType sebagai gantinya. Jenis ruang.
spaceType

enum (SpaceType)

Opsional. Jenis ruang. Diperlukan saat membuat ruang atau memperbarui jenis ruang. Hanya output untuk penggunaan lainnya.
singleUserBotDm

boolean

Opsional. Apakah ruang adalah DM antara aplikasi Chat dan satu orang.
threaded
(deprecated)

boolean

Hanya output. Tidak digunakan lagi: Gunakan spaceThreadingState sebagai gantinya. Apakah pesan disusun dalam rangkaian pesan di ruang ini.
displayName

string

Opsional. Nama tampilan ruang. Diperlukan saat membuat ruang dengan spaceType SPACE. Jika Anda menerima pesan error ALREADY_EXISTS saat membuat ruang atau memperbarui displayName, coba displayName lain. Ruang yang ada dalam organisasi Google Workspace mungkin sudah menggunakan nama tampilan ini.

Untuk pesan langsung, kolom ini mungkin kosong.

Mendukung hingga 128 karakter.
externalUserAllowed

boolean

Opsional. Tidak dapat diubah. Apakah ruang ini mengizinkan pengguna Google Chat mana pun sebagai anggota. Input saat membuat ruang di organisasi Google Workspace. Jangan sertakan kolom ini saat membuat ruang dalam kondisi berikut:

  • Pengguna yang diautentikasi menggunakan akun konsumen (akun pengguna yang tidak dikelola). Secara default, ruang yang dibuat oleh akun konsumen mengizinkan pengguna Google Chat mana pun.

Untuk ruang yang sudah ada, kolom ini hanya output.
spaceThreadingState

enum (SpaceThreadingState)

Hanya output. Status rangkaian pesan di ruang Chat.
spaceDetails

object (SpaceDetails)

Opsional. Detail tentang ruang, termasuk deskripsi dan aturan.
spaceHistoryState

enum (HistoryState)

Opsional. Status histori pesan untuk pesan dan rangkaian pesan di ruang ini.
importMode

boolean

Opsional. Apakah ruang ini dibuat di Import Mode sebagai bagian dari migrasi data ke Google Workspace. Saat ruang sedang diimpor, ruang tersebut tidak dapat dilihat oleh pengguna hingga impor selesai.

Membuat ruang di Import Modememerlukan autentikasi pengguna.
createTime

string (Timestamp format)

Opsional. Tidak dapat diubah. Untuk ruang yang dibuat di Chat, waktu ruang dibuat. Kolom ini hanya output, kecuali saat digunakan di 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 spaceType adalah GROUP_CHAT atau SPACE.
lastActiveTime

string (Timestamp format)

Hanya output. Stempel waktu pesan terakhir di ruang.
adminInstalled

boolean

Hanya output. Untuk ruang pesan langsung (DM) dengan aplikasi Chat, apakah 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.
membershipCount

object (MembershipCount)

Hanya output. Jumlah langganan yang diikuti, dikelompokkan menurut jenis anggota. Diisi saat spaceType adalah SPACE, DIRECT_MESSAGE, atau GROUP_CHAT.
accessSettings

object (AccessSettings)

Opsional. Menentukan setelan akses ruang. Hanya diisi jika spaceType adalah SPACE.
spaceUri

string

Hanya output. URI bagi pengguna untuk mengakses ruang.
importModeExpireTime

string (Timestamp format)

Hanya output. Waktu saat ruang akan otomatis dihapus oleh sistem jika tetap dalam mode impor.

Setiap ruang yang dibuat dalam mode impor harus keluar dari mode ini sebelum waktu habis ini menggunakan spaces.completeImport.

Kolom ini hanya diisi untuk ruang yang dibuat dengan mode impor.
customer

string

Opsional. Tidak dapat diubah. ID pelanggan domain ruang. Hanya diperlukan saat membuat ruang dengan autentikasi aplikasi dan SpaceType adalah SPACE, jika tidak, tidak boleh disetel.

Dalam format customers/{customer}, dengan customer adalah id dari resource pelanggan Admin SDK. Aplikasi pribadi juga dapat menggunakan alias customers/my_customer untuk membuat ruang di organisasi Google Workspace yang sama dengan aplikasi.

Untuk DM, kolom ini tidak diisi.
Kolom union space_permission_settings. Merepresentasikan setelan izin ruang. Hanya diisi jika space_type adalah SPACE. space_permission_settings hanya dapat berupa salah satu dari hal berikut:
predefinedPermissionSettings

enum (PredefinedPermissionSettings)

Opsional. Hanya input. Setelan izin ruang yang telah ditentukan sebelumnya, hanya dimasukkan saat membuat ruang. Jika kolom tidak disetel, ruang kolaborasi akan dibuat. Setelah Anda membuat ruang, setelan akan diisi di kolom PermissionSettings.

Menetapkan setelan izin yang telah ditentukan sebelumnya mendukung:
permissionSettings

object (PermissionSettings)

Opsional. Setelan izin ruang untuk ruang yang ada. Input untuk memperbarui setelan izin ruang yang tepat, dengan mengganti setelan izin yang ada. Output mencantumkan setelan izin saat ini.

Membaca dan memperbarui setelan izin mendukung:

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 ditampilkan secara datar. Perhatikan bahwa hal ini tidak mencakup pesan langsung antara dua manusia.

SpaceType

Jenis ruang. Diperlukan saat membuat atau memperbarui ruang. Hanya output untuk penggunaan lainnya.

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 menanggapi pesan, pengguna dapat membalas dalam rangkaian pesan, sehingga respons mereka tetap dalam konteks pesan asli.
GROUPED_MESSAGES Ruang bernama tempat percakapan diatur berdasarkan 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

string

Opsional. Deskripsi ruang. Misalnya, jelaskan topik diskusi, tujuan fungsional, atau peserta ruang.

Mendukung hingga 150 karakter.
guidelines

string

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 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 pesan dan rangkaian pesan disimpan.

MembershipCount

Menampilkan jumlah keanggotaan ruang, yang dikelompokkan ke dalam kategori.

Representasi JSON 
{   "joinedDirectHumanUserCount": integer,   "joinedGroupCount": integer }
Kolom
joinedDirectHumanUserCount

integer

Hanya output. Jumlah pengguna manusia yang telah bergabung langsung ke ruang, tidak menghitung pengguna yang bergabung dengan memiliki keanggotaan dalam grup yang bergabung.
joinedGroupCount

integer

Hanya output. Jumlah semua grup yang telah bergabung langsung ke ruang.

AccessSettings

Merepresentasikan setelan akses ruang.

Representasi JSON 
{   "accessState": enum (AccessState),   "audience": string }
Kolom
accessState

enum (AccessState)

Hanya output. Menunjukkan status akses ruang.
audience

string

Opsional. Nama resource target audiens yang dapat menemukan ruang, bergabung ke ruang, dan melihat pratinjau pesan di ruang. Jika tidak disetel, hanya pengguna atau Google Grup yang telah diundang atau ditambahkan satu per satu ke ruang yang dapat mengaksesnya. Untuk mengetahui detailnya, lihat Membuat ruang dapat ditemukan oleh audiens target.

Format: audiences/{audience}

Untuk menggunakan audiens target default bagi organisasi Google Workspace, tetapkan ke audiences/default.

Membaca audiens target mendukung:

Kolom ini tidak diisi saat menggunakan cakupan chat.bot dengan autentikasi aplikasi.

Menetapkan audiens target memerlukan autentikasi pengguna.

AccessState

Merepresentasikan status akses ruang.

Enum
ACCESS_STATE_UNSPECIFIED Status akses tidak diketahui atau tidak didukung di API ini.
PRIVATE Hanya pengguna atau Google Grup yang telah ditambahkan atau diundang secara individual 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 satu per satu ke ruang juga dapat menemukan dan mengakses ruang. Untuk mempelajari lebih lanjut, lihat Membuat ruang dapat ditemukan oleh pengguna tertentu.

Membuat ruang yang dapat ditemukan memerlukan autentikasi pengguna.

PredefinedPermissionSettings

Setelan izin yang telah ditentukan sebelumnya 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 menjadikan ruang sebagai 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 ada.

Untuk menyetel setelan izin saat membuat ruang, tentukan kolom PredefinedPermissionSettings dalam permintaan Anda.

Representasi JSON 
{   "manageMembersAndGroups": {     object (PermissionSetting)   },   "modifySpaceDetails": {     object (PermissionSetting)   },   "toggleHistory": {     object (PermissionSetting)   },   "useAtMentionAll": {     object (PermissionSetting)   },   "manageApps": {     object (PermissionSetting)   },   "manageWebhooks": {     object (PermissionSetting)   },   "postMessages": {     object (PermissionSetting)   },   "replyMessages": {     object (PermissionSetting)   } }
Kolom
manageMembersAndGroups

object (PermissionSetting)

Opsional. Setelan untuk mengelola anggota dan grup di ruang.
modifySpaceDetails

object (PermissionSetting)

Opsional. Setelan untuk memperbarui nama, avatar, deskripsi, dan panduan ruang.
toggleHistory

object (PermissionSetting)

Opsional. Setelan untuk mengaktifkan dan menonaktifkan histori ruang.
useAtMentionAll

object (PermissionSetting)

Opsional. Setelan untuk menggunakan @semua di ruang.
manageApps

object (PermissionSetting)

Opsional. Setelan untuk mengelola aplikasi dalam ruang.
manageWebhooks

object (PermissionSetting)

Opsional. Setelan untuk mengelola webhook dalam ruang.
postMessages

object (PermissionSetting)

Hanya output. Setelan untuk memposting pesan dalam ruang.
replyMessages

object (PermissionSetting)

Opsional. Setelan untuk membalas pesan dalam ruang.

PermissionSetting

Merepresentasikan setelan izin ruang.

Representasi JSON 
{   "managersAllowed": boolean,   "membersAllowed": boolean }
Kolom
managersAllowed

boolean

Opsional. Apakah pengelola ruang memiliki izin ini.
membersAllowed

boolean

Opsional. Apakah anggota non-pengelola memiliki izin ini.

Metode

completeImport

 Menyelesaikan proses impor untuk ruang yang ditentukan dan membuatnya terlihat oleh pengguna.

create

 Membuat ruang.

delete

 Menghapus ruang bernama.

findDirectMessage

 Menampilkan pesan langsung yang ada dengan pengguna yang ditentukan.

get

 Menampilkan detail tentang ruang.

list

 Mencantumkan ruang tempat pemanggil menjadi anggota.

patch

 Memperbarui ruang.
Menampilkan daftar ruang dalam organisasi Google Workspace berdasarkan penelusuran administrator.

setup

 Membuat ruang dan menambahkan pengguna tertentu ke dalamnya.