younifyd
Menu

Drive.files.copy

Creates a copy of a file and applies any requested updates with patch semantics. Folders cannot be copied.

POST/files/{fileId}/copy

Use it in a workflow

  1. Add a step and choose the Google Drive connector.
  2. Pick the Drive.files.copy action (under files).
  3. Fill in the fields below, then reference the result from later steps as {{driveFilesCopy.response.data}}.

Request

Path parameters

fileIdstringrequired

The ID of the file.

Query parameters

altstring

Data format for the response.

One ofjson

fieldsstring

Selector specifying which fields to include in a partial response.

keystring

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

oauth_tokenstring

OAuth 2.0 token for the current user.

prettyPrintboolean

Returns response with indentations and line breaks.

quotaUserstring

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

userIpstring

Deprecated. Please use quotaUser instead.

enforceSingleParentboolean

Deprecated. Copying files into multiple folders is no longer supported. Use shortcuts instead.

ignoreDefaultVisibilityboolean

Whether to ignore the domain's default visibility settings for the created file. Domain administrators can choose to make all uploaded files visible to the domain by default; this parameter bypasses that behavior for the request. Permissions are still inherited from parent folders.

includeLabelsstring

A comma-separated list of IDs of labels to include in the labelInfo part of the response.

includePermissionsForViewstring

Specifies which additional view's permissions to include in the response. Only 'published' is supported.

keepRevisionForeverboolean

Whether to set the 'keepForever' field in the new head revision. This is only applicable to files with binary content in Google Drive. Only 200 revisions for the file can be kept forever. If the limit is reached, try deleting pinned revisions.

ocrLanguagestring

A language hint for OCR processing during image import (ISO 639-1 code).

supportsAllDrivesboolean

Whether the requesting application supports both My Drives and shared drives.

supportsTeamDrivesboolean

Deprecated use supportsAllDrives instead.

Request body

Enter the body as JSON in the step's Body field.

appPropertiesobject

A collection of arbitrary key-value pairs that 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 an OAuth 2 client ID. You cannot use an API key to retrieve private properties.

capabilitiesobject

Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user can take.

canAcceptOwnershipboolean

Whether the current user is the pending owner of the file. Not populated for shared drive files.

canAddChildrenboolean

Whether the current user can add children to this folder. This is always false when the item isn't a folder.

canAddFolderFromAnotherDriveboolean

Whether the current user can add a folder from another drive (different shared drive or My Drive) to this folder. This is false when the item isn't a folder. Only populated for items in shared drives.

canAddMyDriveParentboolean

Whether the current user can add a parent for the item without removing an existing parent in the same request. Not populated for shared drive files.

canChangeCopyRequiresWriterPermissionboolean

Whether the current user can change the copyRequiresWriterPermission restriction of this file.

canChangeSecurityUpdateEnabledboolean

Whether the current user can change the securityUpdateEnabled field on link share metadata.

canChangeViewersCanCopyContentboolean

Deprecated

canCommentboolean

Whether the current user can comment on this file.

canCopyboolean

Whether the current user can copy this file. For an item in a shared drive, whether the current user can copy non-folder descendants of this item, or this item itself if it's not a folder.

canDeleteboolean

Whether the current user can delete this file.

canDeleteChildrenboolean

Whether the current user can delete children of this folder. This is false when the item isn't a folder. Only populated for items in shared drives.

canDownloadboolean

Whether the current user can download this file.

canEditboolean

Whether the current user can edit this file. Other factors might limit the type of changes a user can make to a file. For example, see canChangeCopyRequiresWriterPermission or canModifyContent.

canListChildrenboolean

Whether the current user can list the children of this folder. This is always false when the item isn't a folder.

canModifyContentboolean

Whether the current user can modify the content of this file.

canModifyContentRestrictionboolean

Whether the current user can modify restrictions on content of this file.

canModifyLabelsboolean

Whether the current user can modify the labels on this file.

