Panduan ini menjelaskan cara menggunakan metode
setUp()
di resource Space
Google Chat API untuk menyiapkan ruang Google Chat. Menyiapkan ruang akan membuat ruang dan menambahkan pengguna yang ditentukan ke dalamnya.
Resource Space
mewakili tempat orang dan aplikasi Chat dapat mengirim pesan, berbagi file, dan berkolaborasi. Ada beberapa jenis ruang:
- Pesan langsung (DM) adalah percakapan antara dua pengguna atau pengguna dan aplikasi Chat.
- Chat grup adalah percakapan antara tiga pengguna atau lebih dan aplikasi Chat.
- Ruang bernama adalah tempat permanen tempat orang mengirim pesan, berbagi file, dan berkolaborasi.
Saat menyiapkan ruang, pertimbangkan hal-hal berikut:
- Pengguna yang melakukan panggilan (diautentikasi) akan otomatis ditambahkan ke ruang, sehingga Anda tidak perlu menentukan keanggotaan pengguna dalam permintaan.
- Saat membuat pesan langsung (DM), jika DM ada di antara dua pengguna, DM akan ditampilkan. Jika tidak, DM akan dibuat.
- Saat membuat chat grup, jika tidak ada keanggotaan yang diberikan dalam permintaan yang berhasil ditambahkan ke chat grup (misalnya, masalah izin), chat grup kosong (termasuk hanya pengguna yang menelepon) mungkin akan dibuat.
- Anda tidak dapat menyiapkan ruang dengan balasan berangkai atau menambahkan orang di luar Google Workspace.
- Langganan duplikat (termasuk pengguna yang menelepon) yang diberikan dalam permintaan akan difilter, bukan menyebabkan error permintaan.
Prasyarat
Node.js
- Akun Google Workspace Business atau Enterprise dengan akses ke Google Chat.
- Siapkan lingkungan Anda:
- Buat project Google Cloud.
- Konfigurasikan layar izin OAuth.
- Aktifkan dan konfigurasikan Google Chat API dengan nama, ikon, dan deskripsi untuk aplikasi Chat Anda.
- Instal Library Klien Cloud Node.js.
-
Buat kredensial client ID OAuth untuk aplikasi desktop. Untuk menjalankan contoh dalam panduan ini, simpan kredensial sebagai file JSON bernama
client_secrets.json
ke direktori lokal Anda.
- Pilih cakupan otorisasi yang mendukung autentikasi pengguna.
Python
- Akun Google Workspace Business atau Enterprise dengan akses ke Google Chat.
- Siapkan lingkungan Anda:
- Buat project Google Cloud.
- Konfigurasi layar izin OAuth.
- Mengaktifkan dan mengonfigurasi Google Chat API dengan nama, ikon, dan deskripsi untuk aplikasi Chat Anda.
- Instal Library Klien Cloud Python.
-
Buat kredensial client ID OAuth untuk aplikasi desktop. Untuk menjalankan contoh dalam panduan ini, simpan kredensial sebagai file JSON bernama
client_secrets.json
ke direktori lokal Anda.
- Pilih cakupan otorisasi yang mendukung autentikasi pengguna.
Java
- Akun Google Workspace Business atau Enterprise dengan akses ke Google Chat.
- Siapkan lingkungan Anda:
- Buat project Google Cloud.
- Konfigurasikan layar izin OAuth.
- Aktifkan dan konfigurasikan Google Chat API dengan nama, ikon, dan deskripsi untuk aplikasi Chat Anda.
- Instal Library Klien Cloud Java.
-
Membuat kredensial client ID OAuth untuk aplikasi desktop. Untuk menjalankan contoh dalam panduan ini, simpan kredensial sebagai file JSON bernama
client_secrets.json
ke direktori lokal Anda.
- Pilih cakupan otorisasi yang mendukung autentikasi pengguna.
Apps Script
- Akun Google Workspace Business atau Enterprise dengan akses ke Google Chat.
- Siapkan lingkungan Anda:
- Buat project Google Cloud.
- Konfigurasikan layar izin OAuth.
- Aktifkan dan konfigurasikan Google Chat API dengan nama, ikon, dan deskripsi untuk aplikasi Chat Anda.
- Buat project Apps Script mandiri, dan aktifkan Layanan Chat Lanjutan.
- Pilih cakupan otorisasi yang mendukung autentikasi pengguna.
Menyiapkan ruang
Untuk menyiapkan ruang, teruskan hal berikut dalam permintaan Anda:
- Tentukan cakupan otorisasi
chat.spaces.create
atauchat.spaces
. - Panggil
metode
SetUpSpace()
. - Teruskan
space
sebagai instanceSpace
dengan semua kolom yang diperlukan sepertidisplayName
atauspaceType
. - Teruskan
memberships
sebagai array instanceMembership
. Untuk setiap instance:- Tentukan
users/{user}
untuk menambahkan pengguna manusia sebagai anggota ruang, dengan{user}
adalah{person_id}
untukperson
dari People API, atau IDuser
di Directory API. Misalnya, jika orang People APIresourceName
adalahpeople/123456789
, Anda dapat menambahkan pengguna ke ruang dengan menyertakan keanggotaan denganusers/123456789
sebagaimember.name
. - Tentukan
groups/{group}
untuk menambahkan grup sebagai anggota ruang, dengan{group}
adalah ID grup yang ingin Anda buat keanggotaannya. ID untuk grup dapat diambil menggunakan Cloud Identity API. Misalnya, jika Cloud Identity API menampilkan grup dengan namagroups/123456789
, tetapkanmembership.groupMember.name
kegroups/123456789
. Google Grup tidak dapat ditambahkan ke chat grup atau DM, tetapi hanya ke ruang yang diberi nama.
- Tentukan
Untuk membuat DM antara pengguna yang menelepon dan pengguna manusia lainnya, tentukan keanggotaan pengguna manusia dalam permintaan Anda.
Untuk membuat DM antara pengguna yang melakukan panggilan dan aplikasi yang melakukan 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 membuat langganan.
Contoh berikut membuat ruang bernama dan membuat satu langganan ke ruang untuk dua pengguna manusia (pengguna terautentikasi dan satu pengguna lainnya).
Node.js
Python
Java
Apps Script
Untuk menjalankan contoh, ganti kode berikut:
DISPLAY_NAME
: nama tampilan ruang baru.USER_NAME
: ID pengguna lain yang akan menyertakan keanggotaan.
Untuk membuka ruang, gunakan ID resource ruang untuk membuat URL ruang.
Anda bisa mendapatkan ID resource dari ruang name
di isi respons Google Chat. Misalnya, jika name
ruang Anda adalah spaces/1234567
, Anda dapat membuka ruang tersebut menggunakan URL berikut: https://mail.google.com/chat/u/0/#chat/space/1234567
.
Topik terkait
- Buat ruang.
- Mendapatkan detail tentang ruang.
- Mencantumkan ruang.
- Memperbarui ruang.
- Menghapus ruang.
- Temukan ruang pesan langsung.
- Membuat ruang dapat ditemukan oleh pengguna tertentu.