REST Resource: users.labels

Ressource: Étiquette

Les libellés permettent de classer les messages et les fils de discussion dans la boîte aux lettres de l'utilisateur. La boîte aux lettres d'un utilisateur peut contenir jusqu'à 10 000 libellés.

Représentation 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)
  }
}
Champs
id

string

Identifiant immuable du libellé.
name

string

Nom à afficher du libellé.
messageListVisibility

enum (MessageListVisibility)

Visibilité des messages portant ce libellé dans la liste des messages de l'interface Web de Gmail.
labelListVisibility

enum (LabelListVisibility)

Visibilité du libellé dans la liste des libellés sur l'interface Web de Gmail.
type

enum (Type)

Type de propriétaire du libellé. Les libellés utilisateur sont créés par l'utilisateur, et peuvent être modifiés et supprimés par l'utilisateur, et peuvent être appliqués à n'importe quel message ou fil de discussion. Les libellés système sont créés en interne et ne peuvent pas être ajoutés, modifiés ni supprimés. Il est possible d'appliquer ou de supprimer des libellés système dans les messages et les fils de discussion dans certaines circonstances, mais cela n'est pas garanti. Par exemple, les utilisateurs peuvent appliquer et supprimer les libellés INBOX et UNREAD des messages et des fils de discussion, mais pas d'appliquer ou de supprimer les libellés DRAFTS ou SENT des messages ou des fils de discussion.
messagesTotal

integer

Nombre total de messages portant ce libellé.
messagesUnread

integer

Nombre de messages non lus portant ce libellé.
threadsTotal

integer

Nombre total de threads avec le libellé.
threadsUnread

integer

Nombre de fils de discussion non lus portant ce libellé.
color

object (Color)

Couleur à attribuer au libellé. La couleur n'est disponible que pour les libellés dont le type est défini sur user.

MessageListVisibility

Enums
show Afficher le libellé dans la liste des messages
hide Ne pas afficher le libellé dans la liste des messages.

LabelListVisibility

Enums
labelShow Afficher le libellé dans la liste des libellés
labelShowIfUnread afficher ce libellé s'il existe des messages non lus associés à ce libellé ;
labelHide Ne pas afficher le libellé dans la liste des libellés.

Type

Enums
system Libellés créés par Gmail.
user Étiquettes personnalisées créées par l'utilisateur ou l'application.

Couleur

Représentation JSON 
{
  "textColor": string,
  "backgroundColor": string
}
Champs
textColor

string

Couleur du texte du libellé, représentée par une chaîne hexadécimale. Ce champ est obligatoire pour définir la couleur d'un libellé. Vous pouvez utiliser les ensembles de valeurs de couleurs prédéfinis suivants:
#0000000, #434343, #6666666, #9999999, #cccccc, #e9999999, #cccccc.
backgroundColor

string

Couleur d'arrière-plan représentée sous la forme d'une chaîne hexadécimale #RRGGBB (par exemple, #000000). Ce champ est obligatoire pour définir la couleur d'un libellé. Vous pouvez utiliser les ensembles de valeurs de couleurs prédéfinis suivants:
#0000000, #434343, #6666666, #9999999, #cccccc, #e9999999, #cccccc.

Méthodes

create

 Crée un libellé.

delete

 Le libellé spécifié est supprimé immédiatement et de manière définitive, ainsi que des messages et fils de discussion auxquels il s'applique.

get

 Récupère le libellé spécifié.

list

 Liste tous les libellés de la boîte aux lettres de l'utilisateur.

patch

 Appliquez un correctif au libellé spécifié.

update

 Met à jour l'étiquette spécifiée.