Skip to content

Google: Creates a copy of a file and applies any requested updates with patch semantics For more information, see Create and manage files (https: developers google com workspace drive api guides create-file) — request body — body

Creates a copy of a file and applies any requested updates with patch semantics. For more information, see [Create and manage files](https://developers.google.com/workspace/drive/api/guides/create-file).: request body, field body. Complete fields and constraints for contract 2026-10-27.

API reference · Contract 2026-10-27

SDK schema: Creates a copy of a file and applies any requested updates with patch semantics For more information, see Create and manage files (https: developers google com workspace drive api guides create-file) — request body — body

FieldTypePresenceDescription and constraints
$objectRootThe metadata for a file. Some resource methods (such as `files.update`) require a `fileId`. Use the `files.list` method to retrieve the ID for a file.
appPropertiesobjectOptionalA collection of arbitrary key-value pairs which are private to the requesting app.
Entries with null values are cleared in update and copy requests. These properties can only be retrieved using an authenticated request. An authenticated request uses an access token obtained with a OAuth 2 client ID. You cannot use an API key to retrieve private properties.
Additional keys: see wildcard field
appProperties.*stringAdditional keys
capabilitiesModelOptionalExpand Creates a copy of a file and applies any requested updates with patch semantics For more information, see Create and manage files (https: developers google com workspace drive api guides create-file) — response body — capabilities
clientEncryptionDetailsModelOptionalExpand Creates a copy of a file and applies any requested updates with patch semantics For more information, see Create and manage files (https: developers google com workspace drive api guides create-file) — response body — client Encryption Details
Client Side Encryption related details. Contains details about the encryption state of the file and details regarding the encryption mechanism that clients need to use when decrypting the contents of this item. This will only be present on files and not on folders or shortcuts.
contentHintsModelOptionalExpand Creates a copy of a file and applies any requested updates with patch semantics For more information, see Create and manage files (https: developers google com workspace drive api guides create-file) — response body — content Hints
contentRestrictionsarrayOptionalRestrictions for accessing the content of the file. Only populated if such a restriction exists.
contentRestrictions[]ModelEach itemExpand Creates a copy of a file and applies any requested updates with patch semantics For more information, see Create and manage files (https: developers google com workspace drive api guides create-file) — response body — content Restrictions item
copyRequiresWriterPermissionbooleanOptionalWhether the options to copy, print, or download this file should be disabled for readers and commenters.
createdTimestringOptionalThe time at which the file was created (RFC 3339 date-time).
Format: date-time
descriptionstringOptionalA short description of the file.
downloadRestrictionsModelOptionalExpand Creates a copy of a file and applies any requested updates with patch semantics For more information, see Create and manage files (https: developers google com workspace drive api guides create-file) — response body — download Restrictions
Download restrictions applied on the file.
driveIdstringOptionalOutput only. ID of the shared drive the file resides in. Only populated for items in shared drives.
explicitlyTrashedbooleanOptionalOutput only. Whether the file has been explicitly trashed, as opposed to recursively trashed from a parent folder.
exportLinksobjectOptionalOutput only. Links for exporting Docs Editors files to specific formats.
Read only: true
Additional keys: see wildcard field
exportLinks.*stringAdditional keys
fileExtensionstringOptionalOutput only. The final component of `fullFileExtension`. This is only available for files with binary content in Google Drive.
folderColorRgbstringOptionalThe color for a folder or a shortcut to a folder as an RGB hex string. The supported colors are published in the `folderColorPalette` field of the [`about`](/workspace/drive/api/reference/rest/v3/about) resource. If an unsupported color is specified, the closest color in the palette is used instead.
fullFileExtensionstringOptionalOutput only. The full file extension extracted from the `name` field. May contain multiple concatenated extensions, such as “tar.gz”. This is only available for files with binary content in Google Drive. This is automatically updated when the `name` field changes, however it’s not cleared if the new name doesn’t contain a valid extension.
hasAugmentedPermissionsbooleanOptionalOutput only. Whether there are permissions directly on this file. This field is only populated for items in shared drives.
hasThumbnailbooleanOptionalOutput only. Whether this file has a thumbnail. This doesn’t indicate whether the requesting app has access to the thumbnail. To check access, look for the presence of the thumbnailLink field.
headRevisionIdstringOptionalOutput only. The ID of the file’s head revision. This is currently only available for files with binary content in Google Drive.
iconLinkstringOptionalOutput only. A static, unauthenticated link to the file’s icon.
idstringOptionalThe ID of the file.
imageMediaMetadataModelOptionalExpand Creates a copy of a file and applies any requested updates with patch semantics For more information, see Create and manage files (https: developers google com workspace drive api guides create-file) — request body — body image Media Metadata
inheritedPermissionsDisabledbooleanOptionalWhether this file has inherited permissions disabled. Inherited permissions are enabled by default.
isAppAuthorizedbooleanOptionalOutput only. Whether the file was created or opened by the requesting app.
kindstringOptionalOutput only. Identifies what kind of resource this is. Value: the fixed string `“drive#file”`.
Default: drive#file
labelInfoobjectOptionalLabel information on the file.
labelInfo.labelsarrayOptionalOutput only. The set of labels on the file as requested by the label IDs in the `includeLabels` parameter. By default, no labels are returned.
labelInfo.labels[]ModelEach itemExpand Lists the labels on a file For more information, see List labels on a file (https: developers google com workspace drive api guides list-labels) — response body — labels item
lastModifyingUserModelOptionalExpand Gets information about the user, the user’s Drive, and system capabilities. For more information, see [Return user info](https://developers.google.com/workspace/drive/api/guides/user-info). Required: The `fields` parameter must be set To return the exact fields you need, see Return specific fields (https: developers google com workspace drive api guides fields-parameter) — response body — user
Output only. The last user to modify the file. This field is only populated when the last modification was performed by a signed-in user.
linkShareMetadataobjectOptionalContains details about the link URLs that clients are using to refer to this item.
linkShareMetadata.securityUpdateEligiblebooleanOptionalOutput only. Whether the file is eligible for security update.
linkShareMetadata.securityUpdateEnabledbooleanOptionalOutput only. Whether the security update is enabled for this file.
md5ChecksumstringOptionalOutput only. The MD5 checksum for the content of the file. This is only applicable to files with binary content in Google Drive.
mimeTypestringOptionalThe MIME type of the file. Google Drive attempts to automatically detect an appropriate value from uploaded content, if no value is provided. The value cannot be changed unless a new revision is uploaded. If a file is created with a Google Doc MIME type, the uploaded content is imported, if possible. The supported import formats are published in the [`about`](/workspace/drive/api/reference/rest/v3/about) resource.
modifiedByMebooleanOptionalOutput only. Whether the file has been modified by this user.
modifiedByMeTimestringOptionalThe last time the file was modified by the user (RFC 3339 date-time).
Format: date-time
modifiedTimestringOptionalhe last time the file was modified by anyone (RFC 3339 date-time). Note that setting modifiedTime will also update modifiedByMeTime for the user.
Format: date-time
namestringOptionalThe name of the file. This isn’t necessarily unique within a folder. Note that for immutable items such as the top-level folders of shared drives, the My Drive root folder, and the Application Data folder, the name is constant.
originalFilenamestringOptionalThe original filename of the uploaded content if available, or else the original value of the `name` field. This is only available for files with binary content in Google Drive.
ownedByMebooleanOptionalOutput only. Whether the user owns the file. Not populated for items in shared drives.
ownersarrayOptionalOutput only. The owner of this file. Only certain legacy files may have more than one owner. This field isn’t populated for items in shared drives.
owners[]ModelEach itemExpand Gets information about the user, the user’s Drive, and system capabilities. For more information, see [Return user info](https://developers.google.com/workspace/drive/api/guides/user-info). Required: The `fields` parameter must be set To return the exact fields you need, see Return specific fields (https: developers google com workspace drive api guides fields-parameter) — response body — user
parentsarrayOptionalThe ID of the parent folder containing the file. A file can only have one parent folder; specifying multiple parents isn’t supported. If not specified as part of a create request, the file is placed directly in the user’s My Drive folder. If not specified as part of a copy request, the file inherits any discoverable parent of the source file. Update requests must use the `addParents` and `removeParents` parameters to modify the parents list.
parents[]stringEach item
permissionIdsarrayOptionalOutput only. List of permission IDs for users with access to this file.
permissionIds[]stringEach item
permissionsarrayOptionalOutput only. The full list of permissions for the file. This is only available if the requesting user can share the file. Not populated for items in shared drives.
permissions[]ModelEach itemExpand Gets a permission by ID For more information, see Share files, folders, and drives (https: developers google com workspace drive api guides manage-sharing) — response body
propertiesobjectOptionalA collection of arbitrary key-value pairs which are visible to all apps.
Entries with null values are cleared in update and copy requests.
Additional keys: see wildcard field
properties.*stringAdditional keys
quotaBytesUsedstringOptionalOutput only. The number of storage quota bytes used by the file. This includes the head revision as well as previous revisions with `keepForever` enabled.
Format: int64
resourceKeystringOptionalOutput only. A key needed to access the item via a shared link.
sha1ChecksumstringOptionalOutput only. The SHA1 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it’s not populated for Docs Editors or shortcut files.
sha256ChecksumstringOptionalOutput only. The SHA256 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it’s not populated for Docs Editors or shortcut files.
sharedbooleanOptionalOutput only. Whether the file has been shared. Not populated for items in shared drives.
sharedWithMeTimestringOptionalThe time at which the file was shared with the user, if applicable (RFC 3339 date-time).
Format: date-time
sharingUserModelOptionalExpand Gets information about the user, the user’s Drive, and system capabilities. For more information, see [Return user info](https://developers.google.com/workspace/drive/api/guides/user-info). Required: The `fields` parameter must be set To return the exact fields you need, see Return specific fields (https: developers google com workspace drive api guides fields-parameter) — response body — user
Output only. The user who shared the file with the requesting user, if applicable.
shortcutDetailsModelOptionalExpand Creates a copy of a file and applies any requested updates with patch semantics For more information, see Create and manage files (https: developers google com workspace drive api guides create-file) — response body — shortcut Details
sizestringOptionalOutput only. Size in bytes of blobs and Google Workspace editor files. Won’t be populated for files that have no size, like shortcuts and folders.
Format: int64
spacesarrayOptionalOutput only. The list of spaces which contain the file. The currently supported values are `drive`, `appDataFolder`, and `photos`.
spaces[]stringEach item
starredbooleanOptionalWhether the user has starred the file.
teamDriveIdstringOptionalDeprecated: Output only. Use `driveId` instead.
thumbnailLinkstringOptionalOutput only. A short-lived link to the file’s thumbnail, if available. Typically lasts on the order of hours. Not intended for direct usage on web applications due to [Cross-Origin Resource Sharing (CORS)](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) policies. Consider using a proxy server. Only populated when the requesting app can access the file’s content. If the file isn’t shared publicly, the URL returned in `files.thumbnailLink` must be fetched using a credentialed request.
thumbnailVersionstringOptionalOutput only. The thumbnail version for use in thumbnail cache invalidation.
Format: int64
trashedbooleanOptionalWhether the file has been trashed, either explicitly or from a trashed parent folder. Only the owner may trash a file, but other users can still access the file in the owner’s trash until it’s permanently deleted.
trashedTimestringOptionalThe time that the item was trashed (RFC 3339 date-time). Only populated for items in shared drives.
Format: date-time
trashingUserModelOptionalExpand Gets information about the user, the user’s Drive, and system capabilities. For more information, see [Return user info](https://developers.google.com/workspace/drive/api/guides/user-info). Required: The `fields` parameter must be set To return the exact fields you need, see Return specific fields (https: developers google com workspace drive api guides fields-parameter) — response body — user
Output only. If the file has been explicitly trashed, the user who trashed it. Only populated for items in shared drives.
versionstringOptionalOutput only. A monotonically increasing version number for the file. This reflects every change made to the file on the server, even those not visible to the user.
Format: int64
videoMediaMetadataModelOptionalExpand Creates a copy of a file and applies any requested updates with patch semantics For more information, see Create and manage files (https: developers google com workspace drive api guides create-file) — request body — body video Media Metadata
viewedByMebooleanOptionalOutput only. Whether the file has been viewed by this user.
viewedByMeTimestringOptionalThe last time the file was viewed by the user (RFC 3339 date-time).
Format: date-time
viewersCanCopyContentbooleanOptionalDeprecated: Use `copyRequiresWriterPermission` instead.
webContentLinkstringOptionalOutput only. A link for downloading the content of the file in a browser. This is only available for files with binary content in Google Drive.
webViewLinkstringOptionalOutput only. A link for opening the file in a relevant Google editor or viewer in a browser.
writersCanSharebooleanOptionalWhether users with only `writer` permission can modify the file’s permissions. Not populated for items in shared drives.

Referenced models: Creates a copy of a file and applies any requested updates with patch semantics For more information, see Create and manage files (https: developers google com workspace drive api guides create-file) — response body — client Encryption Details, Creates a copy of a file and applies any requested updates with patch semantics For more information, see Create and manage files (https: developers google com workspace drive api guides create-file) — response body — content Restrictions item, Creates a copy of a file and applies any requested updates with patch semantics For more information, see Create and manage files (https: developers google com workspace drive api guides create-file) — response body — download Restrictions, Lists the labels on a file For more information, see List labels on a file (https: developers google com workspace drive api guides list-labels) — response body — labels item, Gets a permission by ID For more information, see Share files, folders, and drives (https: developers google com workspace drive api guides manage-sharing) — response body, Gets information about the user, the user’s Drive, and system capabilities. For more information, see [Return user info](https://developers.google.com/workspace/drive/api/guides/user-info). Required: The `fields` parameter must be set To return the exact fields you need, see Return specific fields (https: developers google com workspace drive api guides fields-parameter) — response body — user, Creates a copy of a file and applies any requested updates with patch semantics For more information, see Create and manage files (https: developers google com workspace drive api guides create-file) — response body — capabilities, Creates a copy of a file and applies any requested updates with patch semantics For more information, see Create and manage files (https: developers google com workspace drive api guides create-file) — response body — content Hints, Creates a copy of a file and applies any requested updates with patch semantics For more information, see Create and manage files (https: developers google com workspace drive api guides create-file) — request body — body image Media Metadata, Creates a copy of a file and applies any requested updates with patch semantics For more information, see Create and manage files (https: developers google com workspace drive api guides create-file) — response body — shortcut Details, Creates a copy of a file and applies any requested updates with patch semantics For more information, see Create and manage files (https: developers google com workspace drive api guides create-file) — request body — body video Media Metadata

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.