列出聊天室中的成員資格。如需範例,請參閱「列出聊天室中的使用者和 Google Chat 應用程式」。採用應用程式驗證設定的成員資格清單會列出 Chat 應用程式可存取的聊天室成員,但不含 Chat 應用程式成員資格。透過使用者驗證功能列出的成員資格,清單會列出通過驗證的使用者可存取的聊天室成員。
HTTP 要求
GET https://chat.googleapis.com/v1/{parent=spaces/*}/members
這個網址使用 gRPC 轉碼語法。
路徑參數
參數 | |
---|---|
parent |
必要欄位。要擷取成員清單的聊天室資源名稱。 格式:space/{space} |
查詢參數
參數 | |
---|---|
pageSize |
選用設定。可退貨的會員數量上限。服務傳回的產品數量可能會少於這個值。 如未指定,最多會傳回 100 個成員資格。 值的數量上限是 1000。如果使用的值超過 1000,系統會自動將值變更為 1000。 負值會傳回 |
pageToken |
選用設定。頁面符記,從先前的呼叫列出成員。提供這個參數即可擷取後續網頁。 進行分頁時,提供的所有其他參數應與提供網頁權杖的呼叫相符。將不同的值傳送至其他參數,可能會導致非預期的結果。 |
filter |
選用設定。查詢篩選器。 你可以依成員的角色 ( 如要依角色篩選,請將 如要依類型篩選,請將 如要同時依角色和類型進行篩選,請使用
舉例來說,以下查詢是有效的查詢:
以下查詢無效:
無效查詢遭到伺服器拒絕,並顯示 |
showGroups |
選用設定。執行 |
showInvited |
選用設定。變更 目前需要使用者驗證。 |
useAdminAccess |
true 時,此方法會使用使用者的 Google Workspace 管理員權限執行。通話使用者必須是具備管理即時通訊和聊天室對話權限的 Google Workspace 管理員。 需要 使用管理員存取權時,無法在聊天室中列出應用程式成員。 |
要求主體
要求主體必須為空白。
回應主體
針對聊天室成員清單的回應。
如果成功,回應主體會含有以下結構的資料:
JSON 表示法 |
---|
{
"memberships": [
{
object ( |
欄位 | |
---|---|
memberships[] |
未排序的清單。要求 (或第一個) 頁面中的成員清單。 |
nextPageToken |
可做為 |
授權範圍
需要下列其中一種 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
詳情請參閱授權指南。