canMoveChildrenOutOfDriveboolean

Whether the current user can move children of this folder outside of the shared drive. This is false when the item isn't a folder. Only populated for items in shared drives.

canMoveChildrenOutOfTeamDriveboolean

Deprecated - use canMoveChildrenOutOfDrive instead.

canMoveChildrenWithinDriveboolean

Whether the current user can move children of this folder within this shared drive or My Drive. This is false when the item isn't a folder. Note that a request to move the child might still fail depending on the current user's access to the child and to the destination folder.

canMoveChildrenWithinTeamDriveboolean

Deprecated - use canMoveChildrenWithinDrive instead.

canMoveItemIntoTeamDriveboolean

Deprecated - use canMoveItemOutOfDrive instead.

canMoveItemOutOfDriveboolean

Whether the current user can move this item outside of this shared drive or My Drive by changing its parent. Note that a request to change the parent of the item might still fail depending on the new parent that's being added.

canMoveItemOutOfTeamDriveboolean

Deprecated - use canMoveItemOutOfDrive instead.

canMoveItemWithinDriveboolean

Whether the current user can move this item within this shared drive or My Drive. Note that a request to change the parent of the item might still fail depending on the new parent that's being added and the parent that's being removed.

canMoveItemWithinTeamDriveboolean

Deprecated - use canMoveItemWithinDrive instead.

canMoveTeamDriveItemboolean

Deprecated - use canMoveItemWithinDrive or canMoveItemOutOfDrive instead.

canReadDriveboolean

Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives.

canReadLabelsboolean

Whether the current user can read the labels on this file.

canReadRevisionsboolean

Whether the current user can read the revisions resource of this file. For a shared drive item, whether revisions of non-folder descendants of this item, or this item itself if it's not a folder, can be read.

canReadTeamDriveboolean

Deprecated - use canReadDrive instead.

canRemoveChildrenboolean

Whether the current user can remove children from this folder. This is always false when the item isn't a folder. For a folder in a shared drive, use canDeleteChildren or canTrashChildren instead.

canRemoveMyDriveParentboolean

Whether the current user can remove a parent from the item without adding another parent in the same request. Not populated for shared drive files.

canRenameboolean

Whether the current user can rename this file.

canShareboolean

Whether the current user can modify the sharing settings for this file.

canTrashboolean

Whether the current user can move this file to trash.

canTrashChildrenboolean

Whether the current user can trash children of this folder. This is false when the item isn't a folder. Only populated for items in shared drives.

canUntrashboolean

Whether the current user can restore this file from trash.

contentHintsobject

Additional information about the content of the file. These fields are never populated in responses.

indexableTextstring

Text to be indexed for the file to improve fullText queries. This is limited to 128 KB in length and might contain HTML elements. For more information, see Manage file metadata.

thumbnailobject2 fields

A thumbnail for the file. This will only be used if Google Drive cannot generate a standard thumbnail.

contentRestrictionsarray<object>

Restrictions for accessing the content of the file. Only populated if such a restriction exists.

readOnlyboolean

Whether the content of the file is read-only. If a file is read-only, a new revision of the file may not be added, comments may not be added or modified, and the title of the file may not be modified.

reasonstring

Reason for why the content of the file is restricted. This is only mutable on requests that also set readOnly=true.

restrictingUserobject6 fields

Information about a Drive user.

restrictionTimestring (date-time)

The time at which the content restriction was set (formatted RFC 3339 timestamp). Only populated if readOnly is true.

typestring

The type of the content restriction. Currently the only possible value is globalContentRestriction.

copyRequiresWriterPermissionboolean

Whether the options to copy, print, or download this file, should be disabled for readers and commenters.

createdTimestring (date-time)

The time at which the file was created (RFC 3339 date-time).

descriptionstring

A short description of the file.

driveIdstring

ID of the shared drive the file resides in. Only populated for items in shared drives.

explicitlyTrashedboolean

