Method: domains.trafficStats.list

列出所有可用日期的流量統計資料。如果使用者沒有存取網域 TrafficStats 的權限，系統會傳回 PERMISSION_DENIED。

HTTP 要求

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

這個網址使用 gRPC 轉碼語法。

路徑參數

參數
parent

string

要列出流量統計資料的網域資源名稱。格式應為 domains/{domain_name}，其中 domain_name 為完整的網域名稱。

查詢參數

參數
startDate

object (Date)

要擷取的指標最早日期。startDate 和 endDate 必須同時指定，或兩者皆未指定。如果只指定一個關鍵字，或結束日期早於 startDate，則會傳回 INVALID_src。
endDate

object (Date)

要擷取的指標最後一天。startDate 和 endDate 必須同時指定，或兩者皆未指定。如果只指定一個關鍵字，或結束日期早於 startDate，則會傳回 INVALID_src。
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 的月份和日期，例如週年紀念日。
  • 有 1 年，第 0 個月卻為 0 天。
  • 年和月，但數字為零 (例如信用卡到期日)。

相關類型：

JSON 表示法 
{
  "year": integer,
  "month": integer,
  "day": integer
}
欄位
year

integer

日期的年份。這個值必須介於 1 至 9999，或 0 之間可指定不含年份的日期。
month

integer

一年中的月份。必須介於 1 到 12 之間，或 0 可以指定不含月份和日期的年份。
day

integer

一個月中的第幾天。這個值必須介於 1 至 31 之間，且有效的年份和月份；或 0 可讓您指定本身或年份和月份，但這些日期不明顯。