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

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

日付

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

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

関連するタイプ:

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

integer

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

integer

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

integer

日。1 ～ 31 の範囲の年と月で指定でき、0 の場合は単独で年を指定するか、日付が重要でない年と月を指定します。