Close httplib2 connections.
Creates a copy of a file and applies any requested updates with patch semantics.
Creates a new file. This method supports an */upload* URI and accepts uploaded media with the following characteristics: - *Maximum file size:* 5,120 GB - *Accepted Media MIME types:*`*/*` Note: Specify a valid MIME type, rather than the literal `*/*` value. The literal `*/*` is only used to indicate that any valid MIME type can be uploaded. For more information on uploading files, see [Upload file data](/drive/api/guides/manage-uploads). Apps creating shortcuts with `files.create` must specify the MIME type `application/vnd.google-apps.shortcut`. Apps should specify a file extension in the `name` property when inserting files with the API. For example, an operation to insert a JPEG file should specify something like `"name": "cat.jpg"` in the metadata. Subsequent `GET` requests include the read-only `fileExtension` property populated with the extension originally specified in the `title` property. When a Google Drive user requests to download a file, or when the file is downloaded through the sync client, Drive builds a full filename (with extension) based on the title. In cases where the extension is missing, Drive attempts to determine the extension based on the file's MIME type.
Permanently deletes a file owned by the user without moving it to the trash. If the file belongs to a shared drive, the user must be an `organizer` on the parent folder. If the target is a folder, all descendants owned by the user are also deleted.
download(fileId, mimeType=None, revisionId=None, x__xgafv=None)
Downloads content of a file. Operations are valid for 24 hours from the time of creation.
emptyTrash(driveId=None, enforceSingleParent=None, x__xgafv=None)
Permanently deletes all of the user's trashed files.
export(fileId, mimeType, x__xgafv=None)
Exports a Google Workspace document to the requested MIME type and returns exported byte content. Note that the exported content is limited to 10MB.
export_media(fileId, mimeType, x__xgafv=None)
Exports a Google Workspace document to the requested MIME type and returns exported byte content. Note that the exported content is limited to 10MB.
generateIds(count=None, space=None, type=None, x__xgafv=None)
Generates a set of file IDs which can be provided in create or copy requests.
Gets a file's metadata or content by ID. If you provide the URL parameter `alt=media`, then the response includes the file contents in the response body. Downloading content with `alt=media` only works if the file is stored in Drive. To download Google Docs, Sheets, and Slides use [`files.export`](/drive/api/reference/rest/v3/files/export) instead. For more information, see [Download & export files](/drive/api/guides/manage-downloads).
Gets a file's metadata or content by ID. If you provide the URL parameter `alt=media`, then the response includes the file contents in the response body. Downloading content with `alt=media` only works if the file is stored in Drive. To download Google Docs, Sheets, and Slides use [`files.export`](/drive/api/reference/rest/v3/files/export) instead. For more information, see [Download & export files](/drive/api/guides/manage-downloads).
Lists the user's files. This method accepts the `q` parameter, which is a search query combining one or more search terms. For more information, see the [Search for files & folders](/drive/api/guides/search-files) guide. *Note:* This method returns *all* files by default, including trashed files. If you don't want trashed files to appear in the list, use the `trashed=false` query parameter to remove trashed files from the results.
listLabels(fileId, maxResults=None, pageToken=None, x__xgafv=None)
Lists the labels on a file.
Retrieves the next page of results.
Retrieves the next page of results.
modifyLabels(fileId, body=None, x__xgafv=None)
Modifies the set of labels applied to a file. Returns a list of the labels that were added or modified.
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 be changed automatically, such as `modifiedDate`. This method supports patch semantics. This method supports an */upload* URI and accepts uploaded media with the following characteristics: - *Maximum file size:* 5,120 GB - *Accepted Media MIME types:*`*/*` Note: Specify a valid MIME type, rather than the literal `*/*` value. The literal `*/*` is only used to indicate that any valid MIME type can be uploaded. For more information on uploading files, see [Upload file data](/drive/api/guides/manage-uploads).
Subscribes to changes to a file.
close()
Close httplib2 connections.
copy(fileId, body=None, enforceSingleParent=None, ignoreDefaultVisibility=None, includeLabels=None, includePermissionsForView=None, keepRevisionForever=None, ocrLanguage=None, supportsAllDrives=None, supportsTeamDrives=None, x__xgafv=None)
Creates a copy of a file and applies any requested updates with patch semantics.
Args:
fileId: string, The ID of the file. (required)
body: object, The request body.
The object takes the form of:
{ # The 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.
"appProperties": { # A 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.
"a_key": "A String",
},
"capabilities": { # Output only. Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take.
"canAcceptOwnership": True or False, # Output only. Whether the current user is the pending owner of the file. Not populated for shared drive files.
"canAddChildren": True or False, # Output only. Whether the current user can add children to this folder. This is always false when the item is not a folder.
"canAddFolderFromAnotherDrive": True or False, # Output only. 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 is not a folder. Only populated for items in shared drives.
"canAddMyDriveParent": True or False, # Output only. 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.
"canChangeCopyRequiresWriterPermission": True or False, # Output only. Whether the current user can change the `copyRequiresWriterPermission` restriction of this file.
"canChangeSecurityUpdateEnabled": True or False, # Output only. Whether the current user can change the securityUpdateEnabled field on link share metadata.
"canChangeViewersCanCopyContent": True or False, # Deprecated: Output only.
"canComment": True or False, # Output only. Whether the current user can comment on this file.
"canCopy": True or False, # Output only. 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 is not a folder.
"canDelete": True or False, # Output only. Whether the current user can delete this file.
"canDeleteChildren": True or False, # Output only. Whether the current user can delete children of this folder. This is false when the item is not a folder. Only populated for items in shared drives.
"canDownload": True or False, # Output only. Whether the current user can download this file.
"canEdit": True or False, # Output only. Whether the current user can edit this file. Other factors may limit the type of changes a user can make to a file. For example, see `canChangeCopyRequiresWriterPermission` or `canModifyContent`.
"canListChildren": True or False, # Output only. Whether the current user can list the children of this folder. This is always false when the item is not a folder.
"canModifyContent": True or False, # Output only. Whether the current user can modify the content of this file.
"canModifyContentRestriction": True or False, # Deprecated: Output only. Use one of `canModifyEditorContentRestriction`, `canModifyOwnerContentRestriction` or `canRemoveContentRestriction`.
"canModifyEditorContentRestriction": True or False, # Output only. Whether the current user can add or modify content restrictions on the file which are editor restricted.
"canModifyLabels": True or False, # Output only. Whether the current user can modify the labels on the file.
"canModifyOwnerContentRestriction": True or False, # Output only. Whether the current user can add or modify content restrictions which are owner restricted.
"canMoveChildrenOutOfDrive": True or False, # Output only. Whether the current user can move children of this folder outside of the shared drive. This is false when the item is not a folder. Only populated for items in shared drives.
"canMoveChildrenOutOfTeamDrive": True or False, # Deprecated: Output only. Use `canMoveChildrenOutOfDrive` instead.
"canMoveChildrenWithinDrive": True or False, # Output only. Whether the current user can move children of this folder within this drive. This is false when the item is not a folder. Note that a request to move the child may still fail depending on the current user's access to the child and to the destination folder.
"canMoveChildrenWithinTeamDrive": True or False, # Deprecated: Output only. Use `canMoveChildrenWithinDrive` instead.
"canMoveItemIntoTeamDrive": True or False, # Deprecated: Output only. Use `canMoveItemOutOfDrive` instead.
"canMoveItemOutOfDrive": True or False, # Output only. Whether the current user can move this item outside of this drive by changing its parent. Note that a request to change the parent of the item may still fail depending on the new parent that is being added.
"canMoveItemOutOfTeamDrive": True or False, # Deprecated: Output only. Use `canMoveItemOutOfDrive` instead.
"canMoveItemWithinDrive": True or False, # Output only. Whether the current user can move this item within this drive. Note that a request to change the parent of the item may still fail depending on the new parent that is being added and the parent that is being removed.
"canMoveItemWithinTeamDrive": True or False, # Deprecated: Output only. Use `canMoveItemWithinDrive` instead.
"canMoveTeamDriveItem": True or False, # Deprecated: Output only. Use `canMoveItemWithinDrive` or `canMoveItemOutOfDrive` instead.
"canReadDrive": True or False, # Output only. Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives.
"canReadLabels": True or False, # Output only. Whether the current user can read the labels on the file.
"canReadRevisions": True or False, # Output only. 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 is not a folder, can be read.
"canReadTeamDrive": True or False, # Deprecated: Output only. Use `canReadDrive` instead.
"canRemoveChildren": True or False, # Output only. Whether the current user can remove children from this folder. This is always false when the item is not a folder. For a folder in a shared drive, use `canDeleteChildren` or `canTrashChildren` instead.
"canRemoveContentRestriction": True or False, # Output only. Whether there is a content restriction on the file that can be removed by the current user.
"canRemoveMyDriveParent": True or False, # Output only. 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.
"canRename": True or False, # Output only. Whether the current user can rename this file.
"canShare": True or False, # Output only. Whether the current user can modify the sharing settings for this file.
"canTrash": True or False, # Output only. Whether the current user can move this file to trash.
"canTrashChildren": True or False, # Output only. Whether the current user can trash children of this folder. This is false when the item is not a folder. Only populated for items in shared drives.
"canUntrash": True or False, # Output only. Whether the current user can restore this file from trash.
},
"contentHints": { # Additional information about the content of the file. These fields are never populated in responses.
"indexableText": "A String", # Text to be indexed for the file to improve fullText queries. This is limited to 128KB in length and may contain HTML elements.
"thumbnail": { # A thumbnail for the file. This will only be used if Google Drive cannot generate a standard thumbnail.
"image": "A String", # The thumbnail data encoded with URL-safe Base64 (RFC 4648 section 5).
"mimeType": "A String", # The MIME type of the thumbnail.
},
},
"contentRestrictions": [ # Restrictions for accessing the content of the file. Only populated if such a restriction exists.
{ # A restriction for accessing the content of the file.
"ownerRestricted": True or False, # Whether the content restriction can only be modified or removed by a user who owns the file. For files in shared drives, any user with `organizer` capabilities can modify or remove this content restriction.
"readOnly": True or False, # 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.
"reason": "A String", # Reason for why the content of the file is restricted. This is only mutable on requests that also set `readOnly=true`.
"restrictingUser": { # Information about a Drive user. # Output only. The user who set the content restriction. Only populated if `readOnly` is true.
"displayName": "A String", # Output only. A plain text displayable name for this user.
"emailAddress": "A String", # Output only. 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.
"kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#user"`.
"me": True or False, # Output only. Whether this user is the requesting user.
"permissionId": "A String", # Output only. The user's ID as visible in Permission resources.
"photoLink": "A String", # Output only. A link to the user's profile photo, if available.
},
"restrictionTime": "A String", # The time at which the content restriction was set (formatted RFC 3339 timestamp). Only populated if readOnly is true.
"systemRestricted": True or False, # Output only. Whether the content restriction was applied by the system, for example due to an esignature. Users cannot modify or remove system restricted content restrictions.
"type": "A String", # Output only. The type of the content restriction. Currently the only possible value is `globalContentRestriction`.
},
],
"copyRequiresWriterPermission": True or False, # Whether the options to copy, print, or download this file, should be disabled for readers and commenters.
"createdTime": "A String", # The time at which the file was created (RFC 3339 date-time).
"description": "A String", # A short description of the file.
"driveId": "A String", # Output only. ID of the shared drive the file resides in. Only populated for items in shared drives.
"explicitlyTrashed": True or False, # Output only. Whether the file has been explicitly trashed, as opposed to recursively trashed from a parent folder.
"exportLinks": { # Output only. Links for exporting Docs Editors files to specific formats.
"a_key": "A String",
},
"fileExtension": "A String", # Output only. The final component of `fullFileExtension`. This is only available for files with binary content in Google Drive.
"folderColorRgb": "A String", # The 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 resource. If an unsupported color is specified, the closest color in the palette is used instead.
"fullFileExtension": "A String", # Output 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 is not cleared if the new name does not contain a valid extension.
"hasAugmentedPermissions": True or False, # Output only. Whether there are permissions directly on this file. This field is only populated for items in shared drives.
"hasThumbnail": True or False, # Output only. 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.
"headRevisionId": "A String", # Output only. The ID of the file's head revision. This is currently only available for files with binary content in Google Drive.
"iconLink": "A String", # Output only. A static, unauthenticated link to the file's icon.
"id": "A String", # The ID of the file.
"imageMediaMetadata": { # Output only. Additional metadata about image media, if available.
"aperture": 3.14, # Output only. The aperture used to create the photo (f-number).
"cameraMake": "A String", # Output only. The make of the camera used to create the photo.
"cameraModel": "A String", # Output only. The model of the camera used to create the photo.
"colorSpace": "A String", # Output only. The color space of the photo.
"exposureBias": 3.14, # Output only. The exposure bias of the photo (APEX value).
"exposureMode": "A String", # Output only. The exposure mode used to create the photo.
"exposureTime": 3.14, # Output only. The length of the exposure, in seconds.
"flashUsed": True or False, # Output only. Whether a flash was used to create the photo.
"focalLength": 3.14, # Output only. The focal length used to create the photo, in millimeters.
"height": 42, # Output only. The height of the image in pixels.
"isoSpeed": 42, # Output only. The ISO speed used to create the photo.
"lens": "A String", # Output only. The lens used to create the photo.
"location": { # Output only. Geographic location information stored in the image.
"altitude": 3.14, # Output only. The altitude stored in the image.
"latitude": 3.14, # Output only. The latitude stored in the image.
"longitude": 3.14, # Output only. The longitude stored in the image.
},
"maxApertureValue": 3.14, # Output only. The smallest f-number of the lens at the focal length used to create the photo (APEX value).
"meteringMode": "A String", # Output only. The metering mode used to create the photo.
"rotation": 42, # Output only. The number of clockwise 90 degree rotations applied from the image's original orientation.
"sensor": "A String", # Output only. The type of sensor used to create the photo.
"subjectDistance": 42, # Output only. The distance to the subject of the photo, in meters.
"time": "A String", # Output only. The date and time the photo was taken (EXIF DateTime).
"whiteBalance": "A String", # Output only. The white balance mode used to create the photo.
"width": 42, # Output only. The width of the image in pixels.
},
"isAppAuthorized": True or False, # Output only. Whether the file was created or opened by the requesting app.
"kind": "drive#file", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#file"`.
"labelInfo": { # Output only. An overview of the labels on the file.
"labels": [ # Output only. The set of labels on the file as requested by the label IDs in the `includeLabels` parameter. By default, no labels are returned.
{ # Representation of label and label fields.
"fields": { # A map of the fields on the label, keyed by the field's ID.
"a_key": { # Representation of field, which is a typed key-value pair.
"dateString": [ # Only present if valueType is dateString. RFC 3339 formatted date: YYYY-MM-DD.
"A String",
],
"id": "A String", # The identifier of this label field.
"integer": [ # Only present if `valueType` is `integer`.
"A String",
],
"kind": "A String", # This is always drive#labelField.
"selection": [ # Only present if `valueType` is `selection`
"A String",
],
"text": [ # Only present if `valueType` is `text`.
"A String",
],
"user": [ # Only present if `valueType` is `user`.
{ # Information about a Drive user.
"displayName": "A String", # Output only. A plain text displayable name for this user.
"emailAddress": "A String", # Output only. 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.
"kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#user"`.
"me": True or False, # Output only. Whether this user is the requesting user.
"permissionId": "A String", # Output only. The user's ID as visible in Permission resources.
"photoLink": "A String", # Output only. A link to the user's profile photo, if available.
},
],
"valueType": "A String", # The field type. While new values may be supported in the future, the following are currently allowed: * `dateString` * `integer` * `selection` * `text` * `user`
},
},
"id": "A String", # The ID of the label.
"kind": "A String", # This is always drive#label
"revisionId": "A String", # The revision ID of the label.
},
],
},
"lastModifyingUser": { # Information about a Drive 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.
"displayName": "A String", # Output only. A plain text displayable name for this user.
"emailAddress": "A String", # Output only. 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.
"kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#user"`.
"me": True or False, # Output only. Whether this user is the requesting user.
"permissionId": "A String", # Output only. The user's ID as visible in Permission resources.
"photoLink": "A String", # Output only. A link to the user's profile photo, if available.
},
"linkShareMetadata": { # Contains details about the link URLs that clients are using to refer to this item.
"securityUpdateEligible": True or False, # Output only. Whether the file is eligible for security update.
"securityUpdateEnabled": True or False, # Output only. Whether the security update is enabled for this file.
},
"md5Checksum": "A String", # Output only. The MD5 checksum for the content of the file. This is only applicable to files with binary content in Google Drive.
"mimeType": "A String", # The 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 resource.
"modifiedByMe": True or False, # Output only. Whether the file has been modified by this user.
"modifiedByMeTime": "A String", # The last time the file was modified by the user (RFC 3339 date-time).
"modifiedTime": "A String", # he last time the file was modified by anyone (RFC 3339 date-time). Note that setting modifiedTime will also update modifiedByMeTime for the user.
"name": "A String", # The name of the file. This is not 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.
"originalFilename": "A String", # 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.
"ownedByMe": True or False, # Output only. Whether the user owns the file. Not populated for items in shared drives.
"owners": [ # Output 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.
{ # Information about a Drive user.
"displayName": "A String", # Output only. A plain text displayable name for this user.
"emailAddress": "A String", # Output only. 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.
"kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#user"`.
"me": True or False, # Output only. Whether this user is the requesting user.
"permissionId": "A String", # Output only. The user's ID as visible in Permission resources.
"photoLink": "A String", # Output only. A link to the user's profile photo, if available.
},
],
"parents": [ # The 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.
"A String",
],
"permissionIds": [ # Output only. List of permission IDs for users with access to this file.
"A String",
],
"permissions": [ # Output 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.
{ # A permission for a file. A permission grants a user, group, domain, or the world access to a file or a folder hierarchy. By default, permissions requests only return a subset of fields. Permission kind, ID, type, and role are always returned. To retrieve specific fields, see https://developers.google.com/drive/api/guides/fields-parameter. Some resource methods (such as `permissions.update`) require a `permissionId`. Use the `permissions.list` method to retrieve the ID for a file, folder, or shared drive.
"allowFileDiscovery": True or False, # Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type `domain` or `anyone`.
"deleted": True or False, # Output only. Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.
"displayName": "A String", # Output only. 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 "thecompany.com." * `anyone` - No `displayName` is present.
"domain": "A String", # The domain to which this permission refers.
"emailAddress": "A String", # The email address of the user or group to which this permission refers.
"expirationTime": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration times have the following restrictions: - They can only be set on user and group permissions - The time must be in the future - The time cannot be more than a year in the future
"id": "A String", # Output only. 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.
"kind": "drive#permission", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#permission"`.
"pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for `user` type permissions for files that are not in a shared drive.
"permissionDetails": [ # Output only. Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items.
{
"inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated. This is an output-only field.
"inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is an output-only field.
"permissionType": "A String", # Output only. The permission type for this user. While new values may be added in future, the following are currently possible: * `file` * `member`
"role": "A String", # Output only. The primary role for this user. While new values may be added in the future, the following are currently possible: * `organizer` * `fileOrganizer` * `writer` * `commenter` * `reader`
},
],
"photoLink": "A String", # Output only. A link to the user's profile photo, if available.
"role": "A String", # 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`
"teamDrivePermissionDetails": [ # Output only. Deprecated: Output only. Use `permissionDetails` instead.
{
"inherited": True or False, # Deprecated: Output only. Use `permissionDetails/inherited` instead.
"inheritedFrom": "A String", # Deprecated: Output only. Use `permissionDetails/inheritedFrom` instead.
"role": "A String", # Deprecated: Output only. Use `permissionDetails/role` instead.
"teamDrivePermissionType": "A String", # Deprecated: Output only. Use `permissionDetails/permissionType` instead.
},
],
"type": "A String", # 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 an `anyone` type.
"view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. 'published' is the only supported value.
},
],
"properties": { # A collection of arbitrary key-value pairs which are visible to all apps.
# Entries with null values are cleared in update and copy requests.
"a_key": "A String",
},
"quotaBytesUsed": "A String", # Output only. The number of storage quota bytes used by the file. This includes the head revision as well as previous revisions with `keepForever` enabled.
"resourceKey": "A String", # Output only. A key needed to access the item via a shared link.
"sha1Checksum": "A String", # Output only. The SHA1 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.
"sha256Checksum": "A String", # Output only. The SHA256 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.
"shared": True or False, # Output only. Whether the file has been shared. Not populated for items in shared drives.
"sharedWithMeTime": "A String", # The time at which the file was shared with the user, if applicable (RFC 3339 date-time).
"sharingUser": { # Information about a Drive user. # Output only. The user who shared the file with the requesting user, if applicable.
"displayName": "A String", # Output only. A plain text displayable name for this user.
"emailAddress": "A String", # Output only. 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.
"kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#user"`.
"me": True or False, # Output only. Whether this user is the requesting user.
"permissionId": "A String", # Output only. The user's ID as visible in Permission resources.
"photoLink": "A String", # Output only. A link to the user's profile photo, if available.
},
"shortcutDetails": { # Shortcut file details. Only populated for shortcut files, which have the mimeType field set to `application/vnd.google-apps.shortcut`. Can only be set on `files.create` requests.
"targetId": "A String", # The ID of the file that this shortcut points to. Can only be set on `files.create` requests.
"targetMimeType": "A String", # Output only. The MIME type of the file that this shortcut points to. The value of this field is a snapshot of the target's MIME type, captured when the shortcut is created.
"targetResourceKey": "A String", # Output only. The ResourceKey for the target file.
},
"size": "A String", # Output only. Size in bytes of blobs and first party editor files. Won't be populated for files that have no size, like shortcuts and folders.
"spaces": [ # Output only. The list of spaces which contain the file. The currently supported values are 'drive', 'appDataFolder' and 'photos'.
"A String",
],
"starred": True or False, # Whether the user has starred the file.
"teamDriveId": "A String", # Deprecated: Output only. Use `driveId` instead.
"thumbnailLink": "A String", # Output 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.
"thumbnailVersion": "A String", # Output only. The thumbnail version for use in thumbnail cache invalidation.
"trashed": True or False, # Whether the file has been trashed, either explicitly or from a trashed parent folder. Only the owner may trash a file, and other users cannot see files in the owner's trash.
"trashedTime": "A String", # The time that the item was trashed (RFC 3339 date-time). Only populated for items in shared drives.
"trashingUser": { # Information about a Drive user. # Output only. If the file has been explicitly trashed, the user who trashed it. Only populated for items in shared drives.
"displayName": "A String", # Output only. A plain text displayable name for this user.
"emailAddress": "A String", # Output only. 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.
"kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#user"`.
"me": True or False, # Output only. Whether this user is the requesting user.
"permissionId": "A String", # Output only. The user's ID as visible in Permission resources.
"photoLink": "A String", # Output only. A link to the user's profile photo, if available.
},
"version": "A String", # Output 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.
"videoMediaMetadata": { # Output only. Additional metadata about video media. This may not be available immediately upon upload.
"durationMillis": "A String", # Output only. The duration of the video in milliseconds.
"height": 42, # Output only. The height of the video in pixels.
"width": 42, # Output only. The width of the video in pixels.
},
"viewedByMe": True or False, # Output only. Whether the file has been viewed by this user.
"viewedByMeTime": "A String", # The last time the file was viewed by the user (RFC 3339 date-time).
"viewersCanCopyContent": True or False, # Deprecated: Use `copyRequiresWriterPermission` instead.
"webContentLink": "A String", # Output 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.
"webViewLink": "A String", # Output only. A link for opening the file in a relevant Google editor or viewer in a browser.
"writersCanShare": True or False, # Whether users with only `writer` permission can modify the file's permissions. Not populated for items in shared drives.
}
enforceSingleParent: boolean, Deprecated. Copying files into multiple folders is no longer supported. Use shortcuts instead.
ignoreDefaultVisibility: boolean, 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.
includeLabels: string, A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.
includePermissionsForView: string, Specifies which additional view's permissions to include in the response. Only 'published' is supported.
keepRevisionForever: boolean, 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.
ocrLanguage: string, A language hint for OCR processing during image import (ISO 639-1 code).
supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives.
supportsTeamDrives: boolean, Deprecated: Use `supportsAllDrives` instead.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The 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.
"appProperties": { # A 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.
"a_key": "A String",
},
"capabilities": { # Output only. Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take.
"canAcceptOwnership": True or False, # Output only. Whether the current user is the pending owner of the file. Not populated for shared drive files.
"canAddChildren": True or False, # Output only. Whether the current user can add children to this folder. This is always false when the item is not a folder.
"canAddFolderFromAnotherDrive": True or False, # Output only. 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 is not a folder. Only populated for items in shared drives.
"canAddMyDriveParent": True or False, # Output only. 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.
"canChangeCopyRequiresWriterPermission": True or False, # Output only. Whether the current user can change the `copyRequiresWriterPermission` restriction of this file.
"canChangeSecurityUpdateEnabled": True or False, # Output only. Whether the current user can change the securityUpdateEnabled field on link share metadata.
"canChangeViewersCanCopyContent": True or False, # Deprecated: Output only.
"canComment": True or False, # Output only. Whether the current user can comment on this file.
"canCopy": True or False, # Output only. 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 is not a folder.
"canDelete": True or False, # Output only. Whether the current user can delete this file.
"canDeleteChildren": True or False, # Output only. Whether the current user can delete children of this folder. This is false when the item is not a folder. Only populated for items in shared drives.
"canDownload": True or False, # Output only. Whether the current user can download this file.
"canEdit": True or False, # Output only. Whether the current user can edit this file. Other factors may limit the type of changes a user can make to a file. For example, see `canChangeCopyRequiresWriterPermission` or `canModifyContent`.
"canListChildren": True or False, # Output only. Whether the current user can list the children of this folder. This is always false when the item is not a folder.
"canModifyContent": True or False, # Output only. Whether the current user can modify the content of this file.
"canModifyContentRestriction": True or False, # Deprecated: Output only. Use one of `canModifyEditorContentRestriction`, `canModifyOwnerContentRestriction` or `canRemoveContentRestriction`.
"canModifyEditorContentRestriction": True or False, # Output only. Whether the current user can add or modify content restrictions on the file which are editor restricted.
"canModifyLabels": True or False, # Output only. Whether the current user can modify the labels on the file.
"canModifyOwnerContentRestriction": True or False, # Output only. Whether the current user can add or modify content restrictions which are owner restricted.
"canMoveChildrenOutOfDrive": True or False, # Output only. Whether the current user can move children of this folder outside of the shared drive. This is false when the item is not a folder. Only populated for items in shared drives.
"canMoveChildrenOutOfTeamDrive": True or False, # Deprecated: Output only. Use `canMoveChildrenOutOfDrive` instead.
"canMoveChildrenWithinDrive": True or False, # Output only. Whether the current user can move children of this folder within this drive. This is false when the item is not a folder. Note that a request to move the child may still fail depending on the current user's access to the child and to the destination folder.
"canMoveChildrenWithinTeamDrive": True or False, # Deprecated: Output only. Use `canMoveChildrenWithinDrive` instead.
"canMoveItemIntoTeamDrive": True or False, # Deprecated: Output only. Use `canMoveItemOutOfDrive` instead.
"canMoveItemOutOfDrive": True or False, # Output only. Whether the current user can move this item outside of this drive by changing its parent. Note that a request to change the parent of the item may still fail depending on the new parent that is being added.
"canMoveItemOutOfTeamDrive": True or False, # Deprecated: Output only. Use `canMoveItemOutOfDrive` instead.
"canMoveItemWithinDrive": True or False, # Output only. Whether the current user can move this item within this drive. Note that a request to change the parent of the item may still fail depending on the new parent that is being added and the parent that is being removed.
"canMoveItemWithinTeamDrive": True or False, # Deprecated: Output only. Use `canMoveItemWithinDrive` instead.
"canMoveTeamDriveItem": True or False, # Deprecated: Output only. Use `canMoveItemWithinDrive` or `canMoveItemOutOfDrive` instead.
"canReadDrive": True or False, # Output only. Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives.
"canReadLabels": True or False, # Output only. Whether the current user can read the labels on the file.
"canReadRevisions": True or False, # Output only. 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 is not a folder, can be read.
"canReadTeamDrive": True or False, # Deprecated: Output only. Use `canReadDrive` instead.
"canRemoveChildren": True or False, # Output only. Whether the current user can remove children from this folder. This is always false when the item is not a folder. For a folder in a shared drive, use `canDeleteChildren` or `canTrashChildren` instead.
"canRemoveContentRestriction": True or False, # Output only. Whether there is a content restriction on the file that can be removed by the current user.
"canRemoveMyDriveParent": True or False, # Output only. 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.
"canRename": True or False, # Output only. Whether the current user can rename this file.
"canShare": True or False, # Output only. Whether the current user can modify the sharing settings for this file.
"canTrash": True or False, # Output only. Whether the current user can move this file to trash.
"canTrashChildren": True or False, # Output only. Whether the current user can trash children of this folder. This is false when the item is not a folder. Only populated for items in shared drives.
"canUntrash": True or False, # Output only. Whether the current user can restore this file from trash.
},
"contentHints": { # Additional information about the content of the file. These fields are never populated in responses.
"indexableText": "A String", # Text to be indexed for the file to improve fullText queries. This is limited to 128KB in length and may contain HTML elements.
"thumbnail": { # A thumbnail for the file. This will only be used if Google Drive cannot generate a standard thumbnail.
"image": "A String", # The thumbnail data encoded with URL-safe Base64 (RFC 4648 section 5).
"mimeType": "A String", # The MIME type of the thumbnail.
},
},
"contentRestrictions": [ # Restrictions for accessing the content of the file. Only populated if such a restriction exists.
{ # A restriction for accessing the content of the file.
"ownerRestricted": True or False, # Whether the content restriction can only be modified or removed by a user who owns the file. For files in shared drives, any user with `organizer` capabilities can modify or remove this content restriction.
"readOnly": True or False, # 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.
"reason": "A String", # Reason for why the content of the file is restricted. This is only mutable on requests that also set `readOnly=true`.
"restrictingUser": { # Information about a Drive user. # Output only. The user who set the content restriction. Only populated if `readOnly` is true.
"displayName": "A String", # Output only. A plain text displayable name for this user.
"emailAddress": "A String", # Output only. 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.
"kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#user"`.
"me": True or False, # Output only. Whether this user is the requesting user.
"permissionId": "A String", # Output only. The user's ID as visible in Permission resources.
"photoLink": "A String", # Output only. A link to the user's profile photo, if available.
},
"restrictionTime": "A String", # The time at which the content restriction was set (formatted RFC 3339 timestamp). Only populated if readOnly is true.
"systemRestricted": True or False, # Output only. Whether the content restriction was applied by the system, for example due to an esignature. Users cannot modify or remove system restricted content restrictions.
"type": "A String", # Output only. The type of the content restriction. Currently the only possible value is `globalContentRestriction`.
},
],
"copyRequiresWriterPermission": True or False, # Whether the options to copy, print, or download this file, should be disabled for readers and commenters.
"createdTime": "A String", # The time at which the file was created (RFC 3339 date-time).
"description": "A String", # A short description of the file.
"driveId": "A String", # Output only. ID of the shared drive the file resides in. Only populated for items in shared drives.
"explicitlyTrashed": True or False, # Output only. Whether the file has been explicitly trashed, as opposed to recursively trashed from a parent folder.
"exportLinks": { # Output only. Links for exporting Docs Editors files to specific formats.
"a_key": "A String",
},
"fileExtension": "A String", # Output only. The final component of `fullFileExtension`. This is only available for files with binary content in Google Drive.
"folderColorRgb": "A String", # The 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 resource. If an unsupported color is specified, the closest color in the palette is used instead.
"fullFileExtension": "A String", # Output 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 is not cleared if the new name does not contain a valid extension.
"hasAugmentedPermissions": True or False, # Output only. Whether there are permissions directly on this file. This field is only populated for items in shared drives.
"hasThumbnail": True or False, # Output only. 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.
"headRevisionId": "A String", # Output only. The ID of the file's head revision. This is currently only available for files with binary content in Google Drive.
"iconLink": "A String", # Output only. A static, unauthenticated link to the file's icon.
"id": "A String", # The ID of the file.
"imageMediaMetadata": { # Output only. Additional metadata about image media, if available.
"aperture": 3.14, # Output only. The aperture used to create the photo (f-number).
"cameraMake": "A String", # Output only. The make of the camera used to create the photo.
"cameraModel": "A String", # Output only. The model of the camera used to create the photo.
"colorSpace": "A String", # Output only. The color space of the photo.
"exposureBias": 3.14, # Output only. The exposure bias of the photo (APEX value).
"exposureMode": "A String", # Output only. The exposure mode used to create the photo.
"exposureTime": 3.14, # Output only. The length of the exposure, in seconds.
"flashUsed": True or False, # Output only. Whether a flash was used to create the photo.
"focalLength": 3.14, # Output only. The focal length used to create the photo, in millimeters.
"height": 42, # Output only. The height of the image in pixels.
"isoSpeed": 42, # Output only. The ISO speed used to create the photo.
"lens": "A String", # Output only. The lens used to create the photo.
"location": { # Output only. Geographic location information stored in the image.
"altitude": 3.14, # Output only. The altitude stored in the image.
"latitude": 3.14, # Output only. The latitude stored in the image.
"longitude": 3.14, # Output only. The longitude stored in the image.
},
"maxApertureValue": 3.14, # Output only. The smallest f-number of the lens at the focal length used to create the photo (APEX value).
"meteringMode": "A String", # Output only. The metering mode used to create the photo.
"rotation": 42, # Output only. The number of clockwise 90 degree rotations applied from the image's original orientation.
"sensor": "A String", # Output only. The type of sensor used to create the photo.
"subjectDistance": 42, # Output only. The distance to the subject of the photo, in meters.
"time": "A String", # Output only. The date and time the photo was taken (EXIF DateTime).
"whiteBalance": "A String", # Output only. The white balance mode used to create the photo.
"width": 42, # Output only. The width of the image in pixels.
},
"isAppAuthorized": True or False, # Output only. Whether the file was created or opened by the requesting app.
"kind": "drive#file", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#file"`.
"labelInfo": { # Output only. An overview of the labels on the file.
"labels": [ # Output only. The set of labels on the file as requested by the label IDs in the `includeLabels` parameter. By default, no labels are returned.
{ # Representation of label and label fields.
"fields": { # A map of the fields on the label, keyed by the field's ID.
"a_key": { # Representation of field, which is a typed key-value pair.
"dateString": [ # Only present if valueType is dateString. RFC 3339 formatted date: YYYY-MM-DD.
"A String",
],
"id": "A String", # The identifier of this label field.
"integer": [ # Only present if `valueType` is `integer`.
"A String",
],
"kind": "A String", # This is always drive#labelField.
"selection": [ # Only present if `valueType` is `selection`
"A String",
],
"text": [ # Only present if `valueType` is `text`.
"A String",
],
"user": [ # Only present if `valueType` is `user`.
{ # Information about a Drive user.
"displayName": "A String", # Output only. A plain text displayable name for this user.
"emailAddress": "A String", # Output only. 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.
"kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#user"`.
"me": True or False, # Output only. Whether this user is the requesting user.
"permissionId": "A String", # Output only. The user's ID as visible in Permission resources.
"photoLink": "A String", # Output only. A link to the user's profile photo, if available.
},
],
"valueType": "A String", # The field type. While new values may be supported in the future, the following are currently allowed: * `dateString` * `integer` * `selection` * `text` * `user`
},
},
"id": "A String", # The ID of the label.
"kind": "A String", # This is always drive#label
"revisionId": "A String", # The revision ID of the label.
},
],
},
"lastModifyingUser": { # Information about a Drive 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.
"displayName": "A String", # Output only. A plain text displayable name for this user.
"emailAddress": "A String", # Output only. 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.
"kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#user"`.
"me": True or False, # Output only. Whether this user is the requesting user.
"permissionId": "A String", # Output only. The user's ID as visible in Permission resources.
"photoLink": "A String", # Output only. A link to the user's profile photo, if available.
},
"linkShareMetadata": { # Contains details about the link URLs that clients are using to refer to this item.
"securityUpdateEligible": True or False, # Output only. Whether the file is eligible for security update.
"securityUpdateEnabled": True or False, # Output only. Whether the security update is enabled for this file.
},
"md5Checksum": "A String", # Output only. The MD5 checksum for the content of the file. This is only applicable to files with binary content in Google Drive.
"mimeType": "A String", # The 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 resource.
"modifiedByMe": True or False, # Output only. Whether the file has been modified by this user.
"modifiedByMeTime": "A String", # The last time the file was modified by the user (RFC 3339 date-time).
"modifiedTime": "A String", # he last time the file was modified by anyone (RFC 3339 date-time). Note that setting modifiedTime will also update modifiedByMeTime for the user.
"name": "A String", # The name of the file. This is not 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.
"originalFilename": "A String", # 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.
"ownedByMe": True or False, # Output only. Whether the user owns the file. Not populated for items in shared drives.
"owners": [ # Output 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.
{ # Information about a Drive user.
"displayName": "A String", # Output only. A plain text displayable name for this user.
"emailAddress": "A String", # Output only. 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.
"kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#user"`.
"me": True or False, # Output only. Whether this user is the requesting user.
"permissionId": "A String", # Output only. The user's ID as visible in Permission resources.
"photoLink": "A String", # Output only. A link to the user's profile photo, if available.
},
],
"parents": [ # The 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.
"A String",
],
"permissionIds": [ # Output only. List of permission IDs for users with access to this file.
"A String",
],
"permissions": [ # Output 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.
{ # A permission for a file. A permission grants a user, group, domain, or the world access to a file or a folder hierarchy. By default, permissions requests only return a subset of fields. Permission kind, ID, type, and role are always returned. To retrieve specific fields, see https://developers.google.com/drive/api/guides/fields-parameter. Some resource methods (such as `permissions.update`) require a `permissionId`. Use the `permissions.list` method to retrieve the ID for a file, folder, or shared drive.
"allowFileDiscovery": True or False, # Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type `domain` or `anyone`.
"deleted": True or False, # Output only. Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.
"displayName": "A String", # Output only. 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 "thecompany.com." * `anyone` - No `displayName` is present.
"domain": "A String", # The domain to which this permission refers.
"emailAddress": "A String", # The email address of the user or group to which this permission refers.
"expirationTime": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration times have the following restrictions: - They can only be set on user and group permissions - The time must be in the future - The time cannot be more than a year in the future
"id": "A String", # Output only. 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.
"kind": "drive#permission", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#permission"`.
"pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for `user` type permissions for files that are not in a shared drive.
"permissionDetails": [ # Output only. Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items.
{
"inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated. This is an output-only field.
"inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is an output-only field.
"permissionType": "A String", # Output only. The permission type for this user. While new values may be added in future, the following are currently possible: * `file` * `member`
"role": "A String", # Output only. The primary role for this user. While new values may be added in the future, the following are currently possible: * `organizer` * `fileOrganizer` * `writer` * `commenter` * `reader`
},
],
"photoLink": "A String", # Output only. A link to the user's profile photo, if available.
"role": "A String", # 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`
"teamDrivePermissionDetails": [ # Output only. Deprecated: Output only. Use `permissionDetails` instead.
{
"inherited": True or False, # Deprecated: Output only. Use `permissionDetails/inherited` instead.
"inheritedFrom": "A String", # Deprecated: Output only. Use `permissionDetails/inheritedFrom` instead.
"role": "A String", # Deprecated: Output only. Use `permissionDetails/role` instead.
"teamDrivePermissionType": "A String", # Deprecated: Output only. Use `permissionDetails/permissionType` instead.
},
],
"type": "A String", # 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 an `anyone` type.
"view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. 'published' is the only supported value.
},
],
"properties": { # A collection of arbitrary key-value pairs which are visible to all apps.
# Entries with null values are cleared in update and copy requests.
"a_key": "A String",
},
"quotaBytesUsed": "A String", # Output only. The number of storage quota bytes used by the file. This includes the head revision as well as previous revisions with `keepForever` enabled.
"resourceKey": "A String", # Output only. A key needed to access the item via a shared link.
"sha1Checksum": "A String", # Output only. The SHA1 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.
"sha256Checksum": "A String", # Output only. The SHA256 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.
"shared": True or False, # Output only. Whether the file has been shared. Not populated for items in shared drives.
"sharedWithMeTime": "A String", # The time at which the file was shared with the user, if applicable (RFC 3339 date-time).
"sharingUser": { # Information about a Drive user. # Output only. The user who shared the file with the requesting user, if applicable.
"displayName": "A String", # Output only. A plain text displayable name for this user.
"emailAddress": "A String", # Output only. 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.
"kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#user"`.
"me": True or False, # Output only. Whether this user is the requesting user.
"permissionId": "A String", # Output only. The user's ID as visible in Permission resources.
"photoLink": "A String", # Output only. A link to the user's profile photo, if available.
},
"shortcutDetails": { # Shortcut file details. Only populated for shortcut files, which have the mimeType field set to `application/vnd.google-apps.shortcut`. Can only be set on `files.create` requests.
"targetId": "A String", # The ID of the file that this shortcut points to. Can only be set on `files.create` requests.
"targetMimeType": "A String", # Output only. The MIME type of the file that this shortcut points to. The value of this field is a snapshot of the target's MIME type, captured when the shortcut is created.
"targetResourceKey": "A String", # Output only. The ResourceKey for the target file.
},
"size": "A String", # Output only. Size in bytes of blobs and first party editor files. Won't be populated for files that have no size, like shortcuts and folders.
"spaces": [ # Output only. The list of spaces which contain the file. The currently supported values are 'drive', 'appDataFolder' and 'photos'.
"A String",
],
"starred": True or False, # Whether the user has starred the file.
"teamDriveId": "A String", # Deprecated: Output only. Use `driveId` instead.
"thumbnailLink": "A String", # Output 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.
"thumbnailVersion": "A String", # Output only. The thumbnail version for use in thumbnail cache invalidation.
"trashed": True or False, # Whether the file has been trashed, either explicitly or from a trashed parent folder. Only the owner may trash a file, and other users cannot see files in the owner's trash.
"trashedTime": "A String", # The time that the item was trashed (RFC 3339 date-time). Only populated for items in shared drives.
"trashingUser": { # Information about a Drive user. # Output only. If the file has been explicitly trashed, the user who trashed it. Only populated for items in shared drives.
"displayName": "A String", # Output only. A plain text displayable name for this user.
"emailAddress": "A String", # Output only. 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.
"kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#user"`.
"me": True or False, # Output only. Whether this user is the requesting user.
"permissionId": "A String", # Output only. The user's ID as visible in Permission resources.
"photoLink": "A String", # Output only. A link to the user's profile photo, if available.
},
"version": "A String", # Output 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.
"videoMediaMetadata": { # Output only. Additional metadata about video media. This may not be available immediately upon upload.
"durationMillis": "A String", # Output only. The duration of the video in milliseconds.
"height": 42, # Output only. The height of the video in pixels.
"width": 42, # Output only. The width of the video in pixels.
},
"viewedByMe": True or False, # Output only. Whether the file has been viewed by this user.
"viewedByMeTime": "A String", # The last time the file was viewed by the user (RFC 3339 date-time).
"viewersCanCopyContent": True or False, # Deprecated: Use `copyRequiresWriterPermission` instead.
"webContentLink": "A String", # Output 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.
"webViewLink": "A String", # Output only. A link for opening the file in a relevant Google editor or viewer in a browser.
"writersCanShare": True or False, # Whether users with only `writer` permission can modify the file's permissions. Not populated for items in shared drives.
}
create(body=None, enforceSingleParent=None, ignoreDefaultVisibility=None, includeLabels=None, includePermissionsForView=None, keepRevisionForever=None, media_body=None, media_mime_type=None, ocrLanguage=None, supportsAllDrives=None, supportsTeamDrives=None, useContentAsIndexableText=None, x__xgafv=None)
Creates a new file. This method supports an */upload* URI and accepts uploaded media with the following characteristics: - *Maximum file size:* 5,120 GB - *Accepted Media MIME types:*`*/*` Note: Specify a valid MIME type, rather than the literal `*/*` value. The literal `*/*` is only used to indicate that any valid MIME type can be uploaded. For more information on uploading files, see [Upload file data](/drive/api/guides/manage-uploads). Apps creating shortcuts with `files.create` must specify the MIME type `application/vnd.google-apps.shortcut`. Apps should specify a file extension in the `name` property when inserting files with the API. For example, an operation to insert a JPEG file should specify something like `"name": "cat.jpg"` in the metadata. Subsequent `GET` requests include the read-only `fileExtension` property populated with the extension originally specified in the `title` property. When a Google Drive user requests to download a file, or when the file is downloaded through the sync client, Drive builds a full filename (with extension) based on the title. In cases where the extension is missing, Drive attempts to determine the extension based on the file's MIME type.
Args:
body: object, The request body.
The object takes the form of:
{ # The 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.
"appProperties": { # A 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.
"a_key": "A String",
},
"capabilities": { # Output only. Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take.
"canAcceptOwnership": True or False, # Output only. Whether the current user is the pending owner of the file. Not populated for shared drive files.
"canAddChildren": True or False, # Output only. Whether the current user can add children to this folder. This is always false when the item is not a folder.
"canAddFolderFromAnotherDrive": True or False, # Output only. 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 is not a folder. Only populated for items in shared drives.
"canAddMyDriveParent": True or False, # Output only. 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.
"canChangeCopyRequiresWriterPermission": True or False, # Output only. Whether the current user can change the `copyRequiresWriterPermission` restriction of this file.
"canChangeSecurityUpdateEnabled": True or False, # Output only. Whether the current user can change the securityUpdateEnabled field on link share metadata.
"canChangeViewersCanCopyContent": True or False, # Deprecated: Output only.
"canComment": True or False, # Output only. Whether the current user can comment on this file.
"canCopy": True or False, # Output only. 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 is not a folder.
"canDelete": True or False, # Output only. Whether the current user can delete this file.
"canDeleteChildren": True or False, # Output only. Whether the current user can delete children of this folder. This is false when the item is not a folder. Only populated for items in shared drives.
"canDownload": True or False, # Output only. Whether the current user can download this file.
"canEdit": True or False, # Output only. Whether the current user can edit this file. Other factors may limit the type of changes a user can make to a file. For example, see `canChangeCopyRequiresWriterPermission` or `canModifyContent`.
"canListChildren": True or False, # Output only. Whether the current user can list the children of this folder. This is always false when the item is not a folder.
"canModifyContent": True or False, # Output only. Whether the current user can modify the content of this file.
"canModifyContentRestriction": True or False, # Deprecated: Output only. Use one of `canModifyEditorContentRestriction`, `canModifyOwnerContentRestriction` or `canRemoveContentRestriction`.
"canModifyEditorContentRestriction": True or False, # Output only. Whether the current user can add or modify content restrictions on the file which are editor restricted.
"canModifyLabels": True or False, # Output only. Whether the current user can modify the labels on the file.
"canModifyOwnerContentRestriction": True or False, # Output only. Whether the current user can add or modify content restrictions which are owner restricted.
"canMoveChildrenOutOfDrive": True or False, # Output only. Whether the current user can move children of this folder outside of the shared drive. This is false when the item is not a folder. Only populated for items in shared drives.
"canMoveChildrenOutOfTeamDrive": True or False, # Deprecated: Output only. Use `canMoveChildrenOutOfDrive` instead.
"canMoveChildrenWithinDrive": True or False, # Output only. Whether the current user can move children of this folder within this drive. This is false when the item is not a folder. Note that a request to move the child may still fail depending on the current user's access to the child and to the destination folder.
"canMoveChildrenWithinTeamDrive": True or False, # Deprecated: Output only. Use `canMoveChildrenWithinDrive` instead.
"canMoveItemIntoTeamDrive": True or False, # Deprecated: Output only. Use `canMoveItemOutOfDrive` instead.
"canMoveItemOutOfDrive": True or False, # Output only. Whether the current user can move this item outside of this drive by changing its parent. Note that a request to change the parent of the item may still fail depending on the new parent that is being added.
"canMoveItemOutOfTeamDrive": True or False, # Deprecated: Output only. Use `canMoveItemOutOfDrive` instead.
"canMoveItemWithinDrive": True or False, # Output only. Whether the current user can move this item within this drive. Note that a request to change the parent of the item may still fail depending on the new parent that is being added and the parent that is being removed.
"canMoveItemWithinTeamDrive": True or False, # Deprecated: Output only. Use `canMoveItemWithinDrive` instead.
"canMoveTeamDriveItem": True or False, # Deprecated: Output only. Use `canMoveItemWithinDrive` or `canMoveItemOutOfDrive` instead.
"canReadDrive": True or False, # Output only. Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives.
"canReadLabels": True or False, # Output only. Whether the current user can read the labels on the file.
"canReadRevisions": True or False, # Output only. 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 is not a folder, can be read.
"canReadTeamDrive": True or False, # Deprecated: Output only. Use `canReadDrive` instead.
"canRemoveChildren": True or False, # Output only. Whether the current user can remove children from this folder. This is always false when the item is not a folder. For a folder in a shared drive, use `canDeleteChildren` or `canTrashChildren` instead.
"canRemoveContentRestriction": True or False, # Output only. Whether there is a content restriction on the file that can be removed by the current user.
"canRemoveMyDriveParent": True or False, # Output only. 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.
"canRename": True or False, # Output only. Whether the current user can rename this file.
"canShare": True or False, # Output only. Whether the current user can modify the sharing settings for this file.
"canTrash": True or False, # Output only. Whether the current user can move this file to trash.
"canTrashChildren": True or False, # Output only. Whether the current user can trash children of this folder. This is false when the item is not a folder. Only populated for items in shared drives.
"canUntrash": True or False, # Output only. Whether the current user can restore this file from trash.
},
"contentHints": { # Additional information about the content of the file. These fields are never populated in responses.
"indexableText": "A String", # Text to be indexed for the file to improve fullText queries. This is limited to 128KB in length and may contain HTML elements.
"thumbnail": { # A thumbnail for the file. This will only be used if Google Drive cannot generate a standard thumbnail.
"image": "A String", # The thumbnail data encoded with URL-safe Base64 (RFC 4648 section 5).
"mimeType": "A String", # The MIME type of the thumbnail.
},
},
"contentRestrictions": [ # Restrictions for accessing the content of the file. Only populated if such a restriction exists.
{ # A restriction for accessing the content of the file.
"ownerRestricted": True or False, # Whether the content restriction can only be modified or removed by a user who owns the file. For files in shared drives, any user with `organizer` capabilities can modify or remove this content restriction.
"readOnly": True or False, # 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.
"reason": "A String", # Reason for why the content of the file is restricted. This is only mutable on requests that also set `readOnly=true`.
"restrictingUser": { # Information about a Drive user. # Output only. The user who set the content restriction. Only populated if `readOnly` is true.
"displayName": "A String", # Output only. A plain text displayable name for this user.
"emailAddress": "A String", # Output only. 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.
"kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#user"`.
"me": True or False, # Output only. Whether this user is the requesting user.
"permissionId": "A String", # Output only. The user's ID as visible in Permission resources.
"photoLink": "A String", # Output only. A link to the user's profile photo, if available.
},
"restrictionTime": "A String", # The time at which the content restriction was set (formatted RFC 3339 timestamp). Only populated if readOnly is true.
"systemRestricted": True or False, # Output only. Whether the content restriction was applied by the system, for example due to an esignature. Users cannot modify or remove system restricted content restrictions.
"type": "A String", # Output only. The type of the content restriction. Currently the only possible value is `globalContentRestriction`.
},
],
"copyRequiresWriterPermission": True or False, # Whether the options to copy, print, or download this file, should be disabled for readers and commenters.
"createdTime": "A String", # The time at which the file was created (RFC 3339 date-time).
"description": "A String", # A short description of the file.
"driveId": "A String", # Output only. ID of the shared drive the file resides in. Only populated for items in shared drives.
"explicitlyTrashed": True or False, # Output only. Whether the file has been explicitly trashed, as opposed to recursively trashed from a parent folder.
"exportLinks": { # Output only. Links for exporting Docs Editors files to specific formats.
"a_key": "A String",
},
"fileExtension": "A String", # Output only. The final component of `fullFileExtension`. This is only available for files with binary content in Google Drive.
"folderColorRgb": "A String", # The 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 resource. If an unsupported color is specified, the closest color in the palette is used instead.
"fullFileExtension": "A String", # Output 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 is not cleared if the new name does not contain a valid extension.
"hasAugmentedPermissions": True or False, # Output only. Whether there are permissions directly on this file. This field is only populated for items in shared drives.
"hasThumbnail": True or False, # Output only. 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.
"headRevisionId": "A String", # Output only. The ID of the file's head revision. This is currently only available for files with binary content in Google Drive.
"iconLink": "A String", # Output only. A static, unauthenticated link to the file's icon.
"id": "A String", # The ID of the file.
"imageMediaMetadata": { # Output only. Additional metadata about image media, if available.
"aperture": 3.14, # Output only. The aperture used to create the photo (f-number).
"cameraMake": "A String", # Output only. The make of the camera used to create the photo.
"cameraModel": "A String", # Output only. The model of the camera used to create the photo.
"colorSpace": "A String", # Output only. The color space of the photo.
"exposureBias": 3.14, # Output only. The exposure bias of the photo (APEX value).
"exposureMode": "A String", # Output only. The exposure mode used to create the photo.
"exposureTime": 3.14, # Output only. The length of the exposure, in seconds.
"flashUsed": True or False, # Output only. Whether a flash was used to create the photo.
"focalLength": 3.14, # Output only. The focal length used to create the photo, in millimeters.
"height": 42, # Output only. The height of the image in pixels.
"isoSpeed": 42, # Output only. The ISO speed used to create the photo.
"lens": "A String", # Output only. The lens used to create the photo.
"location": { # Output only. Geographic location information stored in the image.
"altitude": 3.14, # Output only. The altitude stored in the image.
"latitude": 3.14, # Output only. The latitude stored in the image.
"longitude": 3.14, # Output only. The longitude stored in the image.
},
"maxApertureValue": 3.14, # Output only. The smallest f-number of the lens at the focal length used to create the photo (APEX value).
"meteringMode": "A String", # Output only. The metering mode used to create the photo.
"rotation": 42, # Output only. The number of clockwise 90 degree rotations applied from the image's original orientation.
"sensor": "A String", # Output only. The type of sensor used to create the photo.
"subjectDistance": 42, # Output only. The distance to the subject of the photo, in meters.
"time": "A String", # Output only. The date and time the photo was taken (EXIF DateTime).
"whiteBalance": "A String", # Output only. The white balance mode used to create the photo.
"width": 42, # Output only. The width of the image in pixels.
},
"isAppAuthorized": True or False, # Output only. Whether the file was created or opened by the requesting app.
"kind": "drive#file", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#file"`.
"labelInfo": { # Output only. An overview of the labels on the file.
"labels": [ # Output only. The set of labels on the file as requested by the label IDs in the `includeLabels` parameter. By default, no labels are returned.
{ # Representation of label and label fields.
"fields": { # A map of the fields on the label, keyed by the field's ID.
"a_key": { # Representation of field, which is a typed key-value pair.
"dateString": [ # Only present if valueType is dateString. RFC 3339 formatted date: YYYY-MM-DD.
"A String",
],
"id": "A String", # The identifier of this label field.
"integer": [ # Only present if `valueType` is `integer`.
"A String",
],
"kind": "A String", # This is always drive#labelField.
"selection": [ # Only present if `valueType` is `selection`
"A String",
],
"text": [ # Only present if `valueType` is `text`.
"A String",
],
"user": [ # Only present if `valueType` is `user`.
{ # Information about a Drive user.
"displayName": "A String", # Output only. A plain text displayable name for this user.
"emailAddress": "A String", # Output only. 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.
"kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#user"`.
"me": True or False, # Output only. Whether this user is the requesting user.
"permissionId": "A String", # Output only. The user's ID as visible in Permission resources.
"photoLink": "A String", # Output only. A link to the user's profile photo, if available.
},
],
"valueType": "A String", # The field type. While new values may be supported in the future, the following are currently allowed: * `dateString` * `integer` * `selection` * `text` * `user`
},
},
"id": "A String", # The ID of the label.
"kind": "A String", # This is always drive#label
"revisionId": "A String", # The revision ID of the label.
},
],
},
"lastModifyingUser": { # Information about a Drive 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.
"displayName": "A String", # Output only. A plain text displayable name for this user.
"emailAddress": "A String", # Output only. 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.
"kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#user"`.
"me": True or False, # Output only. Whether this user is the requesting user.
"permissionId": "A String", # Output only. The user's ID as visible in Permission resources.
"photoLink": "A String", # Output only. A link to the user's profile photo, if available.
},
"linkShareMetadata": { # Contains details about the link URLs that clients are using to refer to this item.
"securityUpdateEligible": True or False, # Output only. Whether the file is eligible for security update.
"securityUpdateEnabled": True or False, # Output only. Whether the security update is enabled for this file.
},
"md5Checksum": "A String", # Output only. The MD5 checksum for the content of the file. This is only applicable to files with binary content in Google Drive.
"mimeType": "A String", # The 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 resource.
"modifiedByMe": True or False, # Output only. Whether the file has been modified by this user.
"modifiedByMeTime": "A String", # The last time the file was modified by the user (RFC 3339 date-time).
"modifiedTime": "A String", # he last time the file was modified by anyone (RFC 3339 date-time). Note that setting modifiedTime will also update modifiedByMeTime for the user.
"name": "A String", # The name of the file. This is not 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.
"originalFilename": "A String", # 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.
"ownedByMe": True or False, # Output only. Whether the user owns the file. Not populated for items in shared drives.
"owners": [ # Output 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.
{ # Information about a Drive user.
"displayName": "A String", # Output only. A plain text displayable name for this user.
"emailAddress": "A String", # Output only. 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.
"kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#user"`.
"me": True or False, # Output only. Whether this user is the requesting user.
"permissionId": "A String", # Output only. The user's ID as visible in Permission resources.
"photoLink": "A String", # Output only. A link to the user's profile photo, if available.
},
],
"parents": [ # The 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.
"A String",
],
"permissionIds": [ # Output only. List of permission IDs for users with access to this file.
"A String",
],
"permissions": [ # Output 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.
{ # A permission for a file. A permission grants a user, group, domain, or the world access to a file or a folder hierarchy. By default, permissions requests only return a subset of fields. Permission kind, ID, type, and role are always returned. To retrieve specific fields, see https://developers.google.com/drive/api/guides/fields-parameter. Some resource methods (such as `permissions.update`) require a `permissionId`. Use the `permissions.list` method to retrieve the ID for a file, folder, or shared drive.
"allowFileDiscovery": True or False, # Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type `domain` or `anyone`.
"deleted": True or False, # Output only. Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.
"displayName": "A String", # Output only. 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 "thecompany.com." * `anyone` - No `displayName` is present.
"domain": "A String", # The domain to which this permission refers.
"emailAddress": "A String", # The email address of the user or group to which this permission refers.
"expirationTime": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration times have the following restrictions: - They can only be set on user and group permissions - The time must be in the future - The time cannot be more than a year in the future
"id": "A String", # Output only. 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.
"kind": "drive#permission", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#permission"`.
"pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for `user` type permissions for files that are not in a shared drive.
"permissionDetails": [ # Output only. Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items.
{
"inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated. This is an output-only field.
"inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is an output-only field.
"permissionType": "A String", # Output only. The permission type for this user. While new values may be added in future, the following are currently possible: * `file` * `member`
"role": "A String", # Output only. The primary role for this user. While new values may be added in the future, the following are currently possible: * `organizer` * `fileOrganizer` * `writer` * `commenter` * `reader`
},
],
"photoLink": "A String", # Output only. A link to the user's profile photo, if available.
"role": "A String", # 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`
"teamDrivePermissionDetails": [ # Output only. Deprecated: Output only. Use `permissionDetails` instead.
{
"inherited": True or False, # Deprecated: Output only. Use `permissionDetails/inherited` instead.
"inheritedFrom": "A String", # Deprecated: Output only. Use `permissionDetails/inheritedFrom` instead.
"role": "A String", # Deprecated: Output only. Use `permissionDetails/role` instead.
"teamDrivePermissionType": "A String", # Deprecated: Output only. Use `permissionDetails/permissionType` instead.
},
],
"type": "A String", # 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 an `anyone` type.
"view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. 'published' is the only supported value.
},
],
"properties": { # A collection of arbitrary key-value pairs which are visible to all apps.
# Entries with null values are cleared in update and copy requests.
"a_key": "A String",
},
"quotaBytesUsed": "A String", # Output only. The number of storage quota bytes used by the file. This includes the head revision as well as previous revisions with `keepForever` enabled.
"resourceKey": "A String", # Output only. A key needed to access the item via a shared link.
"sha1Checksum": "A String", # Output only. The SHA1 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.
"sha256Checksum": "A String", # Output only. The SHA256 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.
"shared": True or False, # Output only. Whether the file has been shared. Not populated for items in shared drives.
"sharedWithMeTime": "A String", # The time at which the file was shared with the user, if applicable (RFC 3339 date-time).
"sharingUser": { # Information about a Drive user. # Output only. The user who shared the file with the requesting user, if applicable.
"displayName": "A String", # Output only. A plain text displayable name for this user.
"emailAddress": "A String", # Output only. 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.
"kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#user"`.
"me": True or False, # Output only. Whether this user is the requesting user.
"permissionId": "A String", # Output only. The user's ID as visible in Permission resources.
"photoLink": "A String", # Output only. A link to the user's profile photo, if available.
},
"shortcutDetails": { # Shortcut file details. Only populated for shortcut files, which have the mimeType field set to `application/vnd.google-apps.shortcut`. Can only be set on `files.create` requests.
"targetId": "A String", # The ID of the file that this shortcut points to. Can only be set on `files.create` requests.
"targetMimeType": "A String", # Output only. The MIME type of the file that this shortcut points to. The value of this field is a snapshot of the target's MIME type, captured when the shortcut is created.
"targetResourceKey": "A String", # Output only. The ResourceKey for the target file.
},
"size": "A String", # Output only. Size in bytes of blobs and first party editor files. Won't be populated for files that have no size, like shortcuts and folders.
"spaces": [ # Output only. The list of spaces which contain the file. The currently supported values are 'drive', 'appDataFolder' and 'photos'.
"A String",
],
"starred": True or False, # Whether the user has starred the file.
"teamDriveId": "A String", # Deprecated: Output only. Use `driveId` instead.
"thumbnailLink": "A String", # Output 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.
"thumbnailVersion": "A String", # Output only. The thumbnail version for use in thumbnail cache invalidation.
"trashed": True or False, # Whether the file has been trashed, either explicitly or from a trashed parent folder. Only the owner may trash a file, and other users cannot see files in the owner's trash.
"trashedTime": "A String", # The time that the item was trashed (RFC 3339 date-time). Only populated for items in shared drives.
"trashingUser": { # Information about a Drive user. # Output only. If the file has been explicitly trashed, the user who trashed it. Only populated for items in shared drives.
"displayName": "A String", # Output only. A plain text displayable name for this user.
"emailAddress": "A String", # Output only. 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.
"kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#user"`.
"me": True or False, # Output only. Whether this user is the requesting user.
"permissionId": "A String", # Output only. The user's ID as visible in Permission resources.
"photoLink": "A String", # Output only. A link to the user's profile photo, if available.
},
"version": "A String", # Output 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.
"videoMediaMetadata": { # Output only. Additional metadata about video media. This may not be available immediately upon upload.
"durationMillis": "A String", # Output only. The duration of the video in milliseconds.
"height": 42, # Output only. The height of the video in pixels.
"width": 42, # Output only. The width of the video in pixels.
},
"viewedByMe": True or False, # Output only. Whether the file has been viewed by this user.
"viewedByMeTime": "A String", # The last time the file was viewed by the user (RFC 3339 date-time).
"viewersCanCopyContent": True or False, # Deprecated: Use `copyRequiresWriterPermission` instead.
"webContentLink": "A String", # Output 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.
"webViewLink": "A String", # Output only. A link for opening the file in a relevant Google editor or viewer in a browser.
"writersCanShare": True or False, # Whether users with only `writer` permission can modify the file's permissions. Not populated for items in shared drives.
}
enforceSingleParent: boolean, Deprecated. Creating files in multiple folders is no longer supported.
ignoreDefaultVisibility: boolean, 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.
includeLabels: string, A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.
includePermissionsForView: string, Specifies which additional view's permissions to include in the response. Only 'published' is supported.
keepRevisionForever: boolean, 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.
media_body: string, The filename of the media request body, or an instance of a MediaUpload object.
media_mime_type: string, The MIME type of the media request body, or an instance of a MediaUpload object.
ocrLanguage: string, A language hint for OCR processing during image import (ISO 639-1 code).
supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives.
supportsTeamDrives: boolean, Deprecated: Use `supportsAllDrives` instead.
useContentAsIndexableText: boolean, Whether to use the uploaded content as indexable text.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The 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.
"appProperties": { # A 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.
"a_key": "A String",
},
"capabilities": { # Output only. Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take.
"canAcceptOwnership": True or False, # Output only. Whether the current user is the pending owner of the file. Not populated for shared drive files.
"canAddChildren": True or False, # Output only. Whether the current user can add children to this folder. This is always false when the item is not a folder.
"canAddFolderFromAnotherDrive": True or False, # Output only. 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 is not a folder. Only populated for items in shared drives.
"canAddMyDriveParent": True or False, # Output only. 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.
"canChangeCopyRequiresWriterPermission": True or False, # Output only. Whether the current user can change the `copyRequiresWriterPermission` restriction of this file.
"canChangeSecurityUpdateEnabled": True or False, # Output only. Whether the current user can change the securityUpdateEnabled field on link share metadata.
"canChangeViewersCanCopyContent": True or False, # Deprecated: Output only.
"canComment": True or False, # Output only. Whether the current user can comment on this file.
"canCopy": True or False, # Output only. 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 is not a folder.
"canDelete": True or False, # Output only. Whether the current user can delete this file.
"canDeleteChildren": True or False, # Output only. Whether the current user can delete children of this folder. This is false when the item is not a folder. Only populated for items in shared drives.
"canDownload": True or False, # Output only. Whether the current user can download this file.
"canEdit": True or False, # Output only. Whether the current user can edit this file. Other factors may limit the type of changes a user can make to a file. For example, see `canChangeCopyRequiresWriterPermission` or `canModifyContent`.
"canListChildren": True or False, # Output only. Whether the current user can list the children of this folder. This is always false when the item is not a folder.
"canModifyContent": True or False, # Output only. Whether the current user can modify the content of this file.
"canModifyContentRestriction": True or False, # Deprecated: Output only. Use one of `canModifyEditorContentRestriction`, `canModifyOwnerContentRestriction` or `canRemoveContentRestriction`.
"canModifyEditorContentRestriction": True or False, # Output only. Whether the current user can add or modify content restrictions on the file which are editor restricted.
"canModifyLabels": True or False, # Output only. Whether the current user can modify the labels on the file.
"canModifyOwnerContentRestriction": True or False, # Output only. Whether the current user can add or modify content restrictions which are owner restricted.
"canMoveChildrenOutOfDrive": True or False, # Output only. Whether the current user can move children of this folder outside of the shared drive. This is false when the item is not a folder. Only populated for items in shared drives.
"canMoveChildrenOutOfTeamDrive": True or False, # Deprecated: Output only. Use `canMoveChildrenOutOfDrive` instead.
"canMoveChildrenWithinDrive": True or False, # Output only. Whether the current user can move children of this folder within this drive. This is false when the item is not a folder. Note that a request to move the child may still fail depending on the current user's access to the child and to the destination folder.
"canMoveChildrenWithinTeamDrive": True or False, # Deprecated: Output only. Use `canMoveChildrenWithinDrive` instead.
"canMoveItemIntoTeamDrive": True or False, # Deprecated: Output only. Use `canMoveItemOutOfDrive` instead.
"canMoveItemOutOfDrive": True or False, # Output only. Whether the current user can move this item outside of this drive by changing its parent. Note that a request to change the parent of the item may still fail depending on the new parent that is being added.
"canMoveItemOutOfTeamDrive": True or False, # Deprecated: Output only. Use `canMoveItemOutOfDrive` instead.
"canMoveItemWithinDrive": True or False, # Output only. Whether the current user can move this item within this drive. Note that a request to change the parent of the item may still fail depending on the new parent that is being added and the parent that is being removed.
"canMoveItemWithinTeamDrive": True or False, # Deprecated: Output only. Use `canMoveItemWithinDrive` instead.
"canMoveTeamDriveItem": True or False, # Deprecated: Output only. Use `canMoveItemWithinDrive` or `canMoveItemOutOfDrive` instead.
"canReadDrive": True or False, # Output only. Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives.
"canReadLabels": True or False, # Output only. Whether the current user can read the labels on the file.
"canReadRevisions": True or False, # Output only. 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 is not a folder, can be read.
"canReadTeamDrive": True or False, # Deprecated: Output only. Use `canReadDrive` instead.
"canRemoveChildren": True or False, # Output only. Whether the current user can remove children from this folder. This is always false when the item is not a folder. For a folder in a shared drive, use `canDeleteChildren` or `canTrashChildren` instead.
"canRemoveContentRestriction": True or False, # Output only. Whether there is a content restriction on the file that can be removed by the current user.
"canRemoveMyDriveParent": True or False, # Output only. 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.
"canRename": True or False, # Output only. Whether the current user can rename this file.
"canShare": True or False, # Output only. Whether the current user can modify the sharing settings for this file.
"canTrash": True or False, # Output only. Whether the current user can move this file to trash.
"canTrashChildren": True or False, # Output only. Whether the current user can trash children of this folder. This is false when the item is not a folder. Only populated for items in shared drives.
"canUntrash": True or False, # Output only. Whether the current user can restore this file from trash.
},
"contentHints": { # Additional information about the content of the file. These fields are never populated in responses.
"indexableText": "A String", # Text to be indexed for the file to improve fullText queries. This is limited to 128KB in length and may contain HTML elements.
"thumbnail": { # A thumbnail for the file. This will only be used if Google Drive cannot generate a standard thumbnail.
"image": "A String", # The thumbnail data encoded with URL-safe Base64 (RFC 4648 section 5).
"mimeType": "A String", # The MIME type of the thumbnail.
},
},
"contentRestrictions": [ # Restrictions for accessing the content of the file. Only populated if such a restriction exists.
{ # A restriction for accessing the content of the file.
"ownerRestricted": True or False, # Whether the content restriction can only be modified or removed by a user who owns the file. For files in shared drives, any user with `organizer` capabilities can modify or remove this content restriction.
"readOnly": True or False, # 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.
"reason": "A String", # Reason for why the content of the file is restricted. This is only mutable on requests that also set `readOnly=true`.
"restrictingUser": { # Information about a Drive user. # Output only. The user who set the content restriction. Only populated if `readOnly` is true.
"displayName": "A String", # Output only. A plain text displayable name for this user.
"emailAddress": "A String", # Output only. 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.
"kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#user"`.
"me": True or False, # Output only. Whether this user is the requesting user.
"permissionId": "A String", # Output only. The user's ID as visible in Permission resources.
"photoLink": "A String", # Output only. A link to the user's profile photo, if available.
},
"restrictionTime": "A String", # The time at which the content restriction was set (formatted RFC 3339 timestamp). Only populated if readOnly is true.
"systemRestricted": True or False, # Output only. Whether the content restriction was applied by the system, for example due to an esignature. Users cannot modify or remove system restricted content restrictions.
"type": "A String", # Output only. The type of the content restriction. Currently the only possible value is `globalContentRestriction`.
},
],
"copyRequiresWriterPermission": True or False, # Whether the options to copy, print, or download this file, should be disabled for readers and commenters.
"createdTime": "A String", # The time at which the file was created (RFC 3339 date-time).
"description": "A String", # A short description of the file.
"driveId": "A String", # Output only. ID of the shared drive the file resides in. Only populated for items in shared drives.
"explicitlyTrashed": True or False, # Output only. Whether the file has been explicitly trashed, as opposed to recursively trashed from a parent folder.
"exportLinks": { # Output only. Links for exporting Docs Editors files to specific formats.
"a_key": "A String",
},
"fileExtension": "A String", # Output only. The final component of `fullFileExtension`. This is only available for files with binary content in Google Drive.
"folderColorRgb": "A String", # The 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 resource. If an unsupported color is specified, the closest color in the palette is used instead.
"fullFileExtension": "A String", # Output 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 is not cleared if the new name does not contain a valid extension.
"hasAugmentedPermissions": True or False, # Output only. Whether there are permissions directly on this file. This field is only populated for items in shared drives.
"hasThumbnail": True or False, # Output only. 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.
"headRevisionId": "A String", # Output only. The ID of the file's head revision. This is currently only available for files with binary content in Google Drive.
"iconLink": "A String", # Output only. A static, unauthenticated link to the file's icon.
"id": "A String", # The ID of the file.
"imageMediaMetadata": { # Output only. Additional metadata about image media, if available.
"aperture": 3.14, # Output only. The aperture used to create the photo (f-number).
"cameraMake": "A String", # Output only. The make of the camera used to create the photo.
"cameraModel": "A String", # Output only. The model of the camera used to create the photo.
"colorSpace": "A String", # Output only. The color space of the photo.
"exposureBias": 3.14, # Output only. The exposure bias of the photo (APEX value).
"exposureMode": "A String", # Output only. The exposure mode used to create the photo.
"exposureTime": 3.14, # Output only. The length of the exposure, in seconds.
"flashUsed": True or False, # Output only. Whether a flash was used to create the photo.
"focalLength": 3.14, # Output only. The focal length used to create the photo, in millimeters.
"height": 42, # Output only. The height of the image in pixels.
"isoSpeed": 42, # Output only. The ISO speed used to create the photo.
"lens": "A String", # Output only. The lens used to create the photo.
"location": { # Output only. Geographic location information stored in the image.
"altitude": 3.14, # Output only. The altitude stored in the image.
"latitude": 3.14, # Output only. The latitude stored in the image.
"longitude": 3.14, # Output only. The longitude stored in the image.
},
"maxApertureValue": 3.14, # Output only. The smallest f-number of the lens at the focal length used to create the photo (APEX value).
"meteringMode": "A String", # Output only. The metering mode used to create the photo.
"rotation": 42, # Output only. The number of clockwise 90 degree rotations applied from the image's original orientation.
"sensor": "A String", # Output only. The type of sensor used to create the photo.
"subjectDistance": 42, # Output only. The distance to the subject of the photo, in meters.
"time": "A String", # Output only. The date and time the photo was taken (EXIF DateTime).
"whiteBalance": "A String", # Output only. The white balance mode used to create the photo.
"width": 42, # Output only. The width of the image in pixels.
},
"isAppAuthorized": True or False, # Output only. Whether the file was created or opened by the requesting app.
"kind": "drive#file", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#file"`.
"labelInfo": { # Output only. An overview of the labels on the file.
"labels": [ # Output only. The set of labels on the file as requested by the label IDs in the `includeLabels` parameter. By default, no labels are returned.
{ # Representation of label and label fields.
"fields": { # A map of the fields on the label, keyed by the field's ID.
"a_key": { # Representation of field, which is a typed key-value pair.
"dateString": [ # Only present if valueType is dateString. RFC 3339 formatted date: YYYY-MM-DD.
"A String",
],
"id": "A String", # The identifier of this label field.
"integer": [ # Only present if `valueType` is `integer`.
"A String",
],
"kind": "A String", # This is always drive#labelField.
"selection": [ # Only present if `valueType` is `selection`
"A String",
],
"text": [ # Only present if `valueType` is `text`.
"A String",
],
"user": [ # Only present if `valueType` is `user`.
{ # Information about a Drive user.
"displayName": "A String", # Output only. A plain text displayable name for this user.
"emailAddress": "A String", # Output only. 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.
"kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#user"`.
"me": True or False, # Output only. Whether this user is the requesting user.
"permissionId": "A String", # Output only. The user's ID as visible in Permission resources.
"photoLink": "A String", # Output only. A link to the user's profile photo, if available.
},
],
"valueType": "A String", # The field type. While new values may be supported in the future, the following are currently allowed: * `dateString` * `integer` * `selection` * `text` * `user`
},
},
"id": "A String", # The ID of the label.
"kind": "A String", # This is always drive#label
"revisionId": "A String", # The revision ID of the label.
},
],
},
"lastModifyingUser": { # Information about a Drive 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.
"displayName": "A String", # Output only. A plain text displayable name for this user.
"emailAddress": "A String", # Output only. 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.
"kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#user"`.
"me": True or False, # Output only. Whether this user is the requesting user.
"permissionId": "A String", # Output only. The user's ID as visible in Permission resources.
"photoLink": "A String", # Output only. A link to the user's profile photo, if available.
},
"linkShareMetadata": { # Contains details about the link URLs that clients are using to refer to this item.
"securityUpdateEligible": True or False, # Output only. Whether the file is eligible for security update.
"securityUpdateEnabled": True or False, # Output only. Whether the security update is enabled for this file.
},
"md5Checksum": "A String", # Output only. The MD5 checksum for the content of the file. This is only applicable to files with binary content in Google Drive.
"mimeType": "A String", # The 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 resource.
"modifiedByMe": True or False, # Output only. Whether the file has been modified by this user.
"modifiedByMeTime": "A String", # The last time the file was modified by the user (RFC 3339 date-time).
"modifiedTime": "A String", # he last time the file was modified by anyone (RFC 3339 date-time). Note that setting modifiedTime will also update modifiedByMeTime for the user.
"name": "A String", # The name of the file. This is not 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.
"originalFilename": "A String", # 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.
"ownedByMe": True or False, # Output only. Whether the user owns the file. Not populated for items in shared drives.
"owners": [ # Output 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.
{ # Information about a Drive user.
"displayName": "A String", # Output only. A plain text displayable name for this user.
"emailAddress": "A String", # Output only. 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.
"kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#user"`.
"me": True or False, # Output only. Whether this user is the requesting user.
"permissionId": "A String", # Output only. The user's ID as visible in Permission resources.
"photoLink": "A String", # Output only. A link to the user's profile photo, if available.
},
],
"parents": [ # The 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.
"A String",
],
"permissionIds": [ # Output only. List of permission IDs for users with access to this file.
"A String",
],
"permissions": [ # Output 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.
{ # A permission for a file. A permission grants a user, group, domain, or the world access to a file or a folder hierarchy. By default, permissions requests only return a subset of fields. Permission kind, ID, type, and role are always returned. To retrieve specific fields, see https://developers.google.com/drive/api/guides/fields-parameter. Some resource methods (such as `permissions.update`) require a `permissionId`. Use the `permissions.list` method to retrieve the ID for a file, folder, or shared drive.
"allowFileDiscovery": True or False, # Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type `domain` or `anyone`.
"deleted": True or False, # Output only. Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.
"displayName": "A String", # Output only. 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 "thecompany.com." * `anyone` - No `displayName` is present.
"domain": "A String", # The domain to which this permission refers.
"emailAddress": "A String", # The email address of the user or group to which this permission refers.
"expirationTime": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration times have the following restrictions: - They can only be set on user and group permissions - The time must be in the future - The time cannot be more than a year in the future
"id": "A String", # Output only. 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.
"kind": "drive#permission", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#permission"`.
"pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for `user` type permissions for files that are not in a shared drive.
"permissionDetails": [ # Output only. Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items.
{
"inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated. This is an output-only field.
"inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is an output-only field.
"permissionType": "A String", # Output only. The permission type for this user. While new values may be added in future, the following are currently possible: * `file` * `member`
"role": "A String", # Output only. The primary role for this user. While new values may be added in the future, the following are currently possible: * `organizer` * `fileOrganizer` * `writer` * `commenter` * `reader`
},
],
"photoLink": "A String", # Output only. A link to the user's profile photo, if available.
"role": "A String", # 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`
"teamDrivePermissionDetails": [ # Output only. Deprecated: Output only. Use `permissionDetails` instead.
{
"inherited": True or False, # Deprecated: Output only. Use `permissionDetails/inherited` instead.
"inheritedFrom": "A String", # Deprecated: Output only. Use `permissionDetails/inheritedFrom` instead.
"role": "A String", # Deprecated: Output only. Use `permissionDetails/role` instead.
"teamDrivePermissionType": "A String", # Deprecated: Output only. Use `permissionDetails/permissionType` instead.
},
],
"type": "A String", # 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 an `anyone` type.
"view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. 'published' is the only supported value.
},
],
"properties": { # A collection of arbitrary key-value pairs which are visible to all apps.
# Entries with null values are cleared in update and copy requests.
"a_key": "A String",
},
"quotaBytesUsed": "A String", # Output only. The number of storage quota bytes used by the file. This includes the head revision as well as previous revisions with `keepForever` enabled.
"resourceKey": "A String", # Output only. A key needed to access the item via a shared link.
"sha1Checksum": "A String", # Output only. The SHA1 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.
"sha256Checksum": "A String", # Output only. The SHA256 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.
"shared": True or False, # Output only. Whether the file has been shared. Not populated for items in shared drives.
"sharedWithMeTime": "A String", # The time at which the file was shared with the user, if applicable (RFC 3339 date-time).
"sharingUser": { # Information about a Drive user. # Output only. The user who shared the file with the requesting user, if applicable.
"displayName": "A String", # Output only. A plain text displayable name for this user.
"emailAddress": "A String", # Output only. 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.
"kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#user"`.
"me": True or False, # Output only. Whether this user is the requesting user.
"permissionId": "A String", # Output only. The user's ID as visible in Permission resources.
"photoLink": "A String", # Output only. A link to the user's profile photo, if available.
},
"shortcutDetails": { # Shortcut file details. Only populated for shortcut files, which have the mimeType field set to `application/vnd.google-apps.shortcut`. Can only be set on `files.create` requests.
"targetId": "A String", # The ID of the file that this shortcut points to. Can only be set on `files.create` requests.
"targetMimeType": "A String", # Output only. The MIME type of the file that this shortcut points to. The value of this field is a snapshot of the target's MIME type, captured when the shortcut is created.
"targetResourceKey": "A String", # Output only. The ResourceKey for the target file.
},
"size": "A String", # Output only. Size in bytes of blobs and first party editor files. Won't be populated for files that have no size, like shortcuts and folders.
"spaces": [ # Output only. The list of spaces which contain the file. The currently supported values are 'drive', 'appDataFolder' and 'photos'.
"A String",
],
"starred": True or False, # Whether the user has starred the file.
"teamDriveId": "A String", # Deprecated: Output only. Use `driveId` instead.
"thumbnailLink": "A String", # Output 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.
"thumbnailVersion": "A String", # Output only. The thumbnail version for use in thumbnail cache invalidation.
"trashed": True or False, # Whether the file has been trashed, either explicitly or from a trashed parent folder. Only the owner may trash a file, and other users cannot see files in the owner's trash.
"trashedTime": "A String", # The time that the item was trashed (RFC 3339 date-time). Only populated for items in shared drives.
"trashingUser": { # Information about a Drive user. # Output only. If the file has been explicitly trashed, the user who trashed it. Only populated for items in shared drives.
"displayName": "A String", # Output only. A plain text displayable name for this user.
"emailAddress": "A String", # Output only. 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.
"kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#user"`.
"me": True or False, # Output only. Whether this user is the requesting user.
"permissionId": "A String", # Output only. The user's ID as visible in Permission resources.
"photoLink": "A String", # Output only. A link to the user's profile photo, if available.
},
"version": "A String", # Output 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.
"videoMediaMetadata": { # Output only. Additional metadata about video media. This may not be available immediately upon upload.
"durationMillis": "A String", # Output only. The duration of the video in milliseconds.
"height": 42, # Output only. The height of the video in pixels.
"width": 42, # Output only. The width of the video in pixels.
},
"viewedByMe": True or False, # Output only. Whether the file has been viewed by this user.
"viewedByMeTime": "A String", # The last time the file was viewed by the user (RFC 3339 date-time).
"viewersCanCopyContent": True or False, # Deprecated: Use `copyRequiresWriterPermission` instead.
"webContentLink": "A String", # Output 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.
"webViewLink": "A String", # Output only. A link for opening the file in a relevant Google editor or viewer in a browser.
"writersCanShare": True or False, # Whether users with only `writer` permission can modify the file's permissions. Not populated for items in shared drives.
}
delete(fileId, enforceSingleParent=None, supportsAllDrives=None, supportsTeamDrives=None, x__xgafv=None)
Permanently deletes a file owned by the user without moving it to the trash. If the file belongs to a shared drive, the user must be an `organizer` on the parent folder. If the target is a folder, all descendants owned by the user are also deleted.
Args:
fileId: string, The ID of the file. (required)
enforceSingleParent: boolean, Deprecated: If an item is not in a shared drive and its last parent is deleted but the item itself is not, the item will be placed under its owner's root.
supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives.
supportsTeamDrives: boolean, Deprecated: Use `supportsAllDrives` instead.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
download(fileId, mimeType=None, revisionId=None, x__xgafv=None)
Downloads content of a file. Operations are valid for 24 hours from the time of creation.
Args:
fileId: string, Required. The ID of the file to download. (required)
mimeType: string, Optional. The MIME type the file should be downloaded as. This field can only be set when downloading Google Workspace documents. See [Export MIME types for Google Workspace documents](/drive/api/guides/ref-export-formats) for the list of supported MIME types. If not set, a Google Workspace document is downloaded with a default MIME type. The default MIME type might change in the future.
revisionId: string, Optional. The revision ID of the file to download. This field can only be set when downloading blob files, Google Docs, and Google Sheets. Returns `INVALID_ARGUMENT` if downloading a specific revision on the file is unsupported.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}
emptyTrash(driveId=None, enforceSingleParent=None, x__xgafv=None)
Permanently deletes all of the user's trashed files.
Args:
driveId: string, If set, empties the trash of the provided shared drive.
enforceSingleParent: boolean, Deprecated: If an item is not in a shared drive and its last parent is deleted but the item itself is not, the item will be placed under its owner's root.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
export(fileId, mimeType, x__xgafv=None)
Exports a Google Workspace document to the requested MIME type and returns exported byte content. Note that the exported content is limited to 10MB.
Args:
fileId: string, The ID of the file. (required)
mimeType: string, Required. The MIME type of the format requested for this export. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
export_media(fileId, mimeType, x__xgafv=None)
Exports a Google Workspace document to the requested MIME type and returns exported byte content. Note that the exported content is limited to 10MB.
Args:
fileId: string, The ID of the file. (required)
mimeType: string, Required. The MIME type of the format requested for this export. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
generateIds(count=None, space=None, type=None, x__xgafv=None)
Generates a set of file IDs which can be provided in create or copy requests.
Args:
count: integer, The number of IDs to return.
space: string, The space in which the IDs can be used to create new files. Supported values are 'drive' and 'appDataFolder'. (Default: 'drive')
type: string, The type of items which the IDs can be used for. Supported values are 'files' and 'shortcuts'. Note that 'shortcuts' are only supported in the `drive` 'space'. (Default: 'files')
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A list of generated file IDs which can be provided in create requests.
"ids": [ # The IDs generated for the requesting user in the specified space.
"A String",
],
"kind": "drive#generatedIds", # Identifies what kind of resource this is. Value: the fixed string `"drive#generatedIds"`.
"space": "A String", # The type of file that can be created with these IDs.
}
get(fileId, acknowledgeAbuse=None, includeLabels=None, includePermissionsForView=None, supportsAllDrives=None, supportsTeamDrives=None, x__xgafv=None)
Gets a file's metadata or content by ID. If you provide the URL parameter `alt=media`, then the response includes the file contents in the response body. Downloading content with `alt=media` only works if the file is stored in Drive. To download Google Docs, Sheets, and Slides use [`files.export`](/drive/api/reference/rest/v3/files/export) instead. For more information, see [Download & export files](/drive/api/guides/manage-downloads).
Args:
fileId: string, The ID of the file. (required)
acknowledgeAbuse: boolean, Whether the user is acknowledging the risk of downloading known malware or other abusive files. This is only applicable when the `alt` parameter is set to `media` and the user is the owner of the file or an organizer of the shared drive in which the file resides.
includeLabels: string, A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.
includePermissionsForView: string, Specifies which additional view's permissions to include in the response. Only 'published' is supported.
supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives.
supportsTeamDrives: boolean, Deprecated: Use `supportsAllDrives` instead.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The 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.
"appProperties": { # A 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.
"a_key": "A String",
},
"capabilities": { # Output only. Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take.
"canAcceptOwnership": True or False, # Output only. Whether the current user is the pending owner of the file. Not populated for shared drive files.
"canAddChildren": True or False, # Output only. Whether the current user can add children to this folder. This is always false when the item is not a folder.
"canAddFolderFromAnotherDrive": True or False, # Output only. 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 is not a folder. Only populated for items in shared drives.
"canAddMyDriveParent": True or False, # Output only. 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.
"canChangeCopyRequiresWriterPermission": True or False, # Output only. Whether the current user can change the `copyRequiresWriterPermission` restriction of this file.
"canChangeSecurityUpdateEnabled": True or False, # Output only. Whether the current user can change the securityUpdateEnabled field on link share metadata.
"canChangeViewersCanCopyContent": True or False, # Deprecated: Output only.
"canComment": True or False, # Output only. Whether the current user can comment on this file.
"canCopy": True or False, # Output only. 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 is not a folder.
"canDelete": True or False, # Output only. Whether the current user can delete this file.
"canDeleteChildren": True or False, # Output only. Whether the current user can delete children of this folder. This is false when the item is not a folder. Only populated for items in shared drives.
"canDownload": True or False, # Output only. Whether the current user can download this file.
"canEdit": True or False, # Output only. Whether the current user can edit this file. Other factors may limit the type of changes a user can make to a file. For example, see `canChangeCopyRequiresWriterPermission` or `canModifyContent`.
"canListChildren": True or False, # Output only. Whether the current user can list the children of this folder. This is always false when the item is not a folder.
"canModifyContent": True or False, # Output only. Whether the current user can modify the content of this file.
"canModifyContentRestriction": True or False, # Deprecated: Output only. Use one of `canModifyEditorContentRestriction`, `canModifyOwnerContentRestriction` or `canRemoveContentRestriction`.
"canModifyEditorContentRestriction": True or False, # Output only. Whether the current user can add or modify content restrictions on the file which are editor restricted.
"canModifyLabels": True or False, # Output only. Whether the current user can modify the labels on the file.
"canModifyOwnerContentRestriction": True or False, # Output only. Whether the current user can add or modify content restrictions which are owner restricted.
"canMoveChildrenOutOfDrive": True or False, # Output only. Whether the current user can move children of this folder outside of the shared drive. This is false when the item is not a folder. Only populated for items in shared drives.
"canMoveChildrenOutOfTeamDrive": True or False, # Deprecated: Output only. Use `canMoveChildrenOutOfDrive` instead.
"canMoveChildrenWithinDrive": True or False, # Output only. Whether the current user can move children of this folder within this drive. This is false when the item is not a folder. Note that a request to move the child may still fail depending on the current user's access to the child and to the destination folder.
"canMoveChildrenWithinTeamDrive": True or False, # Deprecated: Output only. Use `canMoveChildrenWithinDrive` instead.
"canMoveItemIntoTeamDrive": True or False, # Deprecated: Output only. Use `canMoveItemOutOfDrive` instead.
"canMoveItemOutOfDrive": True or False, # Output only. Whether the current user can move this item outside of this drive by changing its parent. Note that a request to change the parent of the item may still fail depending on the new parent that is being added.
"canMoveItemOutOfTeamDrive": True or False, # Deprecated: Output only. Use `canMoveItemOutOfDrive` instead.
"canMoveItemWithinDrive": True or False, # Output only. Whether the current user can move this item within this drive. Note that a request to change the parent of the item may still fail depending on the new parent that is being added and the parent that is being removed.
"canMoveItemWithinTeamDrive": True or False, # Deprecated: Output only. Use `canMoveItemWithinDrive` instead.
"canMoveTeamDriveItem": True or False, # Deprecated: Output only. Use `canMoveItemWithinDrive` or `canMoveItemOutOfDrive` instead.
"canReadDrive": True or False, # Output only. Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives.
"canReadLabels": True or False, # Output only. Whether the current user can read the labels on the file.
"canReadRevisions": True or False, # Output only. 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 is not a folder, can be read.
"canReadTeamDrive": True or False, # Deprecated: Output only. Use `canReadDrive` instead.
"canRemoveChildren": True or False, # Output only. Whether the current user can remove children from this folder. This is always false when the item is not a folder. For a folder in a shared drive, use `canDeleteChildren` or `canTrashChildren` instead.
"canRemoveContentRestriction": True or False, # Output only. Whether there is a content restriction on the file that can be removed by the current user.
"canRemoveMyDriveParent": True or False, # Output only. 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.
"canRename": True or False, # Output only. Whether the current user can rename this file.
"canShare": True or False, # Output only. Whether the current user can modify the sharing settings for this file.
"canTrash": True or False, # Output only. Whether the current user can move this file to trash.
"canTrashChildren": True or False, # Output only. Whether the current user can trash children of this folder. This is false when the item is not a folder. Only populated for items in shared drives.
"canUntrash": True or False, # Output only. Whether the current user can restore this file from trash.
},
"contentHints": { # Additional information about the content of the file. These fields are never populated in responses.
"indexableText": "A String", # Text to be indexed for the file to improve fullText queries. This is limited to 128KB in length and may contain HTML elements.
"thumbnail": { # A thumbnail for the file. This will only be used if Google Drive cannot generate a standard thumbnail.
"image": "A String", # The thumbnail data encoded with URL-safe Base64 (RFC 4648 section 5).
"mimeType": "A String", # The MIME type of the thumbnail.
},
},
"contentRestrictions": [ # Restrictions for accessing the content of the file. Only populated if such a restriction exists.
{ # A restriction for accessing the content of the file.
"ownerRestricted": True or False, # Whether the content restriction can only be modified or removed by a user who owns the file. For files in shared drives, any user with `organizer` capabilities can modify or remove this content restriction.
"readOnly": True or False, # 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.
"reason": "A String", # Reason for why the content of the file is restricted. This is only mutable on requests that also set `readOnly=true`.
"restrictingUser": { # Information about a Drive user. # Output only. The user who set the content restriction. Only populated if `readOnly` is true.
"displayName": "A String", # Output only. A plain text displayable name for this user.
"emailAddress": "A String", # Output only. 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.
"kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#user"`.
"me": True or False, # Output only. Whether this user is the requesting user.
"permissionId": "A String", # Output only. The user's ID as visible in Permission resources.
"photoLink": "A String", # Output only. A link to the user's profile photo, if available.
},
"restrictionTime": "A String", # The time at which the content restriction was set (formatted RFC 3339 timestamp). Only populated if readOnly is true.
"systemRestricted": True or False, # Output only. Whether the content restriction was applied by the system, for example due to an esignature. Users cannot modify or remove system restricted content restrictions.
"type": "A String", # Output only. The type of the content restriction. Currently the only possible value is `globalContentRestriction`.
},
],
"copyRequiresWriterPermission": True or False, # Whether the options to copy, print, or download this file, should be disabled for readers and commenters.
"createdTime": "A String", # The time at which the file was created (RFC 3339 date-time).
"description": "A String", # A short description of the file.
"driveId": "A String", # Output only. ID of the shared drive the file resides in. Only populated for items in shared drives.
"explicitlyTrashed": True or False, # Output only. Whether the file has been explicitly trashed, as opposed to recursively trashed from a parent folder.
"exportLinks": { # Output only. Links for exporting Docs Editors files to specific formats.
"a_key": "A String",
},
"fileExtension": "A String", # Output only. The final component of `fullFileExtension`. This is only available for files with binary content in Google Drive.
"folderColorRgb": "A String", # The 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 resource. If an unsupported color is specified, the closest color in the palette is used instead.
"fullFileExtension": "A String", # Output 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 is not cleared if the new name does not contain a valid extension.
"hasAugmentedPermissions": True or False, # Output only. Whether there are permissions directly on this file. This field is only populated for items in shared drives.
"hasThumbnail": True or False, # Output only. 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.
"headRevisionId": "A String", # Output only. The ID of the file's head revision. This is currently only available for files with binary content in Google Drive.
"iconLink": "A String", # Output only. A static, unauthenticated link to the file's icon.
"id": "A String", # The ID of the file.
"imageMediaMetadata": { # Output only. Additional metadata about image media, if available.
"aperture": 3.14, # Output only. The aperture used to create the photo (f-number).
"cameraMake": "A String", # Output only. The make of the camera used to create the photo.
"cameraModel": "A String", # Output only. The model of the camera used to create the photo.
"colorSpace": "A String", # Output only. The color space of the photo.
"exposureBias": 3.14, # Output only. The exposure bias of the photo (APEX value).
"exposureMode": "A String", # Output only. The exposure mode used to create the photo.
"exposureTime": 3.14, # Output only. The length of the exposure, in seconds.
"flashUsed": True or False, # Output only. Whether a flash was used to create the photo.
"focalLength": 3.14, # Output only. The focal length used to create the photo, in millimeters.
"height": 42, # Output only. The height of the image in pixels.
"isoSpeed": 42, # Output only. The ISO speed used to create the photo.
"lens": "A String", # Output only. The lens used to create the photo.
"location": { # Output only. Geographic location information stored in the image.
"altitude": 3.14, # Output only. The altitude stored in the image.
"latitude": 3.14, # Output only. The latitude stored in the image.
"longitude": 3.14, # Output only. The longitude stored in the image.
},
"maxApertureValue": 3.14, # Output only. The smallest f-number of the lens at the focal length used to create the photo (APEX value).
"meteringMode": "A String", # Output only. The metering mode used to create the photo.
"rotation": 42, # Output only. The number of clockwise 90 degree rotations applied from the image's original orientation.
"sensor": "A String", # Output only. The type of sensor used to create the photo.
"subjectDistance": 42, # Output only. The distance to the subject of the photo, in meters.
"time": "A String", # Output only. The date and time the photo was taken (EXIF DateTime).
"whiteBalance": "A String", # Output only. The white balance mode used to create the photo.
"width": 42, # Output only. The width of the image in pixels.
},
"isAppAuthorized": True or False, # Output only. Whether the file was created or opened by the requesting app.
"kind": "drive#file", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#file"`.
"labelInfo": { # Output only. An overview of the labels on the file.
"labels": [ # Output only. The set of labels on the file as requested by the label IDs in the `includeLabels` parameter. By default, no labels are returned.
{ # Representation of label and label fields.
"fields": { # A map of the fields on the label, keyed by the field's ID.
"a_key": { # Representation of field, which is a typed key-value pair.
"dateString": [ # Only present if valueType is dateString. RFC 3339 formatted date: YYYY-MM-DD.
"A String",
],
"id": "A String", # The identifier of this label field.
"integer": [ # Only present if `valueType` is `integer`.
"A String",
],
"kind": "A String", # This is always drive#labelField.
"selection": [ # Only present if `valueType` is `selection`
"A String",
],
"text": [ # Only present if `valueType` is `text`.
"A String",
],
"user": [ # Only present if `valueType` is `user`.
{ # Information about a Drive user.
"displayName": "A String", # Output only. A plain text displayable name for this user.
"emailAddress": "A String", # Output only. 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.
"kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#user"`.
"me": True or False, # Output only. Whether this user is the requesting user.
"permissionId": "A String", # Output only. The user's ID as visible in Permission resources.
"photoLink": "A String", # Output only. A link to the user's profile photo, if available.
},
],
"valueType": "A String", # The field type. While new values may be supported in the future, the following are currently allowed: * `dateString` * `integer` * `selection` * `text` * `user`
},
},
"id": "A String", # The ID of the label.
"kind": "A String", # This is always drive#label
"revisionId": "A String", # The revision ID of the label.
},
],
},
"lastModifyingUser": { # Information about a Drive 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.
"displayName": "A String", # Output only. A plain text displayable name for this user.
"emailAddress": "A String", # Output only. 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.
"kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#user"`.
"me": True or False, # Output only. Whether this user is the requesting user.
"permissionId": "A String", # Output only. The user's ID as visible in Permission resources.
"photoLink": "A String", # Output only. A link to the user's profile photo, if available.
},
"linkShareMetadata": { # Contains details about the link URLs that clients are using to refer to this item.
"securityUpdateEligible": True or False, # Output only. Whether the file is eligible for security update.
"securityUpdateEnabled": True or False, # Output only. Whether the security update is enabled for this file.
},
"md5Checksum": "A String", # Output only. The MD5 checksum for the content of the file. This is only applicable to files with binary content in Google Drive.
"mimeType": "A String", # The 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 resource.
"modifiedByMe": True or False, # Output only. Whether the file has been modified by this user.
"modifiedByMeTime": "A String", # The last time the file was modified by the user (RFC 3339 date-time).
"modifiedTime": "A String", # he last time the file was modified by anyone (RFC 3339 date-time). Note that setting modifiedTime will also update modifiedByMeTime for the user.
"name": "A String", # The name of the file. This is not 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.
"originalFilename": "A String", # 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.
"ownedByMe": True or False, # Output only. Whether the user owns the file. Not populated for items in shared drives.
"owners": [ # Output 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.
{ # Information about a Drive user.
"displayName": "A String", # Output only. A plain text displayable name for this user.
"emailAddress": "A String", # Output only. 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.
"kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#user"`.
"me": True or False, # Output only. Whether this user is the requesting user.
"permissionId": "A String", # Output only. The user's ID as visible in Permission resources.
"photoLink": "A String", # Output only. A link to the user's profile photo, if available.
},
],
"parents": [ # The 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.
"A String",
],
"permissionIds": [ # Output only. List of permission IDs for users with access to this file.
"A String",
],
"permissions": [ # Output 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.
{ # A permission for a file. A permission grants a user, group, domain, or the world access to a file or a folder hierarchy. By default, permissions requests only return a subset of fields. Permission kind, ID, type, and role are always returned. To retrieve specific fields, see https://developers.google.com/drive/api/guides/fields-parameter. Some resource methods (such as `permissions.update`) require a `permissionId`. Use the `permissions.list` method to retrieve the ID for a file, folder, or shared drive.
"allowFileDiscovery": True or False, # Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type `domain` or `anyone`.
"deleted": True or False, # Output only. Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.
"displayName": "A String", # Output only. 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 "thecompany.com." * `anyone` - No `displayName` is present.
"domain": "A String", # The domain to which this permission refers.
"emailAddress": "A String", # The email address of the user or group to which this permission refers.
"expirationTime": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration times have the following restrictions: - They can only be set on user and group permissions - The time must be in the future - The time cannot be more than a year in the future
"id": "A String", # Output only. 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.
"kind": "drive#permission", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#permission"`.
"pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for `user` type permissions for files that are not in a shared drive.
"permissionDetails": [ # Output only. Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items.
{
"inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated. This is an output-only field.
"inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is an output-only field.
"permissionType": "A String", # Output only. The permission type for this user. While new values may be added in future, the following are currently possible: * `file` * `member`
"role": "A String", # Output only. The primary role for this user. While new values may be added in the future, the following are currently possible: * `organizer` * `fileOrganizer` * `writer` * `commenter` * `reader`
},
],
"photoLink": "A String", # Output only. A link to the user's profile photo, if available.
"role": "A String", # 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`
"teamDrivePermissionDetails": [ # Output only. Deprecated: Output only. Use `permissionDetails` instead.
{
"inherited": True or False, # Deprecated: Output only. Use `permissionDetails/inherited` instead.
"inheritedFrom": "A String", # Deprecated: Output only. Use `permissionDetails/inheritedFrom` instead.
"role": "A String", # Deprecated: Output only. Use `permissionDetails/role` instead.
"teamDrivePermissionType": "A String", # Deprecated: Output only. Use `permissionDetails/permissionType` instead.
},
],
"type": "A String", # 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 an `anyone` type.
"view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. 'published' is the only supported value.
},
],
"properties": { # A collection of arbitrary key-value pairs which are visible to all apps.
# Entries with null values are cleared in update and copy requests.
"a_key": "A String",
},
"quotaBytesUsed": "A String", # Output only. The number of storage quota bytes used by the file. This includes the head revision as well as previous revisions with `keepForever` enabled.
"resourceKey": "A String", # Output only. A key needed to access the item via a shared link.
"sha1Checksum": "A String", # Output only. The SHA1 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.
"sha256Checksum": "A String", # Output only. The SHA256 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.
"shared": True or False, # Output only. Whether the file has been shared. Not populated for items in shared drives.
"sharedWithMeTime": "A String", # The time at which the file was shared with the user, if applicable (RFC 3339 date-time).
"sharingUser": { # Information about a Drive user. # Output only. The user who shared the file with the requesting user, if applicable.
"displayName": "A String", # Output only. A plain text displayable name for this user.
"emailAddress": "A String", # Output only. 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.
"kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#user"`.
"me": True or False, # Output only. Whether this user is the requesting user.
"permissionId": "A String", # Output only. The user's ID as visible in Permission resources.
"photoLink": "A String", # Output only. A link to the user's profile photo, if available.
},
"shortcutDetails": { # Shortcut file details. Only populated for shortcut files, which have the mimeType field set to `application/vnd.google-apps.shortcut`. Can only be set on `files.create` requests.
"targetId": "A String", # The ID of the file that this shortcut points to. Can only be set on `files.create` requests.
"targetMimeType": "A String", # Output only. The MIME type of the file that this shortcut points to. The value of this field is a snapshot of the target's MIME type, captured when the shortcut is created.
"targetResourceKey": "A String", # Output only. The ResourceKey for the target file.
},
"size": "A String", # Output only. Size in bytes of blobs and first party editor files. Won't be populated for files that have no size, like shortcuts and folders.
"spaces": [ # Output only. The list of spaces which contain the file. The currently supported values are 'drive', 'appDataFolder' and 'photos'.
"A String",
],
"starred": True or False, # Whether the user has starred the file.
"teamDriveId": "A String", # Deprecated: Output only. Use `driveId` instead.
"thumbnailLink": "A String", # Output 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.
"thumbnailVersion": "A String", # Output only. The thumbnail version for use in thumbnail cache invalidation.
"trashed": True or False, # Whether the file has been trashed, either explicitly or from a trashed parent folder. Only the owner may trash a file, and other users cannot see files in the owner's trash.
"trashedTime": "A String", # The time that the item was trashed (RFC 3339 date-time). Only populated for items in shared drives.
"trashingUser": { # Information about a Drive user. # Output only. If the file has been explicitly trashed, the user who trashed it. Only populated for items in shared drives.
"displayName": "A String", # Output only. A plain text displayable name for this user.
"emailAddress": "A String", # Output only. 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.
"kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#user"`.
"me": True or False, # Output only. Whether this user is the requesting user.
"permissionId": "A String", # Output only. The user's ID as visible in Permission resources.
"photoLink": "A String", # Output only. A link to the user's profile photo, if available.
},
"version": "A String", # Output 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.
"videoMediaMetadata": { # Output only. Additional metadata about video media. This may not be available immediately upon upload.
"durationMillis": "A String", # Output only. The duration of the video in milliseconds.
"height": 42, # Output only. The height of the video in pixels.
"width": 42, # Output only. The width of the video in pixels.
},
"viewedByMe": True or False, # Output only. Whether the file has been viewed by this user.
"viewedByMeTime": "A String", # The last time the file was viewed by the user (RFC 3339 date-time).
"viewersCanCopyContent": True or False, # Deprecated: Use `copyRequiresWriterPermission` instead.
"webContentLink": "A String", # Output 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.
"webViewLink": "A String", # Output only. A link for opening the file in a relevant Google editor or viewer in a browser.
"writersCanShare": True or False, # Whether users with only `writer` permission can modify the file's permissions. Not populated for items in shared drives.
}
get_media(fileId, acknowledgeAbuse=None, includeLabels=None, includePermissionsForView=None, supportsAllDrives=None, supportsTeamDrives=None, x__xgafv=None)
Gets a file's metadata or content by ID. If you provide the URL parameter `alt=media`, then the response includes the file contents in the response body. Downloading content with `alt=media` only works if the file is stored in Drive. To download Google Docs, Sheets, and Slides use [`files.export`](/drive/api/reference/rest/v3/files/export) instead. For more information, see [Download & export files](/drive/api/guides/manage-downloads).
Args:
fileId: string, The ID of the file. (required)
acknowledgeAbuse: boolean, Whether the user is acknowledging the risk of downloading known malware or other abusive files. This is only applicable when the `alt` parameter is set to `media` and the user is the owner of the file or an organizer of the shared drive in which the file resides.
includeLabels: string, A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.
includePermissionsForView: string, Specifies which additional view's permissions to include in the response. Only 'published' is supported.
supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives.
supportsTeamDrives: boolean, Deprecated: Use `supportsAllDrives` instead.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
The media object as a string.
list(corpora=None, corpus=None, driveId=None, includeItemsFromAllDrives=None, includeLabels=None, includePermissionsForView=None, includeTeamDriveItems=None, orderBy=None, pageSize=None, pageToken=None, q=None, spaces=None, supportsAllDrives=None, supportsTeamDrives=None, teamDriveId=None, x__xgafv=None)
Lists the user's files. This method accepts the `q` parameter, which is a search query combining one or more search terms. For more information, see the [Search for files & folders](/drive/api/guides/search-files) guide. *Note:* This method returns *all* files by default, including trashed files. If you don't want trashed files to appear in the list, use the `trashed=false` query parameter to remove trashed files from the results.
Args:
corpora: string, Bodies of items (files/documents) to which the query applies. Supported bodies are 'user', 'domain', 'drive', and 'allDrives'. Prefer 'user' or 'drive' to 'allDrives' for efficiency. By default, corpora is set to 'user'. However, this can change depending on the filter set through the 'q' parameter.
corpus: string, Deprecated: The source of files to list. Use 'corpora' instead.
Allowed values
domain - Files shared to the user's domain.
user - Files owned by or shared to the user.
driveId: string, ID of the shared drive to search.
includeItemsFromAllDrives: boolean, Whether both My Drive and shared drive items should be included in results.
includeLabels: string, A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.
includePermissionsForView: string, Specifies which additional view's permissions to include in the response. Only 'published' is supported.
includeTeamDriveItems: boolean, Deprecated: Use `includeItemsFromAllDrives` instead.
orderBy: string, A comma-separated list of sort keys. Valid keys are: * `createdTime`: When the file was created. * `folder`: The folder ID. This field is sorted using alphabetical ordering. * `modifiedByMeTime`: The last time the file was modified by the user. * `modifiedTime`: The last time the file was modified by anyone. * `name`: The name of the file. This field is sorted using alphabetical ordering, so 1, 12, 2, 22. * `name_natural`: The name of the file. This field is sorted using natural sort ordering, so 1, 2, 12, 22. * `quotaBytesUsed`: The number of storage quota bytes used by the file. * `recency`: The most recent timestamp from the file's date-time fields. * `sharedWithMeTime`: When the file was shared with the user, if applicable. * `starred`: Whether the user has starred the file. * `viewedByMeTime`: The last time the file was viewed by the user. Each key sorts ascending by default, but can be reversed with the 'desc' modifier. Example usage: `?orderBy=folder,modifiedTime desc,name`.
pageSize: integer, The maximum number of files to return per page. Partial or empty result pages are possible even before the end of the files list has been reached.
pageToken: string, The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response.
q: string, A query for filtering the file results. See the "Search for files & folders" guide for supported syntax.
spaces: string, A comma-separated list of spaces to query within the corpora. Supported values are 'drive' and 'appDataFolder'.
supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives.
supportsTeamDrives: boolean, Deprecated: Use `supportsAllDrives` instead.
teamDriveId: string, Deprecated: Use `driveId` instead.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A list of files.
"files": [ # The list of files. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched.
{ # The 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.
"appProperties": { # A 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.
"a_key": "A String",
},
"capabilities": { # Output only. Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take.
"canAcceptOwnership": True or False, # Output only. Whether the current user is the pending owner of the file. Not populated for shared drive files.
"canAddChildren": True or False, # Output only. Whether the current user can add children to this folder. This is always false when the item is not a folder.
"canAddFolderFromAnotherDrive": True or False, # Output only. 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 is not a folder. Only populated for items in shared drives.
"canAddMyDriveParent": True or False, # Output only. 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.
"canChangeCopyRequiresWriterPermission": True or False, # Output only. Whether the current user can change the `copyRequiresWriterPermission` restriction of this file.
"canChangeSecurityUpdateEnabled": True or False, # Output only. Whether the current user can change the securityUpdateEnabled field on link share metadata.
"canChangeViewersCanCopyContent": True or False, # Deprecated: Output only.
"canComment": True or False, # Output only. Whether the current user can comment on this file.
"canCopy": True or False, # Output only. 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 is not a folder.
"canDelete": True or False, # Output only. Whether the current user can delete this file.
"canDeleteChildren": True or False, # Output only. Whether the current user can delete children of this folder. This is false when the item is not a folder. Only populated for items in shared drives.
"canDownload": True or False, # Output only. Whether the current user can download this file.
"canEdit": True or False, # Output only. Whether the current user can edit this file. Other factors may limit the type of changes a user can make to a file. For example, see `canChangeCopyRequiresWriterPermission` or `canModifyContent`.
"canListChildren": True or False, # Output only. Whether the current user can list the children of this folder. This is always false when the item is not a folder.
"canModifyContent": True or False, # Output only. Whether the current user can modify the content of this file.
"canModifyContentRestriction": True or False, # Deprecated: Output only. Use one of `canModifyEditorContentRestriction`, `canModifyOwnerContentRestriction` or `canRemoveContentRestriction`.
"canModifyEditorContentRestriction": True or False, # Output only. Whether the current user can add or modify content restrictions on the file which are editor restricted.
"canModifyLabels": True or False, # Output only. Whether the current user can modify the labels on the file.
"canModifyOwnerContentRestriction": True or False, # Output only. Whether the current user can add or modify content restrictions which are owner restricted.
"canMoveChildrenOutOfDrive": True or False, # Output only. Whether the current user can move children of this folder outside of the shared drive. This is false when the item is not a folder. Only populated for items in shared drives.
"canMoveChildrenOutOfTeamDrive": True or False, # Deprecated: Output only. Use `canMoveChildrenOutOfDrive` instead.
"canMoveChildrenWithinDrive": True or False, # Output only. Whether the current user can move children of this folder within this drive. This is false when the item is not a folder. Note that a request to move the child may still fail depending on the current user's access to the child and to the destination folder.
"canMoveChildrenWithinTeamDrive": True or False, # Deprecated: Output only. Use `canMoveChildrenWithinDrive` instead.
"canMoveItemIntoTeamDrive": True or False, # Deprecated: Output only. Use `canMoveItemOutOfDrive` instead.
"canMoveItemOutOfDrive": True or False, # Output only. Whether the current user can move this item outside of this drive by changing its parent. Note that a request to change the parent of the item may still fail depending on the new parent that is being added.
"canMoveItemOutOfTeamDrive": True or False, # Deprecated: Output only. Use `canMoveItemOutOfDrive` instead.
"canMoveItemWithinDrive": True or False, # Output only. Whether the current user can move this item within this drive. Note that a request to change the parent of the item may still fail depending on the new parent that is being added and the parent that is being removed.
"canMoveItemWithinTeamDrive": True or False, # Deprecated: Output only. Use `canMoveItemWithinDrive` instead.
"canMoveTeamDriveItem": True or False, # Deprecated: Output only. Use `canMoveItemWithinDrive` or `canMoveItemOutOfDrive` instead.
"canReadDrive": True or False, # Output only. Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives.
"canReadLabels": True or False, # Output only. Whether the current user can read the labels on the file.
"canReadRevisions": True or False, # Output only. 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 is not a folder, can be read.
"canReadTeamDrive": True or False, # Deprecated: Output only. Use `canReadDrive` instead.
"canRemoveChildren": True or False, # Output only. Whether the current user can remove children from this folder. This is always false when the item is not a folder. For a folder in a shared drive, use `canDeleteChildren` or `canTrashChildren` instead.
"canRemoveContentRestriction": True or False, # Output only. Whether there is a content restriction on the file that can be removed by the current user.
"canRemoveMyDriveParent": True or False, # Output only. 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.
"canRename": True or False, # Output only. Whether the current user can rename this file.
"canShare": True or False, # Output only. Whether the current user can modify the sharing settings for this file.
"canTrash": True or False, # Output only. Whether the current user can move this file to trash.
"canTrashChildren": True or False, # Output only. Whether the current user can trash children of this folder. This is false when the item is not a folder. Only populated for items in shared drives.
"canUntrash": True or False, # Output only. Whether the current user can restore this file from trash.
},
"contentHints": { # Additional information about the content of the file. These fields are never populated in responses.
"indexableText": "A String", # Text to be indexed for the file to improve fullText queries. This is limited to 128KB in length and may contain HTML elements.
"thumbnail": { # A thumbnail for the file. This will only be used if Google Drive cannot generate a standard thumbnail.
"image": "A String", # The thumbnail data encoded with URL-safe Base64 (RFC 4648 section 5).
"mimeType": "A String", # The MIME type of the thumbnail.
},
},
"contentRestrictions": [ # Restrictions for accessing the content of the file. Only populated if such a restriction exists.
{ # A restriction for accessing the content of the file.
"ownerRestricted": True or False, # Whether the content restriction can only be modified or removed by a user who owns the file. For files in shared drives, any user with `organizer` capabilities can modify or remove this content restriction.
"readOnly": True or False, # 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.
"reason": "A String", # Reason for why the content of the file is restricted. This is only mutable on requests that also set `readOnly=true`.
"restrictingUser": { # Information about a Drive user. # Output only. The user who set the content restriction. Only populated if `readOnly` is true.
"displayName": "A String", # Output only. A plain text displayable name for this user.
"emailAddress": "A String", # Output only. 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.
"kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#user"`.
"me": True or False, # Output only. Whether this user is the requesting user.
"permissionId": "A String", # Output only. The user's ID as visible in Permission resources.
"photoLink": "A String", # Output only. A link to the user's profile photo, if available.
},
"restrictionTime": "A String", # The time at which the content restriction was set (formatted RFC 3339 timestamp). Only populated if readOnly is true.
"systemRestricted": True or False, # Output only. Whether the content restriction was applied by the system, for example due to an esignature. Users cannot modify or remove system restricted content restrictions.
"type": "A String", # Output only. The type of the content restriction. Currently the only possible value is `globalContentRestriction`.
},
],
"copyRequiresWriterPermission": True or False, # Whether the options to copy, print, or download this file, should be disabled for readers and commenters.
"createdTime": "A String", # The time at which the file was created (RFC 3339 date-time).
"description": "A String", # A short description of the file.
"driveId": "A String", # Output only. ID of the shared drive the file resides in. Only populated for items in shared drives.
"explicitlyTrashed": True or False, # Output only. Whether the file has been explicitly trashed, as opposed to recursively trashed from a parent folder.
"exportLinks": { # Output only. Links for exporting Docs Editors files to specific formats.
"a_key": "A String",
},
"fileExtension": "A String", # Output only. The final component of `fullFileExtension`. This is only available for files with binary content in Google Drive.
"folderColorRgb": "A String", # The 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 resource. If an unsupported color is specified, the closest color in the palette is used instead.
"fullFileExtension": "A String", # Output 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 is not cleared if the new name does not contain a valid extension.
"hasAugmentedPermissions": True or False, # Output only. Whether there are permissions directly on this file. This field is only populated for items in shared drives.
"hasThumbnail": True or False, # Output only. 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.
"headRevisionId": "A String", # Output only. The ID of the file's head revision. This is currently only available for files with binary content in Google Drive.
"iconLink": "A String", # Output only. A static, unauthenticated link to the file's icon.
"id": "A String", # The ID of the file.
"imageMediaMetadata": { # Output only. Additional metadata about image media, if available.
"aperture": 3.14, # Output only. The aperture used to create the photo (f-number).
"cameraMake": "A String", # Output only. The make of the camera used to create the photo.
"cameraModel": "A String", # Output only. The model of the camera used to create the photo.
"colorSpace": "A String", # Output only. The color space of the photo.
"exposureBias": 3.14, # Output only. The exposure bias of the photo (APEX value).
"exposureMode": "A String", # Output only. The exposure mode used to create the photo.
"exposureTime": 3.14, # Output only. The length of the exposure, in seconds.
"flashUsed": True or False, # Output only. Whether a flash was used to create the photo.
"focalLength": 3.14, # Output only. The focal length used to create the photo, in millimeters.
"height": 42, # Output only. The height of the image in pixels.
"isoSpeed": 42, # Output only. The ISO speed used to create the photo.
"lens": "A String", # Output only. The lens used to create the photo.
"location": { # Output only. Geographic location information stored in the image.
"altitude": 3.14, # Output only. The altitude stored in the image.
"latitude": 3.14, # Output only. The latitude stored in the image.
"longitude": 3.14, # Output only. The longitude stored in the image.
},
"maxApertureValue": 3.14, # Output only. The smallest f-number of the lens at the focal length used to create the photo (APEX value).
"meteringMode": "A String", # Output only. The metering mode used to create the photo.
"rotation": 42, # Output only. The number of clockwise 90 degree rotations applied from the image's original orientation.
"sensor": "A String", # Output only. The type of sensor used to create the photo.
"subjectDistance": 42, # Output only. The distance to the subject of the photo, in meters.
"time": "A String", # Output only. The date and time the photo was taken (EXIF DateTime).
"whiteBalance": "A String", # Output only. The white balance mode used to create the photo.
"width": 42, # Output only. The width of the image in pixels.
},
"isAppAuthorized": True or False, # Output only. Whether the file was created or opened by the requesting app.
"kind": "drive#file", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#file"`.
"labelInfo": { # Output only. An overview of the labels on the file.
"labels": [ # Output only. The set of labels on the file as requested by the label IDs in the `includeLabels` parameter. By default, no labels are returned.
{ # Representation of label and label fields.
"fields": { # A map of the fields on the label, keyed by the field's ID.
"a_key": { # Representation of field, which is a typed key-value pair.
"dateString": [ # Only present if valueType is dateString. RFC 3339 formatted date: YYYY-MM-DD.
"A String",
],
"id": "A String", # The identifier of this label field.
"integer": [ # Only present if `valueType` is `integer`.
"A String",
],
"kind": "A String", # This is always drive#labelField.
"selection": [ # Only present if `valueType` is `selection`
"A String",
],
"text": [ # Only present if `valueType` is `text`.
"A String",
],
"user": [ # Only present if `valueType` is `user`.
{ # Information about a Drive user.
"displayName": "A String", # Output only. A plain text displayable name for this user.
"emailAddress": "A String", # Output only. 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.
"kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#user"`.
"me": True or False, # Output only. Whether this user is the requesting user.
"permissionId": "A String", # Output only. The user's ID as visible in Permission resources.
"photoLink": "A String", # Output only. A link to the user's profile photo, if available.
},
],
"valueType": "A String", # The field type. While new values may be supported in the future, the following are currently allowed: * `dateString` * `integer` * `selection` * `text` * `user`
},
},
"id": "A String", # The ID of the label.
"kind": "A String", # This is always drive#label
"revisionId": "A String", # The revision ID of the label.
},
],
},
"lastModifyingUser": { # Information about a Drive 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.
"displayName": "A String", # Output only. A plain text displayable name for this user.
"emailAddress": "A String", # Output only. 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.
"kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#user"`.
"me": True or False, # Output only. Whether this user is the requesting user.
"permissionId": "A String", # Output only. The user's ID as visible in Permission resources.
"photoLink": "A String", # Output only. A link to the user's profile photo, if available.
},
"linkShareMetadata": { # Contains details about the link URLs that clients are using to refer to this item.
"securityUpdateEligible": True or False, # Output only. Whether the file is eligible for security update.
"securityUpdateEnabled": True or False, # Output only. Whether the security update is enabled for this file.
},
"md5Checksum": "A String", # Output only. The MD5 checksum for the content of the file. This is only applicable to files with binary content in Google Drive.
"mimeType": "A String", # The 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 resource.
"modifiedByMe": True or False, # Output only. Whether the file has been modified by this user.
"modifiedByMeTime": "A String", # The last time the file was modified by the user (RFC 3339 date-time).
"modifiedTime": "A String", # he last time the file was modified by anyone (RFC 3339 date-time). Note that setting modifiedTime will also update modifiedByMeTime for the user.
"name": "A String", # The name of the file. This is not 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.
"originalFilename": "A String", # 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.
"ownedByMe": True or False, # Output only. Whether the user owns the file. Not populated for items in shared drives.
"owners": [ # Output 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.
{ # Information about a Drive user.
"displayName": "A String", # Output only. A plain text displayable name for this user.
"emailAddress": "A String", # Output only. 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.
"kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#user"`.
"me": True or False, # Output only. Whether this user is the requesting user.
"permissionId": "A String", # Output only. The user's ID as visible in Permission resources.
"photoLink": "A String", # Output only. A link to the user's profile photo, if available.
},
],
"parents": [ # The 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.
"A String",
],
"permissionIds": [ # Output only. List of permission IDs for users with access to this file.
"A String",
],
"permissions": [ # Output 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.
{ # A permission for a file. A permission grants a user, group, domain, or the world access to a file or a folder hierarchy. By default, permissions requests only return a subset of fields. Permission kind, ID, type, and role are always returned. To retrieve specific fields, see https://developers.google.com/drive/api/guides/fields-parameter. Some resource methods (such as `permissions.update`) require a `permissionId`. Use the `permissions.list` method to retrieve the ID for a file, folder, or shared drive.
"allowFileDiscovery": True or False, # Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type `domain` or `anyone`.
"deleted": True or False, # Output only. Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.
"displayName": "A String", # Output only. 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 "thecompany.com." * `anyone` - No `displayName` is present.
"domain": "A String", # The domain to which this permission refers.
"emailAddress": "A String", # The email address of the user or group to which this permission refers.
"expirationTime": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration times have the following restrictions: - They can only be set on user and group permissions - The time must be in the future - The time cannot be more than a year in the future
"id": "A String", # Output only. 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.
"kind": "drive#permission", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#permission"`.
"pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for `user` type permissions for files that are not in a shared drive.
"permissionDetails": [ # Output only. Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items.
{
"inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated. This is an output-only field.
"inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is an output-only field.
"permissionType": "A String", # Output only. The permission type for this user. While new values may be added in future, the following are currently possible: * `file` * `member`
"role": "A String", # Output only. The primary role for this user. While new values may be added in the future, the following are currently possible: * `organizer` * `fileOrganizer` * `writer` * `commenter` * `reader`
},
],
"photoLink": "A String", # Output only. A link to the user's profile photo, if available.
"role": "A String", # 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`
"teamDrivePermissionDetails": [ # Output only. Deprecated: Output only. Use `permissionDetails` instead.
{
"inherited": True or False, # Deprecated: Output only. Use `permissionDetails/inherited` instead.
"inheritedFrom": "A String", # Deprecated: Output only. Use `permissionDetails/inheritedFrom` instead.
"role": "A String", # Deprecated: Output only. Use `permissionDetails/role` instead.
"teamDrivePermissionType": "A String", # Deprecated: Output only. Use `permissionDetails/permissionType` instead.
},
],
"type": "A String", # 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 an `anyone` type.
"view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. 'published' is the only supported value.
},
],
"properties": { # A collection of arbitrary key-value pairs which are visible to all apps.
# Entries with null values are cleared in update and copy requests.
"a_key": "A String",
},
"quotaBytesUsed": "A String", # Output only. The number of storage quota bytes used by the file. This includes the head revision as well as previous revisions with `keepForever` enabled.
"resourceKey": "A String", # Output only. A key needed to access the item via a shared link.
"sha1Checksum": "A String", # Output only. The SHA1 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.
"sha256Checksum": "A String", # Output only. The SHA256 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.
"shared": True or False, # Output only. Whether the file has been shared. Not populated for items in shared drives.
"sharedWithMeTime": "A String", # The time at which the file was shared with the user, if applicable (RFC 3339 date-time).
"sharingUser": { # Information about a Drive user. # Output only. The user who shared the file with the requesting user, if applicable.
"displayName": "A String", # Output only. A plain text displayable name for this user.
"emailAddress": "A String", # Output only. 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.
"kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#user"`.
"me": True or False, # Output only. Whether this user is the requesting user.
"permissionId": "A String", # Output only. The user's ID as visible in Permission resources.
"photoLink": "A String", # Output only. A link to the user's profile photo, if available.
},
"shortcutDetails": { # Shortcut file details. Only populated for shortcut files, which have the mimeType field set to `application/vnd.google-apps.shortcut`. Can only be set on `files.create` requests.
"targetId": "A String", # The ID of the file that this shortcut points to. Can only be set on `files.create` requests.
"targetMimeType": "A String", # Output only. The MIME type of the file that this shortcut points to. The value of this field is a snapshot of the target's MIME type, captured when the shortcut is created.
"targetResourceKey": "A String", # Output only. The ResourceKey for the target file.
},
"size": "A String", # Output only. Size in bytes of blobs and first party editor files. Won't be populated for files that have no size, like shortcuts and folders.
"spaces": [ # Output only. The list of spaces which contain the file. The currently supported values are 'drive', 'appDataFolder' and 'photos'.
"A String",
],
"starred": True or False, # Whether the user has starred the file.
"teamDriveId": "A String", # Deprecated: Output only. Use `driveId` instead.
"thumbnailLink": "A String", # Output 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.
"thumbnailVersion": "A String", # Output only. The thumbnail version for use in thumbnail cache invalidation.
"trashed": True or False, # Whether the file has been trashed, either explicitly or from a trashed parent folder. Only the owner may trash a file, and other users cannot see files in the owner's trash.
"trashedTime": "A String", # The time that the item was trashed (RFC 3339 date-time). Only populated for items in shared drives.
"trashingUser": { # Information about a Drive user. # Output only. If the file has been explicitly trashed, the user who trashed it. Only populated for items in shared drives.
"displayName": "A String", # Output only. A plain text displayable name for this user.
"emailAddress": "A String", # Output only. 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.
"kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#user"`.
"me": True or False, # Output only. Whether this user is the requesting user.
"permissionId": "A String", # Output only. The user's ID as visible in Permission resources.
"photoLink": "A String", # Output only. A link to the user's profile photo, if available.
},
"version": "A String", # Output 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.
"videoMediaMetadata": { # Output only. Additional metadata about video media. This may not be available immediately upon upload.
"durationMillis": "A String", # Output only. The duration of the video in milliseconds.
"height": 42, # Output only. The height of the video in pixels.
"width": 42, # Output only. The width of the video in pixels.
},
"viewedByMe": True or False, # Output only. Whether the file has been viewed by this user.
"viewedByMeTime": "A String", # The last time the file was viewed by the user (RFC 3339 date-time).
"viewersCanCopyContent": True or False, # Deprecated: Use `copyRequiresWriterPermission` instead.
"webContentLink": "A String", # Output 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.
"webViewLink": "A String", # Output only. A link for opening the file in a relevant Google editor or viewer in a browser.
"writersCanShare": True or False, # Whether users with only `writer` permission can modify the file's permissions. Not populated for items in shared drives.
},
],
"incompleteSearch": True or False, # Whether the search process was incomplete. If true, then some search results might be missing, since all documents were not searched. This can occur when searching multiple drives with the 'allDrives' corpora, but all corpora couldn't be searched. When this happens, it's suggested that clients narrow their query by choosing a different corpus such as 'user' or 'drive'.
"kind": "drive#fileList", # Identifies what kind of resource this is. Value: the fixed string `"drive#fileList"`.
"nextPageToken": "A String", # The page token for the next page of files. This will be absent if the end of the files list has been reached. If the token is rejected for any reason, it should be discarded, and pagination should be restarted from the first page of results. The page token is typically valid for several hours. However, if new items are added or removed, your expected results might differ.
}
listLabels(fileId, maxResults=None, pageToken=None, x__xgafv=None)
Lists the labels on a file.
Args:
fileId: string, The ID for the file. (required)
maxResults: integer, The maximum number of labels to return per page. When not set, defaults to 100.
pageToken: string, The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A list of labels applied to a file.
"kind": "A String", # This is always drive#labelList
"labels": [ # The list of labels.
{ # Representation of label and label fields.
"fields": { # A map of the fields on the label, keyed by the field's ID.
"a_key": { # Representation of field, which is a typed key-value pair.
"dateString": [ # Only present if valueType is dateString. RFC 3339 formatted date: YYYY-MM-DD.
"A String",
],
"id": "A String", # The identifier of this label field.
"integer": [ # Only present if `valueType` is `integer`.
"A String",
],
"kind": "A String", # This is always drive#labelField.
"selection": [ # Only present if `valueType` is `selection`
"A String",
],
"text": [ # Only present if `valueType` is `text`.
"A String",
],
"user": [ # Only present if `valueType` is `user`.
{ # Information about a Drive user.
"displayName": "A String", # Output only. A plain text displayable name for this user.
"emailAddress": "A String", # Output only. 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.
"kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#user"`.
"me": True or False, # Output only. Whether this user is the requesting user.
"permissionId": "A String", # Output only. The user's ID as visible in Permission resources.
"photoLink": "A String", # Output only. A link to the user's profile photo, if available.
},
],
"valueType": "A String", # The field type. While new values may be supported in the future, the following are currently allowed: * `dateString` * `integer` * `selection` * `text` * `user`
},
},
"id": "A String", # The ID of the label.
"kind": "A String", # This is always drive#label
"revisionId": "A String", # The revision ID of the label.
},
],
"nextPageToken": "A String", # The page token for the next page of labels. This field will be absent if the end of the list has been reached. If the token is rejected for any reason, it should be discarded, and pagination should be restarted from the first page of results. The page token is typically valid for several hours. However, if new items are added or removed, your expected results might differ.
}
listLabels_next()
Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
list_next()
Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
modifyLabels(fileId, body=None, x__xgafv=None)
Modifies the set of labels applied to a file. Returns a list of the labels that were added or modified.
Args:
fileId: string, The ID of the file to which the labels belong. (required)
body: object, The request body.
The object takes the form of:
{ # A request to modify the set of labels on a file. This request may contain many modifications that will either all succeed or all fail atomically.
"kind": "A String", # This is always drive#modifyLabelsRequest.
"labelModifications": [ # The list of modifications to apply to the labels on the file.
{ # A modification to a label on a file. A LabelModification can be used to apply a label to a file, update an existing label on a file, or remove a label from a file.
"fieldModifications": [ # The list of modifications to this label's fields.
{ # A modification to a label's field.
"fieldId": "A String", # The ID of the field to be modified.
"kind": "A String", # This is always drive#labelFieldModification.
"setDateValues": [ # Replaces the value of a dateString Field with these new values. The string must be in the RFC 3339 full-date format: YYYY-MM-DD.
"A String",
],
"setIntegerValues": [ # Replaces the value of an `integer` field with these new values.
"A String",
],
"setSelectionValues": [ # Replaces a `selection` field with these new values.
"A String",
],
"setTextValues": [ # Sets the value of a `text` field.
"A String",
],
"setUserValues": [ # Replaces a `user` field with these new values. The values must be valid email addresses.
"A String",
],
"unsetValues": True or False, # Unsets the values for this field.
},
],
"kind": "A String", # This is always drive#labelModification.
"labelId": "A String", # The ID of the label to modify.
"removeLabel": True or False, # If true, the label will be removed from the file.
},
],
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response to a ModifyLabels request. This contains only those labels which were added or updated by the request.
"kind": "A String", # This is always drive#modifyLabelsResponse
"modifiedLabels": [ # The list of labels which were added or updated by the request.
{ # Representation of label and label fields.
"fields": { # A map of the fields on the label, keyed by the field's ID.
"a_key": { # Representation of field, which is a typed key-value pair.
"dateString": [ # Only present if valueType is dateString. RFC 3339 formatted date: YYYY-MM-DD.
"A String",
],
"id": "A String", # The identifier of this label field.
"integer": [ # Only present if `valueType` is `integer`.
"A String",
],
"kind": "A String", # This is always drive#labelField.
"selection": [ # Only present if `valueType` is `selection`
"A String",
],
"text": [ # Only present if `valueType` is `text`.
"A String",
],
"user": [ # Only present if `valueType` is `user`.
{ # Information about a Drive user.
"displayName": "A String", # Output only. A plain text displayable name for this user.
"emailAddress": "A String", # Output only. 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.
"kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#user"`.
"me": True or False, # Output only. Whether this user is the requesting user.
"permissionId": "A String", # Output only. The user's ID as visible in Permission resources.
"photoLink": "A String", # Output only. A link to the user's profile photo, if available.
},
],
"valueType": "A String", # The field type. While new values may be supported in the future, the following are currently allowed: * `dateString` * `integer` * `selection` * `text` * `user`
},
},
"id": "A String", # The ID of the label.
"kind": "A String", # This is always drive#label
"revisionId": "A String", # The revision ID of the label.
},
],
}
update(fileId, addParents=None, body=None, enforceSingleParent=None, includeLabels=None, includePermissionsForView=None, keepRevisionForever=None, media_body=None, media_mime_type=None, ocrLanguage=None, removeParents=None, supportsAllDrives=None, supportsTeamDrives=None, useContentAsIndexableText=None, x__xgafv=None)
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 be changed automatically, such as `modifiedDate`. This method supports patch semantics. This method supports an */upload* URI and accepts uploaded media with the following characteristics: - *Maximum file size:* 5,120 GB - *Accepted Media MIME types:*`*/*` Note: Specify a valid MIME type, rather than the literal `*/*` value. The literal `*/*` is only used to indicate that any valid MIME type can be uploaded. For more information on uploading files, see [Upload file data](/drive/api/guides/manage-uploads).
Args:
fileId: string, The ID of the file. (required)
body: object, The request body.
The object takes the form of:
{ # The 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.
"appProperties": { # A 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.
"a_key": "A String",
},
"capabilities": { # Output only. Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take.
"canAcceptOwnership": True or False, # Output only. Whether the current user is the pending owner of the file. Not populated for shared drive files.
"canAddChildren": True or False, # Output only. Whether the current user can add children to this folder. This is always false when the item is not a folder.
"canAddFolderFromAnotherDrive": True or False, # Output only. 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 is not a folder. Only populated for items in shared drives.
"canAddMyDriveParent": True or False, # Output only. 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.
"canChangeCopyRequiresWriterPermission": True or False, # Output only. Whether the current user can change the `copyRequiresWriterPermission` restriction of this file.
"canChangeSecurityUpdateEnabled": True or False, # Output only. Whether the current user can change the securityUpdateEnabled field on link share metadata.
"canChangeViewersCanCopyContent": True or False, # Deprecated: Output only.
"canComment": True or False, # Output only. Whether the current user can comment on this file.
"canCopy": True or False, # Output only. 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 is not a folder.
"canDelete": True or False, # Output only. Whether the current user can delete this file.
"canDeleteChildren": True or False, # Output only. Whether the current user can delete children of this folder. This is false when the item is not a folder. Only populated for items in shared drives.
"canDownload": True or False, # Output only. Whether the current user can download this file.
"canEdit": True or False, # Output only. Whether the current user can edit this file. Other factors may limit the type of changes a user can make to a file. For example, see `canChangeCopyRequiresWriterPermission` or `canModifyContent`.
"canListChildren": True or False, # Output only. Whether the current user can list the children of this folder. This is always false when the item is not a folder.
"canModifyContent": True or False, # Output only. Whether the current user can modify the content of this file.
"canModifyContentRestriction": True or False, # Deprecated: Output only. Use one of `canModifyEditorContentRestriction`, `canModifyOwnerContentRestriction` or `canRemoveContentRestriction`.
"canModifyEditorContentRestriction": True or False, # Output only. Whether the current user can add or modify content restrictions on the file which are editor restricted.
"canModifyLabels": True or False, # Output only. Whether the current user can modify the labels on the file.
"canModifyOwnerContentRestriction": True or False, # Output only. Whether the current user can add or modify content restrictions which are owner restricted.
"canMoveChildrenOutOfDrive": True or False, # Output only. Whether the current user can move children of this folder outside of the shared drive. This is false when the item is not a folder. Only populated for items in shared drives.
"canMoveChildrenOutOfTeamDrive": True or False, # Deprecated: Output only. Use `canMoveChildrenOutOfDrive` instead.
"canMoveChildrenWithinDrive": True or False, # Output only. Whether the current user can move children of this folder within this drive. This is false when the item is not a folder. Note that a request to move the child may still fail depending on the current user's access to the child and to the destination folder.
"canMoveChildrenWithinTeamDrive": True or False, # Deprecated: Output only. Use `canMoveChildrenWithinDrive` instead.
"canMoveItemIntoTeamDrive": True or False, # Deprecated: Output only. Use `canMoveItemOutOfDrive` instead.
"canMoveItemOutOfDrive": True or False, # Output only. Whether the current user can move this item outside of this drive by changing its parent. Note that a request to change the parent of the item may still fail depending on the new parent that is being added.
"canMoveItemOutOfTeamDrive": True or False, # Deprecated: Output only. Use `canMoveItemOutOfDrive` instead.
"canMoveItemWithinDrive": True or False, # Output only. Whether the current user can move this item within this drive. Note that a request to change the parent of the item may still fail depending on the new parent that is being added and the parent that is being removed.
"canMoveItemWithinTeamDrive": True or False, # Deprecated: Output only. Use `canMoveItemWithinDrive` instead.
"canMoveTeamDriveItem": True or False, # Deprecated: Output only. Use `canMoveItemWithinDrive` or `canMoveItemOutOfDrive` instead.
"canReadDrive": True or False, # Output only. Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives.
"canReadLabels": True or False, # Output only. Whether the current user can read the labels on the file.
"canReadRevisions": True or False, # Output only. 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 is not a folder, can be read.
"canReadTeamDrive": True or False, # Deprecated: Output only. Use `canReadDrive` instead.
"canRemoveChildren": True or False, # Output only. Whether the current user can remove children from this folder. This is always false when the item is not a folder. For a folder in a shared drive, use `canDeleteChildren` or `canTrashChildren` instead.
"canRemoveContentRestriction": True or False, # Output only. Whether there is a content restriction on the file that can be removed by the current user.
"canRemoveMyDriveParent": True or False, # Output only. 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.
"canRename": True or False, # Output only. Whether the current user can rename this file.
"canShare": True or False, # Output only. Whether the current user can modify the sharing settings for this file.
"canTrash": True or False, # Output only. Whether the current user can move this file to trash.
"canTrashChildren": True or False, # Output only. Whether the current user can trash children of this folder. This is false when the item is not a folder. Only populated for items in shared drives.
"canUntrash": True or False, # Output only. Whether the current user can restore this file from trash.
},
"contentHints": { # Additional information about the content of the file. These fields are never populated in responses.
"indexableText": "A String", # Text to be indexed for the file to improve fullText queries. This is limited to 128KB in length and may contain HTML elements.
"thumbnail": { # A thumbnail for the file. This will only be used if Google Drive cannot generate a standard thumbnail.
"image": "A String", # The thumbnail data encoded with URL-safe Base64 (RFC 4648 section 5).
"mimeType": "A String", # The MIME type of the thumbnail.
},
},
"contentRestrictions": [ # Restrictions for accessing the content of the file. Only populated if such a restriction exists.
{ # A restriction for accessing the content of the file.
"ownerRestricted": True or False, # Whether the content restriction can only be modified or removed by a user who owns the file. For files in shared drives, any user with `organizer` capabilities can modify or remove this content restriction.
"readOnly": True or False, # 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.
"reason": "A String", # Reason for why the content of the file is restricted. This is only mutable on requests that also set `readOnly=true`.
"restrictingUser": { # Information about a Drive user. # Output only. The user who set the content restriction. Only populated if `readOnly` is true.
"displayName": "A String", # Output only. A plain text displayable name for this user.
"emailAddress": "A String", # Output only. 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.
"kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#user"`.
"me": True or False, # Output only. Whether this user is the requesting user.
"permissionId": "A String", # Output only. The user's ID as visible in Permission resources.
"photoLink": "A String", # Output only. A link to the user's profile photo, if available.
},
"restrictionTime": "A String", # The time at which the content restriction was set (formatted RFC 3339 timestamp). Only populated if readOnly is true.
"systemRestricted": True or False, # Output only. Whether the content restriction was applied by the system, for example due to an esignature. Users cannot modify or remove system restricted content restrictions.
"type": "A String", # Output only. The type of the content restriction. Currently the only possible value is `globalContentRestriction`.
},
],
"copyRequiresWriterPermission": True or False, # Whether the options to copy, print, or download this file, should be disabled for readers and commenters.
"createdTime": "A String", # The time at which the file was created (RFC 3339 date-time).
"description": "A String", # A short description of the file.
"driveId": "A String", # Output only. ID of the shared drive the file resides in. Only populated for items in shared drives.
"explicitlyTrashed": True or False, # Output only. Whether the file has been explicitly trashed, as opposed to recursively trashed from a parent folder.
"exportLinks": { # Output only. Links for exporting Docs Editors files to specific formats.
"a_key": "A String",
},
"fileExtension": "A String", # Output only. The final component of `fullFileExtension`. This is only available for files with binary content in Google Drive.
"folderColorRgb": "A String", # The 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 resource. If an unsupported color is specified, the closest color in the palette is used instead.
"fullFileExtension": "A String", # Output 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 is not cleared if the new name does not contain a valid extension.
"hasAugmentedPermissions": True or False, # Output only. Whether there are permissions directly on this file. This field is only populated for items in shared drives.
"hasThumbnail": True or False, # Output only. 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.
"headRevisionId": "A String", # Output only. The ID of the file's head revision. This is currently only available for files with binary content in Google Drive.
"iconLink": "A String", # Output only. A static, unauthenticated link to the file's icon.
"id": "A String", # The ID of the file.
"imageMediaMetadata": { # Output only. Additional metadata about image media, if available.
"aperture": 3.14, # Output only. The aperture used to create the photo (f-number).
"cameraMake": "A String", # Output only. The make of the camera used to create the photo.
"cameraModel": "A String", # Output only. The model of the camera used to create the photo.
"colorSpace": "A String", # Output only. The color space of the photo.
"exposureBias": 3.14, # Output only. The exposure bias of the photo (APEX value).
"exposureMode": "A String", # Output only. The exposure mode used to create the photo.
"exposureTime": 3.14, # Output only. The length of the exposure, in seconds.
"flashUsed": True or False, # Output only. Whether a flash was used to create the photo.
"focalLength": 3.14, # Output only. The focal length used to create the photo, in millimeters.
"height": 42, # Output only. The height of the image in pixels.
"isoSpeed": 42, # Output only. The ISO speed used to create the photo.
"lens": "A String", # Output only. The lens used to create the photo.
"location": { # Output only. Geographic location information stored in the image.
"altitude": 3.14, # Output only. The altitude stored in the image.
"latitude": 3.14, # Output only. The latitude stored in the image.
"longitude": 3.14, # Output only. The longitude stored in the image.
},
"maxApertureValue": 3.14, # Output only. The smallest f-number of the lens at the focal length used to create the photo (APEX value).
"meteringMode": "A String", # Output only. The metering mode used to create the photo.
"rotation": 42, # Output only. The number of clockwise 90 degree rotations applied from the image's original orientation.
"sensor": "A String", # Output only. The type of sensor used to create the photo.
"subjectDistance": 42, # Output only. The distance to the subject of the photo, in meters.
"time": "A String", # Output only. The date and time the photo was taken (EXIF DateTime).
"whiteBalance": "A String", # Output only. The white balance mode used to create the photo.
"width": 42, # Output only. The width of the image in pixels.
},
"isAppAuthorized": True or False, # Output only. Whether the file was created or opened by the requesting app.
"kind": "drive#file", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#file"`.
"labelInfo": { # Output only. An overview of the labels on the file.
"labels": [ # Output only. The set of labels on the file as requested by the label IDs in the `includeLabels` parameter. By default, no labels are returned.
{ # Representation of label and label fields.
"fields": { # A map of the fields on the label, keyed by the field's ID.
"a_key": { # Representation of field, which is a typed key-value pair.
"dateString": [ # Only present if valueType is dateString. RFC 3339 formatted date: YYYY-MM-DD.
"A String",
],
"id": "A String", # The identifier of this label field.
"integer": [ # Only present if `valueType` is `integer`.
"A String",
],
"kind": "A String", # This is always drive#labelField.
"selection": [ # Only present if `valueType` is `selection`
"A String",
],
"text": [ # Only present if `valueType` is `text`.
"A String",
],
"user": [ # Only present if `valueType` is `user`.
{ # Information about a Drive user.
"displayName": "A String", # Output only. A plain text displayable name for this user.
"emailAddress": "A String", # Output only. 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.
"kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#user"`.
"me": True or False, # Output only. Whether this user is the requesting user.
"permissionId": "A String", # Output only. The user's ID as visible in Permission resources.
"photoLink": "A String", # Output only. A link to the user's profile photo, if available.
},
],
"valueType": "A String", # The field type. While new values may be supported in the future, the following are currently allowed: * `dateString` * `integer` * `selection` * `text` * `user`
},
},
"id": "A String", # The ID of the label.
"kind": "A String", # This is always drive#label
"revisionId": "A String", # The revision ID of the label.
},
],
},
"lastModifyingUser": { # Information about a Drive 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.
"displayName": "A String", # Output only. A plain text displayable name for this user.
"emailAddress": "A String", # Output only. 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.
"kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#user"`.
"me": True or False, # Output only. Whether this user is the requesting user.
"permissionId": "A String", # Output only. The user's ID as visible in Permission resources.
"photoLink": "A String", # Output only. A link to the user's profile photo, if available.
},
"linkShareMetadata": { # Contains details about the link URLs that clients are using to refer to this item.
"securityUpdateEligible": True or False, # Output only. Whether the file is eligible for security update.
"securityUpdateEnabled": True or False, # Output only. Whether the security update is enabled for this file.
},
"md5Checksum": "A String", # Output only. The MD5 checksum for the content of the file. This is only applicable to files with binary content in Google Drive.
"mimeType": "A String", # The 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 resource.
"modifiedByMe": True or False, # Output only. Whether the file has been modified by this user.
"modifiedByMeTime": "A String", # The last time the file was modified by the user (RFC 3339 date-time).
"modifiedTime": "A String", # he last time the file was modified by anyone (RFC 3339 date-time). Note that setting modifiedTime will also update modifiedByMeTime for the user.
"name": "A String", # The name of the file. This is not 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.
"originalFilename": "A String", # 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.
"ownedByMe": True or False, # Output only. Whether the user owns the file. Not populated for items in shared drives.
"owners": [ # Output 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.
{ # Information about a Drive user.
"displayName": "A String", # Output only. A plain text displayable name for this user.
"emailAddress": "A String", # Output only. 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.
"kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#user"`.
"me": True or False, # Output only. Whether this user is the requesting user.
"permissionId": "A String", # Output only. The user's ID as visible in Permission resources.
"photoLink": "A String", # Output only. A link to the user's profile photo, if available.
},
],
"parents": [ # The 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.
"A String",
],
"permissionIds": [ # Output only. List of permission IDs for users with access to this file.
"A String",
],
"permissions": [ # Output 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.
{ # A permission for a file. A permission grants a user, group, domain, or the world access to a file or a folder hierarchy. By default, permissions requests only return a subset of fields. Permission kind, ID, type, and role are always returned. To retrieve specific fields, see https://developers.google.com/drive/api/guides/fields-parameter. Some resource methods (such as `permissions.update`) require a `permissionId`. Use the `permissions.list` method to retrieve the ID for a file, folder, or shared drive.
"allowFileDiscovery": True or False, # Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type `domain` or `anyone`.
"deleted": True or False, # Output only. Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.
"displayName": "A String", # Output only. 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 "thecompany.com." * `anyone` - No `displayName` is present.
"domain": "A String", # The domain to which this permission refers.
"emailAddress": "A String", # The email address of the user or group to which this permission refers.
"expirationTime": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration times have the following restrictions: - They can only be set on user and group permissions - The time must be in the future - The time cannot be more than a year in the future
"id": "A String", # Output only. 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.
"kind": "drive#permission", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#permission"`.
"pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for `user` type permissions for files that are not in a shared drive.
"permissionDetails": [ # Output only. Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items.
{
"inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated. This is an output-only field.
"inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is an output-only field.
"permissionType": "A String", # Output only. The permission type for this user. While new values may be added in future, the following are currently possible: * `file` * `member`
"role": "A String", # Output only. The primary role for this user. While new values may be added in the future, the following are currently possible: * `organizer` * `fileOrganizer` * `writer` * `commenter` * `reader`
},
],
"photoLink": "A String", # Output only. A link to the user's profile photo, if available.
"role": "A String", # 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`
"teamDrivePermissionDetails": [ # Output only. Deprecated: Output only. Use `permissionDetails` instead.
{
"inherited": True or False, # Deprecated: Output only. Use `permissionDetails/inherited` instead.
"inheritedFrom": "A String", # Deprecated: Output only. Use `permissionDetails/inheritedFrom` instead.
"role": "A String", # Deprecated: Output only. Use `permissionDetails/role` instead.
"teamDrivePermissionType": "A String", # Deprecated: Output only. Use `permissionDetails/permissionType` instead.
},
],
"type": "A String", # 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 an `anyone` type.
"view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. 'published' is the only supported value.
},
],
"properties": { # A collection of arbitrary key-value pairs which are visible to all apps.
# Entries with null values are cleared in update and copy requests.
"a_key": "A String",
},
"quotaBytesUsed": "A String", # Output only. The number of storage quota bytes used by the file. This includes the head revision as well as previous revisions with `keepForever` enabled.
"resourceKey": "A String", # Output only. A key needed to access the item via a shared link.
"sha1Checksum": "A String", # Output only. The SHA1 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.
"sha256Checksum": "A String", # Output only. The SHA256 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.
"shared": True or False, # Output only. Whether the file has been shared. Not populated for items in shared drives.
"sharedWithMeTime": "A String", # The time at which the file was shared with the user, if applicable (RFC 3339 date-time).
"sharingUser": { # Information about a Drive user. # Output only. The user who shared the file with the requesting user, if applicable.
"displayName": "A String", # Output only. A plain text displayable name for this user.
"emailAddress": "A String", # Output only. 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.
"kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#user"`.
"me": True or False, # Output only. Whether this user is the requesting user.
"permissionId": "A String", # Output only. The user's ID as visible in Permission resources.
"photoLink": "A String", # Output only. A link to the user's profile photo, if available.
},
"shortcutDetails": { # Shortcut file details. Only populated for shortcut files, which have the mimeType field set to `application/vnd.google-apps.shortcut`. Can only be set on `files.create` requests.
"targetId": "A String", # The ID of the file that this shortcut points to. Can only be set on `files.create` requests.
"targetMimeType": "A String", # Output only. The MIME type of the file that this shortcut points to. The value of this field is a snapshot of the target's MIME type, captured when the shortcut is created.
"targetResourceKey": "A String", # Output only. The ResourceKey for the target file.
},
"size": "A String", # Output only. Size in bytes of blobs and first party editor files. Won't be populated for files that have no size, like shortcuts and folders.
"spaces": [ # Output only. The list of spaces which contain the file. The currently supported values are 'drive', 'appDataFolder' and 'photos'.
"A String",
],
"starred": True or False, # Whether the user has starred the file.
"teamDriveId": "A String", # Deprecated: Output only. Use `driveId` instead.
"thumbnailLink": "A String", # Output 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.
"thumbnailVersion": "A String", # Output only. The thumbnail version for use in thumbnail cache invalidation.
"trashed": True or False, # Whether the file has been trashed, either explicitly or from a trashed parent folder. Only the owner may trash a file, and other users cannot see files in the owner's trash.
"trashedTime": "A String", # The time that the item was trashed (RFC 3339 date-time). Only populated for items in shared drives.
"trashingUser": { # Information about a Drive user. # Output only. If the file has been explicitly trashed, the user who trashed it. Only populated for items in shared drives.
"displayName": "A String", # Output only. A plain text displayable name for this user.
"emailAddress": "A String", # Output only. 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.
"kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#user"`.
"me": True or False, # Output only. Whether this user is the requesting user.
"permissionId": "A String", # Output only. The user's ID as visible in Permission resources.
"photoLink": "A String", # Output only. A link to the user's profile photo, if available.
},
"version": "A String", # Output 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.
"videoMediaMetadata": { # Output only. Additional metadata about video media. This may not be available immediately upon upload.
"durationMillis": "A String", # Output only. The duration of the video in milliseconds.
"height": 42, # Output only. The height of the video in pixels.
"width": 42, # Output only. The width of the video in pixels.
},
"viewedByMe": True or False, # Output only. Whether the file has been viewed by this user.
"viewedByMeTime": "A String", # The last time the file was viewed by the user (RFC 3339 date-time).
"viewersCanCopyContent": True or False, # Deprecated: Use `copyRequiresWriterPermission` instead.
"webContentLink": "A String", # Output 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.
"webViewLink": "A String", # Output only. A link for opening the file in a relevant Google editor or viewer in a browser.
"writersCanShare": True or False, # Whether users with only `writer` permission can modify the file's permissions. Not populated for items in shared drives.
}
addParents: string, A comma-separated list of parent IDs to add.
enforceSingleParent: boolean, Deprecated: Adding files to multiple folders is no longer supported. Use shortcuts instead.
includeLabels: string, A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.
includePermissionsForView: string, Specifies which additional view's permissions to include in the response. Only 'published' is supported.
keepRevisionForever: boolean, 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.
media_body: string, The filename of the media request body, or an instance of a MediaUpload object.
media_mime_type: string, The MIME type of the media request body, or an instance of a MediaUpload object.
ocrLanguage: string, A language hint for OCR processing during image import (ISO 639-1 code).
removeParents: string, A comma-separated list of parent IDs to remove.
supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives.
supportsTeamDrives: boolean, Deprecated: Use `supportsAllDrives` instead.
useContentAsIndexableText: boolean, Whether to use the uploaded content as indexable text.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The 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.
"appProperties": { # A 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.
"a_key": "A String",
},
"capabilities": { # Output only. Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take.
"canAcceptOwnership": True or False, # Output only. Whether the current user is the pending owner of the file. Not populated for shared drive files.
"canAddChildren": True or False, # Output only. Whether the current user can add children to this folder. This is always false when the item is not a folder.
"canAddFolderFromAnotherDrive": True or False, # Output only. 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 is not a folder. Only populated for items in shared drives.
"canAddMyDriveParent": True or False, # Output only. 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.
"canChangeCopyRequiresWriterPermission": True or False, # Output only. Whether the current user can change the `copyRequiresWriterPermission` restriction of this file.
"canChangeSecurityUpdateEnabled": True or False, # Output only. Whether the current user can change the securityUpdateEnabled field on link share metadata.
"canChangeViewersCanCopyContent": True or False, # Deprecated: Output only.
"canComment": True or False, # Output only. Whether the current user can comment on this file.
"canCopy": True or False, # Output only. 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 is not a folder.
"canDelete": True or False, # Output only. Whether the current user can delete this file.
"canDeleteChildren": True or False, # Output only. Whether the current user can delete children of this folder. This is false when the item is not a folder. Only populated for items in shared drives.
"canDownload": True or False, # Output only. Whether the current user can download this file.
"canEdit": True or False, # Output only. Whether the current user can edit this file. Other factors may limit the type of changes a user can make to a file. For example, see `canChangeCopyRequiresWriterPermission` or `canModifyContent`.
"canListChildren": True or False, # Output only. Whether the current user can list the children of this folder. This is always false when the item is not a folder.
"canModifyContent": True or False, # Output only. Whether the current user can modify the content of this file.
"canModifyContentRestriction": True or False, # Deprecated: Output only. Use one of `canModifyEditorContentRestriction`, `canModifyOwnerContentRestriction` or `canRemoveContentRestriction`.
"canModifyEditorContentRestriction": True or False, # Output only. Whether the current user can add or modify content restrictions on the file which are editor restricted.
"canModifyLabels": True or False, # Output only. Whether the current user can modify the labels on the file.
"canModifyOwnerContentRestriction": True or False, # Output only. Whether the current user can add or modify content restrictions which are owner restricted.
"canMoveChildrenOutOfDrive": True or False, # Output only. Whether the current user can move children of this folder outside of the shared drive. This is false when the item is not a folder. Only populated for items in shared drives.
"canMoveChildrenOutOfTeamDrive": True or False, # Deprecated: Output only. Use `canMoveChildrenOutOfDrive` instead.
"canMoveChildrenWithinDrive": True or False, # Output only. Whether the current user can move children of this folder within this drive. This is false when the item is not a folder. Note that a request to move the child may still fail depending on the current user's access to the child and to the destination folder.
"canMoveChildrenWithinTeamDrive": True or False, # Deprecated: Output only. Use `canMoveChildrenWithinDrive` instead.
"canMoveItemIntoTeamDrive": True or False, # Deprecated: Output only. Use `canMoveItemOutOfDrive` instead.
"canMoveItemOutOfDrive": True or False, # Output only. Whether the current user can move this item outside of this drive by changing its parent. Note that a request to change the parent of the item may still fail depending on the new parent that is being added.
"canMoveItemOutOfTeamDrive": True or False, # Deprecated: Output only. Use `canMoveItemOutOfDrive` instead.
"canMoveItemWithinDrive": True or False, # Output only. Whether the current user can move this item within this drive. Note that a request to change the parent of the item may still fail depending on the new parent that is being added and the parent that is being removed.
"canMoveItemWithinTeamDrive": True or False, # Deprecated: Output only. Use `canMoveItemWithinDrive` instead.
"canMoveTeamDriveItem": True or False, # Deprecated: Output only. Use `canMoveItemWithinDrive` or `canMoveItemOutOfDrive` instead.
"canReadDrive": True or False, # Output only. Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives.
"canReadLabels": True or False, # Output only. Whether the current user can read the labels on the file.
"canReadRevisions": True or False, # Output only. 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 is not a folder, can be read.
"canReadTeamDrive": True or False, # Deprecated: Output only. Use `canReadDrive` instead.
"canRemoveChildren": True or False, # Output only. Whether the current user can remove children from this folder. This is always false when the item is not a folder. For a folder in a shared drive, use `canDeleteChildren` or `canTrashChildren` instead.
"canRemoveContentRestriction": True or False, # Output only. Whether there is a content restriction on the file that can be removed by the current user.
"canRemoveMyDriveParent": True or False, # Output only. 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.
"canRename": True or False, # Output only. Whether the current user can rename this file.
"canShare": True or False, # Output only. Whether the current user can modify the sharing settings for this file.
"canTrash": True or False, # Output only. Whether the current user can move this file to trash.
"canTrashChildren": True or False, # Output only. Whether the current user can trash children of this folder. This is false when the item is not a folder. Only populated for items in shared drives.
"canUntrash": True or False, # Output only. Whether the current user can restore this file from trash.
},
"contentHints": { # Additional information about the content of the file. These fields are never populated in responses.
"indexableText": "A String", # Text to be indexed for the file to improve fullText queries. This is limited to 128KB in length and may contain HTML elements.
"thumbnail": { # A thumbnail for the file. This will only be used if Google Drive cannot generate a standard thumbnail.
"image": "A String", # The thumbnail data encoded with URL-safe Base64 (RFC 4648 section 5).
"mimeType": "A String", # The MIME type of the thumbnail.
},
},
"contentRestrictions": [ # Restrictions for accessing the content of the file. Only populated if such a restriction exists.
{ # A restriction for accessing the content of the file.
"ownerRestricted": True or False, # Whether the content restriction can only be modified or removed by a user who owns the file. For files in shared drives, any user with `organizer` capabilities can modify or remove this content restriction.
"readOnly": True or False, # 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.
"reason": "A String", # Reason for why the content of the file is restricted. This is only mutable on requests that also set `readOnly=true`.
"restrictingUser": { # Information about a Drive user. # Output only. The user who set the content restriction. Only populated if `readOnly` is true.
"displayName": "A String", # Output only. A plain text displayable name for this user.
"emailAddress": "A String", # Output only. 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.
"kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#user"`.
"me": True or False, # Output only. Whether this user is the requesting user.
"permissionId": "A String", # Output only. The user's ID as visible in Permission resources.
"photoLink": "A String", # Output only. A link to the user's profile photo, if available.
},
"restrictionTime": "A String", # The time at which the content restriction was set (formatted RFC 3339 timestamp). Only populated if readOnly is true.
"systemRestricted": True or False, # Output only. Whether the content restriction was applied by the system, for example due to an esignature. Users cannot modify or remove system restricted content restrictions.
"type": "A String", # Output only. The type of the content restriction. Currently the only possible value is `globalContentRestriction`.
},
],
"copyRequiresWriterPermission": True or False, # Whether the options to copy, print, or download this file, should be disabled for readers and commenters.
"createdTime": "A String", # The time at which the file was created (RFC 3339 date-time).
"description": "A String", # A short description of the file.
"driveId": "A String", # Output only. ID of the shared drive the file resides in. Only populated for items in shared drives.
"explicitlyTrashed": True or False, # Output only. Whether the file has been explicitly trashed, as opposed to recursively trashed from a parent folder.
"exportLinks": { # Output only. Links for exporting Docs Editors files to specific formats.
"a_key": "A String",
},
"fileExtension": "A String", # Output only. The final component of `fullFileExtension`. This is only available for files with binary content in Google Drive.
"folderColorRgb": "A String", # The 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 resource. If an unsupported color is specified, the closest color in the palette is used instead.
"fullFileExtension": "A String", # Output 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 is not cleared if the new name does not contain a valid extension.
"hasAugmentedPermissions": True or False, # Output only. Whether there are permissions directly on this file. This field is only populated for items in shared drives.
"hasThumbnail": True or False, # Output only. 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.
"headRevisionId": "A String", # Output only. The ID of the file's head revision. This is currently only available for files with binary content in Google Drive.
"iconLink": "A String", # Output only. A static, unauthenticated link to the file's icon.
"id": "A String", # The ID of the file.
"imageMediaMetadata": { # Output only. Additional metadata about image media, if available.
"aperture": 3.14, # Output only. The aperture used to create the photo (f-number).
"cameraMake": "A String", # Output only. The make of the camera used to create the photo.
"cameraModel": "A String", # Output only. The model of the camera used to create the photo.
"colorSpace": "A String", # Output only. The color space of the photo.
"exposureBias": 3.14, # Output only. The exposure bias of the photo (APEX value).
"exposureMode": "A String", # Output only. The exposure mode used to create the photo.
"exposureTime": 3.14, # Output only. The length of the exposure, in seconds.
"flashUsed": True or False, # Output only. Whether a flash was used to create the photo.
"focalLength": 3.14, # Output only. The focal length used to create the photo, in millimeters.
"height": 42, # Output only. The height of the image in pixels.
"isoSpeed": 42, # Output only. The ISO speed used to create the photo.
"lens": "A String", # Output only. The lens used to create the photo.
"location": { # Output only. Geographic location information stored in the image.
"altitude": 3.14, # Output only. The altitude stored in the image.
"latitude": 3.14, # Output only. The latitude stored in the image.
"longitude": 3.14, # Output only. The longitude stored in the image.
},
"maxApertureValue": 3.14, # Output only. The smallest f-number of the lens at the focal length used to create the photo (APEX value).
"meteringMode": "A String", # Output only. The metering mode used to create the photo.
"rotation": 42, # Output only. The number of clockwise 90 degree rotations applied from the image's original orientation.
"sensor": "A String", # Output only. The type of sensor used to create the photo.
"subjectDistance": 42, # Output only. The distance to the subject of the photo, in meters.
"time": "A String", # Output only. The date and time the photo was taken (EXIF DateTime).
"whiteBalance": "A String", # Output only. The white balance mode used to create the photo.
"width": 42, # Output only. The width of the image in pixels.
},
"isAppAuthorized": True or False, # Output only. Whether the file was created or opened by the requesting app.
"kind": "drive#file", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#file"`.
"labelInfo": { # Output only. An overview of the labels on the file.
"labels": [ # Output only. The set of labels on the file as requested by the label IDs in the `includeLabels` parameter. By default, no labels are returned.
{ # Representation of label and label fields.
"fields": { # A map of the fields on the label, keyed by the field's ID.
"a_key": { # Representation of field, which is a typed key-value pair.
"dateString": [ # Only present if valueType is dateString. RFC 3339 formatted date: YYYY-MM-DD.
"A String",
],
"id": "A String", # The identifier of this label field.
"integer": [ # Only present if `valueType` is `integer`.
"A String",
],
"kind": "A String", # This is always drive#labelField.
"selection": [ # Only present if `valueType` is `selection`
"A String",
],
"text": [ # Only present if `valueType` is `text`.
"A String",
],
"user": [ # Only present if `valueType` is `user`.
{ # Information about a Drive user.
"displayName": "A String", # Output only. A plain text displayable name for this user.
"emailAddress": "A String", # Output only. 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.
"kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#user"`.
"me": True or False, # Output only. Whether this user is the requesting user.
"permissionId": "A String", # Output only. The user's ID as visible in Permission resources.
"photoLink": "A String", # Output only. A link to the user's profile photo, if available.
},
],
"valueType": "A String", # The field type. While new values may be supported in the future, the following are currently allowed: * `dateString` * `integer` * `selection` * `text` * `user`
},
},
"id": "A String", # The ID of the label.
"kind": "A String", # This is always drive#label
"revisionId": "A String", # The revision ID of the label.
},
],
},
"lastModifyingUser": { # Information about a Drive 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.
"displayName": "A String", # Output only. A plain text displayable name for this user.
"emailAddress": "A String", # Output only. 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.
"kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#user"`.
"me": True or False, # Output only. Whether this user is the requesting user.
"permissionId": "A String", # Output only. The user's ID as visible in Permission resources.
"photoLink": "A String", # Output only. A link to the user's profile photo, if available.
},
"linkShareMetadata": { # Contains details about the link URLs that clients are using to refer to this item.
"securityUpdateEligible": True or False, # Output only. Whether the file is eligible for security update.
"securityUpdateEnabled": True or False, # Output only. Whether the security update is enabled for this file.
},
"md5Checksum": "A String", # Output only. The MD5 checksum for the content of the file. This is only applicable to files with binary content in Google Drive.
"mimeType": "A String", # The 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 resource.
"modifiedByMe": True or False, # Output only. Whether the file has been modified by this user.
"modifiedByMeTime": "A String", # The last time the file was modified by the user (RFC 3339 date-time).
"modifiedTime": "A String", # he last time the file was modified by anyone (RFC 3339 date-time). Note that setting modifiedTime will also update modifiedByMeTime for the user.
"name": "A String", # The name of the file. This is not 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.
"originalFilename": "A String", # 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.
"ownedByMe": True or False, # Output only. Whether the user owns the file. Not populated for items in shared drives.
"owners": [ # Output 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.
{ # Information about a Drive user.
"displayName": "A String", # Output only. A plain text displayable name for this user.
"emailAddress": "A String", # Output only. 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.
"kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#user"`.
"me": True or False, # Output only. Whether this user is the requesting user.
"permissionId": "A String", # Output only. The user's ID as visible in Permission resources.
"photoLink": "A String", # Output only. A link to the user's profile photo, if available.
},
],
"parents": [ # The 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.
"A String",
],
"permissionIds": [ # Output only. List of permission IDs for users with access to this file.
"A String",
],
"permissions": [ # Output 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.
{ # A permission for a file. A permission grants a user, group, domain, or the world access to a file or a folder hierarchy. By default, permissions requests only return a subset of fields. Permission kind, ID, type, and role are always returned. To retrieve specific fields, see https://developers.google.com/drive/api/guides/fields-parameter. Some resource methods (such as `permissions.update`) require a `permissionId`. Use the `permissions.list` method to retrieve the ID for a file, folder, or shared drive.
"allowFileDiscovery": True or False, # Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type `domain` or `anyone`.
"deleted": True or False, # Output only. Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.
"displayName": "A String", # Output only. 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 "thecompany.com." * `anyone` - No `displayName` is present.
"domain": "A String", # The domain to which this permission refers.
"emailAddress": "A String", # The email address of the user or group to which this permission refers.
"expirationTime": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration times have the following restrictions: - They can only be set on user and group permissions - The time must be in the future - The time cannot be more than a year in the future
"id": "A String", # Output only. 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.
"kind": "drive#permission", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#permission"`.
"pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for `user` type permissions for files that are not in a shared drive.
"permissionDetails": [ # Output only. Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items.
{
"inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated. This is an output-only field.
"inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is an output-only field.
"permissionType": "A String", # Output only. The permission type for this user. While new values may be added in future, the following are currently possible: * `file` * `member`
"role": "A String", # Output only. The primary role for this user. While new values may be added in the future, the following are currently possible: * `organizer` * `fileOrganizer` * `writer` * `commenter` * `reader`
},
],
"photoLink": "A String", # Output only. A link to the user's profile photo, if available.
"role": "A String", # 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`
"teamDrivePermissionDetails": [ # Output only. Deprecated: Output only. Use `permissionDetails` instead.
{
"inherited": True or False, # Deprecated: Output only. Use `permissionDetails/inherited` instead.
"inheritedFrom": "A String", # Deprecated: Output only. Use `permissionDetails/inheritedFrom` instead.
"role": "A String", # Deprecated: Output only. Use `permissionDetails/role` instead.
"teamDrivePermissionType": "A String", # Deprecated: Output only. Use `permissionDetails/permissionType` instead.
},
],
"type": "A String", # 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 an `anyone` type.
"view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. 'published' is the only supported value.
},
],
"properties": { # A collection of arbitrary key-value pairs which are visible to all apps.
# Entries with null values are cleared in update and copy requests.
"a_key": "A String",
},
"quotaBytesUsed": "A String", # Output only. The number of storage quota bytes used by the file. This includes the head revision as well as previous revisions with `keepForever` enabled.
"resourceKey": "A String", # Output only. A key needed to access the item via a shared link.
"sha1Checksum": "A String", # Output only. The SHA1 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.
"sha256Checksum": "A String", # Output only. The SHA256 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.
"shared": True or False, # Output only. Whether the file has been shared. Not populated for items in shared drives.
"sharedWithMeTime": "A String", # The time at which the file was shared with the user, if applicable (RFC 3339 date-time).
"sharingUser": { # Information about a Drive user. # Output only. The user who shared the file with the requesting user, if applicable.
"displayName": "A String", # Output only. A plain text displayable name for this user.
"emailAddress": "A String", # Output only. 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.
"kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#user"`.
"me": True or False, # Output only. Whether this user is the requesting user.
"permissionId": "A String", # Output only. The user's ID as visible in Permission resources.
"photoLink": "A String", # Output only. A link to the user's profile photo, if available.
},
"shortcutDetails": { # Shortcut file details. Only populated for shortcut files, which have the mimeType field set to `application/vnd.google-apps.shortcut`. Can only be set on `files.create` requests.
"targetId": "A String", # The ID of the file that this shortcut points to. Can only be set on `files.create` requests.
"targetMimeType": "A String", # Output only. The MIME type of the file that this shortcut points to. The value of this field is a snapshot of the target's MIME type, captured when the shortcut is created.
"targetResourceKey": "A String", # Output only. The ResourceKey for the target file.
},
"size": "A String", # Output only. Size in bytes of blobs and first party editor files. Won't be populated for files that have no size, like shortcuts and folders.
"spaces": [ # Output only. The list of spaces which contain the file. The currently supported values are 'drive', 'appDataFolder' and 'photos'.
"A String",
],
"starred": True or False, # Whether the user has starred the file.
"teamDriveId": "A String", # Deprecated: Output only. Use `driveId` instead.
"thumbnailLink": "A String", # Output 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.
"thumbnailVersion": "A String", # Output only. The thumbnail version for use in thumbnail cache invalidation.
"trashed": True or False, # Whether the file has been trashed, either explicitly or from a trashed parent folder. Only the owner may trash a file, and other users cannot see files in the owner's trash.
"trashedTime": "A String", # The time that the item was trashed (RFC 3339 date-time). Only populated for items in shared drives.
"trashingUser": { # Information about a Drive user. # Output only. If the file has been explicitly trashed, the user who trashed it. Only populated for items in shared drives.
"displayName": "A String", # Output only. A plain text displayable name for this user.
"emailAddress": "A String", # Output only. 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.
"kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#user"`.
"me": True or False, # Output only. Whether this user is the requesting user.
"permissionId": "A String", # Output only. The user's ID as visible in Permission resources.
"photoLink": "A String", # Output only. A link to the user's profile photo, if available.
},
"version": "A String", # Output 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.
"videoMediaMetadata": { # Output only. Additional metadata about video media. This may not be available immediately upon upload.
"durationMillis": "A String", # Output only. The duration of the video in milliseconds.
"height": 42, # Output only. The height of the video in pixels.
"width": 42, # Output only. The width of the video in pixels.
},
"viewedByMe": True or False, # Output only. Whether the file has been viewed by this user.
"viewedByMeTime": "A String", # The last time the file was viewed by the user (RFC 3339 date-time).
"viewersCanCopyContent": True or False, # Deprecated: Use `copyRequiresWriterPermission` instead.
"webContentLink": "A String", # Output 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.
"webViewLink": "A String", # Output only. A link for opening the file in a relevant Google editor or viewer in a browser.
"writersCanShare": True or False, # Whether users with only `writer` permission can modify the file's permissions. Not populated for items in shared drives.
}
watch(fileId, acknowledgeAbuse=None, body=None, includeLabels=None, includePermissionsForView=None, supportsAllDrives=None, supportsTeamDrives=None, x__xgafv=None)
Subscribes to changes to a file.
Args:
fileId: string, The ID of the file. (required)
body: object, The request body.
The object takes the form of:
{ # A notification channel used to watch for resource changes.
"address": "A String", # The address where notifications are delivered for this channel.
"expiration": "A String", # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.
"id": "A String", # A UUID or similar unique string that identifies this channel.
"kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource, which is `api#channel`.
"params": { # Additional parameters controlling delivery channel behavior. Optional.
"a_key": "A String",
},
"payload": True or False, # A Boolean value to indicate whether payload is wanted. Optional.
"resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.
"resourceUri": "A String", # A version-specific identifier for the watched resource.
"token": "A String", # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.
"type": "A String", # The type of delivery mechanism used for this channel. Valid values are "web_hook" or "webhook".
}
acknowledgeAbuse: boolean, Whether the user is acknowledging the risk of downloading known malware or other abusive files. This is only applicable when the `alt` parameter is set to `media` and the user is the owner of the file or an organizer of the shared drive in which the file resides.
includeLabels: string, A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.
includePermissionsForView: string, Specifies which additional view's permissions to include in the response. Only 'published' is supported.
supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives.
supportsTeamDrives: boolean, Deprecated: Use `supportsAllDrives` instead.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A notification channel used to watch for resource changes.
"address": "A String", # The address where notifications are delivered for this channel.
"expiration": "A String", # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.
"id": "A String", # A UUID or similar unique string that identifies this channel.
"kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource, which is `api#channel`.
"params": { # Additional parameters controlling delivery channel behavior. Optional.
"a_key": "A String",
},
"payload": True or False, # A Boolean value to indicate whether payload is wanted. Optional.
"resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.
"resourceUri": "A String", # A version-specific identifier for the watched resource.
"token": "A String", # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.
"type": "A String", # The type of delivery mechanism used for this channel. Valid values are "web_hook" or "webhook".
}