REST Resource: users.labels

Tài nguyên: Nhãn

Nhãn được 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ã nhận dạng 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 các thư có nhãn này trong danh sách thư trên giao diện web của Gmail.
labelListVisibility

enum (LabelListVisibility)

Chế độ hiển thị của nhãn trong danh sách nhãn trên giao diện web của 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, đồng thời có thể được người dùng sửa đổi và xoá, đồng thời có thể áp dụng cho bất kỳ thư hoặc chuỗi nào. Các nhãn hệ thống được tạo nội bộ và không thể thêm, sửa đổi hoặc xoá. Bạn có thể áp dụng hoặc xoá nhãn hệ thống khỏi thư và chuỗi thư trong một số trường hợp, nhưng điều này không được đảm bảo chắc chắn. Ví dụ: người dùng có thể áp dụng và xoá các nhãn INBOX và UNREAD khỏi thư và chuỗi thư, nhưng không thể áp dụng hoặc xoá các 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 có nhãn.
threadsUnread

integer

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

object (Color)

Màu cần chỉ định cho nhãn. Màu chỉ áp dụng cho các nhãn đã đặt type thành user.

MessageListVisibility

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

LabelListVisibility

Enum
labelShow Hiển thị nhãn trong danh sách nhãn.
labelShowIfUnread Hiện nhãn nếu có bất kỳ thư chưa đọc nào được gắn nhãn đó.
labelHide Không hiển thị 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 thể hiện dưới dạng chuỗi hex. Trường này là bắt buộc để đặt màu cho nhãn.

backgroundColor

string

Màu nền được biểu thị dưới dạng chuỗi hex #RRGGBB (ví dụ: #000000). Trường này là bắt buộc để đặt màu cho nhãn.

Phương thức

create

 Tạo một nhãn mới.

delete

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

get

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

list

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

patch

 Vá nhãn được chỉ định.

update

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