REST Resource: labels

Tài nguyên: Nhãn

Nhãn xác định cách phân loại có thể áp dụng cho các mục trên Drive để sắp xếp và tìm kiếm trên các mục. Nhãn có thể là các chuỗi đơn giản hoặc có thể chứa các trường mô tả siêu dữ liệu bổ sung có thể được dùng thêm để sắp xếp và tìm kiếm các mục trên Drive.

Biểu diễn dưới dạng JSON 
{
  "name": string,
  "id": string,
  "revisionId": string,
  "labelType": enum (LabelType),
  "creator": {
    object (UserInfo)
  },
  "createTime": string,
  "revisionCreator": {
    object (UserInfo)
  },
  "revisionCreateTime": string,
  "publisher": {
    object (UserInfo)
  },
  "publishTime": string,
  "disabler": {
    object (UserInfo)
  },
  "disableTime": string,
  "customer": string,
  "properties": {
    object (Properties)
  },
  "lifecycle": {
    object (Lifecycle)
  },
  "displayHints": {
    object (DisplayHints)
  },
  "appliedCapabilities": {
    object (AppliedCapabilities)
  },
  "schemaCapabilities": {
    object (SchemaCapabilities)
  },
  "appliedLabelPolicy": {
    object (AppliedLabelPolicy)
  },
  "fields": [
    {
      object (Field)
    }
  ],
  "learnMoreUri": string,
  "lockStatus": {
    object (LockStatus)
  }
}
Trường
name

string

Chỉ có đầu ra. Tên tài nguyên của nhãn. Sẽ có dạng: labels/{id} hoặc labels/{id}@{revisionId}, tuỳ thuộc vào yêu cầu. Xem id và revisionId bên dưới.
id

string

Chỉ có đầu ra. Giá trị nhận dạng riêng biệt trên toàn cầu của nhãn này. Mã nhận dạng chiếm một phần của nhãn name, nhưng không giống như name, mã nhận dạng không nhất quán giữa các bản sửa đổi. Khớp với biểu thức chính quy: ([a-zA-Z0-9])+
revisionId

string

Chỉ có đầu ra. Mã bản sửa đổi của nhãn. Mã bản sửa đổi có thể thuộc nhãn name, tuỳ thuộc vào yêu cầu được đưa ra. Một bản sửa đổi mới được tạo bất cứ khi nào thuộc tính được sửa đổi của một nhãn có sự thay đổi. Khớp với biểu thức chính quy: ([a-zA-Z0-9])+
labelType

enum (LabelType)

Bắt buộc. Loại nhãn.
creator

object (UserInfo)

Chỉ có đầu ra. Người dùng đã tạo nhãn này.
createTime

string (Timestamp format)

Chỉ có đầu ra. Thời gian tạo nhãn này.
revisionCreator

object (UserInfo)

Chỉ có đầu ra. Người dùng đã tạo bản sửa đổi nhãn này.
revisionCreateTime

string (Timestamp format)

Chỉ có đầu ra. Thời gian tạo bản sửa đổi nhãn này.
publisher

object (UserInfo)

Chỉ có đầu ra. Người dùng đã xuất bản nhãn này. Giá trị này không có ý nghĩa khi nhãn chưa được xuất bản.
publishTime

string (Timestamp format)

Chỉ có đầu ra. Thời gian xuất bản nhãn này. Giá trị này không có ý nghĩa khi nhãn chưa được xuất bản.
disabler

object (UserInfo)

Chỉ có đầu ra. Người dùng đã vô hiệu hoá nhãn này. Giá trị này không có ý nghĩa khi nhãn không bị tắt.
disableTime

string (Timestamp format)

Chỉ có đầu ra. Thời gian nhãn này bị vô hiệu hoá. Giá trị này không có ý nghĩa khi nhãn không bị tắt.
customer

string

Chỉ có đầu ra. Khách hàng sở hữu nhãn này. Ví dụ: "customer/123abc789".
properties

object (Properties)

Bắt buộc. Các thuộc tính cơ bản của nhãn.
lifecycle

object (Lifecycle)

Chỉ có đầu ra. Trạng thái vòng đời của nhãn, bao gồm cả việc nhãn đã được xuất bản, không được dùng nữa và có các thay đổi ở bản nháp hay không.
displayHints

object (DisplayHints)

Chỉ có đầu ra. Gợi ý cho thấy giao diện người dùng để hiển thị nhãn.
appliedCapabilities

object (AppliedCapabilities)

Chỉ có đầu ra. Các tính năng liên quan đến nhãn này trên siêu dữ liệu được áp dụng.
schemaCapabilities

object (SchemaCapabilities)

Chỉ có đầu ra. Các khả năng mà người dùng có trên nhãn này.
appliedLabelPolicy

object (AppliedLabelPolicy)

Chỉ có đầu ra. Hành vi của nhãn này khi áp dụng cho các mục trên Drive.
fields[]

object (Field)

