Method: spaces.members.list

透過集合功能整理內容 你可以依據偏好儲存及分類內容。

列出聊天室成員。

需要驗證。完整支援服務帳戶驗證。

HTTP 要求

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

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

路徑參數

參數
parent

string

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

格式：空格/{空格}

查詢參數

參數
pageSize

integer

要傳回的成員數上限。服務傳回的值可能會少於這個值。

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

最大值是 1000； 1000 以上的值被為 1000。

負值會傳回 INVALID_ARGUMENT 錯誤。
pageToken

string

從先前的名單成員呼叫收到網頁憑證，請提供這個 ID 以擷取後續網頁。

進行分頁時，所有其他提供的參數都應與提供網頁憑證的呼叫相符。將其他值傳送至其他參數可能會導致非預期的結果。
filter

string

選用，查詢篩選器。

API 支援依 role 和 type 篩選。

role 只接受 ROLE_MEMBER 和 ROLE_MANAGER 值。

member.type 只接受 HUMAN 和 BOT 值。

例如，以下查詢是有效的：

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

伺服器會以 INVALID_ARGUMENT 錯誤拒絕無效的查詢。
showInvited

boolean

選用，當true再次傳回與invited會員相關的會員資格時，系統會一併傳回其他類型的成員。如果已設定 [filter][google.chat.v1.Membership.filter]，系統不會傳回與篩選條件不符的 invited 個成員資格。

目前必須使用使用者驗證。

要求主體

要求主體必須為空白。

回應主體

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

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

object (Membership)

要求 (或第一個) 頁面中的會員清單。
nextPageToken

string

可作為 pageToken 傳送的符記以擷取下一頁的結果。如果空白，之後就不會有後續頁面。

授權範圍

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

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

詳情請參閱授權指南。