创建和发布标签

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

创建标签

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

您还必须指定：

  • A LabelType。

  • 通过 property方法指定标签title。

  • 将 useAdminAccess 设置为 true，以使用用户的管理员凭据。服务器会先验证用户是否是具有“管理标签”权限的管理员，然后再允许访问。

此示例会创建一个具有指定标题的标准管理员标签，其中包含一个 SelectionOptions Field 和 2 个 Choices。

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 可以设置为“Long: Month DD, YYYY”或“Short: MM/DD/YY“
TextOptions 在文本框中输入文本 支持的字符数上限为 100
UserOptions 从 Google Workspace 通讯录中选择一个或多个用户。 根据 ListOptions 中的配置，每个文件的用户条目数上限为 10

发布标签

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

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

  • 一个 Label 资源 ，用于表示每个标签。它包含资源 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。
    • 对字段验证选项的更新会拒绝之前接受的内容。
    • 减少条目数上限。