创建和发布标签

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

创建标签

如需创建标签，请对 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
文件最多可有 10 个选项（在 ListOptions 中配置）
IntegerOptions 输入数值 仅支持整数
DateOptions 选择日历日期 （可选）Date format 可设置为“长格式：Month DD, YYYY”或“短格式：MM/DD/YY”
TextOptions 在文本框中输入文字 支持的字符数上限为 100
UserOptions 从 Google Workspace 通讯录中选择一个或多个用户。 根据 ListOptions 中的配置，一个文件的用户条目数上限为 10

发布标签

借助 Labels 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 已更改。
    • 对字段验证选项的更新会拒绝之前接受的内容。
    • 减少了最大条目数。