Panduan ini menjelaskan cara menggunakan metode patch
di resource Space
Google Chat API untuk memperbarui ruang. Perbarui ruang untuk mengubah atribut tentang
ruang, seperti nama tampilan, deskripsi, dan panduan yang terlihat oleh pengguna.
Resource 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 dengan aplikasi Chat.
- Chat grup adalah percakapan antara tiga pengguna atau lebih dan aplikasi Chat.
- Ruang bernama adalah tempat persisten tempat orang-orang mengirim pesan, berbagi file, dan berkolaborasi.
Prasyarat
Python
- Python 3.6 atau yang lebih baru
- Alat pengelolaan paket pip
Library klien Google terbaru untuk Python. Untuk menginstal atau mengupdatenya, jalankan perintah berikut di antarmuka command line Anda:
pip3 install --upgrade google-api-python-client google-auth-oauthlib
- Project Google Cloud dengan Google Chat API yang diaktifkan dan dikonfigurasi. Untuk mengetahui langkah-langkahnya, lihat Membangun aplikasi Google Chat.
Otorisasi yang dikonfigurasi untuk aplikasi Chat. Pembaruan ruang memerlukan autentikasi Pengguna dengan cakupan otorisasi
chat.spaces
.
Node.js
- Node.js & npm
Library klien Google terbaru untuk Node.js. Untuk menginstalnya, jalankan perintah berikut di antarmuka command line Anda:
npm install @google-cloud/local-auth @googleapis/chat
- Project Google Cloud dengan Google Chat API yang diaktifkan dan dikonfigurasi. Untuk mengetahui langkah-langkahnya, lihat Membangun aplikasi Google Chat.
Otorisasi yang dikonfigurasi untuk aplikasi Chat. Pembaruan ruang memerlukan autentikasi Pengguna dengan cakupan otorisasi
chat.spaces
.
Memperbarui ruang
Untuk memperbarui ruang yang ada di Google Chat, teruskan hal berikut dalam permintaan Anda:
- Tentukan cakupan otorisasi
chat.spaces
. - Panggil
metode
patch
pada resourceSpace
. Dalam permintaan, Anda menentukan kolomname
ruang, kolomupdateMask
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 lainnya. 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 dapat Anda peroleh 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 dapat Anda peroleh 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
resource Space
yang mencerminkan update.
Topik terkait
- Mendapatkan detail tentang ruang.
- Mencantumkan ruang.
- Menghapus ruang.
- Menyiapkan ruang.
- Menemukan ruang pesan langsung.
- Membuat ruang dapat ditemukan oleh pengguna tertentu.