Close httplib2 connections.
Creates a copy of the specified file.
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.
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(maxResults=None, space=None, type=None, x__xgafv=None)
Generates a set of file IDs which can be provided in insert 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/v2/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/v2/files/export) instead. For more information, see [Download & export files](/drive/api/guides/manage-downloads).
Inserts 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.insert` must specify the MIME type `application/vnd.google-apps.shortcut`. Apps should specify a file extension in the `title` property when inserting files with the API. For example, an operation to insert a JPEG file should specify something like `"title": "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.
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 change automatically, such as modifiedDate. This method supports patch semantics.
Set the file's updated time to the current server time.
Moves a file to the trash. The currently authenticated user must own the file or be at least a `fileOrganizer` on the parent for shared drive files.
Restores a file from the trash. The currently authenticated user must own the file or be at least a `fileOrganizer` on the parent for shared drive files.
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, convert=None, enforceSingleParent=None, includeLabels=None, includePermissionsForView=None, ocr=None, ocrLanguage=None, pinned=None, supportsAllDrives=None, supportsTeamDrives=None, timedTextLanguage=None, timedTextTrackName=None, visibility=None, x__xgafv=None)
Creates a copy of the specified file.
Args:
fileId: string, The ID of the file to copy. (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.
"alternateLink": "A String", # Output only. A link for opening the file in a relevant Google editor or viewer.
"appDataContents": True or False, # Output only. Whether this file is in the Application Data folder.
"canComment": True or False, # Output only. Deprecated: Use `capabilities/canComment` instead.
"canReadRevisions": True or False, # Output only. Deprecated: Use `capabilities/canReadRevisions` instead.
"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.
"canChangeRestrictedDownload": True or False, # Output only. Deprecated.
"canChangeSecurityUpdateEnabled": True or False, # Output only. Whether the current user can change the securityUpdateEnabled field on link share metadata.
"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, # Output only. Deprecated: 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, # Output only. Deprecated: Use `canMoveChildrenWithinDrive` instead.
"canMoveItemIntoTeamDrive": True or False, # Output only. Deprecated: 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, # Output only. Deprecated: 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, # Output only. Deprecated: Use `canMoveItemWithinDrive` instead.
"canMoveTeamDriveItem": True or False, # Output only. Deprecated: 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, # Output only. Deprecated: 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.
},
"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.
"isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made.
"kind": "drive#user", # Output only. This is always `drive#user`.
"permissionId": "A String", # Output only. The user's ID as visible in the permissions collection.
"picture": { # Output only. The user's profile picture.
"url": "A String", # Output Only. A URL that points to a profile picture of this user.
},
},
"restrictionDate": "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.
"copyable": True or False, # Output only. Deprecated: Use `capabilities/canCopy` instead.
"createdDate": "A String", # Create time for this file (formatted RFC 3339 timestamp).
"defaultOpenWithLink": "A String", # Output only. A link to open this file with the user's default app for this file. Only populated when the drive.apps.readonly scope is used.
"description": "A String", # A short description of the file.
"downloadUrl": "A String", # Output only. Short lived download URL for the file. This field is only populated for files with content stored in Google Drive; it is not populated for Google Docs or shortcut files.
"driveId": "A String", # Output only. ID of the shared drive the file resides in. Only populated for items in shared drives.
"editable": True or False, # Output only. Deprecated: Use `capabilities/canEdit` instead.
"embedLink": "A String", # Output only. A link for embedding the file.
"etag": "A String", # Output only. ETag of the file.
"explicitlyTrashed": True or False, # Output only. Whether this file has been explicitly trashed, as opposed to recursively trashed.
"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` with trailing text that does not appear to be part of the extension removed. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.
"fileSize": "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.
"folderColorRgb": "A String", # Folder color as an RGB hex string if the file is a folder or a shortcut to a folder. The list of supported colors is available in the folderColorPalette field of the About resource. If an unsupported color is specified, it will be changed to the closest color in the palette.
"fullFileExtension": "A String", # Output only. The full file extension; extracted from the title. May contain multiple concatenated extensions, such as "tar.gz". Removing an extension from the title does not clear this field; however, changing the extension on the title does update this field. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.
"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 field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.
"iconLink": "A String", # Output only. A link to the file's icon.
"id": "A String", # The ID of the file.
"imageMediaMetadata": { # Output only. Metadata about image media. This will only be present for image types, and its contents will depend on what can be parsed from the image content.
"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.
"date": "A String", # Output only. The date and time the photo was taken (EXIF format timestamp).
"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.
"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.
},
"indexableText": { # Indexable text attributes for the file (can only be written)
"text": "A String", # The text to be indexed for this file.
},
"isAppAuthorized": True or False, # Output only. Whether the file was created or opened by the requesting app.
"kind": "drive#file", # Output only. The type of file. This is always `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 a 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": "drive#labelField", # 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.
"isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made.
"kind": "drive#user", # Output only. This is always `drive#user`.
"permissionId": "A String", # Output only. The user's ID as visible in the permissions collection.
"picture": { # Output only. The user's profile picture.
"url": "A String", # Output Only. A URL that points to a profile picture of this user.
},
},
],
"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": "drive#label", # This is always `drive#label`
"revisionId": "A String", # The revision ID of the label.
},
],
},
"labels": { # A group of labels for the file.
"hidden": True or False, # Output only. Deprecated.
"modified": True or False, # Output only. Whether the file has been modified by this user.
"restricted": True or False, # Output only. Deprecated: Use `copyRequiresWriterPermission` instead.
"starred": True or False, # Whether this file is starred by the user.
"trashed": True or False, # Whether this file has been trashed. This label applies to all users accessing the file; however, only owners are allowed to see and untrash files.
"viewed": True or False, # Whether this file has been viewed by this user.
},
"lastModifyingUser": { # Information about a Drive user. # Output only. The last user to modify this 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.
"isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made.
"kind": "drive#user", # Output only. This is always `drive#user`.
"permissionId": "A String", # Output only. The user's ID as visible in the permissions collection.
"picture": { # Output only. The user's profile picture.
"url": "A String", # Output Only. A URL that points to a profile picture of this user.
},
},
"lastModifyingUserName": "A String", # Output only. Name of the last user to modify this file.
"lastViewedByMeDate": "A String", # Last time this file was viewed by the user (formatted RFC 3339 timestamp).
"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.
},
"markedViewedByMeDate": "A String", # Deprecated.
"md5Checksum": "A String", # Output only. An MD5 checksum for the content of this file. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.
"mimeType": "A String", # The MIME type of the file. This is only mutable on update when uploading new content. This field can be left blank, and the mimetype will be determined from the uploaded content's MIME type.
"modifiedByMeDate": "A String", # Last time this file was modified by the user (formatted RFC 3339 timestamp). Note that setting modifiedDate will also update the modifiedByMe date for the user which set the date.
"modifiedDate": "A String", # Last time this file was modified by anyone (formatted RFC 3339 timestamp). This is only mutable on update when the setModifiedDate parameter is set.
"openWithLinks": { # Output only. A map of the id of each of the user's apps to a link to open this file with that app. Only populated when the drive.apps.readonly scope is used.
"a_key": "A String",
},
"originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the `title` field. This is only available for files with binary content in Google Drive.
"ownedByMe": True or False, # Output only. Whether the file is owned by the current user. Not populated for items in shared drives.
"ownerNames": [ # Output only. Name(s) of the owner(s) of this file. Not populated for items in shared drives.
"A String",
],
"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.
"isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made.
"kind": "drive#user", # Output only. This is always `drive#user`.
"permissionId": "A String", # Output only. The user's ID as visible in the permissions collection.
"picture": { # Output only. The user's profile picture.
"url": "A String", # Output Only. A URL that points to a profile picture of this user.
},
},
],
"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 an insert 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 reference to a file's parent. A file can only have one parent folder; specifying multiple parents isn't supported. Some resource methods (such as `parents.get`) require a `parentId`. Use the `parents.list` method to retrieve the ID for a parent.
"id": "A String", # The ID of the parent.
"isRoot": True or False, # Output only. Whether or not the parent is the root folder.
"kind": "drive#parentReference", # Output only. This is always `drive#parentReference`.
"parentLink": "A String", # Output only. A link to the parent.
"selfLink": "A String", # Output only. A link back to this reference.
},
],
"permissionIds": [ # Output only. List of permission IDs for users with access to this file.
"A String",
],
"permissions": [ # Output only. The list of permissions for users with access to this 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. 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.
"additionalRoles": [ # Additional roles for this user. Only `commenter` is currently allowed, though more may be supported in the future.
"A String",
],
"authKey": "A String", # Output only. Deprecated.
"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.
"domain": "A String", # Output only. The domain name of the entity this permission refers to. This is an output-only field which is present when the permission type is `user`, `group` or `domain`.
"emailAddress": "A String", # Output only. The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is `user` or `group`.
"etag": "A String", # Output only. The ETag of the permission.
"expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: - They can only be set on user and group permissions - The date must be in the future - The date cannot be more than a year in the future - The date can only be set on drive.permissions.update or drive.permissions.patch requests
"id": "A String", # The ID of the user this permission refers to, and identical to the `permissionId` in the About and Files resources. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored.
"kind": "drive#permission", # Output only. This is always `drive#permission`.
"name": "A String", # Output only. The name for this 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.
{
"additionalRoles": [ # Output only. Additional roles for this user. Only `commenter` is currently possible, though more may be supported in the future.
"A String",
],
"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` * `reader`
},
],
"photoLink": "A String", # Output only. A link to the profile photo, if available.
"role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: * `owner` * `organizer` * `fileOrganizer` * `writer` * `reader`
"selfLink": "A String", # Output only. A link back to this permission.
"teamDrivePermissionDetails": [ # Output only. Deprecated: Use `permissionDetails` instead.
{
"additionalRoles": [ # Output only. Deprecated: Use `permissionDetails/additionalRoles` instead.
"A String",
],
"inherited": True or False, # Output only. Deprecated: Use `permissionDetails/inherited` instead.
"inheritedFrom": "A String", # Output only. Deprecated: Use `permissionDetails/inheritedFrom` instead.
"role": "A String", # Output only. Deprecated: Use `permissionDetails/role` instead.
"teamDrivePermissionType": "A String", # Output only. Deprecated: Use `permissionDetails/permissionType` instead.
},
],
"type": "A String", # The account type. Allowed values are: * `user` * `group` * `domain` * `anyone`
"value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored.
"view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. `published` is the only supported value.
"withLink": True or False, # Whether the link is required for this permission.
},
],
"properties": [ # The list of properties.
{ # A key-value pair attached to a file that is either public or private to an application. The following limits apply to file properties: * Maximum of 100 properties total per file * Maximum of 30 private properties per app * Maximum of 30 public properties * Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property Some resource methods (such as `properties.update`) require a `propertyKey`. Use the `properties.list` method to retrieve the key for a property.
"etag": "A String", # Output only. ETag of the property.
"key": "A String", # The key of this property.
"kind": "drive#property", # Output only. This is always `drive#property`.
"selfLink": "A String", # Output only. The link back to this property.
"value": "A String", # The value of this property.
"visibility": "A String", # The visibility of this property. Allowed values are PRIVATE (default) and PUBLIC. Private 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.
},
],
"quotaBytesUsed": "A String", # Output only. The number of quota bytes used by this file.
"resourceKey": "A String", # Output only. A key needed to access the item via a shared link.
"selfLink": "A String", # Output only. A link back to this file.
"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.
"shareable": True or False, # Output only. Deprecated: Use `capabilities/canShare` instead.
"shared": True or False, # Output only. Whether the file has been shared. Not populated for items in shared drives.
"sharedWithMeDate": "A String", # Time at which this file was shared with the user (formatted RFC 3339 timestamp).
"sharingUser": { # Information about a Drive user. # Output only. User that shared the item with the current user, if available.
"displayName": "A String", # Output only. A plain text displayable name for this user.
"emailAddress": "A String", # Output only. The email address of the user.
"isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made.
"kind": "drive#user", # Output only. This is always `drive#user`.
"permissionId": "A String", # Output only. The user's ID as visible in the permissions collection.
"picture": { # Output only. The user's profile picture.
"url": "A String", # Output Only. A URL that points to a profile picture of this user.
},
},
"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.insert` requests.
"targetId": "A String", # The ID of the file that this shortcut points to. Can only be set on `files.insert` 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.
},
"spaces": [ # Output only. The list of spaces which contain the file. Supported values are `drive`, `appDataFolder` and `photos`.
"A String",
],
"teamDriveId": "A String", # Output only. Deprecated: Use `driveId` instead.
"thumbnail": { # A thumbnail for the file. This will only be used if a standard thumbnail cannot be generated.
"image": "A String", # The URL-safe Base64 encoded bytes of the thumbnail image. It should conform to RFC 4648 section 5.
"mimeType": "A String", # The MIME type of the thumbnail.
},
"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), 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.
"title": "A String", # The title of this file. Note that for immutable items such as the top level folders of shared drives, My Drive root folder, and Application Data folder the title is constant.
"trashedDate": "A String", # The time that the item was trashed (formatted RFC 3339 timestamp). 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.
"isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made.
"kind": "drive#user", # Output only. This is always `drive#user`.
"permissionId": "A String", # Output only. The user's ID as visible in the permissions collection.
"picture": { # Output only. The user's profile picture.
"url": "A String", # Output Only. A URL that points to a profile picture of this user.
},
},
"userPermission": { # A permission for a file. A permission grants a user, group, domain, or the world access to a file or a folder hierarchy. 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. # Output only. The permissions for the authenticated user on this file.
"additionalRoles": [ # Additional roles for this user. Only `commenter` is currently allowed, though more may be supported in the future.
"A String",
],
"authKey": "A String", # Output only. Deprecated.
"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.
"domain": "A String", # Output only. The domain name of the entity this permission refers to. This is an output-only field which is present when the permission type is `user`, `group` or `domain`.
"emailAddress": "A String", # Output only. The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is `user` or `group`.
"etag": "A String", # Output only. The ETag of the permission.
"expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: - They can only be set on user and group permissions - The date must be in the future - The date cannot be more than a year in the future - The date can only be set on drive.permissions.update or drive.permissions.patch requests
"id": "A String", # The ID of the user this permission refers to, and identical to the `permissionId` in the About and Files resources. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored.
"kind": "drive#permission", # Output only. This is always `drive#permission`.
"name": "A String", # Output only. The name for this 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.
{
"additionalRoles": [ # Output only. Additional roles for this user. Only `commenter` is currently possible, though more may be supported in the future.
"A String",
],
"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` * `reader`
},
],
"photoLink": "A String", # Output only. A link to the profile photo, if available.
"role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: * `owner` * `organizer` * `fileOrganizer` * `writer` * `reader`
"selfLink": "A String", # Output only. A link back to this permission.
"teamDrivePermissionDetails": [ # Output only. Deprecated: Use `permissionDetails` instead.
{
"additionalRoles": [ # Output only. Deprecated: Use `permissionDetails/additionalRoles` instead.
"A String",
],
"inherited": True or False, # Output only. Deprecated: Use `permissionDetails/inherited` instead.
"inheritedFrom": "A String", # Output only. Deprecated: Use `permissionDetails/inheritedFrom` instead.
"role": "A String", # Output only. Deprecated: Use `permissionDetails/role` instead.
"teamDrivePermissionType": "A String", # Output only. Deprecated: Use `permissionDetails/permissionType` instead.
},
],
"type": "A String", # The account type. Allowed values are: * `user` * `group` * `domain` * `anyone`
"value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored.
"view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. `published` is the only supported value.
"withLink": True or False, # Whether the link is required for this permission.
},
"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 requesting user.
"videoMediaMetadata": { # Output only. Metadata about video media. This will only be present for video types.
"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.
},
"webContentLink": "A String", # Output only. A link for downloading the content of the file in a browser using cookie based authentication. In cases where the content is shared publicly, the content can be downloaded without any credentials.
"webViewLink": "A String", # Output only. A link only available on public folders for viewing their static web assets (HTML, CSS, JS, etc) via Google Drive's Website Hosting.
"writersCanShare": True or False, # Whether writers can share the document with other users. Not populated for items in shared drives.
}
convert: boolean, Whether to convert this file to the corresponding Docs Editors format.
enforceSingleParent: boolean, Deprecated: Copying files into 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.
ocr: boolean, Whether to attempt OCR on .jpg, .png, .gif, or .pdf uploads.
ocrLanguage: string, If `ocr` is true, hints at the language to use. Valid values are BCP 47 codes.
pinned: boolean, Whether to pin the head revision of the new copy. A file can have a maximum of 200 pinned revisions.
supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives.
supportsTeamDrives: boolean, Deprecated: Use `supportsAllDrives` instead.
timedTextLanguage: string, The language of the timed text.
timedTextTrackName: string, The timed text track name.
visibility: string, The visibility of the new file. This parameter is only relevant when the source is not a native Google Doc and convert=false.
Allowed values
DEFAULT - The visibility of the new file is determined by the user's default visibility/sharing policies.
PRIVATE - The new file will be visible to only the owner.
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.
"alternateLink": "A String", # Output only. A link for opening the file in a relevant Google editor or viewer.
"appDataContents": True or False, # Output only. Whether this file is in the Application Data folder.
"canComment": True or False, # Output only. Deprecated: Use `capabilities/canComment` instead.
"canReadRevisions": True or False, # Output only. Deprecated: Use `capabilities/canReadRevisions` instead.
"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.
"canChangeRestrictedDownload": True or False, # Output only. Deprecated.
"canChangeSecurityUpdateEnabled": True or False, # Output only. Whether the current user can change the securityUpdateEnabled field on link share metadata.
"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, # Output only. Deprecated: 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, # Output only. Deprecated: Use `canMoveChildrenWithinDrive` instead.
"canMoveItemIntoTeamDrive": True or False, # Output only. Deprecated: 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, # Output only. Deprecated: 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, # Output only. Deprecated: Use `canMoveItemWithinDrive` instead.
"canMoveTeamDriveItem": True or False, # Output only. Deprecated: 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, # Output only. Deprecated: 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.
},
"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.
"isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made.
"kind": "drive#user", # Output only. This is always `drive#user`.
"permissionId": "A String", # Output only. The user's ID as visible in the permissions collection.
"picture": { # Output only. The user's profile picture.
"url": "A String", # Output Only. A URL that points to a profile picture of this user.
},
},
"restrictionDate": "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.
"copyable": True or False, # Output only. Deprecated: Use `capabilities/canCopy` instead.
"createdDate": "A String", # Create time for this file (formatted RFC 3339 timestamp).
"defaultOpenWithLink": "A String", # Output only. A link to open this file with the user's default app for this file. Only populated when the drive.apps.readonly scope is used.
"description": "A String", # A short description of the file.
"downloadUrl": "A String", # Output only. Short lived download URL for the file. This field is only populated for files with content stored in Google Drive; it is not populated for Google Docs or shortcut files.
"driveId": "A String", # Output only. ID of the shared drive the file resides in. Only populated for items in shared drives.
"editable": True or False, # Output only. Deprecated: Use `capabilities/canEdit` instead.
"embedLink": "A String", # Output only. A link for embedding the file.
"etag": "A String", # Output only. ETag of the file.
"explicitlyTrashed": True or False, # Output only. Whether this file has been explicitly trashed, as opposed to recursively trashed.
"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` with trailing text that does not appear to be part of the extension removed. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.
"fileSize": "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.
"folderColorRgb": "A String", # Folder color as an RGB hex string if the file is a folder or a shortcut to a folder. The list of supported colors is available in the folderColorPalette field of the About resource. If an unsupported color is specified, it will be changed to the closest color in the palette.
"fullFileExtension": "A String", # Output only. The full file extension; extracted from the title. May contain multiple concatenated extensions, such as "tar.gz". Removing an extension from the title does not clear this field; however, changing the extension on the title does update this field. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.
"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 field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.
"iconLink": "A String", # Output only. A link to the file's icon.
"id": "A String", # The ID of the file.
"imageMediaMetadata": { # Output only. Metadata about image media. This will only be present for image types, and its contents will depend on what can be parsed from the image content.
"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.
"date": "A String", # Output only. The date and time the photo was taken (EXIF format timestamp).
"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.
"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.
},
"indexableText": { # Indexable text attributes for the file (can only be written)
"text": "A String", # The text to be indexed for this file.
},
"isAppAuthorized": True or False, # Output only. Whether the file was created or opened by the requesting app.
"kind": "drive#file", # Output only. The type of file. This is always `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 a 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": "drive#labelField", # 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.
"isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made.
"kind": "drive#user", # Output only. This is always `drive#user`.
"permissionId": "A String", # Output only. The user's ID as visible in the permissions collection.
"picture": { # Output only. The user's profile picture.
"url": "A String", # Output Only. A URL that points to a profile picture of this user.
},
},
],
"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": "drive#label", # This is always `drive#label`
"revisionId": "A String", # The revision ID of the label.
},
],
},
"labels": { # A group of labels for the file.
"hidden": True or False, # Output only. Deprecated.
"modified": True or False, # Output only. Whether the file has been modified by this user.
"restricted": True or False, # Output only. Deprecated: Use `copyRequiresWriterPermission` instead.
"starred": True or False, # Whether this file is starred by the user.
"trashed": True or False, # Whether this file has been trashed. This label applies to all users accessing the file; however, only owners are allowed to see and untrash files.
"viewed": True or False, # Whether this file has been viewed by this user.
},
"lastModifyingUser": { # Information about a Drive user. # Output only. The last user to modify this 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.
"isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made.
"kind": "drive#user", # Output only. This is always `drive#user`.
"permissionId": "A String", # Output only. The user's ID as visible in the permissions collection.
"picture": { # Output only. The user's profile picture.
"url": "A String", # Output Only. A URL that points to a profile picture of this user.
},
},
"lastModifyingUserName": "A String", # Output only. Name of the last user to modify this file.
"lastViewedByMeDate": "A String", # Last time this file was viewed by the user (formatted RFC 3339 timestamp).
"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.
},
"markedViewedByMeDate": "A String", # Deprecated.
"md5Checksum": "A String", # Output only. An MD5 checksum for the content of this file. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.
"mimeType": "A String", # The MIME type of the file. This is only mutable on update when uploading new content. This field can be left blank, and the mimetype will be determined from the uploaded content's MIME type.
"modifiedByMeDate": "A String", # Last time this file was modified by the user (formatted RFC 3339 timestamp). Note that setting modifiedDate will also update the modifiedByMe date for the user which set the date.
"modifiedDate": "A String", # Last time this file was modified by anyone (formatted RFC 3339 timestamp). This is only mutable on update when the setModifiedDate parameter is set.
"openWithLinks": { # Output only. A map of the id of each of the user's apps to a link to open this file with that app. Only populated when the drive.apps.readonly scope is used.
"a_key": "A String",
},
"originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the `title` field. This is only available for files with binary content in Google Drive.
"ownedByMe": True or False, # Output only. Whether the file is owned by the current user. Not populated for items in shared drives.
"ownerNames": [ # Output only. Name(s) of the owner(s) of this file. Not populated for items in shared drives.
"A String",
],
"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.
"isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made.
"kind": "drive#user", # Output only. This is always `drive#user`.
"permissionId": "A String", # Output only. The user's ID as visible in the permissions collection.
"picture": { # Output only. The user's profile picture.
"url": "A String", # Output Only. A URL that points to a profile picture of this user.
},
},
],
"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 an insert 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 reference to a file's parent. A file can only have one parent folder; specifying multiple parents isn't supported. Some resource methods (such as `parents.get`) require a `parentId`. Use the `parents.list` method to retrieve the ID for a parent.
"id": "A String", # The ID of the parent.
"isRoot": True or False, # Output only. Whether or not the parent is the root folder.
"kind": "drive#parentReference", # Output only. This is always `drive#parentReference`.
"parentLink": "A String", # Output only. A link to the parent.
"selfLink": "A String", # Output only. A link back to this reference.
},
],
"permissionIds": [ # Output only. List of permission IDs for users with access to this file.
"A String",
],
"permissions": [ # Output only. The list of permissions for users with access to this 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. 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.
"additionalRoles": [ # Additional roles for this user. Only `commenter` is currently allowed, though more may be supported in the future.
"A String",
],
"authKey": "A String", # Output only. Deprecated.
"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.
"domain": "A String", # Output only. The domain name of the entity this permission refers to. This is an output-only field which is present when the permission type is `user`, `group` or `domain`.
"emailAddress": "A String", # Output only. The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is `user` or `group`.
"etag": "A String", # Output only. The ETag of the permission.
"expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: - They can only be set on user and group permissions - The date must be in the future - The date cannot be more than a year in the future - The date can only be set on drive.permissions.update or drive.permissions.patch requests
"id": "A String", # The ID of the user this permission refers to, and identical to the `permissionId` in the About and Files resources. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored.
"kind": "drive#permission", # Output only. This is always `drive#permission`.
"name": "A String", # Output only. The name for this 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.
{
"additionalRoles": [ # Output only. Additional roles for this user. Only `commenter` is currently possible, though more may be supported in the future.
"A String",
],
"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` * `reader`
},
],
"photoLink": "A String", # Output only. A link to the profile photo, if available.
"role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: * `owner` * `organizer` * `fileOrganizer` * `writer` * `reader`
"selfLink": "A String", # Output only. A link back to this permission.
"teamDrivePermissionDetails": [ # Output only. Deprecated: Use `permissionDetails` instead.
{
"additionalRoles": [ # Output only. Deprecated: Use `permissionDetails/additionalRoles` instead.
"A String",
],
"inherited": True or False, # Output only. Deprecated: Use `permissionDetails/inherited` instead.
"inheritedFrom": "A String", # Output only. Deprecated: Use `permissionDetails/inheritedFrom` instead.
"role": "A String", # Output only. Deprecated: Use `permissionDetails/role` instead.
"teamDrivePermissionType": "A String", # Output only. Deprecated: Use `permissionDetails/permissionType` instead.
},
],
"type": "A String", # The account type. Allowed values are: * `user` * `group` * `domain` * `anyone`
"value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored.
"view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. `published` is the only supported value.
"withLink": True or False, # Whether the link is required for this permission.
},
],
"properties": [ # The list of properties.
{ # A key-value pair attached to a file that is either public or private to an application. The following limits apply to file properties: * Maximum of 100 properties total per file * Maximum of 30 private properties per app * Maximum of 30 public properties * Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property Some resource methods (such as `properties.update`) require a `propertyKey`. Use the `properties.list` method to retrieve the key for a property.
"etag": "A String", # Output only. ETag of the property.
"key": "A String", # The key of this property.
"kind": "drive#property", # Output only. This is always `drive#property`.
"selfLink": "A String", # Output only. The link back to this property.
"value": "A String", # The value of this property.
"visibility": "A String", # The visibility of this property. Allowed values are PRIVATE (default) and PUBLIC. Private 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.
},
],
"quotaBytesUsed": "A String", # Output only. The number of quota bytes used by this file.
"resourceKey": "A String", # Output only. A key needed to access the item via a shared link.
"selfLink": "A String", # Output only. A link back to this file.
"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.
"shareable": True or False, # Output only. Deprecated: Use `capabilities/canShare` instead.
"shared": True or False, # Output only. Whether the file has been shared. Not populated for items in shared drives.
"sharedWithMeDate": "A String", # Time at which this file was shared with the user (formatted RFC 3339 timestamp).
"sharingUser": { # Information about a Drive user. # Output only. User that shared the item with the current user, if available.
"displayName": "A String", # Output only. A plain text displayable name for this user.
"emailAddress": "A String", # Output only. The email address of the user.
"isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made.
"kind": "drive#user", # Output only. This is always `drive#user`.
"permissionId": "A String", # Output only. The user's ID as visible in the permissions collection.
"picture": { # Output only. The user's profile picture.
"url": "A String", # Output Only. A URL that points to a profile picture of this user.
},
},
"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.insert` requests.
"targetId": "A String", # The ID of the file that this shortcut points to. Can only be set on `files.insert` 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.
},
"spaces": [ # Output only. The list of spaces which contain the file. Supported values are `drive`, `appDataFolder` and `photos`.
"A String",
],
"teamDriveId": "A String", # Output only. Deprecated: Use `driveId` instead.
"thumbnail": { # A thumbnail for the file. This will only be used if a standard thumbnail cannot be generated.
"image": "A String", # The URL-safe Base64 encoded bytes of the thumbnail image. It should conform to RFC 4648 section 5.
"mimeType": "A String", # The MIME type of the thumbnail.
},
"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), 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.
"title": "A String", # The title of this file. Note that for immutable items such as the top level folders of shared drives, My Drive root folder, and Application Data folder the title is constant.
"trashedDate": "A String", # The time that the item was trashed (formatted RFC 3339 timestamp). 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.
"isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made.
"kind": "drive#user", # Output only. This is always `drive#user`.
"permissionId": "A String", # Output only. The user's ID as visible in the permissions collection.
"picture": { # Output only. The user's profile picture.
"url": "A String", # Output Only. A URL that points to a profile picture of this user.
},
},
"userPermission": { # A permission for a file. A permission grants a user, group, domain, or the world access to a file or a folder hierarchy. 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. # Output only. The permissions for the authenticated user on this file.
"additionalRoles": [ # Additional roles for this user. Only `commenter` is currently allowed, though more may be supported in the future.
"A String",
],
"authKey": "A String", # Output only. Deprecated.
"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.
"domain": "A String", # Output only. The domain name of the entity this permission refers to. This is an output-only field which is present when the permission type is `user`, `group` or `domain`.
"emailAddress": "A String", # Output only. The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is `user` or `group`.
"etag": "A String", # Output only. The ETag of the permission.
"expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: - They can only be set on user and group permissions - The date must be in the future - The date cannot be more than a year in the future - The date can only be set on drive.permissions.update or drive.permissions.patch requests
"id": "A String", # The ID of the user this permission refers to, and identical to the `permissionId` in the About and Files resources. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored.
"kind": "drive#permission", # Output only. This is always `drive#permission`.
"name": "A String", # Output only. The name for this 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.
{
"additionalRoles": [ # Output only. Additional roles for this user. Only `commenter` is currently possible, though more may be supported in the future.
"A String",
],
"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` * `reader`
},
],
"photoLink": "A String", # Output only. A link to the profile photo, if available.
"role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: * `owner` * `organizer` * `fileOrganizer` * `writer` * `reader`
"selfLink": "A String", # Output only. A link back to this permission.
"teamDrivePermissionDetails": [ # Output only. Deprecated: Use `permissionDetails` instead.
{
"additionalRoles": [ # Output only. Deprecated: Use `permissionDetails/additionalRoles` instead.
"A String",
],
"inherited": True or False, # Output only. Deprecated: Use `permissionDetails/inherited` instead.
"inheritedFrom": "A String", # Output only. Deprecated: Use `permissionDetails/inheritedFrom` instead.
"role": "A String", # Output only. Deprecated: Use `permissionDetails/role` instead.
"teamDrivePermissionType": "A String", # Output only. Deprecated: Use `permissionDetails/permissionType` instead.
},
],
"type": "A String", # The account type. Allowed values are: * `user` * `group` * `domain` * `anyone`
"value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored.
"view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. `published` is the only supported value.
"withLink": True or False, # Whether the link is required for this permission.
},
"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 requesting user.
"videoMediaMetadata": { # Output only. Metadata about video media. This will only be present for video types.
"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.
},
"webContentLink": "A String", # Output only. A link for downloading the content of the file in a browser using cookie based authentication. In cases where the content is shared publicly, the content can be downloaded without any credentials.
"webViewLink": "A String", # Output only. A link only available on public folders for viewing their static web assets (HTML, CSS, JS, etc) via Google Drive's Website Hosting.
"writersCanShare": True or False, # Whether writers can share the document with other users. 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 to delete. (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 is 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
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 is 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(maxResults=None, space=None, type=None, x__xgafv=None)
Generates a set of file IDs which can be provided in insert or copy requests.
Args:
maxResults: integer, Maximum 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 IDs which can be provided in insert requests
"ids": [ # The IDs generated for the requesting user in the specified space.
"A String",
],
"kind": "drive#generatedIds", # This is always `drive#generatedIds`
"space": "A String", # The type of file that can be created with these IDs.
}
get(fileId, acknowledgeAbuse=None, includeLabels=None, includePermissionsForView=None, projection=None, revisionId=None, supportsAllDrives=None, supportsTeamDrives=None, updateViewedDate=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/v2/files/export) instead. For more information, see [Download & export files](/drive/api/guides/manage-downloads).
Args:
fileId: string, The ID for the file in question. (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.
projection: string, Deprecated: This parameter has no function.
Allowed values
BASIC - Deprecated.
FULL - Deprecated.
revisionId: string, Specifies the Revision ID that should be downloaded. Ignored unless alt=media is specified.
supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives.
supportsTeamDrives: boolean, Deprecated: Use `supportsAllDrives` instead.
updateViewedDate: boolean, Deprecated: Use `files.update` with `modifiedDateBehavior=noChange, updateViewedDate=true` and an empty request body.
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.
"alternateLink": "A String", # Output only. A link for opening the file in a relevant Google editor or viewer.
"appDataContents": True or False, # Output only. Whether this file is in the Application Data folder.
"canComment": True or False, # Output only. Deprecated: Use `capabilities/canComment` instead.
"canReadRevisions": True or False, # Output only. Deprecated: Use `capabilities/canReadRevisions` instead.
"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.
"canChangeRestrictedDownload": True or False, # Output only. Deprecated.
"canChangeSecurityUpdateEnabled": True or False, # Output only. Whether the current user can change the securityUpdateEnabled field on link share metadata.
"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, # Output only. Deprecated: 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, # Output only. Deprecated: Use `canMoveChildrenWithinDrive` instead.
"canMoveItemIntoTeamDrive": True or False, # Output only. Deprecated: 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, # Output only. Deprecated: 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, # Output only. Deprecated: Use `canMoveItemWithinDrive` instead.
"canMoveTeamDriveItem": True or False, # Output only. Deprecated: 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, # Output only. Deprecated: 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.
},
"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.
"isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made.
"kind": "drive#user", # Output only. This is always `drive#user`.
"permissionId": "A String", # Output only. The user's ID as visible in the permissions collection.
"picture": { # Output only. The user's profile picture.
"url": "A String", # Output Only. A URL that points to a profile picture of this user.
},
},
"restrictionDate": "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.
"copyable": True or False, # Output only. Deprecated: Use `capabilities/canCopy` instead.
"createdDate": "A String", # Create time for this file (formatted RFC 3339 timestamp).
"defaultOpenWithLink": "A String", # Output only. A link to open this file with the user's default app for this file. Only populated when the drive.apps.readonly scope is used.
"description": "A String", # A short description of the file.
"downloadUrl": "A String", # Output only. Short lived download URL for the file. This field is only populated for files with content stored in Google Drive; it is not populated for Google Docs or shortcut files.
"driveId": "A String", # Output only. ID of the shared drive the file resides in. Only populated for items in shared drives.
"editable": True or False, # Output only. Deprecated: Use `capabilities/canEdit` instead.
"embedLink": "A String", # Output only. A link for embedding the file.
"etag": "A String", # Output only. ETag of the file.
"explicitlyTrashed": True or False, # Output only. Whether this file has been explicitly trashed, as opposed to recursively trashed.
"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` with trailing text that does not appear to be part of the extension removed. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.
"fileSize": "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.
"folderColorRgb": "A String", # Folder color as an RGB hex string if the file is a folder or a shortcut to a folder. The list of supported colors is available in the folderColorPalette field of the About resource. If an unsupported color is specified, it will be changed to the closest color in the palette.
"fullFileExtension": "A String", # Output only. The full file extension; extracted from the title. May contain multiple concatenated extensions, such as "tar.gz". Removing an extension from the title does not clear this field; however, changing the extension on the title does update this field. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.
"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 field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.
"iconLink": "A String", # Output only. A link to the file's icon.
"id": "A String", # The ID of the file.
"imageMediaMetadata": { # Output only. Metadata about image media. This will only be present for image types, and its contents will depend on what can be parsed from the image content.
"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.
"date": "A String", # Output only. The date and time the photo was taken (EXIF format timestamp).
"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.
"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.
},
"indexableText": { # Indexable text attributes for the file (can only be written)
"text": "A String", # The text to be indexed for this file.
},
"isAppAuthorized": True or False, # Output only. Whether the file was created or opened by the requesting app.
"kind": "drive#file", # Output only. The type of file. This is always `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 a 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": "drive#labelField", # 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.
"isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made.
"kind": "drive#user", # Output only. This is always `drive#user`.
"permissionId": "A String", # Output only. The user's ID as visible in the permissions collection.
"picture": { # Output only. The user's profile picture.
"url": "A String", # Output Only. A URL that points to a profile picture of this user.
},
},
],
"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": "drive#label", # This is always `drive#label`
"revisionId": "A String", # The revision ID of the label.
},
],
},
"labels": { # A group of labels for the file.
"hidden": True or False, # Output only. Deprecated.
"modified": True or False, # Output only. Whether the file has been modified by this user.
"restricted": True or False, # Output only. Deprecated: Use `copyRequiresWriterPermission` instead.
"starred": True or False, # Whether this file is starred by the user.
"trashed": True or False, # Whether this file has been trashed. This label applies to all users accessing the file; however, only owners are allowed to see and untrash files.
"viewed": True or False, # Whether this file has been viewed by this user.
},
"lastModifyingUser": { # Information about a Drive user. # Output only. The last user to modify this 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.
"isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made.
"kind": "drive#user", # Output only. This is always `drive#user`.
"permissionId": "A String", # Output only. The user's ID as visible in the permissions collection.
"picture": { # Output only. The user's profile picture.
"url": "A String", # Output Only. A URL that points to a profile picture of this user.
},
},
"lastModifyingUserName": "A String", # Output only. Name of the last user to modify this file.
"lastViewedByMeDate": "A String", # Last time this file was viewed by the user (formatted RFC 3339 timestamp).
"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.
},
"markedViewedByMeDate": "A String", # Deprecated.
"md5Checksum": "A String", # Output only. An MD5 checksum for the content of this file. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.
"mimeType": "A String", # The MIME type of the file. This is only mutable on update when uploading new content. This field can be left blank, and the mimetype will be determined from the uploaded content's MIME type.
"modifiedByMeDate": "A String", # Last time this file was modified by the user (formatted RFC 3339 timestamp). Note that setting modifiedDate will also update the modifiedByMe date for the user which set the date.
"modifiedDate": "A String", # Last time this file was modified by anyone (formatted RFC 3339 timestamp). This is only mutable on update when the setModifiedDate parameter is set.
"openWithLinks": { # Output only. A map of the id of each of the user's apps to a link to open this file with that app. Only populated when the drive.apps.readonly scope is used.
"a_key": "A String",
},
"originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the `title` field. This is only available for files with binary content in Google Drive.
"ownedByMe": True or False, # Output only. Whether the file is owned by the current user. Not populated for items in shared drives.
"ownerNames": [ # Output only. Name(s) of the owner(s) of this file. Not populated for items in shared drives.
"A String",
],
"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.
"isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made.
"kind": "drive#user", # Output only. This is always `drive#user`.
"permissionId": "A String", # Output only. The user's ID as visible in the permissions collection.
"picture": { # Output only. The user's profile picture.
"url": "A String", # Output Only. A URL that points to a profile picture of this user.
},
},
],
"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 an insert 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 reference to a file's parent. A file can only have one parent folder; specifying multiple parents isn't supported. Some resource methods (such as `parents.get`) require a `parentId`. Use the `parents.list` method to retrieve the ID for a parent.
"id": "A String", # The ID of the parent.
"isRoot": True or False, # Output only. Whether or not the parent is the root folder.
"kind": "drive#parentReference", # Output only. This is always `drive#parentReference`.
"parentLink": "A String", # Output only. A link to the parent.
"selfLink": "A String", # Output only. A link back to this reference.
},
],
"permissionIds": [ # Output only. List of permission IDs for users with access to this file.
"A String",
],
"permissions": [ # Output only. The list of permissions for users with access to this 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. 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.
"additionalRoles": [ # Additional roles for this user. Only `commenter` is currently allowed, though more may be supported in the future.
"A String",
],
"authKey": "A String", # Output only. Deprecated.
"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.
"domain": "A String", # Output only. The domain name of the entity this permission refers to. This is an output-only field which is present when the permission type is `user`, `group` or `domain`.
"emailAddress": "A String", # Output only. The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is `user` or `group`.
"etag": "A String", # Output only. The ETag of the permission.
"expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: - They can only be set on user and group permissions - The date must be in the future - The date cannot be more than a year in the future - The date can only be set on drive.permissions.update or drive.permissions.patch requests
"id": "A String", # The ID of the user this permission refers to, and identical to the `permissionId` in the About and Files resources. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored.
"kind": "drive#permission", # Output only. This is always `drive#permission`.
"name": "A String", # Output only. The name for this 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.
{
"additionalRoles": [ # Output only. Additional roles for this user. Only `commenter` is currently possible, though more may be supported in the future.
"A String",
],
"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` * `reader`
},
],
"photoLink": "A String", # Output only. A link to the profile photo, if available.
"role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: * `owner` * `organizer` * `fileOrganizer` * `writer` * `reader`
"selfLink": "A String", # Output only. A link back to this permission.
"teamDrivePermissionDetails": [ # Output only. Deprecated: Use `permissionDetails` instead.
{
"additionalRoles": [ # Output only. Deprecated: Use `permissionDetails/additionalRoles` instead.
"A String",
],
"inherited": True or False, # Output only. Deprecated: Use `permissionDetails/inherited` instead.
"inheritedFrom": "A String", # Output only. Deprecated: Use `permissionDetails/inheritedFrom` instead.
"role": "A String", # Output only. Deprecated: Use `permissionDetails/role` instead.
"teamDrivePermissionType": "A String", # Output only. Deprecated: Use `permissionDetails/permissionType` instead.
},
],
"type": "A String", # The account type. Allowed values are: * `user` * `group` * `domain` * `anyone`
"value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored.
"view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. `published` is the only supported value.
"withLink": True or False, # Whether the link is required for this permission.
},
],
"properties": [ # The list of properties.
{ # A key-value pair attached to a file that is either public or private to an application. The following limits apply to file properties: * Maximum of 100 properties total per file * Maximum of 30 private properties per app * Maximum of 30 public properties * Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property Some resource methods (such as `properties.update`) require a `propertyKey`. Use the `properties.list` method to retrieve the key for a property.
"etag": "A String", # Output only. ETag of the property.
"key": "A String", # The key of this property.
"kind": "drive#property", # Output only. This is always `drive#property`.
"selfLink": "A String", # Output only. The link back to this property.
"value": "A String", # The value of this property.
"visibility": "A String", # The visibility of this property. Allowed values are PRIVATE (default) and PUBLIC. Private 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.
},
],
"quotaBytesUsed": "A String", # Output only. The number of quota bytes used by this file.
"resourceKey": "A String", # Output only. A key needed to access the item via a shared link.
"selfLink": "A String", # Output only. A link back to this file.
"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.
"shareable": True or False, # Output only. Deprecated: Use `capabilities/canShare` instead.
"shared": True or False, # Output only. Whether the file has been shared. Not populated for items in shared drives.
"sharedWithMeDate": "A String", # Time at which this file was shared with the user (formatted RFC 3339 timestamp).
"sharingUser": { # Information about a Drive user. # Output only. User that shared the item with the current user, if available.
"displayName": "A String", # Output only. A plain text displayable name for this user.
"emailAddress": "A String", # Output only. The email address of the user.
"isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made.
"kind": "drive#user", # Output only. This is always `drive#user`.
"permissionId": "A String", # Output only. The user's ID as visible in the permissions collection.
"picture": { # Output only. The user's profile picture.
"url": "A String", # Output Only. A URL that points to a profile picture of this user.
},
},
"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.insert` requests.
"targetId": "A String", # The ID of the file that this shortcut points to. Can only be set on `files.insert` 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.
},
"spaces": [ # Output only. The list of spaces which contain the file. Supported values are `drive`, `appDataFolder` and `photos`.
"A String",
],
"teamDriveId": "A String", # Output only. Deprecated: Use `driveId` instead.
"thumbnail": { # A thumbnail for the file. This will only be used if a standard thumbnail cannot be generated.
"image": "A String", # The URL-safe Base64 encoded bytes of the thumbnail image. It should conform to RFC 4648 section 5.
"mimeType": "A String", # The MIME type of the thumbnail.
},
"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), 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.
"title": "A String", # The title of this file. Note that for immutable items such as the top level folders of shared drives, My Drive root folder, and Application Data folder the title is constant.
"trashedDate": "A String", # The time that the item was trashed (formatted RFC 3339 timestamp). 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.
"isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made.
"kind": "drive#user", # Output only. This is always `drive#user`.
"permissionId": "A String", # Output only. The user's ID as visible in the permissions collection.
"picture": { # Output only. The user's profile picture.
"url": "A String", # Output Only. A URL that points to a profile picture of this user.
},
},
"userPermission": { # A permission for a file. A permission grants a user, group, domain, or the world access to a file or a folder hierarchy. 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. # Output only. The permissions for the authenticated user on this file.
"additionalRoles": [ # Additional roles for this user. Only `commenter` is currently allowed, though more may be supported in the future.
"A String",
],
"authKey": "A String", # Output only. Deprecated.
"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.
"domain": "A String", # Output only. The domain name of the entity this permission refers to. This is an output-only field which is present when the permission type is `user`, `group` or `domain`.
"emailAddress": "A String", # Output only. The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is `user` or `group`.
"etag": "A String", # Output only. The ETag of the permission.
"expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: - They can only be set on user and group permissions - The date must be in the future - The date cannot be more than a year in the future - The date can only be set on drive.permissions.update or drive.permissions.patch requests
"id": "A String", # The ID of the user this permission refers to, and identical to the `permissionId` in the About and Files resources. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored.
"kind": "drive#permission", # Output only. This is always `drive#permission`.
"name": "A String", # Output only. The name for this 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.
{
"additionalRoles": [ # Output only. Additional roles for this user. Only `commenter` is currently possible, though more may be supported in the future.
"A String",
],
"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` * `reader`
},
],
"photoLink": "A String", # Output only. A link to the profile photo, if available.
"role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: * `owner` * `organizer` * `fileOrganizer` * `writer` * `reader`
"selfLink": "A String", # Output only. A link back to this permission.
"teamDrivePermissionDetails": [ # Output only. Deprecated: Use `permissionDetails` instead.
{
"additionalRoles": [ # Output only. Deprecated: Use `permissionDetails/additionalRoles` instead.
"A String",
],
"inherited": True or False, # Output only. Deprecated: Use `permissionDetails/inherited` instead.
"inheritedFrom": "A String", # Output only. Deprecated: Use `permissionDetails/inheritedFrom` instead.
"role": "A String", # Output only. Deprecated: Use `permissionDetails/role` instead.
"teamDrivePermissionType": "A String", # Output only. Deprecated: Use `permissionDetails/permissionType` instead.
},
],
"type": "A String", # The account type. Allowed values are: * `user` * `group` * `domain` * `anyone`
"value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored.
"view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. `published` is the only supported value.
"withLink": True or False, # Whether the link is required for this permission.
},
"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 requesting user.
"videoMediaMetadata": { # Output only. Metadata about video media. This will only be present for video types.
"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.
},
"webContentLink": "A String", # Output only. A link for downloading the content of the file in a browser using cookie based authentication. In cases where the content is shared publicly, the content can be downloaded without any credentials.
"webViewLink": "A String", # Output only. A link only available on public folders for viewing their static web assets (HTML, CSS, JS, etc) via Google Drive's Website Hosting.
"writersCanShare": True or False, # Whether writers can share the document with other users. Not populated for items in shared drives.
}
get_media(fileId, acknowledgeAbuse=None, includeLabels=None, includePermissionsForView=None, projection=None, revisionId=None, supportsAllDrives=None, supportsTeamDrives=None, updateViewedDate=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/v2/files/export) instead. For more information, see [Download & export files](/drive/api/guides/manage-downloads).
Args:
fileId: string, The ID for the file in question. (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.
projection: string, Deprecated: This parameter has no function.
Allowed values
BASIC - Deprecated.
FULL - Deprecated.
revisionId: string, Specifies the Revision ID that should be downloaded. Ignored unless alt=media is specified.
supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives.
supportsTeamDrives: boolean, Deprecated: Use `supportsAllDrives` instead.
updateViewedDate: boolean, Deprecated: Use `files.update` with `modifiedDateBehavior=noChange, updateViewedDate=true` and an empty request body.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
The media object as a string.
insert(body=None, convert=None, enforceSingleParent=None, includeLabels=None, includePermissionsForView=None, media_body=None, media_mime_type=None, ocr=None, ocrLanguage=None, pinned=None, supportsAllDrives=None, supportsTeamDrives=None, timedTextLanguage=None, timedTextTrackName=None, useContentAsIndexableText=None, visibility=None, x__xgafv=None)
Inserts 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.insert` must specify the MIME type `application/vnd.google-apps.shortcut`. Apps should specify a file extension in the `title` property when inserting files with the API. For example, an operation to insert a JPEG file should specify something like `"title": "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.
"alternateLink": "A String", # Output only. A link for opening the file in a relevant Google editor or viewer.
"appDataContents": True or False, # Output only. Whether this file is in the Application Data folder.
"canComment": True or False, # Output only. Deprecated: Use `capabilities/canComment` instead.
"canReadRevisions": True or False, # Output only. Deprecated: Use `capabilities/canReadRevisions` instead.
"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.
"canChangeRestrictedDownload": True or False, # Output only. Deprecated.
"canChangeSecurityUpdateEnabled": True or False, # Output only. Whether the current user can change the securityUpdateEnabled field on link share metadata.
"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, # Output only. Deprecated: 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, # Output only. Deprecated: Use `canMoveChildrenWithinDrive` instead.
"canMoveItemIntoTeamDrive": True or False, # Output only. Deprecated: 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, # Output only. Deprecated: 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, # Output only. Deprecated: Use `canMoveItemWithinDrive` instead.
"canMoveTeamDriveItem": True or False, # Output only. Deprecated: 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, # Output only. Deprecated: 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.
},
"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.
"isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made.
"kind": "drive#user", # Output only. This is always `drive#user`.
"permissionId": "A String", # Output only. The user's ID as visible in the permissions collection.
"picture": { # Output only. The user's profile picture.
"url": "A String", # Output Only. A URL that points to a profile picture of this user.
},
},
"restrictionDate": "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.
"copyable": True or False, # Output only. Deprecated: Use `capabilities/canCopy` instead.
"createdDate": "A String", # Create time for this file (formatted RFC 3339 timestamp).
"defaultOpenWithLink": "A String", # Output only. A link to open this file with the user's default app for this file. Only populated when the drive.apps.readonly scope is used.
"description": "A String", # A short description of the file.
"downloadUrl": "A String", # Output only. Short lived download URL for the file. This field is only populated for files with content stored in Google Drive; it is not populated for Google Docs or shortcut files.
"driveId": "A String", # Output only. ID of the shared drive the file resides in. Only populated for items in shared drives.
"editable": True or False, # Output only. Deprecated: Use `capabilities/canEdit` instead.
"embedLink": "A String", # Output only. A link for embedding the file.
"etag": "A String", # Output only. ETag of the file.
"explicitlyTrashed": True or False, # Output only. Whether this file has been explicitly trashed, as opposed to recursively trashed.
"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` with trailing text that does not appear to be part of the extension removed. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.
"fileSize": "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.
"folderColorRgb": "A String", # Folder color as an RGB hex string if the file is a folder or a shortcut to a folder. The list of supported colors is available in the folderColorPalette field of the About resource. If an unsupported color is specified, it will be changed to the closest color in the palette.
"fullFileExtension": "A String", # Output only. The full file extension; extracted from the title. May contain multiple concatenated extensions, such as "tar.gz". Removing an extension from the title does not clear this field; however, changing the extension on the title does update this field. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.
"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 field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.
"iconLink": "A String", # Output only. A link to the file's icon.
"id": "A String", # The ID of the file.
"imageMediaMetadata": { # Output only. Metadata about image media. This will only be present for image types, and its contents will depend on what can be parsed from the image content.
"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.
"date": "A String", # Output only. The date and time the photo was taken (EXIF format timestamp).
"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.
"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.
},
"indexableText": { # Indexable text attributes for the file (can only be written)
"text": "A String", # The text to be indexed for this file.
},
"isAppAuthorized": True or False, # Output only. Whether the file was created or opened by the requesting app.
"kind": "drive#file", # Output only. The type of file. This is always `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 a 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": "drive#labelField", # 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.
"isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made.
"kind": "drive#user", # Output only. This is always `drive#user`.
"permissionId": "A String", # Output only. The user's ID as visible in the permissions collection.
"picture": { # Output only. The user's profile picture.
"url": "A String", # Output Only. A URL that points to a profile picture of this user.
},
},
],
"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": "drive#label", # This is always `drive#label`
"revisionId": "A String", # The revision ID of the label.
},
],
},
"labels": { # A group of labels for the file.
"hidden": True or False, # Output only. Deprecated.
"modified": True or False, # Output only. Whether the file has been modified by this user.
"restricted": True or False, # Output only. Deprecated: Use `copyRequiresWriterPermission` instead.
"starred": True or False, # Whether this file is starred by the user.
"trashed": True or False, # Whether this file has been trashed. This label applies to all users accessing the file; however, only owners are allowed to see and untrash files.
"viewed": True or False, # Whether this file has been viewed by this user.
},
"lastModifyingUser": { # Information about a Drive user. # Output only. The last user to modify this 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.
"isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made.
"kind": "drive#user", # Output only. This is always `drive#user`.
"permissionId": "A String", # Output only. The user's ID as visible in the permissions collection.
"picture": { # Output only. The user's profile picture.
"url": "A String", # Output Only. A URL that points to a profile picture of this user.
},
},
"lastModifyingUserName": "A String", # Output only. Name of the last user to modify this file.
"lastViewedByMeDate": "A String", # Last time this file was viewed by the user (formatted RFC 3339 timestamp).
"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.
},
"markedViewedByMeDate": "A String", # Deprecated.
"md5Checksum": "A String", # Output only. An MD5 checksum for the content of this file. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.
"mimeType": "A String", # The MIME type of the file. This is only mutable on update when uploading new content. This field can be left blank, and the mimetype will be determined from the uploaded content's MIME type.
"modifiedByMeDate": "A String", # Last time this file was modified by the user (formatted RFC 3339 timestamp). Note that setting modifiedDate will also update the modifiedByMe date for the user which set the date.
"modifiedDate": "A String", # Last time this file was modified by anyone (formatted RFC 3339 timestamp). This is only mutable on update when the setModifiedDate parameter is set.
"openWithLinks": { # Output only. A map of the id of each of the user's apps to a link to open this file with that app. Only populated when the drive.apps.readonly scope is used.
"a_key": "A String",
},
"originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the `title` field. This is only available for files with binary content in Google Drive.
"ownedByMe": True or False, # Output only. Whether the file is owned by the current user. Not populated for items in shared drives.
"ownerNames": [ # Output only. Name(s) of the owner(s) of this file. Not populated for items in shared drives.
"A String",
],
"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.
"isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made.
"kind": "drive#user", # Output only. This is always `drive#user`.
"permissionId": "A String", # Output only. The user's ID as visible in the permissions collection.
"picture": { # Output only. The user's profile picture.
"url": "A String", # Output Only. A URL that points to a profile picture of this user.
},
},
],
"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 an insert 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 reference to a file's parent. A file can only have one parent folder; specifying multiple parents isn't supported. Some resource methods (such as `parents.get`) require a `parentId`. Use the `parents.list` method to retrieve the ID for a parent.
"id": "A String", # The ID of the parent.
"isRoot": True or False, # Output only. Whether or not the parent is the root folder.
"kind": "drive#parentReference", # Output only. This is always `drive#parentReference`.
"parentLink": "A String", # Output only. A link to the parent.
"selfLink": "A String", # Output only. A link back to this reference.
},
],
"permissionIds": [ # Output only. List of permission IDs for users with access to this file.
"A String",
],
"permissions": [ # Output only. The list of permissions for users with access to this 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. 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.
"additionalRoles": [ # Additional roles for this user. Only `commenter` is currently allowed, though more may be supported in the future.
"A String",
],
"authKey": "A String", # Output only. Deprecated.
"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.
"domain": "A String", # Output only. The domain name of the entity this permission refers to. This is an output-only field which is present when the permission type is `user`, `group` or `domain`.
"emailAddress": "A String", # Output only. The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is `user` or `group`.
"etag": "A String", # Output only. The ETag of the permission.
"expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: - They can only be set on user and group permissions - The date must be in the future - The date cannot be more than a year in the future - The date can only be set on drive.permissions.update or drive.permissions.patch requests
"id": "A String", # The ID of the user this permission refers to, and identical to the `permissionId` in the About and Files resources. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored.
"kind": "drive#permission", # Output only. This is always `drive#permission`.
"name": "A String", # Output only. The name for this 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.
{
"additionalRoles": [ # Output only. Additional roles for this user. Only `commenter` is currently possible, though more may be supported in the future.
"A String",
],
"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` * `reader`
},
],
"photoLink": "A String", # Output only. A link to the profile photo, if available.
"role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: * `owner` * `organizer` * `fileOrganizer` * `writer` * `reader`
"selfLink": "A String", # Output only. A link back to this permission.
"teamDrivePermissionDetails": [ # Output only. Deprecated: Use `permissionDetails` instead.
{
"additionalRoles": [ # Output only. Deprecated: Use `permissionDetails/additionalRoles` instead.
"A String",
],
"inherited": True or False, # Output only. Deprecated: Use `permissionDetails/inherited` instead.
"inheritedFrom": "A String", # Output only. Deprecated: Use `permissionDetails/inheritedFrom` instead.
"role": "A String", # Output only. Deprecated: Use `permissionDetails/role` instead.
"teamDrivePermissionType": "A String", # Output only. Deprecated: Use `permissionDetails/permissionType` instead.
},
],
"type": "A String", # The account type. Allowed values are: * `user` * `group` * `domain` * `anyone`
"value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored.
"view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. `published` is the only supported value.
"withLink": True or False, # Whether the link is required for this permission.
},
],
"properties": [ # The list of properties.
{ # A key-value pair attached to a file that is either public or private to an application. The following limits apply to file properties: * Maximum of 100 properties total per file * Maximum of 30 private properties per app * Maximum of 30 public properties * Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property Some resource methods (such as `properties.update`) require a `propertyKey`. Use the `properties.list` method to retrieve the key for a property.
"etag": "A String", # Output only. ETag of the property.
"key": "A String", # The key of this property.
"kind": "drive#property", # Output only. This is always `drive#property`.
"selfLink": "A String", # Output only. The link back to this property.
"value": "A String", # The value of this property.
"visibility": "A String", # The visibility of this property. Allowed values are PRIVATE (default) and PUBLIC. Private 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.
},
],
"quotaBytesUsed": "A String", # Output only. The number of quota bytes used by this file.
"resourceKey": "A String", # Output only. A key needed to access the item via a shared link.
"selfLink": "A String", # Output only. A link back to this file.
"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.
"shareable": True or False, # Output only. Deprecated: Use `capabilities/canShare` instead.
"shared": True or False, # Output only. Whether the file has been shared. Not populated for items in shared drives.
"sharedWithMeDate": "A String", # Time at which this file was shared with the user (formatted RFC 3339 timestamp).
"sharingUser": { # Information about a Drive user. # Output only. User that shared the item with the current user, if available.
"displayName": "A String", # Output only. A plain text displayable name for this user.
"emailAddress": "A String", # Output only. The email address of the user.
"isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made.
"kind": "drive#user", # Output only. This is always `drive#user`.
"permissionId": "A String", # Output only. The user's ID as visible in the permissions collection.
"picture": { # Output only. The user's profile picture.
"url": "A String", # Output Only. A URL that points to a profile picture of this user.
},
},
"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.insert` requests.
"targetId": "A String", # The ID of the file that this shortcut points to. Can only be set on `files.insert` 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.
},
"spaces": [ # Output only. The list of spaces which contain the file. Supported values are `drive`, `appDataFolder` and `photos`.
"A String",
],
"teamDriveId": "A String", # Output only. Deprecated: Use `driveId` instead.
"thumbnail": { # A thumbnail for the file. This will only be used if a standard thumbnail cannot be generated.
"image": "A String", # The URL-safe Base64 encoded bytes of the thumbnail image. It should conform to RFC 4648 section 5.
"mimeType": "A String", # The MIME type of the thumbnail.
},
"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), 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.
"title": "A String", # The title of this file. Note that for immutable items such as the top level folders of shared drives, My Drive root folder, and Application Data folder the title is constant.
"trashedDate": "A String", # The time that the item was trashed (formatted RFC 3339 timestamp). 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.
"isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made.
"kind": "drive#user", # Output only. This is always `drive#user`.
"permissionId": "A String", # Output only. The user's ID as visible in the permissions collection.
"picture": { # Output only. The user's profile picture.
"url": "A String", # Output Only. A URL that points to a profile picture of this user.
},
},
"userPermission": { # A permission for a file. A permission grants a user, group, domain, or the world access to a file or a folder hierarchy. 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. # Output only. The permissions for the authenticated user on this file.
"additionalRoles": [ # Additional roles for this user. Only `commenter` is currently allowed, though more may be supported in the future.
"A String",
],
"authKey": "A String", # Output only. Deprecated.
"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.
"domain": "A String", # Output only. The domain name of the entity this permission refers to. This is an output-only field which is present when the permission type is `user`, `group` or `domain`.
"emailAddress": "A String", # Output only. The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is `user` or `group`.
"etag": "A String", # Output only. The ETag of the permission.
"expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: - They can only be set on user and group permissions - The date must be in the future - The date cannot be more than a year in the future - The date can only be set on drive.permissions.update or drive.permissions.patch requests
"id": "A String", # The ID of the user this permission refers to, and identical to the `permissionId` in the About and Files resources. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored.
"kind": "drive#permission", # Output only. This is always `drive#permission`.
"name": "A String", # Output only. The name for this 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.
{
"additionalRoles": [ # Output only. Additional roles for this user. Only `commenter` is currently possible, though more may be supported in the future.
"A String",
],
"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` * `reader`
},
],
"photoLink": "A String", # Output only. A link to the profile photo, if available.
"role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: * `owner` * `organizer` * `fileOrganizer` * `writer` * `reader`
"selfLink": "A String", # Output only. A link back to this permission.
"teamDrivePermissionDetails": [ # Output only. Deprecated: Use `permissionDetails` instead.
{
"additionalRoles": [ # Output only. Deprecated: Use `permissionDetails/additionalRoles` instead.
"A String",
],
"inherited": True or False, # Output only. Deprecated: Use `permissionDetails/inherited` instead.
"inheritedFrom": "A String", # Output only. Deprecated: Use `permissionDetails/inheritedFrom` instead.
"role": "A String", # Output only. Deprecated: Use `permissionDetails/role` instead.
"teamDrivePermissionType": "A String", # Output only. Deprecated: Use `permissionDetails/permissionType` instead.
},
],
"type": "A String", # The account type. Allowed values are: * `user` * `group` * `domain` * `anyone`
"value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored.
"view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. `published` is the only supported value.
"withLink": True or False, # Whether the link is required for this permission.
},
"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 requesting user.
"videoMediaMetadata": { # Output only. Metadata about video media. This will only be present for video types.
"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.
},
"webContentLink": "A String", # Output only. A link for downloading the content of the file in a browser using cookie based authentication. In cases where the content is shared publicly, the content can be downloaded without any credentials.
"webViewLink": "A String", # Output only. A link only available on public folders for viewing their static web assets (HTML, CSS, JS, etc) via Google Drive's Website Hosting.
"writersCanShare": True or False, # Whether writers can share the document with other users. Not populated for items in shared drives.
}
convert: boolean, Whether to convert this file to the corresponding Docs Editors format.
enforceSingleParent: boolean, Deprecated: Creating files in multiple folders is no longer supported.
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.
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.
ocr: boolean, Whether to attempt OCR on .jpg, .png, .gif, or .pdf uploads.
ocrLanguage: string, If ocr is true, hints at the language to use. Valid values are BCP 47 codes.
pinned: boolean, Whether to pin the head revision of the uploaded file. A file can have a maximum of 200 pinned revisions.
supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives.
supportsTeamDrives: boolean, Deprecated: Use `supportsAllDrives` instead.
timedTextLanguage: string, The language of the timed text.
timedTextTrackName: string, The timed text track name.
useContentAsIndexableText: boolean, Whether to use the content as indexable text.
visibility: string, The visibility of the new file. This parameter is only relevant when convert=false.
Allowed values
DEFAULT - The visibility of the new file is determined by the user's default visibility/sharing policies.
PRIVATE - The new file will be visible to only the owner.
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.
"alternateLink": "A String", # Output only. A link for opening the file in a relevant Google editor or viewer.
"appDataContents": True or False, # Output only. Whether this file is in the Application Data folder.
"canComment": True or False, # Output only. Deprecated: Use `capabilities/canComment` instead.
"canReadRevisions": True or False, # Output only. Deprecated: Use `capabilities/canReadRevisions` instead.
"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.
"canChangeRestrictedDownload": True or False, # Output only. Deprecated.
"canChangeSecurityUpdateEnabled": True or False, # Output only. Whether the current user can change the securityUpdateEnabled field on link share metadata.
"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, # Output only. Deprecated: 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, # Output only. Deprecated: Use `canMoveChildrenWithinDrive` instead.
"canMoveItemIntoTeamDrive": True or False, # Output only. Deprecated: 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, # Output only. Deprecated: 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, # Output only. Deprecated: Use `canMoveItemWithinDrive` instead.
"canMoveTeamDriveItem": True or False, # Output only. Deprecated: 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, # Output only. Deprecated: 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.
},
"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.
"isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made.
"kind": "drive#user", # Output only. This is always `drive#user`.
"permissionId": "A String", # Output only. The user's ID as visible in the permissions collection.
"picture": { # Output only. The user's profile picture.
"url": "A String", # Output Only. A URL that points to a profile picture of this user.
},
},
"restrictionDate": "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.
"copyable": True or False, # Output only. Deprecated: Use `capabilities/canCopy` instead.
"createdDate": "A String", # Create time for this file (formatted RFC 3339 timestamp).
"defaultOpenWithLink": "A String", # Output only. A link to open this file with the user's default app for this file. Only populated when the drive.apps.readonly scope is used.
"description": "A String", # A short description of the file.
"downloadUrl": "A String", # Output only. Short lived download URL for the file. This field is only populated for files with content stored in Google Drive; it is not populated for Google Docs or shortcut files.
"driveId": "A String", # Output only. ID of the shared drive the file resides in. Only populated for items in shared drives.
"editable": True or False, # Output only. Deprecated: Use `capabilities/canEdit` instead.
"embedLink": "A String", # Output only. A link for embedding the file.
"etag": "A String", # Output only. ETag of the file.
"explicitlyTrashed": True or False, # Output only. Whether this file has been explicitly trashed, as opposed to recursively trashed.
"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` with trailing text that does not appear to be part of the extension removed. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.
"fileSize": "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.
"folderColorRgb": "A String", # Folder color as an RGB hex string if the file is a folder or a shortcut to a folder. The list of supported colors is available in the folderColorPalette field of the About resource. If an unsupported color is specified, it will be changed to the closest color in the palette.
"fullFileExtension": "A String", # Output only. The full file extension; extracted from the title. May contain multiple concatenated extensions, such as "tar.gz". Removing an extension from the title does not clear this field; however, changing the extension on the title does update this field. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.
"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 field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.
"iconLink": "A String", # Output only. A link to the file's icon.
"id": "A String", # The ID of the file.
"imageMediaMetadata": { # Output only. Metadata about image media. This will only be present for image types, and its contents will depend on what can be parsed from the image content.
"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.
"date": "A String", # Output only. The date and time the photo was taken (EXIF format timestamp).
"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.
"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.
},
"indexableText": { # Indexable text attributes for the file (can only be written)
"text": "A String", # The text to be indexed for this file.
},
"isAppAuthorized": True or False, # Output only. Whether the file was created or opened by the requesting app.
"kind": "drive#file", # Output only. The type of file. This is always `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 a 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": "drive#labelField", # 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.
"isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made.
"kind": "drive#user", # Output only. This is always `drive#user`.
"permissionId": "A String", # Output only. The user's ID as visible in the permissions collection.
"picture": { # Output only. The user's profile picture.
"url": "A String", # Output Only. A URL that points to a profile picture of this user.
},
},
],
"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": "drive#label", # This is always `drive#label`
"revisionId": "A String", # The revision ID of the label.
},
],
},
"labels": { # A group of labels for the file.
"hidden": True or False, # Output only. Deprecated.
"modified": True or False, # Output only. Whether the file has been modified by this user.
"restricted": True or False, # Output only. Deprecated: Use `copyRequiresWriterPermission` instead.
"starred": True or False, # Whether this file is starred by the user.
"trashed": True or False, # Whether this file has been trashed. This label applies to all users accessing the file; however, only owners are allowed to see and untrash files.
"viewed": True or False, # Whether this file has been viewed by this user.
},
"lastModifyingUser": { # Information about a Drive user. # Output only. The last user to modify this 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.
"isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made.
"kind": "drive#user", # Output only. This is always `drive#user`.
"permissionId": "A String", # Output only. The user's ID as visible in the permissions collection.
"picture": { # Output only. The user's profile picture.
"url": "A String", # Output Only. A URL that points to a profile picture of this user.
},
},
"lastModifyingUserName": "A String", # Output only. Name of the last user to modify this file.
"lastViewedByMeDate": "A String", # Last time this file was viewed by the user (formatted RFC 3339 timestamp).
"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.
},
"markedViewedByMeDate": "A String", # Deprecated.
"md5Checksum": "A String", # Output only. An MD5 checksum for the content of this file. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.
"mimeType": "A String", # The MIME type of the file. This is only mutable on update when uploading new content. This field can be left blank, and the mimetype will be determined from the uploaded content's MIME type.
"modifiedByMeDate": "A String", # Last time this file was modified by the user (formatted RFC 3339 timestamp). Note that setting modifiedDate will also update the modifiedByMe date for the user which set the date.
"modifiedDate": "A String", # Last time this file was modified by anyone (formatted RFC 3339 timestamp). This is only mutable on update when the setModifiedDate parameter is set.
"openWithLinks": { # Output only. A map of the id of each of the user's apps to a link to open this file with that app. Only populated when the drive.apps.readonly scope is used.
"a_key": "A String",
},
"originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the `title` field. This is only available for files with binary content in Google Drive.
"ownedByMe": True or False, # Output only. Whether the file is owned by the current user. Not populated for items in shared drives.
"ownerNames": [ # Output only. Name(s) of the owner(s) of this file. Not populated for items in shared drives.
"A String",
],
"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.
"isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made.
"kind": "drive#user", # Output only. This is always `drive#user`.
"permissionId": "A String", # Output only. The user's ID as visible in the permissions collection.
"picture": { # Output only. The user's profile picture.
"url": "A String", # Output Only. A URL that points to a profile picture of this user.
},
},
],
"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 an insert 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 reference to a file's parent. A file can only have one parent folder; specifying multiple parents isn't supported. Some resource methods (such as `parents.get`) require a `parentId`. Use the `parents.list` method to retrieve the ID for a parent.
"id": "A String", # The ID of the parent.
"isRoot": True or False, # Output only. Whether or not the parent is the root folder.
"kind": "drive#parentReference", # Output only. This is always `drive#parentReference`.
"parentLink": "A String", # Output only. A link to the parent.
"selfLink": "A String", # Output only. A link back to this reference.
},
],
"permissionIds": [ # Output only. List of permission IDs for users with access to this file.
"A String",
],
"permissions": [ # Output only. The list of permissions for users with access to this 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. 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.
"additionalRoles": [ # Additional roles for this user. Only `commenter` is currently allowed, though more may be supported in the future.
"A String",
],
"authKey": "A String", # Output only. Deprecated.
"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.
"domain": "A String", # Output only. The domain name of the entity this permission refers to. This is an output-only field which is present when the permission type is `user`, `group` or `domain`.
"emailAddress": "A String", # Output only. The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is `user` or `group`.
"etag": "A String", # Output only. The ETag of the permission.
"expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: - They can only be set on user and group permissions - The date must be in the future - The date cannot be more than a year in the future - The date can only be set on drive.permissions.update or drive.permissions.patch requests
"id": "A String", # The ID of the user this permission refers to, and identical to the `permissionId` in the About and Files resources. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored.
"kind": "drive#permission", # Output only. This is always `drive#permission`.
"name": "A String", # Output only. The name for this 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.
{
"additionalRoles": [ # Output only. Additional roles for this user. Only `commenter` is currently possible, though more may be supported in the future.
"A String",
],
"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` * `reader`
},
],
"photoLink": "A String", # Output only. A link to the profile photo, if available.
"role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: * `owner` * `organizer` * `fileOrganizer` * `writer` * `reader`
"selfLink": "A String", # Output only. A link back to this permission.
"teamDrivePermissionDetails": [ # Output only. Deprecated: Use `permissionDetails` instead.
{
"additionalRoles": [ # Output only. Deprecated: Use `permissionDetails/additionalRoles` instead.
"A String",
],
"inherited": True or False, # Output only. Deprecated: Use `permissionDetails/inherited` instead.
"inheritedFrom": "A String", # Output only. Deprecated: Use `permissionDetails/inheritedFrom` instead.
"role": "A String", # Output only. Deprecated: Use `permissionDetails/role` instead.
"teamDrivePermissionType": "A String", # Output only. Deprecated: Use `permissionDetails/permissionType` instead.
},
],
"type": "A String", # The account type. Allowed values are: * `user` * `group` * `domain` * `anyone`
"value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored.
"view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. `published` is the only supported value.
"withLink": True or False, # Whether the link is required for this permission.
},
],
"properties": [ # The list of properties.
{ # A key-value pair attached to a file that is either public or private to an application. The following limits apply to file properties: * Maximum of 100 properties total per file * Maximum of 30 private properties per app * Maximum of 30 public properties * Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property Some resource methods (such as `properties.update`) require a `propertyKey`. Use the `properties.list` method to retrieve the key for a property.
"etag": "A String", # Output only. ETag of the property.
"key": "A String", # The key of this property.
"kind": "drive#property", # Output only. This is always `drive#property`.
"selfLink": "A String", # Output only. The link back to this property.
"value": "A String", # The value of this property.
"visibility": "A String", # The visibility of this property. Allowed values are PRIVATE (default) and PUBLIC. Private 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.
},
],
"quotaBytesUsed": "A String", # Output only. The number of quota bytes used by this file.
"resourceKey": "A String", # Output only. A key needed to access the item via a shared link.
"selfLink": "A String", # Output only. A link back to this file.
"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.
"shareable": True or False, # Output only. Deprecated: Use `capabilities/canShare` instead.
"shared": True or False, # Output only. Whether the file has been shared. Not populated for items in shared drives.
"sharedWithMeDate": "A String", # Time at which this file was shared with the user (formatted RFC 3339 timestamp).
"sharingUser": { # Information about a Drive user. # Output only. User that shared the item with the current user, if available.
"displayName": "A String", # Output only. A plain text displayable name for this user.
"emailAddress": "A String", # Output only. The email address of the user.
"isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made.
"kind": "drive#user", # Output only. This is always `drive#user`.
"permissionId": "A String", # Output only. The user's ID as visible in the permissions collection.
"picture": { # Output only. The user's profile picture.
"url": "A String", # Output Only. A URL that points to a profile picture of this user.
},
},
"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.insert` requests.
"targetId": "A String", # The ID of the file that this shortcut points to. Can only be set on `files.insert` 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.
},
"spaces": [ # Output only. The list of spaces which contain the file. Supported values are `drive`, `appDataFolder` and `photos`.
"A String",
],
"teamDriveId": "A String", # Output only. Deprecated: Use `driveId` instead.
"thumbnail": { # A thumbnail for the file. This will only be used if a standard thumbnail cannot be generated.
"image": "A String", # The URL-safe Base64 encoded bytes of the thumbnail image. It should conform to RFC 4648 section 5.
"mimeType": "A String", # The MIME type of the thumbnail.
},
"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), 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.
"title": "A String", # The title of this file. Note that for immutable items such as the top level folders of shared drives, My Drive root folder, and Application Data folder the title is constant.
"trashedDate": "A String", # The time that the item was trashed (formatted RFC 3339 timestamp). 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.
"isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made.
"kind": "drive#user", # Output only. This is always `drive#user`.
"permissionId": "A String", # Output only. The user's ID as visible in the permissions collection.
"picture": { # Output only. The user's profile picture.
"url": "A String", # Output Only. A URL that points to a profile picture of this user.
},
},
"userPermission": { # A permission for a file. A permission grants a user, group, domain, or the world access to a file or a folder hierarchy. 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. # Output only. The permissions for the authenticated user on this file.
"additionalRoles": [ # Additional roles for this user. Only `commenter` is currently allowed, though more may be supported in the future.
"A String",
],
"authKey": "A String", # Output only. Deprecated.
"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.
"domain": "A String", # Output only. The domain name of the entity this permission refers to. This is an output-only field which is present when the permission type is `user`, `group` or `domain`.
"emailAddress": "A String", # Output only. The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is `user` or `group`.
"etag": "A String", # Output only. The ETag of the permission.
"expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: - They can only be set on user and group permissions - The date must be in the future - The date cannot be more than a year in the future - The date can only be set on drive.permissions.update or drive.permissions.patch requests
"id": "A String", # The ID of the user this permission refers to, and identical to the `permissionId` in the About and Files resources. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored.
"kind": "drive#permission", # Output only. This is always `drive#permission`.
"name": "A String", # Output only. The name for this 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.
{
"additionalRoles": [ # Output only. Additional roles for this user. Only `commenter` is currently possible, though more may be supported in the future.
"A String",
],
"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` * `reader`
},
],
"photoLink": "A String", # Output only. A link to the profile photo, if available.
"role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: * `owner` * `organizer` * `fileOrganizer` * `writer` * `reader`
"selfLink": "A String", # Output only. A link back to this permission.
"teamDrivePermissionDetails": [ # Output only. Deprecated: Use `permissionDetails` instead.
{
"additionalRoles": [ # Output only. Deprecated: Use `permissionDetails/additionalRoles` instead.
"A String",
],
"inherited": True or False, # Output only. Deprecated: Use `permissionDetails/inherited` instead.
"inheritedFrom": "A String", # Output only. Deprecated: Use `permissionDetails/inheritedFrom` instead.
"role": "A String", # Output only. Deprecated: Use `permissionDetails/role` instead.
"teamDrivePermissionType": "A String", # Output only. Deprecated: Use `permissionDetails/permissionType` instead.
},
],
"type": "A String", # The account type. Allowed values are: * `user` * `group` * `domain` * `anyone`
"value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored.
"view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. `published` is the only supported value.
"withLink": True or False, # Whether the link is required for this permission.
},
"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 requesting user.
"videoMediaMetadata": { # Output only. Metadata about video media. This will only be present for video types.
"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.
},
"webContentLink": "A String", # Output only. A link for downloading the content of the file in a browser using cookie based authentication. In cases where the content is shared publicly, the content can be downloaded without any credentials.
"webViewLink": "A String", # Output only. A link only available on public folders for viewing their static web assets (HTML, CSS, JS, etc) via Google Drive's Website Hosting.
"writersCanShare": True or False, # Whether writers can share the document with other users. Not populated for items in shared drives.
}
list(corpora=None, corpus=None, driveId=None, includeItemsFromAllDrives=None, includeLabels=None, includePermissionsForView=None, includeTeamDriveItems=None, maxResults=None, orderBy=None, pageToken=None, projection=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 `default`, `domain`, `drive` and `allDrives`. Prefer `default` or `drive` to `allDrives` for efficiency.
corpus: string, Deprecated: The body of items (files/documents) to which the query applies. Use `corpora` instead.
Allowed values
DEFAULT - The items that the user has accessed.
DOMAIN - Items shared to the user's domain.
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.
maxResults: 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.
orderBy: string, A comma-separated list of sort keys. Valid keys are: * `createdDate`: When the file was created. * `folder`: The folder ID. This field is sorted using alphabetical ordering. * `lastViewedByMeDate`: The last time the file was viewed by the user. * `modifiedByMeDate`: The last time the file was modified by the user. * `modifiedDate`: The last time the file was modified by anyone. * `quotaBytesUsed`: The number of storage quota bytes used by the file. * `recency`: The most recent timestamp from the file's date-time fields. * `sharedWithMeDate`: When the file was shared with the user, if applicable. * `starred`: Whether the user has starred the file. * `title`: The title of the file. This field is sorted using alphabetical ordering, so 1, 12, 2, 22. * `title_natural`: The title of the file. This field is sorted using natural sort ordering, so 1, 2, 12, 22. Each key sorts ascending by default, but can be reversed with the 'desc' modifier. Example usage: `?orderBy=folder,modifiedDate desc,title`. Note that there's a current limitation for users with approximately one million files in which the requested sort order is ignored.
pageToken: string, Page token for files.
projection: string, Deprecated: This parameter has no function.
Allowed values
BASIC - Deprecated.
FULL - Deprecated.
q: string, Query string for searching files.
spaces: string, A comma-separated list of spaces to query. 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.
"etag": "A String", # The ETag of the list.
"incompleteSearch": True or False, # Whether the search process was incomplete. If true, then some search results may be missing, since all documents were not searched. This may occur when searching multiple drives with the "allDrives" corpora, but all corpora could not be searched. When this happens, it is suggested that clients narrow their query by choosing a different corpus such as "default" or "drive".
"items": [ # 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.
"alternateLink": "A String", # Output only. A link for opening the file in a relevant Google editor or viewer.
"appDataContents": True or False, # Output only. Whether this file is in the Application Data folder.
"canComment": True or False, # Output only. Deprecated: Use `capabilities/canComment` instead.
"canReadRevisions": True or False, # Output only. Deprecated: Use `capabilities/canReadRevisions` instead.
"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.
"canChangeRestrictedDownload": True or False, # Output only. Deprecated.
"canChangeSecurityUpdateEnabled": True or False, # Output only. Whether the current user can change the securityUpdateEnabled field on link share metadata.
"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, # Output only. Deprecated: 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, # Output only. Deprecated: Use `canMoveChildrenWithinDrive` instead.
"canMoveItemIntoTeamDrive": True or False, # Output only. Deprecated: 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, # Output only. Deprecated: 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, # Output only. Deprecated: Use `canMoveItemWithinDrive` instead.
"canMoveTeamDriveItem": True or False, # Output only. Deprecated: 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, # Output only. Deprecated: 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.
},
"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.
"isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made.
"kind": "drive#user", # Output only. This is always `drive#user`.
"permissionId": "A String", # Output only. The user's ID as visible in the permissions collection.
"picture": { # Output only. The user's profile picture.
"url": "A String", # Output Only. A URL that points to a profile picture of this user.
},
},
"restrictionDate": "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.
"copyable": True or False, # Output only. Deprecated: Use `capabilities/canCopy` instead.
"createdDate": "A String", # Create time for this file (formatted RFC 3339 timestamp).
"defaultOpenWithLink": "A String", # Output only. A link to open this file with the user's default app for this file. Only populated when the drive.apps.readonly scope is used.
"description": "A String", # A short description of the file.
"downloadUrl": "A String", # Output only. Short lived download URL for the file. This field is only populated for files with content stored in Google Drive; it is not populated for Google Docs or shortcut files.
"driveId": "A String", # Output only. ID of the shared drive the file resides in. Only populated for items in shared drives.
"editable": True or False, # Output only. Deprecated: Use `capabilities/canEdit` instead.
"embedLink": "A String", # Output only. A link for embedding the file.
"etag": "A String", # Output only. ETag of the file.
"explicitlyTrashed": True or False, # Output only. Whether this file has been explicitly trashed, as opposed to recursively trashed.
"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` with trailing text that does not appear to be part of the extension removed. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.
"fileSize": "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.
"folderColorRgb": "A String", # Folder color as an RGB hex string if the file is a folder or a shortcut to a folder. The list of supported colors is available in the folderColorPalette field of the About resource. If an unsupported color is specified, it will be changed to the closest color in the palette.
"fullFileExtension": "A String", # Output only. The full file extension; extracted from the title. May contain multiple concatenated extensions, such as "tar.gz". Removing an extension from the title does not clear this field; however, changing the extension on the title does update this field. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.
"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 field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.
"iconLink": "A String", # Output only. A link to the file's icon.
"id": "A String", # The ID of the file.
"imageMediaMetadata": { # Output only. Metadata about image media. This will only be present for image types, and its contents will depend on what can be parsed from the image content.
"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.
"date": "A String", # Output only. The date and time the photo was taken (EXIF format timestamp).
"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.
"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.
},
"indexableText": { # Indexable text attributes for the file (can only be written)
"text": "A String", # The text to be indexed for this file.
},
"isAppAuthorized": True or False, # Output only. Whether the file was created or opened by the requesting app.
"kind": "drive#file", # Output only. The type of file. This is always `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 a 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": "drive#labelField", # 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.
"isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made.
"kind": "drive#user", # Output only. This is always `drive#user`.
"permissionId": "A String", # Output only. The user's ID as visible in the permissions collection.
"picture": { # Output only. The user's profile picture.
"url": "A String", # Output Only. A URL that points to a profile picture of this user.
},
},
],
"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": "drive#label", # This is always `drive#label`
"revisionId": "A String", # The revision ID of the label.
},
],
},
"labels": { # A group of labels for the file.
"hidden": True or False, # Output only. Deprecated.
"modified": True or False, # Output only. Whether the file has been modified by this user.
"restricted": True or False, # Output only. Deprecated: Use `copyRequiresWriterPermission` instead.
"starred": True or False, # Whether this file is starred by the user.
"trashed": True or False, # Whether this file has been trashed. This label applies to all users accessing the file; however, only owners are allowed to see and untrash files.
"viewed": True or False, # Whether this file has been viewed by this user.
},
"lastModifyingUser": { # Information about a Drive user. # Output only. The last user to modify this 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.
"isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made.
"kind": "drive#user", # Output only. This is always `drive#user`.
"permissionId": "A String", # Output only. The user's ID as visible in the permissions collection.
"picture": { # Output only. The user's profile picture.
"url": "A String", # Output Only. A URL that points to a profile picture of this user.
},
},
"lastModifyingUserName": "A String", # Output only. Name of the last user to modify this file.
"lastViewedByMeDate": "A String", # Last time this file was viewed by the user (formatted RFC 3339 timestamp).
"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.
},
"markedViewedByMeDate": "A String", # Deprecated.
"md5Checksum": "A String", # Output only. An MD5 checksum for the content of this file. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.
"mimeType": "A String", # The MIME type of the file. This is only mutable on update when uploading new content. This field can be left blank, and the mimetype will be determined from the uploaded content's MIME type.
"modifiedByMeDate": "A String", # Last time this file was modified by the user (formatted RFC 3339 timestamp). Note that setting modifiedDate will also update the modifiedByMe date for the user which set the date.
"modifiedDate": "A String", # Last time this file was modified by anyone (formatted RFC 3339 timestamp). This is only mutable on update when the setModifiedDate parameter is set.
"openWithLinks": { # Output only. A map of the id of each of the user's apps to a link to open this file with that app. Only populated when the drive.apps.readonly scope is used.
"a_key": "A String",
},
"originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the `title` field. This is only available for files with binary content in Google Drive.
"ownedByMe": True or False, # Output only. Whether the file is owned by the current user. Not populated for items in shared drives.
"ownerNames": [ # Output only. Name(s) of the owner(s) of this file. Not populated for items in shared drives.
"A String",
],
"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.
"isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made.
"kind": "drive#user", # Output only. This is always `drive#user`.
"permissionId": "A String", # Output only. The user's ID as visible in the permissions collection.
"picture": { # Output only. The user's profile picture.
"url": "A String", # Output Only. A URL that points to a profile picture of this user.
},
},
],
"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 an insert 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 reference to a file's parent. A file can only have one parent folder; specifying multiple parents isn't supported. Some resource methods (such as `parents.get`) require a `parentId`. Use the `parents.list` method to retrieve the ID for a parent.
"id": "A String", # The ID of the parent.
"isRoot": True or False, # Output only. Whether or not the parent is the root folder.
"kind": "drive#parentReference", # Output only. This is always `drive#parentReference`.
"parentLink": "A String", # Output only. A link to the parent.
"selfLink": "A String", # Output only. A link back to this reference.
},
],
"permissionIds": [ # Output only. List of permission IDs for users with access to this file.
"A String",
],
"permissions": [ # Output only. The list of permissions for users with access to this 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. 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.
"additionalRoles": [ # Additional roles for this user. Only `commenter` is currently allowed, though more may be supported in the future.
"A String",
],
"authKey": "A String", # Output only. Deprecated.
"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.
"domain": "A String", # Output only. The domain name of the entity this permission refers to. This is an output-only field which is present when the permission type is `user`, `group` or `domain`.
"emailAddress": "A String", # Output only. The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is `user` or `group`.
"etag": "A String", # Output only. The ETag of the permission.
"expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: - They can only be set on user and group permissions - The date must be in the future - The date cannot be more than a year in the future - The date can only be set on drive.permissions.update or drive.permissions.patch requests
"id": "A String", # The ID of the user this permission refers to, and identical to the `permissionId` in the About and Files resources. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored.
"kind": "drive#permission", # Output only. This is always `drive#permission`.
"name": "A String", # Output only. The name for this 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.
{
"additionalRoles": [ # Output only. Additional roles for this user. Only `commenter` is currently possible, though more may be supported in the future.
"A String",
],
"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` * `reader`
},
],
"photoLink": "A String", # Output only. A link to the profile photo, if available.
"role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: * `owner` * `organizer` * `fileOrganizer` * `writer` * `reader`
"selfLink": "A String", # Output only. A link back to this permission.
"teamDrivePermissionDetails": [ # Output only. Deprecated: Use `permissionDetails` instead.
{
"additionalRoles": [ # Output only. Deprecated: Use `permissionDetails/additionalRoles` instead.
"A String",
],
"inherited": True or False, # Output only. Deprecated: Use `permissionDetails/inherited` instead.
"inheritedFrom": "A String", # Output only. Deprecated: Use `permissionDetails/inheritedFrom` instead.
"role": "A String", # Output only. Deprecated: Use `permissionDetails/role` instead.
"teamDrivePermissionType": "A String", # Output only. Deprecated: Use `permissionDetails/permissionType` instead.
},
],
"type": "A String", # The account type. Allowed values are: * `user` * `group` * `domain` * `anyone`
"value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored.
"view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. `published` is the only supported value.
"withLink": True or False, # Whether the link is required for this permission.
},
],
"properties": [ # The list of properties.
{ # A key-value pair attached to a file that is either public or private to an application. The following limits apply to file properties: * Maximum of 100 properties total per file * Maximum of 30 private properties per app * Maximum of 30 public properties * Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property Some resource methods (such as `properties.update`) require a `propertyKey`. Use the `properties.list` method to retrieve the key for a property.
"etag": "A String", # Output only. ETag of the property.
"key": "A String", # The key of this property.
"kind": "drive#property", # Output only. This is always `drive#property`.
"selfLink": "A String", # Output only. The link back to this property.
"value": "A String", # The value of this property.
"visibility": "A String", # The visibility of this property. Allowed values are PRIVATE (default) and PUBLIC. Private 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.
},
],
"quotaBytesUsed": "A String", # Output only. The number of quota bytes used by this file.
"resourceKey": "A String", # Output only. A key needed to access the item via a shared link.
"selfLink": "A String", # Output only. A link back to this file.
"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.
"shareable": True or False, # Output only. Deprecated: Use `capabilities/canShare` instead.
"shared": True or False, # Output only. Whether the file has been shared. Not populated for items in shared drives.
"sharedWithMeDate": "A String", # Time at which this file was shared with the user (formatted RFC 3339 timestamp).
"sharingUser": { # Information about a Drive user. # Output only. User that shared the item with the current user, if available.
"displayName": "A String", # Output only. A plain text displayable name for this user.
"emailAddress": "A String", # Output only. The email address of the user.
"isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made.
"kind": "drive#user", # Output only. This is always `drive#user`.
"permissionId": "A String", # Output only. The user's ID as visible in the permissions collection.
"picture": { # Output only. The user's profile picture.
"url": "A String", # Output Only. A URL that points to a profile picture of this user.
},
},
"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.insert` requests.
"targetId": "A String", # The ID of the file that this shortcut points to. Can only be set on `files.insert` 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.
},
"spaces": [ # Output only. The list of spaces which contain the file. Supported values are `drive`, `appDataFolder` and `photos`.
"A String",
],
"teamDriveId": "A String", # Output only. Deprecated: Use `driveId` instead.
"thumbnail": { # A thumbnail for the file. This will only be used if a standard thumbnail cannot be generated.
"image": "A String", # The URL-safe Base64 encoded bytes of the thumbnail image. It should conform to RFC 4648 section 5.
"mimeType": "A String", # The MIME type of the thumbnail.
},
"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), 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.
"title": "A String", # The title of this file. Note that for immutable items such as the top level folders of shared drives, My Drive root folder, and Application Data folder the title is constant.
"trashedDate": "A String", # The time that the item was trashed (formatted RFC 3339 timestamp). 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.
"isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made.
"kind": "drive#user", # Output only. This is always `drive#user`.
"permissionId": "A String", # Output only. The user's ID as visible in the permissions collection.
"picture": { # Output only. The user's profile picture.
"url": "A String", # Output Only. A URL that points to a profile picture of this user.
},
},
"userPermission": { # A permission for a file. A permission grants a user, group, domain, or the world access to a file or a folder hierarchy. 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. # Output only. The permissions for the authenticated user on this file.
"additionalRoles": [ # Additional roles for this user. Only `commenter` is currently allowed, though more may be supported in the future.
"A String",
],
"authKey": "A String", # Output only. Deprecated.
"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.
"domain": "A String", # Output only. The domain name of the entity this permission refers to. This is an output-only field which is present when the permission type is `user`, `group` or `domain`.
"emailAddress": "A String", # Output only. The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is `user` or `group`.
"etag": "A String", # Output only. The ETag of the permission.
"expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: - They can only be set on user and group permissions - The date must be in the future - The date cannot be more than a year in the future - The date can only be set on drive.permissions.update or drive.permissions.patch requests
"id": "A String", # The ID of the user this permission refers to, and identical to the `permissionId` in the About and Files resources. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored.
"kind": "drive#permission", # Output only. This is always `drive#permission`.
"name": "A String", # Output only. The name for this 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.
{
"additionalRoles": [ # Output only. Additional roles for this user. Only `commenter` is currently possible, though more may be supported in the future.
"A String",
],
"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` * `reader`
},
],
"photoLink": "A String", # Output only. A link to the profile photo, if available.
"role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: * `owner` * `organizer` * `fileOrganizer` * `writer` * `reader`
"selfLink": "A String", # Output only. A link back to this permission.
"teamDrivePermissionDetails": [ # Output only. Deprecated: Use `permissionDetails` instead.
{
"additionalRoles": [ # Output only. Deprecated: Use `permissionDetails/additionalRoles` instead.
"A String",
],
"inherited": True or False, # Output only. Deprecated: Use `permissionDetails/inherited` instead.
"inheritedFrom": "A String", # Output only. Deprecated: Use `permissionDetails/inheritedFrom` instead.
"role": "A String", # Output only. Deprecated: Use `permissionDetails/role` instead.
"teamDrivePermissionType": "A String", # Output only. Deprecated: Use `permissionDetails/permissionType` instead.
},
],
"type": "A String", # The account type. Allowed values are: * `user` * `group` * `domain` * `anyone`
"value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored.
"view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. `published` is the only supported value.
"withLink": True or False, # Whether the link is required for this permission.
},
"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 requesting user.
"videoMediaMetadata": { # Output only. Metadata about video media. This will only be present for video types.
"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.
},
"webContentLink": "A String", # Output only. A link for downloading the content of the file in a browser using cookie based authentication. In cases where the content is shared publicly, the content can be downloaded without any credentials.
"webViewLink": "A String", # Output only. A link only available on public folders for viewing their static web assets (HTML, CSS, JS, etc) via Google Drive's Website Hosting.
"writersCanShare": True or False, # Whether writers can share the document with other users. Not populated for items in shared drives.
},
],
"kind": "drive#fileList", # This is always `drive#fileList`.
"nextLink": "A String", # A link to the next page of files.
"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.
"selfLink": "A String", # A link back to this list.
}
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.
"items": [ # The list of labels.
{ # Representation of a 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": "drive#labelField", # 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.
"isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made.
"kind": "drive#user", # Output only. This is always `drive#user`.
"permissionId": "A String", # Output only. The user's ID as visible in the permissions collection.
"picture": { # Output only. The user's profile picture.
"url": "A String", # Output Only. A URL that points to a profile picture of this user.
},
},
],
"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": "drive#label", # This is always `drive#label`
"revisionId": "A String", # The revision ID of the label.
},
],
"kind": "drive#labelList", # This is always `drive#labelList`
"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.
}
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": "drive#modifyLabelsRequest", # 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": "drive#labelFieldModification", # 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": "drive#labelModification", # 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": "drive#modifyLabelsResponse", # This is always `drive#modifyLabelsResponse`
"modifiedLabels": [ # The list of labels which were added or updated by the request.
{ # Representation of a 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": "drive#labelField", # 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.
"isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made.
"kind": "drive#user", # Output only. This is always `drive#user`.
"permissionId": "A String", # Output only. The user's ID as visible in the permissions collection.
"picture": { # Output only. The user's profile picture.
"url": "A String", # Output Only. A URL that points to a profile picture of this user.
},
},
],
"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": "drive#label", # This is always `drive#label`
"revisionId": "A String", # The revision ID of the label.
},
],
}
patch(fileId, addParents=None, body=None, convert=None, enforceSingleParent=None, includeLabels=None, includePermissionsForView=None, modifiedDateBehavior=None, newRevision=None, ocr=None, ocrLanguage=None, pinned=None, removeParents=None, setModifiedDate=None, supportsAllDrives=None, supportsTeamDrives=None, timedTextLanguage=None, timedTextTrackName=None, updateViewedDate=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 change automatically, such as modifiedDate. This method supports patch semantics.
Args:
fileId: string, The ID of the file to update. (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.
"alternateLink": "A String", # Output only. A link for opening the file in a relevant Google editor or viewer.
"appDataContents": True or False, # Output only. Whether this file is in the Application Data folder.
"canComment": True or False, # Output only. Deprecated: Use `capabilities/canComment` instead.
"canReadRevisions": True or False, # Output only. Deprecated: Use `capabilities/canReadRevisions` instead.
"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.
"canChangeRestrictedDownload": True or False, # Output only. Deprecated.
"canChangeSecurityUpdateEnabled": True or False, # Output only. Whether the current user can change the securityUpdateEnabled field on link share metadata.
"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, # Output only. Deprecated: 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, # Output only. Deprecated: Use `canMoveChildrenWithinDrive` instead.
"canMoveItemIntoTeamDrive": True or False, # Output only. Deprecated: 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, # Output only. Deprecated: 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, # Output only. Deprecated: Use `canMoveItemWithinDrive` instead.
"canMoveTeamDriveItem": True or False, # Output only. Deprecated: 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, # Output only. Deprecated: 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.
},
"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.
"isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made.
"kind": "drive#user", # Output only. This is always `drive#user`.
"permissionId": "A String", # Output only. The user's ID as visible in the permissions collection.
"picture": { # Output only. The user's profile picture.
"url": "A String", # Output Only. A URL that points to a profile picture of this user.
},
},
"restrictionDate": "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.
"copyable": True or False, # Output only. Deprecated: Use `capabilities/canCopy` instead.
"createdDate": "A String", # Create time for this file (formatted RFC 3339 timestamp).
"defaultOpenWithLink": "A String", # Output only. A link to open this file with the user's default app for this file. Only populated when the drive.apps.readonly scope is used.
"description": "A String", # A short description of the file.
"downloadUrl": "A String", # Output only. Short lived download URL for the file. This field is only populated for files with content stored in Google Drive; it is not populated for Google Docs or shortcut files.
"driveId": "A String", # Output only. ID of the shared drive the file resides in. Only populated for items in shared drives.
"editable": True or False, # Output only. Deprecated: Use `capabilities/canEdit` instead.
"embedLink": "A String", # Output only. A link for embedding the file.
"etag": "A String", # Output only. ETag of the file.
"explicitlyTrashed": True or False, # Output only. Whether this file has been explicitly trashed, as opposed to recursively trashed.
"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` with trailing text that does not appear to be part of the extension removed. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.
"fileSize": "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.
"folderColorRgb": "A String", # Folder color as an RGB hex string if the file is a folder or a shortcut to a folder. The list of supported colors is available in the folderColorPalette field of the About resource. If an unsupported color is specified, it will be changed to the closest color in the palette.
"fullFileExtension": "A String", # Output only. The full file extension; extracted from the title. May contain multiple concatenated extensions, such as "tar.gz". Removing an extension from the title does not clear this field; however, changing the extension on the title does update this field. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.
"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 field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.
"iconLink": "A String", # Output only. A link to the file's icon.
"id": "A String", # The ID of the file.
"imageMediaMetadata": { # Output only. Metadata about image media. This will only be present for image types, and its contents will depend on what can be parsed from the image content.
"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.
"date": "A String", # Output only. The date and time the photo was taken (EXIF format timestamp).
"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.
"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.
},
"indexableText": { # Indexable text attributes for the file (can only be written)
"text": "A String", # The text to be indexed for this file.
},
"isAppAuthorized": True or False, # Output only. Whether the file was created or opened by the requesting app.
"kind": "drive#file", # Output only. The type of file. This is always `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 a 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": "drive#labelField", # 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.
"isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made.
"kind": "drive#user", # Output only. This is always `drive#user`.
"permissionId": "A String", # Output only. The user's ID as visible in the permissions collection.
"picture": { # Output only. The user's profile picture.
"url": "A String", # Output Only. A URL that points to a profile picture of this user.
},
},
],
"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": "drive#label", # This is always `drive#label`
"revisionId": "A String", # The revision ID of the label.
},
],
},
"labels": { # A group of labels for the file.
"hidden": True or False, # Output only. Deprecated.
"modified": True or False, # Output only. Whether the file has been modified by this user.
"restricted": True or False, # Output only. Deprecated: Use `copyRequiresWriterPermission` instead.
"starred": True or False, # Whether this file is starred by the user.
"trashed": True or False, # Whether this file has been trashed. This label applies to all users accessing the file; however, only owners are allowed to see and untrash files.
"viewed": True or False, # Whether this file has been viewed by this user.
},
"lastModifyingUser": { # Information about a Drive user. # Output only. The last user to modify this 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.
"isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made.
"kind": "drive#user", # Output only. This is always `drive#user`.
"permissionId": "A String", # Output only. The user's ID as visible in the permissions collection.
"picture": { # Output only. The user's profile picture.
"url": "A String", # Output Only. A URL that points to a profile picture of this user.
},
},
"lastModifyingUserName": "A String", # Output only. Name of the last user to modify this file.
"lastViewedByMeDate": "A String", # Last time this file was viewed by the user (formatted RFC 3339 timestamp).
"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.
},
"markedViewedByMeDate": "A String", # Deprecated.
"md5Checksum": "A String", # Output only. An MD5 checksum for the content of this file. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.
"mimeType": "A String", # The MIME type of the file. This is only mutable on update when uploading new content. This field can be left blank, and the mimetype will be determined from the uploaded content's MIME type.
"modifiedByMeDate": "A String", # Last time this file was modified by the user (formatted RFC 3339 timestamp). Note that setting modifiedDate will also update the modifiedByMe date for the user which set the date.
"modifiedDate": "A String", # Last time this file was modified by anyone (formatted RFC 3339 timestamp). This is only mutable on update when the setModifiedDate parameter is set.
"openWithLinks": { # Output only. A map of the id of each of the user's apps to a link to open this file with that app. Only populated when the drive.apps.readonly scope is used.
"a_key": "A String",
},
"originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the `title` field. This is only available for files with binary content in Google Drive.
"ownedByMe": True or False, # Output only. Whether the file is owned by the current user. Not populated for items in shared drives.
"ownerNames": [ # Output only. Name(s) of the owner(s) of this file. Not populated for items in shared drives.
"A String",
],
"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.
"isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made.
"kind": "drive#user", # Output only. This is always `drive#user`.
"permissionId": "A String", # Output only. The user's ID as visible in the permissions collection.
"picture": { # Output only. The user's profile picture.
"url": "A String", # Output Only. A URL that points to a profile picture of this user.
},
},
],
"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 an insert 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 reference to a file's parent. A file can only have one parent folder; specifying multiple parents isn't supported. Some resource methods (such as `parents.get`) require a `parentId`. Use the `parents.list` method to retrieve the ID for a parent.
"id": "A String", # The ID of the parent.
"isRoot": True or False, # Output only. Whether or not the parent is the root folder.
"kind": "drive#parentReference", # Output only. This is always `drive#parentReference`.
"parentLink": "A String", # Output only. A link to the parent.
"selfLink": "A String", # Output only. A link back to this reference.
},
],
"permissionIds": [ # Output only. List of permission IDs for users with access to this file.
"A String",
],
"permissions": [ # Output only. The list of permissions for users with access to this 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. 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.
"additionalRoles": [ # Additional roles for this user. Only `commenter` is currently allowed, though more may be supported in the future.
"A String",
],
"authKey": "A String", # Output only. Deprecated.
"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.
"domain": "A String", # Output only. The domain name of the entity this permission refers to. This is an output-only field which is present when the permission type is `user`, `group` or `domain`.
"emailAddress": "A String", # Output only. The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is `user` or `group`.
"etag": "A String", # Output only. The ETag of the permission.
"expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: - They can only be set on user and group permissions - The date must be in the future - The date cannot be more than a year in the future - The date can only be set on drive.permissions.update or drive.permissions.patch requests
"id": "A String", # The ID of the user this permission refers to, and identical to the `permissionId` in the About and Files resources. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored.
"kind": "drive#permission", # Output only. This is always `drive#permission`.
"name": "A String", # Output only. The name for this 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.
{
"additionalRoles": [ # Output only. Additional roles for this user. Only `commenter` is currently possible, though more may be supported in the future.
"A String",
],
"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` * `reader`
},
],
"photoLink": "A String", # Output only. A link to the profile photo, if available.
"role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: * `owner` * `organizer` * `fileOrganizer` * `writer` * `reader`
"selfLink": "A String", # Output only. A link back to this permission.
"teamDrivePermissionDetails": [ # Output only. Deprecated: Use `permissionDetails` instead.
{
"additionalRoles": [ # Output only. Deprecated: Use `permissionDetails/additionalRoles` instead.
"A String",
],
"inherited": True or False, # Output only. Deprecated: Use `permissionDetails/inherited` instead.
"inheritedFrom": "A String", # Output only. Deprecated: Use `permissionDetails/inheritedFrom` instead.
"role": "A String", # Output only. Deprecated: Use `permissionDetails/role` instead.
"teamDrivePermissionType": "A String", # Output only. Deprecated: Use `permissionDetails/permissionType` instead.
},
],
"type": "A String", # The account type. Allowed values are: * `user` * `group` * `domain` * `anyone`
"value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored.
"view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. `published` is the only supported value.
"withLink": True or False, # Whether the link is required for this permission.
},
],
"properties": [ # The list of properties.
{ # A key-value pair attached to a file that is either public or private to an application. The following limits apply to file properties: * Maximum of 100 properties total per file * Maximum of 30 private properties per app * Maximum of 30 public properties * Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property Some resource methods (such as `properties.update`) require a `propertyKey`. Use the `properties.list` method to retrieve the key for a property.
"etag": "A String", # Output only. ETag of the property.
"key": "A String", # The key of this property.
"kind": "drive#property", # Output only. This is always `drive#property`.
"selfLink": "A String", # Output only. The link back to this property.
"value": "A String", # The value of this property.
"visibility": "A String", # The visibility of this property. Allowed values are PRIVATE (default) and PUBLIC. Private 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.
},
],
"quotaBytesUsed": "A String", # Output only. The number of quota bytes used by this file.
"resourceKey": "A String", # Output only. A key needed to access the item via a shared link.
"selfLink": "A String", # Output only. A link back to this file.
"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.
"shareable": True or False, # Output only. Deprecated: Use `capabilities/canShare` instead.
"shared": True or False, # Output only. Whether the file has been shared. Not populated for items in shared drives.
"sharedWithMeDate": "A String", # Time at which this file was shared with the user (formatted RFC 3339 timestamp).
"sharingUser": { # Information about a Drive user. # Output only. User that shared the item with the current user, if available.
"displayName": "A String", # Output only. A plain text displayable name for this user.
"emailAddress": "A String", # Output only. The email address of the user.
"isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made.
"kind": "drive#user", # Output only. This is always `drive#user`.
"permissionId": "A String", # Output only. The user's ID as visible in the permissions collection.
"picture": { # Output only. The user's profile picture.
"url": "A String", # Output Only. A URL that points to a profile picture of this user.
},
},
"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.insert` requests.
"targetId": "A String", # The ID of the file that this shortcut points to. Can only be set on `files.insert` 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.
},
"spaces": [ # Output only. The list of spaces which contain the file. Supported values are `drive`, `appDataFolder` and `photos`.
"A String",
],
"teamDriveId": "A String", # Output only. Deprecated: Use `driveId` instead.
"thumbnail": { # A thumbnail for the file. This will only be used if a standard thumbnail cannot be generated.
"image": "A String", # The URL-safe Base64 encoded bytes of the thumbnail image. It should conform to RFC 4648 section 5.
"mimeType": "A String", # The MIME type of the thumbnail.
},
"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), 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.
"title": "A String", # The title of this file. Note that for immutable items such as the top level folders of shared drives, My Drive root folder, and Application Data folder the title is constant.
"trashedDate": "A String", # The time that the item was trashed (formatted RFC 3339 timestamp). 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.
"isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made.
"kind": "drive#user", # Output only. This is always `drive#user`.
"permissionId": "A String", # Output only. The user's ID as visible in the permissions collection.
"picture": { # Output only. The user's profile picture.
"url": "A String", # Output Only. A URL that points to a profile picture of this user.
},
},
"userPermission": { # A permission for a file. A permission grants a user, group, domain, or the world access to a file or a folder hierarchy. 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. # Output only. The permissions for the authenticated user on this file.
"additionalRoles": [ # Additional roles for this user. Only `commenter` is currently allowed, though more may be supported in the future.
"A String",
],
"authKey": "A String", # Output only. Deprecated.
"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.
"domain": "A String", # Output only. The domain name of the entity this permission refers to. This is an output-only field which is present when the permission type is `user`, `group` or `domain`.
"emailAddress": "A String", # Output only. The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is `user` or `group`.
"etag": "A String", # Output only. The ETag of the permission.
"expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: - They can only be set on user and group permissions - The date must be in the future - The date cannot be more than a year in the future - The date can only be set on drive.permissions.update or drive.permissions.patch requests
"id": "A String", # The ID of the user this permission refers to, and identical to the `permissionId` in the About and Files resources. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored.
"kind": "drive#permission", # Output only. This is always `drive#permission`.
"name": "A String", # Output only. The name for this 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.
{
"additionalRoles": [ # Output only. Additional roles for this user. Only `commenter` is currently possible, though more may be supported in the future.
"A String",
],
"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` * `reader`
},
],
"photoLink": "A String", # Output only. A link to the profile photo, if available.
"role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: * `owner` * `organizer` * `fileOrganizer` * `writer` * `reader`
"selfLink": "A String", # Output only. A link back to this permission.
"teamDrivePermissionDetails": [ # Output only. Deprecated: Use `permissionDetails` instead.
{
"additionalRoles": [ # Output only. Deprecated: Use `permissionDetails/additionalRoles` instead.
"A String",
],
"inherited": True or False, # Output only. Deprecated: Use `permissionDetails/inherited` instead.
"inheritedFrom": "A String", # Output only. Deprecated: Use `permissionDetails/inheritedFrom` instead.
"role": "A String", # Output only. Deprecated: Use `permissionDetails/role` instead.
"teamDrivePermissionType": "A String", # Output only. Deprecated: Use `permissionDetails/permissionType` instead.
},
],
"type": "A String", # The account type. Allowed values are: * `user` * `group` * `domain` * `anyone`
"value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored.
"view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. `published` is the only supported value.
"withLink": True or False, # Whether the link is required for this permission.
},
"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 requesting user.
"videoMediaMetadata": { # Output only. Metadata about video media. This will only be present for video types.
"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.
},
"webContentLink": "A String", # Output only. A link for downloading the content of the file in a browser using cookie based authentication. In cases where the content is shared publicly, the content can be downloaded without any credentials.
"webViewLink": "A String", # Output only. A link only available on public folders for viewing their static web assets (HTML, CSS, JS, etc) via Google Drive's Website Hosting.
"writersCanShare": True or False, # Whether writers can share the document with other users. Not populated for items in shared drives.
}
addParents: string, Comma-separated list of parent IDs to add.
convert: boolean, Deprecated: This parameter has no function.
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.
modifiedDateBehavior: string, Determines the behavior in which `modifiedDate` is updated. This overrides `setModifiedDate`.
Allowed values
fromBody - Set `modifiedDate` to the value provided in the body of the request. No change if no value was provided.
fromBodyIfNeeded - Set `modifiedDate` to the value provided in the body of the request depending on other contents of the update.
fromBodyOrNow - Set modifiedDate to the value provided in the body of the request, or to the current time if no value was provided.
noChange - Maintain the previous value of `modifiedDate`.
now - Set `modifiedDate` to the current time.
nowIfNeeded - Set `modifiedDate` to the current time depending on contents of the update.
newRevision: boolean, Whether a blob upload should create a new revision. If false, the blob data in the current head revision is replaced. If true or not set, a new blob is created as head revision, and previous unpinned revisions are preserved for a short period of time. Pinned revisions are stored indefinitely, using additional storage quota, up to a maximum of 200 revisions. For details on how revisions are retained, see the [Drive Help Center](https://support.google.com/drive/answer/2409045). Note that this field is ignored if there is no payload in the request.
ocr: boolean, Whether to attempt OCR on .jpg, .png, .gif, or .pdf uploads.
ocrLanguage: string, If ocr is true, hints at the language to use. Valid values are BCP 47 codes.
pinned: boolean, Whether to pin the new revision. A file can have a maximum of 200 pinned revisions. Note that this field is ignored if there is no payload in the request.
removeParents: string, Comma-separated list of parent IDs to remove.
setModifiedDate: boolean, Whether to set the modified date using the value supplied in the request body. Setting this field to `true` is equivalent to `modifiedDateBehavior=fromBodyOrNow`, and `false` is equivalent to `modifiedDateBehavior=now`. To prevent any changes to the modified date set `modifiedDateBehavior=noChange`.
supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives.
supportsTeamDrives: boolean, Deprecated: Use `supportsAllDrives` instead.
timedTextLanguage: string, The language of the timed text.
timedTextTrackName: string, The timed text track name.
updateViewedDate: boolean, Whether to update the view date after successfully updating the file.
useContentAsIndexableText: boolean, Whether to use the content as indexable text.
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.
"alternateLink": "A String", # Output only. A link for opening the file in a relevant Google editor or viewer.
"appDataContents": True or False, # Output only. Whether this file is in the Application Data folder.
"canComment": True or False, # Output only. Deprecated: Use `capabilities/canComment` instead.
"canReadRevisions": True or False, # Output only. Deprecated: Use `capabilities/canReadRevisions` instead.
"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.
"canChangeRestrictedDownload": True or False, # Output only. Deprecated.
"canChangeSecurityUpdateEnabled": True or False, # Output only. Whether the current user can change the securityUpdateEnabled field on link share metadata.
"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, # Output only. Deprecated: 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, # Output only. Deprecated: Use `canMoveChildrenWithinDrive` instead.
"canMoveItemIntoTeamDrive": True or False, # Output only. Deprecated: 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, # Output only. Deprecated: 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, # Output only. Deprecated: Use `canMoveItemWithinDrive` instead.
"canMoveTeamDriveItem": True or False, # Output only. Deprecated: 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, # Output only. Deprecated: 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.
},
"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.
"isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made.
"kind": "drive#user", # Output only. This is always `drive#user`.
"permissionId": "A String", # Output only. The user's ID as visible in the permissions collection.
"picture": { # Output only. The user's profile picture.
"url": "A String", # Output Only. A URL that points to a profile picture of this user.
},
},
"restrictionDate": "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.
"copyable": True or False, # Output only. Deprecated: Use `capabilities/canCopy` instead.
"createdDate": "A String", # Create time for this file (formatted RFC 3339 timestamp).
"defaultOpenWithLink": "A String", # Output only. A link to open this file with the user's default app for this file. Only populated when the drive.apps.readonly scope is used.
"description": "A String", # A short description of the file.
"downloadUrl": "A String", # Output only. Short lived download URL for the file. This field is only populated for files with content stored in Google Drive; it is not populated for Google Docs or shortcut files.
"driveId": "A String", # Output only. ID of the shared drive the file resides in. Only populated for items in shared drives.
"editable": True or False, # Output only. Deprecated: Use `capabilities/canEdit` instead.
"embedLink": "A String", # Output only. A link for embedding the file.
"etag": "A String", # Output only. ETag of the file.
"explicitlyTrashed": True or False, # Output only. Whether this file has been explicitly trashed, as opposed to recursively trashed.
"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` with trailing text that does not appear to be part of the extension removed. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.
"fileSize": "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.
"folderColorRgb": "A String", # Folder color as an RGB hex string if the file is a folder or a shortcut to a folder. The list of supported colors is available in the folderColorPalette field of the About resource. If an unsupported color is specified, it will be changed to the closest color in the palette.
"fullFileExtension": "A String", # Output only. The full file extension; extracted from the title. May contain multiple concatenated extensions, such as "tar.gz". Removing an extension from the title does not clear this field; however, changing the extension on the title does update this field. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.
"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 field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.
"iconLink": "A String", # Output only. A link to the file's icon.
"id": "A String", # The ID of the file.
"imageMediaMetadata": { # Output only. Metadata about image media. This will only be present for image types, and its contents will depend on what can be parsed from the image content.
"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.
"date": "A String", # Output only. The date and time the photo was taken (EXIF format timestamp).
"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.
"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.
},
"indexableText": { # Indexable text attributes for the file (can only be written)
"text": "A String", # The text to be indexed for this file.
},
"isAppAuthorized": True or False, # Output only. Whether the file was created or opened by the requesting app.
"kind": "drive#file", # Output only. The type of file. This is always `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 a 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": "drive#labelField", # 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.
"isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made.
"kind": "drive#user", # Output only. This is always `drive#user`.
"permissionId": "A String", # Output only. The user's ID as visible in the permissions collection.
"picture": { # Output only. The user's profile picture.
"url": "A String", # Output Only. A URL that points to a profile picture of this user.
},
},
],
"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": "drive#label", # This is always `drive#label`
"revisionId": "A String", # The revision ID of the label.
},
],
},
"labels": { # A group of labels for the file.
"hidden": True or False, # Output only. Deprecated.
"modified": True or False, # Output only. Whether the file has been modified by this user.
"restricted": True or False, # Output only. Deprecated: Use `copyRequiresWriterPermission` instead.
"starred": True or False, # Whether this file is starred by the user.
"trashed": True or False, # Whether this file has been trashed. This label applies to all users accessing the file; however, only owners are allowed to see and untrash files.
"viewed": True or False, # Whether this file has been viewed by this user.
},
"lastModifyingUser": { # Information about a Drive user. # Output only. The last user to modify this 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.
"isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made.
"kind": "drive#user", # Output only. This is always `drive#user`.
"permissionId": "A String", # Output only. The user's ID as visible in the permissions collection.
"picture": { # Output only. The user's profile picture.
"url": "A String", # Output Only. A URL that points to a profile picture of this user.
},
},
"lastModifyingUserName": "A String", # Output only. Name of the last user to modify this file.
"lastViewedByMeDate": "A String", # Last time this file was viewed by the user (formatted RFC 3339 timestamp).
"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.
},
"markedViewedByMeDate": "A String", # Deprecated.
"md5Checksum": "A String", # Output only. An MD5 checksum for the content of this file. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.
"mimeType": "A String", # The MIME type of the file. This is only mutable on update when uploading new content. This field can be left blank, and the mimetype will be determined from the uploaded content's MIME type.
"modifiedByMeDate": "A String", # Last time this file was modified by the user (formatted RFC 3339 timestamp). Note that setting modifiedDate will also update the modifiedByMe date for the user which set the date.
"modifiedDate": "A String", # Last time this file was modified by anyone (formatted RFC 3339 timestamp). This is only mutable on update when the setModifiedDate parameter is set.
"openWithLinks": { # Output only. A map of the id of each of the user's apps to a link to open this file with that app. Only populated when the drive.apps.readonly scope is used.
"a_key": "A String",
},
"originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the `title` field. This is only available for files with binary content in Google Drive.
"ownedByMe": True or False, # Output only. Whether the file is owned by the current user. Not populated for items in shared drives.
"ownerNames": [ # Output only. Name(s) of the owner(s) of this file. Not populated for items in shared drives.
"A String",
],
"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.
"isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made.
"kind": "drive#user", # Output only. This is always `drive#user`.
"permissionId": "A String", # Output only. The user's ID as visible in the permissions collection.
"picture": { # Output only. The user's profile picture.
"url": "A String", # Output Only. A URL that points to a profile picture of this user.
},
},
],
"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 an insert 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 reference to a file's parent. A file can only have one parent folder; specifying multiple parents isn't supported. Some resource methods (such as `parents.get`) require a `parentId`. Use the `parents.list` method to retrieve the ID for a parent.
"id": "A String", # The ID of the parent.
"isRoot": True or False, # Output only. Whether or not the parent is the root folder.
"kind": "drive#parentReference", # Output only. This is always `drive#parentReference`.
"parentLink": "A String", # Output only. A link to the parent.
"selfLink": "A String", # Output only. A link back to this reference.
},
],
"permissionIds": [ # Output only. List of permission IDs for users with access to this file.
"A String",
],
"permissions": [ # Output only. The list of permissions for users with access to this 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. 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.
"additionalRoles": [ # Additional roles for this user. Only `commenter` is currently allowed, though more may be supported in the future.
"A String",
],
"authKey": "A String", # Output only. Deprecated.
"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.
"domain": "A String", # Output only. The domain name of the entity this permission refers to. This is an output-only field which is present when the permission type is `user`, `group` or `domain`.
"emailAddress": "A String", # Output only. The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is `user` or `group`.
"etag": "A String", # Output only. The ETag of the permission.
"expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: - They can only be set on user and group permissions - The date must be in the future - The date cannot be more than a year in the future - The date can only be set on drive.permissions.update or drive.permissions.patch requests
"id": "A String", # The ID of the user this permission refers to, and identical to the `permissionId` in the About and Files resources. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored.
"kind": "drive#permission", # Output only. This is always `drive#permission`.
"name": "A String", # Output only. The name for this 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.
{
"additionalRoles": [ # Output only. Additional roles for this user. Only `commenter` is currently possible, though more may be supported in the future.
"A String",
],
"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` * `reader`
},
],
"photoLink": "A String", # Output only. A link to the profile photo, if available.
"role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: * `owner` * `organizer` * `fileOrganizer` * `writer` * `reader`
"selfLink": "A String", # Output only. A link back to this permission.
"teamDrivePermissionDetails": [ # Output only. Deprecated: Use `permissionDetails` instead.
{
"additionalRoles": [ # Output only. Deprecated: Use `permissionDetails/additionalRoles` instead.
"A String",
],
"inherited": True or False, # Output only. Deprecated: Use `permissionDetails/inherited` instead.
"inheritedFrom": "A String", # Output only. Deprecated: Use `permissionDetails/inheritedFrom` instead.
"role": "A String", # Output only. Deprecated: Use `permissionDetails/role` instead.
"teamDrivePermissionType": "A String", # Output only. Deprecated: Use `permissionDetails/permissionType` instead.
},
],
"type": "A String", # The account type. Allowed values are: * `user` * `group` * `domain` * `anyone`
"value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored.
"view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. `published` is the only supported value.
"withLink": True or False, # Whether the link is required for this permission.
},
],
"properties": [ # The list of properties.
{ # A key-value pair attached to a file that is either public or private to an application. The following limits apply to file properties: * Maximum of 100 properties total per file * Maximum of 30 private properties per app * Maximum of 30 public properties * Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property Some resource methods (such as `properties.update`) require a `propertyKey`. Use the `properties.list` method to retrieve the key for a property.
"etag": "A String", # Output only. ETag of the property.
"key": "A String", # The key of this property.
"kind": "drive#property", # Output only. This is always `drive#property`.
"selfLink": "A String", # Output only. The link back to this property.
"value": "A String", # The value of this property.
"visibility": "A String", # The visibility of this property. Allowed values are PRIVATE (default) and PUBLIC. Private 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.
},
],
"quotaBytesUsed": "A String", # Output only. The number of quota bytes used by this file.
"resourceKey": "A String", # Output only. A key needed to access the item via a shared link.
"selfLink": "A String", # Output only. A link back to this file.
"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.
"shareable": True or False, # Output only. Deprecated: Use `capabilities/canShare` instead.
"shared": True or False, # Output only. Whether the file has been shared. Not populated for items in shared drives.
"sharedWithMeDate": "A String", # Time at which this file was shared with the user (formatted RFC 3339 timestamp).
"sharingUser": { # Information about a Drive user. # Output only. User that shared the item with the current user, if available.
"displayName": "A String", # Output only. A plain text displayable name for this user.
"emailAddress": "A String", # Output only. The email address of the user.
"isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made.
"kind": "drive#user", # Output only. This is always `drive#user`.
"permissionId": "A String", # Output only. The user's ID as visible in the permissions collection.
"picture": { # Output only. The user's profile picture.
"url": "A String", # Output Only. A URL that points to a profile picture of this user.
},
},
"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.insert` requests.
"targetId": "A String", # The ID of the file that this shortcut points to. Can only be set on `files.insert` 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.
},
"spaces": [ # Output only. The list of spaces which contain the file. Supported values are `drive`, `appDataFolder` and `photos`.
"A String",
],
"teamDriveId": "A String", # Output only. Deprecated: Use `driveId` instead.
"thumbnail": { # A thumbnail for the file. This will only be used if a standard thumbnail cannot be generated.
"image": "A String", # The URL-safe Base64 encoded bytes of the thumbnail image. It should conform to RFC 4648 section 5.
"mimeType": "A String", # The MIME type of the thumbnail.
},
"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), 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.
"title": "A String", # The title of this file. Note that for immutable items such as the top level folders of shared drives, My Drive root folder, and Application Data folder the title is constant.
"trashedDate": "A String", # The time that the item was trashed (formatted RFC 3339 timestamp). 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.
"isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made.
"kind": "drive#user", # Output only. This is always `drive#user`.
"permissionId": "A String", # Output only. The user's ID as visible in the permissions collection.
"picture": { # Output only. The user's profile picture.
"url": "A String", # Output Only. A URL that points to a profile picture of this user.
},
},
"userPermission": { # A permission for a file. A permission grants a user, group, domain, or the world access to a file or a folder hierarchy. 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. # Output only. The permissions for the authenticated user on this file.
"additionalRoles": [ # Additional roles for this user. Only `commenter` is currently allowed, though more may be supported in the future.
"A String",
],
"authKey": "A String", # Output only. Deprecated.
"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.
"domain": "A String", # Output only. The domain name of the entity this permission refers to. This is an output-only field which is present when the permission type is `user`, `group` or `domain`.
"emailAddress": "A String", # Output only. The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is `user` or `group`.
"etag": "A String", # Output only. The ETag of the permission.
"expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: - They can only be set on user and group permissions - The date must be in the future - The date cannot be more than a year in the future - The date can only be set on drive.permissions.update or drive.permissions.patch requests
"id": "A String", # The ID of the user this permission refers to, and identical to the `permissionId` in the About and Files resources. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored.
"kind": "drive#permission", # Output only. This is always `drive#permission`.
"name": "A String", # Output only. The name for this 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.
{
"additionalRoles": [ # Output only. Additional roles for this user. Only `commenter` is currently possible, though more may be supported in the future.
"A String",
],
"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` * `reader`
},
],
"photoLink": "A String", # Output only. A link to the profile photo, if available.
"role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: * `owner` * `organizer` * `fileOrganizer` * `writer` * `reader`
"selfLink": "A String", # Output only. A link back to this permission.
"teamDrivePermissionDetails": [ # Output only. Deprecated: Use `permissionDetails` instead.
{
"additionalRoles": [ # Output only. Deprecated: Use `permissionDetails/additionalRoles` instead.
"A String",
],
"inherited": True or False, # Output only. Deprecated: Use `permissionDetails/inherited` instead.
"inheritedFrom": "A String", # Output only. Deprecated: Use `permissionDetails/inheritedFrom` instead.
"role": "A String", # Output only. Deprecated: Use `permissionDetails/role` instead.
"teamDrivePermissionType": "A String", # Output only. Deprecated: Use `permissionDetails/permissionType` instead.
},
],
"type": "A String", # The account type. Allowed values are: * `user` * `group` * `domain` * `anyone`
"value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored.
"view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. `published` is the only supported value.
"withLink": True or False, # Whether the link is required for this permission.
},
"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 requesting user.
"videoMediaMetadata": { # Output only. Metadata about video media. This will only be present for video types.
"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.
},
"webContentLink": "A String", # Output only. A link for downloading the content of the file in a browser using cookie based authentication. In cases where the content is shared publicly, the content can be downloaded without any credentials.
"webViewLink": "A String", # Output only. A link only available on public folders for viewing their static web assets (HTML, CSS, JS, etc) via Google Drive's Website Hosting.
"writersCanShare": True or False, # Whether writers can share the document with other users. Not populated for items in shared drives.
}
touch(fileId, includeLabels=None, includePermissionsForView=None, supportsAllDrives=None, supportsTeamDrives=None, x__xgafv=None)
Set the file's updated time to the current server time.
Args:
fileId: string, The ID of the file to update. (required)
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.
"alternateLink": "A String", # Output only. A link for opening the file in a relevant Google editor or viewer.
"appDataContents": True or False, # Output only. Whether this file is in the Application Data folder.
"canComment": True or False, # Output only. Deprecated: Use `capabilities/canComment` instead.
"canReadRevisions": True or False, # Output only. Deprecated: Use `capabilities/canReadRevisions` instead.
"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.
"canChangeRestrictedDownload": True or False, # Output only. Deprecated.
"canChangeSecurityUpdateEnabled": True or False, # Output only. Whether the current user can change the securityUpdateEnabled field on link share metadata.
"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, # Output only. Deprecated: 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, # Output only. Deprecated: Use `canMoveChildrenWithinDrive` instead.
"canMoveItemIntoTeamDrive": True or False, # Output only. Deprecated: 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, # Output only. Deprecated: 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, # Output only. Deprecated: Use `canMoveItemWithinDrive` instead.
"canMoveTeamDriveItem": True or False, # Output only. Deprecated: 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, # Output only. Deprecated: 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.
},
"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.
"isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made.
"kind": "drive#user", # Output only. This is always `drive#user`.
"permissionId": "A String", # Output only. The user's ID as visible in the permissions collection.
"picture": { # Output only. The user's profile picture.
"url": "A String", # Output Only. A URL that points to a profile picture of this user.
},
},
"restrictionDate": "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.
"copyable": True or False, # Output only. Deprecated: Use `capabilities/canCopy` instead.
"createdDate": "A String", # Create time for this file (formatted RFC 3339 timestamp).
"defaultOpenWithLink": "A String", # Output only. A link to open this file with the user's default app for this file. Only populated when the drive.apps.readonly scope is used.
"description": "A String", # A short description of the file.
"downloadUrl": "A String", # Output only. Short lived download URL for the file. This field is only populated for files with content stored in Google Drive; it is not populated for Google Docs or shortcut files.
"driveId": "A String", # Output only. ID of the shared drive the file resides in. Only populated for items in shared drives.
"editable": True or False, # Output only. Deprecated: Use `capabilities/canEdit` instead.
"embedLink": "A String", # Output only. A link for embedding the file.
"etag": "A String", # Output only. ETag of the file.
"explicitlyTrashed": True or False, # Output only. Whether this file has been explicitly trashed, as opposed to recursively trashed.
"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` with trailing text that does not appear to be part of the extension removed. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.
"fileSize": "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.
"folderColorRgb": "A String", # Folder color as an RGB hex string if the file is a folder or a shortcut to a folder. The list of supported colors is available in the folderColorPalette field of the About resource. If an unsupported color is specified, it will be changed to the closest color in the palette.
"fullFileExtension": "A String", # Output only. The full file extension; extracted from the title. May contain multiple concatenated extensions, such as "tar.gz". Removing an extension from the title does not clear this field; however, changing the extension on the title does update this field. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.
"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 field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.
"iconLink": "A String", # Output only. A link to the file's icon.
"id": "A String", # The ID of the file.
"imageMediaMetadata": { # Output only. Metadata about image media. This will only be present for image types, and its contents will depend on what can be parsed from the image content.
"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.
"date": "A String", # Output only. The date and time the photo was taken (EXIF format timestamp).
"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.
"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.
},
"indexableText": { # Indexable text attributes for the file (can only be written)
"text": "A String", # The text to be indexed for this file.
},
"isAppAuthorized": True or False, # Output only. Whether the file was created or opened by the requesting app.
"kind": "drive#file", # Output only. The type of file. This is always `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 a 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": "drive#labelField", # 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.
"isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made.
"kind": "drive#user", # Output only. This is always `drive#user`.
"permissionId": "A String", # Output only. The user's ID as visible in the permissions collection.
"picture": { # Output only. The user's profile picture.
"url": "A String", # Output Only. A URL that points to a profile picture of this user.
},
},
],
"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": "drive#label", # This is always `drive#label`
"revisionId": "A String", # The revision ID of the label.
},
],
},
"labels": { # A group of labels for the file.
"hidden": True or False, # Output only. Deprecated.
"modified": True or False, # Output only. Whether the file has been modified by this user.
"restricted": True or False, # Output only. Deprecated: Use `copyRequiresWriterPermission` instead.
"starred": True or False, # Whether this file is starred by the user.
"trashed": True or False, # Whether this file has been trashed. This label applies to all users accessing the file; however, only owners are allowed to see and untrash files.
"viewed": True or False, # Whether this file has been viewed by this user.
},
"lastModifyingUser": { # Information about a Drive user. # Output only. The last user to modify this 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.
"isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made.
"kind": "drive#user", # Output only. This is always `drive#user`.
"permissionId": "A String", # Output only. The user's ID as visible in the permissions collection.
"picture": { # Output only. The user's profile picture.
"url": "A String", # Output Only. A URL that points to a profile picture of this user.
},
},
"lastModifyingUserName": "A String", # Output only. Name of the last user to modify this file.
"lastViewedByMeDate": "A String", # Last time this file was viewed by the user (formatted RFC 3339 timestamp).
"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.
},
"markedViewedByMeDate": "A String", # Deprecated.
"md5Checksum": "A String", # Output only. An MD5 checksum for the content of this file. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.
"mimeType": "A String", # The MIME type of the file. This is only mutable on update when uploading new content. This field can be left blank, and the mimetype will be determined from the uploaded content's MIME type.
"modifiedByMeDate": "A String", # Last time this file was modified by the user (formatted RFC 3339 timestamp). Note that setting modifiedDate will also update the modifiedByMe date for the user which set the date.
"modifiedDate": "A String", # Last time this file was modified by anyone (formatted RFC 3339 timestamp). This is only mutable on update when the setModifiedDate parameter is set.
"openWithLinks": { # Output only. A map of the id of each of the user's apps to a link to open this file with that app. Only populated when the drive.apps.readonly scope is used.
"a_key": "A String",
},
"originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the `title` field. This is only available for files with binary content in Google Drive.
"ownedByMe": True or False, # Output only. Whether the file is owned by the current user. Not populated for items in shared drives.
"ownerNames": [ # Output only. Name(s) of the owner(s) of this file. Not populated for items in shared drives.
"A String",
],
"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.
"isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made.
"kind": "drive#user", # Output only. This is always `drive#user`.
"permissionId": "A String", # Output only. The user's ID as visible in the permissions collection.
"picture": { # Output only. The user's profile picture.
"url": "A String", # Output Only. A URL that points to a profile picture of this user.
},
},
],
"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 an insert 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 reference to a file's parent. A file can only have one parent folder; specifying multiple parents isn't supported. Some resource methods (such as `parents.get`) require a `parentId`. Use the `parents.list` method to retrieve the ID for a parent.
"id": "A String", # The ID of the parent.
"isRoot": True or False, # Output only. Whether or not the parent is the root folder.
"kind": "drive#parentReference", # Output only. This is always `drive#parentReference`.
"parentLink": "A String", # Output only. A link to the parent.
"selfLink": "A String", # Output only. A link back to this reference.
},
],
"permissionIds": [ # Output only. List of permission IDs for users with access to this file.
"A String",
],
"permissions": [ # Output only. The list of permissions for users with access to this 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. 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.
"additionalRoles": [ # Additional roles for this user. Only `commenter` is currently allowed, though more may be supported in the future.
"A String",
],
"authKey": "A String", # Output only. Deprecated.
"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.
"domain": "A String", # Output only. The domain name of the entity this permission refers to. This is an output-only field which is present when the permission type is `user`, `group` or `domain`.
"emailAddress": "A String", # Output only. The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is `user` or `group`.
"etag": "A String", # Output only. The ETag of the permission.
"expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: - They can only be set on user and group permissions - The date must be in the future - The date cannot be more than a year in the future - The date can only be set on drive.permissions.update or drive.permissions.patch requests
"id": "A String", # The ID of the user this permission refers to, and identical to the `permissionId` in the About and Files resources. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored.
"kind": "drive#permission", # Output only. This is always `drive#permission`.
"name": "A String", # Output only. The name for this 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.
{
"additionalRoles": [ # Output only. Additional roles for this user. Only `commenter` is currently possible, though more may be supported in the future.
"A String",
],
"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` * `reader`
},
],
"photoLink": "A String", # Output only. A link to the profile photo, if available.
"role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: * `owner` * `organizer` * `fileOrganizer` * `writer` * `reader`
"selfLink": "A String", # Output only. A link back to this permission.
"teamDrivePermissionDetails": [ # Output only. Deprecated: Use `permissionDetails` instead.
{
"additionalRoles": [ # Output only. Deprecated: Use `permissionDetails/additionalRoles` instead.
"A String",
],
"inherited": True or False, # Output only. Deprecated: Use `permissionDetails/inherited` instead.
"inheritedFrom": "A String", # Output only. Deprecated: Use `permissionDetails/inheritedFrom` instead.
"role": "A String", # Output only. Deprecated: Use `permissionDetails/role` instead.
"teamDrivePermissionType": "A String", # Output only. Deprecated: Use `permissionDetails/permissionType` instead.
},
],
"type": "A String", # The account type. Allowed values are: * `user` * `group` * `domain` * `anyone`
"value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored.
"view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. `published` is the only supported value.
"withLink": True or False, # Whether the link is required for this permission.
},
],
"properties": [ # The list of properties.
{ # A key-value pair attached to a file that is either public or private to an application. The following limits apply to file properties: * Maximum of 100 properties total per file * Maximum of 30 private properties per app * Maximum of 30 public properties * Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property Some resource methods (such as `properties.update`) require a `propertyKey`. Use the `properties.list` method to retrieve the key for a property.
"etag": "A String", # Output only. ETag of the property.
"key": "A String", # The key of this property.
"kind": "drive#property", # Output only. This is always `drive#property`.
"selfLink": "A String", # Output only. The link back to this property.
"value": "A String", # The value of this property.
"visibility": "A String", # The visibility of this property. Allowed values are PRIVATE (default) and PUBLIC. Private 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.
},
],
"quotaBytesUsed": "A String", # Output only. The number of quota bytes used by this file.
"resourceKey": "A String", # Output only. A key needed to access the item via a shared link.
"selfLink": "A String", # Output only. A link back to this file.
"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.
"shareable": True or False, # Output only. Deprecated: Use `capabilities/canShare` instead.
"shared": True or False, # Output only. Whether the file has been shared. Not populated for items in shared drives.
"sharedWithMeDate": "A String", # Time at which this file was shared with the user (formatted RFC 3339 timestamp).
"sharingUser": { # Information about a Drive user. # Output only. User that shared the item with the current user, if available.
"displayName": "A String", # Output only. A plain text displayable name for this user.
"emailAddress": "A String", # Output only. The email address of the user.
"isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made.
"kind": "drive#user", # Output only. This is always `drive#user`.
"permissionId": "A String", # Output only. The user's ID as visible in the permissions collection.
"picture": { # Output only. The user's profile picture.
"url": "A String", # Output Only. A URL that points to a profile picture of this user.
},
},
"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.insert` requests.
"targetId": "A String", # The ID of the file that this shortcut points to. Can only be set on `files.insert` 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.
},
"spaces": [ # Output only. The list of spaces which contain the file. Supported values are `drive`, `appDataFolder` and `photos`.
"A String",
],
"teamDriveId": "A String", # Output only. Deprecated: Use `driveId` instead.
"thumbnail": { # A thumbnail for the file. This will only be used if a standard thumbnail cannot be generated.
"image": "A String", # The URL-safe Base64 encoded bytes of the thumbnail image. It should conform to RFC 4648 section 5.
"mimeType": "A String", # The MIME type of the thumbnail.
},
"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), 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.
"title": "A String", # The title of this file. Note that for immutable items such as the top level folders of shared drives, My Drive root folder, and Application Data folder the title is constant.
"trashedDate": "A String", # The time that the item was trashed (formatted RFC 3339 timestamp). 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.
"isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made.
"kind": "drive#user", # Output only. This is always `drive#user`.
"permissionId": "A String", # Output only. The user's ID as visible in the permissions collection.
"picture": { # Output only. The user's profile picture.
"url": "A String", # Output Only. A URL that points to a profile picture of this user.
},
},
"userPermission": { # A permission for a file. A permission grants a user, group, domain, or the world access to a file or a folder hierarchy. 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. # Output only. The permissions for the authenticated user on this file.
"additionalRoles": [ # Additional roles for this user. Only `commenter` is currently allowed, though more may be supported in the future.
"A String",
],
"authKey": "A String", # Output only. Deprecated.
"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.
"domain": "A String", # Output only. The domain name of the entity this permission refers to. This is an output-only field which is present when the permission type is `user`, `group` or `domain`.
"emailAddress": "A String", # Output only. The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is `user` or `group`.
"etag": "A String", # Output only. The ETag of the permission.
"expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: - They can only be set on user and group permissions - The date must be in the future - The date cannot be more than a year in the future - The date can only be set on drive.permissions.update or drive.permissions.patch requests
"id": "A String", # The ID of the user this permission refers to, and identical to the `permissionId` in the About and Files resources. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored.
"kind": "drive#permission", # Output only. This is always `drive#permission`.
"name": "A String", # Output only. The name for this 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.
{
"additionalRoles": [ # Output only. Additional roles for this user. Only `commenter` is currently possible, though more may be supported in the future.
"A String",
],
"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` * `reader`
},
],
"photoLink": "A String", # Output only. A link to the profile photo, if available.
"role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: * `owner` * `organizer` * `fileOrganizer` * `writer` * `reader`
"selfLink": "A String", # Output only. A link back to this permission.
"teamDrivePermissionDetails": [ # Output only. Deprecated: Use `permissionDetails` instead.
{
"additionalRoles": [ # Output only. Deprecated: Use `permissionDetails/additionalRoles` instead.
"A String",
],
"inherited": True or False, # Output only. Deprecated: Use `permissionDetails/inherited` instead.
"inheritedFrom": "A String", # Output only. Deprecated: Use `permissionDetails/inheritedFrom` instead.
"role": "A String", # Output only. Deprecated: Use `permissionDetails/role` instead.
"teamDrivePermissionType": "A String", # Output only. Deprecated: Use `permissionDetails/permissionType` instead.
},
],
"type": "A String", # The account type. Allowed values are: * `user` * `group` * `domain` * `anyone`
"value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored.
"view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. `published` is the only supported value.
"withLink": True or False, # Whether the link is required for this permission.
},
"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 requesting user.
"videoMediaMetadata": { # Output only. Metadata about video media. This will only be present for video types.
"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.
},
"webContentLink": "A String", # Output only. A link for downloading the content of the file in a browser using cookie based authentication. In cases where the content is shared publicly, the content can be downloaded without any credentials.
"webViewLink": "A String", # Output only. A link only available on public folders for viewing their static web assets (HTML, CSS, JS, etc) via Google Drive's Website Hosting.
"writersCanShare": True or False, # Whether writers can share the document with other users. Not populated for items in shared drives.
}
trash(fileId, includeLabels=None, includePermissionsForView=None, supportsAllDrives=None, supportsTeamDrives=None, x__xgafv=None)
Moves a file to the trash. The currently authenticated user must own the file or be at least a `fileOrganizer` on the parent for shared drive files.
Args:
fileId: string, The ID of the file to trash. (required)
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.
"alternateLink": "A String", # Output only. A link for opening the file in a relevant Google editor or viewer.
"appDataContents": True or False, # Output only. Whether this file is in the Application Data folder.
"canComment": True or False, # Output only. Deprecated: Use `capabilities/canComment` instead.
"canReadRevisions": True or False, # Output only. Deprecated: Use `capabilities/canReadRevisions` instead.
"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.
"canChangeRestrictedDownload": True or False, # Output only. Deprecated.
"canChangeSecurityUpdateEnabled": True or False, # Output only. Whether the current user can change the securityUpdateEnabled field on link share metadata.
"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, # Output only. Deprecated: 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, # Output only. Deprecated: Use `canMoveChildrenWithinDrive` instead.
"canMoveItemIntoTeamDrive": True or False, # Output only. Deprecated: 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, # Output only. Deprecated: 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, # Output only. Deprecated: Use `canMoveItemWithinDrive` instead.
"canMoveTeamDriveItem": True or False, # Output only. Deprecated: 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, # Output only. Deprecated: 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.
},
"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.
"isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made.
"kind": "drive#user", # Output only. This is always `drive#user`.
"permissionId": "A String", # Output only. The user's ID as visible in the permissions collection.
"picture": { # Output only. The user's profile picture.
"url": "A String", # Output Only. A URL that points to a profile picture of this user.
},
},
"restrictionDate": "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.
"copyable": True or False, # Output only. Deprecated: Use `capabilities/canCopy` instead.
"createdDate": "A String", # Create time for this file (formatted RFC 3339 timestamp).
"defaultOpenWithLink": "A String", # Output only. A link to open this file with the user's default app for this file. Only populated when the drive.apps.readonly scope is used.
"description": "A String", # A short description of the file.
"downloadUrl": "A String", # Output only. Short lived download URL for the file. This field is only populated for files with content stored in Google Drive; it is not populated for Google Docs or shortcut files.
"driveId": "A String", # Output only. ID of the shared drive the file resides in. Only populated for items in shared drives.
"editable": True or False, # Output only. Deprecated: Use `capabilities/canEdit` instead.
"embedLink": "A String", # Output only. A link for embedding the file.
"etag": "A String", # Output only. ETag of the file.
"explicitlyTrashed": True or False, # Output only. Whether this file has been explicitly trashed, as opposed to recursively trashed.
"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` with trailing text that does not appear to be part of the extension removed. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.
"fileSize": "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.
"folderColorRgb": "A String", # Folder color as an RGB hex string if the file is a folder or a shortcut to a folder. The list of supported colors is available in the folderColorPalette field of the About resource. If an unsupported color is specified, it will be changed to the closest color in the palette.
"fullFileExtension": "A String", # Output only. The full file extension; extracted from the title. May contain multiple concatenated extensions, such as "tar.gz". Removing an extension from the title does not clear this field; however, changing the extension on the title does update this field. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.
"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 field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.
"iconLink": "A String", # Output only. A link to the file's icon.
"id": "A String", # The ID of the file.
"imageMediaMetadata": { # Output only. Metadata about image media. This will only be present for image types, and its contents will depend on what can be parsed from the image content.
"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.
"date": "A String", # Output only. The date and time the photo was taken (EXIF format timestamp).
"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.
"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.
},
"indexableText": { # Indexable text attributes for the file (can only be written)
"text": "A String", # The text to be indexed for this file.
},
"isAppAuthorized": True or False, # Output only. Whether the file was created or opened by the requesting app.
"kind": "drive#file", # Output only. The type of file. This is always `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 a 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": "drive#labelField", # 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.
"isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made.
"kind": "drive#user", # Output only. This is always `drive#user`.
"permissionId": "A String", # Output only. The user's ID as visible in the permissions collection.
"picture": { # Output only. The user's profile picture.
"url": "A String", # Output Only. A URL that points to a profile picture of this user.
},
},
],
"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": "drive#label", # This is always `drive#label`
"revisionId": "A String", # The revision ID of the label.
},
],
},
"labels": { # A group of labels for the file.
"hidden": True or False, # Output only. Deprecated.
"modified": True or False, # Output only. Whether the file has been modified by this user.
"restricted": True or False, # Output only. Deprecated: Use `copyRequiresWriterPermission` instead.
"starred": True or False, # Whether this file is starred by the user.
"trashed": True or False, # Whether this file has been trashed. This label applies to all users accessing the file; however, only owners are allowed to see and untrash files.
"viewed": True or False, # Whether this file has been viewed by this user.
},
"lastModifyingUser": { # Information about a Drive user. # Output only. The last user to modify this 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.
"isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made.
"kind": "drive#user", # Output only. This is always `drive#user`.
"permissionId": "A String", # Output only. The user's ID as visible in the permissions collection.
"picture": { # Output only. The user's profile picture.
"url": "A String", # Output Only. A URL that points to a profile picture of this user.
},
},
"lastModifyingUserName": "A String", # Output only. Name of the last user to modify this file.
"lastViewedByMeDate": "A String", # Last time this file was viewed by the user (formatted RFC 3339 timestamp).
"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.
},
"markedViewedByMeDate": "A String", # Deprecated.
"md5Checksum": "A String", # Output only. An MD5 checksum for the content of this file. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.
"mimeType": "A String", # The MIME type of the file. This is only mutable on update when uploading new content. This field can be left blank, and the mimetype will be determined from the uploaded content's MIME type.
"modifiedByMeDate": "A String", # Last time this file was modified by the user (formatted RFC 3339 timestamp). Note that setting modifiedDate will also update the modifiedByMe date for the user which set the date.
"modifiedDate": "A String", # Last time this file was modified by anyone (formatted RFC 3339 timestamp). This is only mutable on update when the setModifiedDate parameter is set.
"openWithLinks": { # Output only. A map of the id of each of the user's apps to a link to open this file with that app. Only populated when the drive.apps.readonly scope is used.
"a_key": "A String",
},
"originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the `title` field. This is only available for files with binary content in Google Drive.
"ownedByMe": True or False, # Output only. Whether the file is owned by the current user. Not populated for items in shared drives.
"ownerNames": [ # Output only. Name(s) of the owner(s) of this file. Not populated for items in shared drives.
"A String",
],
"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.
"isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made.
"kind": "drive#user", # Output only. This is always `drive#user`.
"permissionId": "A String", # Output only. The user's ID as visible in the permissions collection.
"picture": { # Output only. The user's profile picture.
"url": "A String", # Output Only. A URL that points to a profile picture of this user.
},
},
],
"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 an insert 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 reference to a file's parent. A file can only have one parent folder; specifying multiple parents isn't supported. Some resource methods (such as `parents.get`) require a `parentId`. Use the `parents.list` method to retrieve the ID for a parent.
"id": "A String", # The ID of the parent.
"isRoot": True or False, # Output only. Whether or not the parent is the root folder.
"kind": "drive#parentReference", # Output only. This is always `drive#parentReference`.
"parentLink": "A String", # Output only. A link to the parent.
"selfLink": "A String", # Output only. A link back to this reference.
},
],
"permissionIds": [ # Output only. List of permission IDs for users with access to this file.
"A String",
],
"permissions": [ # Output only. The list of permissions for users with access to this 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. 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.
"additionalRoles": [ # Additional roles for this user. Only `commenter` is currently allowed, though more may be supported in the future.
"A String",
],
"authKey": "A String", # Output only. Deprecated.
"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.
"domain": "A String", # Output only. The domain name of the entity this permission refers to. This is an output-only field which is present when the permission type is `user`, `group` or `domain`.
"emailAddress": "A String", # Output only. The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is `user` or `group`.
"etag": "A String", # Output only. The ETag of the permission.
"expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: - They can only be set on user and group permissions - The date must be in the future - The date cannot be more than a year in the future - The date can only be set on drive.permissions.update or drive.permissions.patch requests
"id": "A String", # The ID of the user this permission refers to, and identical to the `permissionId` in the About and Files resources. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored.
"kind": "drive#permission", # Output only. This is always `drive#permission`.
"name": "A String", # Output only. The name for this 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.
{
"additionalRoles": [ # Output only. Additional roles for this user. Only `commenter` is currently possible, though more may be supported in the future.
"A String",
],
"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` * `reader`
},
],
"photoLink": "A String", # Output only. A link to the profile photo, if available.
"role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: * `owner` * `organizer` * `fileOrganizer` * `writer` * `reader`
"selfLink": "A String", # Output only. A link back to this permission.
"teamDrivePermissionDetails": [ # Output only. Deprecated: Use `permissionDetails` instead.
{
"additionalRoles": [ # Output only. Deprecated: Use `permissionDetails/additionalRoles` instead.
"A String",
],
"inherited": True or False, # Output only. Deprecated: Use `permissionDetails/inherited` instead.
"inheritedFrom": "A String", # Output only. Deprecated: Use `permissionDetails/inheritedFrom` instead.
"role": "A String", # Output only. Deprecated: Use `permissionDetails/role` instead.
"teamDrivePermissionType": "A String", # Output only. Deprecated: Use `permissionDetails/permissionType` instead.
},
],
"type": "A String", # The account type. Allowed values are: * `user` * `group` * `domain` * `anyone`
"value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored.
"view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. `published` is the only supported value.
"withLink": True or False, # Whether the link is required for this permission.
},
],
"properties": [ # The list of properties.
{ # A key-value pair attached to a file that is either public or private to an application. The following limits apply to file properties: * Maximum of 100 properties total per file * Maximum of 30 private properties per app * Maximum of 30 public properties * Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property Some resource methods (such as `properties.update`) require a `propertyKey`. Use the `properties.list` method to retrieve the key for a property.
"etag": "A String", # Output only. ETag of the property.
"key": "A String", # The key of this property.
"kind": "drive#property", # Output only. This is always `drive#property`.
"selfLink": "A String", # Output only. The link back to this property.
"value": "A String", # The value of this property.
"visibility": "A String", # The visibility of this property. Allowed values are PRIVATE (default) and PUBLIC. Private 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.
},
],
"quotaBytesUsed": "A String", # Output only. The number of quota bytes used by this file.
"resourceKey": "A String", # Output only. A key needed to access the item via a shared link.
"selfLink": "A String", # Output only. A link back to this file.
"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.
"shareable": True or False, # Output only. Deprecated: Use `capabilities/canShare` instead.
"shared": True or False, # Output only. Whether the file has been shared. Not populated for items in shared drives.
"sharedWithMeDate": "A String", # Time at which this file was shared with the user (formatted RFC 3339 timestamp).
"sharingUser": { # Information about a Drive user. # Output only. User that shared the item with the current user, if available.
"displayName": "A String", # Output only. A plain text displayable name for this user.
"emailAddress": "A String", # Output only. The email address of the user.
"isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made.
"kind": "drive#user", # Output only. This is always `drive#user`.
"permissionId": "A String", # Output only. The user's ID as visible in the permissions collection.
"picture": { # Output only. The user's profile picture.
"url": "A String", # Output Only. A URL that points to a profile picture of this user.
},
},
"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.insert` requests.
"targetId": "A String", # The ID of the file that this shortcut points to. Can only be set on `files.insert` 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.
},
"spaces": [ # Output only. The list of spaces which contain the file. Supported values are `drive`, `appDataFolder` and `photos`.
"A String",
],
"teamDriveId": "A String", # Output only. Deprecated: Use `driveId` instead.
"thumbnail": { # A thumbnail for the file. This will only be used if a standard thumbnail cannot be generated.
"image": "A String", # The URL-safe Base64 encoded bytes of the thumbnail image. It should conform to RFC 4648 section 5.
"mimeType": "A String", # The MIME type of the thumbnail.
},
"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), 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.
"title": "A String", # The title of this file. Note that for immutable items such as the top level folders of shared drives, My Drive root folder, and Application Data folder the title is constant.
"trashedDate": "A String", # The time that the item was trashed (formatted RFC 3339 timestamp). 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.
"isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made.
"kind": "drive#user", # Output only. This is always `drive#user`.
"permissionId": "A String", # Output only. The user's ID as visible in the permissions collection.
"picture": { # Output only. The user's profile picture.
"url": "A String", # Output Only. A URL that points to a profile picture of this user.
},
},
"userPermission": { # A permission for a file. A permission grants a user, group, domain, or the world access to a file or a folder hierarchy. 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. # Output only. The permissions for the authenticated user on this file.
"additionalRoles": [ # Additional roles for this user. Only `commenter` is currently allowed, though more may be supported in the future.
"A String",
],
"authKey": "A String", # Output only. Deprecated.
"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.
"domain": "A String", # Output only. The domain name of the entity this permission refers to. This is an output-only field which is present when the permission type is `user`, `group` or `domain`.
"emailAddress": "A String", # Output only. The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is `user` or `group`.
"etag": "A String", # Output only. The ETag of the permission.
"expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: - They can only be set on user and group permissions - The date must be in the future - The date cannot be more than a year in the future - The date can only be set on drive.permissions.update or drive.permissions.patch requests
"id": "A String", # The ID of the user this permission refers to, and identical to the `permissionId` in the About and Files resources. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored.
"kind": "drive#permission", # Output only. This is always `drive#permission`.
"name": "A String", # Output only. The name for this 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.
{
"additionalRoles": [ # Output only. Additional roles for this user. Only `commenter` is currently possible, though more may be supported in the future.
"A String",
],
"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` * `reader`
},
],
"photoLink": "A String", # Output only. A link to the profile photo, if available.
"role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: * `owner` * `organizer` * `fileOrganizer` * `writer` * `reader`
"selfLink": "A String", # Output only. A link back to this permission.
"teamDrivePermissionDetails": [ # Output only. Deprecated: Use `permissionDetails` instead.
{
"additionalRoles": [ # Output only. Deprecated: Use `permissionDetails/additionalRoles` instead.
"A String",
],
"inherited": True or False, # Output only. Deprecated: Use `permissionDetails/inherited` instead.
"inheritedFrom": "A String", # Output only. Deprecated: Use `permissionDetails/inheritedFrom` instead.
"role": "A String", # Output only. Deprecated: Use `permissionDetails/role` instead.
"teamDrivePermissionType": "A String", # Output only. Deprecated: Use `permissionDetails/permissionType` instead.
},
],
"type": "A String", # The account type. Allowed values are: * `user` * `group` * `domain` * `anyone`
"value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored.
"view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. `published` is the only supported value.
"withLink": True or False, # Whether the link is required for this permission.
},
"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 requesting user.
"videoMediaMetadata": { # Output only. Metadata about video media. This will only be present for video types.
"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.
},
"webContentLink": "A String", # Output only. A link for downloading the content of the file in a browser using cookie based authentication. In cases where the content is shared publicly, the content can be downloaded without any credentials.
"webViewLink": "A String", # Output only. A link only available on public folders for viewing their static web assets (HTML, CSS, JS, etc) via Google Drive's Website Hosting.
"writersCanShare": True or False, # Whether writers can share the document with other users. Not populated for items in shared drives.
}
untrash(fileId, includeLabels=None, includePermissionsForView=None, supportsAllDrives=None, supportsTeamDrives=None, x__xgafv=None)
Restores a file from the trash. The currently authenticated user must own the file or be at least a `fileOrganizer` on the parent for shared drive files.
Args:
fileId: string, The ID of the file to untrash. (required)
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.
"alternateLink": "A String", # Output only. A link for opening the file in a relevant Google editor or viewer.
"appDataContents": True or False, # Output only. Whether this file is in the Application Data folder.
"canComment": True or False, # Output only. Deprecated: Use `capabilities/canComment` instead.
"canReadRevisions": True or False, # Output only. Deprecated: Use `capabilities/canReadRevisions` instead.
"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.
"canChangeRestrictedDownload": True or False, # Output only. Deprecated.
"canChangeSecurityUpdateEnabled": True or False, # Output only. Whether the current user can change the securityUpdateEnabled field on link share metadata.
"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, # Output only. Deprecated: 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, # Output only. Deprecated: Use `canMoveChildrenWithinDrive` instead.
"canMoveItemIntoTeamDrive": True or False, # Output only. Deprecated: 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, # Output only. Deprecated: 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, # Output only. Deprecated: Use `canMoveItemWithinDrive` instead.
"canMoveTeamDriveItem": True or False, # Output only. Deprecated: 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, # Output only. Deprecated: 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.
},
"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.
"isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made.
"kind": "drive#user", # Output only. This is always `drive#user`.
"permissionId": "A String", # Output only. The user's ID as visible in the permissions collection.
"picture": { # Output only. The user's profile picture.
"url": "A String", # Output Only. A URL that points to a profile picture of this user.
},
},
"restrictionDate": "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.
"copyable": True or False, # Output only. Deprecated: Use `capabilities/canCopy` instead.
"createdDate": "A String", # Create time for this file (formatted RFC 3339 timestamp).
"defaultOpenWithLink": "A String", # Output only. A link to open this file with the user's default app for this file. Only populated when the drive.apps.readonly scope is used.
"description": "A String", # A short description of the file.
"downloadUrl": "A String", # Output only. Short lived download URL for the file. This field is only populated for files with content stored in Google Drive; it is not populated for Google Docs or shortcut files.
"driveId": "A String", # Output only. ID of the shared drive the file resides in. Only populated for items in shared drives.
"editable": True or False, # Output only. Deprecated: Use `capabilities/canEdit` instead.
"embedLink": "A String", # Output only. A link for embedding the file.
"etag": "A String", # Output only. ETag of the file.
"explicitlyTrashed": True or False, # Output only. Whether this file has been explicitly trashed, as opposed to recursively trashed.
"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` with trailing text that does not appear to be part of the extension removed. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.
"fileSize": "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.
"folderColorRgb": "A String", # Folder color as an RGB hex string if the file is a folder or a shortcut to a folder. The list of supported colors is available in the folderColorPalette field of the About resource. If an unsupported color is specified, it will be changed to the closest color in the palette.
"fullFileExtension": "A String", # Output only. The full file extension; extracted from the title. May contain multiple concatenated extensions, such as "tar.gz". Removing an extension from the title does not clear this field; however, changing the extension on the title does update this field. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.
"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 field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.
"iconLink": "A String", # Output only. A link to the file's icon.
"id": "A String", # The ID of the file.
"imageMediaMetadata": { # Output only. Metadata about image media. This will only be present for image types, and its contents will depend on what can be parsed from the image content.
"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.
"date": "A String", # Output only. The date and time the photo was taken (EXIF format timestamp).
"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.
"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.
},
"indexableText": { # Indexable text attributes for the file (can only be written)
"text": "A String", # The text to be indexed for this file.
},
"isAppAuthorized": True or False, # Output only. Whether the file was created or opened by the requesting app.
"kind": "drive#file", # Output only. The type of file. This is always `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 a 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": "drive#labelField", # 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.
"isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made.
"kind": "drive#user", # Output only. This is always `drive#user`.
"permissionId": "A String", # Output only. The user's ID as visible in the permissions collection.
"picture": { # Output only. The user's profile picture.
"url": "A String", # Output Only. A URL that points to a profile picture of this user.
},
},
],
"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": "drive#label", # This is always `drive#label`
"revisionId": "A String", # The revision ID of the label.
},
],
},
"labels": { # A group of labels for the file.
"hidden": True or False, # Output only. Deprecated.
"modified": True or False, # Output only. Whether the file has been modified by this user.
"restricted": True or False, # Output only. Deprecated: Use `copyRequiresWriterPermission` instead.
"starred": True or False, # Whether this file is starred by the user.
"trashed": True or False, # Whether this file has been trashed. This label applies to all users accessing the file; however, only owners are allowed to see and untrash files.
"viewed": True or False, # Whether this file has been viewed by this user.
},
"lastModifyingUser": { # Information about a Drive user. # Output only. The last user to modify this 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.
"isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made.
"kind": "drive#user", # Output only. This is always `drive#user`.
"permissionId": "A String", # Output only. The user's ID as visible in the permissions collection.
"picture": { # Output only. The user's profile picture.
"url": "A String", # Output Only. A URL that points to a profile picture of this user.
},
},
"lastModifyingUserName": "A String", # Output only. Name of the last user to modify this file.
"lastViewedByMeDate": "A String", # Last time this file was viewed by the user (formatted RFC 3339 timestamp).
"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.
},
"markedViewedByMeDate": "A String", # Deprecated.
"md5Checksum": "A String", # Output only. An MD5 checksum for the content of this file. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.
"mimeType": "A String", # The MIME type of the file. This is only mutable on update when uploading new content. This field can be left blank, and the mimetype will be determined from the uploaded content's MIME type.
"modifiedByMeDate": "A String", # Last time this file was modified by the user (formatted RFC 3339 timestamp). Note that setting modifiedDate will also update the modifiedByMe date for the user which set the date.
"modifiedDate": "A String", # Last time this file was modified by anyone (formatted RFC 3339 timestamp). This is only mutable on update when the setModifiedDate parameter is set.
"openWithLinks": { # Output only. A map of the id of each of the user's apps to a link to open this file with that app. Only populated when the drive.apps.readonly scope is used.
"a_key": "A String",
},
"originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the `title` field. This is only available for files with binary content in Google Drive.
"ownedByMe": True or False, # Output only. Whether the file is owned by the current user. Not populated for items in shared drives.
"ownerNames": [ # Output only. Name(s) of the owner(s) of this file. Not populated for items in shared drives.
"A String",
],
"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.
"isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made.
"kind": "drive#user", # Output only. This is always `drive#user`.
"permissionId": "A String", # Output only. The user's ID as visible in the permissions collection.
"picture": { # Output only. The user's profile picture.
"url": "A String", # Output Only. A URL that points to a profile picture of this user.
},
},
],
"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 an insert 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 reference to a file's parent. A file can only have one parent folder; specifying multiple parents isn't supported. Some resource methods (such as `parents.get`) require a `parentId`. Use the `parents.list` method to retrieve the ID for a parent.
"id": "A String", # The ID of the parent.
"isRoot": True or False, # Output only. Whether or not the parent is the root folder.
"kind": "drive#parentReference", # Output only. This is always `drive#parentReference`.
"parentLink": "A String", # Output only. A link to the parent.
"selfLink": "A String", # Output only. A link back to this reference.
},
],
"permissionIds": [ # Output only. List of permission IDs for users with access to this file.
"A String",
],
"permissions": [ # Output only. The list of permissions for users with access to this 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. 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.
"additionalRoles": [ # Additional roles for this user. Only `commenter` is currently allowed, though more may be supported in the future.
"A String",
],
"authKey": "A String", # Output only. Deprecated.
"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.
"domain": "A String", # Output only. The domain name of the entity this permission refers to. This is an output-only field which is present when the permission type is `user`, `group` or `domain`.
"emailAddress": "A String", # Output only. The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is `user` or `group`.
"etag": "A String", # Output only. The ETag of the permission.
"expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: - They can only be set on user and group permissions - The date must be in the future - The date cannot be more than a year in the future - The date can only be set on drive.permissions.update or drive.permissions.patch requests
"id": "A String", # The ID of the user this permission refers to, and identical to the `permissionId` in the About and Files resources. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored.
"kind": "drive#permission", # Output only. This is always `drive#permission`.
"name": "A String", # Output only. The name for this 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.
{
"additionalRoles": [ # Output only. Additional roles for this user. Only `commenter` is currently possible, though more may be supported in the future.
"A String",
],
"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` * `reader`
},
],
"photoLink": "A String", # Output only. A link to the profile photo, if available.
"role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: * `owner` * `organizer` * `fileOrganizer` * `writer` * `reader`
"selfLink": "A String", # Output only. A link back to this permission.
"teamDrivePermissionDetails": [ # Output only. Deprecated: Use `permissionDetails` instead.
{
"additionalRoles": [ # Output only. Deprecated: Use `permissionDetails/additionalRoles` instead.
"A String",
],
"inherited": True or False, # Output only. Deprecated: Use `permissionDetails/inherited` instead.
"inheritedFrom": "A String", # Output only. Deprecated: Use `permissionDetails/inheritedFrom` instead.
"role": "A String", # Output only. Deprecated: Use `permissionDetails/role` instead.
"teamDrivePermissionType": "A String", # Output only. Deprecated: Use `permissionDetails/permissionType` instead.
},
],
"type": "A String", # The account type. Allowed values are: * `user` * `group` * `domain` * `anyone`
"value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored.
"view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. `published` is the only supported value.
"withLink": True or False, # Whether the link is required for this permission.
},
],
"properties": [ # The list of properties.
{ # A key-value pair attached to a file that is either public or private to an application. The following limits apply to file properties: * Maximum of 100 properties total per file * Maximum of 30 private properties per app * Maximum of 30 public properties * Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property Some resource methods (such as `properties.update`) require a `propertyKey`. Use the `properties.list` method to retrieve the key for a property.
"etag": "A String", # Output only. ETag of the property.
"key": "A String", # The key of this property.
"kind": "drive#property", # Output only. This is always `drive#property`.
"selfLink": "A String", # Output only. The link back to this property.
"value": "A String", # The value of this property.
"visibility": "A String", # The visibility of this property. Allowed values are PRIVATE (default) and PUBLIC. Private 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.
},
],
"quotaBytesUsed": "A String", # Output only. The number of quota bytes used by this file.
"resourceKey": "A String", # Output only. A key needed to access the item via a shared link.
"selfLink": "A String", # Output only. A link back to this file.
"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.
"shareable": True or False, # Output only. Deprecated: Use `capabilities/canShare` instead.
"shared": True or False, # Output only. Whether the file has been shared. Not populated for items in shared drives.
"sharedWithMeDate": "A String", # Time at which this file was shared with the user (formatted RFC 3339 timestamp).
"sharingUser": { # Information about a Drive user. # Output only. User that shared the item with the current user, if available.
"displayName": "A String", # Output only. A plain text displayable name for this user.
"emailAddress": "A String", # Output only. The email address of the user.
"isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made.
"kind": "drive#user", # Output only. This is always `drive#user`.
"permissionId": "A String", # Output only. The user's ID as visible in the permissions collection.
"picture": { # Output only. The user's profile picture.
"url": "A String", # Output Only. A URL that points to a profile picture of this user.
},
},
"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.insert` requests.
"targetId": "A String", # The ID of the file that this shortcut points to. Can only be set on `files.insert` 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.
},
"spaces": [ # Output only. The list of spaces which contain the file. Supported values are `drive`, `appDataFolder` and `photos`.
"A String",
],
"teamDriveId": "A String", # Output only. Deprecated: Use `driveId` instead.
"thumbnail": { # A thumbnail for the file. This will only be used if a standard thumbnail cannot be generated.
"image": "A String", # The URL-safe Base64 encoded bytes of the thumbnail image. It should conform to RFC 4648 section 5.
"mimeType": "A String", # The MIME type of the thumbnail.
},
"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), 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.
"title": "A String", # The title of this file. Note that for immutable items such as the top level folders of shared drives, My Drive root folder, and Application Data folder the title is constant.
"trashedDate": "A String", # The time that the item was trashed (formatted RFC 3339 timestamp). 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.
"isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made.
"kind": "drive#user", # Output only. This is always `drive#user`.
"permissionId": "A String", # Output only. The user's ID as visible in the permissions collection.
"picture": { # Output only. The user's profile picture.
"url": "A String", # Output Only. A URL that points to a profile picture of this user.
},
},
"userPermission": { # A permission for a file. A permission grants a user, group, domain, or the world access to a file or a folder hierarchy. 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. # Output only. The permissions for the authenticated user on this file.
"additionalRoles": [ # Additional roles for this user. Only `commenter` is currently allowed, though more may be supported in the future.
"A String",
],
"authKey": "A String", # Output only. Deprecated.
"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.
"domain": "A String", # Output only. The domain name of the entity this permission refers to. This is an output-only field which is present when the permission type is `user`, `group` or `domain`.
"emailAddress": "A String", # Output only. The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is `user` or `group`.
"etag": "A String", # Output only. The ETag of the permission.
"expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: - They can only be set on user and group permissions - The date must be in the future - The date cannot be more than a year in the future - The date can only be set on drive.permissions.update or drive.permissions.patch requests
"id": "A String", # The ID of the user this permission refers to, and identical to the `permissionId` in the About and Files resources. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored.
"kind": "drive#permission", # Output only. This is always `drive#permission`.
"name": "A String", # Output only. The name for this 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.
{
"additionalRoles": [ # Output only. Additional roles for this user. Only `commenter` is currently possible, though more may be supported in the future.
"A String",
],
"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` * `reader`
},
],
"photoLink": "A String", # Output only. A link to the profile photo, if available.
"role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: * `owner` * `organizer` * `fileOrganizer` * `writer` * `reader`
"selfLink": "A String", # Output only. A link back to this permission.
"teamDrivePermissionDetails": [ # Output only. Deprecated: Use `permissionDetails` instead.
{
"additionalRoles": [ # Output only. Deprecated: Use `permissionDetails/additionalRoles` instead.
"A String",
],
"inherited": True or False, # Output only. Deprecated: Use `permissionDetails/inherited` instead.
"inheritedFrom": "A String", # Output only. Deprecated: Use `permissionDetails/inheritedFrom` instead.
"role": "A String", # Output only. Deprecated: Use `permissionDetails/role` instead.
"teamDrivePermissionType": "A String", # Output only. Deprecated: Use `permissionDetails/permissionType` instead.
},
],
"type": "A String", # The account type. Allowed values are: * `user` * `group` * `domain` * `anyone`
"value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored.
"view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. `published` is the only supported value.
"withLink": True or False, # Whether the link is required for this permission.
},
"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 requesting user.
"videoMediaMetadata": { # Output only. Metadata about video media. This will only be present for video types.
"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.
},
"webContentLink": "A String", # Output only. A link for downloading the content of the file in a browser using cookie based authentication. In cases where the content is shared publicly, the content can be downloaded without any credentials.
"webViewLink": "A String", # Output only. A link only available on public folders for viewing their static web assets (HTML, CSS, JS, etc) via Google Drive's Website Hosting.
"writersCanShare": True or False, # Whether writers can share the document with other users. Not populated for items in shared drives.
}
update(fileId, addParents=None, body=None, convert=None, enforceSingleParent=None, includeLabels=None, includePermissionsForView=None, media_body=None, media_mime_type=None, modifiedDateBehavior=None, newRevision=None, ocr=None, ocrLanguage=None, pinned=None, removeParents=None, setModifiedDate=None, supportsAllDrives=None, supportsTeamDrives=None, timedTextLanguage=None, timedTextTrackName=None, updateViewedDate=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 to update. (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.
"alternateLink": "A String", # Output only. A link for opening the file in a relevant Google editor or viewer.
"appDataContents": True or False, # Output only. Whether this file is in the Application Data folder.
"canComment": True or False, # Output only. Deprecated: Use `capabilities/canComment` instead.
"canReadRevisions": True or False, # Output only. Deprecated: Use `capabilities/canReadRevisions` instead.
"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.
"canChangeRestrictedDownload": True or False, # Output only. Deprecated.
"canChangeSecurityUpdateEnabled": True or False, # Output only. Whether the current user can change the securityUpdateEnabled field on link share metadata.
"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, # Output only. Deprecated: 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, # Output only. Deprecated: Use `canMoveChildrenWithinDrive` instead.
"canMoveItemIntoTeamDrive": True or False, # Output only. Deprecated: 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, # Output only. Deprecated: 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, # Output only. Deprecated: Use `canMoveItemWithinDrive` instead.
"canMoveTeamDriveItem": True or False, # Output only. Deprecated: 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, # Output only. Deprecated: 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.
},
"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.
"isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made.
"kind": "drive#user", # Output only. This is always `drive#user`.
"permissionId": "A String", # Output only. The user's ID as visible in the permissions collection.
"picture": { # Output only. The user's profile picture.
"url": "A String", # Output Only. A URL that points to a profile picture of this user.
},
},
"restrictionDate": "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.
"copyable": True or False, # Output only. Deprecated: Use `capabilities/canCopy` instead.
"createdDate": "A String", # Create time for this file (formatted RFC 3339 timestamp).
"defaultOpenWithLink": "A String", # Output only. A link to open this file with the user's default app for this file. Only populated when the drive.apps.readonly scope is used.
"description": "A String", # A short description of the file.
"downloadUrl": "A String", # Output only. Short lived download URL for the file. This field is only populated for files with content stored in Google Drive; it is not populated for Google Docs or shortcut files.
"driveId": "A String", # Output only. ID of the shared drive the file resides in. Only populated for items in shared drives.
"editable": True or False, # Output only. Deprecated: Use `capabilities/canEdit` instead.
"embedLink": "A String", # Output only. A link for embedding the file.
"etag": "A String", # Output only. ETag of the file.
"explicitlyTrashed": True or False, # Output only. Whether this file has been explicitly trashed, as opposed to recursively trashed.
"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` with trailing text that does not appear to be part of the extension removed. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.
"fileSize": "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.
"folderColorRgb": "A String", # Folder color as an RGB hex string if the file is a folder or a shortcut to a folder. The list of supported colors is available in the folderColorPalette field of the About resource. If an unsupported color is specified, it will be changed to the closest color in the palette.
"fullFileExtension": "A String", # Output only. The full file extension; extracted from the title. May contain multiple concatenated extensions, such as "tar.gz". Removing an extension from the title does not clear this field; however, changing the extension on the title does update this field. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.
"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 field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.
"iconLink": "A String", # Output only. A link to the file's icon.
"id": "A String", # The ID of the file.
"imageMediaMetadata": { # Output only. Metadata about image media. This will only be present for image types, and its contents will depend on what can be parsed from the image content.
"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.
"date": "A String", # Output only. The date and time the photo was taken (EXIF format timestamp).
"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.
"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.
},
"indexableText": { # Indexable text attributes for the file (can only be written)
"text": "A String", # The text to be indexed for this file.
},
"isAppAuthorized": True or False, # Output only. Whether the file was created or opened by the requesting app.
"kind": "drive#file", # Output only. The type of file. This is always `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 a 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": "drive#labelField", # 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.
"isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made.
"kind": "drive#user", # Output only. This is always `drive#user`.
"permissionId": "A String", # Output only. The user's ID as visible in the permissions collection.
"picture": { # Output only. The user's profile picture.
"url": "A String", # Output Only. A URL that points to a profile picture of this user.
},
},
],
"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": "drive#label", # This is always `drive#label`
"revisionId": "A String", # The revision ID of the label.
},
],
},
"labels": { # A group of labels for the file.
"hidden": True or False, # Output only. Deprecated.
"modified": True or False, # Output only. Whether the file has been modified by this user.
"restricted": True or False, # Output only. Deprecated: Use `copyRequiresWriterPermission` instead.
"starred": True or False, # Whether this file is starred by the user.
"trashed": True or False, # Whether this file has been trashed. This label applies to all users accessing the file; however, only owners are allowed to see and untrash files.
"viewed": True or False, # Whether this file has been viewed by this user.
},
"lastModifyingUser": { # Information about a Drive user. # Output only. The last user to modify this 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.
"isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made.
"kind": "drive#user", # Output only. This is always `drive#user`.
"permissionId": "A String", # Output only. The user's ID as visible in the permissions collection.
"picture": { # Output only. The user's profile picture.
"url": "A String", # Output Only. A URL that points to a profile picture of this user.
},
},
"lastModifyingUserName": "A String", # Output only. Name of the last user to modify this file.
"lastViewedByMeDate": "A String", # Last time this file was viewed by the user (formatted RFC 3339 timestamp).
"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.
},
"markedViewedByMeDate": "A String", # Deprecated.
"md5Checksum": "A String", # Output only. An MD5 checksum for the content of this file. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.
"mimeType": "A String", # The MIME type of the file. This is only mutable on update when uploading new content. This field can be left blank, and the mimetype will be determined from the uploaded content's MIME type.
"modifiedByMeDate": "A String", # Last time this file was modified by the user (formatted RFC 3339 timestamp). Note that setting modifiedDate will also update the modifiedByMe date for the user which set the date.
"modifiedDate": "A String", # Last time this file was modified by anyone (formatted RFC 3339 timestamp). This is only mutable on update when the setModifiedDate parameter is set.
"openWithLinks": { # Output only. A map of the id of each of the user's apps to a link to open this file with that app. Only populated when the drive.apps.readonly scope is used.
"a_key": "A String",
},
"originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the `title` field. This is only available for files with binary content in Google Drive.
"ownedByMe": True or False, # Output only. Whether the file is owned by the current user. Not populated for items in shared drives.
"ownerNames": [ # Output only. Name(s) of the owner(s) of this file. Not populated for items in shared drives.
"A String",
],
"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.
"isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made.
"kind": "drive#user", # Output only. This is always `drive#user`.
"permissionId": "A String", # Output only. The user's ID as visible in the permissions collection.
"picture": { # Output only. The user's profile picture.
"url": "A String", # Output Only. A URL that points to a profile picture of this user.
},
},
],
"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 an insert 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 reference to a file's parent. A file can only have one parent folder; specifying multiple parents isn't supported. Some resource methods (such as `parents.get`) require a `parentId`. Use the `parents.list` method to retrieve the ID for a parent.
"id": "A String", # The ID of the parent.
"isRoot": True or False, # Output only. Whether or not the parent is the root folder.
"kind": "drive#parentReference", # Output only. This is always `drive#parentReference`.
"parentLink": "A String", # Output only. A link to the parent.
"selfLink": "A String", # Output only. A link back to this reference.
},
],
"permissionIds": [ # Output only. List of permission IDs for users with access to this file.
"A String",
],
"permissions": [ # Output only. The list of permissions for users with access to this 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. 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.
"additionalRoles": [ # Additional roles for this user. Only `commenter` is currently allowed, though more may be supported in the future.
"A String",
],
"authKey": "A String", # Output only. Deprecated.
"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.
"domain": "A String", # Output only. The domain name of the entity this permission refers to. This is an output-only field which is present when the permission type is `user`, `group` or `domain`.
"emailAddress": "A String", # Output only. The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is `user` or `group`.
"etag": "A String", # Output only. The ETag of the permission.
"expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: - They can only be set on user and group permissions - The date must be in the future - The date cannot be more than a year in the future - The date can only be set on drive.permissions.update or drive.permissions.patch requests
"id": "A String", # The ID of the user this permission refers to, and identical to the `permissionId` in the About and Files resources. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored.
"kind": "drive#permission", # Output only. This is always `drive#permission`.
"name": "A String", # Output only. The name for this 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.
{
"additionalRoles": [ # Output only. Additional roles for this user. Only `commenter` is currently possible, though more may be supported in the future.
"A String",
],
"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` * `reader`
},
],
"photoLink": "A String", # Output only. A link to the profile photo, if available.
"role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: * `owner` * `organizer` * `fileOrganizer` * `writer` * `reader`
"selfLink": "A String", # Output only. A link back to this permission.
"teamDrivePermissionDetails": [ # Output only. Deprecated: Use `permissionDetails` instead.
{
"additionalRoles": [ # Output only. Deprecated: Use `permissionDetails/additionalRoles` instead.
"A String",
],
"inherited": True or False, # Output only. Deprecated: Use `permissionDetails/inherited` instead.
"inheritedFrom": "A String", # Output only. Deprecated: Use `permissionDetails/inheritedFrom` instead.
"role": "A String", # Output only. Deprecated: Use `permissionDetails/role` instead.
"teamDrivePermissionType": "A String", # Output only. Deprecated: Use `permissionDetails/permissionType` instead.
},
],
"type": "A String", # The account type. Allowed values are: * `user` * `group` * `domain` * `anyone`
"value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored.
"view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. `published` is the only supported value.
"withLink": True or False, # Whether the link is required for this permission.
},
],
"properties": [ # The list of properties.
{ # A key-value pair attached to a file that is either public or private to an application. The following limits apply to file properties: * Maximum of 100 properties total per file * Maximum of 30 private properties per app * Maximum of 30 public properties * Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property Some resource methods (such as `properties.update`) require a `propertyKey`. Use the `properties.list` method to retrieve the key for a property.
"etag": "A String", # Output only. ETag of the property.
"key": "A String", # The key of this property.
"kind": "drive#property", # Output only. This is always `drive#property`.
"selfLink": "A String", # Output only. The link back to this property.
"value": "A String", # The value of this property.
"visibility": "A String", # The visibility of this property. Allowed values are PRIVATE (default) and PUBLIC. Private 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.
},
],
"quotaBytesUsed": "A String", # Output only. The number of quota bytes used by this file.
"resourceKey": "A String", # Output only. A key needed to access the item via a shared link.
"selfLink": "A String", # Output only. A link back to this file.
"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.
"shareable": True or False, # Output only. Deprecated: Use `capabilities/canShare` instead.
"shared": True or False, # Output only. Whether the file has been shared. Not populated for items in shared drives.
"sharedWithMeDate": "A String", # Time at which this file was shared with the user (formatted RFC 3339 timestamp).
"sharingUser": { # Information about a Drive user. # Output only. User that shared the item with the current user, if available.
"displayName": "A String", # Output only. A plain text displayable name for this user.
"emailAddress": "A String", # Output only. The email address of the user.
"isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made.
"kind": "drive#user", # Output only. This is always `drive#user`.
"permissionId": "A String", # Output only. The user's ID as visible in the permissions collection.
"picture": { # Output only. The user's profile picture.
"url": "A String", # Output Only. A URL that points to a profile picture of this user.
},
},
"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.insert` requests.
"targetId": "A String", # The ID of the file that this shortcut points to. Can only be set on `files.insert` 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.
},
"spaces": [ # Output only. The list of spaces which contain the file. Supported values are `drive`, `appDataFolder` and `photos`.
"A String",
],
"teamDriveId": "A String", # Output only. Deprecated: Use `driveId` instead.
"thumbnail": { # A thumbnail for the file. This will only be used if a standard thumbnail cannot be generated.
"image": "A String", # The URL-safe Base64 encoded bytes of the thumbnail image. It should conform to RFC 4648 section 5.
"mimeType": "A String", # The MIME type of the thumbnail.
},
"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), 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.
"title": "A String", # The title of this file. Note that for immutable items such as the top level folders of shared drives, My Drive root folder, and Application Data folder the title is constant.
"trashedDate": "A String", # The time that the item was trashed (formatted RFC 3339 timestamp). 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.
"isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made.
"kind": "drive#user", # Output only. This is always `drive#user`.
"permissionId": "A String", # Output only. The user's ID as visible in the permissions collection.
"picture": { # Output only. The user's profile picture.
"url": "A String", # Output Only. A URL that points to a profile picture of this user.
},
},
"userPermission": { # A permission for a file. A permission grants a user, group, domain, or the world access to a file or a folder hierarchy. 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. # Output only. The permissions for the authenticated user on this file.
"additionalRoles": [ # Additional roles for this user. Only `commenter` is currently allowed, though more may be supported in the future.
"A String",
],
"authKey": "A String", # Output only. Deprecated.
"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.
"domain": "A String", # Output only. The domain name of the entity this permission refers to. This is an output-only field which is present when the permission type is `user`, `group` or `domain`.
"emailAddress": "A String", # Output only. The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is `user` or `group`.
"etag": "A String", # Output only. The ETag of the permission.
"expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: - They can only be set on user and group permissions - The date must be in the future - The date cannot be more than a year in the future - The date can only be set on drive.permissions.update or drive.permissions.patch requests
"id": "A String", # The ID of the user this permission refers to, and identical to the `permissionId` in the About and Files resources. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored.
"kind": "drive#permission", # Output only. This is always `drive#permission`.
"name": "A String", # Output only. The name for this 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.
{
"additionalRoles": [ # Output only. Additional roles for this user. Only `commenter` is currently possible, though more may be supported in the future.
"A String",
],
"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` * `reader`
},
],
"photoLink": "A String", # Output only. A link to the profile photo, if available.
"role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: * `owner` * `organizer` * `fileOrganizer` * `writer` * `reader`
"selfLink": "A String", # Output only. A link back to this permission.
"teamDrivePermissionDetails": [ # Output only. Deprecated: Use `permissionDetails` instead.
{
"additionalRoles": [ # Output only. Deprecated: Use `permissionDetails/additionalRoles` instead.
"A String",
],
"inherited": True or False, # Output only. Deprecated: Use `permissionDetails/inherited` instead.
"inheritedFrom": "A String", # Output only. Deprecated: Use `permissionDetails/inheritedFrom` instead.
"role": "A String", # Output only. Deprecated: Use `permissionDetails/role` instead.
"teamDrivePermissionType": "A String", # Output only. Deprecated: Use `permissionDetails/permissionType` instead.
},
],
"type": "A String", # The account type. Allowed values are: * `user` * `group` * `domain` * `anyone`
"value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored.
"view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. `published` is the only supported value.
"withLink": True or False, # Whether the link is required for this permission.
},
"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 requesting user.
"videoMediaMetadata": { # Output only. Metadata about video media. This will only be present for video types.
"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.
},
"webContentLink": "A String", # Output only. A link for downloading the content of the file in a browser using cookie based authentication. In cases where the content is shared publicly, the content can be downloaded without any credentials.
"webViewLink": "A String", # Output only. A link only available on public folders for viewing their static web assets (HTML, CSS, JS, etc) via Google Drive's Website Hosting.
"writersCanShare": True or False, # Whether writers can share the document with other users. Not populated for items in shared drives.
}
addParents: string, Comma-separated list of parent IDs to add.
convert: boolean, Deprecated: This parameter has no function.
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.
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.
modifiedDateBehavior: string, Determines the behavior in which `modifiedDate` is updated. This overrides `setModifiedDate`.
Allowed values
fromBody - Set `modifiedDate` to the value provided in the body of the request. No change if no value was provided.
fromBodyIfNeeded - Set `modifiedDate` to the value provided in the body of the request depending on other contents of the update.
fromBodyOrNow - Set modifiedDate to the value provided in the body of the request, or to the current time if no value was provided.
noChange - Maintain the previous value of `modifiedDate`.
now - Set `modifiedDate` to the current time.
nowIfNeeded - Set `modifiedDate` to the current time depending on contents of the update.
newRevision: boolean, Whether a blob upload should create a new revision. If false, the blob data in the current head revision is replaced. If true or not set, a new blob is created as head revision, and previous unpinned revisions are preserved for a short period of time. Pinned revisions are stored indefinitely, using additional storage quota, up to a maximum of 200 revisions. For details on how revisions are retained, see the [Drive Help Center](https://support.google.com/drive/answer/2409045).
ocr: boolean, Whether to attempt OCR on .jpg, .png, .gif, or .pdf uploads.
ocrLanguage: string, If ocr is true, hints at the language to use. Valid values are BCP 47 codes.
pinned: boolean, Whether to pin the new revision. A file can have a maximum of 200 pinned revisions.
removeParents: string, Comma-separated list of parent IDs to remove.
setModifiedDate: boolean, Whether to set the modified date using the value supplied in the request body. Setting this field to `true` is equivalent to `modifiedDateBehavior=fromBodyOrNow`, and `false` is equivalent to `modifiedDateBehavior=now`. To prevent any changes to the modified date set `modifiedDateBehavior=noChange`.
supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives.
supportsTeamDrives: boolean, Deprecated: Use `supportsAllDrives` instead.
timedTextLanguage: string, The language of the timed text.
timedTextTrackName: string, The timed text track name.
updateViewedDate: boolean, Whether to update the view date after successfully updating the file.
useContentAsIndexableText: boolean, Whether to use the content as indexable text.
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.
"alternateLink": "A String", # Output only. A link for opening the file in a relevant Google editor or viewer.
"appDataContents": True or False, # Output only. Whether this file is in the Application Data folder.
"canComment": True or False, # Output only. Deprecated: Use `capabilities/canComment` instead.
"canReadRevisions": True or False, # Output only. Deprecated: Use `capabilities/canReadRevisions` instead.
"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.
"canChangeRestrictedDownload": True or False, # Output only. Deprecated.
"canChangeSecurityUpdateEnabled": True or False, # Output only. Whether the current user can change the securityUpdateEnabled field on link share metadata.
"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, # Output only. Deprecated: 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, # Output only. Deprecated: Use `canMoveChildrenWithinDrive` instead.
"canMoveItemIntoTeamDrive": True or False, # Output only. Deprecated: 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, # Output only. Deprecated: 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, # Output only. Deprecated: Use `canMoveItemWithinDrive` instead.
"canMoveTeamDriveItem": True or False, # Output only. Deprecated: 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, # Output only. Deprecated: 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.
},
"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.
"isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made.
"kind": "drive#user", # Output only. This is always `drive#user`.
"permissionId": "A String", # Output only. The user's ID as visible in the permissions collection.
"picture": { # Output only. The user's profile picture.
"url": "A String", # Output Only. A URL that points to a profile picture of this user.
},
},
"restrictionDate": "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.
"copyable": True or False, # Output only. Deprecated: Use `capabilities/canCopy` instead.
"createdDate": "A String", # Create time for this file (formatted RFC 3339 timestamp).
"defaultOpenWithLink": "A String", # Output only. A link to open this file with the user's default app for this file. Only populated when the drive.apps.readonly scope is used.
"description": "A String", # A short description of the file.
"downloadUrl": "A String", # Output only. Short lived download URL for the file. This field is only populated for files with content stored in Google Drive; it is not populated for Google Docs or shortcut files.
"driveId": "A String", # Output only. ID of the shared drive the file resides in. Only populated for items in shared drives.
"editable": True or False, # Output only. Deprecated: Use `capabilities/canEdit` instead.
"embedLink": "A String", # Output only. A link for embedding the file.
"etag": "A String", # Output only. ETag of the file.
"explicitlyTrashed": True or False, # Output only. Whether this file has been explicitly trashed, as opposed to recursively trashed.
"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` with trailing text that does not appear to be part of the extension removed. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.
"fileSize": "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.
"folderColorRgb": "A String", # Folder color as an RGB hex string if the file is a folder or a shortcut to a folder. The list of supported colors is available in the folderColorPalette field of the About resource. If an unsupported color is specified, it will be changed to the closest color in the palette.
"fullFileExtension": "A String", # Output only. The full file extension; extracted from the title. May contain multiple concatenated extensions, such as "tar.gz". Removing an extension from the title does not clear this field; however, changing the extension on the title does update this field. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.
"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 field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.
"iconLink": "A String", # Output only. A link to the file's icon.
"id": "A String", # The ID of the file.
"imageMediaMetadata": { # Output only. Metadata about image media. This will only be present for image types, and its contents will depend on what can be parsed from the image content.
"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.
"date": "A String", # Output only. The date and time the photo was taken (EXIF format timestamp).
"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.
"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.
},
"indexableText": { # Indexable text attributes for the file (can only be written)
"text": "A String", # The text to be indexed for this file.
},
"isAppAuthorized": True or False, # Output only. Whether the file was created or opened by the requesting app.
"kind": "drive#file", # Output only. The type of file. This is always `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 a 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": "drive#labelField", # 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.
"isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made.
"kind": "drive#user", # Output only. This is always `drive#user`.
"permissionId": "A String", # Output only. The user's ID as visible in the permissions collection.
"picture": { # Output only. The user's profile picture.
"url": "A String", # Output Only. A URL that points to a profile picture of this user.
},
},
],
"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": "drive#label", # This is always `drive#label`
"revisionId": "A String", # The revision ID of the label.
},
],
},
"labels": { # A group of labels for the file.
"hidden": True or False, # Output only. Deprecated.
"modified": True or False, # Output only. Whether the file has been modified by this user.
"restricted": True or False, # Output only. Deprecated: Use `copyRequiresWriterPermission` instead.
"starred": True or False, # Whether this file is starred by the user.
"trashed": True or False, # Whether this file has been trashed. This label applies to all users accessing the file; however, only owners are allowed to see and untrash files.
"viewed": True or False, # Whether this file has been viewed by this user.
},
"lastModifyingUser": { # Information about a Drive user. # Output only. The last user to modify this 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.
"isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made.
"kind": "drive#user", # Output only. This is always `drive#user`.
"permissionId": "A String", # Output only. The user's ID as visible in the permissions collection.
"picture": { # Output only. The user's profile picture.
"url": "A String", # Output Only. A URL that points to a profile picture of this user.
},
},
"lastModifyingUserName": "A String", # Output only. Name of the last user to modify this file.
"lastViewedByMeDate": "A String", # Last time this file was viewed by the user (formatted RFC 3339 timestamp).
"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.
},
"markedViewedByMeDate": "A String", # Deprecated.
"md5Checksum": "A String", # Output only. An MD5 checksum for the content of this file. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.
"mimeType": "A String", # The MIME type of the file. This is only mutable on update when uploading new content. This field can be left blank, and the mimetype will be determined from the uploaded content's MIME type.
"modifiedByMeDate": "A String", # Last time this file was modified by the user (formatted RFC 3339 timestamp). Note that setting modifiedDate will also update the modifiedByMe date for the user which set the date.
"modifiedDate": "A String", # Last time this file was modified by anyone (formatted RFC 3339 timestamp). This is only mutable on update when the setModifiedDate parameter is set.
"openWithLinks": { # Output only. A map of the id of each of the user's apps to a link to open this file with that app. Only populated when the drive.apps.readonly scope is used.
"a_key": "A String",
},
"originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the `title` field. This is only available for files with binary content in Google Drive.
"ownedByMe": True or False, # Output only. Whether the file is owned by the current user. Not populated for items in shared drives.
"ownerNames": [ # Output only. Name(s) of the owner(s) of this file. Not populated for items in shared drives.
"A String",
],
"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.
"isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made.
"kind": "drive#user", # Output only. This is always `drive#user`.
"permissionId": "A String", # Output only. The user's ID as visible in the permissions collection.
"picture": { # Output only. The user's profile picture.
"url": "A String", # Output Only. A URL that points to a profile picture of this user.
},
},
],
"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 an insert 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 reference to a file's parent. A file can only have one parent folder; specifying multiple parents isn't supported. Some resource methods (such as `parents.get`) require a `parentId`. Use the `parents.list` method to retrieve the ID for a parent.
"id": "A String", # The ID of the parent.
"isRoot": True or False, # Output only. Whether or not the parent is the root folder.
"kind": "drive#parentReference", # Output only. This is always `drive#parentReference`.
"parentLink": "A String", # Output only. A link to the parent.
"selfLink": "A String", # Output only. A link back to this reference.
},
],
"permissionIds": [ # Output only. List of permission IDs for users with access to this file.
"A String",
],
"permissions": [ # Output only. The list of permissions for users with access to this 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. 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.
"additionalRoles": [ # Additional roles for this user. Only `commenter` is currently allowed, though more may be supported in the future.
"A String",
],
"authKey": "A String", # Output only. Deprecated.
"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.
"domain": "A String", # Output only. The domain name of the entity this permission refers to. This is an output-only field which is present when the permission type is `user`, `group` or `domain`.
"emailAddress": "A String", # Output only. The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is `user` or `group`.
"etag": "A String", # Output only. The ETag of the permission.
"expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: - They can only be set on user and group permissions - The date must be in the future - The date cannot be more than a year in the future - The date can only be set on drive.permissions.update or drive.permissions.patch requests
"id": "A String", # The ID of the user this permission refers to, and identical to the `permissionId` in the About and Files resources. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored.
"kind": "drive#permission", # Output only. This is always `drive#permission`.
"name": "A String", # Output only. The name for this 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.
{
"additionalRoles": [ # Output only. Additional roles for this user. Only `commenter` is currently possible, though more may be supported in the future.
"A String",
],
"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` * `reader`
},
],
"photoLink": "A String", # Output only. A link to the profile photo, if available.
"role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: * `owner` * `organizer` * `fileOrganizer` * `writer` * `reader`
"selfLink": "A String", # Output only. A link back to this permission.
"teamDrivePermissionDetails": [ # Output only. Deprecated: Use `permissionDetails` instead.
{
"additionalRoles": [ # Output only. Deprecated: Use `permissionDetails/additionalRoles` instead.
"A String",
],
"inherited": True or False, # Output only. Deprecated: Use `permissionDetails/inherited` instead.
"inheritedFrom": "A String", # Output only. Deprecated: Use `permissionDetails/inheritedFrom` instead.
"role": "A String", # Output only. Deprecated: Use `permissionDetails/role` instead.
"teamDrivePermissionType": "A String", # Output only. Deprecated: Use `permissionDetails/permissionType` instead.
},
],
"type": "A String", # The account type. Allowed values are: * `user` * `group` * `domain` * `anyone`
"value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored.
"view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. `published` is the only supported value.
"withLink": True or False, # Whether the link is required for this permission.
},
],
"properties": [ # The list of properties.
{ # A key-value pair attached to a file that is either public or private to an application. The following limits apply to file properties: * Maximum of 100 properties total per file * Maximum of 30 private properties per app * Maximum of 30 public properties * Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property Some resource methods (such as `properties.update`) require a `propertyKey`. Use the `properties.list` method to retrieve the key for a property.
"etag": "A String", # Output only. ETag of the property.
"key": "A String", # The key of this property.
"kind": "drive#property", # Output only. This is always `drive#property`.
"selfLink": "A String", # Output only. The link back to this property.
"value": "A String", # The value of this property.
"visibility": "A String", # The visibility of this property. Allowed values are PRIVATE (default) and PUBLIC. Private 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.
},
],
"quotaBytesUsed": "A String", # Output only. The number of quota bytes used by this file.
"resourceKey": "A String", # Output only. A key needed to access the item via a shared link.
"selfLink": "A String", # Output only. A link back to this file.
"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.
"shareable": True or False, # Output only. Deprecated: Use `capabilities/canShare` instead.
"shared": True or False, # Output only. Whether the file has been shared. Not populated for items in shared drives.
"sharedWithMeDate": "A String", # Time at which this file was shared with the user (formatted RFC 3339 timestamp).
"sharingUser": { # Information about a Drive user. # Output only. User that shared the item with the current user, if available.
"displayName": "A String", # Output only. A plain text displayable name for this user.
"emailAddress": "A String", # Output only. The email address of the user.
"isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made.
"kind": "drive#user", # Output only. This is always `drive#user`.
"permissionId": "A String", # Output only. The user's ID as visible in the permissions collection.
"picture": { # Output only. The user's profile picture.
"url": "A String", # Output Only. A URL that points to a profile picture of this user.
},
},
"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.insert` requests.
"targetId": "A String", # The ID of the file that this shortcut points to. Can only be set on `files.insert` 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.
},
"spaces": [ # Output only. The list of spaces which contain the file. Supported values are `drive`, `appDataFolder` and `photos`.
"A String",
],
"teamDriveId": "A String", # Output only. Deprecated: Use `driveId` instead.
"thumbnail": { # A thumbnail for the file. This will only be used if a standard thumbnail cannot be generated.
"image": "A String", # The URL-safe Base64 encoded bytes of the thumbnail image. It should conform to RFC 4648 section 5.
"mimeType": "A String", # The MIME type of the thumbnail.
},
"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), 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.
"title": "A String", # The title of this file. Note that for immutable items such as the top level folders of shared drives, My Drive root folder, and Application Data folder the title is constant.
"trashedDate": "A String", # The time that the item was trashed (formatted RFC 3339 timestamp). 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.
"isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made.
"kind": "drive#user", # Output only. This is always `drive#user`.
"permissionId": "A String", # Output only. The user's ID as visible in the permissions collection.
"picture": { # Output only. The user's profile picture.
"url": "A String", # Output Only. A URL that points to a profile picture of this user.
},
},
"userPermission": { # A permission for a file. A permission grants a user, group, domain, or the world access to a file or a folder hierarchy. 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. # Output only. The permissions for the authenticated user on this file.
"additionalRoles": [ # Additional roles for this user. Only `commenter` is currently allowed, though more may be supported in the future.
"A String",
],
"authKey": "A String", # Output only. Deprecated.
"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.
"domain": "A String", # Output only. The domain name of the entity this permission refers to. This is an output-only field which is present when the permission type is `user`, `group` or `domain`.
"emailAddress": "A String", # Output only. The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is `user` or `group`.
"etag": "A String", # Output only. The ETag of the permission.
"expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: - They can only be set on user and group permissions - The date must be in the future - The date cannot be more than a year in the future - The date can only be set on drive.permissions.update or drive.permissions.patch requests
"id": "A String", # The ID of the user this permission refers to, and identical to the `permissionId` in the About and Files resources. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored.
"kind": "drive#permission", # Output only. This is always `drive#permission`.
"name": "A String", # Output only. The name for this 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.
{
"additionalRoles": [ # Output only. Additional roles for this user. Only `commenter` is currently possible, though more may be supported in the future.
"A String",
],
"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` * `reader`
},
],
"photoLink": "A String", # Output only. A link to the profile photo, if available.
"role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: * `owner` * `organizer` * `fileOrganizer` * `writer` * `reader`
"selfLink": "A String", # Output only. A link back to this permission.
"teamDrivePermissionDetails": [ # Output only. Deprecated: Use `permissionDetails` instead.
{
"additionalRoles": [ # Output only. Deprecated: Use `permissionDetails/additionalRoles` instead.
"A String",
],
"inherited": True or False, # Output only. Deprecated: Use `permissionDetails/inherited` instead.
"inheritedFrom": "A String", # Output only. Deprecated: Use `permissionDetails/inheritedFrom` instead.
"role": "A String", # Output only. Deprecated: Use `permissionDetails/role` instead.
"teamDrivePermissionType": "A String", # Output only. Deprecated: Use `permissionDetails/permissionType` instead.
},
],
"type": "A String", # The account type. Allowed values are: * `user` * `group` * `domain` * `anyone`
"value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored.
"view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. `published` is the only supported value.
"withLink": True or False, # Whether the link is required for this permission.
},
"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 requesting user.
"videoMediaMetadata": { # Output only. Metadata about video media. This will only be present for video types.
"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.
},
"webContentLink": "A String", # Output only. A link for downloading the content of the file in a browser using cookie based authentication. In cases where the content is shared publicly, the content can be downloaded without any credentials.
"webViewLink": "A String", # Output only. A link only available on public folders for viewing their static web assets (HTML, CSS, JS, etc) via Google Drive's Website Hosting.
"writersCanShare": True or False, # Whether writers can share the document with other users. Not populated for items in shared drives.
}
watch(fileId, acknowledgeAbuse=None, body=None, includeLabels=None, includePermissionsForView=None, projection=None, revisionId=None, supportsAllDrives=None, supportsTeamDrives=None, updateViewedDate=None, x__xgafv=None)
Subscribes to changes to a file.
Args:
fileId: string, The ID for the file in question. (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.
projection: string, Deprecated: This parameter has no function.
Allowed values
BASIC - Deprecated.
FULL - Deprecated.
revisionId: string, Specifies the Revision ID that should be downloaded. Ignored unless alt=media is specified.
supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives.
supportsTeamDrives: boolean, Deprecated: Use `supportsAllDrives` instead.
updateViewedDate: boolean, Deprecated: Use files.update with modifiedDateBehavior=noChange, updateViewedDate=true and an empty request body.
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".
}