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)
  }
}
Các 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 idrevisionId bên dưới.

id

string

Chỉ có đầu ra. Giá trị nhận dạng duy nhất trên toàn cầu của nhãn này. Mã nhận dạng là một phần của nhãn name, nhưng không giống như name, mã nhận dạ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 sẽ được tạo mỗi khi thuộc tính được sửa đổi của một nhãn 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 nhãn này được tạo.

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 không được xuất bản.

publishTime

string (Timestamp format)

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

disabler

object (UserInfo)

Chỉ có đầu ra. Người dùng đã tắt 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ị tắt. 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ụ: "khách hàng/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 nháp hay không.

displayHints

object (DisplayHints)

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

appliedCapabilities

object (AppliedCapabilities)

Chỉ có đầu ra. Các khả 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. Những khả năng mà người dùng có trên nhãn này.

appliedLabelPolicy

object (AppliedLabelPolicy)

Chỉ có đầu ra. Cách hoạt động của nhãn này khi áp dụng cho các mục trên Drive.

fields[]

object (Field)

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

learnMoreUri

string

URL tuỳ chỉnh hiển thị với người dùng để 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. Trạng thái khoá 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 thuộc sở hữu của quản trị viên. 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 bổ sung 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
}
Các 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 People API để thu thập thêm thông tin. Ví dụ: người/12345678.

Thuộc tính

Thuộc tính cơ bản của nhãn.

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

string

Bắt buộc. Tên nhãn.

description

string

Mô tả 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 -> (Đã xoá)
  • PUBLISHED -> DISABLED
  • DISABLED -> PUBLISHED
  • DISABLED -> (Đã xoá)

Trạng thái đã xuất bản và trạng thái 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 một đối tượng ở trạng thái này, trong trường hợp đó, hasUnpublishedChanges sẽ là đúng. Ngoài ra, chúng tôi không cho phép một số loại thay đổi. Nhìn chung, mọi thay đổi làm mất hiệu lực hoặc gây ra những hạn chế mới đối với siêu dữ liệu hiện có liên quan đến nhãn đều bị từ chối.
  • Tắt – Khi bạn 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)
  }
}
Các 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 được xuất bản hay không.

disabledPolicy

object (DisabledPolicy)

Chính sách này điều chỉnh cách hiển thị 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 đối tượng. Sau khi được 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 sẽ không được phép thực hiện một số thay đổi nhất định nữa.
PUBLISHED Đối tượng đã được xuất bản. Đối tượng có thể có các thay đổi nháp chưa xuất bản như được hasUnpublishedChanges chỉ định.
DISABLED Đối tượng này đã được xuất bản và đã bị vô hiệu hoá. Đối tượng có thể có các thay đổi nháp chưa xuất bản như được hasUnpublishedChanges chỉ định.
DELETED Đối tượng đã bị xoá.

DisabledPolicy

Chính sách này điều chỉnh cách xử lý 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
}
Các trường
showInApply

boolean

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

  • Khi true, đối tượng thường sẽ hiển thị trong giao diện người dùng dưới dạng đã 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 để kết xuất nhãn.

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

boolean

Liệu nhãn có hiện trong giao diện người dùng dưới dạng bị tắt hay không.

shownInApply

boolean

Nhãn này sẽ xuất hiện trong trình đơn áp dụng khi áp dụng 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 khả năng mà người dùng có đối với siêu dữ liệu được áp dụng của nhãn này.

Biểu diễn dưới dạng JSON
{
  "canRead": boolean,
  "canApply": boolean,
  "canRemove": boolean
}
Các 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 đế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 khả 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
}
Các 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à phải tắt nhãn.

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ị vô hiệu hoá.

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

Cách hoạt động 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)
}
Các trường
copyMode

enum (CopyMode)

Cho biết cách sao chép các giá trị của trường và nhãn được á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ị của trường và nhãn được áp dụng khi sao chép một mục trên Drive.

Enum
COPY_MODE_UNSPECIFIED Chưa xác định chế độ sao chép.
DO_NOT_COPY Theo mặc định, các giá trị của trường và nhãn đã áp dụng không được sao chép khi mục trên Drive được áp dụng giá trị đó được sao chép.
ALWAYS_COPY Các giá trị của trường và nhãn đã áp dụng luôn được sao chép khi mục trên Drive được áp dụng giá trị đó được sao chép. Chỉ quản trị viên mới có thể sử dụng chế độ này.
COPY_APPLIABLE Các giá trị trường và nhãn đã á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 tuỳ 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ột 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.
}
Các trường
id

string

Chỉ có đầu ra. Khoá của một trường, duy nhất trong một 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 trong 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} > 2001-01-01".

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ị trên giao diện người dùng để kết xuất một trường.

schemaCapabilities

object (SchemaCapabilities)

Chỉ có đầu ra. Những 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ó đối với 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 gian 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 này không được xuất bản.

disabler

object (UserInfo)

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

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 này không bị vô hiệu hoá.

lockStatus

object (LockStatus)

Chỉ có đầu ra. Trạng thái khoá của trường này.

