chore: regens API reference docs (#889)
diff --git a/docs/dyn/drive_v3.files.html b/docs/dyn/drive_v3.files.html
index 042aff2..bd3cf26 100644
--- a/docs/dyn/drive_v3.files.html
+++ b/docs/dyn/drive_v3.files.html
@@ -75,10 +75,10 @@
<h1><a href="drive_v3.html">Drive API</a> . <a href="drive_v3.files.html">files</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
- <code><a href="#copy">copy(fileId, body, keepRevisionForever=None, supportsTeamDrives=None, ocrLanguage=None, ignoreDefaultVisibility=None, supportsAllDrives=None)</a></code></p>
+ <code><a href="#copy">copy(fileId, body=None, enforceSingleParent=None, keepRevisionForever=None, ignoreDefaultVisibility=None, ocrLanguage=None, supportsTeamDrives=None, supportsAllDrives=None)</a></code></p>
<p class="firstline">Creates a copy of a file and applies any requested updates with patch semantics.</p>
<p class="toc_element">
- <code><a href="#create">create(body=None, media_body=None, keepRevisionForever=None, useContentAsIndexableText=None, supportsTeamDrives=None, ocrLanguage=None, ignoreDefaultVisibility=None, supportsAllDrives=None, media_mime_type=None)</a></code></p>
+ <code><a href="#create">create(body=None, enforceSingleParent=None, keepRevisionForever=None, media_body=None, useContentAsIndexableText=None, supportsTeamDrives=None, ocrLanguage=None, ignoreDefaultVisibility=None, supportsAllDrives=None, media_mime_type=None)</a></code></p>
<p class="firstline">Creates a new file.</p>
<p class="toc_element">
<code><a href="#delete">delete(fileId, supportsTeamDrives=None, supportsAllDrives=None)</a></code></p>
@@ -94,7 +94,7 @@
<p class="firstline">Exports a Google Doc to the requested MIME type and returns the exported content. Please note that the exported content is limited to 10MB.</p>
<p class="toc_element">
<code><a href="#generateIds">generateIds(count=None, space=None)</a></code></p>
-<p class="firstline">Generates a set of file IDs which can be provided in create requests.</p>
+<p class="firstline">Generates a set of file IDs which can be provided in create or copy requests.</p>
<p class="toc_element">
<code><a href="#get">get(fileId, supportsTeamDrives=None, supportsAllDrives=None, acknowledgeAbuse=None)</a></code></p>
<p class="firstline">Gets a file's metadata or content by ID.</p>
@@ -108,22 +108,22 @@
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
- <code><a href="#update">update(fileId, body=None, keepRevisionForever=None, removeParents=None, supportsTeamDrives=None, media_body=None, ocrLanguage=None, addParents=None, useContentAsIndexableText=None, supportsAllDrives=None, media_mime_type=None)</a></code></p>
+ <code><a href="#update">update(fileId, body=None, keepRevisionForever=None, removeParents=None, supportsTeamDrives=None, media_body=None, ocrLanguage=None, addParents=None, enforceSingleParent=None, useContentAsIndexableText=None, supportsAllDrives=None, media_mime_type=None)</a></code></p>
<p class="firstline">Updates a file's metadata and/or content with patch semantics.</p>
<p class="toc_element">
- <code><a href="#watch">watch(fileId, body, supportsTeamDrives=None, supportsAllDrives=None, acknowledgeAbuse=None)</a></code></p>
+ <code><a href="#watch">watch(fileId, body=None, supportsTeamDrives=None, supportsAllDrives=None, acknowledgeAbuse=None)</a></code></p>
<p class="firstline">Subscribes to changes to a file</p>
<p class="toc_element">
- <code><a href="#watch_media">watch_media(fileId, body, supportsTeamDrives=None, supportsAllDrives=None, acknowledgeAbuse=None)</a></code></p>
+ <code><a href="#watch_media">watch_media(fileId, body=None, supportsTeamDrives=None, supportsAllDrives=None, acknowledgeAbuse=None)</a></code></p>
<p class="firstline">Subscribes to changes to a file</p>
<h3>Method Details</h3>
<div class="method">
- <code class="details" id="copy">copy(fileId, body, keepRevisionForever=None, supportsTeamDrives=None, ocrLanguage=None, ignoreDefaultVisibility=None, supportsAllDrives=None)</code>
+ <code class="details" id="copy">copy(fileId, body=None, enforceSingleParent=None, keepRevisionForever=None, ignoreDefaultVisibility=None, ocrLanguage=None, supportsTeamDrives=None, supportsAllDrives=None)</code>
<pre>Creates a copy of a file and applies any requested updates with patch semantics.
Args:
fileId: string, The ID of the file. (required)
- body: object, The request body. (required)
+ body: object, The request body.
The object takes the form of:
{ # The metadata for a file.
@@ -149,6 +149,10 @@
"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
"photoLink": "A String", # A link to the user's profile photo, if available.
},
+ "shortcutDetails": { # Shortcut file details. Only populated for shortcut files, which have the mimeType field set to application/vnd.google-apps.shortcut.
+ "targetId": "A String", # The ID of the file that this shortcut points to.
+ "targetMimeType": "A String", # The MIME type of the file that this shortcut points to. The value of this field is a snapshot of the target's MIME type, captured when the shortcut is created.
+ },
"size": "A String", # The size of the file's content in bytes. This is only applicable to files with binary content in Google Drive.
"videoMediaMetadata": { # Additional metadata about video media. This may not be available immediately upon upload.
"width": 42, # The width of the video in pixels.
@@ -177,10 +181,12 @@
"canMoveChildrenWithinTeamDrive": True or False, # Deprecated - use canMoveChildrenWithinDrive instead.
"canListChildren": True or False, # Whether the current user can list the children of this folder. This is always false when the item is not a folder.
"canRename": True or False, # Whether the current user can rename this file.
+ "canModifyContent": True or False, # Whether the current user can modify the content of this file.
"canReadDrive": True or False, # Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives.
"canAddChildren": True or False, # Whether the current user can add children to this folder. This is always false when the item is not a folder.
"canShare": True or False, # Whether the current user can modify the sharing settings for this file.
"canTrashChildren": True or False, # Whether the current user can trash children of this folder. This is false when the item is not a folder. Only populated for items in shared drives.
+ "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.
"canMoveChildrenWithinDrive": True or False, # Whether the current user can move children of this folder within the shared drive. This is false when the item is not a folder. Only populated for items in shared drives.
"canReadRevisions": True or False, # Whether the current user can read the revisions resource of this file. For a shared drive item, whether revisions of non-folder descendants of this item, or this item itself if it is not a folder, can be read.
"canMoveItemWithinDrive": True or False, # Whether the current user can move this item within this shared drive. Note that a request to change the parent of the item may still fail depending on the new parent that is being added. Only populated for items in shared drives.
@@ -191,6 +197,7 @@
"canMoveChildrenOutOfDrive": True or False, # Whether the current user can move children of this folder outside of the shared drive. This is false when the item is not a folder. Only populated for items in shared drives.
"canChangeViewersCanCopyContent": True or False, # Deprecated
"canTrash": True or False, # Whether the current user can move this file to trash.
+ "canRemoveMyDriveParent": True or False, # Whether the current user can remove a parent from the item without adding another parent in the same request. Not populated for shared drive files.
"canDelete": True or False, # Whether the current user can delete this file.
"canMoveTeamDriveItem": True or False, # Deprecated - use canMoveItemWithinDrive or canMoveItemOutOfDrive instead.
"canDownload": True or False, # Whether the current user can download this file.
@@ -198,7 +205,7 @@
"canMoveChildrenOutOfTeamDrive": True or False, # Deprecated - use canMoveChildrenOutOfDrive instead.
"canRemoveChildren": True or False, # Whether the current user can remove children from this folder. This is always false when the item is not a folder. For a folder in a shared drive, use canDeleteChildren or canTrashChildren instead.
"canReadTeamDrive": True or False, # Deprecated - use canReadDrive instead.
- "canEdit": True or False, # Whether the current user can edit this file.
+ "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.
},
"trashedTime": "A String", # The time that the item was trashed (RFC 3339 date-time). Only populated for items in shared drives.
"webViewLink": "A String", # A link for opening the file in a relevant Google editor or viewer in a browser.
@@ -263,7 +270,7 @@
"flashUsed": True or False, # Whether a flash was used to create the photo.
"time": "A String", # The date and time the photo was taken (EXIF DateTime).
"aperture": 3.14, # The aperture used to create the photo (f-number).
- "rotation": 42, # The rotation in clockwise degrees from the image's original orientation.
+ "rotation": 42, # The number of clockwise 90 degree rotations applied from the image's original orientation.
"sensor": "A String", # The type of sensor used to create the photo.
"whiteBalance": "A String", # The white balance mode used to create the photo.
"cameraModel": "A String", # The model of the camera used to create the photo.
@@ -295,11 +302,15 @@
},
},
"fileExtension": "A String", # The final component of fullFileExtension. This is only available for files with binary content in Google Drive.
- "hasAugmentedPermissions": True or False, # Whether any users are granted file access directly on this file. This field is only populated for shared drive files.
+ "hasAugmentedPermissions": True or False, # Whether there are permissions directly on this file. This field is only populated for items in shared drives.
"permissions": [ # The full list of permissions for the file. This is only available if the requesting user can share the file. Not populated for items in shared drives.
{ # A permission for a file. A permission grants a user, group, domain or the world access to a file or a folder hierarchy.
"domain": "A String", # The domain to which this permission refers.
- "displayName": "A String", # A displayable name for users, groups or domains.
+ "displayName": "A String", # The "pretty" name of the value of the permission. The following is a list of examples for each type of permission:
+ # - user - User's full name, as defined for their Google account, such as "Joe Smith."
+ # - group - Name of the Google Group, such as "The Company Administrators."
+ # - domain - String domain name, such as "thecompany.com."
+ # - anyone - No displayName is present.
"teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead.
{
"inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead.
@@ -321,7 +332,7 @@
# - writer
# - commenter
# - reader
- "inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field and is only populated for members of the shared drive.
+ "inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field.
"permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible:
# - file
# - member
@@ -343,17 +354,18 @@
# - user
# - group
# - domain
- # - anyone
- "id": "A String", # The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as permissionId.
+ # - anyone When creating a permission, if type is user or group, you must provide an emailAddress for the user or group. When type is domain, you must provide a domain. There isn't extra information required for a anyone type.
+ "id": "A String", # The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as permissionId. IDs should be treated as opaque values.
},
],
"headRevisionId": "A String", # The ID of the file's head revision. This is currently only available for files with binary content in Google Drive.
}
- keepRevisionForever: boolean, Whether to set the 'keepForever' field in the new head revision. This is only applicable to files with binary content in Google Drive.
- supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead.
- ocrLanguage: string, A language hint for OCR processing during image import (ISO 639-1 code).
+ enforceSingleParent: boolean, Set to true to opt in to API behavior that aims for all items to have exactly one parent. This parameter only takes effect if the item is not in a shared drive. Requests that specify more than one parent fail.
+ 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.
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.
+ ocrLanguage: string, A language hint for OCR processing during image import (ISO 639-1 code).
+ supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead.
supportsAllDrives: boolean, Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives.
Returns:
@@ -382,6 +394,10 @@
"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
"photoLink": "A String", # A link to the user's profile photo, if available.
},
+ "shortcutDetails": { # Shortcut file details. Only populated for shortcut files, which have the mimeType field set to application/vnd.google-apps.shortcut.
+ "targetId": "A String", # The ID of the file that this shortcut points to.
+ "targetMimeType": "A String", # The MIME type of the file that this shortcut points to. The value of this field is a snapshot of the target's MIME type, captured when the shortcut is created.
+ },
"size": "A String", # The size of the file's content in bytes. This is only applicable to files with binary content in Google Drive.
"videoMediaMetadata": { # Additional metadata about video media. This may not be available immediately upon upload.
"width": 42, # The width of the video in pixels.
@@ -410,10 +426,12 @@
"canMoveChildrenWithinTeamDrive": True or False, # Deprecated - use canMoveChildrenWithinDrive instead.
"canListChildren": True or False, # Whether the current user can list the children of this folder. This is always false when the item is not a folder.
"canRename": True or False, # Whether the current user can rename this file.
+ "canModifyContent": True or False, # Whether the current user can modify the content of this file.
"canReadDrive": True or False, # Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives.
"canAddChildren": True or False, # Whether the current user can add children to this folder. This is always false when the item is not a folder.
"canShare": True or False, # Whether the current user can modify the sharing settings for this file.
"canTrashChildren": True or False, # Whether the current user can trash children of this folder. This is false when the item is not a folder. Only populated for items in shared drives.
+ "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.
"canMoveChildrenWithinDrive": True or False, # Whether the current user can move children of this folder within the shared drive. This is false when the item is not a folder. Only populated for items in shared drives.
"canReadRevisions": True or False, # Whether the current user can read the revisions resource of this file. For a shared drive item, whether revisions of non-folder descendants of this item, or this item itself if it is not a folder, can be read.
"canMoveItemWithinDrive": True or False, # Whether the current user can move this item within this shared drive. Note that a request to change the parent of the item may still fail depending on the new parent that is being added. Only populated for items in shared drives.
@@ -424,6 +442,7 @@
"canMoveChildrenOutOfDrive": True or False, # Whether the current user can move children of this folder outside of the shared drive. This is false when the item is not a folder. Only populated for items in shared drives.
"canChangeViewersCanCopyContent": True or False, # Deprecated
"canTrash": True or False, # Whether the current user can move this file to trash.
+ "canRemoveMyDriveParent": True or False, # Whether the current user can remove a parent from the item without adding another parent in the same request. Not populated for shared drive files.
"canDelete": True or False, # Whether the current user can delete this file.
"canMoveTeamDriveItem": True or False, # Deprecated - use canMoveItemWithinDrive or canMoveItemOutOfDrive instead.
"canDownload": True or False, # Whether the current user can download this file.
@@ -431,7 +450,7 @@
"canMoveChildrenOutOfTeamDrive": True or False, # Deprecated - use canMoveChildrenOutOfDrive instead.
"canRemoveChildren": True or False, # Whether the current user can remove children from this folder. This is always false when the item is not a folder. For a folder in a shared drive, use canDeleteChildren or canTrashChildren instead.
"canReadTeamDrive": True or False, # Deprecated - use canReadDrive instead.
- "canEdit": True or False, # Whether the current user can edit this file.
+ "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.
},
"trashedTime": "A String", # The time that the item was trashed (RFC 3339 date-time). Only populated for items in shared drives.
"webViewLink": "A String", # A link for opening the file in a relevant Google editor or viewer in a browser.
@@ -496,7 +515,7 @@
"flashUsed": True or False, # Whether a flash was used to create the photo.
"time": "A String", # The date and time the photo was taken (EXIF DateTime).
"aperture": 3.14, # The aperture used to create the photo (f-number).
- "rotation": 42, # The rotation in clockwise degrees from the image's original orientation.
+ "rotation": 42, # The number of clockwise 90 degree rotations applied from the image's original orientation.
"sensor": "A String", # The type of sensor used to create the photo.
"whiteBalance": "A String", # The white balance mode used to create the photo.
"cameraModel": "A String", # The model of the camera used to create the photo.
@@ -528,11 +547,15 @@
},
},
"fileExtension": "A String", # The final component of fullFileExtension. This is only available for files with binary content in Google Drive.
- "hasAugmentedPermissions": True or False, # Whether any users are granted file access directly on this file. This field is only populated for shared drive files.
+ "hasAugmentedPermissions": True or False, # Whether there are permissions directly on this file. This field is only populated for items in shared drives.
"permissions": [ # The full list of permissions for the file. This is only available if the requesting user can share the file. Not populated for items in shared drives.
{ # A permission for a file. A permission grants a user, group, domain or the world access to a file or a folder hierarchy.
"domain": "A String", # The domain to which this permission refers.
- "displayName": "A String", # A displayable name for users, groups or domains.
+ "displayName": "A String", # The "pretty" name of the value of the permission. The following is a list of examples for each type of permission:
+ # - user - User's full name, as defined for their Google account, such as "Joe Smith."
+ # - group - Name of the Google Group, such as "The Company Administrators."
+ # - domain - String domain name, such as "thecompany.com."
+ # - anyone - No displayName is present.
"teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead.
{
"inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead.
@@ -554,7 +577,7 @@
# - writer
# - commenter
# - reader
- "inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field and is only populated for members of the shared drive.
+ "inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field.
"permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible:
# - file
# - member
@@ -576,8 +599,8 @@
# - user
# - group
# - domain
- # - anyone
- "id": "A String", # The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as permissionId.
+ # - anyone When creating a permission, if type is user or group, you must provide an emailAddress for the user or group. When type is domain, you must provide a domain. There isn't extra information required for a anyone type.
+ "id": "A String", # The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as permissionId. IDs should be treated as opaque values.
},
],
"headRevisionId": "A String", # The ID of the file's head revision. This is currently only available for files with binary content in Google Drive.
@@ -585,7 +608,7 @@
</div>
<div class="method">
- <code class="details" id="create">create(body=None, media_body=None, keepRevisionForever=None, useContentAsIndexableText=None, supportsTeamDrives=None, ocrLanguage=None, ignoreDefaultVisibility=None, supportsAllDrives=None, media_mime_type=None)</code>
+ <code class="details" id="create">create(body=None, enforceSingleParent=None, keepRevisionForever=None, media_body=None, useContentAsIndexableText=None, supportsTeamDrives=None, ocrLanguage=None, ignoreDefaultVisibility=None, supportsAllDrives=None, media_mime_type=None)</code>
<pre>Creates a new file.
Args:
@@ -615,6 +638,10 @@
"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
"photoLink": "A String", # A link to the user's profile photo, if available.
},
+ "shortcutDetails": { # Shortcut file details. Only populated for shortcut files, which have the mimeType field set to application/vnd.google-apps.shortcut.
+ "targetId": "A String", # The ID of the file that this shortcut points to.
+ "targetMimeType": "A String", # The MIME type of the file that this shortcut points to. The value of this field is a snapshot of the target's MIME type, captured when the shortcut is created.
+ },
"size": "A String", # The size of the file's content in bytes. This is only applicable to files with binary content in Google Drive.
"videoMediaMetadata": { # Additional metadata about video media. This may not be available immediately upon upload.
"width": 42, # The width of the video in pixels.
@@ -643,10 +670,12 @@
"canMoveChildrenWithinTeamDrive": True or False, # Deprecated - use canMoveChildrenWithinDrive instead.
"canListChildren": True or False, # Whether the current user can list the children of this folder. This is always false when the item is not a folder.
"canRename": True or False, # Whether the current user can rename this file.
+ "canModifyContent": True or False, # Whether the current user can modify the content of this file.
"canReadDrive": True or False, # Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives.
"canAddChildren": True or False, # Whether the current user can add children to this folder. This is always false when the item is not a folder.
"canShare": True or False, # Whether the current user can modify the sharing settings for this file.
"canTrashChildren": True or False, # Whether the current user can trash children of this folder. This is false when the item is not a folder. Only populated for items in shared drives.
+ "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.
"canMoveChildrenWithinDrive": True or False, # Whether the current user can move children of this folder within the shared drive. This is false when the item is not a folder. Only populated for items in shared drives.
"canReadRevisions": True or False, # Whether the current user can read the revisions resource of this file. For a shared drive item, whether revisions of non-folder descendants of this item, or this item itself if it is not a folder, can be read.
"canMoveItemWithinDrive": True or False, # Whether the current user can move this item within this shared drive. Note that a request to change the parent of the item may still fail depending on the new parent that is being added. Only populated for items in shared drives.
@@ -657,6 +686,7 @@
"canMoveChildrenOutOfDrive": True or False, # Whether the current user can move children of this folder outside of the shared drive. This is false when the item is not a folder. Only populated for items in shared drives.
"canChangeViewersCanCopyContent": True or False, # Deprecated
"canTrash": True or False, # Whether the current user can move this file to trash.
+ "canRemoveMyDriveParent": True or False, # Whether the current user can remove a parent from the item without adding another parent in the same request. Not populated for shared drive files.
"canDelete": True or False, # Whether the current user can delete this file.
"canMoveTeamDriveItem": True or False, # Deprecated - use canMoveItemWithinDrive or canMoveItemOutOfDrive instead.
"canDownload": True or False, # Whether the current user can download this file.
@@ -664,7 +694,7 @@
"canMoveChildrenOutOfTeamDrive": True or False, # Deprecated - use canMoveChildrenOutOfDrive instead.
"canRemoveChildren": True or False, # Whether the current user can remove children from this folder. This is always false when the item is not a folder. For a folder in a shared drive, use canDeleteChildren or canTrashChildren instead.
"canReadTeamDrive": True or False, # Deprecated - use canReadDrive instead.
- "canEdit": True or False, # Whether the current user can edit this file.
+ "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.
},
"trashedTime": "A String", # The time that the item was trashed (RFC 3339 date-time). Only populated for items in shared drives.
"webViewLink": "A String", # A link for opening the file in a relevant Google editor or viewer in a browser.
@@ -729,7 +759,7 @@
"flashUsed": True or False, # Whether a flash was used to create the photo.
"time": "A String", # The date and time the photo was taken (EXIF DateTime).
"aperture": 3.14, # The aperture used to create the photo (f-number).
- "rotation": 42, # The rotation in clockwise degrees from the image's original orientation.
+ "rotation": 42, # The number of clockwise 90 degree rotations applied from the image's original orientation.
"sensor": "A String", # The type of sensor used to create the photo.
"whiteBalance": "A String", # The white balance mode used to create the photo.
"cameraModel": "A String", # The model of the camera used to create the photo.
@@ -761,11 +791,15 @@
},
},
"fileExtension": "A String", # The final component of fullFileExtension. This is only available for files with binary content in Google Drive.
- "hasAugmentedPermissions": True or False, # Whether any users are granted file access directly on this file. This field is only populated for shared drive files.
+ "hasAugmentedPermissions": True or False, # Whether there are permissions directly on this file. This field is only populated for items in shared drives.
"permissions": [ # The full list of permissions for the file. This is only available if the requesting user can share the file. Not populated for items in shared drives.
{ # A permission for a file. A permission grants a user, group, domain or the world access to a file or a folder hierarchy.
"domain": "A String", # The domain to which this permission refers.
- "displayName": "A String", # A displayable name for users, groups or domains.
+ "displayName": "A String", # The "pretty" name of the value of the permission. The following is a list of examples for each type of permission:
+ # - user - User's full name, as defined for their Google account, such as "Joe Smith."
+ # - group - Name of the Google Group, such as "The Company Administrators."
+ # - domain - String domain name, such as "thecompany.com."
+ # - anyone - No displayName is present.
"teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead.
{
"inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead.
@@ -787,7 +821,7 @@
# - writer
# - commenter
# - reader
- "inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field and is only populated for members of the shared drive.
+ "inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field.
"permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible:
# - file
# - member
@@ -809,15 +843,16 @@
# - user
# - group
# - domain
- # - anyone
- "id": "A String", # The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as permissionId.
+ # - anyone When creating a permission, if type is user or group, you must provide an emailAddress for the user or group. When type is domain, you must provide a domain. There isn't extra information required for a anyone type.
+ "id": "A String", # The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as permissionId. IDs should be treated as opaque values.
},
],
"headRevisionId": "A String", # The ID of the file's head revision. This is currently only available for files with binary content in Google Drive.
}
+ enforceSingleParent: boolean, Set to true to opt in to API behavior that aims for all items to have exactly one parent. This parameter only takes effect if the item is not in a shared drive. Requests that specify more than one parent fail.
+ keepRevisionForever: boolean, Whether to set the 'keepForever' field in the new head revision. This is only applicable to files with binary content in Google Drive. Only 200 revisions for the file can be kept forever. If the limit is reached, try deleting pinned revisions.
media_body: string, The filename of the media request body, or an instance of a MediaUpload object.
- keepRevisionForever: boolean, Whether to set the 'keepForever' field in the new head revision. This is only applicable to files with binary content in Google Drive.
useContentAsIndexableText: boolean, Whether to use the uploaded content as indexable text.
supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead.
ocrLanguage: string, A language hint for OCR processing during image import (ISO 639-1 code).
@@ -851,6 +886,10 @@
"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
"photoLink": "A String", # A link to the user's profile photo, if available.
},
+ "shortcutDetails": { # Shortcut file details. Only populated for shortcut files, which have the mimeType field set to application/vnd.google-apps.shortcut.
+ "targetId": "A String", # The ID of the file that this shortcut points to.
+ "targetMimeType": "A String", # The MIME type of the file that this shortcut points to. The value of this field is a snapshot of the target's MIME type, captured when the shortcut is created.
+ },
"size": "A String", # The size of the file's content in bytes. This is only applicable to files with binary content in Google Drive.
"videoMediaMetadata": { # Additional metadata about video media. This may not be available immediately upon upload.
"width": 42, # The width of the video in pixels.
@@ -879,10 +918,12 @@
"canMoveChildrenWithinTeamDrive": True or False, # Deprecated - use canMoveChildrenWithinDrive instead.
"canListChildren": True or False, # Whether the current user can list the children of this folder. This is always false when the item is not a folder.
"canRename": True or False, # Whether the current user can rename this file.
+ "canModifyContent": True or False, # Whether the current user can modify the content of this file.
"canReadDrive": True or False, # Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives.
"canAddChildren": True or False, # Whether the current user can add children to this folder. This is always false when the item is not a folder.
"canShare": True or False, # Whether the current user can modify the sharing settings for this file.
"canTrashChildren": True or False, # Whether the current user can trash children of this folder. This is false when the item is not a folder. Only populated for items in shared drives.
+ "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.
"canMoveChildrenWithinDrive": True or False, # Whether the current user can move children of this folder within the shared drive. This is false when the item is not a folder. Only populated for items in shared drives.
"canReadRevisions": True or False, # Whether the current user can read the revisions resource of this file. For a shared drive item, whether revisions of non-folder descendants of this item, or this item itself if it is not a folder, can be read.
"canMoveItemWithinDrive": True or False, # Whether the current user can move this item within this shared drive. Note that a request to change the parent of the item may still fail depending on the new parent that is being added. Only populated for items in shared drives.
@@ -893,6 +934,7 @@
"canMoveChildrenOutOfDrive": True or False, # Whether the current user can move children of this folder outside of the shared drive. This is false when the item is not a folder. Only populated for items in shared drives.
"canChangeViewersCanCopyContent": True or False, # Deprecated
"canTrash": True or False, # Whether the current user can move this file to trash.
+ "canRemoveMyDriveParent": True or False, # Whether the current user can remove a parent from the item without adding another parent in the same request. Not populated for shared drive files.
"canDelete": True or False, # Whether the current user can delete this file.
"canMoveTeamDriveItem": True or False, # Deprecated - use canMoveItemWithinDrive or canMoveItemOutOfDrive instead.
"canDownload": True or False, # Whether the current user can download this file.
@@ -900,7 +942,7 @@
"canMoveChildrenOutOfTeamDrive": True or False, # Deprecated - use canMoveChildrenOutOfDrive instead.
"canRemoveChildren": True or False, # Whether the current user can remove children from this folder. This is always false when the item is not a folder. For a folder in a shared drive, use canDeleteChildren or canTrashChildren instead.
"canReadTeamDrive": True or False, # Deprecated - use canReadDrive instead.
- "canEdit": True or False, # Whether the current user can edit this file.
+ "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.
},
"trashedTime": "A String", # The time that the item was trashed (RFC 3339 date-time). Only populated for items in shared drives.
"webViewLink": "A String", # A link for opening the file in a relevant Google editor or viewer in a browser.
@@ -965,7 +1007,7 @@
"flashUsed": True or False, # Whether a flash was used to create the photo.
"time": "A String", # The date and time the photo was taken (EXIF DateTime).
"aperture": 3.14, # The aperture used to create the photo (f-number).
- "rotation": 42, # The rotation in clockwise degrees from the image's original orientation.
+ "rotation": 42, # The number of clockwise 90 degree rotations applied from the image's original orientation.
"sensor": "A String", # The type of sensor used to create the photo.
"whiteBalance": "A String", # The white balance mode used to create the photo.
"cameraModel": "A String", # The model of the camera used to create the photo.
@@ -997,11 +1039,15 @@
},
},
"fileExtension": "A String", # The final component of fullFileExtension. This is only available for files with binary content in Google Drive.
- "hasAugmentedPermissions": True or False, # Whether any users are granted file access directly on this file. This field is only populated for shared drive files.
+ "hasAugmentedPermissions": True or False, # Whether there are permissions directly on this file. This field is only populated for items in shared drives.
"permissions": [ # The full list of permissions for the file. This is only available if the requesting user can share the file. Not populated for items in shared drives.
{ # A permission for a file. A permission grants a user, group, domain or the world access to a file or a folder hierarchy.
"domain": "A String", # The domain to which this permission refers.
- "displayName": "A String", # A displayable name for users, groups or domains.
+ "displayName": "A String", # The "pretty" name of the value of the permission. The following is a list of examples for each type of permission:
+ # - user - User's full name, as defined for their Google account, such as "Joe Smith."
+ # - group - Name of the Google Group, such as "The Company Administrators."
+ # - domain - String domain name, such as "thecompany.com."
+ # - anyone - No displayName is present.
"teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead.
{
"inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead.
@@ -1023,7 +1069,7 @@
# - writer
# - commenter
# - reader
- "inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field and is only populated for members of the shared drive.
+ "inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field.
"permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible:
# - file
# - member
@@ -1045,8 +1091,8 @@
# - user
# - group
# - domain
- # - anyone
- "id": "A String", # The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as permissionId.
+ # - anyone When creating a permission, if type is user or group, you must provide an emailAddress for the user or group. When type is domain, you must provide a domain. There isn't extra information required for a anyone type.
+ "id": "A String", # The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as permissionId. IDs should be treated as opaque values.
},
],
"headRevisionId": "A String", # The ID of the file's head revision. This is currently only available for files with binary content in Google Drive.
@@ -1094,7 +1140,7 @@
<div class="method">
<code class="details" id="generateIds">generateIds(count=None, space=None)</code>
- <pre>Generates a set of file IDs which can be provided in create requests.
+ <pre>Generates a set of file IDs which can be provided in create or copy requests.
Args:
count: integer, The number of IDs to return.
@@ -1148,6 +1194,10 @@
"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
"photoLink": "A String", # A link to the user's profile photo, if available.
},
+ "shortcutDetails": { # Shortcut file details. Only populated for shortcut files, which have the mimeType field set to application/vnd.google-apps.shortcut.
+ "targetId": "A String", # The ID of the file that this shortcut points to.
+ "targetMimeType": "A String", # The MIME type of the file that this shortcut points to. The value of this field is a snapshot of the target's MIME type, captured when the shortcut is created.
+ },
"size": "A String", # The size of the file's content in bytes. This is only applicable to files with binary content in Google Drive.
"videoMediaMetadata": { # Additional metadata about video media. This may not be available immediately upon upload.
"width": 42, # The width of the video in pixels.
@@ -1176,10 +1226,12 @@
"canMoveChildrenWithinTeamDrive": True or False, # Deprecated - use canMoveChildrenWithinDrive instead.
"canListChildren": True or False, # Whether the current user can list the children of this folder. This is always false when the item is not a folder.
"canRename": True or False, # Whether the current user can rename this file.
+ "canModifyContent": True or False, # Whether the current user can modify the content of this file.
"canReadDrive": True or False, # Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives.
"canAddChildren": True or False, # Whether the current user can add children to this folder. This is always false when the item is not a folder.
"canShare": True or False, # Whether the current user can modify the sharing settings for this file.
"canTrashChildren": True or False, # Whether the current user can trash children of this folder. This is false when the item is not a folder. Only populated for items in shared drives.
+ "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.
"canMoveChildrenWithinDrive": True or False, # Whether the current user can move children of this folder within the shared drive. This is false when the item is not a folder. Only populated for items in shared drives.
"canReadRevisions": True or False, # Whether the current user can read the revisions resource of this file. For a shared drive item, whether revisions of non-folder descendants of this item, or this item itself if it is not a folder, can be read.
"canMoveItemWithinDrive": True or False, # Whether the current user can move this item within this shared drive. Note that a request to change the parent of the item may still fail depending on the new parent that is being added. Only populated for items in shared drives.
@@ -1190,6 +1242,7 @@
"canMoveChildrenOutOfDrive": True or False, # Whether the current user can move children of this folder outside of the shared drive. This is false when the item is not a folder. Only populated for items in shared drives.
"canChangeViewersCanCopyContent": True or False, # Deprecated
"canTrash": True or False, # Whether the current user can move this file to trash.
+ "canRemoveMyDriveParent": True or False, # Whether the current user can remove a parent from the item without adding another parent in the same request. Not populated for shared drive files.
"canDelete": True or False, # Whether the current user can delete this file.
"canMoveTeamDriveItem": True or False, # Deprecated - use canMoveItemWithinDrive or canMoveItemOutOfDrive instead.
"canDownload": True or False, # Whether the current user can download this file.
@@ -1197,7 +1250,7 @@
"canMoveChildrenOutOfTeamDrive": True or False, # Deprecated - use canMoveChildrenOutOfDrive instead.
"canRemoveChildren": True or False, # Whether the current user can remove children from this folder. This is always false when the item is not a folder. For a folder in a shared drive, use canDeleteChildren or canTrashChildren instead.
"canReadTeamDrive": True or False, # Deprecated - use canReadDrive instead.
- "canEdit": True or False, # Whether the current user can edit this file.
+ "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.
},
"trashedTime": "A String", # The time that the item was trashed (RFC 3339 date-time). Only populated for items in shared drives.
"webViewLink": "A String", # A link for opening the file in a relevant Google editor or viewer in a browser.
@@ -1262,7 +1315,7 @@
"flashUsed": True or False, # Whether a flash was used to create the photo.
"time": "A String", # The date and time the photo was taken (EXIF DateTime).
"aperture": 3.14, # The aperture used to create the photo (f-number).
- "rotation": 42, # The rotation in clockwise degrees from the image's original orientation.
+ "rotation": 42, # The number of clockwise 90 degree rotations applied from the image's original orientation.
"sensor": "A String", # The type of sensor used to create the photo.
"whiteBalance": "A String", # The white balance mode used to create the photo.
"cameraModel": "A String", # The model of the camera used to create the photo.
@@ -1294,11 +1347,15 @@
},
},
"fileExtension": "A String", # The final component of fullFileExtension. This is only available for files with binary content in Google Drive.
- "hasAugmentedPermissions": True or False, # Whether any users are granted file access directly on this file. This field is only populated for shared drive files.
+ "hasAugmentedPermissions": True or False, # Whether there are permissions directly on this file. This field is only populated for items in shared drives.
"permissions": [ # The full list of permissions for the file. This is only available if the requesting user can share the file. Not populated for items in shared drives.
{ # A permission for a file. A permission grants a user, group, domain or the world access to a file or a folder hierarchy.
"domain": "A String", # The domain to which this permission refers.
- "displayName": "A String", # A displayable name for users, groups or domains.
+ "displayName": "A String", # The "pretty" name of the value of the permission. The following is a list of examples for each type of permission:
+ # - user - User's full name, as defined for their Google account, such as "Joe Smith."
+ # - group - Name of the Google Group, such as "The Company Administrators."
+ # - domain - String domain name, such as "thecompany.com."
+ # - anyone - No displayName is present.
"teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead.
{
"inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead.
@@ -1320,7 +1377,7 @@
# - writer
# - commenter
# - reader
- "inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field and is only populated for members of the shared drive.
+ "inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field.
"permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible:
# - file
# - member
@@ -1342,8 +1399,8 @@
# - user
# - group
# - domain
- # - anyone
- "id": "A String", # The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as permissionId.
+ # - anyone When creating a permission, if type is user or group, you must provide an emailAddress for the user or group. When type is domain, you must provide a domain. There isn't extra information required for a anyone type.
+ "id": "A String", # The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as permissionId. IDs should be treated as opaque values.
},
],
"headRevisionId": "A String", # The ID of the file's head revision. This is currently only available for files with binary content in Google Drive.
@@ -1382,7 +1439,7 @@
domain - Files shared to the user's domain.
user - Files owned by or shared to the user.
teamDriveId: string, Deprecated use driveId instead.
- includeItemsFromAllDrives: boolean, Deprecated - Whether both My Drive and shared drive items should be included in results. This parameter will only be effective until June 1, 2020. Afterwards shared drive items will be included in the results.
+ 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.
includeTeamDriveItems: boolean, Deprecated use includeItemsFromAllDrives instead.
corpora: string, Bodies of items (files/documents) to which the query applies. Supported bodies are 'user', 'domain', 'drive' and 'allDrives'. Prefer 'user' or 'drive' to 'allDrives' for efficiency.
supportsAllDrives: boolean, Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives.
@@ -1416,6 +1473,10 @@
"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
"photoLink": "A String", # A link to the user's profile photo, if available.
},
+ "shortcutDetails": { # Shortcut file details. Only populated for shortcut files, which have the mimeType field set to application/vnd.google-apps.shortcut.
+ "targetId": "A String", # The ID of the file that this shortcut points to.
+ "targetMimeType": "A String", # The MIME type of the file that this shortcut points to. The value of this field is a snapshot of the target's MIME type, captured when the shortcut is created.
+ },
"size": "A String", # The size of the file's content in bytes. This is only applicable to files with binary content in Google Drive.
"videoMediaMetadata": { # Additional metadata about video media. This may not be available immediately upon upload.
"width": 42, # The width of the video in pixels.
@@ -1444,10 +1505,12 @@
"canMoveChildrenWithinTeamDrive": True or False, # Deprecated - use canMoveChildrenWithinDrive instead.
"canListChildren": True or False, # Whether the current user can list the children of this folder. This is always false when the item is not a folder.
"canRename": True or False, # Whether the current user can rename this file.
+ "canModifyContent": True or False, # Whether the current user can modify the content of this file.
"canReadDrive": True or False, # Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives.
"canAddChildren": True or False, # Whether the current user can add children to this folder. This is always false when the item is not a folder.
"canShare": True or False, # Whether the current user can modify the sharing settings for this file.
"canTrashChildren": True or False, # Whether the current user can trash children of this folder. This is false when the item is not a folder. Only populated for items in shared drives.
+ "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.
"canMoveChildrenWithinDrive": True or False, # Whether the current user can move children of this folder within the shared drive. This is false when the item is not a folder. Only populated for items in shared drives.
"canReadRevisions": True or False, # Whether the current user can read the revisions resource of this file. For a shared drive item, whether revisions of non-folder descendants of this item, or this item itself if it is not a folder, can be read.
"canMoveItemWithinDrive": True or False, # Whether the current user can move this item within this shared drive. Note that a request to change the parent of the item may still fail depending on the new parent that is being added. Only populated for items in shared drives.
@@ -1458,6 +1521,7 @@
"canMoveChildrenOutOfDrive": True or False, # Whether the current user can move children of this folder outside of the shared drive. This is false when the item is not a folder. Only populated for items in shared drives.
"canChangeViewersCanCopyContent": True or False, # Deprecated
"canTrash": True or False, # Whether the current user can move this file to trash.
+ "canRemoveMyDriveParent": True or False, # Whether the current user can remove a parent from the item without adding another parent in the same request. Not populated for shared drive files.
"canDelete": True or False, # Whether the current user can delete this file.
"canMoveTeamDriveItem": True or False, # Deprecated - use canMoveItemWithinDrive or canMoveItemOutOfDrive instead.
"canDownload": True or False, # Whether the current user can download this file.
@@ -1465,7 +1529,7 @@
"canMoveChildrenOutOfTeamDrive": True or False, # Deprecated - use canMoveChildrenOutOfDrive instead.
"canRemoveChildren": True or False, # Whether the current user can remove children from this folder. This is always false when the item is not a folder. For a folder in a shared drive, use canDeleteChildren or canTrashChildren instead.
"canReadTeamDrive": True or False, # Deprecated - use canReadDrive instead.
- "canEdit": True or False, # Whether the current user can edit this file.
+ "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.
},
"trashedTime": "A String", # The time that the item was trashed (RFC 3339 date-time). Only populated for items in shared drives.
"webViewLink": "A String", # A link for opening the file in a relevant Google editor or viewer in a browser.
@@ -1530,7 +1594,7 @@
"flashUsed": True or False, # Whether a flash was used to create the photo.
"time": "A String", # The date and time the photo was taken (EXIF DateTime).
"aperture": 3.14, # The aperture used to create the photo (f-number).
- "rotation": 42, # The rotation in clockwise degrees from the image's original orientation.
+ "rotation": 42, # The number of clockwise 90 degree rotations applied from the image's original orientation.
"sensor": "A String", # The type of sensor used to create the photo.
"whiteBalance": "A String", # The white balance mode used to create the photo.
"cameraModel": "A String", # The model of the camera used to create the photo.
@@ -1562,11 +1626,15 @@
},
},
"fileExtension": "A String", # The final component of fullFileExtension. This is only available for files with binary content in Google Drive.
- "hasAugmentedPermissions": True or False, # Whether any users are granted file access directly on this file. This field is only populated for shared drive files.
+ "hasAugmentedPermissions": True or False, # Whether there are permissions directly on this file. This field is only populated for items in shared drives.
"permissions": [ # The full list of permissions for the file. This is only available if the requesting user can share the file. Not populated for items in shared drives.
{ # A permission for a file. A permission grants a user, group, domain or the world access to a file or a folder hierarchy.
"domain": "A String", # The domain to which this permission refers.
- "displayName": "A String", # A displayable name for users, groups or domains.
+ "displayName": "A String", # The "pretty" name of the value of the permission. The following is a list of examples for each type of permission:
+ # - user - User's full name, as defined for their Google account, such as "Joe Smith."
+ # - group - Name of the Google Group, such as "The Company Administrators."
+ # - domain - String domain name, such as "thecompany.com."
+ # - anyone - No displayName is present.
"teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead.
{
"inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead.
@@ -1588,7 +1656,7 @@
# - writer
# - commenter
# - reader
- "inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field and is only populated for members of the shared drive.
+ "inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field.
"permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible:
# - file
# - member
@@ -1610,8 +1678,8 @@
# - user
# - group
# - domain
- # - anyone
- "id": "A String", # The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as permissionId.
+ # - anyone When creating a permission, if type is user or group, you must provide an emailAddress for the user or group. When type is domain, you must provide a domain. There isn't extra information required for a anyone type.
+ "id": "A String", # The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as permissionId. IDs should be treated as opaque values.
},
],
"headRevisionId": "A String", # The ID of the file's head revision. This is currently only available for files with binary content in Google Drive.
@@ -1638,7 +1706,7 @@
</div>
<div class="method">
- <code class="details" id="update">update(fileId, body=None, keepRevisionForever=None, removeParents=None, supportsTeamDrives=None, media_body=None, ocrLanguage=None, addParents=None, useContentAsIndexableText=None, supportsAllDrives=None, media_mime_type=None)</code>
+ <code class="details" id="update">update(fileId, body=None, keepRevisionForever=None, removeParents=None, supportsTeamDrives=None, media_body=None, ocrLanguage=None, addParents=None, enforceSingleParent=None, useContentAsIndexableText=None, supportsAllDrives=None, media_mime_type=None)</code>
<pre>Updates a file's metadata and/or content with patch semantics.
Args:
@@ -1669,6 +1737,10 @@
"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
"photoLink": "A String", # A link to the user's profile photo, if available.
},
+ "shortcutDetails": { # Shortcut file details. Only populated for shortcut files, which have the mimeType field set to application/vnd.google-apps.shortcut.
+ "targetId": "A String", # The ID of the file that this shortcut points to.
+ "targetMimeType": "A String", # The MIME type of the file that this shortcut points to. The value of this field is a snapshot of the target's MIME type, captured when the shortcut is created.
+ },
"size": "A String", # The size of the file's content in bytes. This is only applicable to files with binary content in Google Drive.
"videoMediaMetadata": { # Additional metadata about video media. This may not be available immediately upon upload.
"width": 42, # The width of the video in pixels.
@@ -1697,10 +1769,12 @@
"canMoveChildrenWithinTeamDrive": True or False, # Deprecated - use canMoveChildrenWithinDrive instead.
"canListChildren": True or False, # Whether the current user can list the children of this folder. This is always false when the item is not a folder.
"canRename": True or False, # Whether the current user can rename this file.
+ "canModifyContent": True or False, # Whether the current user can modify the content of this file.
"canReadDrive": True or False, # Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives.
"canAddChildren": True or False, # Whether the current user can add children to this folder. This is always false when the item is not a folder.
"canShare": True or False, # Whether the current user can modify the sharing settings for this file.
"canTrashChildren": True or False, # Whether the current user can trash children of this folder. This is false when the item is not a folder. Only populated for items in shared drives.
+ "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.
"canMoveChildrenWithinDrive": True or False, # Whether the current user can move children of this folder within the shared drive. This is false when the item is not a folder. Only populated for items in shared drives.
"canReadRevisions": True or False, # Whether the current user can read the revisions resource of this file. For a shared drive item, whether revisions of non-folder descendants of this item, or this item itself if it is not a folder, can be read.
"canMoveItemWithinDrive": True or False, # Whether the current user can move this item within this shared drive. Note that a request to change the parent of the item may still fail depending on the new parent that is being added. Only populated for items in shared drives.
@@ -1711,6 +1785,7 @@
"canMoveChildrenOutOfDrive": True or False, # Whether the current user can move children of this folder outside of the shared drive. This is false when the item is not a folder. Only populated for items in shared drives.
"canChangeViewersCanCopyContent": True or False, # Deprecated
"canTrash": True or False, # Whether the current user can move this file to trash.
+ "canRemoveMyDriveParent": True or False, # Whether the current user can remove a parent from the item without adding another parent in the same request. Not populated for shared drive files.
"canDelete": True or False, # Whether the current user can delete this file.
"canMoveTeamDriveItem": True or False, # Deprecated - use canMoveItemWithinDrive or canMoveItemOutOfDrive instead.
"canDownload": True or False, # Whether the current user can download this file.
@@ -1718,7 +1793,7 @@
"canMoveChildrenOutOfTeamDrive": True or False, # Deprecated - use canMoveChildrenOutOfDrive instead.
"canRemoveChildren": True or False, # Whether the current user can remove children from this folder. This is always false when the item is not a folder. For a folder in a shared drive, use canDeleteChildren or canTrashChildren instead.
"canReadTeamDrive": True or False, # Deprecated - use canReadDrive instead.
- "canEdit": True or False, # Whether the current user can edit this file.
+ "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.
},
"trashedTime": "A String", # The time that the item was trashed (RFC 3339 date-time). Only populated for items in shared drives.
"webViewLink": "A String", # A link for opening the file in a relevant Google editor or viewer in a browser.
@@ -1783,7 +1858,7 @@
"flashUsed": True or False, # Whether a flash was used to create the photo.
"time": "A String", # The date and time the photo was taken (EXIF DateTime).
"aperture": 3.14, # The aperture used to create the photo (f-number).
- "rotation": 42, # The rotation in clockwise degrees from the image's original orientation.
+ "rotation": 42, # The number of clockwise 90 degree rotations applied from the image's original orientation.
"sensor": "A String", # The type of sensor used to create the photo.
"whiteBalance": "A String", # The white balance mode used to create the photo.
"cameraModel": "A String", # The model of the camera used to create the photo.
@@ -1815,11 +1890,15 @@
},
},
"fileExtension": "A String", # The final component of fullFileExtension. This is only available for files with binary content in Google Drive.
- "hasAugmentedPermissions": True or False, # Whether any users are granted file access directly on this file. This field is only populated for shared drive files.
+ "hasAugmentedPermissions": True or False, # Whether there are permissions directly on this file. This field is only populated for items in shared drives.
"permissions": [ # The full list of permissions for the file. This is only available if the requesting user can share the file. Not populated for items in shared drives.
{ # A permission for a file. A permission grants a user, group, domain or the world access to a file or a folder hierarchy.
"domain": "A String", # The domain to which this permission refers.
- "displayName": "A String", # A displayable name for users, groups or domains.
+ "displayName": "A String", # The "pretty" name of the value of the permission. The following is a list of examples for each type of permission:
+ # - user - User's full name, as defined for their Google account, such as "Joe Smith."
+ # - group - Name of the Google Group, such as "The Company Administrators."
+ # - domain - String domain name, such as "thecompany.com."
+ # - anyone - No displayName is present.
"teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead.
{
"inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead.
@@ -1841,7 +1920,7 @@
# - writer
# - commenter
# - reader
- "inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field and is only populated for members of the shared drive.
+ "inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field.
"permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible:
# - file
# - member
@@ -1863,19 +1942,20 @@
# - user
# - group
# - domain
- # - anyone
- "id": "A String", # The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as permissionId.
+ # - anyone When creating a permission, if type is user or group, you must provide an emailAddress for the user or group. When type is domain, you must provide a domain. There isn't extra information required for a anyone type.
+ "id": "A String", # The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as permissionId. IDs should be treated as opaque values.
},
],
"headRevisionId": "A String", # The ID of the file's head revision. This is currently only available for files with binary content in Google Drive.
}
- keepRevisionForever: boolean, Whether to set the 'keepForever' field in the new head revision. This is only applicable to files with binary content in Google Drive.
+ keepRevisionForever: boolean, Whether to set the 'keepForever' field in the new head revision. This is only applicable to files with binary content in Google Drive. Only 200 revisions for the file can be kept forever. If the limit is reached, try deleting pinned revisions.
removeParents: string, A comma-separated list of parent IDs to remove.
supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead.
media_body: string, The filename of the media request body, or an instance of a MediaUpload object.
ocrLanguage: string, A language hint for OCR processing during image import (ISO 639-1 code).
addParents: string, A comma-separated list of parent IDs to add.
+ enforceSingleParent: boolean, Set to true to opt in to API behavior that aims for all items to have exactly one parent. This parameter only takes effect if the item is not in a shared drive. If the item's owner makes a request to add a single parent, the item is removed from all current folders and placed in the requested folder. Other requests that increase the number of parents fail, except when the canAddMyDriveParent file capability is true and a single parent is being added.
useContentAsIndexableText: boolean, Whether to use the uploaded content as indexable text.
supportsAllDrives: boolean, Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives.
media_mime_type: string, The MIME type of the media request body, or an instance of a MediaUpload object.
@@ -1906,6 +1986,10 @@
"emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
"photoLink": "A String", # A link to the user's profile photo, if available.
},
+ "shortcutDetails": { # Shortcut file details. Only populated for shortcut files, which have the mimeType field set to application/vnd.google-apps.shortcut.
+ "targetId": "A String", # The ID of the file that this shortcut points to.
+ "targetMimeType": "A String", # The MIME type of the file that this shortcut points to. The value of this field is a snapshot of the target's MIME type, captured when the shortcut is created.
+ },
"size": "A String", # The size of the file's content in bytes. This is only applicable to files with binary content in Google Drive.
"videoMediaMetadata": { # Additional metadata about video media. This may not be available immediately upon upload.
"width": 42, # The width of the video in pixels.
@@ -1934,10 +2018,12 @@
"canMoveChildrenWithinTeamDrive": True or False, # Deprecated - use canMoveChildrenWithinDrive instead.
"canListChildren": True or False, # Whether the current user can list the children of this folder. This is always false when the item is not a folder.
"canRename": True or False, # Whether the current user can rename this file.
+ "canModifyContent": True or False, # Whether the current user can modify the content of this file.
"canReadDrive": True or False, # Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives.
"canAddChildren": True or False, # Whether the current user can add children to this folder. This is always false when the item is not a folder.
"canShare": True or False, # Whether the current user can modify the sharing settings for this file.
"canTrashChildren": True or False, # Whether the current user can trash children of this folder. This is false when the item is not a folder. Only populated for items in shared drives.
+ "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.
"canMoveChildrenWithinDrive": True or False, # Whether the current user can move children of this folder within the shared drive. This is false when the item is not a folder. Only populated for items in shared drives.
"canReadRevisions": True or False, # Whether the current user can read the revisions resource of this file. For a shared drive item, whether revisions of non-folder descendants of this item, or this item itself if it is not a folder, can be read.
"canMoveItemWithinDrive": True or False, # Whether the current user can move this item within this shared drive. Note that a request to change the parent of the item may still fail depending on the new parent that is being added. Only populated for items in shared drives.
@@ -1948,6 +2034,7 @@
"canMoveChildrenOutOfDrive": True or False, # Whether the current user can move children of this folder outside of the shared drive. This is false when the item is not a folder. Only populated for items in shared drives.
"canChangeViewersCanCopyContent": True or False, # Deprecated
"canTrash": True or False, # Whether the current user can move this file to trash.
+ "canRemoveMyDriveParent": True or False, # Whether the current user can remove a parent from the item without adding another parent in the same request. Not populated for shared drive files.
"canDelete": True or False, # Whether the current user can delete this file.
"canMoveTeamDriveItem": True or False, # Deprecated - use canMoveItemWithinDrive or canMoveItemOutOfDrive instead.
"canDownload": True or False, # Whether the current user can download this file.
@@ -1955,7 +2042,7 @@
"canMoveChildrenOutOfTeamDrive": True or False, # Deprecated - use canMoveChildrenOutOfDrive instead.
"canRemoveChildren": True or False, # Whether the current user can remove children from this folder. This is always false when the item is not a folder. For a folder in a shared drive, use canDeleteChildren or canTrashChildren instead.
"canReadTeamDrive": True or False, # Deprecated - use canReadDrive instead.
- "canEdit": True or False, # Whether the current user can edit this file.
+ "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.
},
"trashedTime": "A String", # The time that the item was trashed (RFC 3339 date-time). Only populated for items in shared drives.
"webViewLink": "A String", # A link for opening the file in a relevant Google editor or viewer in a browser.
@@ -2020,7 +2107,7 @@
"flashUsed": True or False, # Whether a flash was used to create the photo.
"time": "A String", # The date and time the photo was taken (EXIF DateTime).
"aperture": 3.14, # The aperture used to create the photo (f-number).
- "rotation": 42, # The rotation in clockwise degrees from the image's original orientation.
+ "rotation": 42, # The number of clockwise 90 degree rotations applied from the image's original orientation.
"sensor": "A String", # The type of sensor used to create the photo.
"whiteBalance": "A String", # The white balance mode used to create the photo.
"cameraModel": "A String", # The model of the camera used to create the photo.
@@ -2052,11 +2139,15 @@
},
},
"fileExtension": "A String", # The final component of fullFileExtension. This is only available for files with binary content in Google Drive.
- "hasAugmentedPermissions": True or False, # Whether any users are granted file access directly on this file. This field is only populated for shared drive files.
+ "hasAugmentedPermissions": True or False, # Whether there are permissions directly on this file. This field is only populated for items in shared drives.
"permissions": [ # The full list of permissions for the file. This is only available if the requesting user can share the file. Not populated for items in shared drives.
{ # A permission for a file. A permission grants a user, group, domain or the world access to a file or a folder hierarchy.
"domain": "A String", # The domain to which this permission refers.
- "displayName": "A String", # A displayable name for users, groups or domains.
+ "displayName": "A String", # The "pretty" name of the value of the permission. The following is a list of examples for each type of permission:
+ # - user - User's full name, as defined for their Google account, such as "Joe Smith."
+ # - group - Name of the Google Group, such as "The Company Administrators."
+ # - domain - String domain name, such as "thecompany.com."
+ # - anyone - No displayName is present.
"teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead.
{
"inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead.
@@ -2078,7 +2169,7 @@
# - writer
# - commenter
# - reader
- "inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field and is only populated for members of the shared drive.
+ "inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field.
"permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible:
# - file
# - member
@@ -2100,8 +2191,8 @@
# - user
# - group
# - domain
- # - anyone
- "id": "A String", # The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as permissionId.
+ # - anyone When creating a permission, if type is user or group, you must provide an emailAddress for the user or group. When type is domain, you must provide a domain. There isn't extra information required for a anyone type.
+ "id": "A String", # The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as permissionId. IDs should be treated as opaque values.
},
],
"headRevisionId": "A String", # The ID of the file's head revision. This is currently only available for files with binary content in Google Drive.
@@ -2109,17 +2200,17 @@
</div>
<div class="method">
- <code class="details" id="watch">watch(fileId, body, supportsTeamDrives=None, supportsAllDrives=None, acknowledgeAbuse=None)</code>
+ <code class="details" id="watch">watch(fileId, body=None, supportsTeamDrives=None, supportsAllDrives=None, acknowledgeAbuse=None)</code>
<pre>Subscribes to changes to a file
Args:
fileId: string, The ID of the file. (required)
- body: object, The request body. (required)
+ body: object, The request body.
The object takes the form of:
{ # An notification channel used to watch for resource changes.
"resourceUri": "A String", # A version-specific identifier for the watched resource.
- "kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource. Value: the fixed string "api#channel".
+ "kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource, which is "api#channel".
"resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.
"payload": True or False, # A Boolean value to indicate whether payload is wanted. Optional.
"token": "A String", # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.
@@ -2141,7 +2232,7 @@
{ # An notification channel used to watch for resource changes.
"resourceUri": "A String", # A version-specific identifier for the watched resource.
- "kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource. Value: the fixed string "api#channel".
+ "kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource, which is "api#channel".
"resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.
"payload": True or False, # A Boolean value to indicate whether payload is wanted. Optional.
"token": "A String", # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.
@@ -2156,17 +2247,17 @@
</div>
<div class="method">
- <code class="details" id="watch_media">watch_media(fileId, body, supportsTeamDrives=None, supportsAllDrives=None, acknowledgeAbuse=None)</code>
+ <code class="details" id="watch_media">watch_media(fileId, body=None, supportsTeamDrives=None, supportsAllDrives=None, acknowledgeAbuse=None)</code>
<pre>Subscribes to changes to a file
Args:
fileId: string, The ID of the file. (required)
- body: object, The request body. (required)
+ body: object, The request body.
The object takes the form of:
{ # An notification channel used to watch for resource changes.
"resourceUri": "A String", # A version-specific identifier for the watched resource.
- "kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource. Value: the fixed string "api#channel".
+ "kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource, which is "api#channel".
"resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.
"payload": True or False, # A Boolean value to indicate whether payload is wanted. Optional.
"token": "A String", # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.