REST Resource: spaces

Resource: Spasi

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 (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,

  // 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

Nama resource ruang.

Format: spaces/{space}
type
(deprecated)

enum (Type)

Hanya output. Tidak digunakan lagi: Sebagai gantinya, gunakan spaceType. Jenis ruang.
spaceType

enum (SpaceType)

Jenis ruang. Wajib saat membuat ruang atau memperbarui jenis ruang. Output hanya untuk penggunaan lain.
singleUserBotDm

boolean

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

boolean

Hanya output. Tidak digunakan lagi: Sebagai gantinya, gunakan spaceThreadingState. Apakah pesan disusun dalam ruang ini.
displayName

string

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

Untuk pesan langsung, kolom ini mungkin kosong.

Mendukung hingga 128 karakter.
externalUserAllowed

boolean

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 spasi dalam kondisi berikut:

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

  • Ruang ini digunakan untuk mengimpor data ke Google Chat karena ruang mode impor hanya boleh mengizinkan anggota dari organisasi Google Workspace yang sama. Namun, sebagai bagian dari Program Pratinjau Developer Google Workspace, ruang mode impor dapat mengizinkan setiap pengguna Google Chat sehingga kolom ini kemudian dapat ditetapkan untuk ruang mode impor.

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

enum (SpaceThreadingState)

Hanya output. Status rangkaian pesan di ruang Chat.
spaceDetails

object (SpaceDetails)

Detail tentang ruang, termasuk deskripsi dan aturan.
spaceHistoryState

enum (HistoryState)

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 sedang diimpor, ruang tidak dapat dilihat oleh pengguna sampai proses impor selesai.
createTime

string (Timestamp format)

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

string (Timestamp format)

Hanya output. Stempel waktu pesan terakhir dalam ruang.

adminInstalled

boolean

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.
membershipCount

object (MembershipCount)

Hanya output. Jumlah keanggotaan gabungan yang dikelompokkan menurut jenis anggota. Diisi saat spaceType adalah SPACE, DIRECT_MESSAGE, atau GROUP_CHAT.

accessSettings

object (AccessSettings)

Opsional. Menentukan setelan akses ruang. Hanya diisi saat spaceType adalah SPACE.

spaceUri

string

Hanya output. URI ruang.

Kolom union space_permission_settings. Menampilkan setelan izin ruang. Hanya diisi saat space_type adalah SPACE. space_permission_settings hanya dapat berupa salah satu dari yang berikut:
predefinedPermissionSettings

enum (PredefinedPermissionSettings)

Opsional. Input saja. Setelan izin ruang. Input untuk membuat ruang, ruang kolaborasi akan dibuat jika kolom ini tidak disetel. Setelah Anda membuat ruang, setelan akan diisi di kolom PermissionSettings.

permissionSettings

object (PermissionSettings)

Opsional. Setelan izin yang tepat yang dapat disetel untuk memperbarui ruang. Input untuk memperbarui ruang. Jika tidak, hanya output. Untuk membuat ruang, gunakan predefinedPermissionSettings.

Jenis

Tidak digunakan lagi: Sebagai gantinya, gunakan SpaceType.

Enum
TYPE_UNSPECIFIED Direservasi.
ROOM Percakapan antara dua manusia atau lebih.
DM Pesan Langsung 1:1 antara manusia dan aplikasi Chat, di mana semua pesan ditampilkan secara datar. Perhatikan bahwa ini tidak termasuk pesan langsung antara dua manusia.

SpaceType

Jenis ruang. Wajib ada saat membuat atau memperbarui ruang. Output hanya untuk penggunaan lain.

Enum
SPACE_TYPE_UNSPECIFIED Direservasi.
SPACE Tempat orang-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 manusia 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 pengguna merespons pesan, mereka dapat membalas dalam rangkaian pesan, yang menyimpan 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

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 durasi penyimpanan pesan dan rangkaian percakapan 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

Mewakili jumlah keanggotaan ruang, yang dikelompokkan ke dalam kategori.

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

integer

Jumlah pengguna manusia yang telah langsung bergabung ke ruang, bukan termasuk pengguna yang bergabung dengan memiliki keanggotaan dalam grup gabungan.
joinedGroupCount

integer

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 mengakses ruang. Tetapkan kolom ini ke ID target audiens yang valid agar ruang dapat ditemukan atau gunakan alias audiences/default untuk menetapkan ruang dengan setelan akses default di Konsol Admin. Untuk mempelajari lebih lanjut, lihat Membuat ruang yang dapat ditemukan oleh target audiens. Batalkan penetapan kolom ini untuk membuat ruang dibatasi. Hanya diisi saat ruang dapat ditemukan. Format: audiences/{audience}, audiences/default dapat digunakan sebagai alias dari setelan Berbagi Chat default.

AccessState

Merepresentasikan status akses Ruang.

Enum
ACCESS_STATE_UNSPECIFIED Status akses tidak diketahui atau tidak didukung dalam API ini.
PRIVATE Ruang dapat ditemukan oleh anggota atau grup yang ditambahkan atau diundang.
DISCOVERABLE Ruang dapat ditemukan oleh target audiens yang dipilih, serta anggota atau grup yang ditambahkan atau diundang.

PredefinedPermissionSettings

Setelan izin ruang yang dapat Anda tentukan saat membuat ruang yang diberi nama. Setelan lainnya mungkin ditambahkan di masa mendatang. Untuk mengetahui detail tentang setelan izin untuk ruang yang diberi nama, lihat Pelajari 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 membuat ruang menjadi ruang pengumuman tempat hanya pengelola ruang yang dapat memposting pesan.

PermissionSettings

Setelan izin untuk ruang yang diberi nama. Untuk menetapkan 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)

Setelan untuk mengelola anggota dan grup dalam ruang.
modifySpaceDetails

object (PermissionSetting)

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

object (PermissionSetting)

Setelan untuk mengaktifkan dan menonaktifkan histori ruang.
useAtMentionAll

object (PermissionSetting)

Setelan untuk menggunakan @semua dalam ruang.
manageApps

object (PermissionSetting)

Setelan untuk mengelola aplikasi dalam ruang.
manageWebhooks

object (PermissionSetting)

Setelan untuk mengelola webhook dalam ruang.
postMessages

object (PermissionSetting)

Hanya output. Setelan untuk memposting pesan dalam ruang.
replyMessages

object (PermissionSetting)

Setelan untuk membalas pesan dalam ruang.

PermissionSetting

Mewakili setelan izin ruang.

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

boolean

Apakah pengelola ruang memiliki izin ini atau tidak.
membersAllowed

boolean

Apakah anggota non-pengelola memiliki izin ini atau tidak.

Metode

completeImport

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

create

 Membuat ruang yang diberi nama.

delete

 Menghapus ruang yang diberi nama.

findDirectMessage

 Menampilkan pesan langsung yang sudah ada dengan pengguna yang ditentukan.

get

 Menampilkan detail tentang ruang.

list

 Mencantumkan ruang tempat pemanggil menjadi anggota.

patch

 Memperbarui ruang.

setup

 Membuat ruang dan menambahkan pengguna tertentu ke ruang tersebut.