Whether the file has been explicitly trashed, as opposed to recursively trashed from a parent folder.

exportLinksobject

Links for exporting Docs Editors files to specific formats.

fileExtensionstring

The final component of fullFileExtension. This is only available for files with binary content in Google Drive.

folderColorRgbstring

The color for a folder or shortcut to a folder as an RGB hex string. The supported colors are published in the folderColorPalette field of the About resource. If an unsupported color is specified, the closest color in the palette will be used instead.

fullFileExtensionstring

The full file extension extracted from the name field. Can 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 does not contain a valid extension.

hasAugmentedPermissionsboolean

Whether there are permissions directly on this file. This field is only populated for items in shared drives.

hasThumbnailboolean

Whether this file has a thumbnail. This does not indicate whether the requesting app has access to the thumbnail. To check access, look for the presence of the thumbnailLink field.

headRevisionIdstring

The ID of the file's head revision. This is only available for files with binary content in Google Drive.

iconLinkstring

A static, unauthenticated link to the file's icon.

idstring

The ID of the file.

imageMediaMetadataobject

Additional metadata about image media, if available.

aperturenumber (float)

The aperture used to create the photo (f-number).

cameraMakestring

The make of the camera used to create the photo.

cameraModelstring

The model of the camera used to create the photo.

colorSpacestring

The color space of the photo.

exposureBiasnumber (float)

The exposure bias of the photo (APEX value).

exposureModestring

The exposure mode used to create the photo.

exposureTimenumber (float)

The length of the exposure, in seconds.

flashUsedboolean

Whether a flash was used to create the photo.

focalLengthnumber (float)

The focal length used to create the photo, in millimeters.

heightinteger (int32)

The height of the image in pixels.

isoSpeedinteger (int32)

The ISO speed used to create the photo.

lensstring

The lens used to create the photo.

locationobject3 fields

Geographic location information stored in the image.

maxApertureValuenumber (float)

The smallest f-number of the lens at the focal length used to create the photo (APEX value).

meteringModestring

The metering mode used to create the photo.

rotationinteger (int32)

The number of clockwise 90-degree rotations applied from the image's original orientation.

sensorstring

The type of sensor used to create the photo.

subjectDistanceinteger (int32)

The distance to the subject of the photo, in meters.

timestring

The date and time the photo was taken (EXIF DateTime).

whiteBalancestring

The white balance mode used to create the photo.

widthinteger (int32)

The width of the image in pixels.

isAppAuthorizedboolean

Whether the requesting app created or opened the file.

kindstring

Identifies what kind of resource this is. Value: the fixed string "drive#file".

Default "drive#file"

labelInfoobject

An overview of the labels on the file.

labelsarray<object>4 fields

The set of labels on the file as requested by the label IDs in the includeLabels parameter. By default, no labels are returned.

lastModifyingUserobject

Information about a Drive user.

displayNamestring

A plain text displayable name for this user.

emailAddressstring

The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.

kindstring

Identifies what kind of resource this is. Value: the fixed string "drive#user".

Default "drive#user"

meboolean

Whether this user is the requesting user.

permissionIdstring

The user's ID as visible in Permission resources.

photoLinkstring

A link to the user's profile photo, if available.

linkShareMetadataobject

Contains details about the link URLs that clients are using to refer to this item.

securityUpdateEligibleboolean

Whether the file is eligible for security update.

securityUpdateEnabledboolean

Whether the security update is enabled for this file.

md5Checksumstring

The MD5 checksum for the content of the file. This is only applicable to files with binary content in Google Drive.

mimeTypestring

The MIME type of the file. Google Drive will attempt 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 will be imported if possible. The supported import formats are published in the About resource.

modifiedByMeboolean

Whether this user has modified the file.

modifiedByMeTimestring (date-time)

The last time the user modified the file (RFC 3339 date-time).

modifiedTimestring (date-time)

