停用、启用和删除标签

本页面介绍了如何执行以下涉及标签的任务：

  • 停用标签
  • 启用标签
  • 删除标签

停用标签

停用标签会导致系统基于当前已发布的修订版本创建一个新的已停用的已发布修订版本。如果存在草稿修订版本，系统会根据最新的草稿修订版本创建一个新的已停用的草稿修订版本。较旧的草稿修订版本会被删除。如需了解详情，请参阅标签生命周期。

停用后，用户仍可通过 API 应用此标签。已应用此标签的位置和搜索结果中仍会显示此标签。已停用的标签可以删除。

如需停用已发布的标签，请对 labels 集合使用 disable 方法。

您还必须指定：

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

  • useAdminAccess 是 true，表示使用用户的管理员凭据。服务器会先验证用户是否是相应标签的管理员，然后再允许用户访问。

此示例使用 ID 停用正确的标签。

Python

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

Node.js

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

标签的 State 为 DISABLED，并且标签的修订版本 ID 会递增。用户可以通过 API 应用标签。不过，除非配置了 disabledPolicy 方法的 showInApply 属性，否则界面中不会显示已停用的标签。

启用标签

启用已停用的标签会将其恢复为已发布状态。这会基于当前已停用的已发布修订版本生成新的已发布修订版本。如果存在已停用的现有草稿修订版本，系统会基于该草稿创建一个新修订版本并启用该版本。如需了解详情，请参阅标签生命周期。

如需启用已停用的标签，请使用 enable 方法。

您还必须指定：

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

  • useAdminAccess 是 true，表示使用用户的管理员凭据。服务器会先验证用户是否是相应标签的管理员，然后再允许用户访问。

此示例使用 ID 来启用正确的标签。

Python

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

Node.js

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

标签的 State 为 PUBLISHED，并且标签的修订版本 ID 会递增。用户可以通过 API 查看标签并将其应用于文件。

删除标签

只能删除草稿标签和已停用的标签。删除标签后，先前应用该标签的所有实例（包括用户输入的所有相应字段值）将会永久删除并从这些云端硬盘文件中移除。

如需删除标签，您必须先将其停用，然后使用 delete 方法。

您还必须指定：

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

  • useAdminAccess 是 true，表示使用用户的管理员凭据。服务器会先验证用户是否是相应标签的管理员，然后再允许用户访问。

此示例使用 ID 删除正确的标签。

Python

response = service.labels().delete(
  name='labels/ID',
  useAdminAccess=True).execute()

Node.js

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

标签的 State 为 DELETED，并且标签的修订版本 ID 会递增。标签无法应用，并且已删除的标签最终会被清除。如需了解详情，请参阅标签生命周期。