Method: members.list

擷取群組中所有成員的分頁清單。這個方法會在 60 分鐘後逾時。詳情請參閱「排解錯誤代碼問題」。

HTTP 要求

GET https://admin.googleapis.com/admin/directory/v1/groups/{groupKey}/members

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

路徑參數

參數
groupKey

string

用於在 API 要求中識別群組。值可以是群組的電子郵件地址、群組別名或專屬群組 ID。

查詢參數

參數
includeDerivedMembership

boolean

是否要列出間接會員。預設值為 false。
maxResults

integer

要傳回的結果數上限。允許的最大值為 200。
pageToken

string

用於指定清單中下一頁的符記。
roles

string

roles 查詢參數可讓您依角色擷取群組成員。允許的值為 OWNER、MANAGER 和 MEMBER。

要求主體

要求主體必須為空白。

回應主體

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

JSON 表示法 
{
  "kind": string,
  "etag": string,
  "members": [
    {
      object (Member)
    }
  ],
  "nextPageToken": string
}
欄位
kind

string

資源的類型。
etag

string

資源的 ETag。
members[]

object (Member)

成員物件清單。
nextPageToken

string

用於存取此結果下一頁的符記。

授權範圍

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

  • https://apps-apis.google.com/a/feeds/groups/
  • https://www.googleapis.com/auth/admin.directory.group
  • https://www.googleapis.com/auth/admin.directory.group.member
  • https://www.googleapis.com/auth/admin.directory.group.member.readonly
  • https://www.googleapis.com/auth/admin.directory.group.readonly

詳情請參閱授權指南。