The last time anyone modified the file (RFC 3339 date-time). Note that setting modifiedTime will also update modifiedByMeTime for the user.

namestring

The 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, My Drive root folder, and Application Data folder the name is constant.

originalFilenamestring

The 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.

ownedByMeboolean

Whether the user owns the file. Not populated for items in shared drives.

ownersarray<object>

The owner of this file. Only certain legacy files might have more than one owner. This field isn't populated for items in shared drives.

displayNamestring

A plain text displayable name for this user.

emailAddressstring

The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.

kindstring

Identifies what kind of resource this is. Value: the fixed string "drive#user".

Default "drive#user"

meboolean

Whether this user is the requesting user.

permissionIdstring

The user's ID as visible in Permission resources.

photoLinkstring

A link to the user's profile photo, if available.

parentsarray<string>

The IDs of the parent folders that contain the file. If not specified as part of a create request, the file will be placed directly in the user's My Drive folder. If not specified as part of a copy request, the file will inherit any discoverable parents of the source file. Update requests must use the addParents and removeParents parameters to modify the parents list.

permissionIdsarray<string>

List of permission IDs for users with access to this file.

permissionsarray<object>

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.

allowFileDiscoveryboolean

Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type domain or anyone.

deletedboolean

Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.

displayNamestring

The "pretty" name of the value of the permission. The following is a list of examples for each type of permission: - user - User's full name, as defined for their Google Account, such as "Joe Smith." - group - Name of the Google Group, such as "The Company Administrators." - domain - String domain name, such as "your-company.com." - anyone - No displayName is present.

domainstring

The domain to which this permission refers. The following options are currently allowed: - The entire domain, such as "your-company.com." - A target audience, such as "ID.audience.googledomains.com."

emailAddressstring

The email address of the user or group to which this permission refers.

expirationTimestring (date-time)

The time at which this permission will expire (RFC 3339 date-time). Expiration times have the following restrictions: - They cannot be set on shared drive items. - They can only be set on user and group permissions. - The time must be in the future. - The time cannot be more than one year in the future.

idstring

The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as permissionId. IDs should be treated as opaque values.

kindstring

Identifies what kind of resource this is. Value: the fixed string "drive#permission".

Default "drive#permission"

pendingOwnerboolean

Whether the account associated with this permission is a pending owner. Only populated for user type permissions for files that aren't in a shared drive.

permissionDetailsarray<object>4 fields

Details of whether the permissions on this shared drive item are inherited or are directly on this item. This is an output-only field that's present only for shared drive items.

photoLinkstring

A link to the user's profile photo, if available.

rolestring

The role granted by this permission. While new values may be supported in the future, the following are currently allowed: - owner - organizer - fileOrganizer - writer - commenter - reader

teamDrivePermissionDetailsarray<object>4 fields

Deprecated - use permissionDetails instead.

typestring

The type of the grantee. Valid values are: - user - group - domain - anyone When creating a permission, if type is user or group, you must provide an emailAddress for the user or group. When type is domain, you must provide a domain. There isn't extra information required for the anyone type.

viewstring

Indicates the view for this permission. Only populated for permissions that belong to a view. published is the only supported value.

propertiesobject

A collection of arbitrary key-value pairs that are visible to all apps. Entries with null values are cleared in update and copy requests.

quotaBytesUsedstring (int64)

The number of storage quota bytes used by the file. This includes the head revision as well as previous revisions with keepForever enabled.

resourceKeystring

A key needed to access the item via a shared link.

sha1Checksumstring

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.

