Method: domains.trafficStats.list

利用可能なすべての日のトラフィック統計情報を一覧表示します。ユーザーがドメインの TrafficStats にアクセスする権限がない場合は、PERMISSION_DENIED を返します。

HTTP リクエスト

GET https://gmailpostmastertools.googleapis.com/v1/{parent=domains/*}/trafficStats

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

パスパラメータ

パラメータ
parent

string

トラフィック統計情報を一覧表示するドメインのリソース名。形式は domains/{domain_name} です。ここで、domain_name は完全修飾ドメイン名です。

クエリ パラメータ

パラメータ
startDate

object (Date)

包含を取得する指標の最も早い日。startDate と endDate の両方を指定するか、両方を未指定のままにしてください。いずれか 1 つのみが指定されている場合、または endDate が startDate 時刻より前の場合は、INVALID_ARGUMENT が返されます。
endDate

object (Date)

排他を取得する指標の最新の日付。startDate と endDate の両方を指定するか、両方を未指定のままにしてください。いずれか 1 つのみが指定されている場合、または endDate が startDate 時刻より前の場合は、INVALID_ARGUMENT が返されます。
pageSize

integer

リクエストされたページサイズです。 サーバーが、リクエストされた値よりも少ない TrafficStats を返す場合があります。指定しない場合は、サーバーで適切なデフォルトが選択されます。
pageToken

string

前の List リクエストから返された nextPageToken 値（存在する場合）。これは、前回の trafficStats.list メソッド呼び出しから返された ListTrafficStatsResponse.next_page_token の値です。

リクエスト本文

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

レスポンスの本文

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

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

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

object (TrafficStats)

TrafficStats のリスト。
nextPageToken

string

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

認可スコープ

次の OAuth スコープが必要です。

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

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

日付

誕生日などのように、カレンダーの日付全体またはその一部を表します。時間帯とタイムゾーンは、他の場所で指定されているか、重要ではありません。日付はグレゴリオ暦を基準にしています。これは次のいずれかを表します。

  • ゼロ以外の年、月、日の値を含む完全な日付。
  • 年の値がゼロである月と日（記念日など）。
  • 月と日の値がゼロである単独の年。
  • 日がゼロである年と月（クレジット カードの有効期限など）

関連するタイプ:

JSON 表現 
{
  "year": integer,
  "month": integer,
  "day": integer
}
フィールド
year

integer

その日付の年。1～9999、または年のない日付を指定する場合は 0 にする必要があります。
month

integer

1 年の中の月。1～12、または月と日のない年を指定する場合は 0 にする必要があります。
day

integer

1 月の中の日付。1～31 で、その年と月に対して有効である必要があります。または、日が重要でない場合に年のみか年と月を指定するには 0 にする必要があります。