Danh sách các trường theo thứ tự ưu tiên giảm dần.
learnMoreUri

string

URL tuỳ chỉnh sẽ hiển thị cho người dùng nhằm giúp họ tìm hiểu thêm về nhãn này và cách sử dụng nhãn.
lockStatus

object (LockStatus)

Chỉ có đầu ra. LockStatus của nhãn này.

LabelType

Loại nhãn này.

Enum
LABEL_TYPE_UNSPECIFIED Loại nhãn không xác định.
SHARED Nhãn được chia sẻ có thể được chia sẻ với người dùng để áp dụng cho các mục trên Drive.
ADMIN Nhãn do quản trị viên sở hữu. Chỉ quản trị viên mới có thể tạo và chỉnh sửa. Hỗ trợ một số tính năng khác chỉ dành cho quản trị viên.

UserInfo

Thông tin về người dùng.

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

string

Giá trị nhận dạng cho người dùng này có thể được sử dụng với API Mọi người để nhận thêm thông tin. Ví dụ: người/12345678.

Thuộc tính

Các thuộc tính cơ bản của nhãn.

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

string

Bắt buộc. Tiêu đề của nhãn.
description

string

Nội dung mô tả về nhãn.

Vòng đời

Trạng thái vòng đời của một đối tượng, chẳng hạn như nhãn, trường hoặc lựa chọn. Vòng đời thực thi các quá trình chuyển đổi sau:

  • UNPUBLISHED_DRAFT (trạng thái bắt đầu)
  • UNPUBLISHED_DRAFT -> PUBLISHED
  • UNPUBLISHED_DRAFT -> (Đã xóa)
  • PUBLISHED -> DISABLED
  • DISABLED -> PUBLISHED
  • DISABLED -> (Đã xóa)

Các trạng thái đã xuất bản và bị vô hiệu hoá có một số đặc điểm riêng biệt:

  • Đã xuất bản – Một số loại thay đổi có thể được thực hiện đối với đối tượng ở trạng thái này, trong trường hợp đó, hasUnpublishedChanges sẽ là giá trị true. Ngoài ra, một số loại thay đổi không được phép. Nhìn chung, mọi thay đổi làm mất hiệu lực hoặc gây ra các quy định hạn chế mới đối với siêu dữ liệu hiện có liên quan đến nhãn đều sẽ bị từ chối.
  • Tắt – Khi tắt, DisabledPolicy đã định cấu hình sẽ có hiệu lực.
Biểu diễn dưới dạng JSON 
{
  "state": enum (State),
  "hasUnpublishedChanges": boolean,
  "disabledPolicy": {
    object (DisabledPolicy)
  }
}
Trường
state

enum (State)

Chỉ có đầu ra. Trạng thái của đối tượng liên kết với vòng đời này.
hasUnpublishedChanges

boolean

Chỉ có đầu ra. Liệu đối tượng liên kết với vòng đời này có các thay đổi chưa xuất bản hay không.
disabledPolicy

object (DisabledPolicy)

Chính sách này quy định cách hiển thị một nhãn, trường hoặc lựa chọn đã bị vô hiệu hoá.

Tiểu bang

Trạng thái của đối tượng liên kết với vòng đời này.

Enum
STATE_UNSPECIFIED Trạng thái không xác định.
UNPUBLISHED_DRAFT Trạng thái ban đầu của một đối tượng. Sau khi xuất bản, đối tượng sẽ không bao giờ quay lại trạng thái này. Sau khi xuất bản một đối tượng, bạn không được thực hiện một số loại thay đổi nhất định nữa.
PUBLISHED Đối tượng này đã được xuất bản. Đối tượng này có thể có các thay đổi chưa xuất bản về bản nháp được chỉ định bởi hasUnpublishedChanges.
DISABLED Đối tượng này đã được xuất bản và sau đó đã bị vô hiệu hoá. Đối tượng này có thể có các thay đổi chưa xuất bản về bản nháp được chỉ định bởi hasUnpublishedChanges.
DELETED Đối tượng này đã bị xoá.

DisabledPolicy

Chính sách này quy định cách xử lý một lựa chọn về nhãn, trường hoặc lựa chọn bị vô hiệu hoá trong nhiều ngữ cảnh.

Biểu diễn dưới dạng JSON 
{
  "hideInSearch": boolean,
  "showInApply": boolean
}
Trường
showInApply

boolean

Liệu có hiển thị đối tượng bị vô hiệu hoá này trong trình đơn áp dụng trên các mục trên Drive hay không.

  • Khi true, đối tượng thường hiển thị trong giao diện người dùng dưới dạng bị tắt và không thể bỏ chọn.
  • Khi false, đối tượng thường bị ẩn trong giao diện người dùng.

DisplayHints

Gợi ý cho thấy giao diện người dùng để hiển thị nhãn.

Biểu diễn dưới dạng JSON 
{
  "disabled": boolean,
  "hiddenInSearch": boolean,
  "shownInApply": boolean,
  "priority": string
}
Trường
disabled