json
{
  "appProperties": {},
  "capabilities": {
    "canAcceptOwnership": false,
    "canAddChildren": false,
    "canAddFolderFromAnotherDrive": false,
    "canAddMyDriveParent": false,
    "canChangeCopyRequiresWriterPermission": false,
    "canChangeSecurityUpdateEnabled": false,
    "canChangeViewersCanCopyContent": false,
    "canComment": false,
    "canCopy": false,
    "canDelete": false,
    "canDeleteChildren": false,
    "canDownload": false
  },
  "contentHints": {
    "indexableText": "string",
    "thumbnail": {
      "image": "string",
      "mimeType": "string"
    }
  },
  "contentRestrictions": [
    {
      "readOnly": false,
      "reason": "string",
      "restrictingUser": {
        "displayName": "string",
        "emailAddress": "string",
        "kind": "drive#user",
        "me": false,
        "permissionId": "string",
        "photoLink": "string"
      },
      "restrictionTime": "2025-01-01T00:00:00Z",
      "type": "string"
    }
  ],
  "copyRequiresWriterPermission": false,
  "createdTime": "2025-01-01T00:00:00Z",
  "description": "string",
  "driveId": "string",
  "explicitlyTrashed": false,
  "exportLinks": {},
  "fileExtension": "string",
  "folderColorRgb": "string"
}

Response

Returns 200 with an object. Read it in later steps with {{driveFilesCopy.response.data.<field>}}.

appPropertiesobject

A collection of arbitrary key-value pairs that 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 an OAuth 2 client ID. You cannot use an API key to retrieve private properties.

capabilitiesobject

Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user can take.

canAcceptOwnershipboolean

Whether the current user is the pending owner of the file. Not populated for shared drive files.

canAddChildrenboolean

Whether the current user can add children to this folder. This is always false when the item isn't a folder.

canAddFolderFromAnotherDriveboolean

Whether the current user can add a folder from another drive (different shared drive or My Drive) to this folder. This is false when the item isn't a folder. Only populated for items in shared drives.

canAddMyDriveParentboolean

Whether the current user can add a parent for the item without removing an existing parent in the same request. Not populated for shared drive files.

canChangeCopyRequiresWriterPermissionboolean

Whether the current user can change the copyRequiresWriterPermission restriction of this file.

canChangeSecurityUpdateEnabledboolean

Whether the current user can change the securityUpdateEnabled field on link share metadata.

canChangeViewersCanCopyContentboolean

Deprecated

canCommentboolean

Whether the current user can comment on this file.

canCopyboolean

Whether the current user can copy this file. For an item in a shared drive, whether the current user can copy non-folder descendants of this item, or this item itself if it's not a folder.

canDeleteboolean

Whether the current user can delete this file.

canDeleteChildrenboolean

Whether the current user can delete children of this folder. This is false when the item isn't a folder. Only populated for items in shared drives.

canDownloadboolean

Whether the current user can download this file.

canEditboolean

Whether the current user can edit this file. Other factors might limit the type of changes a user can make to a file. For example, see canChangeCopyRequiresWriterPermission or canModifyContent.

canListChildrenboolean

Whether the current user can list the children of this folder. This is always false when the item isn't a folder.

canModifyContentboolean

Whether the current user can modify the content of this file.

canModifyContentRestrictionboolean

Whether the current user can modify restrictions on content of this file.

canModifyLabelsboolean

Whether the current user can modify the labels on this file.

canMoveChildrenOutOfDriveboolean

Whether the current user can move children of this folder outside of the shared drive. This is false when the item isn't a folder. Only populated for items in shared drives.

canMoveChildrenOutOfTeamDriveboolean

Deprecated - use canMoveChildrenOutOfDrive instead.

canMoveChildrenWithinDriveboolean

Whether the current user can move children of this folder within this shared drive or My Drive. This is false when the item isn't a folder. Note that a request to move the child might still fail depending on the current user's access to the child and to the destination folder.

canMoveChildrenWithinTeamDriveboolean

Deprecated - use canMoveChildrenWithinDrive instead.

canMoveItemIntoTeamDriveboolean

Deprecated - use canMoveItemOutOfDrive instead.

canMoveItemOutOfDriveboolean

Whether the current user can move this item outside of this shared drive or My Drive by changing its parent. Note that a request to change the parent of the item might still fail depending on the new parent that's being added.

