管理文件元数据

本文档介绍了命名文件和使用 例如可编入索引的文本和缩略图要插入和检索文件,请参阅 files 资源。

指定文件名和扩展名

在插入文件时,应用应在标题属性中指定文件扩展名 使用 Google Drive API例如,插入 JPEG 文件的操作 在元数据中指定类似 "name": "cat.jpg" 的内容。

后续的 GET 响应可以包含只读 fileExtension 属性 填充为最初在 name 属性中指定的扩展名。当 Google 云端硬盘用户请求下载文件或文件下载时 云端硬盘会生成一个完整的文件名(其中包含 )。如果缺少扩展程序 云端硬盘会尝试根据文件的 MIME 类型。

保存可编入索引的文本

云端硬盘会自动将文档编入索引以供搜索 可识别文件类型,包括文本文档、PDF、带文本的图片和 其他常见类型。如果您的应用保存其他类型的文件(例如绘图、 视频和快捷方式),则可以提供 文件的 contentHints.indexableText 字段中包含可编入索引的文本。

可编入索引的文本会以 HTML 的形式编入索引。如果您保存可编入索引的文本字符串 <section attribute="value1">Here's some text</section>,然后点按“以下是一些 文本”已编入索引,但“value1”则不是。因此,将 XML 保存为可编入索引的内容 文本不如保存 HTML 那么有用。

指定 indexableText 时,另请注意:

  • contentHints.indexableText 的大小上限为 128 KB。
  • 捕获您希望用户搜索的关键术语和概念。
  • 不要尝试按重要性对文本进行排序,因为索引器会这样做 。
  • 您的应用应在每次保存时更新可索引文本。
  • 请确保文本与文件内容或元数据相关。

最后一点看似很明显,但却非常重要。最好不要 添加常用搜索字词,强制文件显示在搜索结果中。这个 可能会令用户感到沮丧,甚至可能促使他们删除文件。

上传缩略图

云端硬盘会自动为许多常见文件生成缩略图 例如 Google 文档、表格和幻灯片 缩略图有助于用户更好地识别云端硬盘文件。

适用于云端硬盘无法生成标准缩略图的文件类型 您可以提供您的应用生成的缩略图中 创建或更新文件时,如要上传缩略图,请将 files 资源的 contentHints.thumbnail 字段。

具体而言:

  • contentHints.thumbnail.image 字段设置为安全的网址和文件名 base64 编码的图片(请参阅 RFC 4648 部分) 5)。
  • contentHints.thumbnail.mimeType 字段设置为相应的 MIME 类型 用作缩略图

如果云端硬盘可以通过该文件生成缩略图,则会使用 并忽略您可能已上传的任何内容。如果无法使用 生成缩略图时,系统会使用您提供的缩略图

缩略图应遵循以下规则:

  • 可采用 PNG、GIF 或 JPG 格式上传。
  • 建议宽度为 1600 像素。
  • 最小宽度为 220 像素。
  • 文件大小上限为 2 MB。
  • 您的应用应该在每次保存时更新它们。

如需了解详情,请参阅 files 资源。

检索缩略图

您可以检索云端硬盘文件的元数据,包括缩略图。 缩略图信息存储在thumbnailLink files 资源。

返回特定缩略图

以下代码示例展示了 files.get 方法请求,其中包含 多个字段作为查询参数,以返回其 thumbnailLink 元数据 特定文件。有关详情,请参阅返回特定字段的 文件

GET https://www.googleapis.com/drive/v3/files/FILE_ID?fields=id,name,mimeType,thumbnailLink

FILE_ID 替换为您要删除的文件的 fileId 查找。

如果有,请求会返回文件缩略图的短期网址。 通常,该链接会持续几个小时。只有当 发出请求的应用可以访问该文件的内容。如果文件未共享 thumbnailLink 中返回的网址必须使用 基于凭据的请求

返回缩略图列表

以下代码示例展示了 files.list 方法请求,其中包含 多个字段作为查询参数,以返回其 thumbnailLink 元数据 文件列表。有关详情,请参阅搜索文件和 文件夹

GET https://www.googleapis.com/drive/v3/files/?fields=files(id,name,mimeType,thumbnailLink)

要将搜索结果限制为特定的文件类型,请将查询字符串应用于 设置 MIME 类型。例如,以下代码示例展示了如何限制 列表转换为 Google 表格文件。有关 MIME 类型的详情,请参见 Google Workspace 和 Google 云端硬盘支持的 MIME 类型

GET https://www.googleapis.com/drive/v3/files/q=mimeType='application/vnd.google-apps.spreadsheet'&fields=files(id,name,mimeType,thumbnailLink)