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,或兩者都留空白。如果只指定一個,或是 endDate 比 startDate 早,系統會傳回 INVALID_ARGUMENT。

endDate

object (Date)

要擷取的指標的最近一天 (不含該天)。必須同時指定 startDate 和 endDate,或同時不指定。如果只指定一個,或是 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 到 12;如要指定不含日期的年份,請輸入 0。

day

integer

月中的某一天。必須為 1 到 31,並屬於有效的年和月;如果只指定年份,或只指定年份和月份,而不指定當月第幾日的話,請輸入 0。