本指南說明如何在 Google Chat API 的 Space
資源上使用 delete()
方法,在不再需要時刪除命名空間。刪除聊天室後,聊天室內的所有內容都會一併刪除,包括訊息和附件。
如果您是 Google Workspace 管理員,可以呼叫 delete()
方法,刪除 Google Workspace 機構中的任何命名聊天室。
Space
資源代表使用者和 Chat 應用程式可用於傳送訊息、共用檔案及協作的空間。聊天室分為以下幾類:
- 即時訊息 (DM) 是指兩位使用者或使用者與 Chat 應用程式之間的對話。
- 群組通訊是三位以上使用者和 Chat 應用程式的對話。
- 命名聊天室是持續存在的空間,可供使用者傳送訊息、分享檔案和協作。
必要條件
Node.js
- 可存取 Google Chat 的 Business 或 Enterprise Google Workspace 帳戶。
- 設定環境:
- 建立 Google Cloud 專案。
- 設定 OAuth 同意畫面。
- 啟用並設定 Google Chat API,並為 Chat 應用程式提供名稱、圖示和說明。
- 安裝 Node.js Cloud 用戶端程式庫。
- 為電腦版應用程式
建立 OAuth 用戶端 ID 憑證。如要執行本指南中的範例,請將憑證儲存為名為
client_secrets.json
的 JSON 檔案,並儲存至本機目錄。
- 選擇支援使用者驗證的授權範圍。
以使用者身分刪除命名聊天室
如要透過使用者驗證刪除 Google Chat 中的現有聊天室,請在要求中傳遞以下資訊:
- 指定
chat.delete
授權範圍。 - 呼叫
DeleteSpace()
方法。 - 傳遞要刪除的聊天室
name
。
以下說明如何刪除聊天室:
Node.js
如要執行這個範例,請將 SPACE_NAME
替換為聊天室 name
欄位中的 ID。您可以呼叫 ListSpaces()
方法,或從空間的網址取得 ID。
以 Chat 應用程式的形式刪除已命名聊天室
應用程式驗證需要一次性管理員核准。
使用應用程式驗證功能時,您只能刪除 Chat 應用程式建立的聊天室。
如要透過應用程式驗證刪除 Google Chat 中的現有聊天室,請在要求中傳遞下列資訊:
建立 API 金鑰
如要呼叫 Developer Preview API 方法,您必須使用 API 探索文件非公開的開發人員預覽版本。您必須傳送 API 金鑰,才能驗證要求。
如要建立 API 金鑰,請開啟應用程式的 Google Cloud 專案,然後執行下列操作:
- 在 Google Cloud 控制台中,依序前往「Menu」(選單) >「APIs & Services」(API 和服務) >「Credentials」(憑證)。
- 依序按一下「建立憑證」>「API 金鑰」。
- 系統會顯示新的 API 金鑰。
- 按一下「複製」 即可複製 API 金鑰,以便在應用程式程式碼中使用。您也可以在專案憑證的「API 金鑰」部分找到 API 金鑰。
- 按一下「限制金鑰」,即可更新進階設定並限制 API 金鑰的使用方式。詳情請參閱「套用 API 金鑰限制」。
編寫呼叫 Chat API 的指令碼
以下說明如何刪除聊天室:
Python
- 在工作目錄中建立名為
chat_space_delete_app.py
的檔案。 在
chat_space_delete_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.delete"] def main(): ''' Authenticates with Chat API using app authentication, then deletes the specified space. ''' # 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().delete( # The space to delete. # # 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' ).execute() # Print Chat API's response in your command line interface. # When deleting a space, the response body is empty. print(result) if __name__ == '__main__': main()
在程式碼中,請替換下列內容:
API_KEY
:您為建構 Chat API 服務端點而建立的 API 金鑰。SPACE
與聊天室名稱,您可以透過 Chat API 中的spaces.list
方法或聊天室網址取得這項資訊。
在工作目錄中建構並執行範例:
python3 chat_space_delete_app.py
如果成功,回應主體會是空白的,表示聊天室已刪除。
以 Google Workspace 管理員身分刪除命名聊天室
如果您是 Google Workspace 管理員,可以呼叫 DeleteSpace()
方法,刪除 Google Workspace 機構中的任何命名聊天室。
如要以 Google Workspace 管理員身分呼叫這個方法,請按照下列步驟操作:
如需詳細資訊和範例,請參閱「以 Google Workspace 管理員身分管理 Google Chat 聊天室」。