REST Resource: users.labels

Источник: Метка

Метки используются для классификации сообщений и цепочек переписки в почтовом ящике пользователя. Максимальное количество меток, поддерживаемых для почтового ящика пользователя, составляет 10 000.

JSON-представление 
{
  "id": string,
  "name": string,
  "messageListVisibility": enum (MessageListVisibility),
  "labelListVisibility": enum (LabelListVisibility),
  "type": enum (Type),
  "messagesTotal": integer,
  "messagesUnread": integer,
  "threadsTotal": integer,
  "threadsUnread": integer,
  "color": {
    object (Color)
  }
}
Поля
id

string

Неизменяемый идентификатор метки.

name

string

Отображаемое название метки.

messageListVisibility

enum ( MessageListVisibility )

Отображение сообщений с этой меткой в ​​списке сообщений в веб-интерфейсе Gmail.

labelListVisibility

enum ( LabelListVisibility )

Видимость метки в списке меток в веб-интерфейсе Gmail.

type

enum ( Type )

Тип владельца для метки. Пользовательские метки создаются пользователем, могут быть изменены и удалены им, а также могут быть применены к любому сообщению или ветке обсуждения. Системные метки создаются внутри системы и не могут быть добавлены, изменены или удалены. В некоторых случаях системные метки могут быть применены к сообщениям и веткам обсуждения или удалены из них, но это не гарантируется. Например, пользователи могут применять и удалять метки INBOX и UNREAD из сообщений и веток обсуждения, но не могут применять или удалять метки DRAFTS или «Отправленные» из сообщений или веток SENT .

messagesTotal

integer

Общее количество сообщений с меткой.

messagesUnread

integer

Количество непрочитанных сообщений с указанной меткой.

threadsTotal

integer

Общее количество веток с данной меткой.

threadsUnread

integer

Количество непрочитанных сообщений с данной меткой.

color

object ( Color )

Цвет, присваиваемый метке. Этот цвет доступен только для меток, type которых установлен как user .

MessageListVisibility

Перечисления
show Отобразить метку в списке сообщений.
hide Не отображайте метку в списке сообщений.

LabelListVisibility

Перечисления
labelShow Отобразить метку в списке меток.
labelShowIfUnread Если есть непрочитанные сообщения с этой меткой, отобразите соответствующую метку.
labelHide Не отображайте метку в списке меток.

Тип

Перечисления
system Метки созданы Gmail.
user Пользовательские метки, созданные пользователем или приложением.

Цвет

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

string

Цвет текста метки, представленный в виде шестнадцатеричной строки. Это поле обязательно для установки цвета метки. Допускаются только следующие предопределенные значения цвета:
#000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff, #fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3, #f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8, #efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9, #e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0, #cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798, #ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775, #822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c, #464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff, #711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5, #594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1, #c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46, #662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765

backgroundColor

string

Цвет фона представляется в виде шестнадцатеричной строки #RRGGBB (например, #000000). Это поле обязательно для установки цвета метки. Допускаются только следующие предопределенные значения цвета:
#000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff, #fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3, #f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8, #efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9, #e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0, #cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798, #ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775, #822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c, #464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff, #711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5, #594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1, #c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46, #662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765

Методы

create

 Создаёт метку.

delete

 Немедленно и безвозвратно удаляет указанную метку и исключает её из всех сообщений и веток обсуждений, к которым она была применена.

get

 Получает указанную метку.

list

 Отображает список всех меток в почтовом ящике пользователя.

patch

 Прикрепите указанную метку.

update

 Обновляет указанную метку.