Memperbarui ruang (original) (raw)
Panduan ini menjelaskan cara menggunakan metodepatch()pada resource Space Google Chat API untuk memperbarui ruang. Perbarui ruang untuk mengubah atribut tentang ruang, seperti nama tampilan yang terlihat oleh pengguna, deskripsi, dan panduannya.
Jika Anda adalah administrator Google Workspace, Anda dapat memanggil metode patch() untuk memperbarui ruang yang ada di organisasi Google Workspace Anda.
ResourceSpacemerepresentasikan tempat di mana 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 berkelanjutan tempat orang mengirim pesan, berbagi file, dan berkolaborasi.
Prasyarat
Node.js
- Akun Google Workspace Business atau Enterprise dengan akses ke Google Chat.
- Siapkan lingkungan Anda:
- Buat project Google Cloud.
- Konfigurasi layar izin OAuth.
- Aktifkan dan konfigurasi 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
credentials.jsonke direktori lokal Anda.
Untuk mendapatkan panduan, selesaikan langkah-langkah penyiapan lingkungan dipanduan memulai cepat ini.
- Pilih cakupan otorisasi yang mendukung autentikasi pengguna.
- Ruang Google Chat. Untuk membuatnya menggunakan Google Chat API, lihatMembuat ruang. Untuk membuatnya di Chat, bukadokumentasi Pusat Bantuan.
Python
- Akun Google Workspace Business atau Enterprise dengan akses ke Google Chat.
- Siapkan lingkungan Anda:
- Buat project Google Cloud.
- Konfigurasi layar izin OAuth.
- Aktifkan dan konfigurasi Google Chat API dengan nama, ikon, dan deskripsi untuk aplikasi Chat Anda.
- Instal Python Cloud Client Library.
- Buat kredensial client ID OAuth untuk aplikasi desktop. Untuk menjalankan contoh dalam panduan ini, simpan kredensial sebagai file JSON bernama
credentials.jsonke direktori lokal Anda.
Untuk mendapatkan panduan, selesaikan langkah-langkah penyiapan lingkungan dipanduan memulai cepat ini.
- Pilih cakupan otorisasi yang mendukung autentikasi pengguna.
- Ruang Google Chat. Untuk membuatnya menggunakan Google Chat API, lihatMembuat ruang. Untuk membuatnya di Chat, bukadokumentasi Pusat Bantuan.
Java
- Akun Google Workspace Business atau Enterprise dengan akses ke Google Chat.
- Siapkan lingkungan Anda:
- Buat project Google Cloud.
- Konfigurasi layar izin OAuth.
- Aktifkan dan konfigurasi Google Chat API dengan nama, ikon, dan deskripsi untuk aplikasi Chat Anda.
- Instal Java Cloud Client Library.
- Buat kredensial client ID OAuth untuk aplikasi desktop. Untuk menjalankan contoh dalam panduan ini, simpan kredensial sebagai file JSON bernama
credentials.jsonke direktori lokal Anda.
Untuk mendapatkan panduan, selesaikan langkah-langkah penyiapan lingkungan dipanduan memulai cepat ini.
- Pilih cakupan otorisasi yang mendukung autentikasi pengguna.
- Ruang Google Chat. Untuk membuatnya menggunakan Google Chat API, lihatMembuat ruang. Untuk membuatnya di Chat, bukadokumentasi Pusat Bantuan.
Apps Script
- Akun Google Workspace Business atau Enterprise dengan akses ke Google Chat.
- Siapkan lingkungan Anda:
- Buat project Google Cloud.
- Konfigurasi layar izin OAuth.
- Aktifkan dan konfigurasi Google Chat API dengan nama, ikon, dan deskripsi untuk aplikasi Chat Anda.
- Buat project Apps Script mandiri, lalu aktifkan Advanced Chat Service.
Untuk mengetahui langkah-langkah penyiapan lingkungan, selesaikanpanduan memulai ini.
- Pilih cakupan otorisasi yang mendukung autentikasi pengguna.
- Ruang Google Chat. Untuk membuatnya menggunakan Google Chat API, lihatMembuat ruang. Untuk membuatnya di Chat, bukadokumentasi Pusat Bantuan.
Memperbarui ruang sebagai pengguna
Untuk memperbarui ruang yang ada di Google Chat denganautentikasi pengguna, teruskan hal berikut dalam permintaan Anda:
- Tentukan cakupan otorisasi
chat.spaces. - Panggil metodeUpdateSpace(). Dalam permintaan, Anda menentukan kolom ruang
name, kolomupdateMaskdengan satu atau beberapa kolom yang akan diperbarui, danbodydengan informasi ruang yang diperbarui.
Anda dapat memperbarui hal-hal seperti nama tampilan, jenis ruang, status histori, dan lainnya. Untuk melihat semua kolom yang dapat Anda perbarui, lihatdokumentasi referensi.
Berikut cara memperbarui kolom displayName ruang yang ada:
Node.js
Python
Java
Apps Script
Untuk menjalankan contoh ini, ganti SPACE_NAME dengan ID dari kolomnameruang. Anda bisa mendapatkan ID dengan memanggil metodeListSpaces()atau dari URL ruang.
Google Chat API menampilkan instanceSpace yang mencerminkan pembaruan.
Memperbarui ruang sebagai administrator Google Workspace
Jika Anda adalah administrator Google Workspace, Anda dapat memanggil metodeUpdateSpace() untuk memperbarui ruang di organisasi Google Workspace Anda.
Untuk memanggil metode ini sebagai administrator Google Workspace, lakukan hal berikut:
- Panggil metode menggunakan autentikasi pengguna, dan tentukancakupan otorisasiyang mendukung panggilan metode menggunakanhak istimewa administrator.
- Dalam permintaan Anda, tentukan parameter kueri
useAdminAccessketrue.
Untuk mengetahui informasi dan contoh selengkapnya, lihatMengelola ruang Google Chat sebagai administrator Google Workspace.
Memperbarui ruang sebagai aplikasi Chat
Autentikasi aplikasi memerlukanpersetujuan administrator satu kali.
Untuk memperbarui ruang yang ada di Google Chat denganautentikasi aplikasi, luluskan hal berikut dalam permintaan Anda:
- Tentukan cakupan otorisasi
chat.app.spaces. Dengan autentikasi aplikasi, Anda hanya dapat memperbarui ruang yang dibuat oleh aplikasi Chat. - Panggilmetode patchpada resource Space. Dalam permintaan, Anda menentukan kolom ruang
name, kolomupdateMaskdengan satu atau beberapa kolom yang akan diperbarui, danbodydengan informasi ruang yang diperbarui.
Anda dapat memperbarui hal-hal seperti nama tampilan, jenis ruang, status histori, setelan izin, dan lainnya. Untuk melihat semua kolom yang dapat Anda perbarui, lihatdokumentasi referensi.
Menulis skrip yang memanggil Chat API
Berikut cara memperbarui kolom spaceDetails ruang yang ada:
Python
- Di direktori kerja Anda, buat file bernama
chat_space_update_app.py. - Sertakan kode berikut di
chat_space_update_app.py:
from google.oauth2 import service_account
from apiclient.discovery import build
# Define your app's authorization scopes.
# When modifying these scopes, delete the file token.json, if it exists.
SCOPES = ["https://www.googleapis.com/auth/chat.app.spaces"]
def main():
'''
Authenticates with Chat API using app authentication,
then updates the specified space description and guidelines.
'''
# Specify service account details.
creds = (
service_account.Credentials.from_service_account_file('credentials.json')
.with_scopes(SCOPES)
)
# Build a service endpoint for Chat API.
chat = build('chat', 'v1', credentials=creds)
# Use the service endpoint to call Chat API.
result = chat.spaces().patch(
# The space to update, and the updated space details.
#
# Replace {space} with a space name.
# Obtain the space name from the spaces resource of Chat API,
# or from a space's URL.
name='spaces/SPACE',
updateMask='spaceDetails',
body={
'spaceDetails': {
'description': 'This description was updated with Chat API!',
'guidelines': 'These guidelines were updated with Chat API!'
}
}
).execute()
# Prints details about the updated space.
print(result)
if __name__ == '__main__':
main() - Dalam kode, ganti kode berikut:
SPACEdengan nama ruang, yang dapat Anda peroleh dari metode spaces.listdi Chat API, atau dari URL ruang.
- Di direktori kerja Anda, buat dan jalankan sampel:
python3 chat_space_update_app.py Google Chat API menampilkan instanceresource Space yang mencerminkan pembaruan.
Batasan dan pertimbangan
- Dengan autentikasi aplikasi, Aplikasi Chat:
- Hanya dapat memperbaruipredefinedPermissionSettingsataupermissionSettingsdi ruang yang mereka buat.
- Tidak dapat mengupdate accessSettings.audience.
- Mendapatkan detail tentang ruang.
- Mencantumkan ruang.
- Menghapus ruang.
- Menyiapkan ruang.
- Menemukan ruang pesan langsung.
- Membuat ruang dapat ditemukan oleh pengguna tertentu.