Method: groups.list

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

根據 userKey (分頁) 擷取網域或使用者群組的所有群組。

HTTP 要求

GET https://admin.googleapis.com/admin/directory/v1/groups

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

查詢參數

參數
customer

string

客戶 Google Workspace 帳戶的專屬 ID。如果是多網域帳戶，如要擷取客戶的所有群組，請使用這個欄位，而非 domain。您也可以使用 my_customer 別名來代表帳戶的 customerId。customerId 也會在使用者資源中傳回。您必須提供 customer 或 domain 參數。
domain

string

網域名稱。這個欄位只能取得一個網域的群組。如要傳回客戶帳戶的所有網域，請改用 customer 查詢參數。
maxResults

integer

要傳回的結果數量上限。允許的值為 200。
orderBy

enum (OrderBy)

用於排序結果的資料欄
pageToken

string

用於指定清單中下一頁的權杖
query

string

查詢字串搜尋。格式應為「」。完整說明文件的網址為：httpsdevelopers.google.com/admin-sdk/directory/v1/guides/search-groups
sortOrder

enum (SortOrder)

要以遞增或遞減順序傳回結果。僅使用 orderBy 時使用
userKey

string

如果只列出這些群組，則使用者的電子郵件或不可變更的 ID 是指定的使用者。如果 ID 是與使用者物件 ID 相符，

要求主體

要求主體必須為空白。

回應主體

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

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

string

這是資源類型。
etag

string

資源的 ETag。
groups[]

object (Group)

群組物件清單。
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.readonly

詳情請參閱 OAuth 2.0 總覽。

OrderBy

列舉
EMAIL 群組的電子郵件。

SortOrder

列舉
ASCENDING 遞增排序。
DESCENDING 遞減順序。