Label

Một nhãn.

Biểu diễn dưới dạng JSON
{
  "resourceName": string,
  "status": enum (LabelStatus),
  "textLabel": {
    object (TextLabel)
  },
  "id": string,
  "name": string
}
Trường
resourceName

string

Không thể thay đổi. Tên tài nguyên. Tên tài nguyên nhãn có dạng: customers/{customerId}/labels/{label_id}

status

enum (LabelStatus)

Chỉ có đầu ra. Trạng thái của nhãn. Chỉ có thể đọc.

textLabel

object (TextLabel)

Một loại nhãn hiển thị văn bản trên nền màu.

id

string (int64 format)

Chỉ có đầu ra. Mã nhận dạng của nhãn. Chỉ có thể đọc.

name

string

Tên của nhãn.

Đây là trường bắt buộc và không được để trống khi tạo nhãn mới.

Độ dài của chuỗi này phải nằm trong khoảng từ 1 đến 80.

LabelStatus

Các trạng thái có thể có của một nhãn.

Enum
UNSPECIFIED Chưa chỉ định.
UNKNOWN Chỉ dùng cho giá trị trả về. Biểu thị giá trị không xác định trong phiên bản này.
ENABLED Nhãn đang bật.
REMOVED Đã xóa nhãn.

TextLabel

Một loại nhãn hiển thị văn bản trên nền có màu.

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

string

Màu nền của nhãn ở định dạng HEX. Chuỗi này phải khớp với biểu thức chính quy '^#([a-fA-F0-9]{6}|[a-fA-F0-9]{3})$'. Lưu ý: Màu nền có thể không hiển thị đối với tài khoản người quản lý.

description

string

Mô tả ngắn về nhãn. Độ dài không được vượt quá 200 ký tự.