Method: spaces.members.list

列出聊天室中的成員資格。如需範例,請參閱「列出聊天室中的使用者和 Google 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_MEMBERROLE_MANAGER

如要依類型篩選,請將 member.type 設為 HUMANBOT。開發人員預覽:您也可以使用 != 運算子篩選 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.readonlychat.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

詳情請參閱授權指南