Method: users.messages.modify

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

HTTP-запрос

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

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

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

Параметры
userId

string

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

id

string

Идентификатор сообщения, которое необходимо изменить.

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

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

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

string

A list of IDs of labels to add to this message. You can add up to 100 labels with each update.

removeLabelIds[]

string

Список идентификаторов меток, которые нужно удалить из этого сообщения. При каждом обновлении можно удалить до 100 меток.

addClassificationLabels[]

object ( ClassificationLabelValue )

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

removeClassificationLabelIds[]

string

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

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

В случае успеха тело ответа содержит экземпляр объекта Message .

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

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

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

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