REST Resource: users.labels

Tài nguyên: Nhãn

Nhãn được dùng để phân loại thư và chuỗi 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)
  }
}
Các trường
id

string

Mã nhận dạng không thể thay đổi 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ư trong giao diện web của Gmail.

labelListVisibility

enum (LabelListVisibility)

Chế độ hiển thị của nhãn trong danh sách nhãn trong 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 là do người dùng tạo. Người dùng có thể sửa đổi và xoá nhãn này. Nhãn này 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 xóa. 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. Ví dụ: người dùng có thể áp dụng và xoá các nhãn INBOXUNREAD 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 thư có nhãn.

threadsUnread

integer

Số lượng chuỗi tin nhắn chưa đọc có nhãn.

color

object (Color)

Màu cần chỉ định cho nhãn. Màu chỉ dành 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 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
}
Các trường
textColor

string

Màu văn bản của nhãn, được biểu thị dưới dạng chuỗi hex. Trường này là bắt buộc để đặt màu 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 nhãn.

Phương thức

create

Tạo nhãn mới.

delete

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

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

Dán nhãn đã chỉ định.

update

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