docs: update generated docs (#981)
diff --git a/docs/dyn/drive_v2.files.html b/docs/dyn/drive_v2.files.html
index 83e6800..2de3cb8 100644
--- a/docs/dyn/drive_v2.files.html
+++ b/docs/dyn/drive_v2.files.html
@@ -76,7 +76,7 @@
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#copy">copy(fileId, body=None, convert=None, enforceSingleParent=None, ocr=None, ocrLanguage=None, pinned=None, supportsAllDrives=None, supportsTeamDrives=None, timedTextLanguage=None, timedTextTrackName=None, visibility=None)</a></code></p>
-<p class="firstline">Creates a copy of the specified file.</p>
+<p class="firstline">Creates a copy of the specified file. Folders cannot be copied.</p>
<p class="toc_element">
<code><a href="#delete">delete(fileId, supportsAllDrives=None, supportsTeamDrives=None)</a></code></p>
<p class="firstline">Permanently deletes a file by ID. Skips the trash. The currently authenticated user must own the file or be an organizer on the parent for shared drive files.</p>
@@ -115,10 +115,10 @@
<p class="firstline">Set the file's updated time to the current server time.</p>
<p class="toc_element">
<code><a href="#trash">trash(fileId, supportsAllDrives=None, supportsTeamDrives=None)</a></code></p>
-<p class="firstline">Moves a file to the trash. The currently authenticated user must own the file or be at least a fileOrganizer on the parent for shared drive files.</p>
+<p class="firstline">Moves a file to the trash. The currently authenticated user must own the file or be at least a fileOrganizer on the parent for shared drive files. Only the owner may trash a file. The trashed item is excluded from all files.list responses returned for any user who does not own the file. However, all users with access to the file can see the trashed item metadata in an API response. All users with access can copy, download, export, and share the file.</p>
<p class="toc_element">
<code><a href="#untrash">untrash(fileId, supportsAllDrives=None, supportsTeamDrives=None)</a></code></p>
-<p class="firstline">Restores a file from the trash.</p>
+<p class="firstline">Restores a file from the trash. The currently authenticated user must own the file or be at least a fileOrganizer on the parent for shared drive files. Only the owner may untrash a file.</p>
<p class="toc_element">
<code><a href="#update">update(fileId, body=None, addParents=None, convert=None, enforceSingleParent=None, modifiedDateBehavior=None, newRevision=None, ocr=None, ocrLanguage=None, pinned=None, removeParents=None, setModifiedDate=None, supportsAllDrives=None, supportsTeamDrives=None, timedTextLanguage=None, timedTextTrackName=None, updateViewedDate=None, useContentAsIndexableText=None, media_body=None, media_mime_type=None)</a></code></p>
<p class="firstline">Updates file metadata and/or content.</p>
@@ -131,7 +131,7 @@
<h3>Method Details</h3>
<div class="method">
<code class="details" id="copy">copy(fileId, body=None, convert=None, enforceSingleParent=None, ocr=None, ocrLanguage=None, pinned=None, supportsAllDrives=None, supportsTeamDrives=None, timedTextLanguage=None, timedTextTrackName=None, visibility=None)</code>
- <pre>Creates a copy of the specified file.
+ <pre>Creates a copy of the specified file. Folders cannot be copied.
Args:
fileId: string, The ID of the file to copy. (required)
@@ -145,6 +145,7 @@
"canReadRevisions": True or False, # Deprecated: use capabilities/canReadRevisions.
"capabilities": { # Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take.
"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.
+ "canAddFolderFromAnotherDrive": True or False, # Whether the current user can add a folder from another drive (different shared drive or My Drive) to this folder. This is false when the item is not a folder. Only populated for items in shared drives.
"canAddMyDriveParent": True or False, # Whether the current user can add a parent for the item without removing an existing parent in the same request. Not populated for shared drive files.
"canChangeCopyRequiresWriterPermission": True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this file.
"canChangeRestrictedDownload": True or False, # Deprecated
@@ -156,6 +157,7 @@
"canEdit": True or False, # Whether the current user can edit this file. Other factors may limit the type of changes a user can make to a file. For example, see canChangeCopyRequiresWriterPermission or canModifyContent.
"canListChildren": True or False, # Whether the current user can list the children of this folder. This is always false when the item is not a folder.
"canModifyContent": True or False, # Whether the current user can modify the content of this file.
+ "canModifyContentRestriction": True or False, # Whether the current user can modify restrictions on content of 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.
"canMoveChildrenOutOfTeamDrive": True or False, # Deprecated - use canMoveChildrenOutOfDrive instead.
"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.
@@ -177,6 +179,24 @@
"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.
"canUntrash": True or False, # Whether the current user can restore this file from trash.
},
+ "contentRestrictions": [ # Restrictions for accessing the content of the file. Only populated if such a restriction exists.
+ { # A restriction for accessing the content of the file.
+ "readOnly": True or False, # Whether the content of the file is read-only.
+ "reason": "A String", # Reason for why the content of the file is restricted. This is only mutable on requests that also set readOnly=true.
+ "restrictingUser": { # Information about a Drive user. # The user who set the content restriction. Only populated if readOnly is true.
+ "displayName": "A String", # A plain text displayable name for this user.
+ "emailAddress": "A String", # The email address of the user.
+ "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
+ "kind": "drive#user", # This is always drive#user.
+ "permissionId": "A String", # The user's ID as visible in the permissions collection.
+ "picture": { # The user's profile picture.
+ "url": "A String", # A URL that points to a profile picture of this user.
+ },
+ },
+ "restrictionDate": "A String", # The time at which the content restriction was set (formatted RFC 3339 timestamp). Only populated if readOnly is true.
+ "type": "A String", # The type of the content restriction. Currently the only possible value is globalContentRestriction.
+ },
+ ],
"copyRequiresWriterPermission": True or False, # Whether the options to copy, print, or download this file, should be disabled for readers and commenters.
"copyable": True or False, # Deprecated: use capabilities/canCopy.
"createdDate": "A String", # Create time for this file (formatted RFC 3339 timestamp).
@@ -237,7 +257,7 @@
"modified": True or False, # Whether the file has been modified by this user.
"restricted": True or False, # Deprecated - use copyRequiresWriterPermission instead.
"starred": True or False, # Whether this file is starred by the user.
- "trashed": True or False, # Whether this file has been trashed. This label applies to all users accessing the file; however, only owners are allowed to see and untrash files.
+ "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. The trashed item is excluded from all files.list responses returned for any user who does not own the file. However, all users with access to the file can see the trashed item metadata in an API response. All users with access can copy, download, export, and share the file.
"viewed": True or False, # Whether this file has been viewed by this user.
},
"lastModifyingUser": { # Information about a Drive user. # The last user to modify this file.
@@ -488,7 +508,7 @@
ocr: boolean, Whether to attempt OCR on .jpg, .png, .gif, or .pdf uploads.
ocrLanguage: string, If ocr is true, hints at the language to use. Valid values are BCP 47 codes.
pinned: boolean, Whether to pin the head revision of the new copy. A file can have a maximum of 200 pinned revisions.
- supportsAllDrives: boolean, 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.
+ supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives.
supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead.
timedTextLanguage: string, The language of the timed text.
timedTextTrackName: string, The timed text track name.
@@ -507,6 +527,7 @@
"canReadRevisions": True or False, # Deprecated: use capabilities/canReadRevisions.
"capabilities": { # Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take.
"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.
+ "canAddFolderFromAnotherDrive": True or False, # Whether the current user can add a folder from another drive (different shared drive or My Drive) to this folder. This is false when the item is not a folder. Only populated for items in shared drives.
"canAddMyDriveParent": True or False, # Whether the current user can add a parent for the item without removing an existing parent in the same request. Not populated for shared drive files.
"canChangeCopyRequiresWriterPermission": True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this file.
"canChangeRestrictedDownload": True or False, # Deprecated
@@ -518,6 +539,7 @@
"canEdit": True or False, # Whether the current user can edit this file. Other factors may limit the type of changes a user can make to a file. For example, see canChangeCopyRequiresWriterPermission or canModifyContent.
"canListChildren": True or False, # Whether the current user can list the children of this folder. This is always false when the item is not a folder.
"canModifyContent": True or False, # Whether the current user can modify the content of this file.
+ "canModifyContentRestriction": True or False, # Whether the current user can modify restrictions on content of 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.
"canMoveChildrenOutOfTeamDrive": True or False, # Deprecated - use canMoveChildrenOutOfDrive instead.
"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.
@@ -539,6 +561,24 @@
"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.
"canUntrash": True or False, # Whether the current user can restore this file from trash.
},
+ "contentRestrictions": [ # Restrictions for accessing the content of the file. Only populated if such a restriction exists.
+ { # A restriction for accessing the content of the file.
+ "readOnly": True or False, # Whether the content of the file is read-only.
+ "reason": "A String", # Reason for why the content of the file is restricted. This is only mutable on requests that also set readOnly=true.
+ "restrictingUser": { # Information about a Drive user. # The user who set the content restriction. Only populated if readOnly is true.
+ "displayName": "A String", # A plain text displayable name for this user.
+ "emailAddress": "A String", # The email address of the user.
+ "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
+ "kind": "drive#user", # This is always drive#user.
+ "permissionId": "A String", # The user's ID as visible in the permissions collection.
+ "picture": { # The user's profile picture.
+ "url": "A String", # A URL that points to a profile picture of this user.
+ },
+ },
+ "restrictionDate": "A String", # The time at which the content restriction was set (formatted RFC 3339 timestamp). Only populated if readOnly is true.
+ "type": "A String", # The type of the content restriction. Currently the only possible value is globalContentRestriction.
+ },
+ ],
"copyRequiresWriterPermission": True or False, # Whether the options to copy, print, or download this file, should be disabled for readers and commenters.
"copyable": True or False, # Deprecated: use capabilities/canCopy.
"createdDate": "A String", # Create time for this file (formatted RFC 3339 timestamp).
@@ -599,7 +639,7 @@
"modified": True or False, # Whether the file has been modified by this user.
"restricted": True or False, # Deprecated - use copyRequiresWriterPermission instead.
"starred": True or False, # Whether this file is starred by the user.
- "trashed": True or False, # Whether this file has been trashed. This label applies to all users accessing the file; however, only owners are allowed to see and untrash files.
+ "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. The trashed item is excluded from all files.list responses returned for any user who does not own the file. However, all users with access to the file can see the trashed item metadata in an API response. All users with access can copy, download, export, and share the file.
"viewed": True or False, # Whether this file has been viewed by this user.
},
"lastModifyingUser": { # Information about a Drive user. # The last user to modify this file.
@@ -852,7 +892,7 @@
Args:
fileId: string, The ID of the file to delete. (required)
- 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.
+ supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives.
supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead.
</pre>
</div>
@@ -917,7 +957,7 @@
BASIC - Deprecated
FULL - Deprecated
revisionId: string, Specifies the Revision ID that should be downloaded. Ignored unless alt=media is specified.
- 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.
+ supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives.
supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead.
updateViewedDate: boolean, Deprecated: Use files.update with modifiedDateBehavior=noChange, updateViewedDate=true and an empty request body.
@@ -931,6 +971,7 @@
"canReadRevisions": True or False, # Deprecated: use capabilities/canReadRevisions.
"capabilities": { # Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take.
"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.
+ "canAddFolderFromAnotherDrive": True or False, # Whether the current user can add a folder from another drive (different shared drive or My Drive) to this folder. This is false when the item is not a folder. Only populated for items in shared drives.
"canAddMyDriveParent": True or False, # Whether the current user can add a parent for the item without removing an existing parent in the same request. Not populated for shared drive files.
"canChangeCopyRequiresWriterPermission": True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this file.
"canChangeRestrictedDownload": True or False, # Deprecated
@@ -942,6 +983,7 @@
"canEdit": True or False, # Whether the current user can edit this file. Other factors may limit the type of changes a user can make to a file. For example, see canChangeCopyRequiresWriterPermission or canModifyContent.
"canListChildren": True or False, # Whether the current user can list the children of this folder. This is always false when the item is not a folder.
"canModifyContent": True or False, # Whether the current user can modify the content of this file.
+ "canModifyContentRestriction": True or False, # Whether the current user can modify restrictions on content of 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.
"canMoveChildrenOutOfTeamDrive": True or False, # Deprecated - use canMoveChildrenOutOfDrive instead.
"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.
@@ -963,6 +1005,24 @@
"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.
"canUntrash": True or False, # Whether the current user can restore this file from trash.
},
+ "contentRestrictions": [ # Restrictions for accessing the content of the file. Only populated if such a restriction exists.
+ { # A restriction for accessing the content of the file.
+ "readOnly": True or False, # Whether the content of the file is read-only.
+ "reason": "A String", # Reason for why the content of the file is restricted. This is only mutable on requests that also set readOnly=true.
+ "restrictingUser": { # Information about a Drive user. # The user who set the content restriction. Only populated if readOnly is true.
+ "displayName": "A String", # A plain text displayable name for this user.
+ "emailAddress": "A String", # The email address of the user.
+ "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
+ "kind": "drive#user", # This is always drive#user.
+ "permissionId": "A String", # The user's ID as visible in the permissions collection.
+ "picture": { # The user's profile picture.
+ "url": "A String", # A URL that points to a profile picture of this user.
+ },
+ },
+ "restrictionDate": "A String", # The time at which the content restriction was set (formatted RFC 3339 timestamp). Only populated if readOnly is true.
+ "type": "A String", # The type of the content restriction. Currently the only possible value is globalContentRestriction.
+ },
+ ],
"copyRequiresWriterPermission": True or False, # Whether the options to copy, print, or download this file, should be disabled for readers and commenters.
"copyable": True or False, # Deprecated: use capabilities/canCopy.
"createdDate": "A String", # Create time for this file (formatted RFC 3339 timestamp).
@@ -1023,7 +1083,7 @@
"modified": True or False, # Whether the file has been modified by this user.
"restricted": True or False, # Deprecated - use copyRequiresWriterPermission instead.
"starred": True or False, # Whether this file is starred by the user.
- "trashed": True or False, # Whether this file has been trashed. This label applies to all users accessing the file; however, only owners are allowed to see and untrash files.
+ "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. The trashed item is excluded from all files.list responses returned for any user who does not own the file. However, all users with access to the file can see the trashed item metadata in an API response. All users with access can copy, download, export, and share the file.
"viewed": True or False, # Whether this file has been viewed by this user.
},
"lastModifyingUser": { # Information about a Drive user. # The last user to modify this file.
@@ -1282,7 +1342,7 @@
BASIC - Deprecated
FULL - Deprecated
revisionId: string, Specifies the Revision ID that should be downloaded. Ignored unless alt=media is specified.
- 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.
+ supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives.
supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead.
updateViewedDate: boolean, Deprecated: Use files.update with modifiedDateBehavior=noChange, updateViewedDate=true and an empty request body.
@@ -1307,6 +1367,7 @@
"canReadRevisions": True or False, # Deprecated: use capabilities/canReadRevisions.
"capabilities": { # Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take.
"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.
+ "canAddFolderFromAnotherDrive": True or False, # Whether the current user can add a folder from another drive (different shared drive or My Drive) to this folder. This is false when the item is not a folder. Only populated for items in shared drives.
"canAddMyDriveParent": True or False, # Whether the current user can add a parent for the item without removing an existing parent in the same request. Not populated for shared drive files.
"canChangeCopyRequiresWriterPermission": True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this file.
"canChangeRestrictedDownload": True or False, # Deprecated
@@ -1318,6 +1379,7 @@
"canEdit": True or False, # Whether the current user can edit this file. Other factors may limit the type of changes a user can make to a file. For example, see canChangeCopyRequiresWriterPermission or canModifyContent.
"canListChildren": True or False, # Whether the current user can list the children of this folder. This is always false when the item is not a folder.
"canModifyContent": True or False, # Whether the current user can modify the content of this file.
+ "canModifyContentRestriction": True or False, # Whether the current user can modify restrictions on content of 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.
"canMoveChildrenOutOfTeamDrive": True or False, # Deprecated - use canMoveChildrenOutOfDrive instead.
"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.
@@ -1339,6 +1401,24 @@
"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.
"canUntrash": True or False, # Whether the current user can restore this file from trash.
},
+ "contentRestrictions": [ # Restrictions for accessing the content of the file. Only populated if such a restriction exists.
+ { # A restriction for accessing the content of the file.
+ "readOnly": True or False, # Whether the content of the file is read-only.
+ "reason": "A String", # Reason for why the content of the file is restricted. This is only mutable on requests that also set readOnly=true.
+ "restrictingUser": { # Information about a Drive user. # The user who set the content restriction. Only populated if readOnly is true.
+ "displayName": "A String", # A plain text displayable name for this user.
+ "emailAddress": "A String", # The email address of the user.
+ "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
+ "kind": "drive#user", # This is always drive#user.
+ "permissionId": "A String", # The user's ID as visible in the permissions collection.
+ "picture": { # The user's profile picture.
+ "url": "A String", # A URL that points to a profile picture of this user.
+ },
+ },
+ "restrictionDate": "A String", # The time at which the content restriction was set (formatted RFC 3339 timestamp). Only populated if readOnly is true.
+ "type": "A String", # The type of the content restriction. Currently the only possible value is globalContentRestriction.
+ },
+ ],
"copyRequiresWriterPermission": True or False, # Whether the options to copy, print, or download this file, should be disabled for readers and commenters.
"copyable": True or False, # Deprecated: use capabilities/canCopy.
"createdDate": "A String", # Create time for this file (formatted RFC 3339 timestamp).
@@ -1399,7 +1479,7 @@
"modified": True or False, # Whether the file has been modified by this user.
"restricted": True or False, # Deprecated - use copyRequiresWriterPermission instead.
"starred": True or False, # Whether this file is starred by the user.
- "trashed": True or False, # Whether this file has been trashed. This label applies to all users accessing the file; however, only owners are allowed to see and untrash files.
+ "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. The trashed item is excluded from all files.list responses returned for any user who does not own the file. However, all users with access to the file can see the trashed item metadata in an API response. All users with access can copy, download, export, and share the file.
"viewed": True or False, # Whether this file has been viewed by this user.
},
"lastModifyingUser": { # Information about a Drive user. # The last user to modify this file.
@@ -1650,7 +1730,7 @@
ocr: boolean, Whether to attempt OCR on .jpg, .png, .gif, or .pdf uploads.
ocrLanguage: string, If ocr is true, hints at the language to use. Valid values are BCP 47 codes.
pinned: boolean, Whether to pin the head revision of the uploaded file. A file can have a maximum of 200 pinned revisions.
- supportsAllDrives: boolean, 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.
+ supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives.
supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead.
timedTextLanguage: string, The language of the timed text.
timedTextTrackName: string, The timed text track name.
@@ -1672,6 +1752,7 @@
"canReadRevisions": True or False, # Deprecated: use capabilities/canReadRevisions.
"capabilities": { # Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take.
"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.
+ "canAddFolderFromAnotherDrive": True or False, # Whether the current user can add a folder from another drive (different shared drive or My Drive) to this folder. This is false when the item is not a folder. Only populated for items in shared drives.
"canAddMyDriveParent": True or False, # Whether the current user can add a parent for the item without removing an existing parent in the same request. Not populated for shared drive files.
"canChangeCopyRequiresWriterPermission": True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this file.
"canChangeRestrictedDownload": True or False, # Deprecated
@@ -1683,6 +1764,7 @@
"canEdit": True or False, # Whether the current user can edit this file. Other factors may limit the type of changes a user can make to a file. For example, see canChangeCopyRequiresWriterPermission or canModifyContent.
"canListChildren": True or False, # Whether the current user can list the children of this folder. This is always false when the item is not a folder.
"canModifyContent": True or False, # Whether the current user can modify the content of this file.
+ "canModifyContentRestriction": True or False, # Whether the current user can modify restrictions on content of 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.
"canMoveChildrenOutOfTeamDrive": True or False, # Deprecated - use canMoveChildrenOutOfDrive instead.
"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.
@@ -1704,6 +1786,24 @@
"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.
"canUntrash": True or False, # Whether the current user can restore this file from trash.
},
+ "contentRestrictions": [ # Restrictions for accessing the content of the file. Only populated if such a restriction exists.
+ { # A restriction for accessing the content of the file.
+ "readOnly": True or False, # Whether the content of the file is read-only.
+ "reason": "A String", # Reason for why the content of the file is restricted. This is only mutable on requests that also set readOnly=true.
+ "restrictingUser": { # Information about a Drive user. # The user who set the content restriction. Only populated if readOnly is true.
+ "displayName": "A String", # A plain text displayable name for this user.
+ "emailAddress": "A String", # The email address of the user.
+ "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
+ "kind": "drive#user", # This is always drive#user.
+ "permissionId": "A String", # The user's ID as visible in the permissions collection.
+ "picture": { # The user's profile picture.
+ "url": "A String", # A URL that points to a profile picture of this user.
+ },
+ },
+ "restrictionDate": "A String", # The time at which the content restriction was set (formatted RFC 3339 timestamp). Only populated if readOnly is true.
+ "type": "A String", # The type of the content restriction. Currently the only possible value is globalContentRestriction.
+ },
+ ],
"copyRequiresWriterPermission": True or False, # Whether the options to copy, print, or download this file, should be disabled for readers and commenters.
"copyable": True or False, # Deprecated: use capabilities/canCopy.
"createdDate": "A String", # Create time for this file (formatted RFC 3339 timestamp).
@@ -1764,7 +1864,7 @@
"modified": True or False, # Whether the file has been modified by this user.
"restricted": True or False, # Deprecated - use copyRequiresWriterPermission instead.
"starred": True or False, # Whether this file is starred by the user.
- "trashed": True or False, # Whether this file has been trashed. This label applies to all users accessing the file; however, only owners are allowed to see and untrash files.
+ "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. The trashed item is excluded from all files.list responses returned for any user who does not own the file. However, all users with access to the file can see the trashed item metadata in an API response. All users with access can copy, download, export, and share the file.
"viewed": True or False, # Whether this file has been viewed by this user.
},
"lastModifyingUser": { # Information about a Drive user. # The last user to modify this file.
@@ -2016,13 +2116,13 @@
<pre>Lists the user's files.
Args:
- corpora: string, Bodies of items (files/documents) to which the query applies. Supported bodies are 'default', 'domain', 'drive' and 'allDrives'. Prefer 'default' or 'drive' to 'allDrives' for efficiency.
+ corpora: string, Groupings of files to which the query applies. Supported groupings are: 'user' (files created by, opened by, or shared directly with the user), 'drive' (files in the specified shared drive as indicated by the 'driveId'), 'domain' (files shared to the user's domain), and 'allDrives' (A combination of 'user' and 'drive' for all drives where the user is a member). When able, use 'user' or 'drive', instead of 'allDrives', for efficiency.
corpus: string, The body of items (files/documents) to which the query applies. Deprecated: use 'corpora' instead.
Allowed values
DEFAULT - The items that the user has accessed.
DOMAIN - Items shared to the user's domain.
driveId: string, ID of the shared drive to search.
- includeItemsFromAllDrives: boolean, 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.
+ includeItemsFromAllDrives: boolean, Whether both My Drive and shared drive items should be included in results.
includeTeamDriveItems: boolean, Deprecated use includeItemsFromAllDrives instead.
maxResults: integer, The maximum number of files to return per page. Partial or empty result pages are possible even before the end of the files list has been reached.
orderBy: string, A comma-separated list of sort keys. Valid keys are 'createdDate', 'folder', 'lastViewedByMeDate', 'modifiedByMeDate', 'modifiedDate', 'quotaBytesUsed', 'recency', 'sharedWithMeDate', 'starred', 'title', and 'title_natural'. Each key sorts ascending by default, but may be reversed with the 'desc' modifier. Example usage: ?orderBy=folder,modifiedDate desc,title. Please note that there is a current limitation for users with approximately one million files in which the requested sort order is ignored.
@@ -2033,7 +2133,7 @@
FULL - Deprecated
q: string, Query string for searching files.
spaces: string, A comma-separated list of spaces to query. Supported values are 'drive', 'appDataFolder' and 'photos'.
- 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.
+ supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives.
supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead.
teamDriveId: string, Deprecated use driveId instead.
@@ -2051,6 +2151,7 @@
"canReadRevisions": True or False, # Deprecated: use capabilities/canReadRevisions.
"capabilities": { # Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take.
"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.
+ "canAddFolderFromAnotherDrive": True or False, # Whether the current user can add a folder from another drive (different shared drive or My Drive) to this folder. This is false when the item is not a folder. Only populated for items in shared drives.
"canAddMyDriveParent": True or False, # Whether the current user can add a parent for the item without removing an existing parent in the same request. Not populated for shared drive files.
"canChangeCopyRequiresWriterPermission": True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this file.
"canChangeRestrictedDownload": True or False, # Deprecated
@@ -2062,6 +2163,7 @@
"canEdit": True or False, # Whether the current user can edit this file. Other factors may limit the type of changes a user can make to a file. For example, see canChangeCopyRequiresWriterPermission or canModifyContent.
"canListChildren": True or False, # Whether the current user can list the children of this folder. This is always false when the item is not a folder.
"canModifyContent": True or False, # Whether the current user can modify the content of this file.
+ "canModifyContentRestriction": True or False, # Whether the current user can modify restrictions on content of 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.
"canMoveChildrenOutOfTeamDrive": True or False, # Deprecated - use canMoveChildrenOutOfDrive instead.
"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.
@@ -2083,6 +2185,24 @@
"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.
"canUntrash": True or False, # Whether the current user can restore this file from trash.
},
+ "contentRestrictions": [ # Restrictions for accessing the content of the file. Only populated if such a restriction exists.
+ { # A restriction for accessing the content of the file.
+ "readOnly": True or False, # Whether the content of the file is read-only.
+ "reason": "A String", # Reason for why the content of the file is restricted. This is only mutable on requests that also set readOnly=true.
+ "restrictingUser": { # Information about a Drive user. # The user who set the content restriction. Only populated if readOnly is true.
+ "displayName": "A String", # A plain text displayable name for this user.
+ "emailAddress": "A String", # The email address of the user.
+ "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
+ "kind": "drive#user", # This is always drive#user.
+ "permissionId": "A String", # The user's ID as visible in the permissions collection.
+ "picture": { # The user's profile picture.
+ "url": "A String", # A URL that points to a profile picture of this user.
+ },
+ },
+ "restrictionDate": "A String", # The time at which the content restriction was set (formatted RFC 3339 timestamp). Only populated if readOnly is true.
+ "type": "A String", # The type of the content restriction. Currently the only possible value is globalContentRestriction.
+ },
+ ],
"copyRequiresWriterPermission": True or False, # Whether the options to copy, print, or download this file, should be disabled for readers and commenters.
"copyable": True or False, # Deprecated: use capabilities/canCopy.
"createdDate": "A String", # Create time for this file (formatted RFC 3339 timestamp).
@@ -2143,7 +2263,7 @@
"modified": True or False, # Whether the file has been modified by this user.
"restricted": True or False, # Deprecated - use copyRequiresWriterPermission instead.
"starred": True or False, # Whether this file is starred by the user.
- "trashed": True or False, # Whether this file has been trashed. This label applies to all users accessing the file; however, only owners are allowed to see and untrash files.
+ "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. The trashed item is excluded from all files.list responses returned for any user who does not own the file. However, all users with access to the file can see the trashed item metadata in an API response. All users with access can copy, download, export, and share the file.
"viewed": True or False, # Whether this file has been viewed by this user.
},
"lastModifyingUser": { # Information about a Drive user. # The last user to modify this file.
@@ -2426,6 +2546,7 @@
"canReadRevisions": True or False, # Deprecated: use capabilities/canReadRevisions.
"capabilities": { # Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take.
"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.
+ "canAddFolderFromAnotherDrive": True or False, # Whether the current user can add a folder from another drive (different shared drive or My Drive) to this folder. This is false when the item is not a folder. Only populated for items in shared drives.
"canAddMyDriveParent": True or False, # Whether the current user can add a parent for the item without removing an existing parent in the same request. Not populated for shared drive files.
"canChangeCopyRequiresWriterPermission": True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this file.
"canChangeRestrictedDownload": True or False, # Deprecated
@@ -2437,6 +2558,7 @@
"canEdit": True or False, # Whether the current user can edit this file. Other factors may limit the type of changes a user can make to a file. For example, see canChangeCopyRequiresWriterPermission or canModifyContent.
"canListChildren": True or False, # Whether the current user can list the children of this folder. This is always false when the item is not a folder.
"canModifyContent": True or False, # Whether the current user can modify the content of this file.
+ "canModifyContentRestriction": True or False, # Whether the current user can modify restrictions on content of 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.
"canMoveChildrenOutOfTeamDrive": True or False, # Deprecated - use canMoveChildrenOutOfDrive instead.
"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.
@@ -2458,6 +2580,24 @@
"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.
"canUntrash": True or False, # Whether the current user can restore this file from trash.
},
+ "contentRestrictions": [ # Restrictions for accessing the content of the file. Only populated if such a restriction exists.
+ { # A restriction for accessing the content of the file.
+ "readOnly": True or False, # Whether the content of the file is read-only.
+ "reason": "A String", # Reason for why the content of the file is restricted. This is only mutable on requests that also set readOnly=true.
+ "restrictingUser": { # Information about a Drive user. # The user who set the content restriction. Only populated if readOnly is true.
+ "displayName": "A String", # A plain text displayable name for this user.
+ "emailAddress": "A String", # The email address of the user.
+ "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
+ "kind": "drive#user", # This is always drive#user.
+ "permissionId": "A String", # The user's ID as visible in the permissions collection.
+ "picture": { # The user's profile picture.
+ "url": "A String", # A URL that points to a profile picture of this user.
+ },
+ },
+ "restrictionDate": "A String", # The time at which the content restriction was set (formatted RFC 3339 timestamp). Only populated if readOnly is true.
+ "type": "A String", # The type of the content restriction. Currently the only possible value is globalContentRestriction.
+ },
+ ],
"copyRequiresWriterPermission": True or False, # Whether the options to copy, print, or download this file, should be disabled for readers and commenters.
"copyable": True or False, # Deprecated: use capabilities/canCopy.
"createdDate": "A String", # Create time for this file (formatted RFC 3339 timestamp).
@@ -2518,7 +2658,7 @@
"modified": True or False, # Whether the file has been modified by this user.
"restricted": True or False, # Deprecated - use copyRequiresWriterPermission instead.
"starred": True or False, # Whether this file is starred by the user.
- "trashed": True or False, # Whether this file has been trashed. This label applies to all users accessing the file; however, only owners are allowed to see and untrash files.
+ "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. The trashed item is excluded from all files.list responses returned for any user who does not own the file. However, all users with access to the file can see the trashed item metadata in an API response. All users with access can copy, download, export, and share the file.
"viewed": True or False, # Whether this file has been viewed by this user.
},
"lastModifyingUser": { # Information about a Drive user. # The last user to modify this file.
@@ -2775,13 +2915,13 @@
noChange - Maintain the previous value of modifiedDate.
now - Set modifiedDate to the current time.
nowIfNeeded - Set modifiedDate to the current time depending on contents of the update.
- newRevision: boolean, Whether a blob upload should create a new revision. If false, the blob data in the current head revision is replaced. If true or not set, a new blob is created as head revision, and previous unpinned revisions are preserved for a short period of time. Pinned revisions are stored indefinitely, using additional storage quota, up to a maximum of 200 revisions. For details on how revisions are retained, see the Drive Help Center.
+ newRevision: boolean, Whether a blob upload should create a new revision. If false, the blob data in the current head revision is replaced. If true or not set, a new blob is created as head revision, and previous unpinned revisions are preserved for a short period of time. Pinned revisions are stored indefinitely, using additional storage quota, up to a maximum of 200 revisions. For details on how revisions are retained, see the Drive Help Center. Note that this field is ignored if there is no payload in the request.
ocr: boolean, Whether to attempt OCR on .jpg, .png, .gif, or .pdf uploads.
ocrLanguage: string, If ocr is true, hints at the language to use. Valid values are BCP 47 codes.
- pinned: boolean, Whether to pin the new revision. A file can have a maximum of 200 pinned revisions.
+ pinned: boolean, Whether to pin the new revision. A file can have a maximum of 200 pinned revisions. Note that this field is ignored if there is no payload in the request.
removeParents: string, Comma-separated list of parent IDs to remove.
setModifiedDate: boolean, Whether to set the modified date using the value supplied in the request body. Setting this field to true is equivalent to modifiedDateBehavior=fromBodyOrNow, and false is equivalent to modifiedDateBehavior=now. To prevent any changes to the modified date set modifiedDateBehavior=noChange.
- supportsAllDrives: boolean, 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.
+ supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives.
supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead.
timedTextLanguage: string, The language of the timed text.
timedTextTrackName: string, The timed text track name.
@@ -2798,6 +2938,7 @@
"canReadRevisions": True or False, # Deprecated: use capabilities/canReadRevisions.
"capabilities": { # Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take.
"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.
+ "canAddFolderFromAnotherDrive": True or False, # Whether the current user can add a folder from another drive (different shared drive or My Drive) to this folder. This is false when the item is not a folder. Only populated for items in shared drives.
"canAddMyDriveParent": True or False, # Whether the current user can add a parent for the item without removing an existing parent in the same request. Not populated for shared drive files.
"canChangeCopyRequiresWriterPermission": True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this file.
"canChangeRestrictedDownload": True or False, # Deprecated
@@ -2809,6 +2950,7 @@
"canEdit": True or False, # Whether the current user can edit this file. Other factors may limit the type of changes a user can make to a file. For example, see canChangeCopyRequiresWriterPermission or canModifyContent.
"canListChildren": True or False, # Whether the current user can list the children of this folder. This is always false when the item is not a folder.
"canModifyContent": True or False, # Whether the current user can modify the content of this file.
+ "canModifyContentRestriction": True or False, # Whether the current user can modify restrictions on content of 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.
"canMoveChildrenOutOfTeamDrive": True or False, # Deprecated - use canMoveChildrenOutOfDrive instead.
"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.
@@ -2830,6 +2972,24 @@
"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.
"canUntrash": True or False, # Whether the current user can restore this file from trash.
},
+ "contentRestrictions": [ # Restrictions for accessing the content of the file. Only populated if such a restriction exists.
+ { # A restriction for accessing the content of the file.
+ "readOnly": True or False, # Whether the content of the file is read-only.
+ "reason": "A String", # Reason for why the content of the file is restricted. This is only mutable on requests that also set readOnly=true.
+ "restrictingUser": { # Information about a Drive user. # The user who set the content restriction. Only populated if readOnly is true.
+ "displayName": "A String", # A plain text displayable name for this user.
+ "emailAddress": "A String", # The email address of the user.
+ "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
+ "kind": "drive#user", # This is always drive#user.
+ "permissionId": "A String", # The user's ID as visible in the permissions collection.
+ "picture": { # The user's profile picture.
+ "url": "A String", # A URL that points to a profile picture of this user.
+ },
+ },
+ "restrictionDate": "A String", # The time at which the content restriction was set (formatted RFC 3339 timestamp). Only populated if readOnly is true.
+ "type": "A String", # The type of the content restriction. Currently the only possible value is globalContentRestriction.
+ },
+ ],
"copyRequiresWriterPermission": True or False, # Whether the options to copy, print, or download this file, should be disabled for readers and commenters.
"copyable": True or False, # Deprecated: use capabilities/canCopy.
"createdDate": "A String", # Create time for this file (formatted RFC 3339 timestamp).
@@ -2890,7 +3050,7 @@
"modified": True or False, # Whether the file has been modified by this user.
"restricted": True or False, # Deprecated - use copyRequiresWriterPermission instead.
"starred": True or False, # Whether this file is starred by the user.
- "trashed": True or False, # Whether this file has been trashed. This label applies to all users accessing the file; however, only owners are allowed to see and untrash files.
+ "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. The trashed item is excluded from all files.list responses returned for any user who does not own the file. However, all users with access to the file can see the trashed item metadata in an API response. All users with access can copy, download, export, and share the file.
"viewed": True or False, # Whether this file has been viewed by this user.
},
"lastModifyingUser": { # Information about a Drive user. # The last user to modify this file.
@@ -3143,7 +3303,7 @@
Args:
fileId: string, The ID of the file to update. (required)
- 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.
+ supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives.
supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead.
Returns:
@@ -3156,6 +3316,7 @@
"canReadRevisions": True or False, # Deprecated: use capabilities/canReadRevisions.
"capabilities": { # Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take.
"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.
+ "canAddFolderFromAnotherDrive": True or False, # Whether the current user can add a folder from another drive (different shared drive or My Drive) to this folder. This is false when the item is not a folder. Only populated for items in shared drives.
"canAddMyDriveParent": True or False, # Whether the current user can add a parent for the item without removing an existing parent in the same request. Not populated for shared drive files.
"canChangeCopyRequiresWriterPermission": True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this file.
"canChangeRestrictedDownload": True or False, # Deprecated
@@ -3167,6 +3328,7 @@
"canEdit": True or False, # Whether the current user can edit this file. Other factors may limit the type of changes a user can make to a file. For example, see canChangeCopyRequiresWriterPermission or canModifyContent.
"canListChildren": True or False, # Whether the current user can list the children of this folder. This is always false when the item is not a folder.
"canModifyContent": True or False, # Whether the current user can modify the content of this file.
+ "canModifyContentRestriction": True or False, # Whether the current user can modify restrictions on content of 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.
"canMoveChildrenOutOfTeamDrive": True or False, # Deprecated - use canMoveChildrenOutOfDrive instead.
"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.
@@ -3188,6 +3350,24 @@
"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.
"canUntrash": True or False, # Whether the current user can restore this file from trash.
},
+ "contentRestrictions": [ # Restrictions for accessing the content of the file. Only populated if such a restriction exists.
+ { # A restriction for accessing the content of the file.
+ "readOnly": True or False, # Whether the content of the file is read-only.
+ "reason": "A String", # Reason for why the content of the file is restricted. This is only mutable on requests that also set readOnly=true.
+ "restrictingUser": { # Information about a Drive user. # The user who set the content restriction. Only populated if readOnly is true.
+ "displayName": "A String", # A plain text displayable name for this user.
+ "emailAddress": "A String", # The email address of the user.
+ "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
+ "kind": "drive#user", # This is always drive#user.
+ "permissionId": "A String", # The user's ID as visible in the permissions collection.
+ "picture": { # The user's profile picture.
+ "url": "A String", # A URL that points to a profile picture of this user.
+ },
+ },
+ "restrictionDate": "A String", # The time at which the content restriction was set (formatted RFC 3339 timestamp). Only populated if readOnly is true.
+ "type": "A String", # The type of the content restriction. Currently the only possible value is globalContentRestriction.
+ },
+ ],
"copyRequiresWriterPermission": True or False, # Whether the options to copy, print, or download this file, should be disabled for readers and commenters.
"copyable": True or False, # Deprecated: use capabilities/canCopy.
"createdDate": "A String", # Create time for this file (formatted RFC 3339 timestamp).
@@ -3248,7 +3428,7 @@
"modified": True or False, # Whether the file has been modified by this user.
"restricted": True or False, # Deprecated - use copyRequiresWriterPermission instead.
"starred": True or False, # Whether this file is starred by the user.
- "trashed": True or False, # Whether this file has been trashed. This label applies to all users accessing the file; however, only owners are allowed to see and untrash files.
+ "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. The trashed item is excluded from all files.list responses returned for any user who does not own the file. However, all users with access to the file can see the trashed item metadata in an API response. All users with access can copy, download, export, and share the file.
"viewed": True or False, # Whether this file has been viewed by this user.
},
"lastModifyingUser": { # Information about a Drive user. # The last user to modify this file.
@@ -3497,11 +3677,11 @@
<div class="method">
<code class="details" id="trash">trash(fileId, supportsAllDrives=None, supportsTeamDrives=None)</code>
- <pre>Moves a file to the trash. The currently authenticated user must own the file or be at least a fileOrganizer on the parent for shared drive files.
+ <pre>Moves a file to the trash. The currently authenticated user must own the file or be at least a fileOrganizer on the parent for shared drive files. Only the owner may trash a file. The trashed item is excluded from all files.list responses returned for any user who does not own the file. However, all users with access to the file can see the trashed item metadata in an API response. All users with access can copy, download, export, and share the file.
Args:
fileId: string, The ID of the file to trash. (required)
- 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.
+ supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives.
supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead.
Returns:
@@ -3514,6 +3694,7 @@
"canReadRevisions": True or False, # Deprecated: use capabilities/canReadRevisions.
"capabilities": { # Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take.
"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.
+ "canAddFolderFromAnotherDrive": True or False, # Whether the current user can add a folder from another drive (different shared drive or My Drive) to this folder. This is false when the item is not a folder. Only populated for items in shared drives.
"canAddMyDriveParent": True or False, # Whether the current user can add a parent for the item without removing an existing parent in the same request. Not populated for shared drive files.
"canChangeCopyRequiresWriterPermission": True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this file.
"canChangeRestrictedDownload": True or False, # Deprecated
@@ -3525,6 +3706,7 @@
"canEdit": True or False, # Whether the current user can edit this file. Other factors may limit the type of changes a user can make to a file. For example, see canChangeCopyRequiresWriterPermission or canModifyContent.
"canListChildren": True or False, # Whether the current user can list the children of this folder. This is always false when the item is not a folder.
"canModifyContent": True or False, # Whether the current user can modify the content of this file.
+ "canModifyContentRestriction": True or False, # Whether the current user can modify restrictions on content of 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.
"canMoveChildrenOutOfTeamDrive": True or False, # Deprecated - use canMoveChildrenOutOfDrive instead.
"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.
@@ -3546,6 +3728,24 @@
"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.
"canUntrash": True or False, # Whether the current user can restore this file from trash.
},
+ "contentRestrictions": [ # Restrictions for accessing the content of the file. Only populated if such a restriction exists.
+ { # A restriction for accessing the content of the file.
+ "readOnly": True or False, # Whether the content of the file is read-only.
+ "reason": "A String", # Reason for why the content of the file is restricted. This is only mutable on requests that also set readOnly=true.
+ "restrictingUser": { # Information about a Drive user. # The user who set the content restriction. Only populated if readOnly is true.
+ "displayName": "A String", # A plain text displayable name for this user.
+ "emailAddress": "A String", # The email address of the user.
+ "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
+ "kind": "drive#user", # This is always drive#user.
+ "permissionId": "A String", # The user's ID as visible in the permissions collection.
+ "picture": { # The user's profile picture.
+ "url": "A String", # A URL that points to a profile picture of this user.
+ },
+ },
+ "restrictionDate": "A String", # The time at which the content restriction was set (formatted RFC 3339 timestamp). Only populated if readOnly is true.
+ "type": "A String", # The type of the content restriction. Currently the only possible value is globalContentRestriction.
+ },
+ ],
"copyRequiresWriterPermission": True or False, # Whether the options to copy, print, or download this file, should be disabled for readers and commenters.
"copyable": True or False, # Deprecated: use capabilities/canCopy.
"createdDate": "A String", # Create time for this file (formatted RFC 3339 timestamp).
@@ -3606,7 +3806,7 @@
"modified": True or False, # Whether the file has been modified by this user.
"restricted": True or False, # Deprecated - use copyRequiresWriterPermission instead.
"starred": True or False, # Whether this file is starred by the user.
- "trashed": True or False, # Whether this file has been trashed. This label applies to all users accessing the file; however, only owners are allowed to see and untrash files.
+ "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. The trashed item is excluded from all files.list responses returned for any user who does not own the file. However, all users with access to the file can see the trashed item metadata in an API response. All users with access can copy, download, export, and share the file.
"viewed": True or False, # Whether this file has been viewed by this user.
},
"lastModifyingUser": { # Information about a Drive user. # The last user to modify this file.
@@ -3855,11 +4055,11 @@
<div class="method">
<code class="details" id="untrash">untrash(fileId, supportsAllDrives=None, supportsTeamDrives=None)</code>
- <pre>Restores a file from the trash.
+ <pre>Restores a file from the trash. The currently authenticated user must own the file or be at least a fileOrganizer on the parent for shared drive files. Only the owner may untrash a file.
Args:
fileId: string, The ID of the file to untrash. (required)
- 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.
+ supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives.
supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead.
Returns:
@@ -3872,6 +4072,7 @@
"canReadRevisions": True or False, # Deprecated: use capabilities/canReadRevisions.
"capabilities": { # Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take.
"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.
+ "canAddFolderFromAnotherDrive": True or False, # Whether the current user can add a folder from another drive (different shared drive or My Drive) to this folder. This is false when the item is not a folder. Only populated for items in shared drives.
"canAddMyDriveParent": True or False, # Whether the current user can add a parent for the item without removing an existing parent in the same request. Not populated for shared drive files.
"canChangeCopyRequiresWriterPermission": True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this file.
"canChangeRestrictedDownload": True or False, # Deprecated
@@ -3883,6 +4084,7 @@
"canEdit": True or False, # Whether the current user can edit this file. Other factors may limit the type of changes a user can make to a file. For example, see canChangeCopyRequiresWriterPermission or canModifyContent.
"canListChildren": True or False, # Whether the current user can list the children of this folder. This is always false when the item is not a folder.
"canModifyContent": True or False, # Whether the current user can modify the content of this file.
+ "canModifyContentRestriction": True or False, # Whether the current user can modify restrictions on content of 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.
"canMoveChildrenOutOfTeamDrive": True or False, # Deprecated - use canMoveChildrenOutOfDrive instead.
"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.
@@ -3904,6 +4106,24 @@
"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.
"canUntrash": True or False, # Whether the current user can restore this file from trash.
},
+ "contentRestrictions": [ # Restrictions for accessing the content of the file. Only populated if such a restriction exists.
+ { # A restriction for accessing the content of the file.
+ "readOnly": True or False, # Whether the content of the file is read-only.
+ "reason": "A String", # Reason for why the content of the file is restricted. This is only mutable on requests that also set readOnly=true.
+ "restrictingUser": { # Information about a Drive user. # The user who set the content restriction. Only populated if readOnly is true.
+ "displayName": "A String", # A plain text displayable name for this user.
+ "emailAddress": "A String", # The email address of the user.
+ "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
+ "kind": "drive#user", # This is always drive#user.
+ "permissionId": "A String", # The user's ID as visible in the permissions collection.
+ "picture": { # The user's profile picture.
+ "url": "A String", # A URL that points to a profile picture of this user.
+ },
+ },
+ "restrictionDate": "A String", # The time at which the content restriction was set (formatted RFC 3339 timestamp). Only populated if readOnly is true.
+ "type": "A String", # The type of the content restriction. Currently the only possible value is globalContentRestriction.
+ },
+ ],
"copyRequiresWriterPermission": True or False, # Whether the options to copy, print, or download this file, should be disabled for readers and commenters.
"copyable": True or False, # Deprecated: use capabilities/canCopy.
"createdDate": "A String", # Create time for this file (formatted RFC 3339 timestamp).
@@ -3964,7 +4184,7 @@
"modified": True or False, # Whether the file has been modified by this user.
"restricted": True or False, # Deprecated - use copyRequiresWriterPermission instead.
"starred": True or False, # Whether this file is starred by the user.
- "trashed": True or False, # Whether this file has been trashed. This label applies to all users accessing the file; however, only owners are allowed to see and untrash files.
+ "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. The trashed item is excluded from all files.list responses returned for any user who does not own the file. However, all users with access to the file can see the trashed item metadata in an API response. All users with access can copy, download, export, and share the file.
"viewed": True or False, # Whether this file has been viewed by this user.
},
"lastModifyingUser": { # Information about a Drive user. # The last user to modify this file.
@@ -4227,6 +4447,7 @@
"canReadRevisions": True or False, # Deprecated: use capabilities/canReadRevisions.
"capabilities": { # Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take.
"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.
+ "canAddFolderFromAnotherDrive": True or False, # Whether the current user can add a folder from another drive (different shared drive or My Drive) to this folder. This is false when the item is not a folder. Only populated for items in shared drives.
"canAddMyDriveParent": True or False, # Whether the current user can add a parent for the item without removing an existing parent in the same request. Not populated for shared drive files.
"canChangeCopyRequiresWriterPermission": True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this file.
"canChangeRestrictedDownload": True or False, # Deprecated
@@ -4238,6 +4459,7 @@
"canEdit": True or False, # Whether the current user can edit this file. Other factors may limit the type of changes a user can make to a file. For example, see canChangeCopyRequiresWriterPermission or canModifyContent.
"canListChildren": True or False, # Whether the current user can list the children of this folder. This is always false when the item is not a folder.
"canModifyContent": True or False, # Whether the current user can modify the content of this file.
+ "canModifyContentRestriction": True or False, # Whether the current user can modify restrictions on content of 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.
"canMoveChildrenOutOfTeamDrive": True or False, # Deprecated - use canMoveChildrenOutOfDrive instead.
"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.
@@ -4259,6 +4481,24 @@
"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.
"canUntrash": True or False, # Whether the current user can restore this file from trash.
},
+ "contentRestrictions": [ # Restrictions for accessing the content of the file. Only populated if such a restriction exists.
+ { # A restriction for accessing the content of the file.
+ "readOnly": True or False, # Whether the content of the file is read-only.
+ "reason": "A String", # Reason for why the content of the file is restricted. This is only mutable on requests that also set readOnly=true.
+ "restrictingUser": { # Information about a Drive user. # The user who set the content restriction. Only populated if readOnly is true.
+ "displayName": "A String", # A plain text displayable name for this user.
+ "emailAddress": "A String", # The email address of the user.
+ "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
+ "kind": "drive#user", # This is always drive#user.
+ "permissionId": "A String", # The user's ID as visible in the permissions collection.
+ "picture": { # The user's profile picture.
+ "url": "A String", # A URL that points to a profile picture of this user.
+ },
+ },
+ "restrictionDate": "A String", # The time at which the content restriction was set (formatted RFC 3339 timestamp). Only populated if readOnly is true.
+ "type": "A String", # The type of the content restriction. Currently the only possible value is globalContentRestriction.
+ },
+ ],
"copyRequiresWriterPermission": True or False, # Whether the options to copy, print, or download this file, should be disabled for readers and commenters.
"copyable": True or False, # Deprecated: use capabilities/canCopy.
"createdDate": "A String", # Create time for this file (formatted RFC 3339 timestamp).
@@ -4319,7 +4559,7 @@
"modified": True or False, # Whether the file has been modified by this user.
"restricted": True or False, # Deprecated - use copyRequiresWriterPermission instead.
"starred": True or False, # Whether this file is starred by the user.
- "trashed": True or False, # Whether this file has been trashed. This label applies to all users accessing the file; however, only owners are allowed to see and untrash files.
+ "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. The trashed item is excluded from all files.list responses returned for any user who does not own the file. However, all users with access to the file can see the trashed item metadata in an API response. All users with access can copy, download, export, and share the file.
"viewed": True or False, # Whether this file has been viewed by this user.
},
"lastModifyingUser": { # Information about a Drive user. # The last user to modify this file.
@@ -4576,13 +4816,13 @@
noChange - Maintain the previous value of modifiedDate.
now - Set modifiedDate to the current time.
nowIfNeeded - Set modifiedDate to the current time depending on contents of the update.
- newRevision: boolean, Whether a blob upload should create a new revision. If false, the blob data in the current head revision is replaced. If true or not set, a new blob is created as head revision, and previous unpinned revisions are preserved for a short period of time. Pinned revisions are stored indefinitely, using additional storage quota, up to a maximum of 200 revisions. For details on how revisions are retained, see the Drive Help Center.
+ newRevision: boolean, Whether a blob upload should create a new revision. If false, the blob data in the current head revision is replaced. If true or not set, a new blob is created as head revision, and previous unpinned revisions are preserved for a short period of time. Pinned revisions are stored indefinitely, using additional storage quota, up to a maximum of 200 revisions. For details on how revisions are retained, see the Drive Help Center. Note that this field is ignored if there is no payload in the request.
ocr: boolean, Whether to attempt OCR on .jpg, .png, .gif, or .pdf uploads.
ocrLanguage: string, If ocr is true, hints at the language to use. Valid values are BCP 47 codes.
- pinned: boolean, Whether to pin the new revision. A file can have a maximum of 200 pinned revisions.
+ pinned: boolean, Whether to pin the new revision. A file can have a maximum of 200 pinned revisions. Note that this field is ignored if there is no payload in the request.
removeParents: string, Comma-separated list of parent IDs to remove.
setModifiedDate: boolean, Whether to set the modified date using the value supplied in the request body. Setting this field to true is equivalent to modifiedDateBehavior=fromBodyOrNow, and false is equivalent to modifiedDateBehavior=now. To prevent any changes to the modified date set modifiedDateBehavior=noChange.
- supportsAllDrives: boolean, 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.
+ supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives.
supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead.
timedTextLanguage: string, The language of the timed text.
timedTextTrackName: string, The timed text track name.
@@ -4601,6 +4841,7 @@
"canReadRevisions": True or False, # Deprecated: use capabilities/canReadRevisions.
"capabilities": { # Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take.
"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.
+ "canAddFolderFromAnotherDrive": True or False, # Whether the current user can add a folder from another drive (different shared drive or My Drive) to this folder. This is false when the item is not a folder. Only populated for items in shared drives.
"canAddMyDriveParent": True or False, # Whether the current user can add a parent for the item without removing an existing parent in the same request. Not populated for shared drive files.
"canChangeCopyRequiresWriterPermission": True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this file.
"canChangeRestrictedDownload": True or False, # Deprecated
@@ -4612,6 +4853,7 @@
"canEdit": True or False, # Whether the current user can edit this file. Other factors may limit the type of changes a user can make to a file. For example, see canChangeCopyRequiresWriterPermission or canModifyContent.
"canListChildren": True or False, # Whether the current user can list the children of this folder. This is always false when the item is not a folder.
"canModifyContent": True or False, # Whether the current user can modify the content of this file.
+ "canModifyContentRestriction": True or False, # Whether the current user can modify restrictions on content of 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.
"canMoveChildrenOutOfTeamDrive": True or False, # Deprecated - use canMoveChildrenOutOfDrive instead.
"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.
@@ -4633,6 +4875,24 @@
"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.
"canUntrash": True or False, # Whether the current user can restore this file from trash.
},
+ "contentRestrictions": [ # Restrictions for accessing the content of the file. Only populated if such a restriction exists.
+ { # A restriction for accessing the content of the file.
+ "readOnly": True or False, # Whether the content of the file is read-only.
+ "reason": "A String", # Reason for why the content of the file is restricted. This is only mutable on requests that also set readOnly=true.
+ "restrictingUser": { # Information about a Drive user. # The user who set the content restriction. Only populated if readOnly is true.
+ "displayName": "A String", # A plain text displayable name for this user.
+ "emailAddress": "A String", # The email address of the user.
+ "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
+ "kind": "drive#user", # This is always drive#user.
+ "permissionId": "A String", # The user's ID as visible in the permissions collection.
+ "picture": { # The user's profile picture.
+ "url": "A String", # A URL that points to a profile picture of this user.
+ },
+ },
+ "restrictionDate": "A String", # The time at which the content restriction was set (formatted RFC 3339 timestamp). Only populated if readOnly is true.
+ "type": "A String", # The type of the content restriction. Currently the only possible value is globalContentRestriction.
+ },
+ ],
"copyRequiresWriterPermission": True or False, # Whether the options to copy, print, or download this file, should be disabled for readers and commenters.
"copyable": True or False, # Deprecated: use capabilities/canCopy.
"createdDate": "A String", # Create time for this file (formatted RFC 3339 timestamp).
@@ -4693,7 +4953,7 @@
"modified": True or False, # Whether the file has been modified by this user.
"restricted": True or False, # Deprecated - use copyRequiresWriterPermission instead.
"starred": True or False, # Whether this file is starred by the user.
- "trashed": True or False, # Whether this file has been trashed. This label applies to all users accessing the file; however, only owners are allowed to see and untrash files.
+ "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. The trashed item is excluded from all files.list responses returned for any user who does not own the file. However, all users with access to the file can see the trashed item metadata in an API response. All users with access can copy, download, export, and share the file.
"viewed": True or False, # Whether this file has been viewed by this user.
},
"lastModifyingUser": { # Information about a Drive user. # The last user to modify this file.
@@ -4970,7 +5230,7 @@
BASIC - Deprecated
FULL - Deprecated
revisionId: string, Specifies the Revision ID that should be downloaded. Ignored unless alt=media is specified.
- 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.
+ supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives.
supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead.
updateViewedDate: boolean, Deprecated: Use files.update with modifiedDateBehavior=noChange, updateViewedDate=true and an empty request body.
@@ -5023,7 +5283,7 @@
BASIC - Deprecated
FULL - Deprecated
revisionId: string, Specifies the Revision ID that should be downloaded. Ignored unless alt=media is specified.
- 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.
+ supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives.
supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead.
updateViewedDate: boolean, Deprecated: Use files.update with modifiedDateBehavior=noChange, updateViewedDate=true and an empty request body.