Trường nhóm type. Loại dữ liệu và tuỳ chọn của trường này. Sau khi xuất bản, bạn 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)

Tuỳ chọn cho trường chọn.

userOptions

object (UserOptions)

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

TextOptions

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
}
Các trường
minLength

integer

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

maxLength

integer

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

IntegerOptions

Tuỳ chọn dành cho loại trường Số nguyên.

Biểu diễn dưới dạng JSON
{
  "minValue": string,
  "maxValue": string
}
Các 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ệ tối đa cho trường số nguyên.

DateOptions

Tuỳ 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)
  }
}
Các 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ữ.

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

Tuỳ chọn định dạng ngày đã bản địa hoá.

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 (d, d, MMMM)
SHORT_DATE Ngắn gọn, dạng số, trình bày. Ví dụ: 12/13/99 (M/d/yy)

SelectionOptions

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

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

object (ListOptions)

Khi được chỉ định, cho biết trường này có hỗ trợ một danh sách các giá trị. Bạn không thể thay đổi trường này sau khi đã xuất bản.

choices[]

object (Choice)

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

ListOptions

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

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

integer

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

Lựa chọn

Lựa chọn của trường 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)
  }
}
Các trường
id

string

Giá trị duy nhất của lựa chọn. Mã 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 để hiển thị lựa chọn.

schemaCapabilities

object (SchemaCapabilities)

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

appliedCapabilities

object (AppliedCapabilities)

Chỉ có đầu ra. Các khả năng liên quan đến lựa chọn này trên 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 gian lựa chọn này được tạo.

updater

object (UserInfo)

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

updateTime

string (Timestamp format)

Chỉ có đầu ra. Thời gian lựa chọn này được cập nhật lần 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 xuất bản 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 đã tắt lựa chọn này. Giá trị này không có ý nghĩa khi bạn không tắt tuỳ chọn này.

disableTime

string (Timestamp format)

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

lockStatus

object (LockStatus)

Chỉ có đầu ra. Trạng thái 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
}
Các 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 xác định trường này.

description

string

Mô tả nhãn này.

badgeConfig

object (BadgeConfig)

Cấu hình huy hiệu cho lựa chọn này. Khi đặ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
}
Các trường
color

object (Color)

Màu của huy hiệu. Khi bạn không chỉ định thì sẽ không có huy hiệu nào xuất hiện. Màu nền, màu nền trước và màu đơn (chế độ sáng và tối) được thiết lập ở đây sẽ thay đổi trong giao diện người dùng Drive thành màu được hỗ trợ gần nhất được đề 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 giá trị là 0, hệ thống sẽ sử dụng phương pháp phỏng đoán theo mức độ ưu tiên mặc định.

DisplayHints

Các gợi ý hiển thị giao diện người dùng để hiển thị 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
}
Các trường
disabled

boolean

Liệu tuỳ chọn có hiển thị trong giao diện người dùng là bị tắt hay không.

shownInApply

boolean

Tuỳ chọn này sẽ xuất hiện trong trình đơn áp dụng khi áp dụng giá trị cho một mục trên Drive.

badgeColors

object (BadgeColors)

Các màu được sử dụng cho huy hiệu. Thay đổi sang 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 sang 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à phân loại giữa các huy hiệu. Con số thấp hơn có nghĩa là huy hiệu sẽ xuất hiện trước tiên. Khi không có cấu hình huy hiệu, giá trị này sẽ là 0. Nếu không, thuộc tính này sẽ được đặt thành BadgeConfig.priority_override hoặc phương pháp 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à tuỳ chọn.

BadgeColors

Màu lấy từ BadgeConfig 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)
  }
}
Các 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 huy hiệu kết hợp 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 chức 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
}
Các 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 khả năng liên quan đến lựa chọn 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,
  "canSelect": boolean
}
Các trường
canRead

boolean

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

canSelect

boolean

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

LockStatus

Chứa thông tin về việc có nên coi một thành phần nhãn là đã khoá hay không.

Biểu diễn dưới dạng JSON
{
  "locked": boolean
}
Các 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. Một thành phần nhãn có thể hoàn toàn bị khoá ngay cả khi đó không phải là mục tiêu trực tiếp của LabelLock, trong trường hợp này, trường này được đặt thành false.

UserOptions

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

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

object (ListOptions)

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

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
}
Các 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 xác định trường này.

required

boolean

Liệu trường 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 được chỉ định. Nếu trống, trường này sẽ được đặt ở cuối danh sách.

DisplayHints

Gợi ý hiển thị trên 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
}
Các trường
required

boolean

Liệu trường có hiển thị theo yêu cầu trong giao diện người dùng hay không.

disabled

boolean

Liệu trường 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ẽ xuất hiện 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
}
Các 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 được ngừng sử dụng.

canDisable

boolean

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à phải tắt trường này.

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
}
Các trường
canRead

boolean

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

canWrite

boolean

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

Phương thức

create

Tạo Nhãn mới.

delete

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

delta

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

disable

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

enable

Bật Nhãn đã bị vô hiệu hoá 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 cho Nhãn.

updateLabelCopyMode

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

updatePermissions

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