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)
  },
  "enabledAppSettings": {
    object (EnabledAppSettings)
  }
}
字段
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。
enabledAppSettings

object (EnabledAppSettings)

可选。此标签的 EnabledAppSettings。

LabelType

此标签的类型。

枚举
LABEL_TYPE_UNSPECIFIED 标签类型未知。
SHARED 系统可能会与用户共享共享标签，以便用户将其应用于云端硬盘内容。
ADMIN 归管理员所有的标签。只有管理员可以创建和修改此类角色。支持一些仅限管理员使用的其他功能。
GOOGLE_APP 归 Google 内部应用（而非客户）所有的标签。这些标签是只读的。

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（月/日/年）

日期

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

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

相关类型：

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

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

EnabledAppSettings

介绍可在哪些 Workspace 应用中使用标签。

JSON 表示法 
{
  "enabledApps": [
    {
      object (EnabledApp)
    }
  ]
}
字段
enabledApps[]

object (EnabledApp)

可选。可使用此标签的应用列表。

EnabledApp

可使用该标签的应用。

JSON 表示法 
{
  "app": enum (App)
}
字段
app

enum (App)

可选。应用的名称。

应用

可使用标签的一组可能的 Workspace 应用。

枚举
APP_UNSPECIFIED 未指定
DRIVE 云端硬盘。
GMAIL Gmail

方法

create

 创建新标签。

delete

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

delta

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

disable

 停用已发布的标签。

enable

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

get

 按资源名称获取标签。

list

 列出标签。

publish

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

updateLabelCopyMode

 更新标签的 CopyMode。

updateLabelEnabledAppSettings

 更新标签的 EabledAppSettings。

updatePermissions

 更新标签的权限。