REST Resource: labels

资源:标签

标签定义了可对云端硬盘内容应用的分类,以便对各个内容进行整理和搜索。标签可以是简单的字符串,也可以包含描述其他元数据的字段,这些元数据可用于进一步整理和搜索云端硬盘内容。

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)
  }
}
字段
name

string

仅供输出。标签的资源名称。将采用 labels/{id}labels/{id}@{revisionId} 格式,具体取决于请求。请参阅下面的 idrevisionId

id

string

仅供输出。此标签的全局唯一标识符。ID 属于 name 标签的一部分,但与 name 不同的是,修订版本之间的 ID 是一致的。符合以下正则表达式:([a-zA-Z0-9])+

revisionId

string

仅供输出。标签的修订版本 ID。修订版本 ID 可能会包含在标签 name 中,具体取决于发出的请求。只要更改标签的修订版本属性,系统就会创建新的修订版本。符合以下正则表达式:([a-zA-Z0-9])+

labelType

enum (LabelType)

必需。标签的类型。

creator

object (UserInfo)

仅供输出。创建此标签的用户。

createTime

string (Timestamp format)

仅供输出。此标签的创建时间。

revisionCreator

object (UserInfo)

仅供输出。创建此标签修订版本的用户。

revisionCreateTime

string (Timestamp format)

仅供输出。此标签修订版本的创建时间。

publisher

object (UserInfo)

仅供输出。发布此标签的用户。如果标签未发布,此值没有任何意义。

publishTime

string (Timestamp format)

仅供输出。此标签的发布时间。如果标签未发布,此值没有任何意义。

disabler

object (UserInfo)

仅供输出。停用此标签的用户。如果未停用标签,此值没有任何意义。

disableTime

string (Timestamp format)

仅供输出。此标签的停用时间。如果未停用标签,此值没有任何意义。

customer

string

仅供输出。此标签所属的客户。例如:“customers/123abc789”。

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)

仅供输出。此标签的 LockStatus。

LabelType

此标签的类型。

枚举
LABEL_TYPE_UNSPECIFIED 未知标签类型。
SHARED 您可以与用户共享共享标签,以便将其应用于云端硬盘内容。
ADMIN 管理员拥有的标签。只能由管理员创建和编辑。支持一些仅适用于管理员的其他功能。

UserInfo

与用户相关的信息。

JSON 表示法
{
  "person": string
}
字段
person

string

此用户的标识符,可与 People API 一起使用以获取更多信息。例如 people/12345678。

属性

标签的基本属性。

JSON 表示法
{
  "title": string,
  "description": string
}
字段
title

string

必需。标签的标题。

description

string

标签的说明。

生命周期

一个对象(如标签、字段或选项)的生命周期状态。生命周期会强制执行以下转换:

  • UNPUBLISHED_DRAFT(启动状态)
  • UNPUBLISHED_DRAFT -> PUBLISHED
  • UNPUBLISHED_DRAFT ->(已删除)
  • PUBLISHED -> DISABLED
  • DISABLED -> PUBLISHED
  • DISABLED ->(已删除)

“已发布”状态和“已停用”状态具有一些明显的特征:

  • 已发布 - 系统可能会对此状态下的对象进行某些类型的更改,在这种情况下,hasUnpublishedChanges 将为 true。此外,我们不允许进行某些类型的更改。一般来说,任何会使与标签相关的现有元数据失效或导致其受到新限制的更改都会被拒绝。
  • 停用 - 停用后,配置的 DisabledPolicy 将会生效。
JSON 表示法
{
  "state": enum (State),
  "hasUnpublishedChanges": boolean,
  "disabledPolicy": {
    object (DisabledPolicy)
  }
}
字段
state

enum (State)

仅供输出。与此生命周期关联的对象的状态。

hasUnpublishedChanges

boolean

仅供输出。与此生命周期相关联的对象是否具有未发布的更改。

disabledPolicy