boolean

Liệu nhãn có hiển thị trong giao diện người dùng ở trạng thái tắt hay không.
shownInApply

boolean

Nhãn này sẽ hiển thị trong trình đơn áp dụng khi áp dụng các giá trị cho một mục trên Drive.
priority

string (int64 format)

Thứ tự hiển thị nhãn trong danh sách.

AppliedCapabilities

Những chức năng mà người dùng có trên siêu dữ liệu áp dụng của nhãn này.

Biểu diễn dưới dạng JSON 
{
  "canRead": boolean,
  "canApply": boolean,
  "canRemove": boolean
}
Trường
canRead

boolean

Liệu người dùng có thể đọc siêu dữ liệu áp dụng liên quan đến nhãn này hay không.
canApply

boolean

Liệu người dùng có thể áp dụng nhãn này cho các mục hay không.
canRemove

boolean

Liệu người dùng có thể xoá nhãn này khỏi các mục hay không.

SchemaCapabilities

Các tính năng liên quan đến nhãn này khi chỉnh sửa nhãn.

Biểu diễn dưới dạng JSON 
{
  "canUpdate": boolean,
  "canDelete": boolean,
  "canDisable": boolean,
  "canEnable": boolean
}
Trường
canUpdate

boolean

Liệu người dùng có thể thay đổi nhãn này hay không.
canDelete

boolean

Liệu người dùng có thể xoá nhãn này hay không. Người dùng phải có quyền và nhãn phải được tắt.
canDisable

boolean

Liệu người dùng có thể tắt nhãn này hay không. Người dùng phải có quyền và nhãn này phải chưa bị tắt.
canEnable

boolean

Liệu người dùng có thể bật nhãn này hay không. Người dùng phải có quyền và phải tắt nhãn này.

AppliedLabelPolicy

Hành vi của nhãn này khi áp dụng cho các mục trên Drive.

Biểu diễn dưới dạng JSON 
{
  "copyMode": enum (CopyMode)
}
Trường
copyMode

enum (CopyMode)

Cho biết cách sao chép các giá trị trường và nhãn áp dụng khi sao chép một mục trên Drive.

CopyMode

Cho biết cách sao chép các giá trị trường và nhãn áp dụng khi sao chép một mục trên Drive.

Enum
COPY_MODE_UNSPECIFIED Chưa chỉ định chế độ sao chép.
DO_NOT_COPY Theo mặc định, các giá trị trường và nhãn được áp dụng không được sao chép khi mục trên Drive được áp dụng các giá trị đó được sao chép.
ALWAYS_COPY Các giá trị trường và nhãn được áp dụng luôn được sao chép khi mục trên Drive được áp dụng các giá trị đó được sao chép. Chỉ quản trị viên mới có thể dùng chế độ này.
COPY_APPLIABLE Các giá trị nhãn và trường áp dụng sẽ được sao chép nếu người dùng tạo bản sao có thể áp dụng nhãn.

Trường

Xác định một trường có tên hiển thị, loại dữ liệu và các lựa chọn cấu hình khác. Trường này xác định loại siêu dữ liệu có thể được đặt cho mục trên Drive.

Biểu diễn dưới dạng JSON 
{
  "id": string,
  "queryKey": string,
  "properties": {
    object (Properties)
  },
  "lifecycle": {
    object (Lifecycle)
  },
  "displayHints": {
    object (DisplayHints)
  },
  "schemaCapabilities": {
    object (SchemaCapabilities)
  },
  "appliedCapabilities": {
    object (AppliedCapabilities)
  },
  "creator": {
    object (UserInfo)
  },
  "createTime": string,
  "updater": {
    object (UserInfo)
  },
  "updateTime": string,
  "publisher": {
    object (UserInfo)
  },
  "disabler": {
    object (UserInfo)
  },
  "disableTime": string,
  "lockStatus": {
    object (LockStatus)
  },

  // Union field type can be only one of the following:
  "textOptions": {
    object (TextOptions)
  },
  "integerOptions": {
    object (IntegerOptions)
  },
  "dateOptions": {
    object (DateOptions)
  },
  "selectionOptions": {
    object (SelectionOptions)
  },
  "userOptions": {
    object (UserOptions)
  }
  // End of list of possible types for union field type.
}
Trường
id

string

Chỉ có đầu ra. Khoá của một trường, duy nhất trong nhãn hoặc thư viện.

Giá trị này được tạo tự động. Khớp với biểu thức chính quy: ([a-zA-Z0-9])+
queryKey

string

Chỉ có đầu ra. Khoá sử dụng khi tạo truy vấn tìm kiếm trên Drive để tìm tệp dựa trên các giá trị được xác định cho trường này trên tệp. Ví dụ: "{queryKey} > 01-01-2001".
properties

object (Properties)

Các thuộc tính cơ bản của trường.
lifecycle

object (Lifecycle)

Chỉ có đầu ra. Vòng đời của trường này.
displayHints

