Method: spaces.members.list

列出聊天室中的成員。如需範例，請參閱「列出聊天室中的使用者和 Google Chat 應用程式」。使用應用程式驗證列出成員資格時，系統會列出 Chat 應用程式有權存取的聊天室成員資格，但會排除 Chat 應用程式成員資格 (包括應用程式本身的成員資格)。使用「使用者驗證」列出成員資格：列出已驗證使用者可存取空間的成員資格。

支援下列類型的驗證：

  • 應用程式驗證，並使用下列其中一個授權範圍：

    • https://www.googleapis.com/auth/chat.bot
    • https://www.googleapis.com/auth/chat.app.memberships (需要管理員核准)

  • 使用者驗證，並使用下列其中一個授權範圍：

    • https://www.googleapis.com/auth/chat.memberships.readonly
    • https://www.googleapis.com/auth/chat.memberships
    • https://www.googleapis.com/auth/chat.import (僅限匯入模式聊天室)
    • 使用者驗證會在管理員帳戶驗證時授予管理員權限，useAdminAccess為 true，且使用下列其中一個授權範圍：
      • https://www.googleapis.com/auth/chat.admin.memberships.readonly
      • https://www.googleapis.com/auth/chat.admin.memberships

HTTP 要求

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

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

路徑參數

參數
parent

string

必要欄位。要擷取成員名單的空間資源名稱。

格式：spaces/{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

(選用步驟) 時，這個方法會使用使用者的 Google Workspace 管理員權限執行。true

通話使用者必須是具備「管理即時通訊和聊天室對話」權限的 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.app.memberships
  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.readonly

詳情請參閱授權指南。