object (DisabledPolicy)

此政策用于控制如何显示已停用的标签、字段或选项。

状态

与此生命周期关联的对象的状态。

枚举
STATE_UNSPECIFIED 未知状态。
UNPUBLISHED_DRAFT 对象的初始状态。一旦发布,该对象就无法再恢复此状态。对象一旦发布,系统将不再允许进行某些类型的更改。
PUBLISHED 此对象已发布。该对象可能包含尚未发布的草稿更改,如 hasUnpublishedChanges 所示。
DISABLED 该对象已发布且已停用。该对象可能包含尚未发布的草稿更改,如 hasUnpublishedChanges 所示。
DELETED 该对象已被删除。

DisabledPolicy

此政策旨在控制如何在不同上下文中处理已停用的标签、字段或选项。

JSON 表示法
{
  "hideInSearch": boolean,
  "showInApply": boolean
}
字段
showInApply

boolean

是否在云端硬盘项的“应用”菜单中显示此已停用对象。

  • 当为 true 时,对象通常在界面中显示为已停用且不可选择。
  • 当为 false 时,对象通常隐藏在界面中。

DisplayHints

用于呈现标签的界面显示提示。

JSON 表示法
{
  "disabled": boolean,
  "hiddenInSearch": boolean,
  "shownInApply": boolean,
  "priority": string
}
字段
disabled

boolean

标签是否应在界面中显示为已停用。

shownInApply

boolean

为云端硬盘内容应用值时,此标签应显示在“应用”菜单中。

priority

string (int64 format)

以列表形式显示标签的顺序。

AppliedCapabilities

用户对此标签的应用元数据具备的权限。

JSON 表示法
{
  "canRead": boolean,
  "canApply": boolean,
  "canRemove": boolean
}
字段
canRead

boolean

用户是否可以读取与此标签相关的已应用的元数据。

canApply

boolean

用户是否可以将此标签应用于各项。

canRemove

boolean

用户是否可以从项中移除此标签。

SchemaCapabilities

修改标签时与此标签相关的功能。

JSON 表示法
{
  "canUpdate": boolean,
  "canDelete": boolean,
  "canDisable": boolean,
  "canEnable": boolean
}
字段
canUpdate

boolean

用户是否可以更改此标签。

canDelete

boolean

用户是否可以删除此标签。用户必须有权限才能停用标签。

canDisable

boolean

用户是否可以停用此标签。用户必须拥有相应权限,且此标签必须处于已停用状态。

canEnable

boolean

用户是否可以启用此标签。用户必须拥有相应权限,且此标签必须处于停用状态。

AppliedLabelPolicy

此标签应用于云端硬盘内容时的行为。

JSON 表示法
{
  "copyMode": enum (CopyMode)
}
字段
copyMode

enum (CopyMode)

指明在复制云端硬盘内容时应如何复制已应用的标签和字段值。

CopyMode

指明在复制云端硬盘内容时应如何复制已应用的标签和字段值。

枚举
COPY_MODE_UNSPECIFIED 未指定复制模式。
DO_NOT_COPY 默认情况下,当复制已应用的标签和字段值时,系统不会复制已应用标签和字段值。
ALWAYS_COPY 复制所应用的云端硬盘项时,系统始终会复制已应用的标签和字段值。只有管理员可以使用此模式。
COPY_APPLIABLE 如果复制的用户可以使用标签,则复制已应用的标签和字段值。

字段

定义具有显示名称、数据类型和其他配置选项的字段。此字段用于指定可在云端硬盘内容上设置的元数据类型。

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.
}
字段
id

string

仅供输出。字段的键,在标签或库中是唯一的。

此值是自动生成的。符合以下正则表达式:([a-zA-Z0-9])+

queryKey

string

仅供输出。构建云端硬盘搜索查询以根据文件中为此字段定义的值查找文件时使用的键。例如,“{queryKey} > 2001-01-01”。

