REST Resource: users.labels

Risorsa: etichetta

Le etichette vengono utilizzate per classificare i messaggi e i thread all'interno della casella di posta dell'utente. Il numero massimo di etichette supportate per la casella di posta di un utente è 10.000.

Rappresentazione 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)
  }
}
Campi
id

string

L'ID non modificabile dell'etichetta.
name

string

Il nome visualizzato dell'etichetta.
messageListVisibility

enum (MessageListVisibility)

La visibilità dei messaggi con questa etichetta nell'elenco dei messaggi nell'interfaccia web di Gmail.
labelListVisibility

enum (LabelListVisibility)

La visibilità dell'etichetta nell'elenco delle etichette nell'interfaccia web di Gmail.
type

enum (Type)

Il tipo di proprietario dell'etichetta. Le etichette dell'utente sono create dall'utente, che può modificarle ed eliminarle e applicarle a qualsiasi messaggio o thread. Le etichette di sistema vengono create internamente e non possono essere aggiunte, modificate o eliminate. In alcune circostanze, le etichette di sistema potrebbero essere applicate o rimosse da messaggi e thread, ma non è garantito. Ad esempio, gli utenti possono applicare e rimuovere le etichette INBOX e UNREAD da messaggi e thread, ma non possono applicare o rimuovere le etichette DRAFTS o SENT da messaggi o thread.
messagesTotal

integer

Il numero totale di messaggi con l'etichetta.
messagesUnread

integer

Il numero di messaggi non letti con l'etichetta.
threadsTotal

integer

Il numero totale di thread con l'etichetta.
threadsUnread

integer

Il numero di thread non letti con l'etichetta.
color

object (Color)

Il colore da assegnare all'etichetta. Il colore è disponibile solo per le etichette con type impostato su user.

MessageListVisibility

Enum
show Mostra l'etichetta nell'elenco dei messaggi.
hide Non mostrare l'etichetta nell'elenco dei messaggi.

LabelListVisibility

Enum
labelShow Mostra l'etichetta nell'elenco delle etichette.
labelShowIfUnread Mostra l'etichetta se sono presenti messaggi da leggere con quell'etichetta.
labelHide Non mostrare l'etichetta nell'elenco delle etichette.

Tipo

Enum
system Etichette create da Gmail.
user Etichette personalizzate create dall'utente o dall'applicazione.

Colore

Rappresentazione JSON 
{
  "textColor": string,
  "backgroundColor": string
}
Campi
textColor

string

Il colore del testo dell'etichetta, rappresentato come stringa esadecimale. Questo campo è obbligatorio per impostare il colore di un'etichetta. È consentito solo il seguente insieme predefinito di valori di colore:
#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

Il colore di sfondo rappresentato come stringa esadecimale #RRGGBB (ad es. #000000). Questo campo è obbligatorio per impostare il colore di un'etichetta. È consentito solo il seguente insieme predefinito di valori di colore:
#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

Metodi

create

 Crea una nuova etichetta.

delete

 Elimina immediatamente e definitivamente l'etichetta specificata e la rimuove da tutti i messaggi e thread a cui è applicata.

get

 Recupera l'etichetta specificata.

list

 Elenca tutte le etichette nella casella di posta dell'utente.

patch

 Esegui il patch dell'etichetta specificata.

update

 Aggiorna l'etichetta specificata.