REST Resource: users.labels

Ressource: Label

Labels werden verwendet, um Nachrichten und Threads im Postfach des Nutzers zu kategorisieren. 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 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 vom Nutzer geändert und gelöscht sowie 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 bestimmten Umständen können Systemlabels auf Nachrichten und Threads angewendet oder daraus entfernt werden. Dies kann jedoch nicht garantiert werden. Nutzer können beispielsweise die Labels INBOX und UNREAD auf Nachrichten und Threads anwenden und entfernen, aber nicht die Labels DRAFTS oder SENT auf Nachrichten oder Threads anwenden oder entfernen.
messagesTotal

integer

Die Gesamtzahl der Nachrichten mit diesem Label.
messagesUnread

integer

Die Anzahl der ungelesenen Nachrichten mit diesem Label.
threadsTotal

integer

Die Gesamtzahl der Threads mit diesem Label.
threadsUnread

integer

Die Anzahl der ungelesenen Threads mit diesem 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 festgelegt ist.

MessageListVisibility

Enums
show Label in der Nachrichtenliste anzeigen
hide Label nicht in der Nachrichtenliste anzeigen

LabelListVisibility

Enums
labelShow Label in der Labelliste anzeigen.
labelShowIfUnread Label anzeigen, wenn ungelesene Nachrichten mit diesem Label vorhanden sind
labelHide Label nicht in der Labelliste anzeigen.

Typ

Enums
system Von Gmail erstellte Labels.
user Benutzerdefinierte Labels, die vom Nutzer oder der Anwendung erstellt wurden.

Farbe

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

string

Die Textfarbe des Labels, dargestellt als hexadezimaler String. Dieses Feld ist erforderlich, um die Farbe eines Labels festzulegen.

backgroundColor

string

Die Hintergrundfarbe, dargestellt als hexadezimaler String "#RRGGBB" (z. B. #000000). Dieses Feld ist erforderlich, um die Farbe eines Labels festzulegen.

Methoden

create

 Erstellt ein neues Label.

delete

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

get

 Ruft das angegebene Label ab.

list

 Listet alle Labels im Postfach des Nutzers auf.

patch

 Patcht das angegebene Label.

update

 Aktualisiert das angegebene Label.