Method: domains.trafficStats.list

• HTTP-запрос
• Параметры пути
• Параметры запроса
• Тело запроса
• Тело ответа
  • JSON-представление
• Области авторизации
• Дата
  • JSON-представление
• Попробуйте!

Вывести статистику трафика за все доступные дни. Возвращает 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

Дополнительную информацию см. в руководстве по авторизации .

Дата

Представляет полную или частичную календарную дату, например день рождения. Время суток и часовой пояс либо указаны в другом месте, либо не имеют значения. Дата указана по григорианскому календарю. Это может представлять собой одно из следующих действий:

• Полная дата с ненулевыми значениями года, месяца и дня.
• Месяц и день с нулевым годом (например, годовщина).
• Год сам по себе, с нулевым месяцем и нулевым днем.
• Год и месяц с нулевым днем ​​(например, дата истечения срока действия кредитной карты).

Связанные типы:

• google.type.TimeOfDay
• google.type.DateTime
• google.protobuf.Timestamp

JSON-представление
{ "year": integer, "month": integer, "day": integer }

Поля
year	integer Год даты. Должно быть от 1 до 9999 или 0, чтобы указать дату без года.
month	integer Месяц года. Должно быть от 1 до 12 или 0, чтобы указать год без месяца и дня.
day	integer День месяца. Должно быть от 1 до 31 и действительно для года и месяца, или 0, чтобы указать год отдельно или год и месяц, если день не имеет значения.