canMoveItemOutOfTeamDriveboolean

Deprecated - use canMoveItemOutOfDrive instead.

canMoveItemWithinDriveboolean

Whether the current user can move this item within this shared drive or My Drive. Note that a request to change the parent of the item might still fail depending on the new parent that's being added and the parent that's being removed.

canMoveItemWithinTeamDriveboolean

Deprecated - use canMoveItemWithinDrive instead.

canMoveTeamDriveItemboolean

Deprecated - use canMoveItemWithinDrive or canMoveItemOutOfDrive instead.

canReadDriveboolean

Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives.

canReadLabelsboolean

Whether the current user can read the labels on this file.

canReadRevisionsboolean

Whether the current user can read the revisions resource of this file. For a shared drive item, whether revisions of non-folder descendants of this item, or this item itself if it's not a folder, can be read.

canReadTeamDriveboolean

Deprecated - use canReadDrive instead.

canRemoveChildrenboolean

Whether the current user can remove children from this folder. This is always false when the item isn't a folder. For a folder in a shared drive, use canDeleteChildren or canTrashChildren instead.

canRemoveMyDriveParentboolean

Whether the current user can remove a parent from the item without adding another parent in the same request. Not populated for shared drive files.

canRenameboolean

Whether the current user can rename this file.

canShareboolean

Whether the current user can modify the sharing settings for this file.

canTrashboolean

Whether the current user can move this file to trash.

canTrashChildrenboolean

Whether the current user can trash children of this folder. This is false when the item isn't a folder. Only populated for items in shared drives.

canUntrashboolean

Whether the current user can restore this file from trash.

contentHintsobject

Additional information about the content of the file. These fields are never populated in responses.

indexableTextstring

Text to be indexed for the file to improve fullText queries. This is limited to 128 KB in length and might contain HTML elements. For more information, see Manage file metadata.

thumbnailobject2 fields

A thumbnail for the file. This will only be used if Google Drive cannot generate a standard thumbnail.

contentRestrictionsarray<object>

Restrictions for accessing the content of the file. Only populated if such a restriction exists.

readOnlyboolean

Whether the content of the file is read-only. If a file is read-only, a new revision of the file may not be added, comments may not be added or modified, and the title of the file may not be modified.

reasonstring

Reason for why the content of the file is restricted. This is only mutable on requests that also set readOnly=true.

restrictingUserobject6 fields

Information about a Drive user.

restrictionTimestring (date-time)

The time at which the content restriction was set (formatted RFC 3339 timestamp). Only populated if readOnly is true.

typestring

The type of the content restriction. Currently the only possible value is globalContentRestriction.

copyRequiresWriterPermissionboolean

Whether the options to copy, print, or download this file, should be disabled for readers and commenters.

createdTimestring (date-time)

The time at which the file was created (RFC 3339 date-time).

descriptionstring

A short description of the file.

driveIdstring

ID of the shared drive the file resides in. Only populated for items in shared drives.

explicitlyTrashedboolean

Whether the file has been explicitly trashed, as opposed to recursively trashed from a parent folder.

exportLinksobject

Links for exporting Docs Editors files to specific formats.

fileExtensionstring

The final component of fullFileExtension. This is only available for files with binary content in Google Drive.

folderColorRgbstring

The color for a folder or shortcut to a folder as an RGB hex string. The supported colors are published in the folderColorPalette field of the About resource. If an unsupported color is specified, the closest color in the palette will be used instead.

fullFileExtensionstring

The full file extension extracted from the name field. Can 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 does not contain a valid extension.

hasAugmentedPermissionsboolean

Whether there are permissions directly on this file. This field is only populated for items in shared drives.

hasThumbnailboolean

Whether this file has a thumbnail. This does not indicate whether the requesting app has access to the thumbnail. To check access, look for the presence of the thumbnailLink field.

headRevisionIdstring

The ID of the file's head revision. This is only available for files with binary content in Google Drive.

