Method: files.update

更新文件的元数据、内容或两者。

调用此方法时,只需填充请求中要修改的字段。更新字段时,某些字段可能会自动更改,例如 modifiedDate。此方法支持 patch 语义。

此方法支持 /upload URI,并接受所上传的具备以下特征的媒体:

如需详细了解如何上传文件,请参阅上传文件数据

HTTP 请求

  • 上传 URI,用于媒体上传请求:
    PUT https://www.googleapis.com/upload/drive/v2/files/{fileId}
  • 元数据 URI,用于仅涉及元数据的请求:
    PUT https://www.googleapis.com/drive/v2/files/{fileId}

网址采用 gRPC 转码语法。

路径参数

参数
fileId

string

要更新的文件的 ID。

查询参数

参数
addParents

string

要添加的父 ID 的逗号分隔列表。

convert
(deprecated)

boolean

已弃用:此参数没有功能。

enforceSingleParent
(deprecated)

boolean

已弃用:不再支持将文件添加到多个文件夹。请改用 shortcuts

modifiedDateBehavior

enum (ModifiedDateBehavior)

确定 modifiedDate 的更新行为。这会替换 setModifiedDate

newRevision

boolean

Blob 上传是否应创建新修订版本。如果为 false,则替换当前 Head 修订版本中的 blob 数据。如果为 true 或未设置,则会创建一个新的 blob 作为 head 修订版本,并保留之前未固定的修订版本一小段时间。已固定的修订版本会无限期存储,但会占用额外的存储空间配额,最多可存储 200 个修订版本。如需详细了解修订版本的保留方式,请参阅 Google 云端硬盘帮助中心

ocr

boolean

是否尝试对 .jpg、.png、.gif 或 .pdf 上传文件执行 OCR。

ocrLanguage

string

如果 ocr 为 true,则提示要使用的语言。有效值为 BCP 47 代码。

pinned

boolean

是否固定新修订版本。一个文件最多可以有 200 个已固定的修订版本。

removeParents

string

要移除的父 ID 的英文逗号分隔列表。

setModifiedDate

boolean

是否使用请求正文中提供的值设置修改日期。将此字段设置为 true 等同于 modifiedDateBehavior=fromBodyOrNow,而 false 等同于 modifiedDateBehavior=now。防止对修改日期集 modifiedDateBehavior=noChange 进行任何更改。

supportsAllDrives

boolean

请求访问的应用是否同时支持“我的云端硬盘”和共享云端硬盘。

supportsTeamDrives
(deprecated)

boolean

已弃用:请改用 supportsAllDrives

timedTextLanguage

string

定时文字的语言。

timedTextTrackName

string

定时文本轨道名称。

updateViewedDate

boolean

是否在成功更新文件后更新视图日期。

uploadType

string

针对 /upload URI 的上传请求的类型。如果您要使用 /upload URI 上传数据,则必须填写该字段。如果您要创建仅包含元数据的文件,则不需要填写该字段。此外,该字段不会显示在“试用此方法”微件中,因为此微件不支持上传数据。

可接受的值包括:

  • media - 简单上传。仅上传媒体,不涉及任何元数据。
  • multipart - 分段上传。在单个请求中同时上传媒体及其元数据。
  • resumable - 可续传上传。以可续传的方式上传文件,使用至少包含两个请求的一系列请求(其中第一个请求包含元数据)。
useContentAsIndexableText

boolean

是否将内容用作可编入索引的文本。

includePermissionsForView

string

指定要在响应中包含哪些其他视图的权限。仅支持 published

includeLabels

string

逗号分隔的标签 ID 列表,用于包含在响应的 labelInfo 部分中。

请求正文

请求正文包含一个 File 实例。

响应正文

如果成功,则响应正文包含一个 File 实例。

授权范围

需要以下 OAuth 范围之一:

  • https://www.googleapis.com/auth/docs
  • https://www.googleapis.com/auth/drive
  • https://www.googleapis.com/auth/drive.appdata
  • https://www.googleapis.com/auth/drive.apps.readonly
  • https://www.googleapis.com/auth/drive.file
  • https://www.googleapis.com/auth/drive.metadata
  • https://www.googleapis.com/auth/drive.scripts

某些范围受到限制,您的应用需要通过安全评估才能使用这些范围。如需了解详情,请参阅授权指南