取得聊天室詳細資料 (original) (raw)

本指南說明如何使用 Google Chat API 的 Space 資源中的 get() 方法，查看聊天室的詳細資料，例如顯示名稱、說明和規範。

如果您是 Google Workspace 管理員，可以呼叫 get() 方法，擷取 Google Workspace 機構中任何空間的詳細資料。

「Space」資源代表使用者和 Chat 應用程式可傳送訊息、分享檔案及協作的空間。聊天室分為以下幾種類型：

• 即時訊息 (DM) 是指兩位使用者之間，或使用者與 Chat 應用程式之間的對話。
• 群組通訊是指三位以上使用者與即時通訊應用程式之間的對話。
• 具名聊天室是持續存在的空間，可供使用者傳送訊息、分享檔案及協作。

透過應用程式驗證進行驗證，Chat 擴充應用程式就能取得該應用程式所屬聊天室的詳細資料。透過使用者驗證進行驗證後，您就能取得已驗證使用者有權存取的聊天室，無論使用者是聊天室成員或 Google Workspace 管理員。

必要條件

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 應用程式的身分驗證，選擇授權範圍。
• 經過驗證的使用者或呼叫 Chat 應用程式所屬的 Google Chat 聊天室。如要以 Chat 應用程式的身分驗證，請將 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 應用程式的身分驗證，選擇授權範圍。
• 經過驗證的使用者或呼叫 Chat 應用程式所屬的 Google Chat 聊天室。如要以 Chat 應用程式的身分驗證，請將 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 應用程式的身分驗證，選擇授權範圍。
• 經過驗證的使用者或呼叫 Chat 應用程式所屬的 Google Chat 聊天室。如要以 Chat 應用程式的身分驗證，請將 Chat 應用程式加入聊天室。

Apps Script

• 具有 Google Chat 存取權的 Business 或 Enterprise 版 Google Workspace 帳戶。
• 設定環境：
  • 建立 Google Cloud 專案。
  • 設定 OAuth 同意畫面。
  • 啟用及設定 Google Chat API，並為 Chat 應用程式命名、設定圖示和說明。
  • 建立獨立的 Apps Script 專案， 並開啟進階 Chat 服務。
  • 在本指南中，您必須使用使用者或應用程式驗證。如要以 Chat 應用程式的身分進行驗證，請建立服務帳戶憑證。如需相關步驟，請參閱「以 Google Chat 擴充應用程式的身分驗證及授權」。
• 根據您要以使用者或 Chat 應用程式的身分驗證，選擇授權範圍。
• 經過驗證的使用者或呼叫 Chat 應用程式所屬的 Google Chat 聊天室。如要以 Chat 應用程式的身分驗證，請將 Chat 應用程式加入聊天室。

取得儲存空間

如要取得 Google Chat 聊天室，請在要求中傳遞下列項目：

• 授權範圍：
  • 使用使用者驗證時，請指定 chat.spaces.readonly 或 chat.spaces 授權範圍。
  • 使用應用程式驗證時，請指定 chat.bot 授權範圍或 chat.app.spaces 範圍。chat.app.spaces 範圍適用於開發人員預覽版，且需要管理員核准一次。
• 呼叫 GetSpace() 方法，並傳遞要取得的空間 name。從 Google Chat 的 Space 資源或聊天室的網址取得聊天室名稱。

以使用者身分取得聊天室詳細資料

以下說明如何透過使用者驗證取得空間詳細資料：

Node.js

Python

Java

Apps Script

如要執行這個範例，請將 SPACE_NAME 替換為空間的 name 欄位中的 ID。您可以呼叫 ListSpaces() 方法或從空間的網址取得 ID。

Chat API 會傳回 Space 的執行個體，詳細說明指定聊天室。

以 Google Workspace 管理員身分取得空間詳細資料

如果您是 Google Workspace 管理員，可以呼叫 GetSpace方法，擷取 Google Workspace 機構中任何空間的詳細資料。

如要以 Google Workspace 管理員身分呼叫這個方法，請按照下列步驟操作：

• 使用使用者驗證呼叫方法，並指定支援使用管理員權限呼叫方法的授權範圍。
• 在要求中，將查詢參數 useAdminAccess 指定為 true。

如需更多資訊和範例，請參閱「以 Google Workspace 管理員身分管理 Google Chat 聊天室」。

以 Chat 應用程式身分取得聊天室詳細資料

以下說明如何透過應用程式驗證取得空間詳細資料：

Node.js

Python

Java

Apps Script

如要執行這個範例，請將 SPACE_NAME 替換為空間的 name 欄位中的 ID。您可以呼叫 ListSpaces() 方法或從空間的網址取得 ID。

Chat API 會傳回 Space 的執行個體，詳細說明指定聊天室。

限制和注意事項

• 只有在您使用 chat.app.spaces 範圍進行驗證時，系統才會填入「accessSettings」、「predefinedPermissionSettings」和「permissionSettings」欄位，且權限設定僅限於 Chat 應用程式建立的空間。
• 建立聊天室。
• 設定空間。
• 列出空間。
• 更新空間。
• 刪除聊天室。
• 尋找即時訊息聊天室。