创建和发布标签

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

创建标签

要创建标签,请使用 create 方法(在 “labels”集合。标签可以 可以视需要包含一个或多个 Fields

您还必须指定以下内容:

  • 一个 LabelType

  • 标签 title 通过 property 方法。

  • useAdminAccesstrue,以使用用户的管理员凭据。通过 服务器通过“管理标签”验证用户是否为管理员特权 然后才能授予访问权限。

此示例创建了一个带有指定标题和 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 可设置为“长:月 DD, YYYY”或“短:MM/DD/YY”
TextOptions 在文本框中输入文字 支持的字符数上限为 100
UserOptions 从 Google Workspace 联系人中选择一位或多位用户。 根据 ListOptions 中的配置,一个文件的用户条目数量上限为 10 个

发布标签

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

要发布标签,请使用 publish 方法并指定以下内容:

  • 标签资源 来代表每个标签。它包含一个资源 NameID, 是标签的全局唯一标识符。

  • useAdminAccesstrue,以使用用户的管理员凭据。通过 服务器通过“管理标签”验证用户是否为管理员特权 然后才能授予访问权限。

此示例使用 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 递增。然后,用户便可以看到该标签。 文件。有关详情,请参阅标签 生命周期

发布标签时的限制条件

  • 标签发布后将无法恢复为原始草稿状态。有关 相关信息,请参阅标签生命周期

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

  • 某些更改一旦发布,便不再接受。一般来说,这意味着 导致现有 会被拒绝。例如,以下 不允许在标签发布后对其进行更改:

    • 系统会直接删除该标签。(必须先将其停用,然后 deleted.)
    • Field.FieldType 已更改。
    • 更新“字段验证”选项时会拒绝之前的内容 接受。
    • 减少了最大条目数。