REST Resource: users.labels

Ressource: Libellé

Les libellés permettent de classer les messages et les fils de discussion dans la boîte de réception de l'utilisateur. Le nombre maximal de libellés acceptés pour la boîte aux lettres d'un utilisateur est de 10 000.

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 de l'étiquette.
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, qui peut les modifier et les supprimer. Ils 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 que des libellés système puissent être appliqués ou supprimés de messages et de 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 aux messages et aux discussions, mais pas les libellés DRAFTS ou SENT.
messagesTotal

integer

Nombre total de messages avec le libellé.
messagesUnread

integer

Nombre de messages non lus avec le libellé.
threadsTotal

integer

Nombre total de threads 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 valeur 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.

LabelListVisibility

Enums
labelShow Affichez le libellé dans la liste des libellés.
labelShowIfUnread Afficher le libellé si des messages non lus sont 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 Libellés personnalisés créés 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 sous forme de chaîne hexadécimale. Ce champ est obligatoire pour définir la couleur d'un libellé. Seul l'ensemble prédéfini de valeurs de couleur suivant est autorisé:
#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

Couleur d'arrière-plan représentée par la chaîne hexadécimale #RRGGBB (par exemple, #000000). Ce champ est obligatoire pour définir la couleur d'un libellé. Seul l'ensemble prédéfini de valeurs de couleur suivant est autorisé:
#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éthodes

create

 Crée un libellé.

delete

 Supprime immédiatement et définitivement le libellé spécifié, et le retire de tous les messages et fils de discussion auxquels il est appliqué.

get

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

list

 Liste tous les libellés de la boîte de réception de l'utilisateur.

patch

 Appliquez un correctif au libellé spécifié.

update

 Met à jour le libellé spécifié.