properties

object (Properties)

字段的基本属性。

lifecycle

object (Lifecycle)

仅供输出。此字段的生命周期。

displayHints

object (DisplayHints)

仅供输出。用于渲染字段的界面显示提示。

schemaCapabilities

object (SchemaCapabilities)

仅供输出。修改此字段时该用户拥有的权限。

appliedCapabilities

object (AppliedCapabilities)

仅供输出。当标签应用于云端硬盘内容时,此用户拥有此字段的权限及其值。

creator

object (UserInfo)

仅供输出。创建此字段的用户。

createTime

string (Timestamp format)

仅供输出。此字段的创建时间。

updater

object (UserInfo)

仅供输出。修改此字段的用户。

updateTime

string (Timestamp format)

仅供输出。此字段的更新时间。

publisher

object (UserInfo)

仅供输出。发布此字段的用户。如果该字段未发布,此值没有任何意义。

disabler

object (UserInfo)

仅供输出。停用此字段的用户。如果字段未停用,此值没有任何意义。

disableTime

string (Timestamp format)

仅供输出。此字段停用的时间。如果字段未停用,此值没有任何意义。

lockStatus

object (LockStatus)

仅供输出。此字段的 LockStatus。

联合字段 type。此字段的数据类型和选项。数据类型一经发布便无法更改。type 只能是下列其中一项:
textOptions

object (TextOptions)

文本字段选项。

integerOptions

object (IntegerOptions)

整数字段选项。

dateOptions

object (DateOptions)

日期字段选项。

selectionOptions

object (SelectionOptions)

选择字段选项。

userOptions

object (UserOptions)

用户字段选项。

TextOptions

文本字段类型的选项。

JSON 表示法
{
  "minLength": integer,
  "maxLength": integer
}
字段
minLength

integer

仅供输出。文本字段的最小有效长度。

maxLength

integer

仅供输出。文本字段的最大有效长度。

IntegerOptions

整数字段类型的选项。

JSON 表示法
{
  "minValue": string,
  "maxValue": string
}
字段
minValue

string (int64 format)

仅供输出。整数字段的最小有效值。

maxValue

string (int64 format)

仅供输出。整数字段的最大有效值。

DateOptions

日期字段类型的选项。

JSON 表示法
{
  "dateFormatType": enum (DateFormat),
  "dateFormat": string,
  "minValue": {
    object (Date)
  },
  "maxValue": {
    object (Date)
  }
}
字段
dateFormatType

enum (DateFormat)

本地化的日期格式选项。字段值会根据其语言区域以这种格式呈现。

dateFormat

string

仅供输出。ICU 日期格式。

minValue

object (Date)

仅供输出。最小有效值(年、月、日)。

maxValue

object (Date)

仅供输出。最大有效值(年、月、日)。

DateFormat

本地化日期格式选项。

枚举
DATE_FORMAT_UNSPECIFIED 未指定日期格式。
LONG_DATE 包括月份的全名。例如,1999 年 1 月 12 日 (MMMM d, y)
SHORT_DATE 简短、数字、表示法。例如:12/13/99 (M/d/yy)

SelectionOptions

选择字段类型的选项。

JSON 表示法
{
  "listOptions": {
    object (ListOptions)
  },
  "choices": [
    {
      object (Choice)
    }
  ]
}
字段
listOptions

object (ListOptions)

指定后,则表示此字段支持值列表。此字段一经发布便无法更改。

choices[]

object (Choice)

此选择字段可用的选项。列表顺序一致,并且通过 insertBeforeChoice 进行了修改。

ListOptions

关联字段类型的多值变体的选项。

JSON 表示法
{
  "maxEntries": integer
}
字段
maxEntries

integer

允许的条目数上限。

多种选择

选择字段。

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)
  }
}
字段
id

string

所选择的唯一值。此 ID 是自动生成的。匹配正则表达式:([a-zA-Z0-9_])+

