REST Resource: users.labels

Zasób: Label

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

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

Niezmienny 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żytkownika są tworzone przez użytkownika, mogą być przez niego modyfikowane i usuwane oraz mogą być stosowane do dowolnej wiadomości lub wątku. Etykiety systemowe są tworzone wewnętrznie i nie można ich dodawać, modyfikować ani usuwać. W pewnych okolicznościach etykiety systemowe mogą zostać dodane do wiadomości i wątków lub usunięte z nich, ale nie jest to gwarantowane. Użytkownicy mogą na przykład stosować i usuwać etykiety INBOX i UNREAD z wiadomości i wątków, ale nie mogą stosować ani usuwać etykiet DRAFTS ani SENT.
messagesTotal

integer

Łączna liczba wiadomości z 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 do przypisania do etykiety. Kolor jest dostępny tylko w przypadku etykiet, dla których wartość parametru type to user.

MessageListVisibility

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

LabelListVisibility

Wartości w polu enum
labelShow wyświetlać etykietę na liście etykiet.
labelShowIfUnread wyświetlać etykietę, jeśli są nieprzeczytane wiadomości z tą etykietą;
labelHide Nie wyświetlaj etykiety na liście etykiet.

Typ

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

Kolor

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

string

Kolor tekstu etykiety, podany jako ciąg szesnastkowy. To pole jest wymagane, aby ustawić kolor etykiety. Dozwolony jest tylko ten wstępnie zdefiniowany zestaw wartości kolorów:
#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
backgroundColor

string

Kolor tła w formacie szesnastkowym #RRGGBB (np. #000000). To pole jest wymagane, aby ustawić kolor etykiety. Dozwolony jest tylko ten wstępnie zdefiniowany zestaw wartości kolorów:
#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

Metody

create

 Tworzy nową etykietę.

delete

 Natychmiast i na stałe 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 wszystkie etykiety w skrzynce pocztowej użytkownika.

patch

 Wprowadź poprawki w wybranej etykiecie.

update

 Aktualizuje określoną etykietę.