Method: files.patch | Google Drive | Google for Developers (original) (raw)
- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization scopes
- Try it!
Updates a file's metadata and/or content. When calling this method, only populate fields in the request that you want to modify. When updating fields, some fields might change automatically, such as modifiedDate. This method supports patch semantics.
HTTP request
PATCH https://www.googleapis.com/drive/v2/files/{fileId}
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters | |
|---|---|
| fileId | string The ID of the file to update. |
Query parameters
| Parameters | |
|---|---|
| addParents | string Comma-separated list of parent IDs to add. |
| convert**(deprecated)** | boolean Deprecated: This parameter has no function. |
| enforceSingleParent**(deprecated)** | boolean Deprecated: Adding files to multiple folders is no longer supported. Use shortcuts instead. |
| modifiedDateBehavior | enum (ModifiedDateBehavior) Determines the behavior in which modifiedDate is updated. This overrides setModifiedDate. |
| newRevision | boolean Whether a blob upload should create a new revision. If false, the blob data in the current head revision is replaced. If true or not set, a new blob is created as head revision, and previous unpinned revisions are preserved for a short period of time. Pinned revisions are stored indefinitely, using additional storage quota, up to a maximum of 200 revisions. For details on how revisions are retained, see the Drive Help Center. Note that this field is ignored if there is no payload in the request. |
| ocr | boolean Whether to attempt OCR on .jpg, .png, .gif, or .pdf uploads. |
| ocrLanguage | string If ocr is true, hints at the language to use. Valid values are BCP 47 codes. |
| pinned | boolean Whether to pin the new revision. A file can have a maximum of 200 pinned revisions. Note that this field is ignored if there is no payload in the request. |
| removeParents | string Comma-separated list of parent IDs to remove. |
| setModifiedDate | boolean Whether to set the modified date using the value supplied in the request body. Setting this field to true is equivalent to modifiedDateBehavior=fromBodyOrNow, and false is equivalent to modifiedDateBehavior=now. To prevent any changes to the modified date set modifiedDateBehavior=noChange. |
| supportsAllDrives | boolean Whether the requesting application supports both My Drives and shared drives. |
| supportsTeamDrives**(deprecated)** | boolean Deprecated: Use supportsAllDrives instead. |
| timedTextLanguage | string The language of the timed text. |
| timedTextTrackName | string The timed text track name. |
| updateViewedDate | boolean Whether to update the view date after successfully updating the file. |
| useContentAsIndexableText | boolean Whether to use the content as indexable text. |
| includePermissionsForView | string Specifies which additional view's permissions to include in the response. Only published is supported. |
| includeLabels | string A comma-separated list of IDs of labels to include in the labelInfo part of the response. |
Request body
The request body contains an instance of [File](/workspace/drive/api/reference/rest/v2/files#File).
Response body
If successful, the response body contains an instance of [File](/workspace/drive/api/reference/rest/v2/files#File).
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/docshttps://www.googleapis.com/auth/drivehttps://www.googleapis.com/auth/drive.appdatahttps://www.googleapis.com/auth/drive.apps.readonlyhttps://www.googleapis.com/auth/drive.filehttps://www.googleapis.com/auth/drive.metadatahttps://www.googleapis.com/auth/drive.scripts
Some scopes are restricted and require a security assessment for your app to use them. For more information, see the Authorization guide.