Method: users.messages.batchModify
Изменяет метки указанных сообщений.
HTTP-запрос
POST https://gmail.googleapis.com/gmail/v1/users/{userId}/messages/batchModify
URL-адрес использует синтаксис транскодирования gRPC .
Параметры пути
| Параметры |
|---|
userId | string Адрес электронной почты пользователя. Специальное значение me можно использовать для указания аутентифицированного пользователя. |
Тело запроса
Тело запроса содержит данные следующей структуры:
| JSON-представление |
|---|
{
"ids": [
string
],
"addLabelIds": [
string
],
"removeLabelIds": [
string
]
} |
| Поля |
|---|
ids[] | string Идентификаторы сообщений, которые необходимо изменить. Существует ограничение в 1000 идентификаторов на запрос. |
addLabelIds[] | string Список идентификаторов меток для добавления в сообщения. |
removeLabelIds[] | string Список идентификаторов меток, которые нужно удалить из сообщений. |
Тело ответа
В случае успеха тело ответа пустое.
Области авторизации
Требуется одна из следующих областей OAuth:
-
https://mail.google.com/ -
https://www.googleapis.com/auth/gmail.modify
Дополнительную информацию см. в руководстве по авторизации .
Если не указано иное, контент на этой странице предоставляется по лицензии Creative Commons "С указанием авторства 4.0", а примеры кода – по лицензии Apache 2.0. Подробнее об этом написано в правилах сайта. Java – это зарегистрированный товарный знак корпорации Oracle и ее аффилированных лиц.
Последнее обновление: 2024-11-14 UTC.
[null,null,["Последнее обновление: 2024-11-14 UTC."],[[["This endpoint allows modification of labels on multiple messages in batches, by adding or removing label IDs."],["Users need to provide message IDs and desired label IDs for adding or removing."],["It uses an HTTP POST request with specific path parameters and a JSON request body structure."],["Successful execution results in an empty response body, indicating the labels were modified."],["Authorization is required, using specified OAuth scopes related to Gmail access and modification."]]],["This describes how to modify labels on Gmail messages via an HTTP POST request to `https://gmail.googleapis.com/gmail/v1/users/{userId}/messages/batchModify`. The `userId` path parameter specifies the user. The request body, in JSON format, includes `ids` (message IDs), `addLabelIds`, and `removeLabelIds` to specify which labels to modify. A maximum of 1000 message IDs is allowed per request. A successful request returns an empty response body and requires specific OAuth scopes.\n"]]
