Panduan ini menjelaskan cara menggunakan metode patch
pada resource Space
Google Chat API untuk memperbarui ruang. Perbarui spasi untuk mengubah atribut tentang
{i>space <i}, seperti nama tampilan yang
terlihat oleh pengguna, deskripsi, dan panduan.
Tujuan
Referensi Space
mewakili tempat pengguna 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.
- {i>Chat<i} grup adalah percakapan antara tiga pengguna atau lebih dan Aplikasi Chat.
- Ruang bernama adalah tempat tetap tempat orang mengirim pesan, berbagi file, dan berkolaborasi.
Prasyarat
Python
- Sebuah Business atau Enterprise Akun Google Workspace yang memiliki akses ke Google Chat.
- Python 3.6 atau yang lebih baru
- Alat pengelolaan paket pip
- Library klien Google terbaru. Untuk menginstal atau memperbaruinya,
jalankan perintah berikut di antarmuka command line Anda:
pip3 install --upgrade google-api-python-client google-auth-oauthlib
- Menyiapkan lingkungan Anda:
- Buat project Google Cloud.
- Konfigurasi layar izin OAuth.
- Aktifkan dan konfigurasikan Google Chat API dengan nama, ikon, dan deskripsi untuk aplikasi Chat Anda.
-
Membuat kredensial client ID OAuth untuk aplikasi desktop. Untuk menjalankan
sampel dalam
panduan, simpan kredensial sebagai file JSON (
client_secrets.json
) ke direktori lokal.
- Pilih cakupan otorisasi yang mendukung autentikasi pengguna.
Node.js
- Sebuah Business atau Enterprise Akun Google Workspace yang memiliki akses ke Google Chat.
- Node.js 14 atau yang lebih baru
- npm alat pengelolaan paket
- Library klien Google terbaru. Untuk menginstal atau memperbaruinya,
jalankan perintah berikut di antarmuka command line Anda:
npm install @google-cloud/local-auth @googleapis/chat
- Menyiapkan lingkungan Anda:
- Buat project Google Cloud.
- Konfigurasi layar izin OAuth.
- Aktifkan dan konfigurasikan Google Chat API dengan nama, ikon, dan deskripsi untuk aplikasi Chat Anda.
-
Membuat kredensial client ID OAuth untuk aplikasi desktop. Untuk menjalankan
sampel dalam
panduan, simpan kredensial sebagai file JSON (
client_secrets.json
) ke direktori lokal.
- Pilih cakupan otorisasi yang mendukung autentikasi pengguna.
Memperbarui ruang
Untuk memperbarui ruang yang ada di Google Chat, teruskan dalam permintaan Anda:
- Tentukan cakupan otorisasi
chat.spaces
. - Panggil
Metode
patch
pada resourceSpace
. Di beberapa permintaan Anda, Anda menentukan kolomname
ruang,updateMask
kolom dengan satu atau beberapa kolom untuk diperbarui, danbody
dengan informasi ruang yang diperbarui.
Anda dapat memperbarui hal-hal seperti nama tampilan, jenis ruang, status histori, dan banyak lagi. Untuk melihat semua kolom yang dapat diperbarui, lihat dokumentasi referensi.
Berikut cara memperbarui kolom spaceDetails
dari ruang yang ada:
Python
- Di direktori kerja, buat file bernama
chat_space_update.py
. Sertakan kode berikut di
chat_space_update.py
:from google_auth_oauthlib.flow import InstalledAppFlow from googleapiclient.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.spaces"] def main(): ''' Authenticates with Chat API via user credentials, then updates the specified space description and guidelines. ''' # Authenticate with Google Workspace # and get user authorization. flow = InstalledAppFlow.from_client_secrets_file( 'client_secrets.json', SCOPES) creds = flow.run_local_server() # 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
SPACE
dengan nama ruang, yang yang dapat diperoleh dari Metodespaces.list
di Chat API, atau dari URL ruang.Dalam direktori kerja, build dan jalankan contoh:
python3 chat_space_update.py
Node.js
- Di direktori kerja, buat file bernama
update-space.js
. Sertakan kode berikut di
update-space.js
:const chat = require('@googleapis/chat'); const {authenticate} = require('@google-cloud/local-auth'); /** * Updates a Chat space with the description and guidelines. * @return {!Promise<!Object>} */ async function updateSpace() { const scopes = [ 'https://www.googleapis.com/auth/chat.spaces', ]; const authClient = await authenticate({scopes, keyfilePath: 'client_secrets.json'}); const chatClient = await chat.chat({version: 'v1', auth: authClient}); return await chatClient.spaces.patch({ name: 'spaces/SPACE', updateMask: 'spaceDetails', requestBody: { spaceDetails: { description: 'This description was updated with Chat API!', guidelines: 'These guidelines were updated with Chat API!' }, } }); } updateSpace().then(console.log);
Dalam kode, ganti
SPACE
dengan nama ruang, yang yang dapat diperoleh dari Metodespaces.list
di Chat API, atau dari URL ruang.Dalam direktori kerja Anda, jalankan contoh:
node update-space.js
Google Chat API menampilkan instance
Space
referensi yang mencerminkan pembaruan.
Topik terkait
- Mendapatkan detail tentang ruang.
- Mencantumkan ruang.
- Menghapus ruang.
- Menyiapkan ruang.
- Menemukan ruang pesan langsung.
- Membuat ruang dapat ditemukan oleh pengguna tertentu.