REST Resource: labels

Tài nguyên: Nhãn

Nhãn xác định một hệ thống 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 các mục. Nhãn có thể là chuỗi đơn giản hoặc có thể chứa các trường mô tả siêu dữ liệu bổ sung. Bạn có thể sử dụng siêu dữ liệu này để 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)
  },
  "enabledAppSettings": {
    object (EnabledAppSettings)
  }
}
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. Hãy 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. Giá trị nhận dạng là một phần của nhãn name, nhưng không giống như name, giá trị 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ã phiên bản có thể nằm trong nhãn name, tuỳ thuộc vào yêu cầu được đưa ra. Một phiên bản mới sẽ được tạo mỗi khi các thuộc tính có phiên bản 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 tạo nhãn này.
revisionCreator

object (UserInfo)

Chỉ có đầu ra. Người dùng đã tạo phiên bản 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ị vô hiệu hoá.
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ị vô hiệu hoá.
customer

string

Chỉ có đầu ra. Khách hàng mà nhãn này thuộc về. Ví dụ: customers/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.
displayHints

object (DisplayHints)

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

object (AppliedCapabilities)

Chỉ có đầu ra. Các chức 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 chức 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 được á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 để trình bày 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.
enabledAppSettings

object (EnabledAppSettings)

Không bắt buộc. EnabledAppSettings cho 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 Bạn có thể chia sẻ nhãn dùng chung 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 bổ sung chỉ dành cho quản trị viên.
GOOGLE_APP Nhãn thuộc sở hữu của một ứng dụng nội bộ của Google chứ không phải của khách hàng. Các nhãn này ở chế độ chỉ đọc.

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 của người dùng này có thể dùng với People API để biết thêm thông tin. Ví dụ: people/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. Tên 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. Để biết thêm thông tin, hãy xem bài viết Vòng đời của nhãn.

Vòng đời này 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:

  • Published: Bạn có thể thực hiện một số loại thay đổi đối với một đối tượng ở trạng thái này, trong trường hợp đó, hasUnpublishedChanges sẽ là true. Ngoài ra, bạn không được phép thực hiện 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 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.
  • Disabled: Khi bị vô hiệu hoá, 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 được 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 chi phối 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 được 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 được xuất bản, đối tượng sẽ không bao giờ quay lại trạng thái này. Sau khi một đối tượng được xuất bản, bạn sẽ không được phép thực hiện một số loại thay đổi.
PUBLISHED Đối tượng đã được xuất bản. Đối tượng có thể có các thay đổi nháp chưa được xuất bản như biểu thị bằng hasUnpublishedChanges.
DISABLED Đối tượng này đã được xuất bản và sau đó bị vô hiệu hoá. Đối tượng có thể có các thay đổi nháp chưa được xuất bản như biểu thị bằng hasUnpublishedChanges.
DELETED Đã xoá đối tượng này.

DisabledPolicy

Chính sách chi phối cách xử lý nhãn, trường hoặc lựa chọn bị vô hiệu hoá trong các bối cảnh khác nhau.

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

boolean

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

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

DisplayHints

Gợi ý hiển thị 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
}
Trường
disabled

boolean

Liệu nhãn có nên xuất hiện trong giao diện người dùng ở trạng thái bị vô hiệu hoá 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

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

boolean

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

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 chức 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 bị vô hiệu hoá.
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 chưa bị vô hiệu hoá.
canEnable

boolean

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à nhãn này phải bị vô hiệu hoá.

AppliedLabelPolicy

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

CopyMode

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

