REST Resource: users.labels

Recurso: Label

Las etiquetas se usan para categorizar mensajes y 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

Es el ID inmutable de la etiqueta.
name

string

Es el nombre visible de la etiqueta.
messageListVisibility

enum (MessageListVisibility)

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

enum (LabelListVisibility)

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

enum (Type)

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

integer

Es la cantidad total de mensajes con la etiqueta.
messagesUnread

integer

Es la cantidad de mensajes no leídos con la etiqueta.
threadsTotal

integer

Es la cantidad total de conversaciones con la etiqueta.
threadsUnread

integer

Es la cantidad 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 configurado como user.

MessageListVisibility

Enums
show Muestra la etiqueta en la lista de mensajes.
hide No muestra la etiqueta en la lista de mensajes.

LabelListVisibility

Enums
labelShow Muestra la etiqueta en la lista de etiquetas.
labelShowIfUnread Muestra la etiqueta si hay mensajes no leídos con esa etiqueta.
labelHide No muestra la etiqueta en la lista de etiquetas.

Tipo

Enums
system Son las etiquetas creadas por Gmail.
user Son las etiquetas personalizadas creadas por el usuario o la aplicación.

Color

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

string

Es el color del texto de la etiqueta, representado como una cadena hexadecimal. Este campo es obligatorio para configurar el color de una etiqueta. Solo se permite el siguiente conjunto predefinido de valores de color:
#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

Es el color de fondo representado como una cadena hexadecimal #RRGGBB (p. ej., #000000). Este campo es obligatorio para configurar el color de una etiqueta. Solo se permite el siguiente conjunto predefinido de valores de color:
#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

 Crea una etiqueta nueva.

delete

 Borra de inmediato y de forma permanente la etiqueta especificada, y la quita de los mensajes y las conversaciones a los que se aplica.

get

 Obtiene la etiqueta especificada.

list

 Muestra todas las etiquetas del buzón del usuario.

patch

 Aplica un parche a la etiqueta especificada.

update

 Actualiza la etiqueta especificada.