REST Resource: users.labels

Zasób: Etykieta

Etykiety służą do klasyfikowania wiadomości i wątków w skrzynce pocztowej użytkownika. Maksymalna liczba etykiet obsługiwanych w skrzynce pocztowej użytkownika to 10 000.

Zapis 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)
  }
}
Pola
id

string

Stały identyfikator etykiety.

name

string

Wyświetlana nazwa etykiety.

messageListVisibility

enum (MessageListVisibility)

Widoczność wiadomości z tą etykietą na liście wiadomości w interfejsie internetowym Gmaila.

labelListVisibility

enum (LabelListVisibility)

Widoczność etykiety na liście etykiet w interfejsie internetowym Gmaila.

type

enum (Type)

Typ właściciela etykiety. Etykiety użytkowników są tworzone przez użytkowników. Użytkownik może je modyfikować i usuwać. Można je stosować do dowolnych wiadomości lub wątków. Etykiety systemowe są tworzone wewnętrznie i nie można ich dodawać, modyfikować ani usuwać. W pewnych okolicznościach etykiety systemowe mogą być stosowane do wiadomości i wątków lub z nich usuwane, ale nie jest to gwarantowane. Użytkownicy mogą na przykład stosować etykiety INBOX i UNREAD do wiadomości i wątków oraz je usuwać, ale nie mogą stosować ani usuwać etykiet DRAFTS i SENT w wiadomościach i wątkach.

messagesTotal

integer

Łączna liczba wiadomości z daną etykietą.

messagesUnread

integer

Liczba nieprzeczytanych wiadomości z etykietą.

threadsTotal

integer

Łączna liczba wątków z etykietą.

threadsUnread

integer

Liczba nieprzeczytanych wątków z etykietą.

color

object (Color)

Kolor przypisany do etykiety. Kolor jest dostępny tylko w przypadku etykiet, których type ma wartość user.

MessageListVisibility

Wartości w polu enum
show Pokazuj etykietę na liście wiadomości.
hide Nie pokazuj etykiety na liście wiadomości.

LabelListVisibility

Wartości w polu enum
labelShow Pokaż etykietę na liście etykiet.
labelShowIfUnread Pokaż etykietę, jeśli istnieją nieprzeczytane wiadomości z nią związane.
labelHide Nie pokazuj etykiety na liście etykiet.

Typ

Wartości w polu enum
system Etykiety tworzone przez Gmaila.
user Etykiety własne utworzone przez użytkownika lub aplikację.

Kolor

Zapis JSON
{
  "textColor": string,
  "backgroundColor": string
}
Pola
textColor

string

Kolor tekstu etykiety wyrażony w postaci ciągu szesnastkowego. To pole jest wymagane do ustawienia koloru etykiety. #9ebade

backgroundColor

string

Kolor tła przedstawiony w postaci ciągu szesnastkowego #RRGGBB (np. #000000). To pole jest wymagane do ustawienia koloru etykiety. #9ebade

Metody

create

Tworzy nową etykietę.

delete

Natychmiast i trwale usuwa określoną etykietę oraz usuwa ją ze wszystkich wiadomości i wątków, do których została zastosowana.

get

Pobiera określoną etykietę.

list

Wyświetla listę wszystkich etykiet w skrzynce pocztowej użytkownika.

patch

Zastosuj poprawkę do określonej etykiety.

update

Aktualizuje określoną etykietę.