iconLinkstring

A static, unauthenticated link to the file's icon.

idstring

The ID of the file.

imageMediaMetadataobject

Additional metadata about image media, if available.

aperturenumber (float)

The aperture used to create the photo (f-number).

cameraMakestring

The make of the camera used to create the photo.

cameraModelstring

The model of the camera used to create the photo.

colorSpacestring

The color space of the photo.

exposureBiasnumber (float)

The exposure bias of the photo (APEX value).

exposureModestring

The exposure mode used to create the photo.

exposureTimenumber (float)

The length of the exposure, in seconds.

flashUsedboolean

Whether a flash was used to create the photo.

focalLengthnumber (float)

The focal length used to create the photo, in millimeters.

heightinteger (int32)

The height of the image in pixels.

isoSpeedinteger (int32)

The ISO speed used to create the photo.

lensstring

The lens used to create the photo.

locationobject3 fields

Geographic location information stored in the image.

maxApertureValuenumber (float)

The smallest f-number of the lens at the focal length used to create the photo (APEX value).

meteringModestring

The metering mode used to create the photo.

rotationinteger (int32)

The number of clockwise 90-degree rotations applied from the image's original orientation.

sensorstring

The type of sensor used to create the photo.

subjectDistanceinteger (int32)

The distance to the subject of the photo, in meters.

timestring

The date and time the photo was taken (EXIF DateTime).

whiteBalancestring

The white balance mode used to create the photo.

widthinteger (int32)

The width of the image in pixels.

isAppAuthorizedboolean

Whether the requesting app created or opened the file.

kindstring

Identifies what kind of resource this is. Value: the fixed string "drive#file".

Default "drive#file"

labelInfoobject

An overview of the labels on the file.

labelsarray<object>4 fields

The set of labels on the file as requested by the label IDs in the includeLabels parameter. By default, no labels are returned.

lastModifyingUserobject

Information about a Drive user.

displayNamestring

A plain text displayable name for this user.

emailAddressstring

The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.

kindstring

Identifies what kind of resource this is. Value: the fixed string "drive#user".

Default "drive#user"

meboolean

Whether this user is the requesting user.

permissionIdstring

The user's ID as visible in Permission resources.

photoLinkstring

A link to the user's profile photo, if available.

linkShareMetadataobject

Contains details about the link URLs that clients are using to refer to this item.

securityUpdateEligibleboolean

Whether the file is eligible for security update.

securityUpdateEnabledboolean

Whether the security update is enabled for this file.

md5Checksumstring

The MD5 checksum for the content of the file. This is only applicable to files with binary content in Google Drive.

mimeTypestring

The MIME type of the file. Google Drive will attempt 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 will be imported if possible. The supported import formats are published in the About resource.

modifiedByMeboolean

Whether this user has modified the file.

modifiedByMeTimestring (date-time)

The last time the user modified the file (RFC 3339 date-time).

modifiedTimestring (date-time)

The last time anyone modified the file (RFC 3339 date-time). Note that setting modifiedTime will also update modifiedByMeTime for the user.

namestring

The 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, My Drive root folder, and Application Data folder the name is constant.

originalFilenamestring

The 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.

ownedByMeboolean

Whether the user owns the file. Not populated for items in shared drives.

ownersarray<object>

The owner of this file. Only certain legacy files might have more than one owner. This field isn't populated for items in shared drives.

displayNamestring

A plain text displayable name for this user.

emailAddressstring

The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.

kindstring

Identifies what kind of resource this is. Value: the fixed string "drive#user".

Default "drive#user"

meboolean

Whether this user is the requesting user.

permissionIdstring

The user's ID as visible in Permission resources.

photoLinkstring

A link to the user's profile photo, if available.

parentsarray<string>

The IDs of the parent folders that contain the file. If not specified as part of a create request, the file will be placed directly in the user's My Drive folder. If not specified as part of a copy request, the file will inherit any discoverable parents of the source file. Update requests must use the addParents and removeParents parameters to modify the parents list.