properties

object (Properties)

所选择的基本属性。

lifecycle

object (Lifecycle)

仅供输出。选择的生命周期。

displayHints

object (DisplayHints)

仅供输出。用于呈现选项的界面显示提示。

schemaCapabilities

object (SchemaCapabilities)

仅供输出。修改选项时与此选项相关的功能。

appliedCapabilities

object (AppliedCapabilities)

仅供输出。与所应用元数据的此选项相关的功能。

creator

object (UserInfo)

仅供输出。创建此选项的用户。

createTime

string (Timestamp format)

仅供输出。此选项的创建时间。

updater

object (UserInfo)

仅供输出。上次更新此选项的用户。

updateTime

string (Timestamp format)

仅供输出。此选项的上次更新时间。

publisher

object (UserInfo)

仅供输出。发布此选项的用户。如果所选项未发布,此值毫无意义。

publishTime

string (Timestamp format)

仅供输出。此选项的发布时间。如果所选项未发布,此值毫无意义。

disabler

object (UserInfo)

仅供输出。停用此选项的用户。如果未停用该选项,此值将没有任何意义。

disableTime

string (Timestamp format)

仅供输出。停用此选项的时间。如果未停用相应选项,此值将没有任何意义。

lockStatus

object (LockStatus)

仅供输出。此选择的 LockStatus。

属性

所选择的基本属性。

JSON 表示法
{
  "displayName": string,
  "description": string,
  "badgeConfig": {
    object (BadgeConfig)
  },
  "insertBeforeChoice": string
}
字段
displayName

string

必需。要在标识此字段的界面中显示的显示文本。

description

string

此标签的说明。

badgeConfig

object (BadgeConfig)

此选项的标记配置。设置完成后,拥有此选项的标签即被视为“已标记的标签”。

insertBeforeChoice

string

仅限输入。在指定选项之前插入或移动此选项。如果为空,则会将相应选项放在列表末尾。

BadgeConfig

标签的标记状态。

JSON 表示法
{
  "color": {
    object (Color)
  },
  "priorityOverride": string
}
字段
color

object (Color)

标志的颜色。如果未指定,则系统不会呈现任何标志。在云端硬盘界面中,此处设置的背景、前景和单曲(浅色和深色模式)颜色会更改为最接近的推荐颜色。

priorityOverride

string (int64 format)

替换此标志的默认全局优先级。如果设置为 0,则使用默认优先级启发法。

DisplayHints

用于呈现选项的界面显示提示。

JSON 表示法
{
  "disabled": boolean,
  "hiddenInSearch": boolean,
  "shownInApply": boolean,
  "badgeColors": {
    object (BadgeColors)
  },
  "darkBadgeColors": {
    object (BadgeColors)
  },
  "badgePriority": string
}
字段
disabled

boolean

此选项是否应在界面中显示为已停用。

shownInApply

boolean

将值应用于云端硬盘项时,此选项应显示在“应用”菜单中。

badgeColors

object (BadgeColors)

用于徽章的颜色。已根据所选的 properties.badge_config.color 更改为 Google Material 颜色。

darkBadgeColors

object (BadgeColors)

用于标志的深色模式颜色。已根据所选的 properties.badge_config.color 更改为 Google Material 颜色。

badgePriority

string (int64 format)

此徽章的优先级。用于比较多个徽章并对其进行排序。数字越小,表示应最先显示徽章。如果没有标志配置,此值将为 0。否则,将设置为 BadgeConfig.priority_override 或默认启发法,该启发法会优先选择标签的创建日期以及字段和选项优先级。

BadgeColors

派生自 BadgeConfig 的颜色,并已更改为最接近的推荐支持颜色。

JSON 表示法
{
  "backgroundColor": {
    object (Color)
  },
  "foregroundColor": {
    object (Color)
  },
  "soloColor": {
    object (Color)
  }
}
字段
backgroundColor

object (Color)

