REST Resource: spaces

Referensi: 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 (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,
  "adminInstalled": boolean,
  "accessSettings": {
    object (AccessSettings)
  }
}
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 tersebut merupakan DM antara aplikasi Chat dan satu orang.

threaded
(deprecated)

boolean

Hanya output. Tidak digunakan lagi: Sebagai gantinya, gunakan spaceThreadingState. Apakah pesan berangkai di ruang ini atau tidak.

displayName

string

Nama tampilan ruang. Wajib diisi 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 yang diautentikasi menggunakan Akun Google. Secara default, ruang mengizinkan semua pengguna Google Chat.

  • Ruang tersebut digunakan untuk mengimpor data ke Google Chat. Ruang mode impor hanya boleh mengizinkan anggota dari organisasi Google Workspace yang sama.

Untuk ruang yang sudah ada, kolom ini hanya merupakan 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, durasi ruang dibuat. Kolom ini hanya merupakan output, kecuali saat 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 di output jika spaceType adalah GROUP_CHAT atau SPACE.

adminInstalled

boolean

Hanya output. Apakah aplikasi Chat diinstal oleh administrator Google Workspace. Administrator dapat menginstal aplikasi Chat untuk domain, unit organisasi, atau grup pengguna mereka.

Administrator hanya dapat menginstal aplikasi Chat untuk pesan langsung antara pengguna dan aplikasi. Untuk mendukung penginstalan oleh admin, aplikasi Anda harus memiliki fitur pesan langsung.

accessSettings

object (AccessSettings)

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

Jenis

Tidak digunakan lagi: Sebagai gantinya, gunakan SpaceType.

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

SpaceType

Jenis ruang. Wajib 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, 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 tersebut.

Mendukung hingga 150 karakter.

guidelines

string

Opsional. Aturan, ekspektasi, dan etika ruang tersebut.

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.

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 setelan Berbagi Chat default.

AccessState

Menyatakan status akses Ruang.

Enum
ACCESS_STATE_UNSPECIFIED Status akses tidak diketahui atau tidak didukung pada 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.

Metode

completeImport

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

create

Membuat ruang bernama.

delete

Menghapus ruang yang telah diberi nama.

findDirectMessage

Menampilkan pesan langsung yang sudah ada dengan pengguna tertentu.

get

Menampilkan detail tentang ruang.

list

Mencantumkan ruang tempat pemanggil menjadi anggota.

patch

Memperbarui ruang.

setup

Membuat ruang dan menambahkan pengguna tertentu ke dalamnya.