Method: domains.users.list

ドメインにアクセスできるユーザーを一覧表示します。

HTTP リクエスト

GET https://gmailpostmastertools.googleapis.com/v2beta/{parent=domains/*}/users

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

パスパラメータ

パラメータ
parent

string

必須。ユーザーを一覧表示する親リソース名。形式: domains/{domain}

クエリ パラメータ

パラメータ
pageSize

integer

省略可。リクエストされたページサイズ。サーバーから返されるユーザー数は、リクエストされた数より少なくなる可能性があります。指定しない場合、このフィールドのデフォルト値は 10 です。このフィールドの最大値は 200 です。

pageToken

string

省略可。前の List リクエストから返された nextPageToken 値(存在する場合)。

リクエストの本文

リクエストの本文は空にする必要があります。

レスポンスの本文

users.list のレスポンス メッセージ。

成功した場合、レスポンスの本文には次の構造のデータが含まれます。

JSON 表現
{
  "users": [
    {
      object (User)
    }
  ],
  "nextPageToken": string
}
フィールド
users[]

object (User)

ドメインにアクセスできるユーザー。

nextPageToken

string

結果の次のページを取得するためのトークン。リストにそれ以上の結果がない場合は空です。

認可スコープ

次の OAuth スコープのいずれかが必要です。

  • https://www.googleapis.com/auth/postmaster
  • https://www.googleapis.com/auth/postmaster.user

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