Regen all docs. (#700)
* Stop recursing if discovery == {}
* Generate docs with 'make docs'.
diff --git a/docs/dyn/drive_v3.files.html b/docs/dyn/drive_v3.files.html
index 16cb74e..042aff2 100644
--- a/docs/dyn/drive_v3.files.html
+++ b/docs/dyn/drive_v3.files.html
@@ -75,50 +75,50 @@
<h1><a href="drive_v3.html">Drive API</a> . <a href="drive_v3.files.html">files</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
- <code><a href="#copy">copy(fileId, body, keepRevisionForever=None, ignoreDefaultVisibility=None, ocrLanguage=None)</a></code></p>
+ <code><a href="#copy">copy(fileId, body, keepRevisionForever=None, supportsTeamDrives=None, ocrLanguage=None, ignoreDefaultVisibility=None, supportsAllDrives=None)</a></code></p>
<p class="firstline">Creates a copy of a file and applies any requested updates with patch semantics.</p>
<p class="toc_element">
- <code><a href="#create">create(body=None, media_body=None, keepRevisionForever=None, media_mime_type=None, useContentAsIndexableText=None, ignoreDefaultVisibility=None, ocrLanguage=None)</a></code></p>
+ <code><a href="#create">create(body=None, media_body=None, keepRevisionForever=None, useContentAsIndexableText=None, supportsTeamDrives=None, ocrLanguage=None, ignoreDefaultVisibility=None, supportsAllDrives=None, media_mime_type=None)</a></code></p>
<p class="firstline">Creates a new file.</p>
<p class="toc_element">
- <code><a href="#delete">delete(fileId)</a></code></p>
-<p class="firstline">Permanently deletes a file owned by the user without moving it to the trash. If the target is a folder, all descendants owned by the user are also deleted.</p>
+ <code><a href="#delete">delete(fileId, supportsTeamDrives=None, supportsAllDrives=None)</a></code></p>
+<p class="firstline">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. If the target is a folder, all descendants owned by the user are also deleted.</p>
<p class="toc_element">
<code><a href="#emptyTrash">emptyTrash()</a></code></p>
<p class="firstline">Permanently deletes all of the user's trashed files.</p>
<p class="toc_element">
<code><a href="#export">export(fileId, mimeType)</a></code></p>
-<p class="firstline">Exports a Google Doc to the requested MIME type and returns the exported content.</p>
+<p class="firstline">Exports a Google Doc to the requested MIME type and returns the exported content. Please note that the exported content is limited to 10MB.</p>
<p class="toc_element">
<code><a href="#export_media">export_media(fileId, mimeType)</a></code></p>
-<p class="firstline">Exports a Google Doc to the requested MIME type and returns the exported content.</p>
+<p class="firstline">Exports a Google Doc to the requested MIME type and returns the exported content. Please note that the exported content is limited to 10MB.</p>
<p class="toc_element">
<code><a href="#generateIds">generateIds(count=None, space=None)</a></code></p>
<p class="firstline">Generates a set of file IDs which can be provided in create requests.</p>
<p class="toc_element">
- <code><a href="#get">get(fileId, acknowledgeAbuse=None)</a></code></p>
+ <code><a href="#get">get(fileId, supportsTeamDrives=None, supportsAllDrives=None, acknowledgeAbuse=None)</a></code></p>
<p class="firstline">Gets a file's metadata or content by ID.</p>
<p class="toc_element">
- <code><a href="#get_media">get_media(fileId, acknowledgeAbuse=None)</a></code></p>
+ <code><a href="#get_media">get_media(fileId, supportsTeamDrives=None, supportsAllDrives=None, acknowledgeAbuse=None)</a></code></p>
<p class="firstline">Gets a file's metadata or content by ID.</p>
<p class="toc_element">
- <code><a href="#list">list(orderBy=None, q=None, pageSize=None, pageToken=None, spaces=None, corpus=None)</a></code></p>
+ <code><a href="#list">list(orderBy=None, pageSize=None, supportsTeamDrives=None, spaces=None, q=None, pageToken=None, corpus=None, teamDriveId=None, includeItemsFromAllDrives=None, includeTeamDriveItems=None, corpora=None, supportsAllDrives=None, driveId=None)</a></code></p>
<p class="firstline">Lists or searches files.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
- <code><a href="#update">update(fileId, body=None, media_body=None, addParents=None, removeParents=None, media_mime_type=None, useContentAsIndexableText=None, keepRevisionForever=None, ocrLanguage=None)</a></code></p>
+ <code><a href="#update">update(fileId, body=None, keepRevisionForever=None, removeParents=None, supportsTeamDrives=None, media_body=None, ocrLanguage=None, addParents=None, useContentAsIndexableText=None, supportsAllDrives=None, media_mime_type=None)</a></code></p>
<p class="firstline">Updates a file's metadata and/or content with patch semantics.</p>
<p class="toc_element">
- <code><a href="#watch">watch(fileId, body, acknowledgeAbuse=None)</a></code></p>
+ <code><a href="#watch">watch(fileId, body, supportsTeamDrives=None, supportsAllDrives=None, acknowledgeAbuse=None)</a></code></p>
<p class="firstline">Subscribes to changes to a file</p>
<p class="toc_element">
- <code><a href="#watch_media">watch_media(fileId, body, acknowledgeAbuse=None)</a></code></p>
+ <code><a href="#watch_media">watch_media(fileId, body, supportsTeamDrives=None, supportsAllDrives=None, acknowledgeAbuse=None)</a></code></p>
<p class="firstline">Subscribes to changes to a file</p>
<h3>Method Details</h3>
<div class="method">
- <code class="details" id="copy">copy(fileId, body, keepRevisionForever=None, ignoreDefaultVisibility=None, ocrLanguage=None)</code>
+ <code class="details" id="copy">copy(fileId, body, keepRevisionForever=None, supportsTeamDrives=None, ocrLanguage=None, ignoreDefaultVisibility=None, supportsAllDrives=None)</code>
<pre>Creates a copy of a file and applies any requested updates with patch semantics.
Args:
@@ -127,17 +127,18 @@
The object takes the form of:
{ # The metadata for a file.
- "hasThumbnail": True or False, # Whether this file has a thumbnail.
+ "hasThumbnail": True or False, # 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.
"mimeType": "A String", # The MIME type of the file.
- # Drive will attempt to automatically detect an appropriate value from uploaded content if no value is provided. The value cannot be changed unless a new revision is uploaded.
+ # Google Drive will attempt to automatically detect an appropriate value from uploaded content if no value is provided. The value cannot be changed unless a new revision is uploaded.
# If a file is created with a Google Doc MIME type, the uploaded content will be imported if possible. The supported import formats are published in the About resource.
"modifiedByMeTime": "A String", # The last time the file was modified by the user (RFC 3339 date-time).
"thumbnailLink": "A String", # A short-lived link to the file's thumbnail, if available. Typically lasts on the order of hours. Only populated when the requesting app can access the file's content.
- "thumbnailVersion": "A String", # The thumbnail version for use in client-contructable thumbnail URLs or thumbnail cache invalidation.
+ "thumbnailVersion": "A String", # The thumbnail version for use in thumbnail cache invalidation.
"explicitlyTrashed": True or False, # Whether the file has been explicitly trashed, as opposed to recursively trashed from a parent folder.
"isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app.
- "writersCanShare": True or False, # Whether users with only writer permission can modify the file's permissions.
- "ownedByMe": True or False, # Whether the user owns the file.
+ "teamDriveId": "A String", # Deprecated - use driveId instead.
+ "writersCanShare": True or False, # Whether users with only writer permission can modify the file's permissions. Not populated for items in shared drives.
+ "ownedByMe": True or False, # Whether the user owns the file. Not populated for items in shared drives.
"viewedByMeTime": "A String", # The last time the file was viewed by the user (RFC 3339 date-time).
"id": "A String", # The ID of the file.
"sharingUser": { # Information about a Drive user. # The user who shared the file with the requesting user, if applicable.
@@ -148,7 +149,7 @@
"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
"photoLink": "A String", # A link to the user's profile photo, if available.
},
- "size": "A String", # The size of the file's content in bytes. This is only applicable to files with binary content in Drive.
+ "size": "A String", # The size of the file's content in bytes. This is only applicable to files with binary content in Google Drive.
"videoMediaMetadata": { # Additional metadata about video media. This may not be available immediately upon upload.
"width": 42, # The width of the video in pixels.
"durationMillis": "A String", # The duration of the video in milliseconds.
@@ -168,53 +169,60 @@
# Entries with null values are cleared in update and copy requests.
"a_key": "A String",
},
- "capabilities": { # Capabilities the current user has on the file.
- "canReadRevisions": True or False, # Whether the current user has read access to the Revisions resource of the file.
- "canCopy": True or False, # Whether the user can copy the file.
- "canShare": True or False, # Whether the user can modify the file's permissions and sharing settings.
- "canEdit": True or False, # Whether the user can edit the file's content.
- "canComment": True or False, # Whether the user can comment on the file.
+ "capabilities": { # Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take.
+ "canMoveItemOutOfDrive": True or False, # 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.
+ "canUntrash": True or False, # Whether the current user can restore this file from trash.
+ "canMoveItemWithinTeamDrive": True or False, # Deprecated - use canMoveItemWithinDrive instead.
+ "canDeleteChildren": True or False, # 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.
+ "canMoveChildrenWithinTeamDrive": True or False, # Deprecated - use canMoveChildrenWithinDrive instead.
+ "canListChildren": True or False, # Whether the current user can list the children of this folder. This is always false when the item is not a folder.
+ "canRename": True or False, # Whether the current user can rename this file.
+ "canReadDrive": True or False, # Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives.
+ "canAddChildren": True or False, # Whether the current user can add children to this folder. This is always false when the item is not a folder.
+ "canShare": True or False, # Whether the current user can modify the sharing settings for this file.
+ "canTrashChildren": True or False, # 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.
+ "canMoveChildrenWithinDrive": True or False, # Whether the current user can move children of this folder within the shared drive. This is false when the item is not a folder. Only populated for items in shared drives.
+ "canReadRevisions": True or False, # 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.
+ "canMoveItemWithinDrive": True or False, # Whether the current user can move this item within this shared drive. Note that a request to change the parent of the item may still fail depending on the new parent that is being added. Only populated for items in shared drives.
+ "canCopy": True or False, # 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.
+ "canMoveItemIntoTeamDrive": True or False, # Deprecated - use canMoveItemOutOfDrive instead.
+ "canMoveItemOutOfTeamDrive": True or False, # Deprecated - use canMoveItemOutOfDrive instead.
+ "canComment": True or False, # Whether the current user can comment on this file.
+ "canMoveChildrenOutOfDrive": True or False, # 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.
+ "canChangeViewersCanCopyContent": True or False, # Deprecated
+ "canTrash": True or False, # Whether the current user can move this file to trash.
+ "canDelete": True or False, # Whether the current user can delete this file.
+ "canMoveTeamDriveItem": True or False, # Deprecated - use canMoveItemWithinDrive or canMoveItemOutOfDrive instead.
+ "canDownload": True or False, # Whether the current user can download this file.
+ "canChangeCopyRequiresWriterPermission": True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this file.
+ "canMoveChildrenOutOfTeamDrive": True or False, # Deprecated - use canMoveChildrenOutOfDrive instead.
+ "canRemoveChildren": True or False, # 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.
+ "canReadTeamDrive": True or False, # Deprecated - use canReadDrive instead.
+ "canEdit": True or False, # Whether the current user can edit this file.
},
+ "trashedTime": "A String", # The time that the item was trashed (RFC 3339 date-time). Only populated for items in shared drives.
"webViewLink": "A String", # A link for opening the file in a relevant Google editor or viewer in a browser.
"version": "A String", # A monotonically increasing version number for the file. This reflects every change made to the file on the server, even those not visible to the user.
"parents": [ # The IDs of the parent folders which contain the file.
- # If not specified as part of a create request, the file will be placed directly in the My Drive folder. Update requests must use the addParents and removeParents parameters to modify the values.
+ # If not specified as part of a create request, the file will be placed directly in the user's My Drive folder. If not specified as part of a copy request, the file will inherit any discoverable parents of the source file. Update requests must use the addParents and removeParents parameters to modify the parents list.
"A String",
],
"sharedWithMeTime": "A String", # The time at which the file was shared with the user, if applicable (RFC 3339 date-time).
- "shared": True or False, # Whether the file has been shared.
- "permissions": [ # The full list of permissions for the file. This is only available if the requesting user can share the file.
- { # A permission for a file. A permission grants a user, group, domain or the world access to a file or a folder hierarchy.
- "domain": "A String", # The domain to which this permission refers.
- "displayName": "A String", # A displayable name for users, groups or domains.
- "allowFileDiscovery": True or False, # Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type domain or anyone.
- "kind": "drive#permission", # Identifies what kind of resource this is. Value: the fixed string "drive#permission".
- "emailAddress": "A String", # The email address of the user or group to which this permission refers.
- "photoLink": "A String", # A link to the user's profile photo, if available.
- "role": "A String", # The role granted by this permission. Valid values are:
- # - owner
- # - writer
- # - commenter
- # - reader
- "expirationTime": "A String", # The time at which this permission will expire (RFC 3339 date-time).
- "type": "A String", # The type of the grantee. Valid values are:
- # - user
- # - group
- # - domain
- # - anyone
- "id": "A String", # The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as permissionId.
- },
- ],
- "fullFileExtension": "A String", # The full file extension extracted from the name field. May contain multiple concatenated extensions, such as "tar.gz". This is only available for files with binary content in Drive.
+ "exportLinks": { # Links for exporting Google Docs to specific formats.
+ "a_key": "A String", # A mapping from export format to URL
+ },
+ "shared": True or False, # Whether the file has been shared. Not populated for items in shared drives.
+ "copyRequiresWriterPermission": True or False, # Whether the options to copy, print, or download this file, should be disabled for readers and commenters.
+ "fullFileExtension": "A String", # The full file extension extracted from the name field. May contain multiple concatenated extensions, such as "tar.gz". This is only available for files with binary content in Google Drive.
# This is automatically updated when the name field changes, however it is not cleared if the new name does not contain a valid extension.
- "originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the name field. This is only available for files with binary content in Drive.
- "viewersCanCopyContent": True or False, # Whether users with only reader or commenter permission can copy the file's content. This affects copy, download, and print operations.
+ "originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the name field. This is only available for files with binary content in Google Drive.
+ "viewersCanCopyContent": True or False, # Deprecated - use copyRequiresWriterPermission instead.
"description": "A String", # A short description of the file.
"modifiedTime": "A String", # The last time the file was modified by anyone (RFC 3339 date-time).
# Note that setting modifiedTime will also update modifiedByMeTime for the user.
"viewedByMe": True or False, # Whether the file has been viewed by this user.
"modifiedByMe": True or False, # Whether the file has been modified by this user.
- "owners": [ # The owners of the file. Currently, only certain legacy files may have more than one owner.
+ "owners": [ # The owners of the file. Currently, only certain legacy files may have more than one owner. Not populated for items in shared drives.
{ # Information about a Drive user.
"me": True or False, # Whether this user is the requesting user.
"kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
@@ -226,11 +234,12 @@
],
"createdTime": "A String", # The time at which the file was created (RFC 3339 date-time).
"quotaBytesUsed": "A String", # The number of storage quota bytes used by the file. This includes the head revision as well as previous revisions with keepForever enabled.
+ "starred": True or False, # Whether the user has starred the file.
"properties": { # A collection of arbitrary key-value pairs which are visible to all apps.
# Entries with null values are cleared in update and copy requests.
"a_key": "A String",
},
- "md5Checksum": "A String", # The MD5 checksum for the content of the file. This is only applicable to files with binary content in Drive.
+ "md5Checksum": "A String", # The MD5 checksum for the content of the file. This is only applicable to files with binary content in Google Drive.
"iconLink": "A String", # A static, unauthenticated link to the file's icon.
"imageMediaMetadata": { # Additional metadata about image media, if available.
"exposureBias": 3.14, # The exposure bias of the photo (APEX value).
@@ -260,43 +269,109 @@
"cameraModel": "A String", # The model of the camera used to create the photo.
},
"kind": "drive#file", # Identifies what kind of resource this is. Value: the fixed string "drive#file".
- "name": "A String", # The name of the file. This is not necessarily unique within a folder.
- "webContentLink": "A String", # A link for downloading the content of the file in a browser. This is only available for files with binary content in Drive.
+ "name": "A String", # The name of the file. This is not necessarily unique within a folder. Note that for immutable items such as the top level folders of shared drives, My Drive root folder, and Application Data folder the name is constant.
+ "webContentLink": "A String", # A link for downloading the content of the file in a browser. This is only available for files with binary content in Google Drive.
+ "trashingUser": { # Information about a Drive user. # If the file has been explicitly trashed, the user who trashed it. Only populated for items in shared drives.
+ "me": True or False, # Whether this user is the requesting user.
+ "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
+ "displayName": "A String", # A plain text displayable name for this user.
+ "permissionId": "A String", # The user's ID as visible in Permission resources.
+ "emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
+ "photoLink": "A String", # A link to the user's profile photo, if available.
+ },
+ "driveId": "A String", # ID of the shared drive the file resides in. Only populated for items in shared drives.
"spaces": [ # The list of spaces which contain the file. The currently supported values are 'drive', 'appDataFolder' and 'photos'.
"A String",
],
+ "permissionIds": [ # List of permission IDs for users with access to this file.
+ "A String",
+ ],
"trashed": True or False, # Whether the file has been trashed, either explicitly or from a trashed parent folder. Only the owner may trash a file, and other users cannot see files in the owner's trash.
"contentHints": { # Additional information about the content of the file. These fields are never populated in responses.
"indexableText": "A String", # Text to be indexed for the file to improve fullText queries. This is limited to 128KB in length and may contain HTML elements.
- "thumbnail": { # A thumbnail for the file. This will only be used if Drive cannot generate a standard thumbnail.
+ "thumbnail": { # A thumbnail for the file. This will only be used if Google Drive cannot generate a standard thumbnail.
"mimeType": "A String", # The MIME type of the thumbnail.
"image": "A String", # The thumbnail data encoded with URL-safe Base64 (RFC 4648 section 5).
},
},
- "fileExtension": "A String", # The final component of fullFileExtension. This is only available for files with binary content in Drive.
- "starred": True or False, # Whether the user has starred the file.
- "headRevisionId": "A String", # The ID of the file's head revision. This is currently only available for files with binary content in Drive.
+ "fileExtension": "A String", # The final component of fullFileExtension. This is only available for files with binary content in Google Drive.
+ "hasAugmentedPermissions": True or False, # Whether any users are granted file access directly on this file. This field is only populated for shared drive files.
+ "permissions": [ # The full list of permissions for the file. This is only available if the requesting user can share the file. Not populated for items in shared drives.
+ { # A permission for a file. A permission grants a user, group, domain or the world access to a file or a folder hierarchy.
+ "domain": "A String", # The domain to which this permission refers.
+ "displayName": "A String", # A displayable name for users, groups or domains.
+ "teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead.
+ {
+ "inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead.
+ "role": "A String", # Deprecated - use permissionDetails/role instead.
+ "teamDrivePermissionType": "A String", # Deprecated - use permissionDetails/permissionType instead.
+ "inherited": True or False, # Deprecated - use permissionDetails/inherited instead.
+ },
+ ],
+ "allowFileDiscovery": True or False, # Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type domain or anyone.
+ "deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.
+ "kind": "drive#permission", # Identifies what kind of resource this is. Value: the fixed string "drive#permission".
+ "emailAddress": "A String", # The email address of the user or group to which this permission refers.
+ "photoLink": "A String", # A link to the user's profile photo, if available.
+ "permissionDetails": [ # 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.
+ {
+ "role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible:
+ # - organizer
+ # - fileOrganizer
+ # - writer
+ # - commenter
+ # - reader
+ "inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field and is only populated for members of the shared drive.
+ "permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible:
+ # - file
+ # - member
+ "inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field.
+ },
+ ],
+ "expirationTime": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration times have the following restrictions:
+ # - They can only be set on user and group permissions
+ # - The time must be in the future
+ # - The time cannot be more than a year in the future
+ "role": "A String", # The role granted by this permission. While new values may be supported in the future, the following are currently allowed:
+ # - owner
+ # - organizer
+ # - fileOrganizer
+ # - writer
+ # - commenter
+ # - reader
+ "type": "A String", # The type of the grantee. Valid values are:
+ # - user
+ # - group
+ # - domain
+ # - anyone
+ "id": "A String", # The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as permissionId.
+ },
+ ],
+ "headRevisionId": "A String", # The ID of the file's head revision. This is currently only available for files with binary content in Google Drive.
}
- keepRevisionForever: boolean, Whether to set the 'keepForever' field in the new head revision. This is only applicable to files with binary content in Drive.
- ignoreDefaultVisibility: boolean, Whether to ignore the domain's default visibility settings for the created file. Domain administrators can choose to make all uploaded files visible to the domain by default; this parameter bypasses that behavior for the request. Permissions are still inherited from parent folders.
+ keepRevisionForever: boolean, Whether to set the 'keepForever' field in the new head revision. This is only applicable to files with binary content in Google Drive.
+ supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead.
ocrLanguage: string, A language hint for OCR processing during image import (ISO 639-1 code).
+ ignoreDefaultVisibility: boolean, Whether to ignore the domain's default visibility settings for the created file. Domain administrators can choose to make all uploaded files visible to the domain by default; this parameter bypasses that behavior for the request. Permissions are still inherited from parent folders.
+ supportsAllDrives: boolean, Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives.
Returns:
An object of the form:
{ # The metadata for a file.
- "hasThumbnail": True or False, # Whether this file has a thumbnail.
+ "hasThumbnail": True or False, # 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.
"mimeType": "A String", # The MIME type of the file.
- # Drive will attempt to automatically detect an appropriate value from uploaded content if no value is provided. The value cannot be changed unless a new revision is uploaded.
+ # Google Drive will attempt to automatically detect an appropriate value from uploaded content if no value is provided. The value cannot be changed unless a new revision is uploaded.
# If a file is created with a Google Doc MIME type, the uploaded content will be imported if possible. The supported import formats are published in the About resource.
"modifiedByMeTime": "A String", # The last time the file was modified by the user (RFC 3339 date-time).
"thumbnailLink": "A String", # A short-lived link to the file's thumbnail, if available. Typically lasts on the order of hours. Only populated when the requesting app can access the file's content.
- "thumbnailVersion": "A String", # The thumbnail version for use in client-contructable thumbnail URLs or thumbnail cache invalidation.
+ "thumbnailVersion": "A String", # The thumbnail version for use in thumbnail cache invalidation.
"explicitlyTrashed": True or False, # Whether the file has been explicitly trashed, as opposed to recursively trashed from a parent folder.
"isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app.
- "writersCanShare": True or False, # Whether users with only writer permission can modify the file's permissions.
- "ownedByMe": True or False, # Whether the user owns the file.
+ "teamDriveId": "A String", # Deprecated - use driveId instead.
+ "writersCanShare": True or False, # Whether users with only writer permission can modify the file's permissions. Not populated for items in shared drives.
+ "ownedByMe": True or False, # Whether the user owns the file. Not populated for items in shared drives.
"viewedByMeTime": "A String", # The last time the file was viewed by the user (RFC 3339 date-time).
"id": "A String", # The ID of the file.
"sharingUser": { # Information about a Drive user. # The user who shared the file with the requesting user, if applicable.
@@ -307,7 +382,7 @@
"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
"photoLink": "A String", # A link to the user's profile photo, if available.
},
- "size": "A String", # The size of the file's content in bytes. This is only applicable to files with binary content in Drive.
+ "size": "A String", # The size of the file's content in bytes. This is only applicable to files with binary content in Google Drive.
"videoMediaMetadata": { # Additional metadata about video media. This may not be available immediately upon upload.
"width": 42, # The width of the video in pixels.
"durationMillis": "A String", # The duration of the video in milliseconds.
@@ -327,53 +402,60 @@
# Entries with null values are cleared in update and copy requests.
"a_key": "A String",
},
- "capabilities": { # Capabilities the current user has on the file.
- "canReadRevisions": True or False, # Whether the current user has read access to the Revisions resource of the file.
- "canCopy": True or False, # Whether the user can copy the file.
- "canShare": True or False, # Whether the user can modify the file's permissions and sharing settings.
- "canEdit": True or False, # Whether the user can edit the file's content.
- "canComment": True or False, # Whether the user can comment on the file.
+ "capabilities": { # Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take.
+ "canMoveItemOutOfDrive": True or False, # 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.
+ "canUntrash": True or False, # Whether the current user can restore this file from trash.
+ "canMoveItemWithinTeamDrive": True or False, # Deprecated - use canMoveItemWithinDrive instead.
+ "canDeleteChildren": True or False, # 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.
+ "canMoveChildrenWithinTeamDrive": True or False, # Deprecated - use canMoveChildrenWithinDrive instead.
+ "canListChildren": True or False, # Whether the current user can list the children of this folder. This is always false when the item is not a folder.
+ "canRename": True or False, # Whether the current user can rename this file.
+ "canReadDrive": True or False, # Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives.
+ "canAddChildren": True or False, # Whether the current user can add children to this folder. This is always false when the item is not a folder.
+ "canShare": True or False, # Whether the current user can modify the sharing settings for this file.
+ "canTrashChildren": True or False, # 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.
+ "canMoveChildrenWithinDrive": True or False, # Whether the current user can move children of this folder within the shared drive. This is false when the item is not a folder. Only populated for items in shared drives.
+ "canReadRevisions": True or False, # 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.
+ "canMoveItemWithinDrive": True or False, # Whether the current user can move this item within this shared drive. Note that a request to change the parent of the item may still fail depending on the new parent that is being added. Only populated for items in shared drives.
+ "canCopy": True or False, # 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.
+ "canMoveItemIntoTeamDrive": True or False, # Deprecated - use canMoveItemOutOfDrive instead.
+ "canMoveItemOutOfTeamDrive": True or False, # Deprecated - use canMoveItemOutOfDrive instead.
+ "canComment": True or False, # Whether the current user can comment on this file.
+ "canMoveChildrenOutOfDrive": True or False, # 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.
+ "canChangeViewersCanCopyContent": True or False, # Deprecated
+ "canTrash": True or False, # Whether the current user can move this file to trash.
+ "canDelete": True or False, # Whether the current user can delete this file.
+ "canMoveTeamDriveItem": True or False, # Deprecated - use canMoveItemWithinDrive or canMoveItemOutOfDrive instead.
+ "canDownload": True or False, # Whether the current user can download this file.
+ "canChangeCopyRequiresWriterPermission": True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this file.
+ "canMoveChildrenOutOfTeamDrive": True or False, # Deprecated - use canMoveChildrenOutOfDrive instead.
+ "canRemoveChildren": True or False, # 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.
+ "canReadTeamDrive": True or False, # Deprecated - use canReadDrive instead.
+ "canEdit": True or False, # Whether the current user can edit this file.
},
+ "trashedTime": "A String", # The time that the item was trashed (RFC 3339 date-time). Only populated for items in shared drives.
"webViewLink": "A String", # A link for opening the file in a relevant Google editor or viewer in a browser.
"version": "A String", # A monotonically increasing version number for the file. This reflects every change made to the file on the server, even those not visible to the user.
"parents": [ # The IDs of the parent folders which contain the file.
- # If not specified as part of a create request, the file will be placed directly in the My Drive folder. Update requests must use the addParents and removeParents parameters to modify the values.
+ # If not specified as part of a create request, the file will be placed directly in the user's My Drive folder. If not specified as part of a copy request, the file will inherit any discoverable parents of the source file. Update requests must use the addParents and removeParents parameters to modify the parents list.
"A String",
],
"sharedWithMeTime": "A String", # The time at which the file was shared with the user, if applicable (RFC 3339 date-time).
- "shared": True or False, # Whether the file has been shared.
- "permissions": [ # The full list of permissions for the file. This is only available if the requesting user can share the file.
- { # A permission for a file. A permission grants a user, group, domain or the world access to a file or a folder hierarchy.
- "domain": "A String", # The domain to which this permission refers.
- "displayName": "A String", # A displayable name for users, groups or domains.
- "allowFileDiscovery": True or False, # Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type domain or anyone.
- "kind": "drive#permission", # Identifies what kind of resource this is. Value: the fixed string "drive#permission".
- "emailAddress": "A String", # The email address of the user or group to which this permission refers.
- "photoLink": "A String", # A link to the user's profile photo, if available.
- "role": "A String", # The role granted by this permission. Valid values are:
- # - owner
- # - writer
- # - commenter
- # - reader
- "expirationTime": "A String", # The time at which this permission will expire (RFC 3339 date-time).
- "type": "A String", # The type of the grantee. Valid values are:
- # - user
- # - group
- # - domain
- # - anyone
- "id": "A String", # The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as permissionId.
- },
- ],
- "fullFileExtension": "A String", # The full file extension extracted from the name field. May contain multiple concatenated extensions, such as "tar.gz". This is only available for files with binary content in Drive.
+ "exportLinks": { # Links for exporting Google Docs to specific formats.
+ "a_key": "A String", # A mapping from export format to URL
+ },
+ "shared": True or False, # Whether the file has been shared. Not populated for items in shared drives.
+ "copyRequiresWriterPermission": True or False, # Whether the options to copy, print, or download this file, should be disabled for readers and commenters.
+ "fullFileExtension": "A String", # The full file extension extracted from the name field. May contain multiple concatenated extensions, such as "tar.gz". This is only available for files with binary content in Google Drive.
# This is automatically updated when the name field changes, however it is not cleared if the new name does not contain a valid extension.
- "originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the name field. This is only available for files with binary content in Drive.
- "viewersCanCopyContent": True or False, # Whether users with only reader or commenter permission can copy the file's content. This affects copy, download, and print operations.
+ "originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the name field. This is only available for files with binary content in Google Drive.
+ "viewersCanCopyContent": True or False, # Deprecated - use copyRequiresWriterPermission instead.
"description": "A String", # A short description of the file.
"modifiedTime": "A String", # The last time the file was modified by anyone (RFC 3339 date-time).
# Note that setting modifiedTime will also update modifiedByMeTime for the user.
"viewedByMe": True or False, # Whether the file has been viewed by this user.
"modifiedByMe": True or False, # Whether the file has been modified by this user.
- "owners": [ # The owners of the file. Currently, only certain legacy files may have more than one owner.
+ "owners": [ # The owners of the file. Currently, only certain legacy files may have more than one owner. Not populated for items in shared drives.
{ # Information about a Drive user.
"me": True or False, # Whether this user is the requesting user.
"kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
@@ -385,11 +467,12 @@
],
"createdTime": "A String", # The time at which the file was created (RFC 3339 date-time).
"quotaBytesUsed": "A String", # The number of storage quota bytes used by the file. This includes the head revision as well as previous revisions with keepForever enabled.
+ "starred": True or False, # Whether the user has starred the file.
"properties": { # A collection of arbitrary key-value pairs which are visible to all apps.
# Entries with null values are cleared in update and copy requests.
"a_key": "A String",
},
- "md5Checksum": "A String", # The MD5 checksum for the content of the file. This is only applicable to files with binary content in Drive.
+ "md5Checksum": "A String", # The MD5 checksum for the content of the file. This is only applicable to files with binary content in Google Drive.
"iconLink": "A String", # A static, unauthenticated link to the file's icon.
"imageMediaMetadata": { # Additional metadata about image media, if available.
"exposureBias": 3.14, # The exposure bias of the photo (APEX value).
@@ -419,27 +502,90 @@
"cameraModel": "A String", # The model of the camera used to create the photo.
},
"kind": "drive#file", # Identifies what kind of resource this is. Value: the fixed string "drive#file".
- "name": "A String", # The name of the file. This is not necessarily unique within a folder.
- "webContentLink": "A String", # A link for downloading the content of the file in a browser. This is only available for files with binary content in Drive.
+ "name": "A String", # The name of the file. This is not necessarily unique within a folder. Note that for immutable items such as the top level folders of shared drives, My Drive root folder, and Application Data folder the name is constant.
+ "webContentLink": "A String", # A link for downloading the content of the file in a browser. This is only available for files with binary content in Google Drive.
+ "trashingUser": { # Information about a Drive user. # If the file has been explicitly trashed, the user who trashed it. Only populated for items in shared drives.
+ "me": True or False, # Whether this user is the requesting user.
+ "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
+ "displayName": "A String", # A plain text displayable name for this user.
+ "permissionId": "A String", # The user's ID as visible in Permission resources.
+ "emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
+ "photoLink": "A String", # A link to the user's profile photo, if available.
+ },
+ "driveId": "A String", # ID of the shared drive the file resides in. Only populated for items in shared drives.
"spaces": [ # The list of spaces which contain the file. The currently supported values are 'drive', 'appDataFolder' and 'photos'.
"A String",
],
+ "permissionIds": [ # List of permission IDs for users with access to this file.
+ "A String",
+ ],
"trashed": True or False, # Whether the file has been trashed, either explicitly or from a trashed parent folder. Only the owner may trash a file, and other users cannot see files in the owner's trash.
"contentHints": { # Additional information about the content of the file. These fields are never populated in responses.
"indexableText": "A String", # Text to be indexed for the file to improve fullText queries. This is limited to 128KB in length and may contain HTML elements.
- "thumbnail": { # A thumbnail for the file. This will only be used if Drive cannot generate a standard thumbnail.
+ "thumbnail": { # A thumbnail for the file. This will only be used if Google Drive cannot generate a standard thumbnail.
"mimeType": "A String", # The MIME type of the thumbnail.
"image": "A String", # The thumbnail data encoded with URL-safe Base64 (RFC 4648 section 5).
},
},
- "fileExtension": "A String", # The final component of fullFileExtension. This is only available for files with binary content in Drive.
- "starred": True or False, # Whether the user has starred the file.
- "headRevisionId": "A String", # The ID of the file's head revision. This is currently only available for files with binary content in Drive.
+ "fileExtension": "A String", # The final component of fullFileExtension. This is only available for files with binary content in Google Drive.
+ "hasAugmentedPermissions": True or False, # Whether any users are granted file access directly on this file. This field is only populated for shared drive files.
+ "permissions": [ # The full list of permissions for the file. This is only available if the requesting user can share the file. Not populated for items in shared drives.
+ { # A permission for a file. A permission grants a user, group, domain or the world access to a file or a folder hierarchy.
+ "domain": "A String", # The domain to which this permission refers.
+ "displayName": "A String", # A displayable name for users, groups or domains.
+ "teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead.
+ {
+ "inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead.
+ "role": "A String", # Deprecated - use permissionDetails/role instead.
+ "teamDrivePermissionType": "A String", # Deprecated - use permissionDetails/permissionType instead.
+ "inherited": True or False, # Deprecated - use permissionDetails/inherited instead.
+ },
+ ],
+ "allowFileDiscovery": True or False, # Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type domain or anyone.
+ "deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.
+ "kind": "drive#permission", # Identifies what kind of resource this is. Value: the fixed string "drive#permission".
+ "emailAddress": "A String", # The email address of the user or group to which this permission refers.
+ "photoLink": "A String", # A link to the user's profile photo, if available.
+ "permissionDetails": [ # 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.
+ {
+ "role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible:
+ # - organizer
+ # - fileOrganizer
+ # - writer
+ # - commenter
+ # - reader
+ "inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field and is only populated for members of the shared drive.
+ "permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible:
+ # - file
+ # - member
+ "inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field.
+ },
+ ],
+ "expirationTime": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration times have the following restrictions:
+ # - They can only be set on user and group permissions
+ # - The time must be in the future
+ # - The time cannot be more than a year in the future
+ "role": "A String", # The role granted by this permission. While new values may be supported in the future, the following are currently allowed:
+ # - owner
+ # - organizer
+ # - fileOrganizer
+ # - writer
+ # - commenter
+ # - reader
+ "type": "A String", # The type of the grantee. Valid values are:
+ # - user
+ # - group
+ # - domain
+ # - anyone
+ "id": "A String", # The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as permissionId.
+ },
+ ],
+ "headRevisionId": "A String", # The ID of the file's head revision. This is currently only available for files with binary content in Google Drive.
}</pre>
</div>
<div class="method">
- <code class="details" id="create">create(body=None, media_body=None, keepRevisionForever=None, media_mime_type=None, useContentAsIndexableText=None, ignoreDefaultVisibility=None, ocrLanguage=None)</code>
+ <code class="details" id="create">create(body=None, media_body=None, keepRevisionForever=None, useContentAsIndexableText=None, supportsTeamDrives=None, ocrLanguage=None, ignoreDefaultVisibility=None, supportsAllDrives=None, media_mime_type=None)</code>
<pre>Creates a new file.
Args:
@@ -447,17 +593,18 @@
The object takes the form of:
{ # The metadata for a file.
- "hasThumbnail": True or False, # Whether this file has a thumbnail.
+ "hasThumbnail": True or False, # 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.
"mimeType": "A String", # The MIME type of the file.
- # Drive will attempt to automatically detect an appropriate value from uploaded content if no value is provided. The value cannot be changed unless a new revision is uploaded.
+ # Google Drive will attempt to automatically detect an appropriate value from uploaded content if no value is provided. The value cannot be changed unless a new revision is uploaded.
# If a file is created with a Google Doc MIME type, the uploaded content will be imported if possible. The supported import formats are published in the About resource.
"modifiedByMeTime": "A String", # The last time the file was modified by the user (RFC 3339 date-time).
"thumbnailLink": "A String", # A short-lived link to the file's thumbnail, if available. Typically lasts on the order of hours. Only populated when the requesting app can access the file's content.
- "thumbnailVersion": "A String", # The thumbnail version for use in client-contructable thumbnail URLs or thumbnail cache invalidation.
+ "thumbnailVersion": "A String", # The thumbnail version for use in thumbnail cache invalidation.
"explicitlyTrashed": True or False, # Whether the file has been explicitly trashed, as opposed to recursively trashed from a parent folder.
"isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app.
- "writersCanShare": True or False, # Whether users with only writer permission can modify the file's permissions.
- "ownedByMe": True or False, # Whether the user owns the file.
+ "teamDriveId": "A String", # Deprecated - use driveId instead.
+ "writersCanShare": True or False, # Whether users with only writer permission can modify the file's permissions. Not populated for items in shared drives.
+ "ownedByMe": True or False, # Whether the user owns the file. Not populated for items in shared drives.
"viewedByMeTime": "A String", # The last time the file was viewed by the user (RFC 3339 date-time).
"id": "A String", # The ID of the file.
"sharingUser": { # Information about a Drive user. # The user who shared the file with the requesting user, if applicable.
@@ -468,7 +615,7 @@
"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
"photoLink": "A String", # A link to the user's profile photo, if available.
},
- "size": "A String", # The size of the file's content in bytes. This is only applicable to files with binary content in Drive.
+ "size": "A String", # The size of the file's content in bytes. This is only applicable to files with binary content in Google Drive.
"videoMediaMetadata": { # Additional metadata about video media. This may not be available immediately upon upload.
"width": 42, # The width of the video in pixels.
"durationMillis": "A String", # The duration of the video in milliseconds.
@@ -488,53 +635,60 @@
# Entries with null values are cleared in update and copy requests.
"a_key": "A String",
},
- "capabilities": { # Capabilities the current user has on the file.
- "canReadRevisions": True or False, # Whether the current user has read access to the Revisions resource of the file.
- "canCopy": True or False, # Whether the user can copy the file.
- "canShare": True or False, # Whether the user can modify the file's permissions and sharing settings.
- "canEdit": True or False, # Whether the user can edit the file's content.
- "canComment": True or False, # Whether the user can comment on the file.
+ "capabilities": { # Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take.
+ "canMoveItemOutOfDrive": True or False, # 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.
+ "canUntrash": True or False, # Whether the current user can restore this file from trash.
+ "canMoveItemWithinTeamDrive": True or False, # Deprecated - use canMoveItemWithinDrive instead.
+ "canDeleteChildren": True or False, # 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.
+ "canMoveChildrenWithinTeamDrive": True or False, # Deprecated - use canMoveChildrenWithinDrive instead.
+ "canListChildren": True or False, # Whether the current user can list the children of this folder. This is always false when the item is not a folder.
+ "canRename": True or False, # Whether the current user can rename this file.
+ "canReadDrive": True or False, # Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives.
+ "canAddChildren": True or False, # Whether the current user can add children to this folder. This is always false when the item is not a folder.
+ "canShare": True or False, # Whether the current user can modify the sharing settings for this file.
+ "canTrashChildren": True or False, # 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.
+ "canMoveChildrenWithinDrive": True or False, # Whether the current user can move children of this folder within the shared drive. This is false when the item is not a folder. Only populated for items in shared drives.
+ "canReadRevisions": True or False, # 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.
+ "canMoveItemWithinDrive": True or False, # Whether the current user can move this item within this shared drive. Note that a request to change the parent of the item may still fail depending on the new parent that is being added. Only populated for items in shared drives.
+ "canCopy": True or False, # 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.
+ "canMoveItemIntoTeamDrive": True or False, # Deprecated - use canMoveItemOutOfDrive instead.
+ "canMoveItemOutOfTeamDrive": True or False, # Deprecated - use canMoveItemOutOfDrive instead.
+ "canComment": True or False, # Whether the current user can comment on this file.
+ "canMoveChildrenOutOfDrive": True or False, # 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.
+ "canChangeViewersCanCopyContent": True or False, # Deprecated
+ "canTrash": True or False, # Whether the current user can move this file to trash.
+ "canDelete": True or False, # Whether the current user can delete this file.
+ "canMoveTeamDriveItem": True or False, # Deprecated - use canMoveItemWithinDrive or canMoveItemOutOfDrive instead.
+ "canDownload": True or False, # Whether the current user can download this file.
+ "canChangeCopyRequiresWriterPermission": True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this file.
+ "canMoveChildrenOutOfTeamDrive": True or False, # Deprecated - use canMoveChildrenOutOfDrive instead.
+ "canRemoveChildren": True or False, # 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.
+ "canReadTeamDrive": True or False, # Deprecated - use canReadDrive instead.
+ "canEdit": True or False, # Whether the current user can edit this file.
},
+ "trashedTime": "A String", # The time that the item was trashed (RFC 3339 date-time). Only populated for items in shared drives.
"webViewLink": "A String", # A link for opening the file in a relevant Google editor or viewer in a browser.
"version": "A String", # A monotonically increasing version number for the file. This reflects every change made to the file on the server, even those not visible to the user.
"parents": [ # The IDs of the parent folders which contain the file.
- # If not specified as part of a create request, the file will be placed directly in the My Drive folder. Update requests must use the addParents and removeParents parameters to modify the values.
+ # If not specified as part of a create request, the file will be placed directly in the user's My Drive folder. If not specified as part of a copy request, the file will inherit any discoverable parents of the source file. Update requests must use the addParents and removeParents parameters to modify the parents list.
"A String",
],
"sharedWithMeTime": "A String", # The time at which the file was shared with the user, if applicable (RFC 3339 date-time).
- "shared": True or False, # Whether the file has been shared.
- "permissions": [ # The full list of permissions for the file. This is only available if the requesting user can share the file.
- { # A permission for a file. A permission grants a user, group, domain or the world access to a file or a folder hierarchy.
- "domain": "A String", # The domain to which this permission refers.
- "displayName": "A String", # A displayable name for users, groups or domains.
- "allowFileDiscovery": True or False, # Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type domain or anyone.
- "kind": "drive#permission", # Identifies what kind of resource this is. Value: the fixed string "drive#permission".
- "emailAddress": "A String", # The email address of the user or group to which this permission refers.
- "photoLink": "A String", # A link to the user's profile photo, if available.
- "role": "A String", # The role granted by this permission. Valid values are:
- # - owner
- # - writer
- # - commenter
- # - reader
- "expirationTime": "A String", # The time at which this permission will expire (RFC 3339 date-time).
- "type": "A String", # The type of the grantee. Valid values are:
- # - user
- # - group
- # - domain
- # - anyone
- "id": "A String", # The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as permissionId.
- },
- ],
- "fullFileExtension": "A String", # The full file extension extracted from the name field. May contain multiple concatenated extensions, such as "tar.gz". This is only available for files with binary content in Drive.
+ "exportLinks": { # Links for exporting Google Docs to specific formats.
+ "a_key": "A String", # A mapping from export format to URL
+ },
+ "shared": True or False, # Whether the file has been shared. Not populated for items in shared drives.
+ "copyRequiresWriterPermission": True or False, # Whether the options to copy, print, or download this file, should be disabled for readers and commenters.
+ "fullFileExtension": "A String", # The full file extension extracted from the name field. May contain multiple concatenated extensions, such as "tar.gz". This is only available for files with binary content in Google Drive.
# This is automatically updated when the name field changes, however it is not cleared if the new name does not contain a valid extension.
- "originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the name field. This is only available for files with binary content in Drive.
- "viewersCanCopyContent": True or False, # Whether users with only reader or commenter permission can copy the file's content. This affects copy, download, and print operations.
+ "originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the name field. This is only available for files with binary content in Google Drive.
+ "viewersCanCopyContent": True or False, # Deprecated - use copyRequiresWriterPermission instead.
"description": "A String", # A short description of the file.
"modifiedTime": "A String", # The last time the file was modified by anyone (RFC 3339 date-time).
# Note that setting modifiedTime will also update modifiedByMeTime for the user.
"viewedByMe": True or False, # Whether the file has been viewed by this user.
"modifiedByMe": True or False, # Whether the file has been modified by this user.
- "owners": [ # The owners of the file. Currently, only certain legacy files may have more than one owner.
+ "owners": [ # The owners of the file. Currently, only certain legacy files may have more than one owner. Not populated for items in shared drives.
{ # Information about a Drive user.
"me": True or False, # Whether this user is the requesting user.
"kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
@@ -546,11 +700,12 @@
],
"createdTime": "A String", # The time at which the file was created (RFC 3339 date-time).
"quotaBytesUsed": "A String", # The number of storage quota bytes used by the file. This includes the head revision as well as previous revisions with keepForever enabled.
+ "starred": True or False, # Whether the user has starred the file.
"properties": { # A collection of arbitrary key-value pairs which are visible to all apps.
# Entries with null values are cleared in update and copy requests.
"a_key": "A String",
},
- "md5Checksum": "A String", # The MD5 checksum for the content of the file. This is only applicable to files with binary content in Drive.
+ "md5Checksum": "A String", # The MD5 checksum for the content of the file. This is only applicable to files with binary content in Google Drive.
"iconLink": "A String", # A static, unauthenticated link to the file's icon.
"imageMediaMetadata": { # Additional metadata about image media, if available.
"exposureBias": 3.14, # The exposure bias of the photo (APEX value).
@@ -580,46 +735,112 @@
"cameraModel": "A String", # The model of the camera used to create the photo.
},
"kind": "drive#file", # Identifies what kind of resource this is. Value: the fixed string "drive#file".
- "name": "A String", # The name of the file. This is not necessarily unique within a folder.
- "webContentLink": "A String", # A link for downloading the content of the file in a browser. This is only available for files with binary content in Drive.
+ "name": "A String", # The name of the file. This is not necessarily unique within a folder. Note that for immutable items such as the top level folders of shared drives, My Drive root folder, and Application Data folder the name is constant.
+ "webContentLink": "A String", # A link for downloading the content of the file in a browser. This is only available for files with binary content in Google Drive.
+ "trashingUser": { # Information about a Drive user. # If the file has been explicitly trashed, the user who trashed it. Only populated for items in shared drives.
+ "me": True or False, # Whether this user is the requesting user.
+ "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
+ "displayName": "A String", # A plain text displayable name for this user.
+ "permissionId": "A String", # The user's ID as visible in Permission resources.
+ "emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
+ "photoLink": "A String", # A link to the user's profile photo, if available.
+ },
+ "driveId": "A String", # ID of the shared drive the file resides in. Only populated for items in shared drives.
"spaces": [ # The list of spaces which contain the file. The currently supported values are 'drive', 'appDataFolder' and 'photos'.
"A String",
],
+ "permissionIds": [ # List of permission IDs for users with access to this file.
+ "A String",
+ ],
"trashed": True or False, # Whether the file has been trashed, either explicitly or from a trashed parent folder. Only the owner may trash a file, and other users cannot see files in the owner's trash.
"contentHints": { # Additional information about the content of the file. These fields are never populated in responses.
"indexableText": "A String", # Text to be indexed for the file to improve fullText queries. This is limited to 128KB in length and may contain HTML elements.
- "thumbnail": { # A thumbnail for the file. This will only be used if Drive cannot generate a standard thumbnail.
+ "thumbnail": { # A thumbnail for the file. This will only be used if Google Drive cannot generate a standard thumbnail.
"mimeType": "A String", # The MIME type of the thumbnail.
"image": "A String", # The thumbnail data encoded with URL-safe Base64 (RFC 4648 section 5).
},
},
- "fileExtension": "A String", # The final component of fullFileExtension. This is only available for files with binary content in Drive.
- "starred": True or False, # Whether the user has starred the file.
- "headRevisionId": "A String", # The ID of the file's head revision. This is currently only available for files with binary content in Drive.
+ "fileExtension": "A String", # The final component of fullFileExtension. This is only available for files with binary content in Google Drive.
+ "hasAugmentedPermissions": True or False, # Whether any users are granted file access directly on this file. This field is only populated for shared drive files.
+ "permissions": [ # The full list of permissions for the file. This is only available if the requesting user can share the file. Not populated for items in shared drives.
+ { # A permission for a file. A permission grants a user, group, domain or the world access to a file or a folder hierarchy.
+ "domain": "A String", # The domain to which this permission refers.
+ "displayName": "A String", # A displayable name for users, groups or domains.
+ "teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead.
+ {
+ "inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead.
+ "role": "A String", # Deprecated - use permissionDetails/role instead.
+ "teamDrivePermissionType": "A String", # Deprecated - use permissionDetails/permissionType instead.
+ "inherited": True or False, # Deprecated - use permissionDetails/inherited instead.
+ },
+ ],
+ "allowFileDiscovery": True or False, # Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type domain or anyone.
+ "deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.
+ "kind": "drive#permission", # Identifies what kind of resource this is. Value: the fixed string "drive#permission".
+ "emailAddress": "A String", # The email address of the user or group to which this permission refers.
+ "photoLink": "A String", # A link to the user's profile photo, if available.
+ "permissionDetails": [ # 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.
+ {
+ "role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible:
+ # - organizer
+ # - fileOrganizer
+ # - writer
+ # - commenter
+ # - reader
+ "inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field and is only populated for members of the shared drive.
+ "permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible:
+ # - file
+ # - member
+ "inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field.
+ },
+ ],
+ "expirationTime": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration times have the following restrictions:
+ # - They can only be set on user and group permissions
+ # - The time must be in the future
+ # - The time cannot be more than a year in the future
+ "role": "A String", # The role granted by this permission. While new values may be supported in the future, the following are currently allowed:
+ # - owner
+ # - organizer
+ # - fileOrganizer
+ # - writer
+ # - commenter
+ # - reader
+ "type": "A String", # The type of the grantee. Valid values are:
+ # - user
+ # - group
+ # - domain
+ # - anyone
+ "id": "A String", # The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as permissionId.
+ },
+ ],
+ "headRevisionId": "A String", # The ID of the file's head revision. This is currently only available for files with binary content in Google Drive.
}
media_body: string, The filename of the media request body, or an instance of a MediaUpload object.
- keepRevisionForever: boolean, Whether to set the 'keepForever' field in the new head revision. This is only applicable to files with binary content in Drive.
- media_mime_type: string, The MIME type of the media request body, or an instance of a MediaUpload object.
+ keepRevisionForever: boolean, Whether to set the 'keepForever' field in the new head revision. This is only applicable to files with binary content in Google Drive.
useContentAsIndexableText: boolean, Whether to use the uploaded content as indexable text.
- ignoreDefaultVisibility: boolean, Whether to ignore the domain's default visibility settings for the created file. Domain administrators can choose to make all uploaded files visible to the domain by default; this parameter bypasses that behavior for the request. Permissions are still inherited from parent folders.
+ supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead.
ocrLanguage: string, A language hint for OCR processing during image import (ISO 639-1 code).
+ ignoreDefaultVisibility: boolean, Whether to ignore the domain's default visibility settings for the created file. Domain administrators can choose to make all uploaded files visible to the domain by default; this parameter bypasses that behavior for the request. Permissions are still inherited from parent folders.
+ supportsAllDrives: boolean, Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives.
+ media_mime_type: string, The MIME type of the media request body, or an instance of a MediaUpload object.
Returns:
An object of the form:
{ # The metadata for a file.
- "hasThumbnail": True or False, # Whether this file has a thumbnail.
+ "hasThumbnail": True or False, # 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.
"mimeType": "A String", # The MIME type of the file.
- # Drive will attempt to automatically detect an appropriate value from uploaded content if no value is provided. The value cannot be changed unless a new revision is uploaded.
+ # Google Drive will attempt to automatically detect an appropriate value from uploaded content if no value is provided. The value cannot be changed unless a new revision is uploaded.
# If a file is created with a Google Doc MIME type, the uploaded content will be imported if possible. The supported import formats are published in the About resource.
"modifiedByMeTime": "A String", # The last time the file was modified by the user (RFC 3339 date-time).
"thumbnailLink": "A String", # A short-lived link to the file's thumbnail, if available. Typically lasts on the order of hours. Only populated when the requesting app can access the file's content.
- "thumbnailVersion": "A String", # The thumbnail version for use in client-contructable thumbnail URLs or thumbnail cache invalidation.
+ "thumbnailVersion": "A String", # The thumbnail version for use in thumbnail cache invalidation.
"explicitlyTrashed": True or False, # Whether the file has been explicitly trashed, as opposed to recursively trashed from a parent folder.
"isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app.
- "writersCanShare": True or False, # Whether users with only writer permission can modify the file's permissions.
- "ownedByMe": True or False, # Whether the user owns the file.
+ "teamDriveId": "A String", # Deprecated - use driveId instead.
+ "writersCanShare": True or False, # Whether users with only writer permission can modify the file's permissions. Not populated for items in shared drives.
+ "ownedByMe": True or False, # Whether the user owns the file. Not populated for items in shared drives.
"viewedByMeTime": "A String", # The last time the file was viewed by the user (RFC 3339 date-time).
"id": "A String", # The ID of the file.
"sharingUser": { # Information about a Drive user. # The user who shared the file with the requesting user, if applicable.
@@ -630,7 +851,7 @@
"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
"photoLink": "A String", # A link to the user's profile photo, if available.
},
- "size": "A String", # The size of the file's content in bytes. This is only applicable to files with binary content in Drive.
+ "size": "A String", # The size of the file's content in bytes. This is only applicable to files with binary content in Google Drive.
"videoMediaMetadata": { # Additional metadata about video media. This may not be available immediately upon upload.
"width": 42, # The width of the video in pixels.
"durationMillis": "A String", # The duration of the video in milliseconds.
@@ -650,53 +871,60 @@
# Entries with null values are cleared in update and copy requests.
"a_key": "A String",
},
- "capabilities": { # Capabilities the current user has on the file.
- "canReadRevisions": True or False, # Whether the current user has read access to the Revisions resource of the file.
- "canCopy": True or False, # Whether the user can copy the file.
- "canShare": True or False, # Whether the user can modify the file's permissions and sharing settings.
- "canEdit": True or False, # Whether the user can edit the file's content.
- "canComment": True or False, # Whether the user can comment on the file.
+ "capabilities": { # Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take.
+ "canMoveItemOutOfDrive": True or False, # 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.
+ "canUntrash": True or False, # Whether the current user can restore this file from trash.
+ "canMoveItemWithinTeamDrive": True or False, # Deprecated - use canMoveItemWithinDrive instead.
+ "canDeleteChildren": True or False, # 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.
+ "canMoveChildrenWithinTeamDrive": True or False, # Deprecated - use canMoveChildrenWithinDrive instead.
+ "canListChildren": True or False, # Whether the current user can list the children of this folder. This is always false when the item is not a folder.
+ "canRename": True or False, # Whether the current user can rename this file.
+ "canReadDrive": True or False, # Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives.
+ "canAddChildren": True or False, # Whether the current user can add children to this folder. This is always false when the item is not a folder.
+ "canShare": True or False, # Whether the current user can modify the sharing settings for this file.
+ "canTrashChildren": True or False, # 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.
+ "canMoveChildrenWithinDrive": True or False, # Whether the current user can move children of this folder within the shared drive. This is false when the item is not a folder. Only populated for items in shared drives.
+ "canReadRevisions": True or False, # 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.
+ "canMoveItemWithinDrive": True or False, # Whether the current user can move this item within this shared drive. Note that a request to change the parent of the item may still fail depending on the new parent that is being added. Only populated for items in shared drives.
+ "canCopy": True or False, # 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.
+ "canMoveItemIntoTeamDrive": True or False, # Deprecated - use canMoveItemOutOfDrive instead.
+ "canMoveItemOutOfTeamDrive": True or False, # Deprecated - use canMoveItemOutOfDrive instead.
+ "canComment": True or False, # Whether the current user can comment on this file.
+ "canMoveChildrenOutOfDrive": True or False, # 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.
+ "canChangeViewersCanCopyContent": True or False, # Deprecated
+ "canTrash": True or False, # Whether the current user can move this file to trash.
+ "canDelete": True or False, # Whether the current user can delete this file.
+ "canMoveTeamDriveItem": True or False, # Deprecated - use canMoveItemWithinDrive or canMoveItemOutOfDrive instead.
+ "canDownload": True or False, # Whether the current user can download this file.
+ "canChangeCopyRequiresWriterPermission": True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this file.
+ "canMoveChildrenOutOfTeamDrive": True or False, # Deprecated - use canMoveChildrenOutOfDrive instead.
+ "canRemoveChildren": True or False, # 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.
+ "canReadTeamDrive": True or False, # Deprecated - use canReadDrive instead.
+ "canEdit": True or False, # Whether the current user can edit this file.
},
+ "trashedTime": "A String", # The time that the item was trashed (RFC 3339 date-time). Only populated for items in shared drives.
"webViewLink": "A String", # A link for opening the file in a relevant Google editor or viewer in a browser.
"version": "A String", # A monotonically increasing version number for the file. This reflects every change made to the file on the server, even those not visible to the user.
"parents": [ # The IDs of the parent folders which contain the file.
- # If not specified as part of a create request, the file will be placed directly in the My Drive folder. Update requests must use the addParents and removeParents parameters to modify the values.
+ # If not specified as part of a create request, the file will be placed directly in the user's My Drive folder. If not specified as part of a copy request, the file will inherit any discoverable parents of the source file. Update requests must use the addParents and removeParents parameters to modify the parents list.
"A String",
],
"sharedWithMeTime": "A String", # The time at which the file was shared with the user, if applicable (RFC 3339 date-time).
- "shared": True or False, # Whether the file has been shared.
- "permissions": [ # The full list of permissions for the file. This is only available if the requesting user can share the file.
- { # A permission for a file. A permission grants a user, group, domain or the world access to a file or a folder hierarchy.
- "domain": "A String", # The domain to which this permission refers.
- "displayName": "A String", # A displayable name for users, groups or domains.
- "allowFileDiscovery": True or False, # Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type domain or anyone.
- "kind": "drive#permission", # Identifies what kind of resource this is. Value: the fixed string "drive#permission".
- "emailAddress": "A String", # The email address of the user or group to which this permission refers.
- "photoLink": "A String", # A link to the user's profile photo, if available.
- "role": "A String", # The role granted by this permission. Valid values are:
- # - owner
- # - writer
- # - commenter
- # - reader
- "expirationTime": "A String", # The time at which this permission will expire (RFC 3339 date-time).
- "type": "A String", # The type of the grantee. Valid values are:
- # - user
- # - group
- # - domain
- # - anyone
- "id": "A String", # The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as permissionId.
- },
- ],
- "fullFileExtension": "A String", # The full file extension extracted from the name field. May contain multiple concatenated extensions, such as "tar.gz". This is only available for files with binary content in Drive.
+ "exportLinks": { # Links for exporting Google Docs to specific formats.
+ "a_key": "A String", # A mapping from export format to URL
+ },
+ "shared": True or False, # Whether the file has been shared. Not populated for items in shared drives.
+ "copyRequiresWriterPermission": True or False, # Whether the options to copy, print, or download this file, should be disabled for readers and commenters.
+ "fullFileExtension": "A String", # The full file extension extracted from the name field. May contain multiple concatenated extensions, such as "tar.gz". This is only available for files with binary content in Google Drive.
# This is automatically updated when the name field changes, however it is not cleared if the new name does not contain a valid extension.
- "originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the name field. This is only available for files with binary content in Drive.
- "viewersCanCopyContent": True or False, # Whether users with only reader or commenter permission can copy the file's content. This affects copy, download, and print operations.
+ "originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the name field. This is only available for files with binary content in Google Drive.
+ "viewersCanCopyContent": True or False, # Deprecated - use copyRequiresWriterPermission instead.
"description": "A String", # A short description of the file.
"modifiedTime": "A String", # The last time the file was modified by anyone (RFC 3339 date-time).
# Note that setting modifiedTime will also update modifiedByMeTime for the user.
"viewedByMe": True or False, # Whether the file has been viewed by this user.
"modifiedByMe": True or False, # Whether the file has been modified by this user.
- "owners": [ # The owners of the file. Currently, only certain legacy files may have more than one owner.
+ "owners": [ # The owners of the file. Currently, only certain legacy files may have more than one owner. Not populated for items in shared drives.
{ # Information about a Drive user.
"me": True or False, # Whether this user is the requesting user.
"kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
@@ -708,11 +936,12 @@
],
"createdTime": "A String", # The time at which the file was created (RFC 3339 date-time).
"quotaBytesUsed": "A String", # The number of storage quota bytes used by the file. This includes the head revision as well as previous revisions with keepForever enabled.
+ "starred": True or False, # Whether the user has starred the file.
"properties": { # A collection of arbitrary key-value pairs which are visible to all apps.
# Entries with null values are cleared in update and copy requests.
"a_key": "A String",
},
- "md5Checksum": "A String", # The MD5 checksum for the content of the file. This is only applicable to files with binary content in Drive.
+ "md5Checksum": "A String", # The MD5 checksum for the content of the file. This is only applicable to files with binary content in Google Drive.
"iconLink": "A String", # A static, unauthenticated link to the file's icon.
"imageMediaMetadata": { # Additional metadata about image media, if available.
"exposureBias": 3.14, # The exposure bias of the photo (APEX value).
@@ -742,31 +971,96 @@
"cameraModel": "A String", # The model of the camera used to create the photo.
},
"kind": "drive#file", # Identifies what kind of resource this is. Value: the fixed string "drive#file".
- "name": "A String", # The name of the file. This is not necessarily unique within a folder.
- "webContentLink": "A String", # A link for downloading the content of the file in a browser. This is only available for files with binary content in Drive.
+ "name": "A String", # The name of the file. This is not necessarily unique within a folder. Note that for immutable items such as the top level folders of shared drives, My Drive root folder, and Application Data folder the name is constant.
+ "webContentLink": "A String", # A link for downloading the content of the file in a browser. This is only available for files with binary content in Google Drive.
+ "trashingUser": { # Information about a Drive user. # If the file has been explicitly trashed, the user who trashed it. Only populated for items in shared drives.
+ "me": True or False, # Whether this user is the requesting user.
+ "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
+ "displayName": "A String", # A plain text displayable name for this user.
+ "permissionId": "A String", # The user's ID as visible in Permission resources.
+ "emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
+ "photoLink": "A String", # A link to the user's profile photo, if available.
+ },
+ "driveId": "A String", # ID of the shared drive the file resides in. Only populated for items in shared drives.
"spaces": [ # The list of spaces which contain the file. The currently supported values are 'drive', 'appDataFolder' and 'photos'.
"A String",
],
+ "permissionIds": [ # List of permission IDs for users with access to this file.
+ "A String",
+ ],
"trashed": True or False, # Whether the file has been trashed, either explicitly or from a trashed parent folder. Only the owner may trash a file, and other users cannot see files in the owner's trash.
"contentHints": { # Additional information about the content of the file. These fields are never populated in responses.
"indexableText": "A String", # Text to be indexed for the file to improve fullText queries. This is limited to 128KB in length and may contain HTML elements.
- "thumbnail": { # A thumbnail for the file. This will only be used if Drive cannot generate a standard thumbnail.
+ "thumbnail": { # A thumbnail for the file. This will only be used if Google Drive cannot generate a standard thumbnail.
"mimeType": "A String", # The MIME type of the thumbnail.
"image": "A String", # The thumbnail data encoded with URL-safe Base64 (RFC 4648 section 5).
},
},
- "fileExtension": "A String", # The final component of fullFileExtension. This is only available for files with binary content in Drive.
- "starred": True or False, # Whether the user has starred the file.
- "headRevisionId": "A String", # The ID of the file's head revision. This is currently only available for files with binary content in Drive.
+ "fileExtension": "A String", # The final component of fullFileExtension. This is only available for files with binary content in Google Drive.
+ "hasAugmentedPermissions": True or False, # Whether any users are granted file access directly on this file. This field is only populated for shared drive files.
+ "permissions": [ # The full list of permissions for the file. This is only available if the requesting user can share the file. Not populated for items in shared drives.
+ { # A permission for a file. A permission grants a user, group, domain or the world access to a file or a folder hierarchy.
+ "domain": "A String", # The domain to which this permission refers.
+ "displayName": "A String", # A displayable name for users, groups or domains.
+ "teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead.
+ {
+ "inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead.
+ "role": "A String", # Deprecated - use permissionDetails/role instead.
+ "teamDrivePermissionType": "A String", # Deprecated - use permissionDetails/permissionType instead.
+ "inherited": True or False, # Deprecated - use permissionDetails/inherited instead.
+ },
+ ],
+ "allowFileDiscovery": True or False, # Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type domain or anyone.
+ "deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.
+ "kind": "drive#permission", # Identifies what kind of resource this is. Value: the fixed string "drive#permission".
+ "emailAddress": "A String", # The email address of the user or group to which this permission refers.
+ "photoLink": "A String", # A link to the user's profile photo, if available.
+ "permissionDetails": [ # 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.
+ {
+ "role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible:
+ # - organizer
+ # - fileOrganizer
+ # - writer
+ # - commenter
+ # - reader
+ "inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field and is only populated for members of the shared drive.
+ "permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible:
+ # - file
+ # - member
+ "inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field.
+ },
+ ],
+ "expirationTime": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration times have the following restrictions:
+ # - They can only be set on user and group permissions
+ # - The time must be in the future
+ # - The time cannot be more than a year in the future
+ "role": "A String", # The role granted by this permission. While new values may be supported in the future, the following are currently allowed:
+ # - owner
+ # - organizer
+ # - fileOrganizer
+ # - writer
+ # - commenter
+ # - reader
+ "type": "A String", # The type of the grantee. Valid values are:
+ # - user
+ # - group
+ # - domain
+ # - anyone
+ "id": "A String", # The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as permissionId.
+ },
+ ],
+ "headRevisionId": "A String", # The ID of the file's head revision. This is currently only available for files with binary content in Google Drive.
}</pre>
</div>
<div class="method">
- <code class="details" id="delete">delete(fileId)</code>
- <pre>Permanently deletes a file owned by the user without moving it to the trash. If the target is a folder, all descendants owned by the user are also deleted.
+ <code class="details" id="delete">delete(fileId, supportsTeamDrives=None, supportsAllDrives=None)</code>
+ <pre>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. If the target is a folder, all descendants owned by the user are also deleted.
Args:
fileId: string, The ID of the file. (required)
+ supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead.
+ supportsAllDrives: boolean, Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives.
</pre>
</div>
@@ -780,7 +1074,7 @@
<div class="method">
<code class="details" id="export">export(fileId, mimeType)</code>
- <pre>Exports a Google Doc to the requested MIME type and returns the exported content.
+ <pre>Exports a Google Doc to the requested MIME type and returns the exported content. Please note that the exported content is limited to 10MB.
Args:
fileId: string, The ID of the file. (required)
@@ -790,7 +1084,7 @@
<div class="method">
<code class="details" id="export_media">export_media(fileId, mimeType)</code>
- <pre>Exports a Google Doc to the requested MIME type and returns the exported content.
+ <pre>Exports a Google Doc to the requested MIME type and returns the exported content. Please note that the exported content is limited to 10MB.
Args:
fileId: string, The ID of the file. (required)
@@ -819,28 +1113,31 @@
</div>
<div class="method">
- <code class="details" id="get">get(fileId, acknowledgeAbuse=None)</code>
+ <code class="details" id="get">get(fileId, supportsTeamDrives=None, supportsAllDrives=None, acknowledgeAbuse=None)</code>
<pre>Gets a file's metadata or content by ID.
Args:
fileId: string, The ID of the file. (required)
+ supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead.
+ supportsAllDrives: boolean, Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives.
acknowledgeAbuse: boolean, Whether the user is acknowledging the risk of downloading known malware or other abusive files. This is only applicable when alt=media.
Returns:
An object of the form:
{ # The metadata for a file.
- "hasThumbnail": True or False, # Whether this file has a thumbnail.
+ "hasThumbnail": True or False, # 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.
"mimeType": "A String", # The MIME type of the file.
- # Drive will attempt to automatically detect an appropriate value from uploaded content if no value is provided. The value cannot be changed unless a new revision is uploaded.
+ # Google Drive will attempt to automatically detect an appropriate value from uploaded content if no value is provided. The value cannot be changed unless a new revision is uploaded.
# If a file is created with a Google Doc MIME type, the uploaded content will be imported if possible. The supported import formats are published in the About resource.
"modifiedByMeTime": "A String", # The last time the file was modified by the user (RFC 3339 date-time).
"thumbnailLink": "A String", # A short-lived link to the file's thumbnail, if available. Typically lasts on the order of hours. Only populated when the requesting app can access the file's content.
- "thumbnailVersion": "A String", # The thumbnail version for use in client-contructable thumbnail URLs or thumbnail cache invalidation.
+ "thumbnailVersion": "A String", # The thumbnail version for use in thumbnail cache invalidation.
"explicitlyTrashed": True or False, # Whether the file has been explicitly trashed, as opposed to recursively trashed from a parent folder.
"isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app.
- "writersCanShare": True or False, # Whether users with only writer permission can modify the file's permissions.
- "ownedByMe": True or False, # Whether the user owns the file.
+ "teamDriveId": "A String", # Deprecated - use driveId instead.
+ "writersCanShare": True or False, # Whether users with only writer permission can modify the file's permissions. Not populated for items in shared drives.
+ "ownedByMe": True or False, # Whether the user owns the file. Not populated for items in shared drives.
"viewedByMeTime": "A String", # The last time the file was viewed by the user (RFC 3339 date-time).
"id": "A String", # The ID of the file.
"sharingUser": { # Information about a Drive user. # The user who shared the file with the requesting user, if applicable.
@@ -851,7 +1148,7 @@
"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
"photoLink": "A String", # A link to the user's profile photo, if available.
},
- "size": "A String", # The size of the file's content in bytes. This is only applicable to files with binary content in Drive.
+ "size": "A String", # The size of the file's content in bytes. This is only applicable to files with binary content in Google Drive.
"videoMediaMetadata": { # Additional metadata about video media. This may not be available immediately upon upload.
"width": 42, # The width of the video in pixels.
"durationMillis": "A String", # The duration of the video in milliseconds.
@@ -871,53 +1168,60 @@
# Entries with null values are cleared in update and copy requests.
"a_key": "A String",
},
- "capabilities": { # Capabilities the current user has on the file.
- "canReadRevisions": True or False, # Whether the current user has read access to the Revisions resource of the file.
- "canCopy": True or False, # Whether the user can copy the file.
- "canShare": True or False, # Whether the user can modify the file's permissions and sharing settings.
- "canEdit": True or False, # Whether the user can edit the file's content.
- "canComment": True or False, # Whether the user can comment on the file.
+ "capabilities": { # Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take.
+ "canMoveItemOutOfDrive": True or False, # 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.
+ "canUntrash": True or False, # Whether the current user can restore this file from trash.
+ "canMoveItemWithinTeamDrive": True or False, # Deprecated - use canMoveItemWithinDrive instead.
+ "canDeleteChildren": True or False, # 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.
+ "canMoveChildrenWithinTeamDrive": True or False, # Deprecated - use canMoveChildrenWithinDrive instead.
+ "canListChildren": True or False, # Whether the current user can list the children of this folder. This is always false when the item is not a folder.
+ "canRename": True or False, # Whether the current user can rename this file.
+ "canReadDrive": True or False, # Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives.
+ "canAddChildren": True or False, # Whether the current user can add children to this folder. This is always false when the item is not a folder.
+ "canShare": True or False, # Whether the current user can modify the sharing settings for this file.
+ "canTrashChildren": True or False, # 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.
+ "canMoveChildrenWithinDrive": True or False, # Whether the current user can move children of this folder within the shared drive. This is false when the item is not a folder. Only populated for items in shared drives.
+ "canReadRevisions": True or False, # 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.
+ "canMoveItemWithinDrive": True or False, # Whether the current user can move this item within this shared drive. Note that a request to change the parent of the item may still fail depending on the new parent that is being added. Only populated for items in shared drives.
+ "canCopy": True or False, # 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.
+ "canMoveItemIntoTeamDrive": True or False, # Deprecated - use canMoveItemOutOfDrive instead.
+ "canMoveItemOutOfTeamDrive": True or False, # Deprecated - use canMoveItemOutOfDrive instead.
+ "canComment": True or False, # Whether the current user can comment on this file.
+ "canMoveChildrenOutOfDrive": True or False, # 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.
+ "canChangeViewersCanCopyContent": True or False, # Deprecated
+ "canTrash": True or False, # Whether the current user can move this file to trash.
+ "canDelete": True or False, # Whether the current user can delete this file.
+ "canMoveTeamDriveItem": True or False, # Deprecated - use canMoveItemWithinDrive or canMoveItemOutOfDrive instead.
+ "canDownload": True or False, # Whether the current user can download this file.
+ "canChangeCopyRequiresWriterPermission": True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this file.
+ "canMoveChildrenOutOfTeamDrive": True or False, # Deprecated - use canMoveChildrenOutOfDrive instead.
+ "canRemoveChildren": True or False, # 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.
+ "canReadTeamDrive": True or False, # Deprecated - use canReadDrive instead.
+ "canEdit": True or False, # Whether the current user can edit this file.
},
+ "trashedTime": "A String", # The time that the item was trashed (RFC 3339 date-time). Only populated for items in shared drives.
"webViewLink": "A String", # A link for opening the file in a relevant Google editor or viewer in a browser.
"version": "A String", # A monotonically increasing version number for the file. This reflects every change made to the file on the server, even those not visible to the user.
"parents": [ # The IDs of the parent folders which contain the file.
- # If not specified as part of a create request, the file will be placed directly in the My Drive folder. Update requests must use the addParents and removeParents parameters to modify the values.
+ # If not specified as part of a create request, the file will be placed directly in the user's My Drive folder. If not specified as part of a copy request, the file will inherit any discoverable parents of the source file. Update requests must use the addParents and removeParents parameters to modify the parents list.
"A String",
],
"sharedWithMeTime": "A String", # The time at which the file was shared with the user, if applicable (RFC 3339 date-time).
- "shared": True or False, # Whether the file has been shared.
- "permissions": [ # The full list of permissions for the file. This is only available if the requesting user can share the file.
- { # A permission for a file. A permission grants a user, group, domain or the world access to a file or a folder hierarchy.
- "domain": "A String", # The domain to which this permission refers.
- "displayName": "A String", # A displayable name for users, groups or domains.
- "allowFileDiscovery": True or False, # Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type domain or anyone.
- "kind": "drive#permission", # Identifies what kind of resource this is. Value: the fixed string "drive#permission".
- "emailAddress": "A String", # The email address of the user or group to which this permission refers.
- "photoLink": "A String", # A link to the user's profile photo, if available.
- "role": "A String", # The role granted by this permission. Valid values are:
- # - owner
- # - writer
- # - commenter
- # - reader
- "expirationTime": "A String", # The time at which this permission will expire (RFC 3339 date-time).
- "type": "A String", # The type of the grantee. Valid values are:
- # - user
- # - group
- # - domain
- # - anyone
- "id": "A String", # The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as permissionId.
- },
- ],
- "fullFileExtension": "A String", # The full file extension extracted from the name field. May contain multiple concatenated extensions, such as "tar.gz". This is only available for files with binary content in Drive.
+ "exportLinks": { # Links for exporting Google Docs to specific formats.
+ "a_key": "A String", # A mapping from export format to URL
+ },
+ "shared": True or False, # Whether the file has been shared. Not populated for items in shared drives.
+ "copyRequiresWriterPermission": True or False, # Whether the options to copy, print, or download this file, should be disabled for readers and commenters.
+ "fullFileExtension": "A String", # The full file extension extracted from the name field. May contain multiple concatenated extensions, such as "tar.gz". This is only available for files with binary content in Google Drive.
# This is automatically updated when the name field changes, however it is not cleared if the new name does not contain a valid extension.
- "originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the name field. This is only available for files with binary content in Drive.
- "viewersCanCopyContent": True or False, # Whether users with only reader or commenter permission can copy the file's content. This affects copy, download, and print operations.
+ "originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the name field. This is only available for files with binary content in Google Drive.
+ "viewersCanCopyContent": True or False, # Deprecated - use copyRequiresWriterPermission instead.
"description": "A String", # A short description of the file.
"modifiedTime": "A String", # The last time the file was modified by anyone (RFC 3339 date-time).
# Note that setting modifiedTime will also update modifiedByMeTime for the user.
"viewedByMe": True or False, # Whether the file has been viewed by this user.
"modifiedByMe": True or False, # Whether the file has been modified by this user.
- "owners": [ # The owners of the file. Currently, only certain legacy files may have more than one owner.
+ "owners": [ # The owners of the file. Currently, only certain legacy files may have more than one owner. Not populated for items in shared drives.
{ # Information about a Drive user.
"me": True or False, # Whether this user is the requesting user.
"kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
@@ -929,11 +1233,12 @@
],
"createdTime": "A String", # The time at which the file was created (RFC 3339 date-time).
"quotaBytesUsed": "A String", # The number of storage quota bytes used by the file. This includes the head revision as well as previous revisions with keepForever enabled.
+ "starred": True or False, # Whether the user has starred the file.
"properties": { # A collection of arbitrary key-value pairs which are visible to all apps.
# Entries with null values are cleared in update and copy requests.
"a_key": "A String",
},
- "md5Checksum": "A String", # The MD5 checksum for the content of the file. This is only applicable to files with binary content in Drive.
+ "md5Checksum": "A String", # The MD5 checksum for the content of the file. This is only applicable to files with binary content in Google Drive.
"iconLink": "A String", # A static, unauthenticated link to the file's icon.
"imageMediaMetadata": { # Additional metadata about image media, if available.
"exposureBias": 3.14, # The exposure bias of the photo (APEX value).
@@ -963,31 +1268,96 @@
"cameraModel": "A String", # The model of the camera used to create the photo.
},
"kind": "drive#file", # Identifies what kind of resource this is. Value: the fixed string "drive#file".
- "name": "A String", # The name of the file. This is not necessarily unique within a folder.
- "webContentLink": "A String", # A link for downloading the content of the file in a browser. This is only available for files with binary content in Drive.
+ "name": "A String", # The name of the file. This is not necessarily unique within a folder. Note that for immutable items such as the top level folders of shared drives, My Drive root folder, and Application Data folder the name is constant.
+ "webContentLink": "A String", # A link for downloading the content of the file in a browser. This is only available for files with binary content in Google Drive.
+ "trashingUser": { # Information about a Drive user. # If the file has been explicitly trashed, the user who trashed it. Only populated for items in shared drives.
+ "me": True or False, # Whether this user is the requesting user.
+ "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
+ "displayName": "A String", # A plain text displayable name for this user.
+ "permissionId": "A String", # The user's ID as visible in Permission resources.
+ "emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
+ "photoLink": "A String", # A link to the user's profile photo, if available.
+ },
+ "driveId": "A String", # ID of the shared drive the file resides in. Only populated for items in shared drives.
"spaces": [ # The list of spaces which contain the file. The currently supported values are 'drive', 'appDataFolder' and 'photos'.
"A String",
],
+ "permissionIds": [ # List of permission IDs for users with access to this file.
+ "A String",
+ ],
"trashed": True or False, # Whether the file has been trashed, either explicitly or from a trashed parent folder. Only the owner may trash a file, and other users cannot see files in the owner's trash.
"contentHints": { # Additional information about the content of the file. These fields are never populated in responses.
"indexableText": "A String", # Text to be indexed for the file to improve fullText queries. This is limited to 128KB in length and may contain HTML elements.
- "thumbnail": { # A thumbnail for the file. This will only be used if Drive cannot generate a standard thumbnail.
+ "thumbnail": { # A thumbnail for the file. This will only be used if Google Drive cannot generate a standard thumbnail.
"mimeType": "A String", # The MIME type of the thumbnail.
"image": "A String", # The thumbnail data encoded with URL-safe Base64 (RFC 4648 section 5).
},
},
- "fileExtension": "A String", # The final component of fullFileExtension. This is only available for files with binary content in Drive.
- "starred": True or False, # Whether the user has starred the file.
- "headRevisionId": "A String", # The ID of the file's head revision. This is currently only available for files with binary content in Drive.
+ "fileExtension": "A String", # The final component of fullFileExtension. This is only available for files with binary content in Google Drive.
+ "hasAugmentedPermissions": True or False, # Whether any users are granted file access directly on this file. This field is only populated for shared drive files.
+ "permissions": [ # The full list of permissions for the file. This is only available if the requesting user can share the file. Not populated for items in shared drives.
+ { # A permission for a file. A permission grants a user, group, domain or the world access to a file or a folder hierarchy.
+ "domain": "A String", # The domain to which this permission refers.
+ "displayName": "A String", # A displayable name for users, groups or domains.
+ "teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead.
+ {
+ "inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead.
+ "role": "A String", # Deprecated - use permissionDetails/role instead.
+ "teamDrivePermissionType": "A String", # Deprecated - use permissionDetails/permissionType instead.
+ "inherited": True or False, # Deprecated - use permissionDetails/inherited instead.
+ },
+ ],
+ "allowFileDiscovery": True or False, # Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type domain or anyone.
+ "deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.
+ "kind": "drive#permission", # Identifies what kind of resource this is. Value: the fixed string "drive#permission".
+ "emailAddress": "A String", # The email address of the user or group to which this permission refers.
+ "photoLink": "A String", # A link to the user's profile photo, if available.
+ "permissionDetails": [ # 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.
+ {
+ "role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible:
+ # - organizer
+ # - fileOrganizer
+ # - writer
+ # - commenter
+ # - reader
+ "inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field and is only populated for members of the shared drive.
+ "permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible:
+ # - file
+ # - member
+ "inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field.
+ },
+ ],
+ "expirationTime": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration times have the following restrictions:
+ # - They can only be set on user and group permissions
+ # - The time must be in the future
+ # - The time cannot be more than a year in the future
+ "role": "A String", # The role granted by this permission. While new values may be supported in the future, the following are currently allowed:
+ # - owner
+ # - organizer
+ # - fileOrganizer
+ # - writer
+ # - commenter
+ # - reader
+ "type": "A String", # The type of the grantee. Valid values are:
+ # - user
+ # - group
+ # - domain
+ # - anyone
+ "id": "A String", # The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as permissionId.
+ },
+ ],
+ "headRevisionId": "A String", # The ID of the file's head revision. This is currently only available for files with binary content in Google Drive.
}</pre>
</div>
<div class="method">
- <code class="details" id="get_media">get_media(fileId, acknowledgeAbuse=None)</code>
+ <code class="details" id="get_media">get_media(fileId, supportsTeamDrives=None, supportsAllDrives=None, acknowledgeAbuse=None)</code>
<pre>Gets a file's metadata or content by ID.
Args:
fileId: string, The ID of the file. (required)
+ supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead.
+ supportsAllDrives: boolean, Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives.
acknowledgeAbuse: boolean, Whether the user is acknowledging the risk of downloading known malware or other abusive files. This is only applicable when alt=media.
Returns:
@@ -997,37 +1367,45 @@
</div>
<div class="method">
- <code class="details" id="list">list(orderBy=None, q=None, pageSize=None, pageToken=None, spaces=None, corpus=None)</code>
+ <code class="details" id="list">list(orderBy=None, pageSize=None, supportsTeamDrives=None, spaces=None, q=None, pageToken=None, corpus=None, teamDriveId=None, includeItemsFromAllDrives=None, includeTeamDriveItems=None, corpora=None, supportsAllDrives=None, driveId=None)</code>
<pre>Lists or searches files.
Args:
- orderBy: string, A comma-separated list of sort keys. Valid keys are 'createdTime', 'folder', 'modifiedByMeTime', 'modifiedTime', 'name', 'quotaBytesUsed', 'recency', 'sharedWithMeTime', 'starred', and 'viewedByMeTime'. Each key sorts ascending by default, but may be reversed with the 'desc' modifier. Example usage: ?orderBy=folder,modifiedTime desc,name. Please note that there is a current limitation for users with approximately one million files in which the requested sort order is ignored.
- q: string, A query for filtering the file results. See the "Search for Files" guide for supported syntax.
- pageSize: integer, The maximum number of files to return per page.
- 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.
+ orderBy: string, A comma-separated list of sort keys. Valid keys are 'createdTime', 'folder', 'modifiedByMeTime', 'modifiedTime', 'name', 'name_natural', 'quotaBytesUsed', 'recency', 'sharedWithMeTime', 'starred', and 'viewedByMeTime'. Each key sorts ascending by default, but may be reversed with the 'desc' modifier. Example usage: ?orderBy=folder,modifiedTime desc,name. Please note that there is a current limitation for users with approximately one million files in which the requested sort order is ignored.
+ pageSize: integer, The maximum number of files to return per page. Partial or empty result pages are possible even before the end of the files list has been reached.
+ supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead.
spaces: string, A comma-separated list of spaces to query within the corpus. Supported values are 'drive', 'appDataFolder' and 'photos'.
- corpus: string, The source of files to list.
+ q: string, A query for filtering the file results. See the "Search for Files" guide for supported syntax.
+ 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.
+ corpus: string, The source of files to list. Deprecated: use 'corpora' instead.
Allowed values
domain - Files shared to the user's domain.
user - Files owned by or shared to the user.
+ teamDriveId: string, Deprecated use driveId instead.
+ includeItemsFromAllDrives: boolean, Deprecated - Whether both My Drive and shared drive items should be included in results. This parameter will only be effective until June 1, 2020. Afterwards shared drive items will be included in the results.
+ includeTeamDriveItems: boolean, Deprecated use includeItemsFromAllDrives instead.
+ corpora: string, Bodies of items (files/documents) to which the query applies. Supported bodies are 'user', 'domain', 'drive' and 'allDrives'. Prefer 'user' or 'drive' to 'allDrives' for efficiency.
+ supportsAllDrives: boolean, Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives.
+ driveId: string, ID of the shared drive to search.
Returns:
An object of the form:
{ # A list of files.
- "files": [ # The page of files.
+ "files": [ # The list of files. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched.
{ # The metadata for a file.
- "hasThumbnail": True or False, # Whether this file has a thumbnail.
+ "hasThumbnail": True or False, # 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.
"mimeType": "A String", # The MIME type of the file.
- # Drive will attempt to automatically detect an appropriate value from uploaded content if no value is provided. The value cannot be changed unless a new revision is uploaded.
+ # Google Drive will attempt to automatically detect an appropriate value from uploaded content if no value is provided. The value cannot be changed unless a new revision is uploaded.
# If a file is created with a Google Doc MIME type, the uploaded content will be imported if possible. The supported import formats are published in the About resource.
"modifiedByMeTime": "A String", # The last time the file was modified by the user (RFC 3339 date-time).
"thumbnailLink": "A String", # A short-lived link to the file's thumbnail, if available. Typically lasts on the order of hours. Only populated when the requesting app can access the file's content.
- "thumbnailVersion": "A String", # The thumbnail version for use in client-contructable thumbnail URLs or thumbnail cache invalidation.
+ "thumbnailVersion": "A String", # The thumbnail version for use in thumbnail cache invalidation.
"explicitlyTrashed": True or False, # Whether the file has been explicitly trashed, as opposed to recursively trashed from a parent folder.
"isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app.
- "writersCanShare": True or False, # Whether users with only writer permission can modify the file's permissions.
- "ownedByMe": True or False, # Whether the user owns the file.
+ "teamDriveId": "A String", # Deprecated - use driveId instead.
+ "writersCanShare": True or False, # Whether users with only writer permission can modify the file's permissions. Not populated for items in shared drives.
+ "ownedByMe": True or False, # Whether the user owns the file. Not populated for items in shared drives.
"viewedByMeTime": "A String", # The last time the file was viewed by the user (RFC 3339 date-time).
"id": "A String", # The ID of the file.
"sharingUser": { # Information about a Drive user. # The user who shared the file with the requesting user, if applicable.
@@ -1038,7 +1416,7 @@
"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
"photoLink": "A String", # A link to the user's profile photo, if available.
},
- "size": "A String", # The size of the file's content in bytes. This is only applicable to files with binary content in Drive.
+ "size": "A String", # The size of the file's content in bytes. This is only applicable to files with binary content in Google Drive.
"videoMediaMetadata": { # Additional metadata about video media. This may not be available immediately upon upload.
"width": 42, # The width of the video in pixels.
"durationMillis": "A String", # The duration of the video in milliseconds.
@@ -1058,53 +1436,60 @@
# Entries with null values are cleared in update and copy requests.
"a_key": "A String",
},
- "capabilities": { # Capabilities the current user has on the file.
- "canReadRevisions": True or False, # Whether the current user has read access to the Revisions resource of the file.
- "canCopy": True or False, # Whether the user can copy the file.
- "canShare": True or False, # Whether the user can modify the file's permissions and sharing settings.
- "canEdit": True or False, # Whether the user can edit the file's content.
- "canComment": True or False, # Whether the user can comment on the file.
+ "capabilities": { # Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take.
+ "canMoveItemOutOfDrive": True or False, # 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.
+ "canUntrash": True or False, # Whether the current user can restore this file from trash.
+ "canMoveItemWithinTeamDrive": True or False, # Deprecated - use canMoveItemWithinDrive instead.
+ "canDeleteChildren": True or False, # 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.
+ "canMoveChildrenWithinTeamDrive": True or False, # Deprecated - use canMoveChildrenWithinDrive instead.
+ "canListChildren": True or False, # Whether the current user can list the children of this folder. This is always false when the item is not a folder.
+ "canRename": True or False, # Whether the current user can rename this file.
+ "canReadDrive": True or False, # Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives.
+ "canAddChildren": True or False, # Whether the current user can add children to this folder. This is always false when the item is not a folder.
+ "canShare": True or False, # Whether the current user can modify the sharing settings for this file.
+ "canTrashChildren": True or False, # 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.
+ "canMoveChildrenWithinDrive": True or False, # Whether the current user can move children of this folder within the shared drive. This is false when the item is not a folder. Only populated for items in shared drives.
+ "canReadRevisions": True or False, # 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.
+ "canMoveItemWithinDrive": True or False, # Whether the current user can move this item within this shared drive. Note that a request to change the parent of the item may still fail depending on the new parent that is being added. Only populated for items in shared drives.
+ "canCopy": True or False, # 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.
+ "canMoveItemIntoTeamDrive": True or False, # Deprecated - use canMoveItemOutOfDrive instead.
+ "canMoveItemOutOfTeamDrive": True or False, # Deprecated - use canMoveItemOutOfDrive instead.
+ "canComment": True or False, # Whether the current user can comment on this file.
+ "canMoveChildrenOutOfDrive": True or False, # 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.
+ "canChangeViewersCanCopyContent": True or False, # Deprecated
+ "canTrash": True or False, # Whether the current user can move this file to trash.
+ "canDelete": True or False, # Whether the current user can delete this file.
+ "canMoveTeamDriveItem": True or False, # Deprecated - use canMoveItemWithinDrive or canMoveItemOutOfDrive instead.
+ "canDownload": True or False, # Whether the current user can download this file.
+ "canChangeCopyRequiresWriterPermission": True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this file.
+ "canMoveChildrenOutOfTeamDrive": True or False, # Deprecated - use canMoveChildrenOutOfDrive instead.
+ "canRemoveChildren": True or False, # 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.
+ "canReadTeamDrive": True or False, # Deprecated - use canReadDrive instead.
+ "canEdit": True or False, # Whether the current user can edit this file.
},
+ "trashedTime": "A String", # The time that the item was trashed (RFC 3339 date-time). Only populated for items in shared drives.
"webViewLink": "A String", # A link for opening the file in a relevant Google editor or viewer in a browser.
"version": "A String", # A monotonically increasing version number for the file. This reflects every change made to the file on the server, even those not visible to the user.
"parents": [ # The IDs of the parent folders which contain the file.
- # If not specified as part of a create request, the file will be placed directly in the My Drive folder. Update requests must use the addParents and removeParents parameters to modify the values.
+ # If not specified as part of a create request, the file will be placed directly in the user's My Drive folder. If not specified as part of a copy request, the file will inherit any discoverable parents of the source file. Update requests must use the addParents and removeParents parameters to modify the parents list.
"A String",
],
"sharedWithMeTime": "A String", # The time at which the file was shared with the user, if applicable (RFC 3339 date-time).
- "shared": True or False, # Whether the file has been shared.
- "permissions": [ # The full list of permissions for the file. This is only available if the requesting user can share the file.
- { # A permission for a file. A permission grants a user, group, domain or the world access to a file or a folder hierarchy.
- "domain": "A String", # The domain to which this permission refers.
- "displayName": "A String", # A displayable name for users, groups or domains.
- "allowFileDiscovery": True or False, # Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type domain or anyone.
- "kind": "drive#permission", # Identifies what kind of resource this is. Value: the fixed string "drive#permission".
- "emailAddress": "A String", # The email address of the user or group to which this permission refers.
- "photoLink": "A String", # A link to the user's profile photo, if available.
- "role": "A String", # The role granted by this permission. Valid values are:
- # - owner
- # - writer
- # - commenter
- # - reader
- "expirationTime": "A String", # The time at which this permission will expire (RFC 3339 date-time).
- "type": "A String", # The type of the grantee. Valid values are:
- # - user
- # - group
- # - domain
- # - anyone
- "id": "A String", # The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as permissionId.
- },
- ],
- "fullFileExtension": "A String", # The full file extension extracted from the name field. May contain multiple concatenated extensions, such as "tar.gz". This is only available for files with binary content in Drive.
+ "exportLinks": { # Links for exporting Google Docs to specific formats.
+ "a_key": "A String", # A mapping from export format to URL
+ },
+ "shared": True or False, # Whether the file has been shared. Not populated for items in shared drives.
+ "copyRequiresWriterPermission": True or False, # Whether the options to copy, print, or download this file, should be disabled for readers and commenters.
+ "fullFileExtension": "A String", # The full file extension extracted from the name field. May contain multiple concatenated extensions, such as "tar.gz". This is only available for files with binary content in Google Drive.
# This is automatically updated when the name field changes, however it is not cleared if the new name does not contain a valid extension.
- "originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the name field. This is only available for files with binary content in Drive.
- "viewersCanCopyContent": True or False, # Whether users with only reader or commenter permission can copy the file's content. This affects copy, download, and print operations.
+ "originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the name field. This is only available for files with binary content in Google Drive.
+ "viewersCanCopyContent": True or False, # Deprecated - use copyRequiresWriterPermission instead.
"description": "A String", # A short description of the file.
"modifiedTime": "A String", # The last time the file was modified by anyone (RFC 3339 date-time).
# Note that setting modifiedTime will also update modifiedByMeTime for the user.
"viewedByMe": True or False, # Whether the file has been viewed by this user.
"modifiedByMe": True or False, # Whether the file has been modified by this user.
- "owners": [ # The owners of the file. Currently, only certain legacy files may have more than one owner.
+ "owners": [ # The owners of the file. Currently, only certain legacy files may have more than one owner. Not populated for items in shared drives.
{ # Information about a Drive user.
"me": True or False, # Whether this user is the requesting user.
"kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
@@ -1116,11 +1501,12 @@
],
"createdTime": "A String", # The time at which the file was created (RFC 3339 date-time).
"quotaBytesUsed": "A String", # The number of storage quota bytes used by the file. This includes the head revision as well as previous revisions with keepForever enabled.
+ "starred": True or False, # Whether the user has starred the file.
"properties": { # A collection of arbitrary key-value pairs which are visible to all apps.
# Entries with null values are cleared in update and copy requests.
"a_key": "A String",
},
- "md5Checksum": "A String", # The MD5 checksum for the content of the file. This is only applicable to files with binary content in Drive.
+ "md5Checksum": "A String", # The MD5 checksum for the content of the file. This is only applicable to files with binary content in Google Drive.
"iconLink": "A String", # A static, unauthenticated link to the file's icon.
"imageMediaMetadata": { # Additional metadata about image media, if available.
"exposureBias": 3.14, # The exposure bias of the photo (APEX value).
@@ -1150,26 +1536,90 @@
"cameraModel": "A String", # The model of the camera used to create the photo.
},
"kind": "drive#file", # Identifies what kind of resource this is. Value: the fixed string "drive#file".
- "name": "A String", # The name of the file. This is not necessarily unique within a folder.
- "webContentLink": "A String", # A link for downloading the content of the file in a browser. This is only available for files with binary content in Drive.
+ "name": "A String", # The name of the file. This is not necessarily unique within a folder. Note that for immutable items such as the top level folders of shared drives, My Drive root folder, and Application Data folder the name is constant.
+ "webContentLink": "A String", # A link for downloading the content of the file in a browser. This is only available for files with binary content in Google Drive.
+ "trashingUser": { # Information about a Drive user. # If the file has been explicitly trashed, the user who trashed it. Only populated for items in shared drives.
+ "me": True or False, # Whether this user is the requesting user.
+ "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
+ "displayName": "A String", # A plain text displayable name for this user.
+ "permissionId": "A String", # The user's ID as visible in Permission resources.
+ "emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
+ "photoLink": "A String", # A link to the user's profile photo, if available.
+ },
+ "driveId": "A String", # ID of the shared drive the file resides in. Only populated for items in shared drives.
"spaces": [ # The list of spaces which contain the file. The currently supported values are 'drive', 'appDataFolder' and 'photos'.
"A String",
],
+ "permissionIds": [ # List of permission IDs for users with access to this file.
+ "A String",
+ ],
"trashed": True or False, # Whether the file has been trashed, either explicitly or from a trashed parent folder. Only the owner may trash a file, and other users cannot see files in the owner's trash.
"contentHints": { # Additional information about the content of the file. These fields are never populated in responses.
"indexableText": "A String", # Text to be indexed for the file to improve fullText queries. This is limited to 128KB in length and may contain HTML elements.
- "thumbnail": { # A thumbnail for the file. This will only be used if Drive cannot generate a standard thumbnail.
+ "thumbnail": { # A thumbnail for the file. This will only be used if Google Drive cannot generate a standard thumbnail.
"mimeType": "A String", # The MIME type of the thumbnail.
"image": "A String", # The thumbnail data encoded with URL-safe Base64 (RFC 4648 section 5).
},
},
- "fileExtension": "A String", # The final component of fullFileExtension. This is only available for files with binary content in Drive.
- "starred": True or False, # Whether the user has starred the file.
- "headRevisionId": "A String", # The ID of the file's head revision. This is currently only available for files with binary content in Drive.
+ "fileExtension": "A String", # The final component of fullFileExtension. This is only available for files with binary content in Google Drive.
+ "hasAugmentedPermissions": True or False, # Whether any users are granted file access directly on this file. This field is only populated for shared drive files.
+ "permissions": [ # The full list of permissions for the file. This is only available if the requesting user can share the file. Not populated for items in shared drives.
+ { # A permission for a file. A permission grants a user, group, domain or the world access to a file or a folder hierarchy.
+ "domain": "A String", # The domain to which this permission refers.
+ "displayName": "A String", # A displayable name for users, groups or domains.
+ "teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead.
+ {
+ "inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead.
+ "role": "A String", # Deprecated - use permissionDetails/role instead.
+ "teamDrivePermissionType": "A String", # Deprecated - use permissionDetails/permissionType instead.
+ "inherited": True or False, # Deprecated - use permissionDetails/inherited instead.
+ },
+ ],
+ "allowFileDiscovery": True or False, # Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type domain or anyone.
+ "deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.
+ "kind": "drive#permission", # Identifies what kind of resource this is. Value: the fixed string "drive#permission".
+ "emailAddress": "A String", # The email address of the user or group to which this permission refers.
+ "photoLink": "A String", # A link to the user's profile photo, if available.
+ "permissionDetails": [ # 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.
+ {
+ "role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible:
+ # - organizer
+ # - fileOrganizer
+ # - writer
+ # - commenter
+ # - reader
+ "inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field and is only populated for members of the shared drive.
+ "permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible:
+ # - file
+ # - member
+ "inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field.
+ },
+ ],
+ "expirationTime": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration times have the following restrictions:
+ # - They can only be set on user and group permissions
+ # - The time must be in the future
+ # - The time cannot be more than a year in the future
+ "role": "A String", # The role granted by this permission. While new values may be supported in the future, the following are currently allowed:
+ # - owner
+ # - organizer
+ # - fileOrganizer
+ # - writer
+ # - commenter
+ # - reader
+ "type": "A String", # The type of the grantee. Valid values are:
+ # - user
+ # - group
+ # - domain
+ # - anyone
+ "id": "A String", # The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as permissionId.
+ },
+ ],
+ "headRevisionId": "A String", # The ID of the file's head revision. This is currently only available for files with binary content in Google Drive.
},
],
- "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.
+ "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 "user" or "drive".
"kind": "drive#fileList", # Identifies what kind of resource this is. Value: the fixed string "drive#fileList".
+ "nextPageToken": "A String", # The page token for the next page of files. This will be absent if the end of the files list has been reached. If the token is rejected for any reason, it should be discarded, and pagination should be restarted from the first page of results.
}</pre>
</div>
@@ -1188,7 +1638,7 @@
</div>
<div class="method">
- <code class="details" id="update">update(fileId, body=None, media_body=None, addParents=None, removeParents=None, media_mime_type=None, useContentAsIndexableText=None, keepRevisionForever=None, ocrLanguage=None)</code>
+ <code class="details" id="update">update(fileId, body=None, keepRevisionForever=None, removeParents=None, supportsTeamDrives=None, media_body=None, ocrLanguage=None, addParents=None, useContentAsIndexableText=None, supportsAllDrives=None, media_mime_type=None)</code>
<pre>Updates a file's metadata and/or content with patch semantics.
Args:
@@ -1197,17 +1647,18 @@
The object takes the form of:
{ # The metadata for a file.
- "hasThumbnail": True or False, # Whether this file has a thumbnail.
+ "hasThumbnail": True or False, # 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.
"mimeType": "A String", # The MIME type of the file.
- # Drive will attempt to automatically detect an appropriate value from uploaded content if no value is provided. The value cannot be changed unless a new revision is uploaded.
+ # Google Drive will attempt to automatically detect an appropriate value from uploaded content if no value is provided. The value cannot be changed unless a new revision is uploaded.
# If a file is created with a Google Doc MIME type, the uploaded content will be imported if possible. The supported import formats are published in the About resource.
"modifiedByMeTime": "A String", # The last time the file was modified by the user (RFC 3339 date-time).
"thumbnailLink": "A String", # A short-lived link to the file's thumbnail, if available. Typically lasts on the order of hours. Only populated when the requesting app can access the file's content.
- "thumbnailVersion": "A String", # The thumbnail version for use in client-contructable thumbnail URLs or thumbnail cache invalidation.
+ "thumbnailVersion": "A String", # The thumbnail version for use in thumbnail cache invalidation.
"explicitlyTrashed": True or False, # Whether the file has been explicitly trashed, as opposed to recursively trashed from a parent folder.
"isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app.
- "writersCanShare": True or False, # Whether users with only writer permission can modify the file's permissions.
- "ownedByMe": True or False, # Whether the user owns the file.
+ "teamDriveId": "A String", # Deprecated - use driveId instead.
+ "writersCanShare": True or False, # Whether users with only writer permission can modify the file's permissions. Not populated for items in shared drives.
+ "ownedByMe": True or False, # Whether the user owns the file. Not populated for items in shared drives.
"viewedByMeTime": "A String", # The last time the file was viewed by the user (RFC 3339 date-time).
"id": "A String", # The ID of the file.
"sharingUser": { # Information about a Drive user. # The user who shared the file with the requesting user, if applicable.
@@ -1218,7 +1669,7 @@
"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
"photoLink": "A String", # A link to the user's profile photo, if available.
},
- "size": "A String", # The size of the file's content in bytes. This is only applicable to files with binary content in Drive.
+ "size": "A String", # The size of the file's content in bytes. This is only applicable to files with binary content in Google Drive.
"videoMediaMetadata": { # Additional metadata about video media. This may not be available immediately upon upload.
"width": 42, # The width of the video in pixels.
"durationMillis": "A String", # The duration of the video in milliseconds.
@@ -1238,53 +1689,60 @@
# Entries with null values are cleared in update and copy requests.
"a_key": "A String",
},
- "capabilities": { # Capabilities the current user has on the file.
- "canReadRevisions": True or False, # Whether the current user has read access to the Revisions resource of the file.
- "canCopy": True or False, # Whether the user can copy the file.
- "canShare": True or False, # Whether the user can modify the file's permissions and sharing settings.
- "canEdit": True or False, # Whether the user can edit the file's content.
- "canComment": True or False, # Whether the user can comment on the file.
+ "capabilities": { # Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take.
+ "canMoveItemOutOfDrive": True or False, # 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.
+ "canUntrash": True or False, # Whether the current user can restore this file from trash.
+ "canMoveItemWithinTeamDrive": True or False, # Deprecated - use canMoveItemWithinDrive instead.
+ "canDeleteChildren": True or False, # 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.
+ "canMoveChildrenWithinTeamDrive": True or False, # Deprecated - use canMoveChildrenWithinDrive instead.
+ "canListChildren": True or False, # Whether the current user can list the children of this folder. This is always false when the item is not a folder.
+ "canRename": True or False, # Whether the current user can rename this file.
+ "canReadDrive": True or False, # Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives.
+ "canAddChildren": True or False, # Whether the current user can add children to this folder. This is always false when the item is not a folder.
+ "canShare": True or False, # Whether the current user can modify the sharing settings for this file.
+ "canTrashChildren": True or False, # 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.
+ "canMoveChildrenWithinDrive": True or False, # Whether the current user can move children of this folder within the shared drive. This is false when the item is not a folder. Only populated for items in shared drives.
+ "canReadRevisions": True or False, # 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.
+ "canMoveItemWithinDrive": True or False, # Whether the current user can move this item within this shared drive. Note that a request to change the parent of the item may still fail depending on the new parent that is being added. Only populated for items in shared drives.
+ "canCopy": True or False, # 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.
+ "canMoveItemIntoTeamDrive": True or False, # Deprecated - use canMoveItemOutOfDrive instead.
+ "canMoveItemOutOfTeamDrive": True or False, # Deprecated - use canMoveItemOutOfDrive instead.
+ "canComment": True or False, # Whether the current user can comment on this file.
+ "canMoveChildrenOutOfDrive": True or False, # 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.
+ "canChangeViewersCanCopyContent": True or False, # Deprecated
+ "canTrash": True or False, # Whether the current user can move this file to trash.
+ "canDelete": True or False, # Whether the current user can delete this file.
+ "canMoveTeamDriveItem": True or False, # Deprecated - use canMoveItemWithinDrive or canMoveItemOutOfDrive instead.
+ "canDownload": True or False, # Whether the current user can download this file.
+ "canChangeCopyRequiresWriterPermission": True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this file.
+ "canMoveChildrenOutOfTeamDrive": True or False, # Deprecated - use canMoveChildrenOutOfDrive instead.
+ "canRemoveChildren": True or False, # 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.
+ "canReadTeamDrive": True or False, # Deprecated - use canReadDrive instead.
+ "canEdit": True or False, # Whether the current user can edit this file.
},
+ "trashedTime": "A String", # The time that the item was trashed (RFC 3339 date-time). Only populated for items in shared drives.
"webViewLink": "A String", # A link for opening the file in a relevant Google editor or viewer in a browser.
"version": "A String", # A monotonically increasing version number for the file. This reflects every change made to the file on the server, even those not visible to the user.
"parents": [ # The IDs of the parent folders which contain the file.
- # If not specified as part of a create request, the file will be placed directly in the My Drive folder. Update requests must use the addParents and removeParents parameters to modify the values.
+ # If not specified as part of a create request, the file will be placed directly in the user's My Drive folder. If not specified as part of a copy request, the file will inherit any discoverable parents of the source file. Update requests must use the addParents and removeParents parameters to modify the parents list.
"A String",
],
"sharedWithMeTime": "A String", # The time at which the file was shared with the user, if applicable (RFC 3339 date-time).
- "shared": True or False, # Whether the file has been shared.
- "permissions": [ # The full list of permissions for the file. This is only available if the requesting user can share the file.
- { # A permission for a file. A permission grants a user, group, domain or the world access to a file or a folder hierarchy.
- "domain": "A String", # The domain to which this permission refers.
- "displayName": "A String", # A displayable name for users, groups or domains.
- "allowFileDiscovery": True or False, # Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type domain or anyone.
- "kind": "drive#permission", # Identifies what kind of resource this is. Value: the fixed string "drive#permission".
- "emailAddress": "A String", # The email address of the user or group to which this permission refers.
- "photoLink": "A String", # A link to the user's profile photo, if available.
- "role": "A String", # The role granted by this permission. Valid values are:
- # - owner
- # - writer
- # - commenter
- # - reader
- "expirationTime": "A String", # The time at which this permission will expire (RFC 3339 date-time).
- "type": "A String", # The type of the grantee. Valid values are:
- # - user
- # - group
- # - domain
- # - anyone
- "id": "A String", # The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as permissionId.
- },
- ],
- "fullFileExtension": "A String", # The full file extension extracted from the name field. May contain multiple concatenated extensions, such as "tar.gz". This is only available for files with binary content in Drive.
+ "exportLinks": { # Links for exporting Google Docs to specific formats.
+ "a_key": "A String", # A mapping from export format to URL
+ },
+ "shared": True or False, # Whether the file has been shared. Not populated for items in shared drives.
+ "copyRequiresWriterPermission": True or False, # Whether the options to copy, print, or download this file, should be disabled for readers and commenters.
+ "fullFileExtension": "A String", # The full file extension extracted from the name field. May contain multiple concatenated extensions, such as "tar.gz". This is only available for files with binary content in Google Drive.
# This is automatically updated when the name field changes, however it is not cleared if the new name does not contain a valid extension.
- "originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the name field. This is only available for files with binary content in Drive.
- "viewersCanCopyContent": True or False, # Whether users with only reader or commenter permission can copy the file's content. This affects copy, download, and print operations.
+ "originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the name field. This is only available for files with binary content in Google Drive.
+ "viewersCanCopyContent": True or False, # Deprecated - use copyRequiresWriterPermission instead.
"description": "A String", # A short description of the file.
"modifiedTime": "A String", # The last time the file was modified by anyone (RFC 3339 date-time).
# Note that setting modifiedTime will also update modifiedByMeTime for the user.
"viewedByMe": True or False, # Whether the file has been viewed by this user.
"modifiedByMe": True or False, # Whether the file has been modified by this user.
- "owners": [ # The owners of the file. Currently, only certain legacy files may have more than one owner.
+ "owners": [ # The owners of the file. Currently, only certain legacy files may have more than one owner. Not populated for items in shared drives.
{ # Information about a Drive user.
"me": True or False, # Whether this user is the requesting user.
"kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
@@ -1296,11 +1754,12 @@
],
"createdTime": "A String", # The time at which the file was created (RFC 3339 date-time).
"quotaBytesUsed": "A String", # The number of storage quota bytes used by the file. This includes the head revision as well as previous revisions with keepForever enabled.
+ "starred": True or False, # Whether the user has starred the file.
"properties": { # A collection of arbitrary key-value pairs which are visible to all apps.
# Entries with null values are cleared in update and copy requests.
"a_key": "A String",
},
- "md5Checksum": "A String", # The MD5 checksum for the content of the file. This is only applicable to files with binary content in Drive.
+ "md5Checksum": "A String", # The MD5 checksum for the content of the file. This is only applicable to files with binary content in Google Drive.
"iconLink": "A String", # A static, unauthenticated link to the file's icon.
"imageMediaMetadata": { # Additional metadata about image media, if available.
"exposureBias": 3.14, # The exposure bias of the photo (APEX value).
@@ -1330,47 +1789,113 @@
"cameraModel": "A String", # The model of the camera used to create the photo.
},
"kind": "drive#file", # Identifies what kind of resource this is. Value: the fixed string "drive#file".
- "name": "A String", # The name of the file. This is not necessarily unique within a folder.
- "webContentLink": "A String", # A link for downloading the content of the file in a browser. This is only available for files with binary content in Drive.
+ "name": "A String", # The name of the file. This is not necessarily unique within a folder. Note that for immutable items such as the top level folders of shared drives, My Drive root folder, and Application Data folder the name is constant.
+ "webContentLink": "A String", # A link for downloading the content of the file in a browser. This is only available for files with binary content in Google Drive.
+ "trashingUser": { # Information about a Drive user. # If the file has been explicitly trashed, the user who trashed it. Only populated for items in shared drives.
+ "me": True or False, # Whether this user is the requesting user.
+ "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
+ "displayName": "A String", # A plain text displayable name for this user.
+ "permissionId": "A String", # The user's ID as visible in Permission resources.
+ "emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
+ "photoLink": "A String", # A link to the user's profile photo, if available.
+ },
+ "driveId": "A String", # ID of the shared drive the file resides in. Only populated for items in shared drives.
"spaces": [ # The list of spaces which contain the file. The currently supported values are 'drive', 'appDataFolder' and 'photos'.
"A String",
],
+ "permissionIds": [ # List of permission IDs for users with access to this file.
+ "A String",
+ ],
"trashed": True or False, # Whether the file has been trashed, either explicitly or from a trashed parent folder. Only the owner may trash a file, and other users cannot see files in the owner's trash.
"contentHints": { # Additional information about the content of the file. These fields are never populated in responses.
"indexableText": "A String", # Text to be indexed for the file to improve fullText queries. This is limited to 128KB in length and may contain HTML elements.
- "thumbnail": { # A thumbnail for the file. This will only be used if Drive cannot generate a standard thumbnail.
+ "thumbnail": { # A thumbnail for the file. This will only be used if Google Drive cannot generate a standard thumbnail.
"mimeType": "A String", # The MIME type of the thumbnail.
"image": "A String", # The thumbnail data encoded with URL-safe Base64 (RFC 4648 section 5).
},
},
- "fileExtension": "A String", # The final component of fullFileExtension. This is only available for files with binary content in Drive.
- "starred": True or False, # Whether the user has starred the file.
- "headRevisionId": "A String", # The ID of the file's head revision. This is currently only available for files with binary content in Drive.
+ "fileExtension": "A String", # The final component of fullFileExtension. This is only available for files with binary content in Google Drive.
+ "hasAugmentedPermissions": True or False, # Whether any users are granted file access directly on this file. This field is only populated for shared drive files.
+ "permissions": [ # The full list of permissions for the file. This is only available if the requesting user can share the file. Not populated for items in shared drives.
+ { # A permission for a file. A permission grants a user, group, domain or the world access to a file or a folder hierarchy.
+ "domain": "A String", # The domain to which this permission refers.
+ "displayName": "A String", # A displayable name for users, groups or domains.
+ "teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead.
+ {
+ "inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead.
+ "role": "A String", # Deprecated - use permissionDetails/role instead.
+ "teamDrivePermissionType": "A String", # Deprecated - use permissionDetails/permissionType instead.
+ "inherited": True or False, # Deprecated - use permissionDetails/inherited instead.
+ },
+ ],
+ "allowFileDiscovery": True or False, # Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type domain or anyone.
+ "deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.
+ "kind": "drive#permission", # Identifies what kind of resource this is. Value: the fixed string "drive#permission".
+ "emailAddress": "A String", # The email address of the user or group to which this permission refers.
+ "photoLink": "A String", # A link to the user's profile photo, if available.
+ "permissionDetails": [ # 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.
+ {
+ "role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible:
+ # - organizer
+ # - fileOrganizer
+ # - writer
+ # - commenter
+ # - reader
+ "inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field and is only populated for members of the shared drive.
+ "permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible:
+ # - file
+ # - member
+ "inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field.
+ },
+ ],
+ "expirationTime": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration times have the following restrictions:
+ # - They can only be set on user and group permissions
+ # - The time must be in the future
+ # - The time cannot be more than a year in the future
+ "role": "A String", # The role granted by this permission. While new values may be supported in the future, the following are currently allowed:
+ # - owner
+ # - organizer
+ # - fileOrganizer
+ # - writer
+ # - commenter
+ # - reader
+ "type": "A String", # The type of the grantee. Valid values are:
+ # - user
+ # - group
+ # - domain
+ # - anyone
+ "id": "A String", # The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as permissionId.
+ },
+ ],
+ "headRevisionId": "A String", # The ID of the file's head revision. This is currently only available for files with binary content in Google Drive.
}
- media_body: string, The filename of the media request body, or an instance of a MediaUpload object.
- addParents: string, A comma-separated list of parent IDs to add.
+ keepRevisionForever: boolean, Whether to set the 'keepForever' field in the new head revision. This is only applicable to files with binary content in Google Drive.
removeParents: string, A comma-separated list of parent IDs to remove.
- media_mime_type: string, The MIME type of the media request body, or an instance of a MediaUpload object.
- useContentAsIndexableText: boolean, Whether to use the uploaded content as indexable text.
- keepRevisionForever: boolean, Whether to set the 'keepForever' field in the new head revision. This is only applicable to files with binary content in Drive.
+ supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead.
+ media_body: string, The filename of the media request body, or an instance of a MediaUpload object.
ocrLanguage: string, A language hint for OCR processing during image import (ISO 639-1 code).
+ addParents: string, A comma-separated list of parent IDs to add.
+ useContentAsIndexableText: boolean, Whether to use the uploaded content as indexable text.
+ supportsAllDrives: boolean, Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives.
+ media_mime_type: string, The MIME type of the media request body, or an instance of a MediaUpload object.
Returns:
An object of the form:
{ # The metadata for a file.
- "hasThumbnail": True or False, # Whether this file has a thumbnail.
+ "hasThumbnail": True or False, # 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.
"mimeType": "A String", # The MIME type of the file.
- # Drive will attempt to automatically detect an appropriate value from uploaded content if no value is provided. The value cannot be changed unless a new revision is uploaded.
+ # Google Drive will attempt to automatically detect an appropriate value from uploaded content if no value is provided. The value cannot be changed unless a new revision is uploaded.
# If a file is created with a Google Doc MIME type, the uploaded content will be imported if possible. The supported import formats are published in the About resource.
"modifiedByMeTime": "A String", # The last time the file was modified by the user (RFC 3339 date-time).
"thumbnailLink": "A String", # A short-lived link to the file's thumbnail, if available. Typically lasts on the order of hours. Only populated when the requesting app can access the file's content.
- "thumbnailVersion": "A String", # The thumbnail version for use in client-contructable thumbnail URLs or thumbnail cache invalidation.
+ "thumbnailVersion": "A String", # The thumbnail version for use in thumbnail cache invalidation.
"explicitlyTrashed": True or False, # Whether the file has been explicitly trashed, as opposed to recursively trashed from a parent folder.
"isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app.
- "writersCanShare": True or False, # Whether users with only writer permission can modify the file's permissions.
- "ownedByMe": True or False, # Whether the user owns the file.
+ "teamDriveId": "A String", # Deprecated - use driveId instead.
+ "writersCanShare": True or False, # Whether users with only writer permission can modify the file's permissions. Not populated for items in shared drives.
+ "ownedByMe": True or False, # Whether the user owns the file. Not populated for items in shared drives.
"viewedByMeTime": "A String", # The last time the file was viewed by the user (RFC 3339 date-time).
"id": "A String", # The ID of the file.
"sharingUser": { # Information about a Drive user. # The user who shared the file with the requesting user, if applicable.
@@ -1381,7 +1906,7 @@
"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
"photoLink": "A String", # A link to the user's profile photo, if available.
},
- "size": "A String", # The size of the file's content in bytes. This is only applicable to files with binary content in Drive.
+ "size": "A String", # The size of the file's content in bytes. This is only applicable to files with binary content in Google Drive.
"videoMediaMetadata": { # Additional metadata about video media. This may not be available immediately upon upload.
"width": 42, # The width of the video in pixels.
"durationMillis": "A String", # The duration of the video in milliseconds.
@@ -1401,53 +1926,60 @@
# Entries with null values are cleared in update and copy requests.
"a_key": "A String",
},
- "capabilities": { # Capabilities the current user has on the file.
- "canReadRevisions": True or False, # Whether the current user has read access to the Revisions resource of the file.
- "canCopy": True or False, # Whether the user can copy the file.
- "canShare": True or False, # Whether the user can modify the file's permissions and sharing settings.
- "canEdit": True or False, # Whether the user can edit the file's content.
- "canComment": True or False, # Whether the user can comment on the file.
+ "capabilities": { # Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take.
+ "canMoveItemOutOfDrive": True or False, # 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.
+ "canUntrash": True or False, # Whether the current user can restore this file from trash.
+ "canMoveItemWithinTeamDrive": True or False, # Deprecated - use canMoveItemWithinDrive instead.
+ "canDeleteChildren": True or False, # 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.
+ "canMoveChildrenWithinTeamDrive": True or False, # Deprecated - use canMoveChildrenWithinDrive instead.
+ "canListChildren": True or False, # Whether the current user can list the children of this folder. This is always false when the item is not a folder.
+ "canRename": True or False, # Whether the current user can rename this file.
+ "canReadDrive": True or False, # Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives.
+ "canAddChildren": True or False, # Whether the current user can add children to this folder. This is always false when the item is not a folder.
+ "canShare": True or False, # Whether the current user can modify the sharing settings for this file.
+ "canTrashChildren": True or False, # 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.
+ "canMoveChildrenWithinDrive": True or False, # Whether the current user can move children of this folder within the shared drive. This is false when the item is not a folder. Only populated for items in shared drives.
+ "canReadRevisions": True or False, # 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.
+ "canMoveItemWithinDrive": True or False, # Whether the current user can move this item within this shared drive. Note that a request to change the parent of the item may still fail depending on the new parent that is being added. Only populated for items in shared drives.
+ "canCopy": True or False, # 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.
+ "canMoveItemIntoTeamDrive": True or False, # Deprecated - use canMoveItemOutOfDrive instead.
+ "canMoveItemOutOfTeamDrive": True or False, # Deprecated - use canMoveItemOutOfDrive instead.
+ "canComment": True or False, # Whether the current user can comment on this file.
+ "canMoveChildrenOutOfDrive": True or False, # 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.
+ "canChangeViewersCanCopyContent": True or False, # Deprecated
+ "canTrash": True or False, # Whether the current user can move this file to trash.
+ "canDelete": True or False, # Whether the current user can delete this file.
+ "canMoveTeamDriveItem": True or False, # Deprecated - use canMoveItemWithinDrive or canMoveItemOutOfDrive instead.
+ "canDownload": True or False, # Whether the current user can download this file.
+ "canChangeCopyRequiresWriterPermission": True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this file.
+ "canMoveChildrenOutOfTeamDrive": True or False, # Deprecated - use canMoveChildrenOutOfDrive instead.
+ "canRemoveChildren": True or False, # 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.
+ "canReadTeamDrive": True or False, # Deprecated - use canReadDrive instead.
+ "canEdit": True or False, # Whether the current user can edit this file.
},
+ "trashedTime": "A String", # The time that the item was trashed (RFC 3339 date-time). Only populated for items in shared drives.
"webViewLink": "A String", # A link for opening the file in a relevant Google editor or viewer in a browser.
"version": "A String", # A monotonically increasing version number for the file. This reflects every change made to the file on the server, even those not visible to the user.
"parents": [ # The IDs of the parent folders which contain the file.
- # If not specified as part of a create request, the file will be placed directly in the My Drive folder. Update requests must use the addParents and removeParents parameters to modify the values.
+ # If not specified as part of a create request, the file will be placed directly in the user's My Drive folder. If not specified as part of a copy request, the file will inherit any discoverable parents of the source file. Update requests must use the addParents and removeParents parameters to modify the parents list.
"A String",
],
"sharedWithMeTime": "A String", # The time at which the file was shared with the user, if applicable (RFC 3339 date-time).
- "shared": True or False, # Whether the file has been shared.
- "permissions": [ # The full list of permissions for the file. This is only available if the requesting user can share the file.
- { # A permission for a file. A permission grants a user, group, domain or the world access to a file or a folder hierarchy.
- "domain": "A String", # The domain to which this permission refers.
- "displayName": "A String", # A displayable name for users, groups or domains.
- "allowFileDiscovery": True or False, # Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type domain or anyone.
- "kind": "drive#permission", # Identifies what kind of resource this is. Value: the fixed string "drive#permission".
- "emailAddress": "A String", # The email address of the user or group to which this permission refers.
- "photoLink": "A String", # A link to the user's profile photo, if available.
- "role": "A String", # The role granted by this permission. Valid values are:
- # - owner
- # - writer
- # - commenter
- # - reader
- "expirationTime": "A String", # The time at which this permission will expire (RFC 3339 date-time).
- "type": "A String", # The type of the grantee. Valid values are:
- # - user
- # - group
- # - domain
- # - anyone
- "id": "A String", # The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as permissionId.
- },
- ],
- "fullFileExtension": "A String", # The full file extension extracted from the name field. May contain multiple concatenated extensions, such as "tar.gz". This is only available for files with binary content in Drive.
+ "exportLinks": { # Links for exporting Google Docs to specific formats.
+ "a_key": "A String", # A mapping from export format to URL
+ },
+ "shared": True or False, # Whether the file has been shared. Not populated for items in shared drives.
+ "copyRequiresWriterPermission": True or False, # Whether the options to copy, print, or download this file, should be disabled for readers and commenters.
+ "fullFileExtension": "A String", # The full file extension extracted from the name field. May contain multiple concatenated extensions, such as "tar.gz". This is only available for files with binary content in Google Drive.
# This is automatically updated when the name field changes, however it is not cleared if the new name does not contain a valid extension.
- "originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the name field. This is only available for files with binary content in Drive.
- "viewersCanCopyContent": True or False, # Whether users with only reader or commenter permission can copy the file's content. This affects copy, download, and print operations.
+ "originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the name field. This is only available for files with binary content in Google Drive.
+ "viewersCanCopyContent": True or False, # Deprecated - use copyRequiresWriterPermission instead.
"description": "A String", # A short description of the file.
"modifiedTime": "A String", # The last time the file was modified by anyone (RFC 3339 date-time).
# Note that setting modifiedTime will also update modifiedByMeTime for the user.
"viewedByMe": True or False, # Whether the file has been viewed by this user.
"modifiedByMe": True or False, # Whether the file has been modified by this user.
- "owners": [ # The owners of the file. Currently, only certain legacy files may have more than one owner.
+ "owners": [ # The owners of the file. Currently, only certain legacy files may have more than one owner. Not populated for items in shared drives.
{ # Information about a Drive user.
"me": True or False, # Whether this user is the requesting user.
"kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
@@ -1459,11 +1991,12 @@
],
"createdTime": "A String", # The time at which the file was created (RFC 3339 date-time).
"quotaBytesUsed": "A String", # The number of storage quota bytes used by the file. This includes the head revision as well as previous revisions with keepForever enabled.
+ "starred": True or False, # Whether the user has starred the file.
"properties": { # A collection of arbitrary key-value pairs which are visible to all apps.
# Entries with null values are cleared in update and copy requests.
"a_key": "A String",
},
- "md5Checksum": "A String", # The MD5 checksum for the content of the file. This is only applicable to files with binary content in Drive.
+ "md5Checksum": "A String", # The MD5 checksum for the content of the file. This is only applicable to files with binary content in Google Drive.
"iconLink": "A String", # A static, unauthenticated link to the file's icon.
"imageMediaMetadata": { # Additional metadata about image media, if available.
"exposureBias": 3.14, # The exposure bias of the photo (APEX value).
@@ -1493,27 +2026,90 @@
"cameraModel": "A String", # The model of the camera used to create the photo.
},
"kind": "drive#file", # Identifies what kind of resource this is. Value: the fixed string "drive#file".
- "name": "A String", # The name of the file. This is not necessarily unique within a folder.
- "webContentLink": "A String", # A link for downloading the content of the file in a browser. This is only available for files with binary content in Drive.
+ "name": "A String", # The name of the file. This is not necessarily unique within a folder. Note that for immutable items such as the top level folders of shared drives, My Drive root folder, and Application Data folder the name is constant.
+ "webContentLink": "A String", # A link for downloading the content of the file in a browser. This is only available for files with binary content in Google Drive.
+ "trashingUser": { # Information about a Drive user. # If the file has been explicitly trashed, the user who trashed it. Only populated for items in shared drives.
+ "me": True or False, # Whether this user is the requesting user.
+ "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
+ "displayName": "A String", # A plain text displayable name for this user.
+ "permissionId": "A String", # The user's ID as visible in Permission resources.
+ "emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
+ "photoLink": "A String", # A link to the user's profile photo, if available.
+ },
+ "driveId": "A String", # ID of the shared drive the file resides in. Only populated for items in shared drives.
"spaces": [ # The list of spaces which contain the file. The currently supported values are 'drive', 'appDataFolder' and 'photos'.
"A String",
],
+ "permissionIds": [ # List of permission IDs for users with access to this file.
+ "A String",
+ ],
"trashed": True or False, # Whether the file has been trashed, either explicitly or from a trashed parent folder. Only the owner may trash a file, and other users cannot see files in the owner's trash.
"contentHints": { # Additional information about the content of the file. These fields are never populated in responses.
"indexableText": "A String", # Text to be indexed for the file to improve fullText queries. This is limited to 128KB in length and may contain HTML elements.
- "thumbnail": { # A thumbnail for the file. This will only be used if Drive cannot generate a standard thumbnail.
+ "thumbnail": { # A thumbnail for the file. This will only be used if Google Drive cannot generate a standard thumbnail.
"mimeType": "A String", # The MIME type of the thumbnail.
"image": "A String", # The thumbnail data encoded with URL-safe Base64 (RFC 4648 section 5).
},
},
- "fileExtension": "A String", # The final component of fullFileExtension. This is only available for files with binary content in Drive.
- "starred": True or False, # Whether the user has starred the file.
- "headRevisionId": "A String", # The ID of the file's head revision. This is currently only available for files with binary content in Drive.
+ "fileExtension": "A String", # The final component of fullFileExtension. This is only available for files with binary content in Google Drive.
+ "hasAugmentedPermissions": True or False, # Whether any users are granted file access directly on this file. This field is only populated for shared drive files.
+ "permissions": [ # The full list of permissions for the file. This is only available if the requesting user can share the file. Not populated for items in shared drives.
+ { # A permission for a file. A permission grants a user, group, domain or the world access to a file or a folder hierarchy.
+ "domain": "A String", # The domain to which this permission refers.
+ "displayName": "A String", # A displayable name for users, groups or domains.
+ "teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead.
+ {
+ "inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead.
+ "role": "A String", # Deprecated - use permissionDetails/role instead.
+ "teamDrivePermissionType": "A String", # Deprecated - use permissionDetails/permissionType instead.
+ "inherited": True or False, # Deprecated - use permissionDetails/inherited instead.
+ },
+ ],
+ "allowFileDiscovery": True or False, # Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type domain or anyone.
+ "deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.
+ "kind": "drive#permission", # Identifies what kind of resource this is. Value: the fixed string "drive#permission".
+ "emailAddress": "A String", # The email address of the user or group to which this permission refers.
+ "photoLink": "A String", # A link to the user's profile photo, if available.
+ "permissionDetails": [ # 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.
+ {
+ "role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible:
+ # - organizer
+ # - fileOrganizer
+ # - writer
+ # - commenter
+ # - reader
+ "inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field and is only populated for members of the shared drive.
+ "permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible:
+ # - file
+ # - member
+ "inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field.
+ },
+ ],
+ "expirationTime": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration times have the following restrictions:
+ # - They can only be set on user and group permissions
+ # - The time must be in the future
+ # - The time cannot be more than a year in the future
+ "role": "A String", # The role granted by this permission. While new values may be supported in the future, the following are currently allowed:
+ # - owner
+ # - organizer
+ # - fileOrganizer
+ # - writer
+ # - commenter
+ # - reader
+ "type": "A String", # The type of the grantee. Valid values are:
+ # - user
+ # - group
+ # - domain
+ # - anyone
+ "id": "A String", # The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as permissionId.
+ },
+ ],
+ "headRevisionId": "A String", # The ID of the file's head revision. This is currently only available for files with binary content in Google Drive.
}</pre>
</div>
<div class="method">
- <code class="details" id="watch">watch(fileId, body, acknowledgeAbuse=None)</code>
+ <code class="details" id="watch">watch(fileId, body, supportsTeamDrives=None, supportsAllDrives=None, acknowledgeAbuse=None)</code>
<pre>Subscribes to changes to a file
Args:
@@ -1536,6 +2132,8 @@
"id": "A String", # A UUID or similar unique string that identifies this channel.
}
+ supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead.
+ supportsAllDrives: boolean, Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives.
acknowledgeAbuse: boolean, Whether the user is acknowledging the risk of downloading known malware or other abusive files. This is only applicable when alt=media.
Returns:
@@ -1558,7 +2156,7 @@
</div>
<div class="method">
- <code class="details" id="watch_media">watch_media(fileId, body, acknowledgeAbuse=None)</code>
+ <code class="details" id="watch_media">watch_media(fileId, body, supportsTeamDrives=None, supportsAllDrives=None, acknowledgeAbuse=None)</code>
<pre>Subscribes to changes to a file
Args:
@@ -1581,6 +2179,8 @@
"id": "A String", # A UUID or similar unique string that identifies this channel.
}
+ supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead.
+ supportsAllDrives: boolean, Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives.
acknowledgeAbuse: boolean, Whether the user is acknowledging the risk of downloading known malware or other abusive files. This is only applicable when alt=media.
Returns: