本文档介绍了为文件命名和使用元数据(例如可编入索引的文本和缩略图)时的重要注意事项。如需插入和检索文件,请参阅 files
资源。
指定文件名和扩展名
使用 Google Drive API 插入文件时,应用应在 title 属性中指定文件扩展名。例如,用于插入 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
资源。
检索缩略图
您可以检索云端硬盘文件的元数据,包括缩略图。缩略图信息位于 files
资源的 thumbnailLink
字段中。
返回特定缩略图
以下代码示例展示了一个 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)