Method: members.list

グループ内のすべてのメンバーのページ分けされたリストを取得します。このメソッドは 60 分後にタイムアウトします。詳細については、エラーコードのトラブルシューティングをご覧ください。

HTTP リクエスト

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

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

パスパラメータ

パラメータ
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

詳細については、承認ガイドをご覧ください。