Method: spaces.members.list

列出聊天室中的成員。如需範例，請參閱「列出聊天室中的使用者和 Google Chat 應用程式」。列出具有應用程式驗證功能的成員資格，會列出 Chat 應用程式可存取的聊天室成員，但不含 Chat 應用程式成員資格 (包括其所屬聊天室)。透過使用者驗證功能列出成員資格，會列出已驗證使用者可以存取的聊天室中的成員資格。

必須完成驗證。支援應用程式驗證和使用者驗證。

HTTP 要求

GET https://chat.googleapis.com/v1/{parent=spaces/*}/members

這個網址使用 gRPC 轉碼語法。

路徑參數

參數
parent

string

必要欄位。要擷取成員清單的聊天室資源名稱。

格式：空格/{space}

查詢參數

參數
pageSize

integer

選用設定。要傳回的成員資格數量上限。服務傳回的產品數量可能會少於這個值。

如未指定，最多會傳回 100 個成員資格。

最大值是 1000。如果您使用的值超過 1000，系統會自動變更為 1000。

負值會傳回 INVALID_ARGUMENT 錯誤。
pageToken

string

選用設定。來自先前的呼叫，用來列出成員資格的網頁權杖。提供這個參數即可擷取後續網頁。

進行分頁時，提供的所有其他參數應與提供網頁權杖的呼叫相符。如果將不同的值傳遞給其他參數，可能會導致非預期的結果。
filter

string

選用設定。查詢篩選器。

您可以按照成員的角色 (role) 和類型 (member.type) 篩選成員。

如要依角色篩選，請將 role 設為 ROLE_MEMBER 或 ROLE_MANAGER。

如要依類型篩選，請將 member.type 設為 HUMAN 或 BOT。開發人員預覽版：您也可以使用 != 運算子篩選 member.type。

如要同時依角色和類型進行篩選，請使用 AND 運算子。如要依角色或類型進行篩選，請使用 OR 運算子。

當 useAdminAccess 設為 true 時，必須提供 member.type = "HUMAN" 或 member.type != "BOT"。系統會拒絕其他成員類型篩選條件。

舉例來說，以下是有效的查詢：

role = "ROLE_MANAGER" OR role = "ROLE_MEMBER"
member.type = "HUMAN" AND role = "ROLE_MANAGER"

member.type != "BOT"

下列查詢無效：

member.type = "HUMAN" AND member.type = "BOT"
role = "ROLE_MANAGER" AND role = "ROLE_MEMBER"

伺服器拒絕無效的查詢，並顯示 INVALID_ARGUMENT 錯誤。
showGroups

boolean

選用設定。當 true 時，除了其他類型的會員資格外，系統也會傳回與 Google Group 相關聯的會員資格。如果已設定 filter，系統不會傳回不符合篩選條件的 Google Group 成員。
showInvited

boolean

選用設定。如果為 true，除了其他類型的會員資格外，系統還會傳回與 invited 會員相關的會籍。如果已設定篩選器，則不會傳回與篩選條件不符的 invited 個成員。

目前需要使用者驗證。
useAdminAccess

boolean

當 true 時，這個方法會使用使用者的 Google Workspace 管理員權限執行。

通話使用者必須是具備管理即時通訊和聊天室對話權限的 Google Workspace 管理員。

需要 chat.admin.memberships.readonly 或 chat.admin.memberships OAuth 2.0 範圍。

使用管理員存取權時，無法列出聊天室中的應用程式成員資格。

要求主體

要求主體必須為空白。

回應主體

回應清單聊天室成員。

如果成功，回應主體即會包含具有以下結構的資料：

JSON 表示法 
{
  "memberships": [
    {
      object (Membership)
    }
  ],
  "nextPageToken": string
}
欄位
memberships[]

object (Membership)

未排序的清單。要求 (或第一個) 頁面中的成員清單。
nextPageToken

string

可做為 pageToken 傳送的權杖，用於擷取下一頁的結果。如果空白，表示沒有後續網頁。

授權範圍

需要下列其中一種 OAuth 範圍：

  • https://www.googleapis.com/auth/chat.admin.memberships
  • https://www.googleapis.com/auth/chat.admin.memberships.readonly
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.readonly

詳情請參閱授權指南。