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。
|
除非另有註明,否則本頁面中的內容是採用創用 CC 姓名標示 4.0 授權,程式碼範例則為阿帕契 2.0 授權。詳情請參閱《Google Developers 網站政策》。Java 是 Oracle 和/或其關聯企業的註冊商標。
上次更新時間:2025-07-25 (世界標準時間)。
[null,null,["上次更新時間:2025-07-25 (世界標準時間)。"],[],[],null,["# Method: domains.trafficStats.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.ListTrafficStatsResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Date](#Date)\n - [JSON representation](#Date.SCHEMA_REPRESENTATION)\n- [Try it!](#try-it)\n\nList traffic statistics for all available days. Returns PERMISSION_DENIED if user does not have permission to access TrafficStats for the domain.\n\n### HTTP request\n\n`GET https://gmailpostmastertools.googleapis.com/v1/{parent=domains/*}/trafficStats`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `parent` | `string` The resource name of the domain whose traffic statistics we'd like to list. It should have the form `domains/{domain_name}`, where domain_name is the fully qualified domain name. |\n\n### Query parameters\n\n| Parameters ||\n|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `startDate` | `object (`[Date](/workspace/gmail/postmaster/reference/rest/v1/domains.trafficStats/list#Date)`)` The earliest day of the metrics to retrieve inclusive. startDate and endDate must both be specified or both left unspecified. If only one is specified, or endDate is earlier in time than startDate, then INVALID_ARGUMENT is returned. |\n| `endDate` | `object (`[Date](/workspace/gmail/postmaster/reference/rest/v1/domains.trafficStats/list#Date)`)` The most recent day of the metrics to retrieve exclusive. startDate and endDate must both be specified or both left unspecified. If only one is specified, or endDate is earlier in time than startDate, then INVALID_ARGUMENT is returned. |\n| `pageSize` | `integer` Requested page size. Server may return fewer TrafficStats than requested. If unspecified, server will pick an appropriate default. |\n| `pageToken` | `string` The nextPageToken value returned from a previous List request, if any. This is the value of [ListTrafficStatsResponse.next_page_token](/workspace/gmail/postmaster/reference/rest/v1/domains.trafficStats/list#body.ListTrafficStatsResponse.FIELDS.next_page_token) returned from the previous call to `trafficStats.list` method. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nResponse message for trafficStats.list.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|-------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"trafficStats\": [ { object (/workspace/gmail/postmaster/reference/rest/v1/domains.trafficStats#TrafficStats) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|------------------|----------------------------------------------------------------------------------------------------------------------------------------|\n| `trafficStats[]` | `object (`[TrafficStats](/workspace/gmail/postmaster/reference/rest/v1/domains.trafficStats#TrafficStats)`)` The list of TrafficStats. |\n| `nextPageToken` | `string` Token to retrieve the next page of results, or empty if there are no more results in the list. |\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/postmaster.readonly`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent).\n\nDate\n----\n\nRepresents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:\n\n- A full date, with non-zero year, month, and day values.\n- A month and day, with a zero year (for example, an anniversary).\n- A year on its own, with a zero month and a zero day.\n- A year and month, with a zero day (for example, a credit card expiration date).\n\nRelated types:\n\n- `google.type.TimeOfDay`\n- `google.type.DateTime`\n- [google.protobuf.Timestamp](https://protobuf.dev/reference/protobuf/google.protobuf/#timestamp)\n\n| JSON representation |\n|---------------------------------------------------------------|\n| ``` { \"year\": integer, \"month\": integer, \"day\": integer } ``` |\n\n| Fields ||\n|---------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `year` | `integer` Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. |\n| `month` | `integer` Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. |\n| `day` | `integer` Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. |"]]