本指南說明如何在 Google Chat API 的 Message
資源上使用 get()
方法,傳回文字或資訊卡訊息的詳細資料。
在 Chat API 中,Chat 訊息會以
Message
資源。
雖然 Chat 使用者只能傳送含有文字的訊息,但 Chat 應用程式可以使用許多其他訊息功能,包括顯示靜態或互動式使用者介面、向使用者收集資訊,以及私下傳送訊息。進一步瞭解訊息功能
如要瞭解 Chat API 可用的功能,請參閱
Google Chat 訊息總覽。
必要條件
Node.js
- 企業或企業 具有存取權的 Google Workspace 帳戶 Google Chat。
- 設定環境:
- 建立 Google Cloud 專案。
- 設定 OAuth 同意畫面。
- 啟用並設定 Google Chat API,並為 Chat 應用程式提供名稱、圖示和說明。
- 安裝 Node.js Cloud 用戶端程式庫。
- 根據您要在 Google Chat API 中驗證的方式建立存取憑證
要求:
- 如要以 Chat 使用者的身分進行驗證,
建立 OAuth 用戶端 ID
憑證,並將憑證儲存為 JSON 檔案
client_secrets.json
至本機目錄。 - 如要以 Chat 應用程式進行驗證,請建立服務帳戶憑證,並將憑證儲存為名為
credentials.json
的 JSON 檔案。
- 如要以 Chat 使用者的身分進行驗證,
建立 OAuth 用戶端 ID
憑證,並將憑證儲存為 JSON 檔案
- 根據您想以使用者或 Chat 應用程式身分進行驗證,選擇授權範圍。
- Google Chat 聊天室:使用者或發出呼叫的 Chat 應用程式是其中成員。如要以 Chat 應用程式驗證,請將 Chat 應用程式新增至聊天室。
Python
- 企業或企業 具有存取權的 Google Workspace 帳戶 Google Chat。
- 設定環境:
- 建立 Google Cloud 專案。
- 設定 OAuth 同意畫面。
- 啟用並設定 Google Chat API。 圖示和說明
- 安裝 Python Cloud 用戶端程式庫。
- 根據您要在 Google Chat API 要求中驗證的方式,建立存取憑證:
- 如要以 Chat 使用者的身分進行驗證,請建立 OAuth 用戶端 ID 憑證,並將憑證儲存為名為
client_secrets.json
的 JSON 檔案,並儲存在本機目錄中。 - 如要以 Chat 應用程式的身分進行驗證,
建立服務帳戶
憑證,並將憑證儲存為 JSON 檔案
credentials.json
。
- 如要以 Chat 使用者的身分進行驗證,請建立 OAuth 用戶端 ID 憑證,並將憑證儲存為名為
- 根據您想以使用者或 Chat 應用程式身分進行驗證,選擇授權範圍。
- Google Chat 聊天室:使用者或發出呼叫的 Chat 應用程式是其中成員。如要以 Chat 應用程式驗證,請將 Chat 應用程式新增至聊天室。
Java
- 企業或企業 具有存取權的 Google Workspace 帳戶 Google Chat。
- 設定環境:
- 建立 Google Cloud 專案。
- 設定 OAuth 同意畫面。
- 啟用並設定 Google Chat API,並為 Chat 應用程式提供名稱、圖示和說明。
- 安裝 Java Cloud 用戶端程式庫。
- 根據您要在 Google Chat API 中驗證的方式建立存取憑證
要求:
- 如要以 Chat 使用者的身分進行驗證,請建立 OAuth 用戶端 ID 憑證,並將憑證儲存為名為
client_secrets.json
的 JSON 檔案,並儲存在本機目錄中。 - 如要以 Chat 應用程式進行驗證,請建立服務帳戶憑證,並將憑證儲存為名為
credentials.json
的 JSON 檔案。
- 如要以 Chat 使用者的身分進行驗證,請建立 OAuth 用戶端 ID 憑證,並將憑證儲存為名為
- 根據你要以使用者或使用者身分驗證選擇授權範圍 Chat 應用程式。
- 通過驗證的 Google Chat 聊天室 撥打的即時通訊應用程式為成員。如要以 Chat 應用程式驗證,請將 Chat 應用程式新增至聊天室。
Apps Script
- 具備 Google Chat 存取權的 Google Workspace 企業或進階版帳戶。
- 設定環境:
- 建立 Google Cloud 專案。
- 設定 OAuth 同意畫面。
- 啟用並設定 Google Chat API,並為 Chat 應用程式提供名稱、圖示和說明。
- 建立獨立的 Apps Script 專案,並啟用進階 Chat 服務。
- 在本指南中,您必須使用 user 或應用程式驗證如要以 Chat 應用程式的形式進行驗證,請建立 自己的服務帳戶憑證如需詳細步驟,請參閱「以 Google Chat 應用程式身分驗證及授權」。
- 根據您想以使用者或 Chat 應用程式身分進行驗證,選擇授權範圍。
- Google Chat 聊天室:使用者或發出呼叫的 Chat 應用程式是其中成員。如要以 Chat 應用程式驗證,請將 Chat 應用程式新增至聊天室。
取得使用者驗證訊息
如何取得與 使用者驗證 並在要求中傳遞下列資訊:
- 指定
chat.messages.readonly
或chat.messages
授權範圍。 - 呼叫
GetMessage()
方法。 - 將
name
設為要取得的訊息資源名稱。
以下範例會透過使用者驗證取得訊息:
Node.js
Python
Java
Apps Script
如要執行這個範例,請取代下列項目:
SPACE_NAME
:聊天室的 IDname
。 您可以呼叫ListSpaces()
方法,或是從空格網址複製。MESSAGE_NAME
:訊息name
中的 ID。您可以使用 Chat API 以非同步方式建立訊息,或在建立訊息時指派自訂名稱,然後從回應主體中取得 ID。
Chat API 會傳回
Message
詳述指定訊息
接收應用程式驗證訊息
如要取得使用應用程式驗證的訊息詳細資料,請在要求中傳遞以下內容:
- 指定
chat.bot
授權範圍。 - 呼叫
GetMessage()
方法。 - 將
name
設為要取得的訊息資源名稱。
以下範例會透過應用程式驗證取得訊息:
Node.js
Python
Java
Apps Script
如要執行這個範例,請替換下列內容:
SPACE_NAME
:聊天室的 IDname
。 您可以呼叫ListSpaces()
方法,或從空間的網址取得 ID。MESSAGE_NAME
:訊息的 IDname
。 您可以使用 Chat API 以非同步方式建立訊息,或在建立訊息時指派自訂名稱,然後從回應主體中取得 ID。
Chat API 會傳回 Message
的例項,其中包含指定訊息的詳細資料。