Method: spaces.patch

Memperbarui ruang. Sebagai contoh, lihat Memperbarui ruang.

Jika Anda memperbarui kolom displayName dan menerima pesan error ALREADY_EXISTS, coba nama tampilan lain. Ruang yang sudah ada dalam organisasi Google Workspace mungkin sudah menggunakan nama tampilan ini.

Mendukung jenis autentikasi berikut:

Permintaan HTTP

PATCH https://chat.googleapis.com/v1/{space.name=spaces/*}

URL menggunakan sintaksis gRPC Transcoding.

Parameter jalur

Parameter
space.name

string

ID. Nama resource ruang.

Format: spaces/{space}

Dengan {space} mewakili ID yang ditetapkan sistem untuk ruang. Anda dapat memperoleh 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.

Parameter kueri

Parameter
updateMask

string (FieldMask format)

Wajib. Jalur kolom yang diperbarui, dipisahkan koma jika ada beberapa.

Anda dapat memperbarui kolom berikut untuk ruang:

spaceDetails: Memperbarui deskripsi ruang. Mendukung hingga 150 karakter.

displayName: Hanya mendukung pembaruan nama tampilan untuk ruang dengan kolom spaceType SPACE. Jika Anda menerima pesan error ALREADY_EXISTS, coba nilai lain. Ruang yang ada dalam organisasi Google Workspace mungkin sudah menggunakan nama tampilan ini.

spaceType: Hanya mendukung perubahan jenis ruang GROUP_CHAT menjadi SPACE. Sertakan displayName bersama dengan spaceType dalam mask update dan pastikan ruang yang ditentukan memiliki nama tampilan yang tidak kosong dan jenis ruang SPACE. Menyertakan mask spaceType dan jenis SPACE di ruang yang ditentukan saat memperbarui nama tampilan bersifat opsional jika ruang yang ada sudah memiliki jenis SPACE. Mencoba memperbarui jenis spasi dengan cara lain akan menghasilkan error argumen yang tidak valid. spaceType tidak didukung dengan useAdminAccess.

spaceHistoryState: Memperbarui setelan histori ruang dengan mengaktifkan atau menonaktifkan histori untuk ruang. Hanya didukung jika setelan histori diaktifkan untuk organisasi Google Workspace. Untuk memperbarui status histori ruang, Anda harus menghapus semua mask kolom lainnya dalam permintaan. spaceHistoryState tidak didukung dengan useAdminAccess.

accessSettings.audience: Memperbarui setelan akses terkait siapa saja yang dapat menemukan ruang, bergabung ke ruang, dan melihat pratinjau pesan di ruang bernama dengan kolom spaceType sebagai SPACE. Jika ruang yang ada memiliki target audiens, Anda dapat menghapus audiens dan membatasi akses ruang dengan menghilangkan nilai untuk mask kolom ini. Guna memperbarui setelan akses untuk ruang, pengguna yang mengautentikasi harus menjadi pengelola ruang dan menghilangkan semua mask kolom lainnya dalam permintaan Anda. Anda tidak dapat memperbarui kolom ini jika ruang berada dalam mode impor. Untuk mempelajari lebih lanjut, lihat Membuat ruang yang dapat ditemukan oleh pengguna tertentu. accessSettings.audience tidak didukung dengan useAdminAccess.

permissionSettings: Mendukung perubahan setelan izin ruang. Saat memperbarui setelan izin, Anda hanya dapat menentukan mask kolom permissionSettings; Anda tidak dapat memperbarui mask kolom lainnya secara bersamaan. permissionSettings tidak didukung dengan useAdminAccess. Mask kolom yang didukung meliputi:

  • permissionSettings.manageMembersAndGroups
  • permissionSettings.modifySpaceDetails
  • permissionSettings.toggleHistory
  • permissionSettings.useAtMentionAll
  • permissionSettings.manageApps
  • permissionSettings.manageWebhooks
  • permissionSettings.replyMessages
useAdminAccess

boolean

Opsional. Saat true, metode akan berjalan menggunakan hak istimewa administrator Google Workspace pengguna.

Pengguna yang menelepon harus merupakan administrator Google Workspace dengan hak istimewa mengelola percakapan chat dan ruang.

Memerlukan cakupan OAuth 2.0 chat.admin.spaces.

Beberapa nilai FieldMask tidak didukung menggunakan akses admin. Untuk mengetahui detailnya, lihat deskripsi updateMask.

Isi permintaan

Isi permintaan memuat instance Space.

Isi respons

Jika berhasil, isi respons memuat instance Space.

Cakupan otorisasi

Memerlukan salah satu cakupan OAuth berikut:

  • https://www.googleapis.com/auth/chat.app.spaces
  • https://www.googleapis.com/auth/chat.admin.spaces
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.spaces

Untuk mengetahui informasi selengkapnya, lihat Panduan otorisasi.