Method: groups.list

ドメインまたはユーザーキーを指定して、そのドメインまたはユーザーのすべてのグループを取得します（ページネーションあり）。

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/workspace/admin/directory/v1/guides/search-groups をご覧ください。
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

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

OrderBy

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

SortOrder

列挙型
ASCENDING 昇順。
DESCENDING 降順。