REST Resource: users.labels

Ressource: Label

Mit Labels werden Nachrichten und Threads im Postfach des Nutzers kategorisiert. Für das Postfach eines Nutzers werden maximal 10.000 Labels unterstützt.

JSON-Darstellung 
{
  "id": string,
  "name": string,
  "messageListVisibility": enum (MessageListVisibility),
  "labelListVisibility": enum (LabelListVisibility),
  "type": enum (Type),
  "messagesTotal": integer,
  "messagesUnread": integer,
  "threadsTotal": integer,
  "threadsUnread": integer,
  "color": {
    object (Color)
  }
}
Felder
id

string

Die unveränderliche ID des Labels.
name

string

Der Anzeigename des Labels.
messageListVisibility

enum (MessageListVisibility)

Die Sichtbarkeit von Nachrichten mit diesem Label in der Nachrichtenliste in der Gmail-Weboberfläche.
labelListVisibility

enum (LabelListVisibility)

Die Sichtbarkeit des Labels in der Labelliste in der Gmail-Weboberfläche.
type

enum (Type)

Der Inhabertyp für das Label. Nutzerlabels werden vom Nutzer erstellt und können von ihm geändert und gelöscht werden. Sie können auf jede Nachricht oder jeden Thread angewendet werden. Systemlabels werden intern erstellt und können nicht hinzugefügt, geändert oder gelöscht werden. Unter Umständen können Systemlabels auf Nachrichten und Threads angewendet oder daraus entfernt werden. Dies ist jedoch nicht garantiert. Nutzer können beispielsweise die Labels INBOX und UNREAD auf Nachrichten und Threads anwenden und entfernen, aber die Labels DRAFTS oder SENT nicht.
messagesTotal

integer

Die Gesamtzahl der Nachrichten mit dem Label.
messagesUnread

integer

Die Anzahl der ungelesenen Nachrichten mit dem Label.
threadsTotal

integer

Die Gesamtzahl der Threads mit dem Label.
threadsUnread

integer

Die Anzahl der ungelesenen Threads mit dem Label.
color

object (Color)

Die Farbe, die dem Label zugewiesen werden soll. Die Farbe ist nur für Labels verfügbar, bei denen type auf user gesetzt ist.

MessageListVisibility

Enums
show Label in der Nachrichtenliste anzeigen
hide Das Label wird nicht in der Nachrichtenliste angezeigt.

LabelListVisibility

Enums
labelShow Das Label wird in der Labelliste angezeigt.
labelShowIfUnread Das Label wird angezeigt, wenn es ungelesene Nachrichten mit diesem Label gibt.
labelHide Das Label wird nicht in der Labelliste angezeigt.

Typ

Enums
system In Gmail erstellte Labels.
user Vom Nutzer oder der Anwendung erstellte benutzerdefinierte Labels.

Farbe

JSON-Darstellung 
{
  "textColor": string,
  "backgroundColor": string
}
Felder
textColor

string

Die Textfarbe des Labels, dargestellt als Hexadezimalstring. Dieses Feld ist erforderlich, um die Farbe eines Labels festzulegen. Es sind nur die folgenden vordefinierten Farbwerte zulässig:
#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

Die Hintergrundfarbe als Hexadezimalstring #RRGGBB (z. B. #000000). Dieses Feld ist erforderlich, um die Farbe eines Labels festzulegen. Es sind nur die folgenden vordefinierten Farbwerte zulässig:
#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

Methoden

create

 Erstellt ein neues Label.

delete

 Das angegebene Label wird sofort und endgültig gelöscht und aus allen Nachrichten und Unterhaltungen entfernt, auf die es angewendet wurde.

get

 Ruft das angegebene Label ab.

list

 Listet alle Labels im Postfach des Nutzers auf.

patch

 Patch für das angegebene Label.

update

 Aktualisiert das angegebene Label.