Method: domains.list

登録したすべてのドメインと、対応するメタデータのリストを取得します。レスポンス内のドメインの順序は指定されておらず、非決定的です。新しく登録されたドメインが必ずしもこのリストの末尾に追加されるとは限りません。

HTTP リクエスト

GET https://gmailpostmastertools.googleapis.com/v2beta/domains

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

クエリ パラメータ

パラメータ
pageSize

integer

省略可。リクエストされたページサイズ。サーバーはリクエストされた数よりも少ないドメインを返す場合があります。指定しない場合、このフィールドのデフォルト値は 10 です。このフィールドの最大値は 200 です。
pageToken

string

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

リクエストの本文

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

レスポンスの本文

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

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

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

object (Domain)

ユーザーが登録したドメイン。
nextPageToken

string

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

認可スコープ

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

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

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