REST Resource: users.labels

Ressource: Libellé

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

ID immuable du libellé.
name

string

Nom à afficher du libellé.
messageListVisibility

enum (MessageListVisibility)

Visibilité des messages associés à 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 de l'interface Web de Gmail.
type

enum (Type)

Type de propriétaire du libellé. Les libellés utilisateur sont créés par l'utilisateur. Ils 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. Vous ne pouvez pas les ajouter, les modifier ni les supprimer. Dans certains cas, les libellés système peuvent être appliqués ou supprimés des messages et des fils de discussion, 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 ne peuvent pas appliquer les libellés DRAFTS ou SENT aux messages ou aux fils de discussion.
messagesTotal

integer

Nombre total de messages associés au libellé.
messagesUnread

integer

Nombre de messages non lus associés au libellé.
threadsTotal

integer

Nombre total de fils de discussion avec le libellé.
threadsUnread

integer

Nombre de fils de discussion non lus avec le libellé.
color

object (Color)

Couleur à attribuer au libellé. La couleur n'est disponible que pour les libellés dont la propriété type est définie sur user.

MessageListVisibility

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

ÉtiquetteListeVisibilité

Enums
labelShow Afficher le libellé dans la liste des libellés
labelShowIfUnread Afficher le libellé s'il y a des messages non lus avec ce libellé.
labelHide Ne pas afficher le libellé dans la liste.

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 libellé, représentée par une chaîne hexadécimale. Ce champ est obligatoire pour définir la couleur d'un libellé. :
backgroundColor

string

Couleur d'arrière-plan représentée par une chaîne hexadécimale #RRGGBB (ex. : 000000). Ce champ est obligatoire pour définir la couleur d'un libellé. :

Méthodes

create

 Crée un libellé.

delete

 Supprime immédiatement et définitivement le libellé spécifié, ainsi que les messages et fils de discussion auxquels il s'applique.

get

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

list

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

patch

 Appliquez un correctif au libellé spécifié.

update

 Met à jour le libellé spécifié.