REST Resource: users.labels

Tài nguyên: Nhãn

Nhãn dùng để phân loại thư và chuỗi thư trong hộp thư của người dùng. Số lượng nhãn tối đa được hỗ trợ cho hộp thư của người dùng là 10.000.

Biểu diễn dưới dạng 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)
  }
}
Trường
id

string

Mã bất biến của nhãn.
name

string

Tên hiển thị của nhãn.
messageListVisibility

enum (MessageListVisibility)

Chế độ hiển thị của thư có nhãn này trong danh sách thư trên giao diện web Gmail.
labelListVisibility

enum (LabelListVisibility)

Chế độ hiển thị của nhãn trong danh sách nhãn trên giao diện web Gmail.
type

enum (Type)

Loại chủ sở hữu của nhãn. Nhãn người dùng do người dùng tạo và có thể được người dùng sửa đổi và xoá, đồng thời có thể áp dụng cho mọi thư hoặc chuỗi thư. Nhãn hệ thống được tạo nội bộ và không thể thêm, sửa đổi hoặc xoá. Trong một số trường hợp, bạn có thể áp dụng hoặc xoá nhãn hệ thống khỏi thư và chuỗi thư, nhưng không đảm bảo. Ví dụ: người dùng có thể áp dụng và xoá nhãn INBOX và UNREAD khỏi thư và chuỗi thư, nhưng không thể áp dụng hoặc xoá nhãn DRAFTS hoặc SENT khỏi thư hoặc chuỗi thư.
messagesTotal

integer

Tổng số thư có nhãn.
messagesUnread

integer

Số thư chưa đọc có nhãn.
threadsTotal

integer

Tổng số chuỗi thư có nhãn.
threadsUnread

integer

Số chuỗi thư chưa đọc có nhãn.
color

object (Color)

Màu để chỉ định cho nhãn. Màu chỉ có sẵn cho các nhãn có type được đặt thành user.

MessageListVisibility

Enum
show Hiện nhãn trong danh sách thư.
hide Không hiện nhãn trong danh sách thư.

LabelListVisibility

Enum
labelShow Hiện nhãn trong danh sách nhãn.
labelShowIfUnread Hiện nhãn nếu có thư chưa đọc có nhãn đó.
labelHide Không hiện nhãn trong danh sách nhãn.

Loại

Enum
system Nhãn do Gmail tạo.
user Nhãn tuỳ chỉnh do người dùng hoặc ứng dụng tạo.

Màu

Biểu diễn dưới dạng JSON 
{
  "textColor": string,
  "backgroundColor": string
}
Trường
textColor

string

Màu văn bản của nhãn, được biểu thị dưới dạng chuỗi thập lục phân. Bạn phải có trường này để đặt màu cho nhãn. Bạn chỉ được sử dụng tập hợp giá trị màu được xác định trước sau đây:
#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

Màu nền được biểu thị dưới dạng chuỗi thập lục phân #RRGGBB (ví dụ: #000000). Bạn phải có trường này để đặt màu cho nhãn. Bạn chỉ được sử dụng tập hợp giá trị màu được xác định trước sau đây:
#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

Phương thức

create

 Tạo nhãn.

delete

 Xoá ngay lập tức và vĩnh viễn nhãn đã chỉ định, đồng thời xoá nhãn đó khỏi mọi thư và chuỗi thư mà nhãn đó được áp dụng.

get

 Lấy nhãn đã chỉ định.

list

 Liệt kê tất cả nhãn trong hộp thư của người dùng.

patch

 Sửa đổi nhãn đã chỉ định.

update

 Cập nhật nhãn đã chỉ định.