REST Resource: users.labels

Zasób: etykieta

Etykiety służą do kategoryzowania wiadomości i wątków w skrzynce pocztowej użytkownika. Maksymalna liczba etykiet obsługiwanych dla skrzynki 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żytkownika są tworzone przez użytkownika i mogą być przez niego modyfikowane oraz usuwane. Można je stosować 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 można stosować do wiadomości i wątków lub z nich usuwać, ale nie jest to gwarantowane. Na przykład użytkownicy mogą stosować etykiety INBOX i UNREAD do wiadomości i wątków oraz je z nich usuwać, ale nie mogą stosować ani usuwać etykiet DRAFTS i SENT z wiadomości lub wątków.
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 przypisany do etykiety. Kolor jest dostępny tylko w przypadku etykiet, których atrybut type ma wartość user.

MessageListVisibility

Wartości w polu enum
show Pokazuj etykietę na liście wiadomości.
hide Uniemożliwia wyświetlanie 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 tą etykietą.
labelHide Uniemożliwia wyświetlanie etykiety na liście etykiet.

Typ

Wartości w polu enum
system Etykiety utworzone 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 jako ciąg szesnastkowy. To pole jest wymagane do ustawienia koloru etykiety. : :
#00000000, #434343, #00000000, #434343, #66666666, #9999999, #6666666, #9999999, #cccccccc, #9999999, #cccccccc, #efefef, #f3f3f3f3f3, # danej wartości.
backgroundColor

string

Kolor tła jako ciąg szesnastkowy #RRGGBB (np. #000000). To pole jest wymagane do ustawienia koloru etykiety. : :
#00000000, #434343, #00000000, #434343, #66666666, #9999999, #6666666, #9999999, #cccccccc, #9999999, #cccccccc, #efefef, #f3f3f3f3f3, # danej wartości.

Metody

create

 Tworzy nową etykietę.

delete

 Natychmiastowo i trwale usuwa określoną etykietę oraz usuwa ją ze wszystkich wiadomości i wątków, do których jest stosowana.

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ę.