Drive Labels API 概览

标签是您指定的元数据,可帮助用户整理和查找 Google 云端硬盘中的文件,以及针对这些文件应用政策。Drive Labels API 是一种 RESTful API,可通过将元数据附加到云端硬盘文件来支持业务流程。此 API 的常见用途包括:

  • 将内容分类以遵循信息治理策略 - 创建标签以标识敏感内容或需要特殊处理的数据。 例如,您可以创建一个名为“敏感度”的带标记的标签(具有颜色编码的选项值的标签),其值为“绝密”“机密”和“公开”。

  • 为云端硬盘中的内容应用政策 - 创建标签,以便在云端硬盘内容的整个生命周期内对其进行管理,并确保其遵循贵组织的记录保留做法。例如,您可以使用标签来管理数据泄露防护 (DLP) 政策,根据该政策,如果文件的“敏感度”标签设置为“绝密”,则无法将该文件下载到计算机。

  • 挑选和查找文件 - 创建标签,以提高公司内容的可搜索性,让贵组织中的用户能够根据标签及其字段查找内容。例如,贵组织中的用户可以使用云端硬盘搜索选项来查找需要在特定日期之前签字的所有合同。

以下是云端硬盘标签 API 中使用的常见术语列表:

标签

放置在云端硬盘文件上的结构化元数据。 云端硬盘用户可以为文件分配标签并设置标签字段值。标签由以下部分组成:

标签名称
标签的资源名称。标签 ID 构成了标签名称的一部分。根据请求的不同,名称采用以下两种形式之一:labels/{id}labels/{id}@{revisionId}。如需了解详情,请参阅下文中的标签修订版本
标签 ID
标签的全局唯一标识符。ID 构成标签名称的一部分,但与名称不同的是,它在修订版本之间保持一致。

标签有 2 种样式:

带标记的标签

一种具有 SelectionOptions 字段类型的标签,其中包含可进行颜色编码以指示重要性的选项。这是通过 ChoiceProperties 设置 badgeConfig 来完成的。

云端硬盘会为每个文件显示所选选项的颜色,以便用户清楚了解文件的状态、分类等。 例如,带有“敏感度”徽章标签的“机密”选项可能会以红色显示。您一次只能拥有一个带有标记的标签。

标准标签

包含零个或多个字段类型的标签。标准标签可能包含标签标题(例如“Project Moonshot”),并指示与该项目相关的所有文件。标准标签还可以包含多个结构化字段。例如,标题为“合同”的标签可能包含“公司”“截止日期”“状态”和“签署人”等字段。每个字段都具有特定的类型(文本、日期、选择或用户)。

带标记的标签示意图。
图 1. 带标记的标签
标准标签图。
图 2. 标准标签
字段

标签的单个可设置的类型化组成部分。一个标签可以关联零个或多个字段。

字段类型
字段关联的值的数据类型。可配置为文本、整数、日期、用户或选择。如果您使用 ListOptions 配置该字段,则可以为用户和选择字段设置多个值。所选类型会影响适用于 Google 云端硬盘项目的有效值和可用的搜索查询选项。
选择

用户可在 SelectionOptions 字段中选择的多个选项之一。

标签类型

所有标签都包含 LabelType。标签分为以下两种类型:

管理

如需创建和修改管理员拥有的标签,您必须是账号管理员,并拥有管理标签权限。

管理员可以与任何用户共享管理员标签,以授予该用户查看这些标签并将其应用于云端硬盘内容的能力。修改或读取云端硬盘项目上的标签值需要以下权限:

  • 修改 - 如果用户要修改与指定标签相关的云端硬盘项目元数据,则必须拥有相应的权限级别:

    • 云端硬盘内容:EDITOR
    • 标签:APPLIER
  • 读取 - 用户必须拥有适当的权限级别,才能读取或搜索与指定标签相关的云端硬盘项目元数据:

    • 云端硬盘内容:READER
    • 标签:READER
Shared

非管理员用户可以创建共享标签,供其他用户应用于云端硬盘内容。团队可以创建和整理自己的标签,以便在团队内使用,而无需管理员。

标签分类

用户目前可用于云端硬盘文件的已配置标签字段。也称为标签架构。

标签分类法示例:

  • 敏感度 - 红色、橙色、黄色、绿色
  • 状态 - 尚未开始、草稿、审核中、最终
  • 内容类型 - 合同、设计文档、视觉稿
  • 部门 - 市场营销、财务、人力资源、销售
标签生命周期

标签会经历创建、发布、更新等生命周期阶段。当标签历经生命周期时,其标签修订版本会递增。如需了解详情,请参阅标签生命周期

标签修订

标签的实例。每次创建、更新、发布或弃用标签时,标签修订版本都会递增。

草稿修订版本
标签当前草稿实例的修订版本号。您可以对标签进行多次更新,每次更新都会增加其草稿修订版本号,但不会影响已发布的修订版本。借助草稿标签功能,您可以在发布之前测试标签更新。
已发布的修订版本
已发布标签版本的修订版本号。已发布的标签是当前可供用户使用的标签实例。