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

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

Тип истории

Перечисления
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 )

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

СообщениеДобавлено

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

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