| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1 | <html><body> |
| 2 | <style> |
| 3 | |
| 4 | body, h1, h2, h3, div, span, p, pre, a { |
| 5 | margin: 0; |
| 6 | padding: 0; |
| 7 | border: 0; |
| 8 | font-weight: inherit; |
| 9 | font-style: inherit; |
| 10 | font-size: 100%; |
| 11 | font-family: inherit; |
| 12 | vertical-align: baseline; |
| 13 | } |
| 14 | |
| 15 | body { |
| 16 | font-size: 13px; |
| 17 | padding: 1em; |
| 18 | } |
| 19 | |
| 20 | h1 { |
| 21 | font-size: 26px; |
| 22 | margin-bottom: 1em; |
| 23 | } |
| 24 | |
| 25 | h2 { |
| 26 | font-size: 24px; |
| 27 | margin-bottom: 1em; |
| 28 | } |
| 29 | |
| 30 | h3 { |
| 31 | font-size: 20px; |
| 32 | margin-bottom: 1em; |
| 33 | margin-top: 1em; |
| 34 | } |
| 35 | |
| 36 | pre, code { |
| 37 | line-height: 1.5; |
| 38 | font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 | } |
| 40 | |
| 41 | pre { |
| 42 | margin-top: 0.5em; |
| 43 | } |
| 44 | |
| 45 | h1, h2, h3, p { |
| 46 | font-family: Arial, sans serif; |
| 47 | } |
| 48 | |
| 49 | h1, h2, h3 { |
| 50 | border-bottom: solid #CCC 1px; |
| 51 | } |
| 52 | |
| 53 | .toc_element { |
| 54 | margin-top: 0.5em; |
| 55 | } |
| 56 | |
| 57 | .firstline { |
| 58 | margin-left: 2 em; |
| 59 | } |
| 60 | |
| 61 | .method { |
| 62 | margin-top: 1em; |
| 63 | border: solid 1px #CCC; |
| 64 | padding: 1em; |
| 65 | background: #EEE; |
| 66 | } |
| 67 | |
| 68 | .details { |
| 69 | font-weight: bold; |
| 70 | font-size: 14px; |
| 71 | } |
| 72 | |
| 73 | </style> |
| 74 | |
| 75 | <h1><a href="drive_v2.html">Drive API</a> . <a href="drive_v2.changes.html">changes</a></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 78 | <code><a href="#close">close()</a></code></p> |
| 79 | <p class="firstline">Close httplib2 connections.</p> |
| 80 | <p class="toc_element"> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 81 | <code><a href="#get">get(changeId, driveId=None, supportsAllDrives=None, supportsTeamDrives=None, teamDriveId=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 82 | <p class="firstline">Deprecated - Use changes.getStartPageToken and changes.list to retrieve recent changes.</p> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 83 | <p class="toc_element"> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 84 | <code><a href="#getStartPageToken">getStartPageToken(driveId=None, supportsAllDrives=None, supportsTeamDrives=None, teamDriveId=None)</a></code></p> |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 85 | <p class="firstline">Gets the starting pageToken for listing future changes.</p> |
| 86 | <p class="toc_element"> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 87 | <code><a href="#list">list(driveId=None, includeCorpusRemovals=None, includeDeleted=None, includeItemsFromAllDrives=None, includePermissionsForView=None, includeSubscribed=None, includeTeamDriveItems=None, maxResults=None, pageToken=None, spaces=None, startChangeId=None, supportsAllDrives=None, supportsTeamDrives=None, teamDriveId=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 88 | <p class="firstline">Lists the changes for a user or shared drive.</p> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 89 | <p class="toc_element"> |
| 90 | <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| 91 | <p class="firstline">Retrieves the next page of results.</p> |
| 92 | <p class="toc_element"> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 93 | <code><a href="#watch">watch(body=None, driveId=None, includeCorpusRemovals=None, includeDeleted=None, includeItemsFromAllDrives=None, includePermissionsForView=None, includeSubscribed=None, includeTeamDriveItems=None, maxResults=None, pageToken=None, spaces=None, startChangeId=None, supportsAllDrives=None, supportsTeamDrives=None, teamDriveId=None)</a></code></p> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 94 | <p class="firstline">Subscribe to changes for a user.</p> |
| 95 | <h3>Method Details</h3> |
| 96 | <div class="method"> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 97 | <code class="details" id="close">close()</code> |
| 98 | <pre>Close httplib2 connections.</pre> |
| 99 | </div> |
| 100 | |
| 101 | <div class="method"> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 102 | <code class="details" id="get">get(changeId, driveId=None, supportsAllDrives=None, supportsTeamDrives=None, teamDriveId=None)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 103 | <pre>Deprecated - Use changes.getStartPageToken and changes.list to retrieve recent changes. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 104 | |
| 105 | Args: |
| 106 | changeId: string, The ID of the change. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 107 | driveId: string, The shared drive from which the change is returned. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 108 | supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 109 | supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 110 | teamDriveId: string, Deprecated use driveId instead. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 111 | |
| 112 | Returns: |
| 113 | An object of the form: |
| 114 | |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 115 | { # Representation of a change to a file or shared drive. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 116 | "changeType": "A String", # The type of the change. Possible values are file and drive. |
| 117 | "deleted": True or False, # Whether the file or shared drive has been removed from this list of changes, for example by deletion or loss of access. |
| 118 | "drive": { # Representation of a shared drive. # The updated state of the shared drive. Present if the changeType is drive, the user is still a member of the shared drive, and the shared drive has not been deleted. |
| 119 | "backgroundImageFile": { # An image file and cropping parameters from which a background image for this shared drive is set. This is a write only field; it can only be set on drive.drives.update requests that don't set themeId. When specified, all fields of the backgroundImageFile must be set. |
| 120 | "id": "A String", # The ID of an image file in Google Drive to use for the background image. |
| 121 | "width": 3.14, # The width of the cropped image in the closed range of 0 to 1. This value represents the width of the cropped image divided by the width of the entire image. The height is computed by applying a width to height aspect ratio of 80 to 9. The resulting image must be at least 1280 pixels wide and 144 pixels high. |
| 122 | "xCoordinate": 3.14, # The X coordinate of the upper left corner of the cropping area in the background image. This is a value in the closed range of 0 to 1. This value represents the horizontal distance from the left side of the entire image to the left side of the cropping area divided by the width of the entire image. |
| 123 | "yCoordinate": 3.14, # The Y coordinate of the upper left corner of the cropping area in the background image. This is a value in the closed range of 0 to 1. This value represents the vertical distance from the top side of the entire image to the top side of the cropping area divided by the height of the entire image. |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 124 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 125 | "backgroundImageLink": "A String", # A short-lived link to this shared drive's background image. |
| 126 | "capabilities": { # Capabilities the current user has on this shared drive. |
| 127 | "canAddChildren": True or False, # Whether the current user can add children to folders in this shared drive. |
| 128 | "canChangeCopyRequiresWriterPermissionRestriction": True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this shared drive. |
| 129 | "canChangeDomainUsersOnlyRestriction": True or False, # Whether the current user can change the domainUsersOnly restriction of this shared drive. |
| 130 | "canChangeDriveBackground": True or False, # Whether the current user can change the background of this shared drive. |
| 131 | "canChangeDriveMembersOnlyRestriction": True or False, # Whether the current user can change the driveMembersOnly restriction of this shared drive. |
| 132 | "canComment": True or False, # Whether the current user can comment on files in this shared drive. |
| 133 | "canCopy": True or False, # Whether the current user can copy files in this shared drive. |
| 134 | "canDeleteChildren": True or False, # Whether the current user can delete children from folders in this shared drive. |
| 135 | "canDeleteDrive": True or False, # Whether the current user can delete this shared drive. Attempting to delete the shared drive may still fail if there are untrashed items inside the shared drive. |
| 136 | "canDownload": True or False, # Whether the current user can download files in this shared drive. |
| 137 | "canEdit": True or False, # Whether the current user can edit files in this shared drive |
| 138 | "canListChildren": True or False, # Whether the current user can list the children of folders in this shared drive. |
| 139 | "canManageMembers": True or False, # Whether the current user can add members to this shared drive or remove them or change their role. |
| 140 | "canReadRevisions": True or False, # Whether the current user can read the revisions resource of files in this shared drive. |
| 141 | "canRename": True or False, # Whether the current user can rename files or folders in this shared drive. |
| 142 | "canRenameDrive": True or False, # Whether the current user can rename this shared drive. |
| 143 | "canShare": True or False, # Whether the current user can share files or folders in this shared drive. |
| 144 | "canTrashChildren": True or False, # Whether the current user can trash children from folders in this shared drive. |
| 145 | }, |
| 146 | "colorRgb": "A String", # The color of this shared drive as an RGB hex string. It can only be set on a drive.drives.update request that does not set themeId. |
| 147 | "createdDate": "A String", # The time at which the shared drive was created (RFC 3339 date-time). |
| 148 | "hidden": True or False, # Whether the shared drive is hidden from default view. |
| 149 | "id": "A String", # The ID of this shared drive which is also the ID of the top level folder of this shared drive. |
| 150 | "kind": "drive#drive", # This is always drive#drive |
| 151 | "name": "A String", # The name of this shared drive. |
| 152 | "restrictions": { # A set of restrictions that apply to this shared drive or items inside this shared drive. |
| 153 | "adminManagedRestrictions": True or False, # Whether administrative privileges on this shared drive are required to modify restrictions. |
| 154 | "copyRequiresWriterPermission": True or False, # Whether the options to copy, print, or download files inside this shared drive, should be disabled for readers and commenters. When this restriction is set to true, it will override the similarly named field to true for any file inside this shared drive. |
| 155 | "domainUsersOnly": True or False, # Whether access to this shared drive and items inside this shared drive is restricted to users of the domain to which this shared drive belongs. This restriction may be overridden by other sharing policies controlled outside of this shared drive. |
| 156 | "driveMembersOnly": True or False, # Whether access to items inside this shared drive is restricted to its members. |
| 157 | }, |
| 158 | "themeId": "A String", # The ID of the theme from which the background image and color will be set. The set of possible driveThemes can be retrieved from a drive.about.get response. When not specified on a drive.drives.insert request, a random theme is chosen from which the background image and color are set. This is a write-only field; it can only be set on requests that don't set colorRgb or backgroundImageFile. |
| 159 | }, |
| 160 | "driveId": "A String", # The ID of the shared drive associated with this change. |
| 161 | "file": { # The metadata for a file. # The updated state of the file. Present if the type is file and the file has not been removed from this list of changes. |
| 162 | "alternateLink": "A String", # A link for opening the file in a relevant Google editor or viewer. |
| 163 | "appDataContents": True or False, # Whether this file is in the Application Data folder. |
| 164 | "canComment": True or False, # Deprecated: use capabilities/canComment. |
| 165 | "canReadRevisions": True or False, # Deprecated: use capabilities/canReadRevisions. |
| 166 | "capabilities": { # Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take. |
| 167 | "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. |
| 168 | "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. |
| 169 | "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. |
| 170 | "canChangeCopyRequiresWriterPermission": True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this file. |
| 171 | "canChangeRestrictedDownload": True or False, # Deprecated |
| 172 | "canComment": True or False, # Whether the current user can comment on this file. |
| 173 | "canCopy": True or False, # Whether the current user can copy this file. For an item in a shared drive, whether the current user can copy non-folder descendants of this item, or this item itself if it is not a folder. |
| 174 | "canDelete": True or False, # Whether the current user can delete this file. |
| 175 | "canDeleteChildren": True or False, # Whether the current user can delete children of this folder. This is false when the item is not a folder. Only populated for items in shared drives. |
| 176 | "canDownload": True or False, # Whether the current user can download this file. |
| 177 | "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. |
| 178 | "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. |
| 179 | "canModifyContent": True or False, # Whether the current user can modify the content of this file. |
| 180 | "canModifyContentRestriction": True or False, # Whether the current user can modify restrictions on content of this file. |
| 181 | "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. |
| 182 | "canMoveChildrenOutOfTeamDrive": True or False, # Deprecated - use canMoveChildrenOutOfDrive instead. |
| 183 | "canMoveChildrenWithinDrive": True or False, # Whether the current user can move children of this folder within this drive. This is false when the item is not a folder. Note that a request to move the child may still fail depending on the current user's access to the child and to the destination folder. |
| 184 | "canMoveChildrenWithinTeamDrive": True or False, # Deprecated - use canMoveChildrenWithinDrive instead. |
| 185 | "canMoveItemIntoTeamDrive": True or False, # Deprecated - use canMoveItemOutOfDrive instead. |
| 186 | "canMoveItemOutOfDrive": True or False, # Whether the current user can move this item outside of this drive by changing its parent. Note that a request to change the parent of the item may still fail depending on the new parent that is being added. |
| 187 | "canMoveItemOutOfTeamDrive": True or False, # Deprecated - use canMoveItemOutOfDrive instead. |
| 188 | "canMoveItemWithinDrive": True or False, # Whether the current user can move this item within this drive. Note that a request to change the parent of the item may still fail depending on the new parent that is being added and the parent that is being removed. |
| 189 | "canMoveItemWithinTeamDrive": True or False, # Deprecated - use canMoveItemWithinDrive instead. |
| 190 | "canMoveTeamDriveItem": True or False, # Deprecated - use canMoveItemWithinDrive or canMoveItemOutOfDrive instead. |
| 191 | "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. |
| 192 | "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. |
| 193 | "canReadTeamDrive": True or False, # Deprecated - use canReadDrive instead. |
| 194 | "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. |
| 195 | "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. |
| 196 | "canRename": True or False, # Whether the current user can rename this file. |
| 197 | "canShare": True or False, # Whether the current user can modify the sharing settings for this file. |
| 198 | "canTrash": True or False, # Whether the current user can move this file to trash. |
| 199 | "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. |
| 200 | "canUntrash": True or False, # Whether the current user can restore this file from trash. |
| 201 | }, |
| 202 | "contentRestrictions": [ # Restrictions for accessing the content of the file. Only populated if such a restriction exists. |
| 203 | { # A restriction for accessing the content of the file. |
| 204 | "readOnly": True or False, # Whether the content of the file is read-only. If a file is read-only, a new revision of the file may not be added, comments may not be added or modified, and the title of the file may not be modified. |
| 205 | "reason": "A String", # Reason for why the content of the file is restricted. This is only mutable on requests that also set readOnly=true. |
| 206 | "restrictingUser": { # Information about a Drive user. # The user who set the content restriction. Only populated if readOnly is true. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 207 | "displayName": "A String", # A plain text displayable name for this user. |
| 208 | "emailAddress": "A String", # The email address of the user. |
| 209 | "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. |
| 210 | "kind": "drive#user", # This is always drive#user. |
| 211 | "permissionId": "A String", # The user's ID as visible in the permissions collection. |
| 212 | "picture": { # The user's profile picture. |
| 213 | "url": "A String", # A URL that points to a profile picture of this user. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 214 | }, |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 215 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 216 | "restrictionDate": "A String", # The time at which the content restriction was set (formatted RFC 3339 timestamp). Only populated if readOnly is true. |
| 217 | "type": "A String", # The type of the content restriction. Currently the only possible value is globalContentRestriction. |
| 218 | }, |
| 219 | ], |
| 220 | "copyRequiresWriterPermission": True or False, # Whether the options to copy, print, or download this file, should be disabled for readers and commenters. |
| 221 | "copyable": True or False, # Deprecated: use capabilities/canCopy. |
| 222 | "createdDate": "A String", # Create time for this file (formatted RFC 3339 timestamp). |
| 223 | "defaultOpenWithLink": "A String", # A link to open this file with the user's default app for this file. Only populated when the drive.apps.readonly scope is used. |
| 224 | "description": "A String", # A short description of the file. |
| 225 | "downloadUrl": "A String", # Short lived download URL for the file. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files. |
| 226 | "driveId": "A String", # ID of the shared drive the file resides in. Only populated for items in shared drives. |
| 227 | "editable": True or False, # Deprecated: use capabilities/canEdit. |
| 228 | "embedLink": "A String", # A link for embedding the file. |
| 229 | "etag": "A String", # ETag of the file. |
| 230 | "explicitlyTrashed": True or False, # Whether this file has been explicitly trashed, as opposed to recursively trashed. |
| 231 | "exportLinks": { # Links for exporting Docs Editors files to specific formats. |
| 232 | "a_key": "A String", # A mapping from export format to URL |
| 233 | }, |
| 234 | "fileExtension": "A String", # The final component of fullFileExtension with trailing text that does not appear to be part of the extension removed. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files. |
| 235 | "fileSize": "A String", # The size of the file in bytes. This field is populated for files with content stored in Google Drive and for files in Docs Editors; it is not populated for shortcut files. |
| 236 | "folderColorRgb": "A String", # Folder color as an RGB hex string if the file is a folder. The list of supported colors is available in the folderColorPalette field of the About resource. If an unsupported color is specified, it will be changed to the closest color in the palette. Not populated for items in shared drives. |
| 237 | "fullFileExtension": "A String", # The full file extension; extracted from the title. May contain multiple concatenated extensions, such as "tar.gz". Removing an extension from the title does not clear this field; however, changing the extension on the title does update this field. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files. |
| 238 | "hasAugmentedPermissions": True or False, # Whether there are permissions directly on this file. This field is only populated for items in shared drives. |
| 239 | "hasThumbnail": True or False, # Whether this file has a thumbnail. This does not indicate whether the requesting app has access to the thumbnail. To check access, look for the presence of the thumbnailLink field. |
| 240 | "headRevisionId": "A String", # The ID of the file's head revision. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files. |
| 241 | "iconLink": "A String", # A link to the file's icon. |
| 242 | "id": "A String", # The ID of the file. |
| 243 | "imageMediaMetadata": { # Metadata about image media. This will only be present for image types, and its contents will depend on what can be parsed from the image content. |
| 244 | "aperture": 3.14, # The aperture used to create the photo (f-number). |
| 245 | "cameraMake": "A String", # The make of the camera used to create the photo. |
| 246 | "cameraModel": "A String", # The model of the camera used to create the photo. |
| 247 | "colorSpace": "A String", # The color space of the photo. |
| 248 | "date": "A String", # The date and time the photo was taken (EXIF format timestamp). |
| 249 | "exposureBias": 3.14, # The exposure bias of the photo (APEX value). |
| 250 | "exposureMode": "A String", # The exposure mode used to create the photo. |
| 251 | "exposureTime": 3.14, # The length of the exposure, in seconds. |
| 252 | "flashUsed": True or False, # Whether a flash was used to create the photo. |
| 253 | "focalLength": 3.14, # The focal length used to create the photo, in millimeters. |
| 254 | "height": 42, # The height of the image in pixels. |
| 255 | "isoSpeed": 42, # The ISO speed used to create the photo. |
| 256 | "lens": "A String", # The lens used to create the photo. |
| 257 | "location": { # Geographic location information stored in the image. |
| 258 | "altitude": 3.14, # The altitude stored in the image. |
| 259 | "latitude": 3.14, # The latitude stored in the image. |
| 260 | "longitude": 3.14, # The longitude stored in the image. |
| 261 | }, |
| 262 | "maxApertureValue": 3.14, # The smallest f-number of the lens at the focal length used to create the photo (APEX value). |
| 263 | "meteringMode": "A String", # The metering mode used to create the photo. |
| 264 | "rotation": 42, # The number of clockwise 90 degree rotations applied from the image's original orientation. |
| 265 | "sensor": "A String", # The type of sensor used to create the photo. |
| 266 | "subjectDistance": 42, # The distance to the subject of the photo, in meters. |
| 267 | "whiteBalance": "A String", # The white balance mode used to create the photo. |
| 268 | "width": 42, # The width of the image in pixels. |
| 269 | }, |
| 270 | "indexableText": { # Indexable text attributes for the file (can only be written) |
| 271 | "text": "A String", # The text to be indexed for this file. |
| 272 | }, |
| 273 | "isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app. |
| 274 | "kind": "drive#file", # The type of file. This is always drive#file. |
| 275 | "labels": { # A group of labels for the file. |
| 276 | "hidden": True or False, # Deprecated. |
| 277 | "modified": True or False, # Whether the file has been modified by this user. |
| 278 | "restricted": True or False, # Deprecated - use copyRequiresWriterPermission instead. |
| 279 | "starred": True or False, # Whether this file is starred by the user. |
| 280 | "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. |
| 281 | "viewed": True or False, # Whether this file has been viewed by this user. |
| 282 | }, |
| 283 | "lastModifyingUser": { # Information about a Drive user. # The last user to modify this file. |
| 284 | "displayName": "A String", # A plain text displayable name for this user. |
| 285 | "emailAddress": "A String", # The email address of the user. |
| 286 | "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. |
| 287 | "kind": "drive#user", # This is always drive#user. |
| 288 | "permissionId": "A String", # The user's ID as visible in the permissions collection. |
| 289 | "picture": { # The user's profile picture. |
| 290 | "url": "A String", # A URL that points to a profile picture of this user. |
| 291 | }, |
| 292 | }, |
| 293 | "lastModifyingUserName": "A String", # Name of the last user to modify this file. |
| 294 | "lastViewedByMeDate": "A String", # Last time this file was viewed by the user (formatted RFC 3339 timestamp). |
| 295 | "markedViewedByMeDate": "A String", # Deprecated. |
| 296 | "md5Checksum": "A String", # An MD5 checksum for the content of this file. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files. |
| 297 | "mimeType": "A String", # The MIME type of the file. This is only mutable on update when uploading new content. This field can be left blank, and the mimetype will be determined from the uploaded content's MIME type. |
| 298 | "modifiedByMeDate": "A String", # Last time this file was modified by the user (formatted RFC 3339 timestamp). Note that setting modifiedDate will also update the modifiedByMe date for the user which set the date. |
| 299 | "modifiedDate": "A String", # Last time this file was modified by anyone (formatted RFC 3339 timestamp). This is only mutable on update when the setModifiedDate parameter is set. |
| 300 | "openWithLinks": { # A map of the id of each of the user's apps to a link to open this file with that app. Only populated when the drive.apps.readonly scope is used. |
| 301 | "a_key": "A String", |
| 302 | }, |
| 303 | "originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the title field. This is only available for files with binary content in Google Drive. |
| 304 | "ownedByMe": True or False, # Whether the file is owned by the current user. Not populated for items in shared drives. |
| 305 | "ownerNames": [ # Name(s) of the owner(s) of this file. Not populated for items in shared drives. |
| 306 | "A String", |
| 307 | ], |
| 308 | "owners": [ # The owner(s) of this file. Not populated for items in shared drives. |
| 309 | { # Information about a Drive user. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 310 | "displayName": "A String", # A plain text displayable name for this user. |
| 311 | "emailAddress": "A String", # The email address of the user. |
| 312 | "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. |
| 313 | "kind": "drive#user", # This is always drive#user. |
| 314 | "permissionId": "A String", # The user's ID as visible in the permissions collection. |
| 315 | "picture": { # The user's profile picture. |
| 316 | "url": "A String", # A URL that points to a profile picture of this user. |
| 317 | }, |
| Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 318 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 319 | ], |
| 320 | "parents": [ # Collection of parent folders which contain this file. |
| 321 | # If not specified as part of an insert request, the file will be placed directly in the user's My Drive folder. If not specified as part of a copy request, the file will inherit any discoverable parents of the source file. Update requests can also use the addParents and removeParents parameters to modify the parents list. |
| 322 | { # A reference to a file's parent. |
| 323 | "id": "A String", # The ID of the parent. |
| 324 | "isRoot": True or False, # Whether or not the parent is the root folder. |
| 325 | "kind": "drive#parentReference", # This is always drive#parentReference. |
| 326 | "parentLink": "A String", # A link to the parent. |
| 327 | "selfLink": "A String", # A link back to this reference. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 328 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 329 | ], |
| 330 | "permissionIds": [ # List of permission IDs for users with access to this file. |
| 331 | "A String", |
| 332 | ], |
| 333 | "permissions": [ # The list of permissions for users with access to this file. Not populated for items in shared drives. |
| 334 | { # A permission for a file. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 335 | "additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future. |
| 336 | "A String", |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 337 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 338 | "authKey": "A String", # Deprecated. |
| 339 | "deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions. |
| 340 | "domain": "A String", # The domain name of the entity this permission refers to. This is an output-only field which is present when the permission type is user, group or domain. |
| 341 | "emailAddress": "A String", # The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is user or group. |
| 342 | "etag": "A String", # The ETag of the permission. |
| 343 | "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 344 | # - They cannot be set on shared drive items |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 345 | # - They can only be set on user and group permissions |
| 346 | # - The date must be in the future |
| 347 | # - The date cannot be more than a year in the future |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 348 | # - The date can only be set on drive.permissions.update or drive.permissions.patch requests |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 349 | "id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type is anyone, in which case both id and value are ignored. |
| 350 | "kind": "drive#permission", # This is always drive#permission. |
| 351 | "name": "A String", # The name for this permission. |
| 352 | "permissionDetails": [ # Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. |
| 353 | { |
| 354 | "additionalRoles": [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future. |
| 355 | "A String", |
| 356 | ], |
| 357 | "inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field. |
| 358 | "inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field. |
| 359 | "permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible: |
| 360 | # - file |
| 361 | # - member |
| 362 | "role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible: |
| 363 | # - organizer |
| 364 | # - fileOrganizer |
| 365 | # - writer |
| 366 | # - reader |
| 367 | }, |
| 368 | ], |
| 369 | "photoLink": "A String", # A link to the profile photo, if available. |
| 370 | "role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 371 | # - owner |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 372 | # - organizer |
| 373 | # - fileOrganizer |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 374 | # - writer |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 375 | # - reader |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 376 | "selfLink": "A String", # A link back to this permission. |
| 377 | "teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead. |
| 378 | { |
| 379 | "additionalRoles": [ # Deprecated - use permissionDetails/additionalRoles instead. |
| 380 | "A String", |
| 381 | ], |
| 382 | "inherited": True or False, # Deprecated - use permissionDetails/inherited instead. |
| 383 | "inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead. |
| 384 | "role": "A String", # Deprecated - use permissionDetails/role instead. |
| 385 | "teamDrivePermissionType": "A String", # Deprecated - use permissionDetails/permissionType instead. |
| 386 | }, |
| 387 | ], |
| 388 | "type": "A String", # The account type. Allowed values are: |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 389 | # - user |
| 390 | # - group |
| 391 | # - domain |
| 392 | # - anyone |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 393 | "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type is anyone, in which case both id and value are ignored. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 394 | "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. published is the only supported value. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 395 | "withLink": True or False, # Whether the link is required for this permission. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 396 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 397 | ], |
| 398 | "properties": [ # The list of properties. |
| 399 | { # A key-value pair attached to a file that is either public or private to an application. |
| 400 | # The following limits apply to file properties: |
| 401 | # - Maximum of 100 properties total per file |
| 402 | # - Maximum of 30 private properties per app |
| 403 | # - Maximum of 30 public properties |
| 404 | # - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property. |
| 405 | "etag": "A String", # ETag of the property. |
| 406 | "key": "A String", # The key of this property. |
| 407 | "kind": "drive#property", # This is always drive#property. |
| 408 | "selfLink": "A String", # The link back to this property. |
| 409 | "value": "A String", # The value of this property. |
| 410 | "visibility": "A String", # The visibility of this property. Allowed values are PRIVATE and PUBLIC. (Default: PRIVATE) |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 411 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 412 | ], |
| 413 | "quotaBytesUsed": "A String", # The number of quota bytes used by this file. |
| 414 | "selfLink": "A String", # A link back to this file. |
| 415 | "shareable": True or False, # Deprecated: use capabilities/canShare. |
| 416 | "shared": True or False, # Whether the file has been shared. Not populated for items in shared drives. |
| 417 | "sharedWithMeDate": "A String", # Time at which this file was shared with the user (formatted RFC 3339 timestamp). |
| 418 | "sharingUser": { # Information about a Drive user. # User that shared the item with the current user, if available. |
| 419 | "displayName": "A String", # A plain text displayable name for this user. |
| 420 | "emailAddress": "A String", # The email address of the user. |
| 421 | "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. |
| 422 | "kind": "drive#user", # This is always drive#user. |
| 423 | "permissionId": "A String", # The user's ID as visible in the permissions collection. |
| 424 | "picture": { # The user's profile picture. |
| 425 | "url": "A String", # A URL that points to a profile picture of this user. |
| 426 | }, |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 427 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 428 | "shortcutDetails": { # Shortcut file details. Only populated for shortcut files, which have the mimeType field set to application/vnd.google-apps.shortcut. |
| 429 | "targetId": "A String", # The ID of the file that this shortcut points to. |
| 430 | "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. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 431 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 432 | "spaces": [ # The list of spaces which contain the file. Supported values are 'drive', 'appDataFolder' and 'photos'. |
| 433 | "A String", |
| 434 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 435 | "teamDriveId": "A String", # Deprecated - use driveId instead. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 436 | "thumbnail": { # A thumbnail for the file. This will only be used if a standard thumbnail cannot be generated. |
| 437 | "image": "A String", # The URL-safe Base64 encoded bytes of the thumbnail image. It should conform to RFC 4648 section 5. |
| 438 | "mimeType": "A String", # The MIME type of the thumbnail. |
| 439 | }, |
| 440 | "thumbnailLink": "A String", # A short-lived link to the file's thumbnail. Typically lasts on the order of hours. Only populated when the requesting app can access the file's content. If the file isn't shared publicly, the URL returned in Files.thumbnailLink must be fetched using a credentialed request. |
| 441 | "thumbnailVersion": "A String", # The thumbnail version for use in thumbnail cache invalidation. |
| 442 | "title": "A String", # The title of this file. Note that for immutable items such as the top level folders of shared drives, My Drive root folder, and Application Data folder the title is constant. |
| 443 | "trashedDate": "A String", # The time that the item was trashed (formatted RFC 3339 timestamp). Only populated for items in shared drives. |
| 444 | "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. |
| 445 | "displayName": "A String", # A plain text displayable name for this user. |
| 446 | "emailAddress": "A String", # The email address of the user. |
| 447 | "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. |
| 448 | "kind": "drive#user", # This is always drive#user. |
| 449 | "permissionId": "A String", # The user's ID as visible in the permissions collection. |
| 450 | "picture": { # The user's profile picture. |
| 451 | "url": "A String", # A URL that points to a profile picture of this user. |
| 452 | }, |
| 453 | }, |
| 454 | "userPermission": { # A permission for a file. # The permissions for the authenticated user on this file. |
| 455 | "additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future. |
| 456 | "A String", |
| 457 | ], |
| 458 | "authKey": "A String", # Deprecated. |
| 459 | "deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions. |
| 460 | "domain": "A String", # The domain name of the entity this permission refers to. This is an output-only field which is present when the permission type is user, group or domain. |
| 461 | "emailAddress": "A String", # The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is user or group. |
| 462 | "etag": "A String", # The ETag of the permission. |
| 463 | "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: |
| 464 | # - They cannot be set on shared drive items |
| 465 | # - They can only be set on user and group permissions |
| 466 | # - The date must be in the future |
| 467 | # - The date cannot be more than a year in the future |
| 468 | # - The date can only be set on drive.permissions.update or drive.permissions.patch requests |
| 469 | "id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type is anyone, in which case both id and value are ignored. |
| 470 | "kind": "drive#permission", # This is always drive#permission. |
| 471 | "name": "A String", # The name for this permission. |
| 472 | "permissionDetails": [ # Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. |
| 473 | { |
| 474 | "additionalRoles": [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future. |
| 475 | "A String", |
| 476 | ], |
| 477 | "inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field. |
| 478 | "inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field. |
| 479 | "permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible: |
| 480 | # - file |
| 481 | # - member |
| 482 | "role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible: |
| 483 | # - organizer |
| 484 | # - fileOrganizer |
| 485 | # - writer |
| 486 | # - reader |
| 487 | }, |
| 488 | ], |
| 489 | "photoLink": "A String", # A link to the profile photo, if available. |
| 490 | "role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: |
| 491 | # - owner |
| 492 | # - organizer |
| 493 | # - fileOrganizer |
| 494 | # - writer |
| 495 | # - reader |
| 496 | "selfLink": "A String", # A link back to this permission. |
| 497 | "teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead. |
| 498 | { |
| 499 | "additionalRoles": [ # Deprecated - use permissionDetails/additionalRoles instead. |
| 500 | "A String", |
| 501 | ], |
| 502 | "inherited": True or False, # Deprecated - use permissionDetails/inherited instead. |
| 503 | "inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead. |
| 504 | "role": "A String", # Deprecated - use permissionDetails/role instead. |
| 505 | "teamDrivePermissionType": "A String", # Deprecated - use permissionDetails/permissionType instead. |
| 506 | }, |
| 507 | ], |
| 508 | "type": "A String", # The account type. Allowed values are: |
| 509 | # - user |
| 510 | # - group |
| 511 | # - domain |
| 512 | # - anyone |
| 513 | "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type is anyone, in which case both id and value are ignored. |
| 514 | "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. published is the only supported value. |
| 515 | "withLink": True or False, # Whether the link is required for this permission. |
| 516 | }, |
| 517 | "version": "A String", # A monotonically increasing version number for the file. This reflects every change made to the file on the server, even those not visible to the requesting user. |
| 518 | "videoMediaMetadata": { # Metadata about video media. This will only be present for video types. |
| 519 | "durationMillis": "A String", # The duration of the video in milliseconds. |
| 520 | "height": 42, # The height of the video in pixels. |
| 521 | "width": 42, # The width of the video in pixels. |
| 522 | }, |
| 523 | "webContentLink": "A String", # A link for downloading the content of the file in a browser using cookie based authentication. In cases where the content is shared publicly, the content can be downloaded without any credentials. |
| 524 | "webViewLink": "A String", # A link only available on public folders for viewing their static web assets (HTML, CSS, JS, etc) via Google Drive's Website Hosting. |
| 525 | "writersCanShare": True or False, # Whether writers can share the document with other users. Not populated for items in shared drives. |
| 526 | }, |
| 527 | "fileId": "A String", # The ID of the file associated with this change. |
| 528 | "id": "A String", # The ID of the change. |
| 529 | "kind": "drive#change", # This is always drive#change. |
| 530 | "modificationDate": "A String", # The time of this modification. |
| 531 | "selfLink": "A String", # A link back to this change. |
| 532 | "teamDrive": { # Deprecated: use the drive collection instead. # Deprecated - use drive instead. |
| 533 | "backgroundImageFile": { # An image file and cropping parameters from which a background image for this Team Drive is set. This is a write only field; it can only be set on drive.teamdrives.update requests that don't set themeId. When specified, all fields of the backgroundImageFile must be set. |
| 534 | "id": "A String", # The ID of an image file in Drive to use for the background image. |
| 535 | "width": 3.14, # The width of the cropped image in the closed range of 0 to 1. This value represents the width of the cropped image divided by the width of the entire image. The height is computed by applying a width to height aspect ratio of 80 to 9. The resulting image must be at least 1280 pixels wide and 144 pixels high. |
| 536 | "xCoordinate": 3.14, # The X coordinate of the upper left corner of the cropping area in the background image. This is a value in the closed range of 0 to 1. This value represents the horizontal distance from the left side of the entire image to the left side of the cropping area divided by the width of the entire image. |
| 537 | "yCoordinate": 3.14, # The Y coordinate of the upper left corner of the cropping area in the background image. This is a value in the closed range of 0 to 1. This value represents the vertical distance from the top side of the entire image to the top side of the cropping area divided by the height of the entire image. |
| 538 | }, |
| 539 | "backgroundImageLink": "A String", # A short-lived link to this Team Drive's background image. |
| 540 | "capabilities": { # Capabilities the current user has on this Team Drive. |
| 541 | "canAddChildren": True or False, # Whether the current user can add children to folders in this Team Drive. |
| 542 | "canChangeCopyRequiresWriterPermissionRestriction": True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this Team Drive. |
| 543 | "canChangeDomainUsersOnlyRestriction": True or False, # Whether the current user can change the domainUsersOnly restriction of this Team Drive. |
| 544 | "canChangeTeamDriveBackground": True or False, # Whether the current user can change the background of this Team Drive. |
| 545 | "canChangeTeamMembersOnlyRestriction": True or False, # Whether the current user can change the teamMembersOnly restriction of this Team Drive. |
| 546 | "canComment": True or False, # Whether the current user can comment on files in this Team Drive. |
| 547 | "canCopy": True or False, # Whether the current user can copy files in this Team Drive. |
| 548 | "canDeleteChildren": True or False, # Whether the current user can delete children from folders in this Team Drive. |
| 549 | "canDeleteTeamDrive": True or False, # Whether the current user can delete this Team Drive. Attempting to delete the Team Drive may still fail if there are untrashed items inside the Team Drive. |
| 550 | "canDownload": True or False, # Whether the current user can download files in this Team Drive. |
| 551 | "canEdit": True or False, # Whether the current user can edit files in this Team Drive |
| 552 | "canListChildren": True or False, # Whether the current user can list the children of folders in this Team Drive. |
| 553 | "canManageMembers": True or False, # Whether the current user can add members to this Team Drive or remove them or change their role. |
| 554 | "canReadRevisions": True or False, # Whether the current user can read the revisions resource of files in this Team Drive. |
| 555 | "canRemoveChildren": True or False, # Deprecated - use canDeleteChildren or canTrashChildren instead. |
| 556 | "canRename": True or False, # Whether the current user can rename files or folders in this Team Drive. |
| 557 | "canRenameTeamDrive": True or False, # Whether the current user can rename this Team Drive. |
| 558 | "canShare": True or False, # Whether the current user can share files or folders in this Team Drive. |
| 559 | "canTrashChildren": True or False, # Whether the current user can trash children from folders in this Team Drive. |
| 560 | }, |
| 561 | "colorRgb": "A String", # The color of this Team Drive as an RGB hex string. It can only be set on a drive.teamdrives.update request that does not set themeId. |
| 562 | "createdDate": "A String", # The time at which the Team Drive was created (RFC 3339 date-time). |
| 563 | "id": "A String", # The ID of this Team Drive which is also the ID of the top level folder of this Team Drive. |
| 564 | "kind": "drive#teamDrive", # This is always drive#teamDrive |
| 565 | "name": "A String", # The name of this Team Drive. |
| 566 | "restrictions": { # A set of restrictions that apply to this Team Drive or items inside this Team Drive. |
| 567 | "adminManagedRestrictions": True or False, # Whether administrative privileges on this Team Drive are required to modify restrictions. |
| 568 | "copyRequiresWriterPermission": True or False, # Whether the options to copy, print, or download files inside this Team Drive, should be disabled for readers and commenters. When this restriction is set to true, it will override the similarly named field to true for any file inside this Team Drive. |
| 569 | "domainUsersOnly": True or False, # Whether access to this Team Drive and items inside this Team Drive is restricted to users of the domain to which this Team Drive belongs. This restriction may be overridden by other sharing policies controlled outside of this Team Drive. |
| 570 | "teamMembersOnly": True or False, # Whether access to items inside this Team Drive is restricted to members of this Team Drive. |
| 571 | }, |
| 572 | "themeId": "A String", # The ID of the theme from which the background image and color will be set. The set of possible teamDriveThemes can be retrieved from a drive.about.get response. When not specified on a drive.teamdrives.insert request, a random theme is chosen from which the background image and color are set. This is a write-only field; it can only be set on requests that don't set colorRgb or backgroundImageFile. |
| 573 | }, |
| 574 | "teamDriveId": "A String", # Deprecated - use driveId instead. |
| 575 | "type": "A String", # Deprecated - use changeType instead. |
| 576 | }</pre> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 577 | </div> |
| 578 | |
| 579 | <div class="method"> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 580 | <code class="details" id="getStartPageToken">getStartPageToken(driveId=None, supportsAllDrives=None, supportsTeamDrives=None, teamDriveId=None)</code> |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 581 | <pre>Gets the starting pageToken for listing future changes. |
| 582 | |
| 583 | Args: |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 584 | driveId: string, The ID of the shared drive for which the starting pageToken for listing future changes from that shared drive is returned. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 585 | supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 586 | supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 587 | teamDriveId: string, Deprecated use driveId instead. |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 588 | |
| 589 | Returns: |
| 590 | An object of the form: |
| 591 | |
| 592 | { |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 593 | "kind": "drive#startPageToken", # Identifies what kind of resource this is. Value: the fixed string "drive#startPageToken". |
| 594 | "startPageToken": "A String", # The starting page token for listing changes. |
| 595 | }</pre> |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 596 | </div> |
| 597 | |
| 598 | <div class="method"> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 599 | <code class="details" id="list">list(driveId=None, includeCorpusRemovals=None, includeDeleted=None, includeItemsFromAllDrives=None, includePermissionsForView=None, includeSubscribed=None, includeTeamDriveItems=None, maxResults=None, pageToken=None, spaces=None, startChangeId=None, supportsAllDrives=None, supportsTeamDrives=None, teamDriveId=None)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 600 | <pre>Lists the changes for a user or shared drive. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 601 | |
| 602 | Args: |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 603 | driveId: string, The shared drive from which changes are returned. If specified the change IDs will be reflective of the shared drive; use the combined drive ID and change ID as an identifier. |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 604 | includeCorpusRemovals: boolean, Whether changes should include the file resource if the file is still accessible by the user at the time of the request, even when a file was removed from the list of changes and there will be no further change entries for this file. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 605 | includeDeleted: boolean, Whether to include changes indicating that items have been removed from the list of changes, for example by deletion or loss of access. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 606 | includeItemsFromAllDrives: boolean, Whether both My Drive and shared drive items should be included in results. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 607 | includePermissionsForView: string, Specifies which additional view's permissions to include in the response. Only 'published' is supported. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 608 | includeSubscribed: boolean, Whether to include changes outside the My Drive hierarchy in the result. When set to false, changes to files such as those in the Application Data folder or shared files which have not been added to My Drive are omitted from the result. |
| 609 | includeTeamDriveItems: boolean, Deprecated use includeItemsFromAllDrives instead. |
| 610 | maxResults: integer, Maximum number of changes to return. |
| 611 | 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 or to the response from the getStartPageToken method. |
| 612 | spaces: string, A comma-separated list of spaces to query. Supported values are 'drive', 'appDataFolder' and 'photos'. |
| 613 | startChangeId: string, Deprecated - use pageToken instead. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 614 | supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 615 | supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead. |
| 616 | teamDriveId: string, Deprecated use driveId instead. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 617 | |
| 618 | Returns: |
| 619 | An object of the form: |
| 620 | |
| 621 | { # A list of changes for a user. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 622 | "etag": "A String", # The ETag of the list. |
| 623 | "items": [ # The list of changes. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched. |
| 624 | { # Representation of a change to a file or shared drive. |
| 625 | "changeType": "A String", # The type of the change. Possible values are file and drive. |
| 626 | "deleted": True or False, # Whether the file or shared drive has been removed from this list of changes, for example by deletion or loss of access. |
| 627 | "drive": { # Representation of a shared drive. # The updated state of the shared drive. Present if the changeType is drive, the user is still a member of the shared drive, and the shared drive has not been deleted. |
| 628 | "backgroundImageFile": { # An image file and cropping parameters from which a background image for this shared drive is set. This is a write only field; it can only be set on drive.drives.update requests that don't set themeId. When specified, all fields of the backgroundImageFile must be set. |
| 629 | "id": "A String", # The ID of an image file in Google Drive to use for the background image. |
| 630 | "width": 3.14, # The width of the cropped image in the closed range of 0 to 1. This value represents the width of the cropped image divided by the width of the entire image. The height is computed by applying a width to height aspect ratio of 80 to 9. The resulting image must be at least 1280 pixels wide and 144 pixels high. |
| 631 | "xCoordinate": 3.14, # The X coordinate of the upper left corner of the cropping area in the background image. This is a value in the closed range of 0 to 1. This value represents the horizontal distance from the left side of the entire image to the left side of the cropping area divided by the width of the entire image. |
| 632 | "yCoordinate": 3.14, # The Y coordinate of the upper left corner of the cropping area in the background image. This is a value in the closed range of 0 to 1. This value represents the vertical distance from the top side of the entire image to the top side of the cropping area divided by the height of the entire image. |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 633 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 634 | "backgroundImageLink": "A String", # A short-lived link to this shared drive's background image. |
| 635 | "capabilities": { # Capabilities the current user has on this shared drive. |
| 636 | "canAddChildren": True or False, # Whether the current user can add children to folders in this shared drive. |
| 637 | "canChangeCopyRequiresWriterPermissionRestriction": True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this shared drive. |
| 638 | "canChangeDomainUsersOnlyRestriction": True or False, # Whether the current user can change the domainUsersOnly restriction of this shared drive. |
| 639 | "canChangeDriveBackground": True or False, # Whether the current user can change the background of this shared drive. |
| 640 | "canChangeDriveMembersOnlyRestriction": True or False, # Whether the current user can change the driveMembersOnly restriction of this shared drive. |
| 641 | "canComment": True or False, # Whether the current user can comment on files in this shared drive. |
| 642 | "canCopy": True or False, # Whether the current user can copy files in this shared drive. |
| 643 | "canDeleteChildren": True or False, # Whether the current user can delete children from folders in this shared drive. |
| 644 | "canDeleteDrive": True or False, # Whether the current user can delete this shared drive. Attempting to delete the shared drive may still fail if there are untrashed items inside the shared drive. |
| 645 | "canDownload": True or False, # Whether the current user can download files in this shared drive. |
| 646 | "canEdit": True or False, # Whether the current user can edit files in this shared drive |
| 647 | "canListChildren": True or False, # Whether the current user can list the children of folders in this shared drive. |
| 648 | "canManageMembers": True or False, # Whether the current user can add members to this shared drive or remove them or change their role. |
| 649 | "canReadRevisions": True or False, # Whether the current user can read the revisions resource of files in this shared drive. |
| 650 | "canRename": True or False, # Whether the current user can rename files or folders in this shared drive. |
| 651 | "canRenameDrive": True or False, # Whether the current user can rename this shared drive. |
| 652 | "canShare": True or False, # Whether the current user can share files or folders in this shared drive. |
| 653 | "canTrashChildren": True or False, # Whether the current user can trash children from folders in this shared drive. |
| 654 | }, |
| 655 | "colorRgb": "A String", # The color of this shared drive as an RGB hex string. It can only be set on a drive.drives.update request that does not set themeId. |
| 656 | "createdDate": "A String", # The time at which the shared drive was created (RFC 3339 date-time). |
| 657 | "hidden": True or False, # Whether the shared drive is hidden from default view. |
| 658 | "id": "A String", # The ID of this shared drive which is also the ID of the top level folder of this shared drive. |
| 659 | "kind": "drive#drive", # This is always drive#drive |
| 660 | "name": "A String", # The name of this shared drive. |
| 661 | "restrictions": { # A set of restrictions that apply to this shared drive or items inside this shared drive. |
| 662 | "adminManagedRestrictions": True or False, # Whether administrative privileges on this shared drive are required to modify restrictions. |
| 663 | "copyRequiresWriterPermission": True or False, # Whether the options to copy, print, or download files inside this shared drive, should be disabled for readers and commenters. When this restriction is set to true, it will override the similarly named field to true for any file inside this shared drive. |
| 664 | "domainUsersOnly": True or False, # Whether access to this shared drive and items inside this shared drive is restricted to users of the domain to which this shared drive belongs. This restriction may be overridden by other sharing policies controlled outside of this shared drive. |
| 665 | "driveMembersOnly": True or False, # Whether access to items inside this shared drive is restricted to its members. |
| 666 | }, |
| 667 | "themeId": "A String", # The ID of the theme from which the background image and color will be set. The set of possible driveThemes can be retrieved from a drive.about.get response. When not specified on a drive.drives.insert request, a random theme is chosen from which the background image and color are set. This is a write-only field; it can only be set on requests that don't set colorRgb or backgroundImageFile. |
| 668 | }, |
| 669 | "driveId": "A String", # The ID of the shared drive associated with this change. |
| 670 | "file": { # The metadata for a file. # The updated state of the file. Present if the type is file and the file has not been removed from this list of changes. |
| 671 | "alternateLink": "A String", # A link for opening the file in a relevant Google editor or viewer. |
| 672 | "appDataContents": True or False, # Whether this file is in the Application Data folder. |
| 673 | "canComment": True or False, # Deprecated: use capabilities/canComment. |
| 674 | "canReadRevisions": True or False, # Deprecated: use capabilities/canReadRevisions. |
| 675 | "capabilities": { # Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take. |
| 676 | "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. |
| 677 | "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. |
| 678 | "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. |
| 679 | "canChangeCopyRequiresWriterPermission": True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this file. |
| 680 | "canChangeRestrictedDownload": True or False, # Deprecated |
| 681 | "canComment": True or False, # Whether the current user can comment on this file. |
| 682 | "canCopy": True or False, # Whether the current user can copy this file. For an item in a shared drive, whether the current user can copy non-folder descendants of this item, or this item itself if it is not a folder. |
| 683 | "canDelete": True or False, # Whether the current user can delete this file. |
| 684 | "canDeleteChildren": True or False, # Whether the current user can delete children of this folder. This is false when the item is not a folder. Only populated for items in shared drives. |
| 685 | "canDownload": True or False, # Whether the current user can download this file. |
| 686 | "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. |
| 687 | "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. |
| 688 | "canModifyContent": True or False, # Whether the current user can modify the content of this file. |
| 689 | "canModifyContentRestriction": True or False, # Whether the current user can modify restrictions on content of this file. |
| 690 | "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. |
| 691 | "canMoveChildrenOutOfTeamDrive": True or False, # Deprecated - use canMoveChildrenOutOfDrive instead. |
| 692 | "canMoveChildrenWithinDrive": True or False, # Whether the current user can move children of this folder within this drive. This is false when the item is not a folder. Note that a request to move the child may still fail depending on the current user's access to the child and to the destination folder. |
| 693 | "canMoveChildrenWithinTeamDrive": True or False, # Deprecated - use canMoveChildrenWithinDrive instead. |
| 694 | "canMoveItemIntoTeamDrive": True or False, # Deprecated - use canMoveItemOutOfDrive instead. |
| 695 | "canMoveItemOutOfDrive": True or False, # Whether the current user can move this item outside of this drive by changing its parent. Note that a request to change the parent of the item may still fail depending on the new parent that is being added. |
| 696 | "canMoveItemOutOfTeamDrive": True or False, # Deprecated - use canMoveItemOutOfDrive instead. |
| 697 | "canMoveItemWithinDrive": True or False, # Whether the current user can move this item within this drive. Note that a request to change the parent of the item may still fail depending on the new parent that is being added and the parent that is being removed. |
| 698 | "canMoveItemWithinTeamDrive": True or False, # Deprecated - use canMoveItemWithinDrive instead. |
| 699 | "canMoveTeamDriveItem": True or False, # Deprecated - use canMoveItemWithinDrive or canMoveItemOutOfDrive instead. |
| 700 | "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. |
| 701 | "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. |
| 702 | "canReadTeamDrive": True or False, # Deprecated - use canReadDrive instead. |
| 703 | "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. |
| 704 | "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. |
| 705 | "canRename": True or False, # Whether the current user can rename this file. |
| 706 | "canShare": True or False, # Whether the current user can modify the sharing settings for this file. |
| 707 | "canTrash": True or False, # Whether the current user can move this file to trash. |
| 708 | "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. |
| 709 | "canUntrash": True or False, # Whether the current user can restore this file from trash. |
| 710 | }, |
| 711 | "contentRestrictions": [ # Restrictions for accessing the content of the file. Only populated if such a restriction exists. |
| 712 | { # A restriction for accessing the content of the file. |
| 713 | "readOnly": True or False, # Whether the content of the file is read-only. If a file is read-only, a new revision of the file may not be added, comments may not be added or modified, and the title of the file may not be modified. |
| 714 | "reason": "A String", # Reason for why the content of the file is restricted. This is only mutable on requests that also set readOnly=true. |
| 715 | "restrictingUser": { # Information about a Drive user. # The user who set the content restriction. Only populated if readOnly is true. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 716 | "displayName": "A String", # A plain text displayable name for this user. |
| 717 | "emailAddress": "A String", # The email address of the user. |
| 718 | "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. |
| 719 | "kind": "drive#user", # This is always drive#user. |
| 720 | "permissionId": "A String", # The user's ID as visible in the permissions collection. |
| 721 | "picture": { # The user's profile picture. |
| 722 | "url": "A String", # A URL that points to a profile picture of this user. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 723 | }, |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 724 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 725 | "restrictionDate": "A String", # The time at which the content restriction was set (formatted RFC 3339 timestamp). Only populated if readOnly is true. |
| 726 | "type": "A String", # The type of the content restriction. Currently the only possible value is globalContentRestriction. |
| 727 | }, |
| 728 | ], |
| 729 | "copyRequiresWriterPermission": True or False, # Whether the options to copy, print, or download this file, should be disabled for readers and commenters. |
| 730 | "copyable": True or False, # Deprecated: use capabilities/canCopy. |
| 731 | "createdDate": "A String", # Create time for this file (formatted RFC 3339 timestamp). |
| 732 | "defaultOpenWithLink": "A String", # A link to open this file with the user's default app for this file. Only populated when the drive.apps.readonly scope is used. |
| 733 | "description": "A String", # A short description of the file. |
| 734 | "downloadUrl": "A String", # Short lived download URL for the file. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files. |
| 735 | "driveId": "A String", # ID of the shared drive the file resides in. Only populated for items in shared drives. |
| 736 | "editable": True or False, # Deprecated: use capabilities/canEdit. |
| 737 | "embedLink": "A String", # A link for embedding the file. |
| 738 | "etag": "A String", # ETag of the file. |
| 739 | "explicitlyTrashed": True or False, # Whether this file has been explicitly trashed, as opposed to recursively trashed. |
| 740 | "exportLinks": { # Links for exporting Docs Editors files to specific formats. |
| 741 | "a_key": "A String", # A mapping from export format to URL |
| 742 | }, |
| 743 | "fileExtension": "A String", # The final component of fullFileExtension with trailing text that does not appear to be part of the extension removed. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files. |
| 744 | "fileSize": "A String", # The size of the file in bytes. This field is populated for files with content stored in Google Drive and for files in Docs Editors; it is not populated for shortcut files. |
| 745 | "folderColorRgb": "A String", # Folder color as an RGB hex string if the file is a folder. The list of supported colors is available in the folderColorPalette field of the About resource. If an unsupported color is specified, it will be changed to the closest color in the palette. Not populated for items in shared drives. |
| 746 | "fullFileExtension": "A String", # The full file extension; extracted from the title. May contain multiple concatenated extensions, such as "tar.gz". Removing an extension from the title does not clear this field; however, changing the extension on the title does update this field. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files. |
| 747 | "hasAugmentedPermissions": True or False, # Whether there are permissions directly on this file. This field is only populated for items in shared drives. |
| 748 | "hasThumbnail": True or False, # Whether this file has a thumbnail. This does not indicate whether the requesting app has access to the thumbnail. To check access, look for the presence of the thumbnailLink field. |
| 749 | "headRevisionId": "A String", # The ID of the file's head revision. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files. |
| 750 | "iconLink": "A String", # A link to the file's icon. |
| 751 | "id": "A String", # The ID of the file. |
| 752 | "imageMediaMetadata": { # Metadata about image media. This will only be present for image types, and its contents will depend on what can be parsed from the image content. |
| 753 | "aperture": 3.14, # The aperture used to create the photo (f-number). |
| 754 | "cameraMake": "A String", # The make of the camera used to create the photo. |
| 755 | "cameraModel": "A String", # The model of the camera used to create the photo. |
| 756 | "colorSpace": "A String", # The color space of the photo. |
| 757 | "date": "A String", # The date and time the photo was taken (EXIF format timestamp). |
| 758 | "exposureBias": 3.14, # The exposure bias of the photo (APEX value). |
| 759 | "exposureMode": "A String", # The exposure mode used to create the photo. |
| 760 | "exposureTime": 3.14, # The length of the exposure, in seconds. |
| 761 | "flashUsed": True or False, # Whether a flash was used to create the photo. |
| 762 | "focalLength": 3.14, # The focal length used to create the photo, in millimeters. |
| 763 | "height": 42, # The height of the image in pixels. |
| 764 | "isoSpeed": 42, # The ISO speed used to create the photo. |
| 765 | "lens": "A String", # The lens used to create the photo. |
| 766 | "location": { # Geographic location information stored in the image. |
| 767 | "altitude": 3.14, # The altitude stored in the image. |
| 768 | "latitude": 3.14, # The latitude stored in the image. |
| 769 | "longitude": 3.14, # The longitude stored in the image. |
| 770 | }, |
| 771 | "maxApertureValue": 3.14, # The smallest f-number of the lens at the focal length used to create the photo (APEX value). |
| 772 | "meteringMode": "A String", # The metering mode used to create the photo. |
| 773 | "rotation": 42, # The number of clockwise 90 degree rotations applied from the image's original orientation. |
| 774 | "sensor": "A String", # The type of sensor used to create the photo. |
| 775 | "subjectDistance": 42, # The distance to the subject of the photo, in meters. |
| 776 | "whiteBalance": "A String", # The white balance mode used to create the photo. |
| 777 | "width": 42, # The width of the image in pixels. |
| 778 | }, |
| 779 | "indexableText": { # Indexable text attributes for the file (can only be written) |
| 780 | "text": "A String", # The text to be indexed for this file. |
| 781 | }, |
| 782 | "isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app. |
| 783 | "kind": "drive#file", # The type of file. This is always drive#file. |
| 784 | "labels": { # A group of labels for the file. |
| 785 | "hidden": True or False, # Deprecated. |
| 786 | "modified": True or False, # Whether the file has been modified by this user. |
| 787 | "restricted": True or False, # Deprecated - use copyRequiresWriterPermission instead. |
| 788 | "starred": True or False, # Whether this file is starred by the user. |
| 789 | "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. |
| 790 | "viewed": True or False, # Whether this file has been viewed by this user. |
| 791 | }, |
| 792 | "lastModifyingUser": { # Information about a Drive user. # The last user to modify this file. |
| 793 | "displayName": "A String", # A plain text displayable name for this user. |
| 794 | "emailAddress": "A String", # The email address of the user. |
| 795 | "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. |
| 796 | "kind": "drive#user", # This is always drive#user. |
| 797 | "permissionId": "A String", # The user's ID as visible in the permissions collection. |
| 798 | "picture": { # The user's profile picture. |
| 799 | "url": "A String", # A URL that points to a profile picture of this user. |
| 800 | }, |
| 801 | }, |
| 802 | "lastModifyingUserName": "A String", # Name of the last user to modify this file. |
| 803 | "lastViewedByMeDate": "A String", # Last time this file was viewed by the user (formatted RFC 3339 timestamp). |
| 804 | "markedViewedByMeDate": "A String", # Deprecated. |
| 805 | "md5Checksum": "A String", # An MD5 checksum for the content of this file. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files. |
| 806 | "mimeType": "A String", # The MIME type of the file. This is only mutable on update when uploading new content. This field can be left blank, and the mimetype will be determined from the uploaded content's MIME type. |
| 807 | "modifiedByMeDate": "A String", # Last time this file was modified by the user (formatted RFC 3339 timestamp). Note that setting modifiedDate will also update the modifiedByMe date for the user which set the date. |
| 808 | "modifiedDate": "A String", # Last time this file was modified by anyone (formatted RFC 3339 timestamp). This is only mutable on update when the setModifiedDate parameter is set. |
| 809 | "openWithLinks": { # A map of the id of each of the user's apps to a link to open this file with that app. Only populated when the drive.apps.readonly scope is used. |
| 810 | "a_key": "A String", |
| 811 | }, |
| 812 | "originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the title field. This is only available for files with binary content in Google Drive. |
| 813 | "ownedByMe": True or False, # Whether the file is owned by the current user. Not populated for items in shared drives. |
| 814 | "ownerNames": [ # Name(s) of the owner(s) of this file. Not populated for items in shared drives. |
| 815 | "A String", |
| 816 | ], |
| 817 | "owners": [ # The owner(s) of this file. Not populated for items in shared drives. |
| 818 | { # Information about a Drive user. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 819 | "displayName": "A String", # A plain text displayable name for this user. |
| 820 | "emailAddress": "A String", # The email address of the user. |
| 821 | "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. |
| 822 | "kind": "drive#user", # This is always drive#user. |
| 823 | "permissionId": "A String", # The user's ID as visible in the permissions collection. |
| 824 | "picture": { # The user's profile picture. |
| 825 | "url": "A String", # A URL that points to a profile picture of this user. |
| 826 | }, |
| Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 827 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 828 | ], |
| 829 | "parents": [ # Collection of parent folders which contain this file. |
| 830 | # If not specified as part of an insert request, the file will be placed directly in the user's My Drive folder. If not specified as part of a copy request, the file will inherit any discoverable parents of the source file. Update requests can also use the addParents and removeParents parameters to modify the parents list. |
| 831 | { # A reference to a file's parent. |
| 832 | "id": "A String", # The ID of the parent. |
| 833 | "isRoot": True or False, # Whether or not the parent is the root folder. |
| 834 | "kind": "drive#parentReference", # This is always drive#parentReference. |
| 835 | "parentLink": "A String", # A link to the parent. |
| 836 | "selfLink": "A String", # A link back to this reference. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 837 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 838 | ], |
| 839 | "permissionIds": [ # List of permission IDs for users with access to this file. |
| 840 | "A String", |
| 841 | ], |
| 842 | "permissions": [ # The list of permissions for users with access to this file. Not populated for items in shared drives. |
| 843 | { # A permission for a file. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 844 | "additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future. |
| 845 | "A String", |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 846 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 847 | "authKey": "A String", # Deprecated. |
| 848 | "deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions. |
| 849 | "domain": "A String", # The domain name of the entity this permission refers to. This is an output-only field which is present when the permission type is user, group or domain. |
| 850 | "emailAddress": "A String", # The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is user or group. |
| 851 | "etag": "A String", # The ETag of the permission. |
| 852 | "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 853 | # - They cannot be set on shared drive items |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 854 | # - They can only be set on user and group permissions |
| 855 | # - The date must be in the future |
| 856 | # - The date cannot be more than a year in the future |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 857 | # - The date can only be set on drive.permissions.update or drive.permissions.patch requests |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 858 | "id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type is anyone, in which case both id and value are ignored. |
| 859 | "kind": "drive#permission", # This is always drive#permission. |
| 860 | "name": "A String", # The name for this permission. |
| 861 | "permissionDetails": [ # Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. |
| 862 | { |
| 863 | "additionalRoles": [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future. |
| 864 | "A String", |
| 865 | ], |
| 866 | "inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field. |
| 867 | "inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field. |
| 868 | "permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible: |
| 869 | # - file |
| 870 | # - member |
| 871 | "role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible: |
| 872 | # - organizer |
| 873 | # - fileOrganizer |
| 874 | # - writer |
| 875 | # - reader |
| 876 | }, |
| 877 | ], |
| 878 | "photoLink": "A String", # A link to the profile photo, if available. |
| 879 | "role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 880 | # - owner |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 881 | # - organizer |
| 882 | # - fileOrganizer |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 883 | # - writer |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 884 | # - reader |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 885 | "selfLink": "A String", # A link back to this permission. |
| 886 | "teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead. |
| 887 | { |
| 888 | "additionalRoles": [ # Deprecated - use permissionDetails/additionalRoles instead. |
| 889 | "A String", |
| 890 | ], |
| 891 | "inherited": True or False, # Deprecated - use permissionDetails/inherited instead. |
| 892 | "inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead. |
| 893 | "role": "A String", # Deprecated - use permissionDetails/role instead. |
| 894 | "teamDrivePermissionType": "A String", # Deprecated - use permissionDetails/permissionType instead. |
| 895 | }, |
| 896 | ], |
| 897 | "type": "A String", # The account type. Allowed values are: |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 898 | # - user |
| 899 | # - group |
| 900 | # - domain |
| 901 | # - anyone |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 902 | "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type is anyone, in which case both id and value are ignored. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 903 | "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. published is the only supported value. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 904 | "withLink": True or False, # Whether the link is required for this permission. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 905 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 906 | ], |
| 907 | "properties": [ # The list of properties. |
| 908 | { # A key-value pair attached to a file that is either public or private to an application. |
| 909 | # The following limits apply to file properties: |
| 910 | # - Maximum of 100 properties total per file |
| 911 | # - Maximum of 30 private properties per app |
| 912 | # - Maximum of 30 public properties |
| 913 | # - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property. |
| 914 | "etag": "A String", # ETag of the property. |
| 915 | "key": "A String", # The key of this property. |
| 916 | "kind": "drive#property", # This is always drive#property. |
| 917 | "selfLink": "A String", # The link back to this property. |
| 918 | "value": "A String", # The value of this property. |
| 919 | "visibility": "A String", # The visibility of this property. Allowed values are PRIVATE and PUBLIC. (Default: PRIVATE) |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 920 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 921 | ], |
| 922 | "quotaBytesUsed": "A String", # The number of quota bytes used by this file. |
| 923 | "selfLink": "A String", # A link back to this file. |
| 924 | "shareable": True or False, # Deprecated: use capabilities/canShare. |
| 925 | "shared": True or False, # Whether the file has been shared. Not populated for items in shared drives. |
| 926 | "sharedWithMeDate": "A String", # Time at which this file was shared with the user (formatted RFC 3339 timestamp). |
| 927 | "sharingUser": { # Information about a Drive user. # User that shared the item with the current user, if available. |
| 928 | "displayName": "A String", # A plain text displayable name for this user. |
| 929 | "emailAddress": "A String", # The email address of the user. |
| 930 | "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. |
| 931 | "kind": "drive#user", # This is always drive#user. |
| 932 | "permissionId": "A String", # The user's ID as visible in the permissions collection. |
| 933 | "picture": { # The user's profile picture. |
| 934 | "url": "A String", # A URL that points to a profile picture of this user. |
| 935 | }, |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 936 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 937 | "shortcutDetails": { # Shortcut file details. Only populated for shortcut files, which have the mimeType field set to application/vnd.google-apps.shortcut. |
| 938 | "targetId": "A String", # The ID of the file that this shortcut points to. |
| 939 | "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. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 940 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 941 | "spaces": [ # The list of spaces which contain the file. Supported values are 'drive', 'appDataFolder' and 'photos'. |
| 942 | "A String", |
| 943 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 944 | "teamDriveId": "A String", # Deprecated - use driveId instead. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 945 | "thumbnail": { # A thumbnail for the file. This will only be used if a standard thumbnail cannot be generated. |
| 946 | "image": "A String", # The URL-safe Base64 encoded bytes of the thumbnail image. It should conform to RFC 4648 section 5. |
| 947 | "mimeType": "A String", # The MIME type of the thumbnail. |
| 948 | }, |
| 949 | "thumbnailLink": "A String", # A short-lived link to the file's thumbnail. Typically lasts on the order of hours. Only populated when the requesting app can access the file's content. If the file isn't shared publicly, the URL returned in Files.thumbnailLink must be fetched using a credentialed request. |
| 950 | "thumbnailVersion": "A String", # The thumbnail version for use in thumbnail cache invalidation. |
| 951 | "title": "A String", # The title of this file. Note that for immutable items such as the top level folders of shared drives, My Drive root folder, and Application Data folder the title is constant. |
| 952 | "trashedDate": "A String", # The time that the item was trashed (formatted RFC 3339 timestamp). Only populated for items in shared drives. |
| 953 | "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. |
| 954 | "displayName": "A String", # A plain text displayable name for this user. |
| 955 | "emailAddress": "A String", # The email address of the user. |
| 956 | "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. |
| 957 | "kind": "drive#user", # This is always drive#user. |
| 958 | "permissionId": "A String", # The user's ID as visible in the permissions collection. |
| 959 | "picture": { # The user's profile picture. |
| 960 | "url": "A String", # A URL that points to a profile picture of this user. |
| 961 | }, |
| 962 | }, |
| 963 | "userPermission": { # A permission for a file. # The permissions for the authenticated user on this file. |
| 964 | "additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future. |
| 965 | "A String", |
| 966 | ], |
| 967 | "authKey": "A String", # Deprecated. |
| 968 | "deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions. |
| 969 | "domain": "A String", # The domain name of the entity this permission refers to. This is an output-only field which is present when the permission type is user, group or domain. |
| 970 | "emailAddress": "A String", # The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is user or group. |
| 971 | "etag": "A String", # The ETag of the permission. |
| 972 | "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: |
| 973 | # - They cannot be set on shared drive items |
| 974 | # - They can only be set on user and group permissions |
| 975 | # - The date must be in the future |
| 976 | # - The date cannot be more than a year in the future |
| 977 | # - The date can only be set on drive.permissions.update or drive.permissions.patch requests |
| 978 | "id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type is anyone, in which case both id and value are ignored. |
| 979 | "kind": "drive#permission", # This is always drive#permission. |
| 980 | "name": "A String", # The name for this permission. |
| 981 | "permissionDetails": [ # Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. |
| 982 | { |
| 983 | "additionalRoles": [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future. |
| 984 | "A String", |
| 985 | ], |
| 986 | "inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field. |
| 987 | "inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field. |
| 988 | "permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible: |
| 989 | # - file |
| 990 | # - member |
| 991 | "role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible: |
| 992 | # - organizer |
| 993 | # - fileOrganizer |
| 994 | # - writer |
| 995 | # - reader |
| 996 | }, |
| 997 | ], |
| 998 | "photoLink": "A String", # A link to the profile photo, if available. |
| 999 | "role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: |
| 1000 | # - owner |
| 1001 | # - organizer |
| 1002 | # - fileOrganizer |
| 1003 | # - writer |
| 1004 | # - reader |
| 1005 | "selfLink": "A String", # A link back to this permission. |
| 1006 | "teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead. |
| 1007 | { |
| 1008 | "additionalRoles": [ # Deprecated - use permissionDetails/additionalRoles instead. |
| 1009 | "A String", |
| 1010 | ], |
| 1011 | "inherited": True or False, # Deprecated - use permissionDetails/inherited instead. |
| 1012 | "inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead. |
| 1013 | "role": "A String", # Deprecated - use permissionDetails/role instead. |
| 1014 | "teamDrivePermissionType": "A String", # Deprecated - use permissionDetails/permissionType instead. |
| 1015 | }, |
| 1016 | ], |
| 1017 | "type": "A String", # The account type. Allowed values are: |
| 1018 | # - user |
| 1019 | # - group |
| 1020 | # - domain |
| 1021 | # - anyone |
| 1022 | "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type is anyone, in which case both id and value are ignored. |
| 1023 | "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. published is the only supported value. |
| 1024 | "withLink": True or False, # Whether the link is required for this permission. |
| 1025 | }, |
| 1026 | "version": "A String", # A monotonically increasing version number for the file. This reflects every change made to the file on the server, even those not visible to the requesting user. |
| 1027 | "videoMediaMetadata": { # Metadata about video media. This will only be present for video types. |
| 1028 | "durationMillis": "A String", # The duration of the video in milliseconds. |
| 1029 | "height": 42, # The height of the video in pixels. |
| 1030 | "width": 42, # The width of the video in pixels. |
| 1031 | }, |
| 1032 | "webContentLink": "A String", # A link for downloading the content of the file in a browser using cookie based authentication. In cases where the content is shared publicly, the content can be downloaded without any credentials. |
| 1033 | "webViewLink": "A String", # A link only available on public folders for viewing their static web assets (HTML, CSS, JS, etc) via Google Drive's Website Hosting. |
| 1034 | "writersCanShare": True or False, # Whether writers can share the document with other users. Not populated for items in shared drives. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1035 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1036 | "fileId": "A String", # The ID of the file associated with this change. |
| 1037 | "id": "A String", # The ID of the change. |
| 1038 | "kind": "drive#change", # This is always drive#change. |
| 1039 | "modificationDate": "A String", # The time of this modification. |
| 1040 | "selfLink": "A String", # A link back to this change. |
| 1041 | "teamDrive": { # Deprecated: use the drive collection instead. # Deprecated - use drive instead. |
| 1042 | "backgroundImageFile": { # An image file and cropping parameters from which a background image for this Team Drive is set. This is a write only field; it can only be set on drive.teamdrives.update requests that don't set themeId. When specified, all fields of the backgroundImageFile must be set. |
| 1043 | "id": "A String", # The ID of an image file in Drive to use for the background image. |
| 1044 | "width": 3.14, # The width of the cropped image in the closed range of 0 to 1. This value represents the width of the cropped image divided by the width of the entire image. The height is computed by applying a width to height aspect ratio of 80 to 9. The resulting image must be at least 1280 pixels wide and 144 pixels high. |
| 1045 | "xCoordinate": 3.14, # The X coordinate of the upper left corner of the cropping area in the background image. This is a value in the closed range of 0 to 1. This value represents the horizontal distance from the left side of the entire image to the left side of the cropping area divided by the width of the entire image. |
| 1046 | "yCoordinate": 3.14, # The Y coordinate of the upper left corner of the cropping area in the background image. This is a value in the closed range of 0 to 1. This value represents the vertical distance from the top side of the entire image to the top side of the cropping area divided by the height of the entire image. |
| 1047 | }, |
| 1048 | "backgroundImageLink": "A String", # A short-lived link to this Team Drive's background image. |
| 1049 | "capabilities": { # Capabilities the current user has on this Team Drive. |
| 1050 | "canAddChildren": True or False, # Whether the current user can add children to folders in this Team Drive. |
| 1051 | "canChangeCopyRequiresWriterPermissionRestriction": True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this Team Drive. |
| 1052 | "canChangeDomainUsersOnlyRestriction": True or False, # Whether the current user can change the domainUsersOnly restriction of this Team Drive. |
| 1053 | "canChangeTeamDriveBackground": True or False, # Whether the current user can change the background of this Team Drive. |
| 1054 | "canChangeTeamMembersOnlyRestriction": True or False, # Whether the current user can change the teamMembersOnly restriction of this Team Drive. |
| 1055 | "canComment": True or False, # Whether the current user can comment on files in this Team Drive. |
| 1056 | "canCopy": True or False, # Whether the current user can copy files in this Team Drive. |
| 1057 | "canDeleteChildren": True or False, # Whether the current user can delete children from folders in this Team Drive. |
| 1058 | "canDeleteTeamDrive": True or False, # Whether the current user can delete this Team Drive. Attempting to delete the Team Drive may still fail if there are untrashed items inside the Team Drive. |
| 1059 | "canDownload": True or False, # Whether the current user can download files in this Team Drive. |
| 1060 | "canEdit": True or False, # Whether the current user can edit files in this Team Drive |
| 1061 | "canListChildren": True or False, # Whether the current user can list the children of folders in this Team Drive. |
| 1062 | "canManageMembers": True or False, # Whether the current user can add members to this Team Drive or remove them or change their role. |
| 1063 | "canReadRevisions": True or False, # Whether the current user can read the revisions resource of files in this Team Drive. |
| 1064 | "canRemoveChildren": True or False, # Deprecated - use canDeleteChildren or canTrashChildren instead. |
| 1065 | "canRename": True or False, # Whether the current user can rename files or folders in this Team Drive. |
| 1066 | "canRenameTeamDrive": True or False, # Whether the current user can rename this Team Drive. |
| 1067 | "canShare": True or False, # Whether the current user can share files or folders in this Team Drive. |
| 1068 | "canTrashChildren": True or False, # Whether the current user can trash children from folders in this Team Drive. |
| 1069 | }, |
| 1070 | "colorRgb": "A String", # The color of this Team Drive as an RGB hex string. It can only be set on a drive.teamdrives.update request that does not set themeId. |
| 1071 | "createdDate": "A String", # The time at which the Team Drive was created (RFC 3339 date-time). |
| 1072 | "id": "A String", # The ID of this Team Drive which is also the ID of the top level folder of this Team Drive. |
| 1073 | "kind": "drive#teamDrive", # This is always drive#teamDrive |
| 1074 | "name": "A String", # The name of this Team Drive. |
| 1075 | "restrictions": { # A set of restrictions that apply to this Team Drive or items inside this Team Drive. |
| 1076 | "adminManagedRestrictions": True or False, # Whether administrative privileges on this Team Drive are required to modify restrictions. |
| 1077 | "copyRequiresWriterPermission": True or False, # Whether the options to copy, print, or download files inside this Team Drive, should be disabled for readers and commenters. When this restriction is set to true, it will override the similarly named field to true for any file inside this Team Drive. |
| 1078 | "domainUsersOnly": True or False, # Whether access to this Team Drive and items inside this Team Drive is restricted to users of the domain to which this Team Drive belongs. This restriction may be overridden by other sharing policies controlled outside of this Team Drive. |
| 1079 | "teamMembersOnly": True or False, # Whether access to items inside this Team Drive is restricted to members of this Team Drive. |
| 1080 | }, |
| 1081 | "themeId": "A String", # The ID of the theme from which the background image and color will be set. The set of possible teamDriveThemes can be retrieved from a drive.about.get response. When not specified on a drive.teamdrives.insert request, a random theme is chosen from which the background image and color are set. This is a write-only field; it can only be set on requests that don't set colorRgb or backgroundImageFile. |
| 1082 | }, |
| 1083 | "teamDriveId": "A String", # Deprecated - use driveId instead. |
| 1084 | "type": "A String", # Deprecated - use changeType instead. |
| 1085 | }, |
| 1086 | ], |
| 1087 | "kind": "drive#changeList", # This is always drive#changeList. |
| 1088 | "largestChangeId": "A String", # The current largest change ID. |
| 1089 | "newStartPageToken": "A String", # The starting page token for future changes. This will be present only if the end of the current changes list has been reached. |
| 1090 | "nextLink": "A String", # A link to the next page of changes. |
| 1091 | "nextPageToken": "A String", # The page token for the next page of changes. This will be absent if the end of the changes list has been reached. If the token is rejected for any reason, it should be discarded, and pagination should be restarted from the first page of results. |
| 1092 | "selfLink": "A String", # A link back to this list. |
| 1093 | }</pre> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1094 | </div> |
| 1095 | |
| 1096 | <div class="method"> |
| 1097 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 1098 | <pre>Retrieves the next page of results. |
| 1099 | |
| 1100 | Args: |
| 1101 | previous_request: The request for the previous page. (required) |
| 1102 | previous_response: The response from the request for the previous page. (required) |
| 1103 | |
| 1104 | Returns: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1105 | A request object that you can call 'execute()' on to request the next |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1106 | page. Returns None if there are no more items in the collection. |
| 1107 | </pre> |
| 1108 | </div> |
| 1109 | |
| 1110 | <div class="method"> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 1111 | <code class="details" id="watch">watch(body=None, driveId=None, includeCorpusRemovals=None, includeDeleted=None, includeItemsFromAllDrives=None, includePermissionsForView=None, includeSubscribed=None, includeTeamDriveItems=None, maxResults=None, pageToken=None, spaces=None, startChangeId=None, supportsAllDrives=None, supportsTeamDrives=None, teamDriveId=None)</code> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1112 | <pre>Subscribe to changes for a user. |
| 1113 | |
| 1114 | Args: |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1115 | body: object, The request body. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1116 | The object takes the form of: |
| 1117 | |
| 1118 | { # An notification channel used to watch for resource changes. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1119 | "address": "A String", # The address where notifications are delivered for this channel. |
| 1120 | "expiration": "A String", # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional. |
| 1121 | "id": "A String", # A UUID or similar unique string that identifies this channel. |
| 1122 | "kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource, which is "api#channel". |
| 1123 | "params": { # Additional parameters controlling delivery channel behavior. Optional. |
| 1124 | "a_key": "A String", # Declares a new parameter by name. |
| 1125 | }, |
| 1126 | "payload": True or False, # A Boolean value to indicate whether payload is wanted. Optional. |
| 1127 | "resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions. |
| 1128 | "resourceUri": "A String", # A version-specific identifier for the watched resource. |
| 1129 | "token": "A String", # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional. |
| 1130 | "type": "A String", # The type of delivery mechanism used for this channel. |
| 1131 | } |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1132 | |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1133 | driveId: string, The shared drive from which changes are returned. If specified the change IDs will be reflective of the shared drive; use the combined drive ID and change ID as an identifier. |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 1134 | includeCorpusRemovals: boolean, Whether changes should include the file resource if the file is still accessible by the user at the time of the request, even when a file was removed from the list of changes and there will be no further change entries for this file. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1135 | includeDeleted: boolean, Whether to include changes indicating that items have been removed from the list of changes, for example by deletion or loss of access. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1136 | includeItemsFromAllDrives: boolean, Whether both My Drive and shared drive items should be included in results. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 1137 | includePermissionsForView: string, Specifies which additional view's permissions to include in the response. Only 'published' is supported. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1138 | includeSubscribed: boolean, Whether to include changes outside the My Drive hierarchy in the result. When set to false, changes to files such as those in the Application Data folder or shared files which have not been added to My Drive are omitted from the result. |
| 1139 | includeTeamDriveItems: boolean, Deprecated use includeItemsFromAllDrives instead. |
| 1140 | maxResults: integer, Maximum number of changes to return. |
| 1141 | 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 or to the response from the getStartPageToken method. |
| 1142 | spaces: string, A comma-separated list of spaces to query. Supported values are 'drive', 'appDataFolder' and 'photos'. |
| 1143 | startChangeId: string, Deprecated - use pageToken instead. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1144 | supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1145 | supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead. |
| 1146 | teamDriveId: string, Deprecated use driveId instead. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1147 | |
| 1148 | Returns: |
| 1149 | An object of the form: |
| 1150 | |
| 1151 | { # An notification channel used to watch for resource changes. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1152 | "address": "A String", # The address where notifications are delivered for this channel. |
| 1153 | "expiration": "A String", # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional. |
| 1154 | "id": "A String", # A UUID or similar unique string that identifies this channel. |
| 1155 | "kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource, which is "api#channel". |
| 1156 | "params": { # Additional parameters controlling delivery channel behavior. Optional. |
| 1157 | "a_key": "A String", # Declares a new parameter by name. |
| 1158 | }, |
| 1159 | "payload": True or False, # A Boolean value to indicate whether payload is wanted. Optional. |
| 1160 | "resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions. |
| 1161 | "resourceUri": "A String", # A version-specific identifier for the watched resource. |
| 1162 | "token": "A String", # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional. |
| 1163 | "type": "A String", # The type of delivery mechanism used for this channel. |
| 1164 | }</pre> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1165 | </div> |
| 1166 | |
| 1167 | </body></html> |