Method: spaces.setup

Membuat ruang dan menambahkan pengguna yang ditentukan ke dalamnya. Pengguna yang menelepon akan otomatis ditambahkan ke ruang, dan tidak boleh ditentukan sebagai keanggotaan dalam permintaan. Sebagai contoh, lihat Menyiapkan ruang dengan anggota awal.

Untuk menentukan anggota manusia yang akan ditambahkan, tambahkan keanggotaan dengan membership.member.name yang sesuai. Untuk menambahkan pengguna manusia, gunakan users/{user}, dengan {user} dapat berupa alamat email untuk pengguna. Untuk pengguna di organisasi Workspace yang sama, {user} juga dapat berupa id untuk pengguna dari People API, atau id untuk pengguna di Directory API. Misalnya, jika ID profil Person API People untuk user@example.com adalah 123456789, Anda dapat menambahkan pengguna ke ruang dengan menyetel membership.member.name ke users/user@example.com atau users/123456789.

Untuk menentukan grup Google yang akan ditambahkan, tambahkan keanggotaan dengan membership.group_member.name yang sesuai. Untuk menambahkan atau mengundang grup Google, gunakan groups/{group}, dengan {group} adalah id untuk grup dari Cloud Identity Groups API. Misalnya, Anda dapat menggunakan Cloud Identity Groups lookup API untuk mengambil ID 123456789 untuk email grup group@example.com, lalu Anda dapat menambahkan grup ke ruang dengan menetapkan membership.group_member.name ke groups/123456789. Email grup tidak didukung, dan grup Google hanya dapat ditambahkan sebagai anggota di ruang yang diberi nama.

Untuk ruang atau chat grup yang telah diberi nama, anggota tersebut tidak akan ditambahkan ke ruang yang dibuat jika pemanggil memblokir atau diblokir oleh beberapa anggota, atau tidak memiliki izin untuk menambahkan beberapa anggota.

Untuk membuat pesan langsung (DM) antara pengguna yang menelepon dan pengguna manusia lainnya, tentukan tepat satu langganan untuk mewakili pengguna manusia. Jika satu pengguna memblokir pengguna lainnya, permintaan akan gagal dan DM tidak dibuat.

Untuk membuat DM antara pengguna yang menelepon dan aplikasi panggilan, tetapkan Space.singleUserBotDm ke true dan jangan tentukan keanggotaan apa pun. Anda hanya dapat menggunakan metode ini untuk menyiapkan DM dengan aplikasi panggilan. Untuk menambahkan aplikasi panggilan sebagai anggota ruang atau DM yang ada antara dua pengguna manusia, lihat Mengundang atau menambahkan pengguna atau aplikasi ke ruang.

Jika DM sudah ada di antara dua pengguna, meskipun salah satu pengguna memblokir pengguna lainnya pada saat permintaan dibuat, DM yang ada akan ditampilkan.

Ruang dengan balasan berangkai tidak didukung. Jika Anda menerima pesan error ALREADY_EXISTS saat menyiapkan ruang, coba displayName lain. Ruang yang sudah ada dalam organisasi Google Workspace mungkin sudah menggunakan nama tampilan ini.

Memerlukan autentikasi pengguna.

Permintaan HTTP

POST https://chat.googleapis.com/v1/spaces:setup

URL menggunakan sintaksis gRPC Transcoding.

Isi permintaan

Isi permintaan memuat data dengan struktur berikut:

Representasi JSON 
{
  "space": {
    object (Space)
  },
  "requestId": string,
  "memberships": [
    {
      object (Membership)
    }
  ]
}
Kolom
space

object (Space)

Wajib. Kolom Space.spaceType wajib diisi.

Untuk membuat ruang, tetapkan Space.spaceType ke SPACE, lalu setel Space.displayName. Jika Anda menerima pesan error ALREADY_EXISTS saat menyiapkan ruang, coba displayName yang berbeda. Ruang yang ada dalam organisasi Google Workspace mungkin sudah menggunakan nama tampilan ini.

Untuk membuat chat grup, tetapkan Space.spaceType ke GROUP_CHAT. Jangan tetapkan Space.displayName.

Untuk membuat percakapan 1:1 antara manusia, tetapkan Space.spaceType ke DIRECT_MESSAGE dan tetapkan Space.singleUserBotDm ke false. Jangan menetapkan Space.displayName atau Space.spaceDetails.

Untuk membuat percakapan 1:1 antara manusia dan aplikasi Chat yang memanggil, tetapkan Space.spaceType ke DIRECT_MESSAGE dan Space.singleUserBotDm ke true. Jangan tetapkan Space.displayName atau Space.spaceDetails.

Jika ruang DIRECT_MESSAGE sudah ada, ruang tersebut akan ditampilkan, bukan membuat ruang baru.
requestId

string

Opsional. ID unik untuk permintaan ini. Sebaiknya gunakan UUID acak. Menentukan ID permintaan yang ada akan menampilkan ruang yang dibuat dengan ID tersebut, bukan membuat ruang baru. Menentukan ID permintaan yang ada dari aplikasi Chat yang sama dengan pengguna terautentikasi yang berbeda akan menampilkan error.
memberships[]

object (Membership)

Opsional. Pengguna atau grup Google Chat yang akan diundang untuk bergabung ke ruang. Hapus pengguna yang menelepon, karena pengguna tersebut ditambahkan secara otomatis.

Kumpulan tersebut saat ini mengizinkan hingga 20 keanggotaan (selain penelepon).

Untuk keanggotaan manusia, kolom Membership.member harus berisi user dengan name terisi (format: users/{user}) dan type ditetapkan ke User.Type.HUMAN. Anda hanya dapat menambahkan pengguna manusia saat menyiapkan ruang (menambahkan aplikasi Chat hanya didukung untuk penyiapan pesan langsung dengan aplikasi panggilan). Anda juga dapat menambahkan anggota menggunakan email pengguna sebagai alias untuk {user}. Misalnya, user.name dapat berupa users/example@gmail.com. Untuk mengundang pengguna Gmail atau pengguna dari domain Google Workspace eksternal, email pengguna harus digunakan untuk {user}.

Untuk langganan grup Google, kolom Membership.group_member harus berisi group dengan name terisi (format groups/{group}). Anda hanya dapat menambahkan grup Google saat menetapkan Space.spaceType ke SPACE.

Opsional saat menetapkan Space.spaceType ke SPACE.

Wajib jika menetapkan Space.spaceType ke GROUP_CHAT, bersama dengan setidaknya dua langganan.

Wajib saat menetapkan Space.spaceType ke DIRECT_MESSAGE dengan pengguna manusia, beserta satu keanggotaan.

Harus kosong saat membuat percakapan 1:1 antara manusia dan aplikasi Chat panggilan (saat menetapkan Space.spaceType ke DIRECT_MESSAGE dan Space.singleUserBotDm ke true).

Isi respons

Jika berhasil, isi respons memuat instance Space.

Cakupan otorisasi

Memerlukan salah satu cakupan OAuth berikut:

  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.create

Untuk mengetahui informasi selengkapnya, lihat Panduan otorisasi.