Method: files.update

更新文件的元数据和/或内容。调用此方法时,请仅填充您要修改的请求中的字段。更新字段时,某些字段可能会自动更改,例如 modifiedDate。此方法支持补丁语义。

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

  • 文件大小上限:5120 GB
  • 接受的媒体 MIME 类型*/*

注意:请指定有效的 MIME 类型,而不是字面量 */* 值。*/* 字面量仅用于表示可以上传任何有效的 MIME 类型。

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

HTTP 请求

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

网址采用 gRPC 转码语法。

路径参数

参数
uploadType

string

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

可接受的值为:

  • media - 简单上传。仅上传媒体内容,不含任何元数据。
  • multipart - 多部分上传。使用一个请求同时上传媒体及其元数据。
  • resumable - 可续传上传。以可续传的方式上传文件,使用至少两个请求组成的一系列请求,其中第一个请求包含元数据。
fileId

string

要更新的文件的 ID。

查询参数

参数
uploadType

string

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

可接受的值为:

  • media - 简单上传。仅上传媒体内容,不含任何元数据。
  • multipart - 多部分上传。使用一个请求同时上传媒体及其元数据。
  • resumable - 可续传上传。以可续传的方式上传文件,使用至少两个请求组成的一系列请求,其中第一个请求包含元数据。
addParents

string

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

convert
(deprecated)

boolean

已弃用:此参数没有函数。

enforceSingleParent
(deprecated)

boolean

已弃用:系统不再支持向多个文件夹添加文件。请改用 shortcuts

modifiedDateBehavior

enum (ModifiedDateBehavior)

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

newRevision

boolean

上传 blob 时是否应创建新的修订版本。如果为 false,则替换当前头部修订版本中的 blob 数据。如果设置为 true 或未设置,则系统会创建一个新的 Blob 作为头修订版本,并且之前未固定的修订版本将在短时间内保留。固定的修订版本会无限期地存储,并使用额外的存储配额,最多可以指定 200 个修订版本。如要详细了解修订版本的保留方式,请参阅云端硬盘帮助中心

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

是否在成功更新文件后更新查看日期。

useContentAsIndexableText

boolean

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

includePermissionsForView

string

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

includeLabels

string

以英文逗号分隔的 labelInfo 部分所含标签的 ID 列表。

请求正文

请求正文包含一个 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

某些范围受到限制,您的应用必须接受安全评估才能使用这些范围。有关详情,请参阅授权指南