Method: users.messages.batchModify

Изменяет метки и значения меток классификации в указанных сообщениях. Для администраторов, изменяющих сообщения для пользователей в своей организации, запросы требуют авторизации с помощью учетной записи службы , обладающей полномочиями делегирования в масштабе домена для имитации пользователей с областью действия https://www.googleapis.com/auth/gmail.modify.restricted .

HTTP-запрос

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

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

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

Параметры
userId

string

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

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

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

JSON-представление 
{
  "ids": [
    string
  ],
  "addLabelIds": [
    string
  ],
  "removeLabelIds": [
    string
  ],
  "addClassificationLabels": [
    {
      object (ClassificationLabelValue)
    }
  ],
  "removeClassificationLabelIds": [
    string
  ]
}
Поля
ids[]

string

Идентификаторы сообщений, которые необходимо изменить. На один запрос допускается не более 1000 идентификаторов.

addLabelIds[]

string

Список идентификаторов меток для добавления к сообщениям.

removeLabelIds[]

string

Список идентификаторов меток, которые следует удалить из сообщений.

addClassificationLabels[]

object ( ClassificationLabelValue )

Список значений меток классификации для добавления. Если метка классификации с тем же идентификатором уже применена к сообщению, поля с существующими идентификаторами будут обновлены, а поля с новыми идентификаторами будут добавлены. Ограничение — 20 значений меток классификации на один запрос. Если сообщение уже классифицировано и общее количество значений меток классификации превышает максимально допустимое количество значений меток классификации на сообщение, изменение завершится неудачей.

removeClassificationLabelIds[]

string

Список значений меток классификации, которые следует удалить из сообщений.

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

В случае успеха тело ответа будет пустым.

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

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

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

Для получения более подробной информации см. руководство по авторизации .