Method: groups.list

userKey（ページ分け）で指定されたドメインまたはユーザーのすべてのグループを取得します。

HTTP リクエスト

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

この URL は gRPC Transcoding 構文を使用します。

クエリ パラメータ

パラメータ
customer

string

顧客の Google Workspace アカウントの一意の ID。マルチドメイン アカウントの場合、顧客のすべてのグループを取得するには、domain ではなくこのフィールドを使用します。my_customer エイリアスを使用して、アカウントの customerId を表すこともできます。customerId は、Users リソースの一部としても返されます。customer パラメータまたは domain パラメータを指定する必要があります。
domain

string

ドメイン名。このフィールドを使用して、1 つのドメインのみからグループを取得します。顧客アカウントのすべてのドメインを返すには、代わりに customer クエリ パラメータを使用します。
maxResults

integer

返される結果の最大数。指定できる値は 200 です。
orderBy

enum (OrderBy)

結果の並べ替えに使用する列
pageToken

string

リストの次のページを指定するトークン
query

string

クエリ文字列検索。形式は「」です。ドキュメントの全文は https: //developers.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

詳しくは、認可ガイドをご覧ください。

OrderBy

列挙型
EMAIL グループのメールアドレス。

SortOrder

列挙型
ASCENDING 昇順。
DESCENDING 降順。