permissionIdsarray<string>

List of permission IDs for users with access to this file.

permissionsarray<object>

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.

allowFileDiscoveryboolean

Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type domain or anyone.

deletedboolean

Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.

displayNamestring

The "pretty" name of the value of the permission. The following is a list of examples for each type of permission: - user - User's full name, as defined for their Google Account, such as "Joe Smith." - group - Name of the Google Group, such as "The Company Administrators." - domain - String domain name, such as "your-company.com." - anyone - No displayName is present.

domainstring

The domain to which this permission refers. The following options are currently allowed: - The entire domain, such as "your-company.com." - A target audience, such as "ID.audience.googledomains.com."

emailAddressstring

The email address of the user or group to which this permission refers.

expirationTimestring (date-time)

The time at which this permission will expire (RFC 3339 date-time). Expiration times have the following restrictions: - They cannot be set on shared drive items. - They can only be set on user and group permissions. - The time must be in the future. - The time cannot be more than one year in the future.

idstring

The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as permissionId. IDs should be treated as opaque values.

kindstring

Identifies what kind of resource this is. Value: the fixed string "drive#permission".

Default "drive#permission"

pendingOwnerboolean

Whether the account associated with this permission is a pending owner. Only populated for user type permissions for files that aren't in a shared drive.

permissionDetailsarray<object>4 fields

Details of whether the permissions on this shared drive item are inherited or are directly on this item. This is an output-only field that's present only for shared drive items.

photoLinkstring

A link to the user's profile photo, if available.

rolestring

The role granted by this permission. While new values may be supported in the future, the following are currently allowed: - owner - organizer - fileOrganizer - writer - commenter - reader

teamDrivePermissionDetailsarray<object>4 fields

Deprecated - use permissionDetails instead.

typestring

The type of the grantee. Valid values are: - user - group - domain - anyone When creating a permission, if type is user or group, you must provide an emailAddress for the user or group. When type is domain, you must provide a domain. There isn't extra information required for the anyone type.

viewstring

Indicates the view for this permission. Only populated for permissions that belong to a view. published is the only supported value.

propertiesobject

A collection of arbitrary key-value pairs that are visible to all apps. Entries with null values are cleared in update and copy requests.

quotaBytesUsedstring (int64)

The number of storage quota bytes used by the file. This includes the head revision as well as previous revisions with keepForever enabled.

resourceKeystring

A key needed to access the item via a shared link.

sha1Checksumstring

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.

json
{
  "appProperties": {},
  "capabilities": {
    "canAcceptOwnership": false,
    "canAddChildren": false,
    "canAddFolderFromAnotherDrive": false,
    "canAddMyDriveParent": false,
    "canChangeCopyRequiresWriterPermission": false,
    "canChangeSecurityUpdateEnabled": false,
    "canChangeViewersCanCopyContent": false,
    "canComment": false,
    "canCopy": false,
    "canDelete": false,
    "canDeleteChildren": false,
    "canDownload": false
  },
  "contentHints": {
    "indexableText": "string",
    "thumbnail": {
      "image": "string",
      "mimeType": "string"
    }
  },
  "contentRestrictions": [
    {
      "readOnly": false,
      "reason": "string",
      "restrictingUser": {
        "displayName": "string",
        "emailAddress": "string",
        "kind": "drive#user",
        "me": false,
        "permissionId": "string",
        "photoLink": "string"
      },
      "restrictionTime": "2025-01-01T00:00:00Z",
      "type": "string"
    }
  ],
  "copyRequiresWriterPermission": false,
  "createdTime": "2025-01-01T00:00:00Z",
  "description": "string",
  "driveId": "string",
  "explicitlyTrashed": false,
  "exportLinks": {},
  "fileExtension": "string",
  "folderColorRgb": "string"
}

Need more? See the Google Drive guide for connection setup and behaviour shared by every action.