REST Resource: users.labels

Resource: Label

Label digunakan untuk mengategorikan pesan dan rangkaian pesan dalam kotak surat pengguna. Jumlah label maksimum yang didukung untuk kotak surat 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 dan dapat diterapkan ke pesan atau rangkaian pesan. Label sistem dibuat secara internal dan tidak dapat ditambahkan, diubah, atau dihapus. Dalam beberapa situasi, label sistem mungkin dapat diterapkan atau dihapus dari pesan dan rangkaian pesan, 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 yang diberi label.
messagesUnread

integer

Jumlah pesan yang belum dibaca dengan label.
threadsTotal

integer

Jumlah total rangkaian pesan yang memiliki 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 di dalam daftar label.

Jenis

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

Warna

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

string

Warna teks label, direpresentasikan sebagai string heksadesimal. Kolom ini wajib diisi untuk menetapkan warna label. Hanya set nilai warna yang telah ditetapkan berikut yang diperbolehkan berikut yang diperbolehkan:
#0000000, #434343, #6666666, #9999999, #6666666, #9999999, #6666666, #99999999, #ccc, #efefefef, #f3f3f3f3, #, #, atau set nilai warna yang telah ditetapkan sebelumnya yang diperbolehkan::
#0000000, #434343, #6666666, #99999999, #6666666, #99999999, #ccc, #efefefef, #f3f3f3f3,.
backgroundColor

string

Warna latar belakang direpresentasikan sebagai string heksadesimal #RRGGBB (mis. #000000). Kolom ini wajib diisi untuk menetapkan warna label. Hanya set nilai warna yang telah ditetapkan berikut yang diperbolehkan berikut yang diperbolehkan:
#0000000, #434343, #6666666, #9999999, #6666666, #9999999, #6666666, #99999999, #ccc, #efefefef, #f3f3f3f3, #, #, atau set nilai warna yang telah ditetapkan sebelumnya yang diperbolehkan::
#0000000, #434343, #6666666, #99999999, #6666666, #99999999, #ccc, #efefefef, #f3f3f3f3,.

Metode

create

 Membuat label baru.

delete

 Menghapus label yang ditentukan dengan cepat dan permanen serta menghapusnya dari semua pesan dan rangkaian pesan tempat label tersebut diterapkan.

get

 Mendapatkan label yang ditentukan.

list

 Mencantumkan semua label di kotak surat pengguna.

patch

 Menambahkan patch pada label yang ditentukan.

update

 Memperbarui label yang ditentukan.