object (DisplayHints)

Chỉ có đầu ra. Gợi ý hiển thị giao diện người dùng để kết xuất một trường.
schemaCapabilities

object (SchemaCapabilities)

Chỉ có đầu ra. Các khả năng mà người dùng này có khi chỉnh sửa trường này.
appliedCapabilities

object (AppliedCapabilities)

Chỉ có đầu ra. Các khả năng mà người dùng này có trên trường này và giá trị của trường khi nhãn được áp dụng cho các mục trên Drive.
creator

object (UserInfo)

Chỉ có đầu ra. Người dùng đã tạo trường này.
createTime

string (Timestamp format)

Chỉ có đầu ra. Thời điểm trường này được tạo.
updater

object (UserInfo)

Chỉ có đầu ra. Người dùng đã sửa đổi trường này.
updateTime

string (Timestamp format)

Chỉ có đầu ra. Thời gian cập nhật trường này.
publisher

object (UserInfo)

Chỉ có đầu ra. Người dùng đã xuất bản trường này. Giá trị này không có ý nghĩa khi trường không được xuất bản.
disabler

object (UserInfo)

Chỉ có đầu ra. Người dùng đã vô hiệu hoá trường này. Giá trị này không có ý nghĩa khi trường không bị tắt.
disableTime

string (Timestamp format)

Chỉ có đầu ra. Thời gian trường này bị vô hiệu hoá. Giá trị này không có ý nghĩa khi trường không bị tắt.
lockStatus

object (LockStatus)

Chỉ có đầu ra. LockStatus của trường này.
Trường kết hợp type. Loại dữ liệu và các lựa chọn của trường này. Sau khi xuất bản, bạn sẽ không thể thay đổi loại dữ liệu. type chỉ có thể là một trong những trạng thái sau đây:
textOptions

object (TextOptions)

Tuỳ chọn trường văn bản.
integerOptions

object (IntegerOptions)

Tuỳ chọn trường số nguyên.
dateOptions

object (DateOptions)

Tuỳ chọn trường ngày.
selectionOptions

object (SelectionOptions)

Các tuỳ chọn cho trường lựa chọn.
userOptions

object (UserOptions)

Tuỳ chọn trường người dùng.

TextOptions

Các tuỳ chọn cho loại trường Văn bản.

Biểu diễn dưới dạng JSON 
{
  "minLength": integer,
  "maxLength": integer
}
Trường
minLength

integer

Chỉ có đầu ra. Độ dài hợp lệ tối thiểu của các giá trị cho trường văn bản.
maxLength

integer

Chỉ có đầu ra. Độ dài hợp lệ tối đa của các giá trị cho trường văn bản.

IntegerOptions

Các tuỳ chọn cho loại trường Integer (Số nguyên).

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

string (int64 format)

Chỉ có đầu ra. Giá trị hợp lệ nhỏ nhất cho trường số nguyên.
maxValue

string (int64 format)

Chỉ có đầu ra. Giá trị hợp lệ lớn nhất cho trường số nguyên.

DateOptions

Các lựa chọn cho loại trường ngày.

Biểu diễn dưới dạng JSON 
{
  "dateFormatType": enum (DateFormat),
  "dateFormat": string,
  "minValue": {
    object (Date)
  },
  "maxValue": {
    object (Date)
  }
}
Trường
dateFormatType

enum (DateFormat)

Tuỳ chọn định dạng ngày đã bản địa hoá. Các giá trị của trường được hiển thị ở định dạng này theo ngôn ngữ của các giá trị đó.
dateFormat

string

Chỉ có đầu ra. Định dạng ngày trong ICU.
minValue

object (Date)

Chỉ có đầu ra. Giá trị hợp lệ tối thiểu (năm, tháng, ngày).
maxValue

object (Date)

Chỉ có đầu ra. Giá trị hợp lệ tối đa (năm, tháng, ngày).

DateFormat

Tùy chọn định dạng ngày được bản địa hóa.

Enum
DATE_FORMAT_UNSPECIFIED Chưa xác định định dạng ngày.
LONG_DATE Bao gồm tên đầy đủ của tháng. Ví dụ: ngày 12 tháng 1 năm 1999 (MMMM d, y)
SHORT_DATE Ngắn, dạng số, biểu thị. Ví dụ: 12/13/99 (M/d/yy)

Ngày

Đại diện cho toàn bộ hoặc một phần ngày theo lịch, chẳng hạn như ngày sinh nhật. Thời gian trong ngày và múi giờ được chỉ định ở nơi khác hoặc không đáng kể. Ngày này có liên quan đến Lịch Gregory. Thông tin này có thể là một trong những trường hợp sau:

  • Ngày đầy đủ, với các giá trị năm, tháng và ngày khác 0.
  • Tháng và ngày, thể hiện giá trị năm 0 (ví dụ: ngày kỷ niệm).
  • Một năm riêng biệt, tháng không tháng và ngày không tháng.
  • Năm và tháng, không có ngày (ví dụ: ngày hết hạn thẻ tín dụng).

