Method: spaces.setup

Membuat ruang dan menambahkan pengguna tertentu ke dalamnya. Pengguna yang memanggil otomatis ditambahkan ke ruang, dan tidak boleh ditentukan sebagai keanggotaan dalam permintaan. Untuk melihat 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 pengguna. Untuk pengguna di organisasi Workspace yang sama, {user} juga dapat berupa id untuk orang dari People API, atau id untuk pengguna di Directory API. Misalnya, jika ID profil Orang People API 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 menyetel membership.group_member.name ke groups/123456789. Email grup tidak didukung, dan grup Google hanya dapat ditambahkan sebagai anggota di ruang bernama.

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

Untuk membuat pesan langsung (DM) antara pengguna yang memanggil dan pengguna manusia lain, tentukan tepat satu keanggotaan untuk mewakili pengguna manusia. Jika salah satu pengguna memblokir pengguna lain, permintaan akan gagal dan DM tidak akan dibuat.

Untuk membuat DM antara pengguna yang memanggil dan aplikasi yang memanggil, 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 sudah 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 lain 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 ada dalam organisasi Google Workspace mungkin sudah menggunakan nama tampilan ini.

Memerlukan autentikasi pengguna dengan salah satu cakupan otorisasi berikut:

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

Permintaan HTTP

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

URL ini 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 dan tetapkan Space.displayName. Jika Anda menerima pesan error ALREADY_EXISTS saat menyiapkan ruang, coba displayName lain. Ruang yang ada dalam organisasi Google Workspace mungkin sudah menggunakan nama tampilan ini.

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

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

Untuk membuat percakapan 1:1 antara manusia dan aplikasi Chat yang melakukan panggilan, 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. UUID acak direkomendasikan. Menentukan ID permintaan membuat permintaan menjadi idempoten, yang memastikan bahwa beberapa permintaan identik dengan ID permintaan yang sama hanya menghasilkan satu ruang yang dibuat. Permintaan berikutnya dengan ID permintaan yang sama akan menampilkan ruang yang ada dan tidak memperbarui ruang, meskipun detail yang diminta berbeda dari status saat ini.

Untuk menggunakan kolom ini secara efektif:

  • Pastikan permintaan berikutnya identik dan menggunakan kredensial autentikasi yang sama dengan permintaan asli.
  • Jika ruang sudah dibuat dengan ID permintaan yang diberikan, permintaan akan menampilkan ruang tersebut. Perhatikan bahwa ruang yang ditampilkan mungkin tidak terisi sepenuhnya; API mengulangi ruang dalam permintaan Anda dengan nama resource yang ditetapkan sistem terisi. Untuk mengambil metadata terbaru ruang, panggil spaces.get.
  • Menggunakan kembali ID permintaan yang ada dengan pengguna terautentikasi yang berbeda akan menghasilkan error.
memberships[]

object (Membership)

Opsional. Pengguna atau grup Google Chat yang akan diundang untuk bergabung ke ruang. Jangan sertakan pengguna yang memanggil, karena mereka ditambahkan secara otomatis.

Set saat ini mengizinkan hingga 49 langganan (selain pemanggil).

Untuk keanggotaan manusia, kolom Membership.member harus berisi user dengan name yang diisi (format: users/{user}) dan type ditetapkan ke User.Type.HUMAN. Anda hanya dapat menambahkan pengguna manusia saat menyiapkan ruang (penambahan 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 keanggotaan grup Google, kolom Membership.group_member harus berisi group dengan name yang diisi (format groups/{group}). Anda hanya dapat menambahkan grup Google saat menyetel Space.spaceType ke SPACE.

Opsional saat menyetel Space.spaceType ke SPACE.

Wajib diisi saat menyetel Space.spaceType ke GROUP_CHAT, bersama dengan setidaknya dua langganan.

Wajib diisi saat menyetel Space.spaceType ke DIRECT_MESSAGE dengan pengguna manusia, bersama dengan tepat satu keanggotaan.

Harus kosong saat membuat percakapan 1:1 antara manusia dan aplikasi Chat yang memanggil (saat menyetel 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.