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 ->（已删除）

发布状态和停用状态具有一些明显的特征：

  • Published：此状态下的对象可能会发生某些类型的更改，在这种情况下，hasUnpublishedChanges 将为 true。此外，我们不允许进行某些类型的更改。一般来说，任何会使与标签相关的现有元数据失效或导致对这些元数据施加新限制的更改都会被拒绝。
  • Disabled：如果停用，则配置的 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 如果应用标签的用户可以应用该标签，系统会复制已应用的标签和字段值。

字段

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

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

在将值应用于 Google 云端硬盘项目时，此选项应显示在应用菜单中。
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

仅限输出。指示相应标签组件是否是标签锁的（直接）目标。即使标签组件不是标签锁的直接目标，也可以隐式锁定，在这种情况下，此字段会设置为 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

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

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

描述可使用相应标签的 Google Workspace 应用。

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

object (EnabledApp)

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

EnabledApp

可使用相应标签的应用。

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

enum (App)

可选。应用的名称。

应用

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

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

方法

create

 创建标签。

delete

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

delta

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

disable

 停用已发布的标签。

enable

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

get

 按资源名称获取标签。

list

 列出标签。

publish

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

updateLabelCopyMode

 更新标签的 CopyMode。

updateLabelEnabledAppSettings

 更新标签的 EnabledAppSettings。

updatePermissions

 更新标签的权限。