Các loại có liên quan:

Biểu diễn dưới dạng JSON 
{
  "year": integer,
  "month": integer,
  "day": integer
}
Trường
year

integer

Năm của ngày. Giá trị phải từ 1 đến 9999 hoặc bằng 0 để chỉ định ngày không có năm.
month

integer

Tháng trong năm. Giá trị phải từ 1 đến 12 hoặc bằng 0 để chỉ định một năm không có tháng và ngày.
day

integer

Ngày trong tháng. Phải có giá trị từ 1 đến 31 và có giá trị hợp lệ trong năm và tháng, hoặc bằng 0 để chỉ định một năm độc lập hoặc là một năm và tháng mà ngày không quan trọng.

SelectionOptions

Các tuỳ chọn cho loại trường chọn.

Biểu diễn dưới dạng JSON 
{
  "listOptions": {
    object (ListOptions)
  },
  "choices": [
    {
      object (Choice)
    }
  ]
}
Trường
listOptions

object (ListOptions)

Khi được chỉ định, hãy cho biết trường này hỗ trợ danh sách giá trị. Sau khi xuất bản trường, bạn sẽ không thể thay đổi điều này.
choices[]

object (Choice)

Các tuỳ chọn có sẵn cho trường lựa chọn này. Thứ tự trong danh sách nhất quán và được sửa đổi theo insertBeforeChoice.

ListOptions

Các lựa chọn cho biến thể nhiều giá trị của loại trường được liên kết.

Biểu diễn dưới dạng JSON 
{
  "maxEntries": integer
}
Trường
maxEntries

integer

Số mục nhập tối đa được phép.

Lựa chọn

Lựa chọn trường lựa chọn.

Biểu diễn dưới dạng JSON 
{
  "id": string,
  "properties": {
    object (Properties)
  },
  "lifecycle": {
    object (Lifecycle)
  },
  "displayHints": {
    object (DisplayHints)
  },
  "schemaCapabilities": {
    object (SchemaCapabilities)
  },
  "appliedCapabilities": {
    object (AppliedCapabilities)
  },
  "creator": {
    object (UserInfo)
  },
  "createTime": string,
  "updater": {
    object (UserInfo)
  },
  "updateTime": string,
  "publisher": {
    object (UserInfo)
  },
  "publishTime": string,
  "disabler": {
    object (UserInfo)
  },
  "disableTime": string,
  "lockStatus": {
    object (LockStatus)
  }
}
Trường
id

string

Giá trị duy nhất của lựa chọn. Mã nhận dạng này được tạo tự động. Khớp với biểu thức chính quy: ([a-zA-Z0-9_])+.
properties

object (Properties)

Thuộc tính cơ bản của lựa chọn.
lifecycle

object (Lifecycle)

Chỉ có đầu ra. Vòng đời của lựa chọn.
displayHints

object (DisplayHints)

Chỉ có đầu ra. Gợi ý hiển thị giao diện người dùng để kết xuất một lựa chọn.
schemaCapabilities

object (SchemaCapabilities)

Chỉ có đầu ra. Các khả năng liên quan đến lựa chọn này khi chỉnh sửa lựa chọn.
appliedCapabilities

object (AppliedCapabilities)

Chỉ có đầu ra. Các tính năng liên quan đến lựa chọn này đối với siêu dữ liệu được áp dụng.
creator

object (UserInfo)

Chỉ có đầu ra. Người dùng đã tạo lựa chọn này.
createTime

string (Timestamp format)

Chỉ có đầu ra. Thời điểm tạo lựa chọn này.
updater

object (UserInfo)

Chỉ có đầu ra. Người dùng đã cập nhật lựa chọn này lần gần đây nhất.
updateTime

string (Timestamp format)

Chỉ có đầu ra. Thời gian cập nhật lựa chọn này gần đây nhất.
publisher

object (UserInfo)

Chỉ có đầu ra. Người dùng đã đăng lựa chọn này. Giá trị này không có ý nghĩa khi lựa chọn không được xuất bản.
publishTime

string (Timestamp format)

Chỉ có đầu ra. Thời điểm đăng lựa chọn này. Giá trị này không có ý nghĩa khi lựa chọn không được xuất bản.
disabler

object (UserInfo)

Chỉ có đầu ra. Người dùng đã vô hiệu hoá lựa chọn này. Giá trị này không có ý nghĩa khi tuỳ chọn này không bị tắt.
disableTime

string (Timestamp format)

Chỉ có đầu ra. Thời gian lựa chọn này bị vô hiệu hoá. Giá trị này không có ý nghĩa khi lựa chọn không bị tắt.
lockStatus

object (LockStatus)

Chỉ có đầu ra. LockStatus của lựa chọn này.

Thuộc tính

Thuộc tính cơ bản của lựa chọn.

