创建和发布标签

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

创建标签

如需创建标签，请对 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

发布标签

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