docs: update generated docs (#981)
diff --git a/docs/dyn/drive_v3.files.html b/docs/dyn/drive_v3.files.html
index f43a673..5d6e964 100644
--- a/docs/dyn/drive_v3.files.html
+++ b/docs/dyn/drive_v3.files.html
@@ -76,7 +76,7 @@
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#copy">copy(fileId, body=None, enforceSingleParent=None, ignoreDefaultVisibility=None, keepRevisionForever=None, ocrLanguage=None, supportsAllDrives=None, supportsTeamDrives=None)</a></code></p>
-<p class="firstline">Creates a copy of a file and applies any requested updates with patch semantics.</p>
+<p class="firstline">Creates a copy of a file and applies any requested updates with patch semantics. Folders cannot be copied.</p>
<p class="toc_element">
<code><a href="#create">create(body=None, enforceSingleParent=None, ignoreDefaultVisibility=None, keepRevisionForever=None, ocrLanguage=None, supportsAllDrives=None, supportsTeamDrives=None, useContentAsIndexableText=None, media_body=None, media_mime_type=None)</a></code></p>
<p class="firstline">Creates a new file.</p>
@@ -109,7 +109,7 @@
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#update">update(fileId, body=None, addParents=None, enforceSingleParent=None, keepRevisionForever=None, ocrLanguage=None, removeParents=None, supportsAllDrives=None, supportsTeamDrives=None, useContentAsIndexableText=None, media_body=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="firstline">Updates a file's metadata and/or content. This method supports patch semantics.</p>
<p class="toc_element">
<code><a href="#watch">watch(fileId, body=None, acknowledgeAbuse=None, supportsAllDrives=None, supportsTeamDrives=None)</a></code></p>
<p class="firstline">Subscribes to changes to a file</p>
@@ -119,7 +119,7 @@
<h3>Method Details</h3>
<div class="method">
<code class="details" id="copy">copy(fileId, body=None, enforceSingleParent=None, ignoreDefaultVisibility=None, keepRevisionForever=None, ocrLanguage=None, supportsAllDrives=None, supportsTeamDrives=None)</code>
- <pre>Creates a copy of a file and applies any requested updates with patch semantics.
+ <pre>Creates a copy of a file and applies any requested updates with patch semantics. Folders cannot be copied.
Args:
fileId: string, The ID of the file. (required)
@@ -133,6 +133,7 @@
},
"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.
"canChangeViewersCanCopyContent": True or False, # Deprecated
@@ -144,6 +145,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.
@@ -172,6 +174,22 @@
"mimeType": "A String", # The MIME type of the thumbnail.
},
},
+ "contentRestrictions": [ # Restrictions for accessing the content of the file. Only populated if such a restriction exists.
+ { # A restriction for accessing the content of the file.
+ "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. This may not be present in certain contexts if the user has not made their email address visible to the requester.
+ "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
+ "me": True or False, # Whether this user is the requesting user.
+ "permissionId": "A String", # The user's ID as visible in Permission resources.
+ "photoLink": "A String", # A link to the user's profile photo, if available.
+ },
+ "restrictionTime": "A String", # The time at which the content restriction was set (formatted RFC 3339 timestamp). Only populated if readOnly is true.
+ "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.
"createdTime": "A String", # The time at which the file was created (RFC 3339 date-time).
"description": "A String", # A short description of the file.
@@ -337,7 +355,7 @@
"teamDriveId": "A String", # Deprecated - use driveId instead.
"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 thumbnail cache invalidation.
- "trashed": True or False, # Whether the file has been trashed, either explicitly or from a trashed parent folder. Only the owner may trash a file, and other users cannot see files in the owner's trash.
+ "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.
"trashedTime": "A String", # The time that the item was trashed (RFC 3339 date-time). Only populated for items in shared drives.
"trashingUser": { # Information about a Drive user. # If the file has been explicitly trashed, the user who trashed it. Only populated for items in shared drives.
"displayName": "A String", # A plain text displayable name for this user.
@@ -365,7 +383,7 @@
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. Only 200 revisions for the file can be kept forever. If the limit is reached, try deleting pinned revisions.
ocrLanguage: string, A language hint for OCR processing during image import (ISO 639-1 code).
- supportsAllDrives: boolean, 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:
@@ -378,6 +396,7 @@
},
"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.
"canChangeViewersCanCopyContent": True or False, # Deprecated
@@ -389,6 +408,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.
@@ -417,6 +437,22 @@
"mimeType": "A String", # The MIME type of the thumbnail.
},
},
+ "contentRestrictions": [ # Restrictions for accessing the content of the file. Only populated if such a restriction exists.
+ { # A restriction for accessing the content of the file.
+ "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. This may not be present in certain contexts if the user has not made their email address visible to the requester.
+ "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
+ "me": True or False, # Whether this user is the requesting user.
+ "permissionId": "A String", # The user's ID as visible in Permission resources.
+ "photoLink": "A String", # A link to the user's profile photo, if available.
+ },
+ "restrictionTime": "A String", # The time at which the content restriction was set (formatted RFC 3339 timestamp). Only populated if readOnly is true.
+ "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.
"createdTime": "A String", # The time at which the file was created (RFC 3339 date-time).
"description": "A String", # A short description of the file.
@@ -582,7 +618,7 @@
"teamDriveId": "A String", # Deprecated - use driveId instead.
"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 thumbnail cache invalidation.
- "trashed": True or False, # Whether the file has been trashed, either explicitly or from a trashed parent folder. Only the owner may trash a file, and other users cannot see files in the owner's trash.
+ "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.
"trashedTime": "A String", # The time that the item was trashed (RFC 3339 date-time). Only populated for items in shared drives.
"trashingUser": { # Information about a Drive user. # If the file has been explicitly trashed, the user who trashed it. Only populated for items in shared drives.
"displayName": "A String", # A plain text displayable name for this user.
@@ -622,6 +658,7 @@
},
"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.
"canChangeViewersCanCopyContent": True or False, # Deprecated
@@ -633,6 +670,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.
@@ -661,6 +699,22 @@
"mimeType": "A String", # The MIME type of the thumbnail.
},
},
+ "contentRestrictions": [ # Restrictions for accessing the content of the file. Only populated if such a restriction exists.
+ { # A restriction for accessing the content of the file.
+ "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. This may not be present in certain contexts if the user has not made their email address visible to the requester.
+ "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
+ "me": True or False, # Whether this user is the requesting user.
+ "permissionId": "A String", # The user's ID as visible in Permission resources.
+ "photoLink": "A String", # A link to the user's profile photo, if available.
+ },
+ "restrictionTime": "A String", # The time at which the content restriction was set (formatted RFC 3339 timestamp). Only populated if readOnly is true.
+ "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.
"createdTime": "A String", # The time at which the file was created (RFC 3339 date-time).
"description": "A String", # A short description of the file.
@@ -826,7 +880,7 @@
"teamDriveId": "A String", # Deprecated - use driveId instead.
"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 thumbnail cache invalidation.
- "trashed": True or False, # Whether the file has been trashed, either explicitly or from a trashed parent folder. Only the owner may trash a file, and other users cannot see files in the owner's trash.
+ "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.
"trashedTime": "A String", # The time that the item was trashed (RFC 3339 date-time). Only populated for items in shared drives.
"trashingUser": { # Information about a Drive user. # If the file has been explicitly trashed, the user who trashed it. Only populated for items in shared drives.
"displayName": "A String", # A plain text displayable name for this user.
@@ -854,7 +908,7 @@
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. Only 200 revisions for the file can be kept forever. If the limit is reached, try deleting pinned revisions.
ocrLanguage: string, A language hint for OCR processing during image import (ISO 639-1 code).
- supportsAllDrives: boolean, 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.
useContentAsIndexableText: boolean, Whether to use the uploaded content as indexable text.
media_body: string, The filename of the media request body, or an instance of a MediaUpload object.
@@ -870,6 +924,7 @@
},
"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.
"canChangeViewersCanCopyContent": True or False, # Deprecated
@@ -881,6 +936,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.
@@ -909,6 +965,22 @@
"mimeType": "A String", # The MIME type of the thumbnail.
},
},
+ "contentRestrictions": [ # Restrictions for accessing the content of the file. Only populated if such a restriction exists.
+ { # A restriction for accessing the content of the file.
+ "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. This may not be present in certain contexts if the user has not made their email address visible to the requester.
+ "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
+ "me": True or False, # Whether this user is the requesting user.
+ "permissionId": "A String", # The user's ID as visible in Permission resources.
+ "photoLink": "A String", # A link to the user's profile photo, if available.
+ },
+ "restrictionTime": "A String", # The time at which the content restriction was set (formatted RFC 3339 timestamp). Only populated if readOnly is true.
+ "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.
"createdTime": "A String", # The time at which the file was created (RFC 3339 date-time).
"description": "A String", # A short description of the file.
@@ -1074,7 +1146,7 @@
"teamDriveId": "A String", # Deprecated - use driveId instead.
"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 thumbnail cache invalidation.
- "trashed": True or False, # Whether the file has been trashed, either explicitly or from a trashed parent folder. Only the owner may trash a file, and other users cannot see files in the owner's trash.
+ "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.
"trashedTime": "A String", # The time that the item was trashed (RFC 3339 date-time). Only populated for items in shared drives.
"trashingUser": { # Information about a Drive user. # If the file has been explicitly trashed, the user who trashed it. Only populated for items in shared drives.
"displayName": "A String", # A plain text displayable name for this user.
@@ -1105,7 +1177,7 @@
Args:
fileId: string, The ID of the file. (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>
@@ -1165,7 +1237,7 @@
Args:
fileId: string, The ID of the file. (required)
acknowledgeAbuse: boolean, Whether the user is acknowledging the risk of downloading known malware or other abusive files. This is only applicable when alt=media.
- 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:
@@ -1178,6 +1250,7 @@
},
"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.
"canChangeViewersCanCopyContent": True or False, # Deprecated
@@ -1189,6 +1262,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.
@@ -1217,6 +1291,22 @@
"mimeType": "A String", # The MIME type of the thumbnail.
},
},
+ "contentRestrictions": [ # Restrictions for accessing the content of the file. Only populated if such a restriction exists.
+ { # A restriction for accessing the content of the file.
+ "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. This may not be present in certain contexts if the user has not made their email address visible to the requester.
+ "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
+ "me": True or False, # Whether this user is the requesting user.
+ "permissionId": "A String", # The user's ID as visible in Permission resources.
+ "photoLink": "A String", # A link to the user's profile photo, if available.
+ },
+ "restrictionTime": "A String", # The time at which the content restriction was set (formatted RFC 3339 timestamp). Only populated if readOnly is true.
+ "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.
"createdTime": "A String", # The time at which the file was created (RFC 3339 date-time).
"description": "A String", # A short description of the file.
@@ -1382,7 +1472,7 @@
"teamDriveId": "A String", # Deprecated - use driveId instead.
"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 thumbnail cache invalidation.
- "trashed": True or False, # Whether the file has been trashed, either explicitly or from a trashed parent folder. Only the owner may trash a file, and other users cannot see files in the owner's trash.
+ "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.
"trashedTime": "A String", # The time that the item was trashed (RFC 3339 date-time). Only populated for items in shared drives.
"trashingUser": { # Information about a Drive user. # If the file has been explicitly trashed, the user who trashed it. Only populated for items in shared drives.
"displayName": "A String", # A plain text displayable name for this user.
@@ -1414,7 +1504,7 @@
Args:
fileId: string, The ID of the file. (required)
acknowledgeAbuse: boolean, Whether the user is acknowledging the risk of downloading known malware or other abusive files. This is only applicable when alt=media.
- 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:
@@ -1428,20 +1518,20 @@
<pre>Lists or searches files.
Args:
- corpora: string, Bodies of items (files/documents) to which the query applies. Supported bodies are 'user', 'domain', 'drive' and 'allDrives'. Prefer 'user' or 'drive' to 'allDrives' for efficiency.
+ 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 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.
+ user - Files owned by or shared to the user. If a user has permissions on a Shared Drive, the files inside it won't be retrieved unless the user has created, opened, or shared the file.
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 are 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.
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.
pageToken: string, The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response.
q: string, A query for filtering the file results. See the "Search for Files" guide for supported syntax.
spaces: string, A comma-separated list of spaces to query within the corpus. 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.
@@ -1457,6 +1547,7 @@
},
"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.
"canChangeViewersCanCopyContent": True or False, # Deprecated
@@ -1468,6 +1559,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.
@@ -1496,6 +1588,22 @@
"mimeType": "A String", # The MIME type of the thumbnail.
},
},
+ "contentRestrictions": [ # Restrictions for accessing the content of the file. Only populated if such a restriction exists.
+ { # A restriction for accessing the content of the file.
+ "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. This may not be present in certain contexts if the user has not made their email address visible to the requester.
+ "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
+ "me": True or False, # Whether this user is the requesting user.
+ "permissionId": "A String", # The user's ID as visible in Permission resources.
+ "photoLink": "A String", # A link to the user's profile photo, if available.
+ },
+ "restrictionTime": "A String", # The time at which the content restriction was set (formatted RFC 3339 timestamp). Only populated if readOnly is true.
+ "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.
"createdTime": "A String", # The time at which the file was created (RFC 3339 date-time).
"description": "A String", # A short description of the file.
@@ -1661,7 +1769,7 @@
"teamDriveId": "A String", # Deprecated - use driveId instead.
"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 thumbnail cache invalidation.
- "trashed": True or False, # Whether the file has been trashed, either explicitly or from a trashed parent folder. Only the owner may trash a file, and other users cannot see files in the owner's trash.
+ "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.
"trashedTime": "A String", # The time that the item was trashed (RFC 3339 date-time). Only populated for items in shared drives.
"trashingUser": { # Information about a Drive user. # If the file has been explicitly trashed, the user who trashed it. Only populated for items in shared drives.
"displayName": "A String", # A plain text displayable name for this user.
@@ -1707,7 +1815,7 @@
<div class="method">
<code class="details" id="update">update(fileId, body=None, addParents=None, enforceSingleParent=None, keepRevisionForever=None, ocrLanguage=None, removeParents=None, supportsAllDrives=None, supportsTeamDrives=None, useContentAsIndexableText=None, media_body=None, media_mime_type=None)</code>
- <pre>Updates a file's metadata and/or content with patch semantics.
+ <pre>Updates a file's metadata and/or content. This method supports patch semantics.
Args:
fileId: string, The ID of the file. (required)
@@ -1721,6 +1829,7 @@
},
"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.
"canChangeViewersCanCopyContent": True or False, # Deprecated
@@ -1732,6 +1841,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.
@@ -1760,6 +1870,22 @@
"mimeType": "A String", # The MIME type of the thumbnail.
},
},
+ "contentRestrictions": [ # Restrictions for accessing the content of the file. Only populated if such a restriction exists.
+ { # A restriction for accessing the content of the file.
+ "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. This may not be present in certain contexts if the user has not made their email address visible to the requester.
+ "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
+ "me": True or False, # Whether this user is the requesting user.
+ "permissionId": "A String", # The user's ID as visible in Permission resources.
+ "photoLink": "A String", # A link to the user's profile photo, if available.
+ },
+ "restrictionTime": "A String", # The time at which the content restriction was set (formatted RFC 3339 timestamp). Only populated if readOnly is true.
+ "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.
"createdTime": "A String", # The time at which the file was created (RFC 3339 date-time).
"description": "A String", # A short description of the file.
@@ -1925,7 +2051,7 @@
"teamDriveId": "A String", # Deprecated - use driveId instead.
"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 thumbnail cache invalidation.
- "trashed": True or False, # Whether the file has been trashed, either explicitly or from a trashed parent folder. Only the owner may trash a file, and other users cannot see files in the owner's trash.
+ "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.
"trashedTime": "A String", # The time that the item was trashed (RFC 3339 date-time). Only populated for items in shared drives.
"trashingUser": { # Information about a Drive user. # If the file has been explicitly trashed, the user who trashed it. Only populated for items in shared drives.
"displayName": "A String", # A plain text displayable name for this user.
@@ -1954,7 +2080,7 @@
keepRevisionForever: boolean, Whether to set the 'keepForever' field in the new head revision. This is only applicable to files with binary content in Google Drive. Only 200 revisions for the file can be kept forever. If the limit is reached, try deleting pinned revisions.
ocrLanguage: string, A language hint for OCR processing during image import (ISO 639-1 code).
removeParents: string, A comma-separated list of parent IDs to remove.
- 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.
useContentAsIndexableText: boolean, Whether to use the uploaded content as indexable text.
media_body: string, The filename of the media request body, or an instance of a MediaUpload object.
@@ -1970,6 +2096,7 @@
},
"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.
"canChangeViewersCanCopyContent": True or False, # Deprecated
@@ -1981,6 +2108,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.
@@ -2009,6 +2137,22 @@
"mimeType": "A String", # The MIME type of the thumbnail.
},
},
+ "contentRestrictions": [ # Restrictions for accessing the content of the file. Only populated if such a restriction exists.
+ { # A restriction for accessing the content of the file.
+ "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. This may not be present in certain contexts if the user has not made their email address visible to the requester.
+ "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
+ "me": True or False, # Whether this user is the requesting user.
+ "permissionId": "A String", # The user's ID as visible in Permission resources.
+ "photoLink": "A String", # A link to the user's profile photo, if available.
+ },
+ "restrictionTime": "A String", # The time at which the content restriction was set (formatted RFC 3339 timestamp). Only populated if readOnly is true.
+ "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.
"createdTime": "A String", # The time at which the file was created (RFC 3339 date-time).
"description": "A String", # A short description of the file.
@@ -2174,7 +2318,7 @@
"teamDriveId": "A String", # Deprecated - use driveId instead.
"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 thumbnail cache invalidation.
- "trashed": True or False, # Whether the file has been trashed, either explicitly or from a trashed parent folder. Only the owner may trash a file, and other users cannot see files in the owner's trash.
+ "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.
"trashedTime": "A String", # The time that the item was trashed (RFC 3339 date-time). Only populated for items in shared drives.
"trashingUser": { # Information about a Drive user. # If the file has been explicitly trashed, the user who trashed it. Only populated for items in shared drives.
"displayName": "A String", # A plain text displayable name for this user.
@@ -2224,7 +2368,7 @@
}
acknowledgeAbuse: boolean, Whether the user is acknowledging the risk of downloading known malware or other abusive files. This is only applicable when alt=media.
- 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:
@@ -2271,7 +2415,7 @@
}
acknowledgeAbuse: boolean, Whether the user is acknowledging the risk of downloading known malware or other abusive files. This is only applicable when alt=media.
- 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: