本指南將說明如何使用
list()
Google Chat API 的 Space
資源方法,用來列出聊天室。列出聊天室會傳回分頁式、可篩選的聊天室清單。
Space
資源代表使用者和 Chat 應用程式可用於傳送訊息、共用檔案和協作的空間。聊天室分為以下幾種類型:
- 即時訊息 (DM) 是指兩位使用者或使用者之間的對話, Chat 應用程式。
- 群組通訊是 3 位以上使用者的對話, Chat 擴充應用程式。
- 命名聊天室是持續存在的空間,可供使用者傳送訊息、分享檔案和協作。
使用應用程式驗證功能列出聊天室,即可列出 Chat 應用程式可存取的聊天室。使用使用者驗證功能列出聊天室,即可列出已驗證使用者可存取的聊天室。
必要條件
Node.js
- 具備 Google Chat 存取權的 Google Workspace 企業或進階版帳戶。
- 設定環境:
- 建立 Google Cloud 專案。
- 設定 OAuth 同意畫面。
- 啟用並設定 Google Chat API。 圖示和說明
- 安裝 Node.js Cloud 用戶端程式庫。
- 根據您要在 Google Chat API 要求中驗證的方式,建立存取憑證:
- 如要以 Chat 使用者的身分進行驗證,請建立 OAuth 用戶端 ID 憑證,並將憑證儲存為名為
client_secrets.json
的 JSON 檔案,並儲存在本機目錄中。 - 如要以 Chat 應用程式的身分進行驗證,
建立服務帳戶
憑證,並將憑證儲存為 JSON 檔案
credentials.json
。
- 如要以 Chat 使用者的身分進行驗證,請建立 OAuth 用戶端 ID 憑證,並將憑證儲存為名為
- 根據您想以使用者或 Chat 應用程式身分進行驗證,選擇授權範圍。
Python
- 具備 Google Chat 存取權的 Google Workspace 企業或進階版帳戶。
- 設定環境:
- 建立 Google Cloud 專案。
- 設定 OAuth 同意畫面。
- 啟用並設定 Google Chat API。 圖示和說明
- 安裝 Python Cloud 用戶端程式庫。
- 根據您要在 Google Chat API 中驗證的方式建立存取憑證
要求:
- 如要以 Chat 使用者的身分進行驗證,請建立 OAuth 用戶端 ID 憑證,並將憑證儲存為名為
client_secrets.json
的 JSON 檔案,並儲存在本機目錄中。 - 如要以 Chat 應用程式進行驗證,請建立服務帳戶憑證,並將憑證儲存為名為
credentials.json
的 JSON 檔案。
- 如要以 Chat 使用者的身分進行驗證,請建立 OAuth 用戶端 ID 憑證,並將憑證儲存為名為
- 根據您想以使用者或 Chat 應用程式身分進行驗證,選擇授權範圍。
Java
- 企業或企業 具有存取權的 Google Workspace 帳戶 Google Chat。
- 設定環境:
- 建立 Google Cloud 專案。
- 設定 OAuth 同意畫面。
- 啟用並設定 Google Chat API。 圖示和說明
- 安裝 Java Cloud 用戶端程式庫。
- 根據您要在 Google Chat API 中驗證的方式建立存取憑證
要求:
- 如要以 Chat 使用者的身分進行驗證,請建立 OAuth 用戶端 ID 憑證,並將憑證儲存為名為
client_secrets.json
的 JSON 檔案,並儲存在本機目錄中。 - 如要以 Chat 應用程式進行驗證,請建立服務帳戶憑證,並將憑證儲存為名為
credentials.json
的 JSON 檔案。
- 如要以 Chat 使用者的身分進行驗證,請建立 OAuth 用戶端 ID 憑證,並將憑證儲存為名為
- 根據你要以使用者或使用者身分驗證選擇授權範圍 Chat 應用程式。
Apps Script
- 企業或企業 具有存取權的 Google Workspace 帳戶 Google Chat。
- 設定環境:
- 建立 Google Cloud 專案。
- 設定 OAuth 同意畫面。
- 啟用並設定 Google Chat API。 圖示和說明
- 建立獨立的 Apps Script 專案, 並開啟 進階 Chat 服務。
- 在本指南中,您必須使用 user 或應用程式驗證如要以 Chat 應用程式的形式進行驗證,請建立 自己的服務帳戶憑證詳細步驟請參閱 以 Google Chat 應用程式。
- 根據您想以使用者或 Chat 應用程式身分進行驗證,選擇授權範圍。
列出具備使用者驗證機制的聊天室
如要列出 Google Chat 中的聊天室,請在要求中傳遞以下內容:
- 使用使用者驗證時,請指定
chat.spaces.readonly
或chat.spaces
授權範圍。 - 呼叫
ListSpaces()
方法。
以下範例列出已驗證使用者可見的命名聊天室 (但不包括群組通訊和即時訊息,這些項目會篩除):
Node.js
Python
Java
Apps Script
Chat API 會傳回 空格的分頁清單。
列出使用應用程式驗證的聊天室
如要列出 Google Chat 中的聊天室,請在要求中傳遞以下內容:
- 使用應用程式驗證時,請指定
chat.bot
授權範圍。 - 呼叫
ListSpaces()
方法。
以下範例列出 Chat 應用程式可見的命名聊天室 (但不包括群組即時通訊和即時訊息):
Node.js
Python
Java
Apps Script
Chat API 會傳回分頁的聊天室清單。
自訂分頁或篩選清單
如要列出 Google Chat 中的聊天室,請傳遞下列選用查詢參數,以自訂列出聊天室的分頁或篩選聊天室:
pageSize
:要傳回的聊天室數量上限。服務可能會傳回 小於這個值如未指定,最多會傳回 100 個空格。許可的最大值為 1,000;超過 1,000 的值會自動變更為 1,000。pageToken
:從先前 list spaces 呼叫收到的頁面權杖。提供這個權杖即可擷取後續網頁。進行分頁時,篩選器值應與提供網頁權杖的呼叫相符。傳送 否則可能會導致非預期的結果filter
:查詢篩選器。如需支援的查詢詳細資料,請參閱ListSpacesRequest
參考資料。