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 immutabile dell'etichetta.
name

string

Il nome visualizzato dell'etichetta.
messageListVisibility

enum (MessageListVisibility)

La visibilità dei messaggi con questa etichetta nell'elenco dei messaggi dell'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 utente vengono create dall'utente, possono essere modificate ed eliminate dall'utente e possono essere applicate a qualsiasi messaggio o thread. Le etichette di sistema vengono create internamente e non possono essere aggiunte, modificate o eliminate. In alcune circostanze è possibile applicare o rimuovere le etichette di sistema ai messaggi e ai thread, ma questo 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 da leggere con l'etichetta.
threadsTotal

integer

Il numero totale di thread con l'etichetta.
threadsUnread

integer

Il numero di thread da leggere con l'etichetta.
color

object (Color)

Il colore da assegnare all'etichetta. Il colore è disponibile solo per le etichette per cui il campo 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 ci sono 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. #6,6,6,7, #6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6 #9,9 #19a #199 #1999 #199a #1999 #999999 #9999999, #999999
backgroundColor

string

Il colore di sfondo rappresentato come stringa esadecimale #RRGGBB (ad es. #000000). Questo campo è obbligatorio per impostare il colore di un'etichetta. #6,6,6,7, #6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6,6 #9,9 #19a #199 #1999 #199a #1999 #999999 #9999999, #999999

Metodi

create

 Crea una nuova etichetta.

delete

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

get

 Consente di ottenere l'etichetta specificata.

list

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

patch

 Applica la patch all'etichetta specificata.

update

 Aggiorna l'etichetta specificata.