REST Resource: users.labels

Recurso: rótulo

Os marcadores são usados para categorizar mensagens e conversas na caixa de correio do usuário. O número máximo de marcadores permitidos para a caixa de correio 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 de usuário são criados pelo usuário e podem ser modificados e excluídos por ele e aplicados a qualquer mensagem ou sequência. Os rótulos do sistema são criados internamente e não podem ser adicionados, modificados ou excluídos. Os marcadores do sistema podem ser aplicados ou removidos de mensagens e conversas em algumas circunstâncias, 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 ou remover 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 rótulo.
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 marcadores com type definido como user.

MessageListVisibility

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

LabelListVisibility

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

Tipo

Enums
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 string hexadecimal. Este campo é obrigatório para definir a cor de um marcador.

backgroundColor

string

A cor de fundo representada como string hexadecimal #RRGGBB (por exemplo, #000000). Este campo é obrigatório para definir a cor de um marcador.

Métodos

create

 Cria um novo marcador.

delete

 Exclui de forma imediata e permanente o marcador especificado e o remove de todas as mensagens e conversas a que foi aplicado.

get

 Recebe o rótulo especificado.

list

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

patch

 Aplica um patch no marcador especificado.

update

 Atualiza o rótulo especificado.