本指南說明如何使用 Google Chat API 的 Message
資源中的 delete()
方法,刪除文字或資訊卡訊息。
在 Chat API 中,Chat 訊息以 Message
資源表示。Chat 使用者只能傳送含有文字的訊息,但 Chat 擴充應用程式可以使用許多其他訊息功能,包括顯示靜態或互動式使用者介面、向使用者收集資訊,以及私下傳送訊息。如要進一步瞭解 Chat API 提供的訊息功能,請參閱「Google Chat 訊息總覽」。
透過應用程式驗證,您可以使用這個方法刪除 Chat 應用程式傳送的訊息。透過使用者驗證,您可以使用這個方法刪除已驗證使用者傳送的訊息。如果使用者是聊天室管理員,您可能也可以刪除其他聊天室成員傳送的訊息。詳情請參閱「瞭解聊天室管理員角色」。
必要條件
Node.js
- 具有 Google Chat 存取權的 Business 或 Enterprise 版 Google Workspace 帳戶。
- 設定環境:
- 建立 Google Cloud 專案。
- 設定 OAuth 同意畫面。
- 啟用及設定 Google Chat API,並為 Chat 應用程式命名、設定圖示和說明。
- 安裝 Node.js Cloud 用戶端程式庫。
- 根據您要在 Google Chat API 要求中驗證的方式,建立存取憑證:
- 如要以 Chat 使用者身分進行驗證,請建立 OAuth 用戶端 ID 憑證,並將憑證儲存至本機目錄,命名為
credentials.json
的 JSON 檔案。 - 如要以 Chat 應用程式的身分進行驗證,請建立服務帳戶憑證,然後將憑證儲存為名為
credentials.json
的 JSON 檔案。
- 如要以 Chat 使用者身分進行驗證,請建立 OAuth 用戶端 ID 憑證,並將憑證儲存至本機目錄,命名為
- 根據您要以使用者或 Chat 應用程式的身分驗證,選擇授權範圍。
Python
- 具有 Google Chat 存取權的 Business 或 Enterprise 版 Google Workspace 帳戶。
- 設定環境:
- 建立 Google Cloud 專案。
- 設定 OAuth 同意畫面。
- 啟用及設定 Google Chat API,並為 Chat 應用程式命名、設定圖示和說明。
- 安裝 Python Cloud 用戶端程式庫。
- 根據您要在 Google Chat API 要求中驗證的方式,建立存取憑證:
- 如要以 Chat 使用者身分進行驗證,請建立 OAuth 用戶端 ID 憑證,並將憑證儲存至本機目錄,命名為
credentials.json
的 JSON 檔案。 - 如要以 Chat 應用程式的身分進行驗證,請建立服務帳戶憑證,然後將憑證儲存為名為
credentials.json
的 JSON 檔案。
- 如要以 Chat 使用者身分進行驗證,請建立 OAuth 用戶端 ID 憑證,並將憑證儲存至本機目錄,命名為
- 根據您要以使用者或 Chat 應用程式的身分驗證,選擇授權範圍。
Java
- 具有 Google Chat 存取權的 Business 或 Enterprise 版 Google Workspace 帳戶。
- 設定環境:
- 建立 Google Cloud 專案。
- 設定 OAuth 同意畫面。
- 啟用及設定 Google Chat API,並為 Chat 應用程式命名、設定圖示和說明。
- 安裝 Java Cloud 用戶端程式庫。
- 根據您要在 Google Chat API 要求中驗證的方式,建立存取憑證:
- 如要以 Chat 使用者身分進行驗證,請建立 OAuth 用戶端 ID 憑證,並將憑證儲存至本機目錄,命名為
credentials.json
的 JSON 檔案。 - 如要以 Chat 應用程式的身分進行驗證,請建立服務帳戶憑證,然後將憑證儲存為名為
credentials.json
的 JSON 檔案。
- 如要以 Chat 使用者身分進行驗證,請建立 OAuth 用戶端 ID 憑證,並將憑證儲存至本機目錄,命名為
- 根據您要以使用者或 Chat 應用程式的身分驗證,選擇授權範圍。
Apps Script
- 具有 Google Chat 存取權的 Business 或 Enterprise 版 Google Workspace 帳戶。
- 設定環境:
- 建立 Google Cloud 專案。
- 設定 OAuth 同意畫面。
- 啟用及設定 Google Chat API,並為 Chat 應用程式命名、設定圖示和說明。
- 建立獨立的 Apps Script 專案,並開啟進階 Chat 服務。
- 在本指南中,您必須使用使用者或應用程式驗證。如要以 Chat 應用程式的身分進行驗證,請建立服務帳戶憑證。如需相關步驟,請參閱「以 Google Chat 擴充應用程式的身分驗證及授權」。
- 根據您要以使用者或 Chat 應用程式的身分驗證,選擇授權範圍。
透過使用者驗證刪除訊息
如要使用使用者驗證刪除訊息,請在要求中傳遞下列項目:
- 指定
chat.messages
授權範圍。 - 呼叫
DeleteMessage()
方法。 - 將
name
設為要刪除的訊息資源名稱。
以下範例會透過使用者驗證刪除訊息:
Node.js
Python
Java
Apps Script
如要執行這個範例,請替換下列項目:
SPACE_NAME
:來自聊天室的 IDname
。 您可以呼叫ListSpaces()
方法,或從空間的網址取得 ID。MESSAGE_NAME
:訊息name
中的 ID。您可以透過 Chat API 建立訊息,並從非同步傳回的回應主體中取得 ID,也可以使用建立訊息時指派的自訂名稱。
如果成功,回應主體會留白,表示訊息已刪除。
刪除已透過應用程式驗證的訊息
如要使用應用程式驗證刪除訊息,請在要求中傳遞下列項目:
- 指定
chat.bot
授權範圍。 - 呼叫
DeleteMessage()
方法。 - 將
name
設為要刪除的訊息資源名稱。
以下範例會使用應用程式驗證刪除訊息:
Node.js
Python
Java
Apps Script
如要執行這個範例,請替換下列項目:
SPACE_NAME
:來自聊天室的 IDname
。 您可以呼叫ListSpaces()
方法,或從空間的網址取得 ID。MESSAGE_NAME
:訊息name
中的 ID。您可以透過 Chat API 建立訊息,並從非同步傳回的回應主體中取得 ID,也可以使用建立訊息時指派的自訂名稱。
如果成功,回應主體會留白,表示訊息已刪除。