REST Resource: spaces

Resource: Space

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,
  "sessionState": enum (SpaceSessionState),
  "sessionEnableTime": string,
  "importModeExpireTime": string,
  "customer": string,

  "predefinedPermissionSettings": enum (PredefinedPermissionSettings),
  "permissionSettings": {
    object (PermissionSettings)
  }
}
Kolom
name

string

ID. Nama resource ruang.

Format: spaces/{space}

Dengan {space} yang mewakili 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 ruangnya 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 lain.
singleUserBotDm

boolean

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

boolean

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

string

Opsional. Nama tampilan ruang. Diperlukan saat membuat ruang dengan spaceType dari 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 sebagai anggota. Input saat membuat ruang di organisasi Google Workspace. Hapus 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 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 akan terlihat 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 pembuatan ruang. Kolom ini hanya output, kecuali jika 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 keanggotaan yang digabungkan, dikelompokkan menurut jenis keanggotaan. Diisi jika 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.
sessionState

enum (SpaceSessionState)

Hanya output. Status sesi ruang.
sessionEnableTime

string (Timestamp format)

Hanya output. Stempel waktu saat status dukungan sesi ruang menjadi didukung. Tidak ditetapkan jika ruang tidak mengaktifkan dukungan sesi.
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 masa berlaku 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 ditetapkan.

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.

Kolom ini tidak diisi untuk pesan langsung (DM) atau saat ruang dibuat oleh pengguna non-Google Workspace.
Merepresentasikan setelan izin ruang. Hanya diisi jika space_type adalah SPACE. Berikut adalah daftar kolom yang sama-sama bersifat eksklusif. Maksimal satu kolom akan ditetapkan dalam respons:
predefinedPermissionSettings

enum (PredefinedPermissionSettings)

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

Menetapkan setelan izin standar mendukung:
permissionSettings

object (PermissionSettings)

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

Membaca dan memperbarui setelan izin mendukung:
Akhir kolom yang saling eksklusif.

Jenis

Tidak digunakan lagi: Gunakan SpaceType sebagai gantinya.

Enum
TYPE_UNSPECIFIED Dilindungi Undang-Undang.
ROOM Percakapan antara dua manusia atau lebih.
DM Pesan Langsung personal antara manusia dan aplikasi Chat, dengan semua pesan bersifat datar. Perhatikan bahwa hal ini tidak termasuk pesan langsung antara dua orang.

SpaceType

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

Enum
SPACE_TYPE_UNSPECIFIED Dilindungi Undang-Undang.
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 seseorang dan aplikasi Chat.

SpaceThreadingState

Menentukan jenis status rangkaian pesan di ruang Chat.

Enum
SPACE_THREADING_STATE_UNSPECIFIED Dilindungi Undang-Undang.
THREADED_MESSAGES Ruang yang mendukung rangkaian pesan. Saat merespons pesan, pengguna dapat membalas dalam rangkaian pesan, yang membuat respons mereka tetap dalam konteks pesan asli.
GROUPED_MESSAGES Ruang bernama yang percakapannya diatur berdasarkan topik. Topik dan balasannya dikelompokkan bersama.
UNTHREADED_MESSAGES

Ruang yang tidak mendukung rangkaian pesan. Status rangkaian pesan ruang ini hanya digunakan untuk kasus khusus, termasuk:

  • Chat rapat dinamis yang rangkaian pesannya sengaja dinonaktifkan.
  • Percakapan grup lama yang dibuat sebelum tahun 2022.

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

MembershipCount

Mewakili 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 termasuk pengguna yang bergabung karena 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,
  "accessPermissionSettings": {
    object (AccessPermissionSettings)
  }
}
Kolom
accessState

enum (AccessState)

Hanya output. Menunjukkan status akses ruang.
audience

string

Opsional. Nama resource audiens target yang dapat menemukan ruang, bergabung ke ruang, dan melihat pratinjau pesan di ruang. Jika tidak ditetapkan, 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 dukungan audiens target:

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

Menetapkan audiens target memerlukan autentikasi pengguna.
accessPermissionSettings

object (AccessPermissionSettings)

Opsional. Setelan izin akses untuk ruang.

Untuk menetapkan audiens target saat membuat ruang, tentukan kolom accessSettings.audience dalam permintaan Anda.

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 Google Workspace Administrator yang dapat menemukan dan mengakses ruang.
DISCOVERABLE

Pengelola ruang telah memberi audiens target akses ke ruang. Pengguna atau Google Grup yang telah ditambahkan atau diundang satu per satu ke ruang 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.

AccessPermissionSettings

Mengakses setelan izin untuk ruang.

Representasi JSON 
{
  "discoverSpaceSetting": {
    object (AccessPermissionSetting)
  },
  "joinSpaceSetting": {
    object (AccessPermissionSetting)
  },
  "viewSpaceMembershipSetting": {
    object (AccessPermissionSetting)
  }
}
Kolom
discoverSpaceSetting