Enum
COPY_MODE_UNSPECIFIED Chưa chỉ định chế độ sao chép.
DO_NOT_COPY Theo mặc định, nhãn và các giá trị trường đã áp dụng sẽ không được sao chép khi mục trên Drive mà nhãn và các giá trị trường đó được áp dụng bị sao chép.
ALWAYS_COPY Nhãn và giá trị của trường được áp dụng luôn được sao chép khi mục trên Drive mà nhãn và giá trị đó được áp dụng được sao chép. Chỉ quản trị viên mới có thể sử dụng chế độ này.
COPY_APPLIABLE Nhãn và giá trị của trường được áp dụng sẽ được sao chép nếu người dùng sao chép 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 trên một mục trong 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, là 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á dùng khi tạo cụm từ 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} > 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ị giao diện người dùng để kết xuất một trường.
schemaCapabilities

object (SchemaCapabilities)

Chỉ có đầu ra. Các chức 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 quyền 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 tạo trường này.
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 trường này được cập nhật.
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 chưa đượ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ị 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 không bị vô hiệu hoá.
lockStatus

object (LockStatus)

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

object (TextOptions)

Các lựa chọn về trường văn bản.
integerOptions

object (IntegerOptions)

Các lựa chọn về trường số nguyên.
dateOptions

object (DateOptions)

Các lựa chọn về trường ngày.
selectionOptions

object (SelectionOptions)

Các lựa chọn về trường lựa chọn.
userOptions

object (UserOptions)

Các lựa chọn về trường người dùng.

TextOptions

Các lựa 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 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 hợp lệ tối đa của các giá trị cho trường văn bản.

IntegerOptions

Các lựa chọn cho loại trường 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ệ tối thiểu 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

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)

Lựa chọn định dạng ngày theo ngôn ngữ. Các giá trị trường được hiển thị ở định dạng này theo ngôn ngữ của chúng.
dateFormat

string

Chỉ có đầu ra. Định dạng ngày 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

Các lựa chọn về định dạng ngày theo ngôn ngữ.

Enum
DATE_FORMAT_UNSPECIFIED Bạn chưa chỉ đị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 Biểu thị bằng số ngắn gọn. Ví dụ: 13/12/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 quan trọng. Ngày này có liên quan đến Dương lịch. Nội dung đặc tả này có thể xuất hiện dưới dạng một trong những nội dung sau:

  • Một ngày đầy đủ, với các giá trị năm, tháng và ngày khác 0.
  • Giá trị tháng và ngày, giá trị năm bằng 0 (ví dụ: ngày kỷ niệm).
  • Chỉ riêng giá trị năm, với giá trị tháng và ngày bằng 0.
  • Năm và tháng, với giá trị ngày bằng 0 (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 từ 0 để chỉ định một năm không có tháng và ngày.
day

integer

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

SelectionOptions

Các lựa 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)
    }
  ]
}
Trường
listOptions

object (ListOptions)

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

object (Choice)

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

ListOptions

Các lựa chọn cho một biến thể có nhiều giá trị của một 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)

Các 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. Giao diện người dùng hiển thị các gợi ý để hiển thị một lựa chọn.
schemaCapabilities

object (SchemaCapabilities)

Chỉ có đầu ra. 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.
appliedCapabilities

object (AppliedCapabilities)

Chỉ có đầu ra. Các chức 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 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 nhất.
updateTime

string (Timestamp format)

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

object (UserInfo)

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

string (Timestamp format)

Chỉ có đầu ra. Thời gian xuất bản lựa chọn này. Giá trị này không có ý nghĩa khi lựa chọn chưa đượ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 lựa chọn này không bị vô hiệu hoá.
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ị vô hiệu hoá.
lockStatus

object (LockStatus)

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

Thuộc tính

Các 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ị sẽ xuất hiện trong giao diện người dùng để xác định 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 sẽ được coi là "nhãn có huy hiệu".
insertBeforeChoice

string

Chỉ có đầu vào. 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 của huy hiệu. Khi không được chỉ định, huy hiệu sẽ không được hiển thị. Màu nền, màu văn bản và màu đơn sắc (chế độ sáng và tối) được đặt ở đâ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)

Thay thế mức độ ưu tiên chung mặc định của huy hiệu này. Khi được đặ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

