REST Resource: users.labels

Kaynak: Etiket

Etiketler, kullanıcının posta kutusundaki iletileri ve ileti dizilerini kategorilere ayırmak için kullanılır. Bir kullanıcının posta kutusunda en fazla 10.000 etiket desteklenir.

JSON gösterimi
{
  "id": string,
  "name": string,
  "messageListVisibility": enum (MessageListVisibility),
  "labelListVisibility": enum (LabelListVisibility),
  "type": enum (Type),
  "messagesTotal": integer,
  "messagesUnread": integer,
  "threadsTotal": integer,
  "threadsUnread": integer,
  "color": {
    object (Color)
  }
}
Alanlar
id

string

Etiketin sabit kimliğidir.

name

string

Etiketin görünen adı.

messageListVisibility

enum (MessageListVisibility)

Gmail web arayüzündeki ileti listesinde bu etikete sahip iletilerin görünürlüğü.

labelListVisibility

enum (LabelListVisibility)

Gmail web arayüzündeki etiket listesindeki etiketin görünürlüğü.

type

enum (Type)

Etiketin sahip türü. Kullanıcı etiketleri kullanıcı tarafından oluşturulur, kullanıcı tarafından değiştirilebilir, silinebilir ve herhangi bir iletiye veya ileti dizisine uygulanabilir. Sistem etiketleri dahili olarak oluşturulur ve eklenemez, değiştirilemez veya silinemez. Bazı durumlarda sistem etiketleri, iletilere ve ileti dizilerine uygulanabilir veya bu etiketlerden kaldırılabilir ancak bu garanti edilmez. Örneğin, kullanıcılar iletilere ve ileti dizilerine INBOX ve UNREAD etiketlerini uygulayabilir ve kaldırabilir, ancak iletilere veya ileti dizilerine DRAFTS ya da SENT etiketlerini uygulayamaz veya bunları kaldıramaz.

messagesTotal

integer

Etikete sahip iletilerin toplam sayısı.

messagesUnread

integer

Etikete sahip okunmamış iletilerin sayısı.

threadsTotal

integer

Etikete sahip toplam ileti dizisi sayısı.

threadsUnread

integer

Etikete sahip okunmamış ileti dizilerinin sayısı.

color

object (Color)

Etikete atanacak renk. Renk yalnızca type özelliği user olarak ayarlanmış etiketler için kullanılabilir.

MessageListVisibility

Sıralamalar
show Etiketi ileti listesinde gösterin.
hide Etiketi ileti listesinde gösterme.

LabelListVisibility

Sıralamalar
labelShow Etiketi etiket listesinde göster.
labelShowIfUnread Bu etikete sahip okunmamış iletiler varsa etiketi gösterir.
labelHide Etiketi etiket listesinde gösterme.

Tür

Sıralamalar
system Etiketler Gmail tarafından oluşturulur.
user Kullanıcı veya uygulama tarafından oluşturulan özel etiketler.

Renk

JSON gösterimi
{
  "textColor": string,
  "backgroundColor": string
}
Alanlar
textColor

string

Etiketin, onaltılık dize olarak gösterilen metin rengi. Bu alan, etiketin rengini ayarlamak için gereklidir.

backgroundColor

string

Onaltılık dize #RRGGBB olarak gösterilen arka plan rengi (ör. #000000). Bu alan, etiketin rengini ayarlamak için gereklidir.

Yöntemler

create

Yeni bir etiket oluşturur.

delete

Belirtilen etiketi hemen ve kalıcı olarak siler ve uygulandığı tüm iletilerden ve ileti dizilerinden kaldırır.

get

Belirtilen etiketi alır.

list

Kullanıcının posta kutusundaki tüm etiketleri listeler.

patch

Belirtilen etikete yama uygulayın.

update

Belirtilen etiketi günceller.