object (AccessPermissionSetting)

Opsional. Setelan izin akses untuk menemukan ruang.
joinSpaceSetting

object (AccessPermissionSetting)

Opsional. Setelan izin akses untuk bergabung ke ruang.
viewSpaceMembershipSetting

object (AccessPermissionSetting)

Opsional. Setelan izin akses untuk melihat keanggotaan ruang. Harus ditentukan bersama dengan PermissionSettings.view_space_membership dalam mask update dan isi permintaan saat memperbarui siapa yang dapat melihat keanggotaan ruang. Saat memberikan akses lihat kepada audiens target, Anda juga harus memberikan PermissionSettings.view_space_membership kepada semua anggota dalam permintaan yang sama. Untuk menghapus audiens target yang ada (misalnya, untuk membatasi akses lihat hanya untuk pengelola ruang atau asisten pengelola), tentukan AccessPermissionSetting kosong (tanpa principals).

AccessPermissionSetting

Setelan izin akses.

Representasi JSON 
{
  "principals": [
    {
      object (Principal)
    }
  ]
}
Kolom
principals[]

object (Principal)

Opsional. Daftar yang tidak diurutkan. Akun utama yang diizinkan untuk izin ini.

Akun utama

Akun utama yang mewakili entitas yang diberi akses.

Representasi JSON 
{

  "audience": {
    object (Audience)
  }
}
Kolom
Jenis akun utama. Berikut adalah daftar kolom yang sama-sama bersifat eksklusif. Maksimal satu kolom akan ditetapkan dalam respons:
audience

object (Audience)

Audiens.
Akhir kolom yang saling eksklusif.

Audiens

Target audiens di Google Chat. Audiens target mewakili sekelompok pengguna dalam organisasi Google Workspace, yang ditentukan oleh administrator. Audiens target digunakan untuk mengonfigurasi setelan akses dan visibilitas untuk resource, seperti membuat ruang dapat ditemukan oleh grup pengguna tertentu.

Untuk mengetahui detail selengkapnya, lihat Audiens target dan Membuat ruang dapat ditemukan oleh audiens target.

Representasi JSON 
{
  "name": string
}
Kolom
name

string

Nama resource audiens target yang dapat menemukan atau bergabung ke ruang. 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.

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 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 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)
  },
  "viewSpaceMembership": {
    object (PermissionSetting)
  }
}
Kolom
manageMembersAndGroups

object (PermissionSetting)

Opsional. Setelan untuk mengelola anggota dan grup dalam 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 di ruang.
manageWebhooks

object (PermissionSetting)

Opsional. Setelan untuk mengelola webhook di ruang.
postMessages

object (PermissionSetting)

Hanya output. Setelan untuk memposting pesan di ruang.
replyMessages

object (PermissionSetting)

Opsional. Setelan untuk membalas pesan dalam ruang.
viewSpaceMembership

object (PermissionSetting)

Opsional. Setelan untuk melihat keanggotaan ruang. Harus ditentukan bersama dengan AccessPermissionSettings.view_space_membership_setting dalam mask update dan isi permintaan saat memperbarui siapa yang dapat melihat keanggotaan ruang. Saat membatasi akses lihat ke peran tertentu (misalnya, hanya pengelola ruang atau asisten pengelola), tentukan izin peran yang diinginkan di sini dan berikan AccessPermissionSettings.view_space_membership_setting kosong dalam permintaan yang sama. Jika audiens target dikonfigurasi di AccessPermissionSettings.view_space_membership_setting, setelan ini harus diberikan kepada semua anggota.

PermissionSetting

Merepresentasikan setelan izin ruang.

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

boolean

Opsional. Apakah pemilik ruang (ROLE_MANAGER) memiliki izin ini.
membersAllowed

boolean

Opsional. Apakah anggota ruang dasar (ROLE_MEMBER) memiliki izin ini.
assistantManagersAllowed

boolean

Opsional. Apakah pengelola ruang ROLE_ASSISTANT_MANAGER) memiliki izin ini.

SpaceSessionState

Status sesi ruang.

Enum
SPACE_SESSION_STATE_UNSPECIFIED Tidak ditentukan. Jangan gunakan.
NOT_SUPPORTED Ruang tidak memiliki dukungan sesi.
THREAD Ruang mendukung sesi berdasarkan rangkaian pesan.

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.

findGroupChats

 Menampilkan semua ruang dengan spaceType == GROUP_CHAT, yang keanggotaan manusianya berisi pengguna yang menelepon, dan pengguna yang ditentukan dalam FindGroupChatsRequest.users.

get

 Menampilkan detail tentang ruang.

list

 Mencantumkan ruang tempat penelepon menjadi anggota.

patch

 Memperbarui ruang.
Menampilkan daftar ruang dalam organisasi Google Workspace.

setup

 Membuat ruang dan menambahkan pengguna yang ditentukan ke dalamnya.