停用、启用和删除标签

本文档介绍了如何执行以下涉及标签的任务:

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

停用标签

停用标签会基于当前已发布的修订版本生成新的已停用已发布修订版本。如果有草稿修订版本,则会基于最新的草稿修订版本生成新的已停用草稿修订版本。较旧的草稿修订版本会被删除。如需了解详情,请参阅标签 生命周期。

停用后,用户仍可以通过 Google 云端硬盘 Labels API 应用此标签。该标签仍会显示在已应用该标签的位置和搜索结果中。 已停用的标签可以删除。

如需停用已发布的标签,请对 disable资源使用 labels方法。

您还必须指定:

  • 代表标签的 labels 资源。它包含 name 和 id, 后者是标签的全局唯一标识符。

  • useAdminAccess 查询参数设置为 true,以使用用户的管理员 凭据。在允许访问之前,服务器会验证用户是否拥有 所需的 管理分类 标签 管理员权限。

以下代码示例展示了如何使用标签的 id 来停用正确的标签:

Python

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

Node.js

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

将 ID 替换为要停用的标签的 ID。

该标签的 State为DISABLED ,并且标签的修订版本 ID 会递增。用户可以通过 Drive Labels API 应用该标签。不过,除非配置了 showInApply 字段,否则已停用的标签不会显示在界面中。DisabledPolicy

启用标签

启用已停用的标签会将其恢复为已发布状态。它会基于当前已停用的已发布修订版本生成新的已发布修订版本。如果存在已停用的草稿修订版本,则会基于该草稿生成新的修订版本并启用。如需了解详情,请参阅标签 生命周期。

如需启用已停用的标签,请对 enable资源使用 labels方法。

您还必须指定:

  • 代表标签的 labels 资源。它包含 name 和 id, 后者是标签的全局唯一标识符。

  • useAdminAccess 查询参数设置为 true,以使用用户的管理员 凭据。在允许访问之前,服务器会验证用户是否拥有 所需的 管理分类 标签 管理员权限。

以下代码示例展示了如何使用标签的 id 来启用正确的标签:

Python

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

Node.js

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

将 ID 替换为要启用的标签的 ID。

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

删除标签

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

如需删除标签,您必须先停用该标签,然后对 delete资源使用 labels方法。

您还必须指定:

  • 代表标签的 labels 资源。它包含 name 和 id, 后者是标签的全局唯一标识符。

  • useAdminAccess 查询参数设置为 true,以使用用户的管理员 凭据。在允许访问之前,服务器会验证用户是否拥有 所需的 管理分类 标签 管理员权限。

以下代码示例展示了如何使用标签的 id 来删除正确的标签:

Python

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

Node.js

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

将 ID 替换为要删除的标签的 ID。

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