添加自定义文件属性

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

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

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

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

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

使用自定义文件属性

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

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

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方法将 properties字段的files 资源设置为 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 个私有属性。
采用 UTF-8 编码时，每个属性字符串（包括键和值）最多 124 个字节。例如，键长为 10 个字符的属性的值只能包含 114 个字符。同样，需要 100 个字符作为值的属性最多可以使用 24 个字符作为键。

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

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