REST Resource: users.labels

Recurso: Etiqueta

Las etiquetas se usan para categorizar los mensajes y las conversaciones dentro del buzón del usuario. La cantidad máxima de etiquetas admitidas para el buzón de un usuario es de 10,000.

Representación 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

El ID inmutable de la etiqueta.
name

string

El nombre visible de la etiqueta.
messageListVisibility

enum (MessageListVisibility)

La visibilidad de los mensajes con esta etiqueta en la lista de mensajes de la interfaz web de Gmail.
labelListVisibility

enum (LabelListVisibility)

La visibilidad de la etiqueta en la lista de etiquetas de la interfaz web de Gmail.
type

enum (Type)

El tipo de propietario de la etiqueta. El usuario crea las etiquetas de usuario, que pueden modificar y borrar, además de aplicarse a cualquier mensaje o conversación. Las etiquetas del sistema se crean internamente y no se pueden agregar, modificar ni borrar. En determinadas circunstancias, es posible que se puedan aplicar o quitar las etiquetas del sistema en los mensajes y las conversaciones, pero esto no está garantizado. Por ejemplo, los usuarios pueden aplicar y quitar las etiquetas INBOX y UNREAD de los mensajes y las conversaciones, pero no pueden aplicar ni quitar las etiquetas DRAFTS o SENT de los mensajes o las conversaciones.
messagesTotal

integer

La cantidad total de mensajes con la etiqueta.
messagesUnread

integer

El número de mensajes no leídos con la etiqueta.
threadsTotal

integer

La cantidad total de subprocesos con la etiqueta.
threadsUnread

integer

El número de conversaciones no leídas con la etiqueta.
color

object (Color)

Es el color que se asignará a la etiqueta. El color solo está disponible para las etiquetas que tienen su type establecido en user.

MessageListVisibility

Enumeradores
show Mostrar la etiqueta en la lista de mensajes
hide No mostrar la etiqueta en la lista de mensajes

LabelListVisibility

Enumeradores
labelShow Mostrar la etiqueta en la lista de etiquetas
labelShowIfUnread Mostrar la etiqueta si hay algún mensaje no leído con esa etiqueta
labelHide No mostrar la etiqueta en la lista de etiquetas

Tipo

Enumeradores
system Etiquetas creadas por Gmail
user Etiquetas personalizadas creadas por el usuario o la aplicación.

Color

Representación JSON 
{
  "textColor": string,
  "backgroundColor": string
}
Campos
textColor

string

El color del texto de la etiqueta, representado como cadena hexadecimal. Este campo es obligatorio para establecer el color de una etiqueta. .
backgroundColor

string

El color de fondo representado como una cadena hexadecimal #RRGGBB (p. ej., #000000). Este campo es obligatorio para establecer el color de una etiqueta. .

Métodos

create

 Crea una etiqueta nueva.

delete

 Borra de manera inmediata y permanente la etiqueta especificada y la quita de todos los mensajes y conversaciones a los que se aplica.

get

 Obtiene la etiqueta especificada.

list

 Enumera todas las etiquetas en el buzón del usuario.

patch

 Aplica un parche a la etiqueta especificada.

update

 Actualiza la etiqueta especificada.