Biểu diễn dưới dạng JSON 
{
  "displayName": string,
  "description": string,
  "badgeConfig": {
    object (BadgeConfig)
  },
  "insertBeforeChoice": string
}
Trường
displayName

string

Bắt buộc. Văn bản hiển thị để xuất hiện trong giao diện người dùng khi nhận dạng trường này.
description

string

Nội dung mô tả về nhãn này.
badgeConfig

object (BadgeConfig)

Cấu hình huy hiệu cho lựa chọn này. Khi được đặt, nhãn sở hữu lựa chọn này được coi là "nhãn có huy hiệu".
insertBeforeChoice

string

Chỉ nhập. Chèn hoặc di chuyển lựa chọn này trước lựa chọn được chỉ định. Nếu trống, lựa chọn sẽ được đặt ở cuối danh sách.

BadgeConfig

Trạng thái huy hiệu của nhãn.

Biểu diễn dưới dạng JSON 
{
  "color": {
    object (Color)
  },
  "priorityOverride": string
}
Trường
color

object (Color)

Màu sắc của huy hiệu. Khi không được chỉ định, không có huy hiệu nào hiển thị. Màu của nền, nền trước và màu đơn (chế độ sáng và tối) đặt tại đây sẽ thay đổi trong giao diện người dùng Drive thành màu được hỗ trợ gần nhất theo đề xuất.
priorityOverride

string (int64 format)

Ghi đè mức độ ưu tiên chung mặc định của huy hiệu này. Khi bạn đặt thành 0, hệ thống sẽ sử dụng phương pháp phỏng đoán mức độ ưu tiên mặc định.

Màu

Đại diện cho một màu trong hệ màu RGBA. Cách trình bày này được thiết kế để đơn giản hoá việc chuyển đổi sang và từ các bản trình bày màu sắc bằng nhiều ngôn ngữ khác nhau sao cho gọn nhẹ. Ví dụ: các trường của biểu diễn này có thể được cung cấp một cách đơn giản cho hàm khởi tạo của java.awt.Color trong Java; nó cũng có thể được cung cấp một cách đơn giản cho phương thức +colorWithRed:green:blue:alpha của UIColor trong iOS; và chỉ cần thực hiện một chút thao tác, bạn có thể dễ dàng định dạng đoạn mã này thành chuỗi CSS rgba() trong JavaScript.

Trang tham khảo này không có thông tin về hệ màu tuyệt đối cần dùng để diễn giải giá trị RGB – ví dụ: sRGB, Adobe RGB, DCI-P3 và BT.2020. Theo mặc định, các ứng dụng sẽ giả định hệ màu sRGB.

Khi cần quyết định sự cân bằng về màu sắc, quá trình triển khai sẽ coi 2 màu là bằng nhau nếu tất cả các giá trị màu đỏ, xanh lục, xanh dương và alpha chênh lệch nhau tối đa là 1e-5.

Ví dụ (Java):

 import com.google.type.Color;

 // ...
 public static java.awt.Color fromProto(Color protocolor) {
   float alpha = protocolor.hasAlpha()
       ? protocolor.getAlpha().getValue()
       : 1.0;

   return new java.awt.Color(
       protocolor.getRed(),
       protocolor.getGreen(),
       protocolor.getBlue(),
       alpha);
 }

 public static Color toProto(java.awt.Color color) {
   float red = (float) color.getRed();
   float green = (float) color.getGreen();
   float blue = (float) color.getBlue();
   float denominator = 255.0;
   Color.Builder resultBuilder =
       Color
           .newBuilder()
           .setRed(red / denominator)
           .setGreen(green / denominator)
           .setBlue(blue / denominator);
   int alpha = color.getAlpha();
   if (alpha != 255) {
     result.setAlpha(
         FloatValue
             .newBuilder()
             .setValue(((float) alpha) / denominator)
             .build());
   }
   return resultBuilder.build();
 }
 // ...

Ví dụ (iOS / obj-C):

 // ...
 static UIColor* fromProto(Color* protocolor) {
    float red = [protocolor red];
    float green = [protocolor green];
    float blue = [protocolor blue];
    FloatValue* alpha_wrapper = [protocolor alpha];
    float alpha = 1.0;
    if (alpha_wrapper != nil) {
      alpha = [alpha_wrapper value];
    }
    return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
 }

 static Color* toProto(UIColor* color) {
     CGFloat red, green, blue, alpha;
     if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
       return nil;
     }
     Color* result = [[Color alloc] init];
     [result setRed:red];
     [result setGreen:green];
     [result setBlue:blue];
     if (alpha <= 0.9999) {
       [result setAlpha:floatWrapperWithValue(alpha)];
     }
     [result autorelease];
     return result;
}
// ...

Ví dụ (JavaScript):

// ...

