添加自定义文件属性

自定义文件属性是用于存储 Google 云端硬盘文件（例如代码）、来自其他数据存储区的 ID、信息 例如工作流应用之间共享。例如，您可以添加文件 属性应用于销售部门在第一季度生成的所有文档。

如需添加对所有应用可见的属性，请使用properties files 资源。添加属性 则使用 files 资源的 appProperties 字段。

属性还可用于搜索 表达式。

这是典型属性的结构，可能用于存储 文件中的云端硬盘文件数据库 ID。

云端硬盘 API v3

"appProperties": {
  "additionalID": "ID",
}

云端硬盘 API v2

{
  'key':        'additionalID',
  'value':      'ID',
  'visibility': 'PRIVATE'
}

使用自定义文件属性

本部分介绍了如何执行一些与自定义文件属性相关的任务， 影响所有应用

添加或更新自定义文件属性

要添加或更新对所有应用可见的属性，请使用 files.update 方法，用于设置 files 的 properties 字段 资源。

PATCH https://www.googleapis.com/drive/v3/files/FILE_ID
{
  "properties": {
    "name": "wrench",
    "mass": "1.3kg",
    "count": "3"
  }
}

您还可以使用 Google Apps 脚本中的云端硬盘服务。如需了解详情，请参阅 添加自定义 属性。

获取或列出自定义文件属性

要查看对所有应用可见的属性，请使用 files.get 方法检索 自定义文件属性。

GET https://www.googleapis.com/drive/v3/files/FILE_ID?fields=properties

响应包含一个 properties 对象，该对象包含一系列 键值对。

{
  "properties": {
    "name": "wrench",
    "mass": "1.3kg",
    "count": "3"
  }
}

删除自定义文件属性

要删除对所有应用可见的属性值，请使用 files.update 方法，用于设置 files 的 properties 字段 将资源设为 null。

PATCH https://www.googleapis.com/drive/v3/files/FILE_ID
{
  "name": null
}

要查看更改，请调用 files.get 方法检索 properties 对象。

{
  "properties": {
    "mass": "1.3kg",
    "count": "3"
  }
}

自定义文件属性的限制

自定义属性有以下限制：

  • 每个文件最多包含 100 个自定义属性，总计来自所有来源。
  • 每个文件最多包含 30 个公共属性，总计来自所有来源。
  • 任何一个应用的每个文件最多包含 30 个私有属性。
  • 每个属性字符串（包括键和值）不得超过 124 个字节 UTF-8 编码。例如，某个属性具有长度为 10 个字符的键 值中只能包含 114 个字符。同样， 值最多可使用 24 个字符 键。

如需了解详情，请参阅 files 资源。对于 Drive API v2，请参阅 properties 资源。

访问不公开的自定义文件属性

您只能通过以下方法使用 appProperties 字段检索私有属性： 使用通过 OAuth 2.0 获取的访问令牌的经过身份验证的请求 客户端 ID。您无法使用 API 密钥检索私有属性。