REST Resource: users.labels

Resource: Label

Label digunakan untuk mengategorikan pesan dan rangkaian pesan dalam kotak surat pengguna. Jumlah maksimum label yang didukung untuk kotak masuk pengguna adalah 10.000.

Representasi 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)
  }
}
Kolom
id

string

ID label yang tidak dapat diubah.
name

string

Nama tampilan label.
messageListVisibility

enum (MessageListVisibility)

Visibilitas pesan dengan label ini dalam daftar pesan di antarmuka web Gmail.
labelListVisibility

enum (LabelListVisibility)

Visibilitas label dalam daftar label di antarmuka web Gmail.
type

enum (Type)

Jenis pemilik untuk label. Label pengguna dibuat oleh pengguna dan dapat diubah serta dihapus oleh pengguna, serta dapat diterapkan ke pesan atau rangkaian pesan apa pun. Label sistem dibuat secara internal dan tidak dapat ditambahkan, diubah, atau dihapus. Label sistem dapat diterapkan ke atau dihapus dari pesan dan rangkaian pesan dalam beberapa keadaan, tetapi hal ini tidak dijamin. Misalnya, pengguna dapat menerapkan dan menghapus label INBOX dan UNREAD dari pesan dan rangkaian pesan, tetapi tidak dapat menerapkan atau menghapus label DRAFTS atau SENT dari pesan atau rangkaian pesan.
messagesTotal

integer

Jumlah total pesan dengan label.
messagesUnread

integer

Jumlah pesan yang belum dibaca dengan label.
threadsTotal

integer

Jumlah total rangkaian pesan dengan label.
threadsUnread

integer

Jumlah rangkaian pesan yang belum dibaca dengan label.
color

object (Color)

Warna yang akan ditetapkan ke label. Warna hanya tersedia untuk label yang type-nya ditetapkan ke user.

MessageListVisibility

Enum
show Menampilkan label dalam daftar pesan.
hide Jangan tampilkan label dalam daftar pesan.

LabelListVisibility

Enum
labelShow Tampilkan label dalam daftar label.
labelShowIfUnread Tampilkan label jika ada pesan yang belum dibaca dengan label tersebut.
labelHide Jangan tampilkan label dalam daftar label.

Jenis

Enum
system Label yang dibuat oleh Gmail.
user Label kustom yang dibuat oleh pengguna atau aplikasi.

Warna

Representasi JSON 
{
  "textColor": string,
  "backgroundColor": string
}
Kolom
textColor

string

Warna teks label, ditampilkan sebagai string heksadesimal. Kolom ini wajib diisi untuk menyetel warna label. Hanya kumpulan nilai warna yang telah ditentukan sebelumnya berikut yang diizinkan:
#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, #464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff, #711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5, #594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1, #c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46, #662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765
backgroundColor

string

Warna latar belakang ditampilkan sebagai string hex #RRGGBB (mis. #000000). Kolom ini wajib diisi untuk menyetel warna label. Hanya kumpulan nilai warna yang telah ditentukan sebelumnya berikut yang diizinkan:
#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, #464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff, #711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5, #594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1, #c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46, #662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765

Metode

create

 Membuat label baru.

delete

 Segera dan secara permanen menghapus label yang ditentukan serta menghapusnya dari semua pesan dan rangkaian pesan yang menerapkan label tersebut.

get

 Mendapatkan label yang ditentukan.

list

 Mencantumkan semua label di kotak surat pengguna.

patch

 Membuat patch pada label yang ditentukan.

update

 Memperbarui label yang ditentukan.