Method: domains.trafficStats.list
Sử dụng bộ sưu tập để sắp xếp ngăn nắp các trang
Lưu và phân loại nội dung dựa trên lựa chọn ưu tiên của bạn.
Liệt kê số liệu thống kê về lưu lượng truy cập cho tất cả các ngày có sẵn. Trả về PERMISSION_DENIED nếu người dùng không có quyền truy cập vào TrafficStats cho miền.
Yêu cầu HTTP
GET https://gmailpostmastertools.googleapis.com/v1/{parent=domains/*}/trafficStats
URL sử dụng cú pháp Chuyển mã gRPC.
Tham số đường dẫn
| Thông số |
parent |
string
Tên tài nguyên của miền mà chúng tôi muốn liệt kê số liệu thống kê về lưu lượng truy cập. Tên miền phải có dạng domains/{domain_name}, trong đó domain_name là tên miền đủ điều kiện.
|
Tham số truy vấn
| Thông số |
startDate |
object (Date)
Ngày sớm nhất của các chỉ số cần truy xuất, bao gồm cả ngày đó. Bạn phải chỉ định cả startDate và endDate hoặc không chỉ định cả hai. Nếu bạn chỉ chỉ định một giá trị hoặc endDate sớm hơn startDate, thì hệ thống sẽ trả về INVALID_ARGUMENT.
|
endDate |
object (Date)
Ngày gần đây nhất của các chỉ số để truy xuất riêng biệt. Bạn phải chỉ định cả startDate và endDate hoặc không chỉ định cả hai. Nếu bạn chỉ chỉ định một giá trị hoặc endDate sớm hơn startDate, thì hệ thống sẽ trả về INVALID_ARGUMENT.
|
pageSize |
integer
Kích thước trang được yêu cầu. Máy chủ có thể trả về ít TrafficStats hơn yêu cầu. Nếu không được chỉ định, máy chủ sẽ chọn một giá trị mặc định phù hợp.
|
pageToken |
string
Giá trị nextPageToken được trả về từ một yêu cầu Liệt kê trước đó, nếu có. Đây là giá trị của ListTrafficStatsResponse.next_page_token được trả về từ lệnh gọi trước đó đến phương thức trafficStats.list.
|
Nội dung yêu cầu
Nội dung yêu cầu phải trống.
Nội dung phản hồi
Thông báo phản hồi cho trafficStats.list.
Nếu thành công, phần nội dung phản hồi sẽ chứa dữ liệu có cấu trúc sau:
| Biểu diễn dưới dạng JSON |
{
"trafficStats": [
{
object (TrafficStats)
}
],
"nextPageToken": string
} |
| Trường |
trafficStats[] |
object (TrafficStats)
Danh sách TrafficStats.
|
nextPageToken |
string
Mã thông báo để truy xuất trang kết quả tiếp theo hoặc để trống nếu không còn kết quả nào trong danh sách.
|
Phạm vi uỷ quyền
Yêu cầu phạm vi OAuth sau:
https://www.googleapis.com/auth/postmaster.readonly
Để biết thêm thông tin, hãy xem Hướng dẫn uỷ quyền.
Ngày
Đại diện cho toàn bộ hoặc một phần ngày theo lịch, chẳng hạn như ngày sinh nhật. Thời gian trong ngày và múi giờ được chỉ định ở nơi khác hoặc không quan trọng. Ngày này có liên quan đến Lịch Gregorian. Giá trị này có thể biểu thị một trong những nội dung sau:
- Một ngày đầy đủ, với các giá trị năm, tháng và ngày khác 0.
- Tháng và ngày, với năm bằng 0 (ví dụ: ngày kỷ niệm).
- Chỉ riêng giá trị năm, với giá trị tháng và ngày bằng 0.
- Năm và tháng, với ngày bằng 0 (ví dụ: ngày hết hạn thẻ tín dụng).
Các loại có liên quan:
| Biểu diễn dưới dạng JSON |
{
"year": integer,
"month": integer,
"day": integer
} |
| Trường |
year |
integer
Năm của ngày. Giá trị phải từ 1 đến 9999 hoặc bằng 0 để chỉ định ngày không có năm.
|
month |
integer
Tháng trong năm. Giá trị phải từ 1 đến 12 hoặc bằng 0 để chỉ định một năm không có tháng và ngày.
|
day |
integer
Ngày trong tháng. Giá trị phải từ 1 đến 31 và có giá trị trong năm và tháng, hoặc bằng 0 để chỉ định giá trị năm, hoặc một năm và tháng, trong đó ngày là không quan trọng.
|
Trừ phi có lưu ý khác, nội dung của trang này được cấp phép theo Giấy phép ghi nhận tác giả 4.0 của Creative Commons và các mẫu mã lập trình được cấp phép theo Giấy phép Apache 2.0. Để biết thông tin chi tiết, vui lòng tham khảo Chính sách trang web của Google Developers. Java là nhãn hiệu đã đăng ký của Oracle và/hoặc các đơn vị liên kết với Oracle.
Cập nhật lần gần đây nhất: 2025-07-25 UTC.
[null,null,["Cập nhật lần gần đây nhất: 2025-07-25 UTC."],[],[],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. |"]]
