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}，具体取决于请求。请参阅下面的“id”和“revisionId”。
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

标签的说明。

Lifecycle

对象的生命周期状态，例如标签、字段或选择。生命周期强制执行以下转换：

  • 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)

日期

表示整个或部分日历日期（例如生日）。一天中的时间和时区要么在别处指定，要么不重要。日期相对于公历。可以表示以下任一情况：

  • 包含非零年份、月份和天值的完整日期。
  • 月份和天，年份值为零（例如周年纪念日）。
  • 单独的年份，月份和天值为零。
  • 年份和月份，天值为零（例如，信用卡到期日期）。

相关类型：

JSON 表示法 
{
  "year": integer,
  "month": integer,
  "day": integer
}
字段
year

integer

日期中的年份。必须介于 1 到 9999 之间，或为 0（即指定不含年份的日期）。
month

integer

一年中的第几个月。必须介于 1 到 12 之间，或为 0（即只指定年份，不指定月份和天值）。
day

integer

一个月中的第几天。必须介于 1 到 31 之间并且对年份和月份有效，或为 0（即天不重要，指定单独的年份或者年份和月份）。

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，则使用默认优先级启发法。

颜色

表示 RGBA 颜色空间中的一种颜色。这种表示法旨在简化与各种语言中的颜色表示法之间的转换，而不是紧凑的转换。例如，在 Java 中，可以轻松地将此表示法的字段提供给 java.awt.Color 的构造函数；在 iOS 中，也可以轻松地将其提供给 UIColor 的 +colorWithRed:green:blue:alpha 方法；只需少量工作，即可轻松将其格式化为采用 JavaScript 的 CSS rgba() 字符串。

此参考页面不包含解读 RGB 值时应使用的绝对颜色空间，例如 sRGB、Adobe RGB、DCI-P3 和 BT.2020。默认情况下，应用应采用 sRGB 颜色空间。

在需要确定颜色均等性时，除非另有说明，否则如果两种颜色的红色、绿色、蓝色和 alpha 值都相差不超过 1e-5，则将相应实现视为相等。

示例 (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();
 }
 // ...

示例 (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;
}
// ...

示例 (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('');
};

// ...
JSON 表示法 
{
  "red": number,
  "green": number,
  "blue": number,
  "alpha": number
}
字段
red

number

颜色中红色的量，以区间 [0, 1] 中的值表示。
green

number

颜色中绿色的量，以区间 [0, 1] 中的值表示。
blue

number

颜色中的蓝色量，以 [0, 1] 区间中的值表示。
alpha

number

此颜色在像素中的应用比例。也就是说，最终像素颜色由以下等式定义：

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

也就是说，值为 1.0 表示纯色，而值为 0.0 表示完全透明的颜色。它会使用封装容器消息，而非简单的浮动标量，以便区分默认值和未设置的值。如果省略，此颜色对象会渲染为纯色（就好像已经将 Alpha 值明确指定为 1.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

 更新标签的权限。