Method: spaces.setup

Membuat ruang dan menambahkan pengguna yang ditentukan ke dalamnya. Pengguna yang melakukan panggilan ditambahkan ke ruang secara otomatis, dan tidak boleh ditetapkan sebagai keanggotaan dalam permintaan. Untuk contoh, lihat Menyiapkan ruang.

Untuk menentukan anggota manusia yang akan ditambahkan, tambahkan keanggotaan dengan member.name yang sesuai di SetUpSpaceRequest. Untuk menambahkan pengguna manusia, gunakan users/{user}, dengan {user} sebagai {person_id} untuk orang dari People API, atau id untuk pengguna di Admin SDK Directory API. Misalnya, jika People API Person resourceName adalah people/123456789, Anda dapat menambahkan pengguna ke ruang dengan menyertakan keanggotaan dengan users/123456789 sebagai member.name.

Untuk ruang atau chat grup, jika penelepon memblokir atau diblokir oleh beberapa anggota, anggota tersebut tidak akan ditambahkan ke ruang yang dibuat.

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

Untuk membuat DM antara pengguna yang menelepon dan aplikasi panggilan, tetapkan Space.singleUserBotDm ke true, dan jangan tentukan langganan 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 membuat keanggotaan.

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

Ruang dengan balasan berangkai atau akses tamu tidak didukung.

Memerlukan autentikasi pengguna dan cakupan chat.spaces.create atau chat.spaces.

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 diisi. Kolom Space.spaceType wajib diisi.

Untuk membuat ruang, setel Space.spaceType ke SPACE dan setel Space.displayName.

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

Untuk membuat percakapan 1:1 antara pengguna, 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 pengguna dan aplikasi Chat yang menelepon, 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 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. Kumpulan awal pengguna dalam domain yang diundang untuk bergabung ke ruang. Pengguna yang melakukan panggilan ditambahkan ke ruang secara otomatis, dan tidak boleh ditentukan sebagai keanggotaan.

Set saat ini memungkinkan hingga 20 keanggotaan (selain pemanggil).

Kolom Membership.member harus berisi pengguna dengan pengisian name dan User.Type.HUMAN. Semua kolom lainnya akan diabaikan.

Opsional saat menyetel Space.spaceType ke SPACE.

Diperlukan saat menyetel Space.spaceType ke GROUP_CHAT, beserta minimal dua langganan.

Diperlukan saat menyetel Space.spaceType ke DIRECT_MESSAGE dengan pengguna manusia, beserta satu keanggotaan.

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

Tidak didukung: Mengundang pengguna tamu atau menambahkan aplikasi Chat lainnya.

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.