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(即天不重要,指定单独的年份或者年份和月份)。
|
如未另行说明,那么本页面中的内容已根据知识共享署名 4.0 许可获得了许可,并且代码示例已根据 Apache 2.0 许可获得了许可。有关详情,请参阅 Google 开发者网站政策。Java 是 Oracle 和/或其关联公司的注册商标。
最后更新时间 (UTC):2025-07-25。
[null,null,["最后更新时间 (UTC):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. |"]]