借助 Google Drive API,您可以在创建或更新 File
时上传文件数据。如需了解如何创建仅包含元数据的文件(例如文件夹),请参阅创建仅包含元数据的文件。
您可以执行的上传操作有以下三种:
简单上传 (
uploadType=media
):使用此上传类型可传输小型媒体文件(不超过 5 MB),而无需提供元数据。如需执行简单上传,请参阅执行简单上传。多部分上传 (
uploadType=multipart
):“使用此上传类型可在单个请求中传输小文件(5 MB 或更小)以及描述该文件的元数据。如需执行多部分上传,请参阅执行多部分上传。可续传上传 (
uploadType=resumable
):对于大文件(大于 5 MB)以及网络中断可能性较大的情况(例如通过移动应用创建文件时),请使用此上传类型。对于大多数应用来说,可续传上传也是一种很好的方式,因为该方式也适用于小型文件(只不过每次上传时都要多发出一个 HTTP 请求)。如需执行可续传上传,请参阅执行可续传上传。
Google API 客户端库至少会实现其中一种上传类型。如需详细了解如何使用每种类型,请参阅客户端库文档。
使用“PATCH
”而非“PUT
”
温馨提示:HTTP 动词 PATCH
支持部分文件资源更新,而 HTTP 动词 PUT
支持完整资源替换。请注意,向现有资源添加新字段时,PUT
可能会引入重大更改。
上传文件资源时,请遵循以下准则:
- 使用 API 参考文档中记录的 HTTP 动词作为可续传上传的初始请求,或作为简单上传或分段上传的唯一请求。
- 请求开始后,对于可恢复上传的所有后续请求,请使用
PUT
。无论调用的方法如何,这些请求都会上传内容。
执行简单上传
如需执行简单的上传,请将 files.create
方法与 uploadType=media
搭配使用。
以下示例展示了如何执行简单的上传:
HTTP
创建一个针对方法的 /upload URI 的
POST
请求,并设置查询参数uploadType=media
:POST https://www.googleapis.com/upload/drive/v3/files?uploadType=media
将文件的数据添加到请求正文。
添加以下 HTTP 标头:
Content-Type
。请将此项设为要上传的对象的 MIME 媒体类型。Content-Length
。请将此项设为您上传的字节数。如果您使用的是分块传输编码,则无需添加此标头。
发送请求。如果请求成功,服务器将返回
HTTP 200 OK
状态代码以及文件的元数据。{HTTP}
执行简单上传时,系统会创建基本元数据,并从文件中推断出一些属性,例如 MIME 类型或 modifiedTime
。如果文件较小且文件元数据不重要,您可以使用简单上传。
执行多部分上传
借助分块上传请求,您可以在同一请求中上传元数据和数据。如果您要发送的数据非常小,就算连接失败后需要再次完整上传也没关系,那么请使用此选项。
如需执行分块上传,请将 files.create
方法与 uploadType=multipart
搭配使用。
以下示例展示了如何执行多部分上传:
Java
Python
Node.js
PHP
.NET
HTTP
创建一个针对方法的 /upload URI 的
POST
请求,并设置查询参数uploadType=multipart
:POST https://www.googleapis.com/upload/drive/v3/files?uploadType=multipart
创建请求正文。根据多部分/相关内容类型 RFC 2387 设置正文的格式,该类型包含两个部分:
- 元数据。元数据必须位于第一部分,且
Content-Type
标头必须设置为application/json;
charset=UTF-8
。以 JSON 格式添加文件的元数据。 - 媒体。媒体必须位于第二部分,且必须包含任何 MIME 类型的
Content-Type
标头。将文件的数据添加到媒体部分。
使用定界字符串标识每个部分,前面带有两个连字符。此外,请在最后一个边界字符串后面添加两个连字符。
- 元数据。元数据必须位于第一部分,且
添加以下顶级 HTTP 标头:
Content-Type
。请将此项设为multipart/related
,并在其中添加您要用于标识请求不同部分的定界字符串。例如:Content-Type: multipart/related; boundary=foo_bar_baz
Content-Length
。请将此项设为请求正文包含的字节总数。
发送请求。
如需仅创建或更新元数据部分,而不上传关联数据,请向标准资源端点发送 POST
或 PATCH
请求:https://www.googleapis.com/drive/v3/files
如果请求成功,服务器将返回 HTTP 200 OK
状态代码以及文件的元数据。
创建文件时,应在文件的 name
字段中指定文件扩展名。例如,在创建照片 JPEG 文件时,您可以在元数据中指定 "name": "photo.jpg"
之类的内容。对 files.get
的后续调用会返回只读 fileExtension
属性,其中包含 name
字段中原先指定的扩展程序。
执行可续传上传
借助可续传上传,您可以在数据流因通信故障而中断后恢复上传操作。由于您不必从头开始重新上传大型文件,因此在发生网络故障时,可续传上传也可以减少您的带宽使用量。
当您的文件大小可能有很大差异或者请求(例如移动操作系统后台任务和某些 App Engine 请求)有固定的时间限制时,可续传上传会非常有用。如果您想显示上传进度条,也可以使用可续传上传。
可续传上传包括以下几个简要步骤:
- 发送初始请求并检索可续传会话 URI。
- 上传数据并监控上传状态。
- (可选)如果上传中断,请恢复上传。
发送初始请求
如需启动可续传上传,请将 files.create
方法与 uploadType=resumable
搭配使用。
HTTP
创建一个针对方法的 /upload URI 的
POST
请求,并设置查询参数uploadType=resumable
:POST https://www.googleapis.com/upload/drive/v3/files?uploadType=resumable
如果启动请求成功,则响应将包含
200 OK
HTTP 状态代码。此外,它还包含一个Location
标头,该标头指定可续传会话 URI:HTTP/1.1 200 OK Location: https://www.googleapis.com/upload/drive/v3/files?uploadType=resumable&upload_id=xa298sd_sdlkj2 Content-Length: 0
保存可续传会话 URI,以便上传文件数据并查询上传状态。可续传会话 URI 的有效期为一周。
如果您有文件的元数据,请以 JSON 格式向请求正文添加元数据。否则,请将请求正文留空。
添加以下 HTTP 标头:
X-Upload-Content-Type
。可选。设置为后续请求中传输的文件数据的 MIME 类型。如果未在元数据中或通过此标头指定数据的 MIME 类型,则系统会以application/octet-stream.
X-Upload-Content-Length
。可选。设置为后续请求中传输的文件数据的字节数。Content-Type
。如果您有文件的元数据,则需要添加此标头。设置为application/json;
charset=UTF-8
。Content-Length
。除非您使用分块传输编码,否则需要添加此标头。设置为此初始请求正文中的字节数。
发送请求。如果会话启动请求成功,则响应将包含
200 OK HTTP
状态代码。此外,响应还包含一个Location
标头,该标头指定可续传会话 URI。使用可续传会话 URI 上传文件数据并查询上传状态。可续传会话 URI 的有效期为一周。复制并保存可续传会话网址。
继续上传内容。
上传内容
借助以下两种方法,您可以使用可续传会话上传文件:
- 在单个请求中上传内容:如果文件可以在一个请求中上传,并且单个请求没有固定时间限制,或者您不需要显示上传进度指示器,请使用此方法。此方法是最佳方法,因为它需要的请求更少,上传效果会更好。
分块上传内容:如果您必须减少单个请求中传输的数据量,请使用此方法。如果单个请求有固定的时间限制(例如某些类别的 App Engine 请求),您可能需要减少传输的数据量。如果您必须提供自定义指示来显示上传进度,此方法也很有用。
HTTP - 单一请求
- 创建一个针对可续传会话 URI 的
PUT
请求。 - 将文件的数据添加到请求正文。
- 添加 Content-Length HTTP 标头,并将其设置为文件中的字节数。
- 发送请求。如果上传请求中断或者您收到
5xx
响应,请按照恢复中断的上传中的步骤操作。
HTTP - 多个请求
创建一个针对可续传会话 URI 的
PUT
请求。将数据块的数据添加到请求正文。除了结束上传的最后一个数据块之外,数据块的大小应该是 256 KB(256 x 1024 字节)的整数倍。请尽量使用较大的数据块,以便高效上传。
添加以下 HTTP 标头:
Content-Length
。设置为当前数据块中的字节数。Content-Range
。设置此标头可指明要上传文件中的哪些字节。例如,Content-Range: bytes 0-524287/2000000
表示您要上传某个 2,000,000 字节文件中的前 524,288 个字节 (256 x 1024 x 2)。
发送请求并处理响应。如果上传请求中断或者您收到
5xx
响应,请按照恢复中断的上传中的步骤操作。对文件中保留的每个数据块重复执行第 1 步到第 4 步。使用响应中的
Range
标头来确定从何处开始上传下一个分块。不要假设服务器已收到上一个请求中发送的所有字节。
当整个文件上传完毕后,您会收到 200 OK
或 201 Created
响应,以及与资源相关联的所有元数据。
恢复中断的上传
如果上传请求在收到响应之前被终止,或者您收到 503
Service Unavailable
响应,那么您必须恢复中断的上传。
HTTP
如需查询上传状态,请创建一个针对可续传会话 URI 的空
PUT
请求。添加
Content-Range
标头,以指明文件中的当前位置未知。例如,如果您的文件总长度为 200 万字节,请将Content-Range
设为*/2000000
。如果您不知道文件的完整大小,请将Content-Range
设为*/*
。发送请求。
处理响应:
200 OK
或201 Created
响应表明上传已完成,无需执行进一步操作。308 Resume Incomplete
响应表明您必须继续上传文件。404 Not Found
响应表示上传会话已过期,必须从头开始重新上传。
如果您收到
308 Resume Incomplete
响应,请处理该响应的Range
标头,以确定服务器已收到哪些字节。如果响应没有Range
标头,则表示未收到任何字节。例如,bytes=0-42
的Range
标头表明已收到文件的前 43 个字节,并且要上传的下一个分块将从字节 44 开始。现在您已知道从何处恢复上传,请继续上传文件,从下一个字节开始。请添加一个
Content-Range
标头,用于表明您要发送文件的哪一部分。例如,Content-Range: bytes 43-1999999
表示您要发送 44 - 2000000 字节。
处理媒体上传错误
上传媒体内容时,请遵循以下最佳实践来处理错误:
- 对于
5xx
错误,请恢复或重试因连接中断而失败的上传。如需详细了解如何处理5xx
错误,请参阅 500、502、503、504 错误。 - 如果出现
403 rate limit
错误,请重试上传。如需详细了解如何处理403 rate limit
错误,请参阅 403 错误:rateLimitExceeded
。 - 如果可续传上传期间出现任何
4xx
错误(包括403
),请重启上传。这些错误表示上传会话已过期,必须通过请求新的会话 URI 重新启动。上传会话也会在处于非活跃状态一周后过期。
可导入到 Google 文档的类型
在云端硬盘中创建文件时,您可能希望将文件转换为 Google Workspace 文件类型,例如 Google 文档或表格。例如,您可能希望将文档从您喜爱的文字处理器转换为 Google 文档,以便使用其功能。
如需将文件转换为特定的 Google Workspace 文件类型,请在创建文件时指定 Google Workspace mimeType
。
以下示例展示了如何将 CSV 文件转换为 Google Workspace 表格:
Java
Python
Node.js
PHP
.NET
如需查看是否有转换可用,请先检查 about
资源的 importFormats
数组,然后再创建文件。此数组中会动态显示支持的转化。一些常见的导入格式包括:
发件人 | 收件人 |
---|---|
Microsoft Word、OpenDocument 文本、HTML、RTF、纯文本 | Google 文档 |
Microsoft Excel、OpenDocument 电子表格、CSV、TSV、纯文本 | Google 表格 |
Microsoft PowerPoint、OpenDocument 演示文稿 | Google 幻灯片 |
JPEG、PNG、GIF、BMP、PDF | Google 文档(将图片嵌入到文档中) |
纯文本(特殊 MIME 类型)、JSON | Google Apps 脚本 |
如果您在 update
请求期间将媒体上传并转换为 Google 文档、表格或幻灯片文件,则文档的全部内容都会被替换。
将图片转换为 Google 文档时,云端硬盘会使用光学字符识别 (OCR) 技术将图片转换为文本。您可以在 ocrLanguage
参数中指定适用的 BCP 47 语言代码,以提高 OCR 算法的质量。提取的文本会与嵌入的图片一起显示在文档中。
使用预先生成的 ID 上传文件
借助 Drive API,您可以检索用于上传和创建资源的预生成的文件 ID 列表。上传和文件创建请求可以使用这些预生成的 ID。在文件元数据中设置 id
字段。
如需创建预生成的 ID,请调用 files.generateIds
,并提供要创建的 ID 数量。
如果出现不确定的服务器错误或超时,您可以放心地使用预先生成的 ID 重新尝试上传。如果文件已成功创建,后续重试会返回 HTTP 409
错误,并且不会创建重复的文件。
为未知文件类型定义可编入索引的文本
用户可以使用云端硬盘界面查找文档内容。您还可以使用 files.list
和 fullText
字段搜索应用中的内容。如需了解详情,请参阅搜索文件和文件夹。
云端硬盘识别到文件类型(包括文本文档、PDF、带文本的图片和其他常见类型)时,会自动将文档编入索引以供搜索。如果您的应用保存其他类型的文件(例如绘图、视频和快捷方式),您可以通过在文件的 contentHints.indexableText
字段中提供可编入索引的文本来提高可检测性。
如需详细了解可编入索引的文本,请参阅管理文件元数据。