Method: domains.trafficStats.list
Оптимизируйте свои подборки
Сохраняйте и классифицируйте контент в соответствии со своими настройками.
Вывести статистику трафика за все доступные дни. Возвращает PERMISSION_DENIED, если у пользователя нет разрешения на доступ к TrafficStats для домена.
HTTP-запрос
GET https://gmailpostmastertools.googleapis.com/v1/{parent=domains/*}/trafficStats
URL-адрес использует синтаксис транскодирования gRPC .
Параметры пути
| Параметры |
|---|
parent | string Имя ресурса домена, статистику трафика которого мы хотим вывести. Оно должно иметь форму domains/{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 Значение nextPageToken, возвращенное из предыдущего запроса списка, если таковой имеется. Это значение ListTrafficStatsResponse.next_page_token возвращенное в результате предыдущего вызова метода trafficStats.list . |
Тело запроса
Тело запроса должно быть пустым.
Тело ответа
Ответное сообщение для 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, чтобы указать год отдельно или год и месяц, если день не имеет значения. |
Если не указано иное, контент на этой странице предоставляется по лицензии Creative Commons "С указанием авторства 4.0", а примеры кода – по лицензии Apache 2.0. Подробнее об этом написано в правилах сайта. Java – это зарегистрированный товарный знак корпорации Oracle и ее аффилированных лиц.
Последнее обновление: 2025-07-25 UTC.
[null,null,["Последнее обновление: 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. |"]]
