REST Resource: users.labels

Recurso: rótulo

Os marcadores são usados para categorizar mensagens e conversas na caixa de e-mail do usuário. O número máximo de marcadores aceitos para a caixa de e-mails de um usuário é 10.000.

Representação 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)
  }
}
Campos
id

string

O ID imutável do rótulo.
name

string

O nome de exibição do rótulo.
messageListVisibility

enum (MessageListVisibility)

A visibilidade das mensagens com esse marcador na lista de mensagens da interface da Web do Gmail.
labelListVisibility

enum (LabelListVisibility)

A visibilidade do marcador na lista de marcadores na interface da Web do Gmail.
type

enum (Type)

O tipo de proprietário do rótulo. Os marcadores do usuário são criados, modificados e excluídos pelo usuário e podem ser aplicados a qualquer mensagem ou conversa. Os rótulos do sistema são criados internamente e não podem ser adicionados, modificados ou excluídos. Em algumas circunstâncias, é possível aplicar ou remover marcadores do sistema em mensagens e conversas, mas isso não é garantido. Por exemplo, os usuários podem aplicar e remover os marcadores INBOX e UNREAD de mensagens e conversas, mas não podem aplicar nem remover os marcadores DRAFTS ou SENT de mensagens ou conversas.
messagesTotal

integer

O número total de mensagens com o marcador.
messagesUnread

integer

O número de mensagens não lidas com o marcador.
threadsTotal

integer

O número total de conversas com o marcador.
threadsUnread

integer

O número de conversas não lidas com o marcador.
color

object (Color)

A cor a ser atribuída ao marcador. A cor só está disponível para rótulos com type definido como user.

MessageListVisibility

Tipos enumerados
show Mostrar o marcador na lista de mensagens.
hide Não mostrar o marcador na lista de mensagens.

LabelListVisibility

Tipos enumerados
labelShow Mostrar o marcador na lista de marcadores.
labelShowIfUnread Mostrar o marcador se houver mensagens não lidas com ele.
labelHide Não mostrar o marcador na lista de marcadores.

Tipo

Tipos enumerados
system Marcadores criados pelo Gmail.
user Rótulos personalizados criados pelo usuário ou aplicativo.

Cor

Representação JSON 
{
  "textColor": string,
  "backgroundColor": string
}
Campos
textColor

string

A cor do texto do rótulo, representada como uma string hexadecimal. Este campo é obrigatório para definir a cor de um rótulo. Apenas o seguinte conjunto predefinido de valores de cor é permitido:
#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

A cor de fundo representada como a string hexadecimal #RRGGBB (por exemplo, #000000). Este campo é obrigatório para definir a cor de um rótulo. Apenas o seguinte conjunto predefinido de valores de cor é permitido:
#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

Métodos

create

 Cria um rótulo.

delete

 Exclui imediatamente e de forma permanente o marcador especificado e o remove de todas as mensagens e conversas em que ele foi aplicado.

get

 Recebe o rótulo especificado.

list

 Lista todos os marcadores na caixa de correio do usuário.

patch

 Adiciona um patch ao rótulo especificado.

update

 Atualiza o rótulo especificado.