本指南將說明如何使用
patch()
方法,使用 Google Chat API 的 Space
資源以更新聊天室。更新
空間變更聊天室屬性,例如向使用者顯示的顯示名稱。
說明及規範
如果你是 Google Workspace 管理員,可以呼叫 patch()
方法
更新 Google Workspace 機構的任何現有聊天室。
Space
項資源
代表使用者和 Chat 擴充應用程式可以傳送訊息的地方
分享檔案及協同合作聊天室分為以下幾種類型:
- 即時訊息 (DM) 是指兩位使用者或使用者之間的對話, Chat 應用程式。
- 群組通訊是指三位以上使用者與 Chat 應用程式之間的對話。
- 已命名的聊天室是使用者傳送訊息、共用檔案、 這項原則著重於透過對開放式探究 嚴謹治學、誠信與合作的堅持來達到上述目標
必要條件
Node.js
- 具備 Google Chat 存取權的 Google Workspace 企業或進階版帳戶。
- 設定環境:
- 建立 Google Cloud 專案。
- 設定 OAuth 同意畫面。
- 啟用並設定 Google Chat API,並為 Chat 應用程式提供名稱、圖示和說明。
- 安裝 Node.js Cloud 用戶端程式庫。
- 為電腦版應用程式建立 OAuth 用戶端 ID 憑證。如要在此環境中執行範例
指引,將憑證儲存為名為
client_secrets.json
的 JSON 檔案,並儲存至 本機目錄
- 選擇支援使用者驗證的授權範圍。
Python
- 企業或企業 具有存取權的 Google Workspace 帳戶 Google Chat。
- 設定環境:
- 建立 Google Cloud 專案。
- 設定 OAuth 同意畫面。
- 啟用並設定 Google Chat API。 圖示和說明
- 安裝 Python Cloud 用戶端程式庫。
-
為電腦版應用程式建立 OAuth 用戶端 ID 憑證。如要執行本指南中的範例,請將憑證儲存為名為
client_secrets.json
的 JSON 檔案,並儲存至本機目錄。
- 選擇支援使用者驗證的授權範圍。
Java
- 具備 Google Chat 存取權的 Google Workspace 企業或進階版帳戶。
- 設定環境:
- 建立 Google Cloud 專案。
- 設定 OAuth 同意畫面。
- 啟用並設定 Google Chat API。 圖示和說明
- 安裝 Java Cloud 用戶端程式庫。
- 為電腦版應用程式建立 OAuth 用戶端 ID 憑證。如要在此環境中執行範例
指引,將憑證儲存為名為
client_secrets.json
的 JSON 檔案,並儲存至 本機目錄
- 選擇支援使用者驗證的授權範圍。
Apps Script
- 企業或企業 具有存取權的 Google Workspace 帳戶 Google Chat。
- 設定環境:
- 建立 Google Cloud 專案。
- 設定 OAuth 同意畫面。
- 啟用並設定 Google Chat API。 圖示和說明
- 建立獨立的 Apps Script 專案, 並開啟 進階 Chat 服務。
- 選擇支援使用者驗證的授權範圍。
以使用者身分更新聊天室
如何更新 Google Chat 中現有的聊天室和 使用者驗證,傳遞 包括:
- 指定
chat.spaces
授權範圍。 - 在
UpdateSpace()
方法。在要求中指定空格name
欄位,updateMask
欄位 (包含一或多個要更新的欄位) 和body
(含有已更新空間) 可能不準確或不適當
您可以更新顯示名稱、空間類型、記錄狀態等資訊。如要查看可更新的所有欄位,請參閱 參考說明文件。
以下說明如何更新現有空間的 displayName
欄位:
Node.js
Python
Java
Apps Script
如要執行這個範例,請將 SPACE_NAME
替換為
聊天室的
name
] 欄位。您可以呼叫
ListSpaces()
方法,或是從空格網址複製。
Google Chat API 會傳回
Space
反映
更新。
以 Google Workspace 管理員身分更新聊天室
如果您是 Google Workspace 管理員,可以呼叫
使用 UpdateSpace()
種方法更新 Google Workspace 中的任何聊天室
並根據貴機構的使命
價值觀和目標進行調整
如要以 Google Workspace 管理員身分呼叫這個方法,請按照下列步驟操作:
如需更多資訊和範例,請參閱 以 Google Workspace 管理員身分管理 Google Chat 聊天室。
將聊天室更新為 Chat 應用程式
應用程式驗證需要一次性驗證 管理員核准。
如何更新 Google Chat 中現有的聊天室和 應用程式驗證, 並在要求中傳遞下列資訊:
- 指定
chat.app.spaces
授權範圍。透過應用程式驗證,您只能更新 Chat 應用程式建立的聊天室。 - 在
patch
方法 對Space
資源而言。在要求中,您可以指定空間name
欄位、包含一或多個要更新的欄位的updateMask
欄位,以及包含更新後空間資訊的body
。
您可以更新顯示名稱、聊天室類型、記錄狀態、權限設定等。如要查看可更新的所有欄位,請參閱 參考說明文件。
建立 API 金鑰
如要呼叫開發人員預覽版 API 方法,您必須使用 API 探索文件的非公開開發人員預覽版。如要驗證要求,您必須傳遞 API 金鑰。
如要建立 API 金鑰,請開啟應用程式的 Google Cloud 專案,然後執行下列操作:
- 在 Google Cloud 控制台中,依序前往「Menu」(選單) >「APIs & Services」(API 和服務) >「Credentials」(憑證)。
- 按一下「建立憑證」> API 金鑰。
- 系統會顯示新的 API 金鑰。
- 按一下「複製」 即可複製 API 金鑰,以便在應用程式程式碼中使用。您也可以在專案憑證的「API 金鑰」部分找到 API 金鑰。
- 按一下「限制金鑰」,即可更新進階設定並限制 API 金鑰的使用方式。詳情請參閱「套用 API 金鑰限制」一節。
編寫呼叫 Chat API 的指令碼
以下說明如何更新現有空間的 spaceDetails
欄位:
Python
- 在工作目錄中,建立名為
chat_space_update_app.py
的檔案。 在
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, discoveryServiceUrl='https://chat.googleapis.com/$discovery/rest?version=v1&labels=DEVELOPER_PREVIEW&key=API_KEY') # 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()
在程式碼中,請替換下列內容:
API_KEY
:您為了建構而建立的 API 金鑰 Chat API 的服務端點- 將「
SPACE
」替換為聊天室名稱, 您可以從中取得spaces.list
方法 或聊天室網址傳送
在工作目錄中建構並執行範例:
python3 chat_space_update_app.py
Google Chat API 會傳回
反映 Space
資源
更新。