Method: groups.list

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

HTTP 要求

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

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

查詢參數

參數
customer

string

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

string

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

integer

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

enum (OrderBy)

用於排序結果的資料欄
pageToken

string

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

string

查詢字串搜尋。包含一或多個搜尋子句，每個子句都有欄位、運算子和值。如需完整說明文件，請參閱「搜尋群組」。
sortOrder

enum (SortOrder)

指定要依遞增或遞減順序傳回結果。只有在同時使用 orderBy 時才有用
userKey

string

如果只列出特定使用者所屬的群組，請提供該使用者的電子郵件地址或固定 ID。如果是 ID，則應與使用者物件的 ID 相符。無法與 customer 參數搭配使用。

要求主體

要求主體必須為空白。

回應主體

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

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

詳情請參閱授權指南。

排序依據

列舉
EMAIL 群組的電子郵件地址。

SortOrder

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