var protoToCssColor = function(rgb_color) {
   var redFrac = rgb_color.red || 0.0;
   var greenFrac = rgb_color.green || 0.0;
   var blueFrac = rgb_color.blue || 0.0;
   var red = Math.floor(redFrac * 255);
   var green = Math.floor(greenFrac * 255);
   var blue = Math.floor(blueFrac * 255);

   if (!('alpha' in rgb_color)) {
      return rgbToCssColor(red, green, blue);
   }

   var alphaFrac = rgb_color.alpha.value || 0.0;
   var rgbParams = [red, green, blue].join(',');
   return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
};

var rgbToCssColor = function(red, green, blue) {
  var rgbNumber = new Number((red << 16) | (green << 8) | blue);
  var hexString = rgbNumber.toString(16);
  var missingZeros = 6 - hexString.length;
  var resultBuilder = ['#'];
  for (var i = 0; i < missingZeros; i++) {
     resultBuilder.push('0');
  }
  resultBuilder.push(hexString);
  return resultBuilder.join('');
};

// ...
Biểu diễn dưới dạng JSON 
{
  "red": number,
  "green": number,
  "blue": number,
  "alpha": number
}
Trường
red

number

Lượng màu đỏ trong màu dưới dạng một giá trị trong khoảng [0, 1].
green

number

Lượng màu xanh lục trong màu dưới dạng một giá trị trong khoảng [0, 1].
blue

number

Lượng màu xanh dương trong màu dưới dạng một giá trị trong khoảng [0, 1].
alpha

number

Tỷ lệ của màu này sẽ được áp dụng cho điểm ảnh. Tức là màu pixel cuối cùng được xác định theo phương trình:

pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

Điều này có nghĩa là giá trị 1.0 tương ứng với một màu đồng nhất, trong khi giá trị 0.0 tương ứng với một màu hoàn toàn trong suốt. Tính năng này sử dụng một thông báo trình bao bọc thay vì một đại lượng vô hướng số thực đơn giản để có thể phân biệt giữa giá trị mặc định và giá trị chưa được đặt. Nếu bạn bỏ qua, đối tượng màu này sẽ hiển thị dưới dạng một màu đồng nhất (như thể giá trị alpha đã được cung cấp rõ ràng giá trị là 1.0).

DisplayHints

Gợi ý hiển thị giao diện người dùng để kết xuất một tuỳ chọn.

Biểu diễn dưới dạng JSON 
{
  "disabled": boolean,
  "hiddenInSearch": boolean,
  "shownInApply": boolean,
  "badgeColors": {
    object (BadgeColors)
  },
  "darkBadgeColors": {
    object (BadgeColors)
  },
  "badgePriority": string
}
Trường
disabled

boolean

Liệu tuỳ chọn này có hiển thị trong giao diện người dùng ở trạng thái tắt hay không.
shownInApply

boolean

Lựa chọn này sẽ hiển thị trong trình đơn áp dụng khi áp dụng các giá trị cho một mục trên Drive.
badgeColors

object (BadgeColors)

Các màu sử dụng cho huy hiệu. Đã thay đổi thành màu Google Material dựa trên properties.badge_config.color đã chọn.
darkBadgeColors

object (BadgeColors)

Màu ở chế độ tối sử dụng cho huy hiệu. Đã thay đổi thành màu Google Material dựa trên properties.badge_config.color đã chọn.
badgePriority

string (int64 format)

Mức độ ưu tiên của huy hiệu này. Dùng để so sánh và sắp xếp giữa nhiều huy hiệu. Số thấp hơn có nghĩa là huy hiệu sẽ xuất hiện đầu tiên. Khi không có cấu hình huy hiệu, giá trị này sẽ là 0. Nếu không, giá trị này sẽ được đặt thành BadgeConfig.priority_override hoặc hệ thống phỏng đoán mặc định ưu tiên ngày tạo nhãn, cũng như mức độ ưu tiên của trường và lựa chọn.

BadgeColors

Màu bắt nguồn từ SignalConfig và đã thay đổi thành màu được hỗ trợ gần nhất được đề xuất.

Biểu diễn dưới dạng JSON 
{
  "backgroundColor": {
    object (Color)
  },
  "foregroundColor": {
    object (Color)
  },
  "soloColor": {
    object (Color)
  }
}
Trường
backgroundColor

object (Color)

Chỉ có đầu ra. Nền huy hiệu đi kèm với nền trước.
foregroundColor

object (Color)

Chỉ có đầu ra. Nền trước của huy hiệu kết hợp được với nền.
soloColor

object (Color)

Chỉ có đầu ra. Màu có thể dùng cho văn bản không có nền.

SchemaCapabilities

Các tính năng liên quan đến lựa chọn này khi chỉnh sửa lựa chọn.

Biểu diễn dưới dạng JSON 
{
  "canUpdate": boolean,
  "canDelete": boolean,
  "canDisable": boolean,
  "canEnable": boolean
}
Trường
canUpdate

boolean

Liệu người dùng có thể cập nhật lựa chọn này hay không.
canDelete

boolean

Liệu người dùng có thể xoá lựa chọn này hay không.
canDisable

boolean

Liệu người dùng có thể tắt lựa chọn này hay không.
canEnable