仅供输出。与前景配对的标记背景。

foregroundColor

object (Color)

仅供输出。标记与背景配对的前景。

soloColor

object (Color)

仅供输出。可用于没有背景的文字的颜色。

SchemaCapabilities

修改选项时与此选项相关的功能。

JSON 表示法
{
  "canUpdate": boolean,
  "canDelete": boolean,
  "canDisable": boolean,
  "canEnable": boolean
}
字段
canUpdate

boolean

用户是否可以更新此选项。

canDelete

boolean

用户是否可以删除此选项。

canDisable

boolean

用户是否可以停用此选项。

canEnable

boolean

用户是否可以启用此选项。

AppliedCapabilities

与所应用元数据的此选项相关的功能。

JSON 表示法
{
  "canRead": boolean,
  "canSearch": boolean,
  "canSelect": boolean
}
字段
canRead

boolean

用户是否可以读取项上已应用的相关元数据。

canSelect

boolean

用户是否可以为某个项选择此选项。

LockStatus

包含有关是否应将标签组成部分视为锁定状态的信息。

JSON 表示法
{
  "locked": boolean
}
字段
locked

boolean

仅供输出。指示此标签组件是否为 LabelLock 的(直接)目标。标签组件即使不是 LabelLock 的直接目标,也可以隐式锁定,在这种情况下,此字段设置为 false。

UserOptions

用户字段类型的选项。

JSON 表示法
{
  "listOptions": {
    object (ListOptions)
  }
}
字段
listOptions

object (ListOptions)

指定后,则表示此字段支持值列表。此字段一经发布便无法更改。

属性

字段的基本属性。

JSON 表示法
{
  "displayName": string,
  "required": boolean,
  "insertBeforeField": string
}
字段
displayName

string

必需。要在标识此字段的界面中显示的显示文本。

required

boolean

字段是否应标记为必填字段。

insertBeforeField

string

仅限输入。在指定字段之前插入或移动此字段。如果为空,则将该字段放在列表末尾。

DisplayHints

用于渲染字段的界面显示提示。

JSON 表示法
{
  "required": boolean,
  "disabled": boolean,
  "hiddenInSearch": boolean,
  "shownInApply": boolean
}
字段
required

boolean

此字段是否应在界面中显示为必填。

disabled

boolean

此字段是否应在界面中显示为已停用。

shownInApply

boolean

将值应用于云端硬盘项时,此字段应显示在“应用”菜单中。

SchemaCapabilities

修改字段时与此字段相关的功能。

JSON 表示法
{
  "canUpdate": boolean,
  "canDelete": boolean,
  "canDisable": boolean,
  "canEnable": boolean
}
字段
canUpdate

boolean

用户是否可以更改此字段。

canDelete

boolean

用户是否可以删除此字段。用户必须拥有相应权限,且该字段必须弃用。

canDisable

boolean

用户是否可以停用此字段。用户必须拥有相应权限,且此字段必须处于已停用状态。

canEnable

boolean

用户是否可以启用此字段。用户必须拥有相应权限,且此字段必须停用。

AppliedCapabilities

与此字段相关的功能,适用于所应用的元数据。

JSON 表示法
{
  "canRead": boolean,
  "canSearch": boolean,
  "canWrite": boolean
}
字段
canRead

boolean

用户是否可以读取项上已应用的相关元数据。

canWrite

boolean

用户是否可以为云端硬盘内容设置此字段。

方法

create

创建新标签。

delete

永久删除云端硬盘内容的标签和相关元数据。

delta

通过应用一组更新请求来更新单个标签,从而生成新的草稿修订版本。

disable

停用已发布的标签。

enable

启用已停用的标签,并将其恢复为发布状态。

get

按资源名称获取标签。

list

列出标签。

publish

发布对标签的所有草稿更改。

updateLabelCopyMode

更新标签的 CopyMode

updatePermissions

更新标签的权限。