创建和发布标签

本页面介绍了如何创建和发布标签。

创建标签

如需创建标签，请对 labels 集合使用 create 方法。标签可以视需要包含一个或多个 Fields。

您还必须指定以下内容：

  • 一个 LabelType。

  • 通过 property 方法添加 title 标签。

  • useAdminAccess 为 true，以使用用户的管理员凭据。在允许访问之前，服务器会验证用户是否是拥有“管理标签”权限的管理员。

此示例会创建一个带有指定标题的标准管理员标签，以及一个带有 2 个 Choices 的 SelectionOptions Field。

Python

label_body = {
'label_type': 'ADMIN',
'properties': {
    'title': 'TITLE'
},
'fields': [{
    'properties': {
        'display_name': 'DISPLAY_NAME'
    },
    'selection_options': {
        'list_options': {},
        'choices': [{
            'properties': {
                'display_name': 'CHOICE_1'
            }
        }, {
            'properties': {
                'display_name': 'CHOICE_2'
            }
        }]
    }
}]
}
response = service.labels().create(
    body=label_body, useAdminAccess=True).execute()

Node.js

var label = {
'label_type': 'ADMIN',
'properties': {
    'title': 'TITLE'
},
'fields': [{
    'properties': {
    'display_name': 'DISPLAY_NAME'
    },
    'selection_options': {
    'list_options': {},
    'choices': [{
        'properties': {
        'display_name': 'CHOICE_1'
        }
    }, {
        'properties': {
        'display_name': 'CHOICE_2'
        }
    }]
    }
}]
};

service.labels.create({
  'resource': label,
  'use_admin_access': true
}, (err, res) => {
if (err) return console.error('The API returned an error: ' + err);
  console.log(res);
});

该标签在 UNPUBLISHED_DRAFT State 中创建。它必须为 PUBLISHED，才能用于文件并对用户可见。如需了解详情，请参阅标签生命周期。

标签限制

创建和应用标签时适用以下限制：

  • 标准标签 - 150
  • 每个标签的字段数 - 10
  • 用户为每个文件应用的标签 - 5 个

使用标签中的字段

Field Type 用户可执行的操作 格式注意事项和限制
SelectionOptions 从列表中选择一个或多个选项 支持的选项数量上限为 200 个
根据 ListOptions 中的配置，一个文件的选择数量上限为 10 个
IntegerOptions 请输入数值 仅支持整数
DateOptions 选择日历日期 （可选）Date format 可设置为“长：月 DD, YYYY”或“短：MM/DD/YY”
TextOptions 在文本框中输入文字 支持的字符数上限为 100
UserOptions 从 Google Workspace 联系人中选择一位或多位用户。 根据 ListOptions 中的配置，一个文件的用户条目数量上限为 10 个

发布标签

借助标签 API，您可以在完成后发布草稿标签。

如需发布标签，请使用 publish 方法并指定：

  • 表示每个标签的标签资源。它包含资源 Name 和 ID，这是标签的全局唯一标识符。

  • useAdminAccess 为 true，以使用用户的管理员凭据。在允许访问之前，服务器会验证用户是否是拥有“管理标签”权限的管理员。

此示例使用 ID 来识别和发布正确的标签。

Python

service.labels().publish(
name='labels/ID',
body={
  'use_admin_access': True
}).execute()

Node.js

service.labels.publish({
  'resource': {
    'use_admin_access': true
},
'name': 'labels/ID'
}, (err, res) => {
  if (err) return console.error('The API returned an error: ' + err);
  console.log(res);
});

标签发布后，该标签会移至 PUBLISHED State，并且标签的修订版本 ID 会递增。该标签随后对用户可见，并且可以应用于文件。如需了解详情，请参阅标签生命周期。

发布标签时的限制条件

  • 标签发布后将无法恢复为原始草稿状态。如需了解详情，请参阅标签生命周期。

  • 发布标签会创建一个新发布的修订版本。之前的所有草稿修订版本都将被删除。之前发布的修订版本会保留下来，但会根据需要自动删除。

  • 某些更改一旦发布，便不再接受。通常，这意味着任何会导致与标签相关的现有元数据失效或触发新限制的更改都会被拒绝。例如，在标签发布后，不允许对标签进行以下更改：

    • 系统会直接删除该标签。（必须先将其停用，然后才能将其删除。）
    • Field.FieldType 已更改。
    • 对字段验证选项的更新会拒绝以前接受的内容。
    • 减少了最大条目数。