boolean

Liệu người dùng có thể bật lựa chọn này hay không.

AppliedCapabilities

Các tính năng liên quan đến lựa chọn này đối với siêu dữ liệu được áp dụng.

Biểu diễn dưới dạng JSON 
{
  "canRead": boolean,
  "canSearch": boolean,
  "canSelect": boolean
}
Trường
canRead

boolean

Liệu người dùng có thể đọc siêu dữ liệu được áp dụng liên quan trên mặt hàng hay không.
canSelect

boolean

Liệu người dùng có thể chọn lựa chọn này cho một mục hay không.

LockStatus

Chứa thông tin về việc liệu thành phần nhãn có được coi là bị khoá hay không.

Biểu diễn dưới dạng JSON 
{
  "locked": boolean
}
Trường
locked

boolean

Chỉ có đầu ra. Cho biết liệu thành phần nhãn này có phải là mục tiêu (trực tiếp) của LabelLock hay không. Thành phần nhãn có thể bị khoá ngầm ngay cả khi thành phần đó không phải là mục tiêu trực tiếp của LabelLock. Trong trường hợp đó, trường này sẽ được đặt thành false.

UserOptions

Các lựa chọn cho loại trường người dùng.

Biểu diễn dưới dạng JSON 
{
  "listOptions": {
    object (ListOptions)
  }
}
Trường
listOptions

object (ListOptions)

Khi được chỉ định, hãy cho biết rằng trường này hỗ trợ danh sách giá trị. Sau khi xuất bản trường, bạn sẽ không thể thay đổi điều này.

Thuộc tính

Các thuộc tính cơ bản của trường.

Biểu diễn dưới dạng JSON 
{
  "displayName": string,
  "required": boolean,
  "insertBeforeField": string
}
Trường
displayName

string

Bắt buộc. Văn bản hiển thị để xuất hiện trong giao diện người dùng khi nhận dạng trường này.
required

boolean

Liệu trường này có được đánh dấu là bắt buộc hay không.
insertBeforeField

string

Chỉ nhập. Chèn hoặc di chuyển trường này trước trường đã chỉ định. Nếu trống, trường này sẽ được đặt ở cuối danh sách.

DisplayHints

Gợi ý hiển thị giao diện người dùng để kết xuất một trường.

Biểu diễn dưới dạng JSON 
{
  "required": boolean,
  "disabled": boolean,
  "hiddenInSearch": boolean,
  "shownInApply": boolean
}
Trường
required

boolean

Liệu trường này có xuất hiện theo yêu cầu trong giao diện người dùng hay không.
disabled

boolean

Liệu trường này có hiển thị trong giao diện người dùng dưới dạng bị tắt hay không.
shownInApply

boolean

Trường này sẽ hiển thị trong trình đơn áp dụng khi áp dụng các giá trị cho một mục trên Drive.

SchemaCapabilities

Các khả năng liên quan đến trường này khi chỉnh sửa trường.

Biểu diễn dưới dạng JSON 
{
  "canUpdate": boolean,
  "canDelete": boolean,
  "canDisable": boolean,
  "canEnable": boolean
}
Trường
canUpdate

boolean

Liệu người dùng có thể thay đổi trường này hay không.
canDelete

boolean

Liệu người dùng có thể xoá trường này hay không. Người dùng phải có quyền và trường này phải không được dùng nữa.
canDisable

boolean

Liệu người dùng có thể tắt trường này hay không. Người dùng phải có quyền và trường này phải chưa bị tắt.
canEnable

boolean

Liệu người dùng có thể bật trường này hay không. Người dùng phải có quyền và trường này phải được tắt.

AppliedCapabilities

Các khả năng liên quan đến trường này trên siêu dữ liệu được áp dụng.

Biểu diễn dưới dạng JSON 
{
  "canRead": boolean,
  "canSearch": boolean,
  "canWrite": boolean
}
Trường
canRead

boolean

Liệu người dùng có thể đọc siêu dữ liệu được áp dụng liên quan trên mặt hàng hay không.
canWrite

boolean

Liệu người dùng có thể đặt trường này trên các mục trong Drive hay không.

Phương thức

create

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

delete

 Xoá vĩnh viễn Nhãn và siêu dữ liệu liên quan trên các mục trên Drive.

delta

 Cập nhật một Nhãn duy nhất bằng cách áp dụng một nhóm các yêu cầu cập nhật dẫn đến một bản sửa đổi nháp mới.

disable

 Tắt Nhãn đã xuất bản.

enable

 Bật Nhãn đã bị tắt và khôi phục Nhãn về trạng thái đã xuất bản.

get

 Lấy nhãn theo tên tài nguyên.

list

 Danh sách nhãn.

publish

 Xuất bản tất cả các thay đổi nháp đối với Nhãn.

updateLabelCopyMode

 Cập nhật CopyMode của Nhãn.

updatePermissions

 Cập nhật các quyền của Nhãn.