Method: spaces.setup

Membuat ruang dan menambahkan pengguna tertentu ke dalamnya. Pengguna yang menelepon akan otomatis ditambahkan ke ruang, dan tidak boleh ditetapkan sebagai keanggotaan dalam permintaan. Untuk mengetahui contohnya, 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} dapat menjadi alamat email pengguna tersebut. 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 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 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 melakukan panggilan dan pengguna manusia lainnya, tentukan satu keanggotaan untuk mewakili pengguna manusia. Jika satu pengguna memblokir pengguna yang lain, permintaan akan gagal dan DM tidak akan dibuat.

Untuk membuat DM antara pengguna yang melakukan panggilan dan aplikasi panggilan, tetapkan Space.singleUserBotDm ke true dan jangan tetapkan 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 di antara dua pengguna manusia, lihat membuat keanggotaan.

Jika DM sudah ada di antara dua pengguna, meskipun salah satu pengguna memblokir pengguna lainnya 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 diisi. 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 sudah 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 antarmanusia, 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 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. Sebaiknya gunakan UUID acak. Menentukan ID permintaan yang ada akan mengembalikan 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 Google Chat yang akan diundang untuk bergabung ke ruang. Abaikan pengguna yang melakukan panggilan, karena pengguna tersebut ditambahkan secara otomatis.

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

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}.

Opsional saat menetapkan Space.spaceType ke SPACE.

Wajib saat Space.spaceType ditetapkan ke GROUP_CHAT, bersama dengan setidaknya dua keanggotaan.

Wajib saat Space.spaceType ditetapkan ke DIRECT_MESSAGE dengan pengguna manusia, beserta tepat 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 akan berisi 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 informasi selengkapnya, lihat Panduan otorisasi.