Method: spaces.members.list

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

支援下列類型的驗證：

HTTP 要求

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

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

路徑參數

參數
parent

string

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

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

詳情請參閱授權指南。