Method: users.history.list

Выводит историю всех изменений в указанном почтовом ящике. Результаты истории возвращаются в хронологическом порядке (по возрастанию historyId ).

HTTP-запрос

GET https://gmail.googleapis.com/gmail/v1/users/{userId}/history

В URL-адресе используется синтаксис транскодирования gRPC .

Параметры пути

Параметры
userId

string

Адрес электронной почты пользователя. Специальное значение me может использоваться для обозначения авторизованного пользователя.

Параметры запроса

Параметры
maxResults

integer ( uint32 format)

Максимальное количество записей истории для возврата. Значение по умолчанию для этого поля — 100. Максимально допустимое значение для этого поля — 500.

pageToken

string

Токен страницы для получения конкретной страницы результатов в списке.

startHistoryId

string

Обязательный параметр. Возвращает записи истории после указанного startHistoryId . Указанный startHistoryId должен быть получен из historyId сообщения, ветки обсуждения или предыдущего ответа list . Идентификаторы истории увеличиваются хронологически, но не являются последовательными, с произвольными промежутками между действительными идентификаторами. Предоставление недействительного или устаревшего startHistoryId обычно возвращает код ошибки HTTP 404 historyId обычно действителен как минимум неделю, но в некоторых редких случаях может быть действителен всего несколько часов. Если вы получили ответ с ошибкой HTTP 404 , ваше приложение должно выполнить полную синхронизацию. Если в ответе отсутствует nextPageToken , нет обновлений для получения, и вы можете сохранить возвращенный historyId для будущего запроса.

labelId

string

Возвращать только сообщения с меткой, соответствующей идентификатору.

historyTypes[]

enum ( HistoryType )

Типы истории, возвращаемые функцией

Текст запроса

Тело запроса должно быть пустым.

Ответный текст

В случае успеха тело ответа будет содержать данные следующей структуры:

JSON-представление 
{
  "history": [
    {
      object (History)
    }
  ],
  "nextPageToken": string,
  "historyId": string
}
Поля
history[]

object ( History )

Список записей истории. В messages обычно содержатся только поля id и threadId .

nextPageToken

string

Токен страницы для получения следующей страницы результатов в списке.

historyId

string

Идентификатор текущей записи истории почтового ящика.

Области полномочий

Требуется один из следующих диапазонов аутентификации OAuth:

  • https://mail.google.com/
  • https://www.googleapis.com/auth/gmail.modify
  • https://www.googleapis.com/auth/gmail.readonly
  • https://www.googleapis.com/auth/gmail.metadata

Для получения более подробной информации см.OAuth 2.0 Overview .

HistoryType

Перечисления
messageAdded
messageDeleted
labelAdded
labelRemoved

История

Запись об изменении в почтовом ящике пользователя. Каждое изменение в истории может повлиять на несколько сообщений различными способами.

JSON-представление 
{
  "id": string,
  "messages": [
    {
      object (Message)
    }
  ],
  "messagesAdded": [
    {
      object (MessageAdded)
    }
  ],
  "messagesDeleted": [
    {
      object (MessageDeleted)
    }
  ],
  "labelsAdded": [
    {
      object (LabelAdded)
    }
  ],
  "labelsRemoved": [
    {
      object (LabelRemoved)
    }
  ]
}
Поля
id

string

Идентификатор последовательности почтового ящика.

messages[]

object ( Message )

Список сообщений, измененных в этой записи истории. Поля для определенных типов изменений, таких как messagesAdded могут дублировать сообщения в этом поле. Мы рекомендуем использовать поля для конкретных типов изменений вместо этого.

messagesAdded[]

object ( MessageAdded )

Сообщения, добавленные в почтовый ящик, занесены в эту историю.

messagesDeleted[]

object ( MessageDeleted )

В этой истории отображаются сообщения, удаленные (не перемещенные в корзину) из почтового ящика.

labelsAdded[]

object ( LabelAdded )

В этот архив добавлены метки к сообщениям.

labelsRemoved[]

object ( LabelRemoved )

Из сообщений в этом историческом документе удалены пометки.

MessageAdded

JSON-представление 
{
  "message": {
    object (Message)
  }
}
Поля
message

object ( Message )

Сообщение удалено

JSON-представление 
{
  "message": {
    object (Message)
  }
}
Поля
message

object ( Message )

Добавлена ​​метка

JSON-представление 
{
  "message": {
    object (Message)
  },
  "labelIds": [
    string
  ]
}
Поля
message

object ( Message )

labelIds[]

string

Идентификаторы меток добавлены к сообщению.

Метка удалена

JSON-представление 
{
  "message": {
    object (Message)
  },
  "labelIds": [
    string
  ]
}
Поля
message

object ( Message )

labelIds[]

string

Идентификаторы меток удалены из сообщения.