REST Resource: users.labels

Recurso: identificador

Os marcadores são usados para categorizar mensagens e conversas dentro da caixa de correio 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

ID imutável do rótulo.
name

string

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

enum (MessageListVisibility)

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

enum (LabelListVisibility)

A visibilidade do marcador na lista de marcadores da 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, que podem ser modificados e excluídos e aplicados a qualquer mensagem ou conversa. Os marcadores do sistema são criados internamente e não podem ser adicionados, modificados nem excluídos. Em alguns casos, marcadores de sistema podem ser aplicados ou removidos de 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 ou remover os marcadores DRAFTS ou SENT das 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 linhas de execução com o rótulo.
threadsUnread

integer

O número de conversas não lidas com o rótulo.
color

object (Color)

A cor a ser atribuída ao rótulo. A cor está disponível apenas para marcadores com o type definido como user.

MessageListVisibility

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

Visibilidade da etiqueta

Enums
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

Enums
system Marcadores criados pelo Gmail.
user Rótulos personalizados criados pelo usuário ou pelo app.

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. Você está fora do escopo?
backgroundColor

string

A cor do plano de fundo representada como uma string hexadecimal #RRGGBB (por exemplo, #000000). Este campo é obrigatório para definir a cor de um rótulo. Você está fora do escopo?

Métodos

create

 Cria um novo rótulo.

delete

 Exclui o marcador especificado de forma imediata e permanente 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 e-mails do usuário.

patch

 Aplicar patch ao rótulo especificado.

update

 Atualiza o rótulo especificado.