Biểu thị một màu trong không gian màu RGBA. Biểu thị này được thiết kế để đơn giản hoá việc chuyển đổi sang và từ biểu thị màu bằng nhiều ngôn ngữ thay vì tính cô đọng. Ví dụ: các trường của biểu thức 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; 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 một chút công sức, bạn có thể dễ dàng định dạng thành chuỗi rgba() CSS trong JavaScript.

Trang tham chiếu 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, chẳng hạn như 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 xác định sự bằng nhau về màu sắc, các hoạt động triển khai (trừ phi có tài liệu khác) sẽ coi hai màu là bằng nhau nếu tất cả các giá trị đỏ, xanh lục, xanh lam và alpha của chúng khác nhau nhiều nhất 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 giá trị trong khoảng [0, 1].
green

number

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

number

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

number

Phân số của màu này sẽ được áp dụng cho pixel. Tức là màu pixel cuối cùng được xác định bằng 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àu đồng nhất, trong khi giá trị 0.0 tương ứng với màu hoàn toàn trong suốt. Thao tác này sử dụng một thông báo bao bọc thay vì một đại lượng vô hướng đơ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ị bỏ qua, đối tượng màu này sẽ được kết xuất dưới dạng màu đồng nhất (như thể giá trị alpha đã được chỉ định rõ ràng là 1.0).

DisplayHints

Giao diện người dùng hiển thị các gợi ý để hiển thị một lựa 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

Có nên hiển thị lựa chọn này 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ẽ 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)

Màu sắc 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 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ố càng thấp thì huy hiệu càng xuất hiện trước. Nếu không có cấu hình gắn 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 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à lựa chọn.

BadgeColors

Màu bắt nguồn từ BadgeConfig và được thay đổi thành màu được hỗ trợ gần nhất theo đề 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 kết hợp 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 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
}
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

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

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

AppliedCapabilities

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

boolean

Người dùng có thể đọc siêu dữ liệu được áp dụng có liên quan 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à 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 một khoá nhãn hay không. Một thành phần nhãn có thể bị khoá ngầm ngay cả khi không phải là mục tiêu trực tiếp của một khoá nhãn. Trong trường hợp đó, trường này đượ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, cho biết 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
}
Trường
displayName

string

Bắt buộc. Văn bản hiển thị sẽ 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ó nên được đánh dấu là bắt buộc hay không.
insertBeforeField

string

Chỉ có đầu vào. 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ị 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ó nên xuất hiện dưới dạng trường bắt buộc trong giao diện người dùng hay không.
disabled

boolean

Trường này có nên xuất hiện trong giao diện người dùng ở trạng thái 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 giá trị cho một mục trên Drive.

SchemaCapabilities

Các chức 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

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

boolean

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

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 chưa được tắt.
canEnable

boolean

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

AppliedCapabilities

Các chức 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

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

boolean

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

EnabledAppSettings

Mô tả các ứng dụng Google Workspace mà bạn có thể sử dụng nhãn.

Biểu diễn dưới dạng JSON 
{
  "enabledApps": [
    {
      object (EnabledApp)
    }
  ]
}
Trường
enabledApps[]

object (EnabledApp)

Không bắt buộc. Danh sách các ứng dụng có thể dùng nhãn.

EnabledApp

Ứng dụng mà bạn có thể dùng nhãn.

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

enum (App)

Không bắt buộc. Tên ứng dụng.

Ứng dụng

Tập hợp các ứng dụng Google Workspace có thể sử dụng nhãn.

Enum
APP_UNSPECIFIED Không xác định
DRIVE Drive
GMAIL Gmail

Phương thức

create

 Tạo nhãn.

delete

 Xoá vĩnh viễn một 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 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 một nhãn đã 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

 Liệt kê nhãn.

publish

 Xuất bản tất cả thay đổi trong bản nháp cho nhãn.

updateLabelCopyMode

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

updateLabelEnabledAppSettings

 Cập nhật EnabledAppSettings của nhãn.

updatePermissions

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