Method: users.watch

Настройте или обновите отслеживание push-уведомлений для данного почтового ящика пользователя.

HTTP-запрос

POST https://gmail.googleapis.com/gmail/v1/users/{userId}/watch

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

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

Параметры
userId

string

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

Тело запроса

Тело запроса содержит данные следующей структуры:

JSON-представление 
{
  "labelIds": [
    string
  ],
  "labelFilterAction": enum (LabelFilterAction),
  "labelFilterBehavior": enum (LabelFilterAction),
  "topicName": string
}
Поля
labelIds[]

string

Список идентификаторов меток, уведомления о которых следует ограничить. По умолчанию, если не указано, все изменения удаляются. Если указано, то определяет, какие метки необходимы для создания push-уведомления.

labelFilterAction
(deprecated)

enum ( LabelFilterAction )

Указано поведение фильтрации labelIds list . Это поле устарело, поскольку в некоторых случаях оно вызывало некорректное поведение; вместо этого используйте labelFilterBehavior .

labelFilterBehavior

enum ( LabelFilterAction )

Указано поведение фильтрации labelIds list . Это поле заменяет labelFilterAction ; если установлено, labelFilterAction игнорируется.

topicName

string

Полное имя темы Google Cloud Pub/Sub API, в которой будут публиковаться события. Это название темы уже должно существовать в Cloud Pub/Sub, и вы уже предоставили Gmail разрешение на ее публикацию. Например, «projects/my-project-identifier/topics/my-topic-name» (с использованием формата именования тем Cloud Pub/Sub «v1»).

Обратите внимание, что часть «my-project-identifier» должна точно совпадать с идентификатором вашего проекта разработчика Google (того, который выполняет этот запрос на просмотр).

Тело ответа

Нажмите уведомление, чтобы увидеть ответ.

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

JSON-представление 
{
  "historyId": string,
  "expiration": string
}
Поля
historyId

string

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

expiration

string ( int64 format)

Когда Gmail перестанет отправлять уведомления об обновлениях почтового ящика (эпоха миллис). До этого времени еще раз позвоните на watch , чтобы возобновить часы.

Области авторизации

Требуется одна из следующих областей 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

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

МеткаФильтрДействие

Указано поведение фильтрации списка labelIds.

Перечисления
include Получайте push-уведомления только об изменениях сообщений, связанных с указанными идентификаторами меток.
exclude Получайте push-уведомления обо всех изменениях сообщений, кроме тех, которые относятся к указанным меткам.