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.files.html">files</a></h1> 76 <h2>Instance Methods</h2> 77 <p class="toc_element"> 78 <code><a href="#copy">copy(fileId, body, pinned=None, convert=None, supportsTeamDrives=None, ocrLanguage=None, visibility=None, ocr=None, timedTextTrackName=None, timedTextLanguage=None)</a></code></p> 79 <p class="firstline">Creates a copy of the specified file.</p> 80 <p class="toc_element"> 81 <code><a href="#delete">delete(fileId, supportsTeamDrives=None)</a></code></p> 82 <p class="firstline">Permanently deletes a file by ID. Skips the trash. The currently authenticated user must own the file or be an organizer on the parent for Team Drive files.</p> 83 <p class="toc_element"> 84 <code><a href="#emptyTrash">emptyTrash()</a></code></p> 85 <p class="firstline">Permanently deletes all of the user's trashed files.</p> 86 <p class="toc_element"> 87 <code><a href="#export">export(fileId, mimeType)</a></code></p> 88 <p class="firstline">Exports a Google Doc to the requested MIME type and returns the exported content.</p> 89 <p class="toc_element"> 90 <code><a href="#export_media">export_media(fileId, mimeType)</a></code></p> 91 <p class="firstline">Exports a Google Doc to the requested MIME type and returns the exported content.</p> 92 <p class="toc_element"> 93 <code><a href="#generateIds">generateIds(space=None, maxResults=None)</a></code></p> 94 <p class="firstline">Generates a set of file IDs which can be provided in insert requests.</p> 95 <p class="toc_element"> 96 <code><a href="#get">get(fileId, projection=None, revisionId=None, supportsTeamDrives=None, acknowledgeAbuse=None, updateViewedDate=None)</a></code></p> 97 <p class="firstline">Gets a file's metadata by ID.</p> 98 <p class="toc_element"> 99 <code><a href="#get_media">get_media(fileId, projection=None, revisionId=None, supportsTeamDrives=None, acknowledgeAbuse=None, updateViewedDate=None)</a></code></p> 100 <p class="firstline">Gets a file's metadata by ID.</p> 101 <p class="toc_element"> 102 <code><a href="#insert">insert(body=None, supportsTeamDrives=None, media_body=None, ocrLanguage=None, ocr=None, pinned=None, visibility=None, timedTextTrackName=None, convert=None, useContentAsIndexableText=None, media_mime_type=None, timedTextLanguage=None)</a></code></p> 103 <p class="firstline">Insert a new file.</p> 104 <p class="toc_element"> 105 <code><a href="#list">list(orderBy=None, projection=None, supportsTeamDrives=None, spaces=None, pageToken=None, corpus=None, maxResults=None, teamDriveId=None, includeTeamDriveItems=None, corpora=None, q=None)</a></code></p> 106 <p class="firstline">Lists the user's files.</p> 107 <p class="toc_element"> 108 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 109 <p class="firstline">Retrieves the next page of results.</p> 110 <p class="toc_element"> 111 <code><a href="#patch">patch(fileId, body, supportsTeamDrives=None, newRevision=None, modifiedDateBehavior=None, pinned=None, ocrLanguage=None, ocr=None, addParents=None, removeParents=None, updateViewedDate=None, timedTextTrackName=None, convert=None, useContentAsIndexableText=None, setModifiedDate=None, timedTextLanguage=None)</a></code></p> 112 <p class="firstline">Updates file metadata and/or content. This method supports patch semantics.</p> 113 <p class="toc_element"> 114 <code><a href="#touch">touch(fileId, supportsTeamDrives=None)</a></code></p> 115 <p class="firstline">Set the file's updated time to the current server time.</p> 116 <p class="toc_element"> 117 <code><a href="#trash">trash(fileId, supportsTeamDrives=None)</a></code></p> 118 <p class="firstline">Moves a file to the trash. The currently authenticated user must own the file or be an organizer on the parent for Team Drive files.</p> 119 <p class="toc_element"> 120 <code><a href="#untrash">untrash(fileId, supportsTeamDrives=None)</a></code></p> 121 <p class="firstline">Restores a file from the trash.</p> 122 <p class="toc_element"> 123 <code><a href="#update">update(fileId, body=None, supportsTeamDrives=None, newRevision=None, modifiedDateBehavior=None, media_body=None, ocrLanguage=None, ocr=None, pinned=None, addParents=None, removeParents=None, updateViewedDate=None, timedTextTrackName=None, convert=None, useContentAsIndexableText=None, media_mime_type=None, setModifiedDate=None, timedTextLanguage=None)</a></code></p> 124 <p class="firstline">Updates file metadata and/or content.</p> 125 <p class="toc_element"> 126 <code><a href="#watch">watch(fileId, body, projection=None, revisionId=None, supportsTeamDrives=None, acknowledgeAbuse=None, updateViewedDate=None)</a></code></p> 127 <p class="firstline">Subscribe to changes on a file</p> 128 <p class="toc_element"> 129 <code><a href="#watch_media">watch_media(fileId, body, projection=None, revisionId=None, supportsTeamDrives=None, acknowledgeAbuse=None, updateViewedDate=None)</a></code></p> 130 <p class="firstline">Subscribe to changes on a file</p> 131 <h3>Method Details</h3> 132 <div class="method"> 133 <code class="details" id="copy">copy(fileId, body, pinned=None, convert=None, supportsTeamDrives=None, ocrLanguage=None, visibility=None, ocr=None, timedTextTrackName=None, timedTextLanguage=None)</code> 134 <pre>Creates a copy of the specified file. 135 136 Args: 137 fileId: string, The ID of the file to copy. (required) 138 body: object, The request body. (required) 139 The object takes the form of: 140 141 { # The metadata for a file. 142 "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. 143 "lastViewedByMeDate": "A String", # Last time this file was viewed by the user (formatted RFC 3339 timestamp). 144 "trashedDate": "A String", # The time that the item was trashed (formatted RFC 3339 timestamp). Only populated for Team Drive files. 145 "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. 146 "appDataContents": True or False, # Whether this file is in the Application Data folder. 147 "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. 148 "labels": { # A group of labels for the file. 149 "restricted": True or False, # Whether viewers and commenters are prevented from downloading, printing, and copying this file. 150 "modified": True or False, # Whether the file has been modified by this user. 151 "trashed": True or False, # Whether this file has been trashed. This label applies to all users accessing the file; however, only owners are allowed to see and untrash files. 152 "hidden": True or False, # Deprecated. 153 "starred": True or False, # Whether this file is starred by the user. 154 "viewed": True or False, # Whether this file has been viewed by this user. 155 }, 156 "indexableText": { # Indexable text attributes for the file (can only be written) 157 "text": "A String", # The text to be indexed for this file. 158 }, 159 "thumbnailVersion": "A String", # The thumbnail version for use in thumbnail cache invalidation. 160 "explicitlyTrashed": True or False, # Whether this file has been explicitly trashed, as opposed to recursively trashed. 161 "isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app. 162 "lastModifyingUserName": "A String", # Name of the last user to modify this file. 163 "writersCanShare": True or False, # Whether writers can share the document with other users. Not populated for Team Drive files. 164 "owners": [ # The owner(s) of this file. Not populated for Team Drive files. 165 { # Information about a Drive user. 166 "picture": { # The user's profile picture. 167 "url": "A String", # A URL that points to a profile picture of this user. 168 }, 169 "kind": "drive#user", # This is always drive#user. 170 "displayName": "A String", # A plain text displayable name for this user. 171 "permissionId": "A String", # The user's ID as visible in the permissions collection. 172 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. 173 "emailAddress": "A String", # The email address of the user. 174 }, 175 ], 176 "ownedByMe": True or False, # Whether the file is owned by the current user. Not populated for Team Drive files. 177 "id": "A String", # The ID of the file. 178 "sharingUser": { # Information about a Drive user. # User that shared the item with the current user, if available. 179 "picture": { # The user's profile picture. 180 "url": "A String", # A URL that points to a profile picture of this user. 181 }, 182 "kind": "drive#user", # This is always drive#user. 183 "displayName": "A String", # A plain text displayable name for this user. 184 "permissionId": "A String", # The user's ID as visible in the permissions collection. 185 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. 186 "emailAddress": "A String", # The email address of the user. 187 }, 188 "trashingUser": { # Information about a Drive user. # If the file has been explicitly trashed, the user who trashed it. Only populated for Team Drive files. 189 "picture": { # The user's profile picture. 190 "url": "A String", # A URL that points to a profile picture of this user. 191 }, 192 "kind": "drive#user", # This is always drive#user. 193 "displayName": "A String", # A plain text displayable name for this user. 194 "permissionId": "A String", # The user's ID as visible in the permissions collection. 195 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. 196 "emailAddress": "A String", # The email address of the user. 197 }, 198 "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. 199 "lastModifyingUser": { # Information about a Drive user. # The last user to modify this file. 200 "picture": { # The user's profile picture. 201 "url": "A String", # A URL that points to a profile picture of this user. 202 }, 203 "kind": "drive#user", # This is always drive#user. 204 "displayName": "A String", # A plain text displayable name for this user. 205 "permissionId": "A String", # The user's ID as visible in the permissions collection. 206 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. 207 "emailAddress": "A String", # The email address of the user. 208 }, 209 "copyable": True or False, # Deprecated: use capabilities/canCopy. 210 "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 Team Drive files. 211 "markedViewedByMeDate": "A String", # Deprecated. 212 "ownerNames": [ # Name(s) of the owner(s) of this file. Not populated for Team Drive files. 213 "A String", 214 ], 215 "capabilities": { # Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take. 216 "canReadRevisions": True or False, # Whether the current user can read the revisions resource of this file. For a Team Drive item, whether revisions of non-folder descendants of this item, or this item itself if it is not a folder, can be read. 217 "canTrash": True or False, # Whether the current user can move this file to trash. 218 "canCopy": True or False, # Whether the current user can copy this file. For a Team Drive item, whether the current user can copy non-folder descendants of this item, or this item itself if it is not a folder. 219 "canShare": True or False, # Whether the current user can modify the sharing settings for this file. 220 "canDelete": True or False, # Whether the current user can delete this file. 221 "canMoveTeamDriveItem": True or False, # Whether the current user can move this Team Drive item by changing its parent. Note that a request to change the parent for this item may still fail depending on the new parent that is being added. Only populated for Team Drive files. 222 "canRename": True or False, # Whether the current user can rename this file. 223 "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. 224 "canChangeRestrictedDownload": True or False, # Whether the current user can change the restricted download label of this file. 225 "canMoveItemIntoTeamDrive": True or False, # Whether the current user can move this item into a Team Drive. If the item is in a Team Drive, this field is equivalent to canMoveTeamDriveItem. 226 "canDownload": True or False, # Whether the current user can download this file. 227 "canComment": True or False, # Whether the current user can comment on this file. 228 "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. 229 "canReadTeamDrive": True or False, # Whether the current user can read the Team Drive to which this file belongs. Only populated for Team Drive files. 230 "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. 231 "canEdit": True or False, # Whether the current user can edit this file. 232 "canUntrash": True or False, # Whether the current user can restore this file from trash. 233 }, 234 "sharedWithMeDate": "A String", # Time at which this file was shared with the user (formatted RFC 3339 timestamp). 235 "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. 236 "etag": "A String", # ETag of the file. 237 "parents": [ # Collection of parent folders which contain this file. 238 # Setting this field will put the file in all of the provided folders. On insert, if no folders are provided, the file will be placed in the default root folder. 239 { # A reference to a file's parent. 240 "selfLink": "A String", # A link back to this reference. 241 "kind": "drive#parentReference", # This is always drive#parentReference. 242 "id": "A String", # The ID of the parent. 243 "isRoot": True or False, # Whether or not the parent is the root folder. 244 "parentLink": "A String", # A link to the parent. 245 }, 246 ], 247 "exportLinks": { # Links for exporting Google Docs to specific formats. 248 "a_key": "A String", # A mapping from export format to URL 249 }, 250 "shared": True or False, # Whether the file has been shared. Not populated for Team Drive files. 251 "permissions": [ # The list of permissions for users with access to this file. Not populated for Team Drive files. 252 { # A permission for a file. 253 "withLink": True or False, # Whether the link is required for this permission. 254 "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. 255 "name": "A String", # The name for this permission. 256 "teamDrivePermissionDetails": [ # Details of whether the permissions on this Team Drive item are inherited or directly on this item. This is an output-only field which is present only for Team Drive items. 257 { 258 "inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field and is only populated for members of the Team Drive. 259 "role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible: 260 # - organizer 261 # - reader 262 # - writer 263 "additionalRoles": [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future. 264 "A String", 265 ], 266 "teamDrivePermissionType": "A String", # The Team Drive permission type for this user. While new values may be added in future, the following are currently possible: 267 # - file 268 # - member 269 "inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field. 270 }, 271 ], 272 "deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions. 273 "kind": "drive#permission", # This is always drive#permission. 274 "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. 275 "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. 276 "authKey": "A String", # The authkey parameter required for this permission. 277 "etag": "A String", # The ETag of the permission. 278 "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. 279 "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: 280 # - They can only be set on user and group permissions 281 # - The date must be in the future 282 # - The date cannot be more than a year in the future 283 # - The date can only be set on drive.permissions.update requests 284 "role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: 285 # - organizer 286 # - owner 287 # - reader 288 # - writer 289 "type": "A String", # The account type. Allowed values are: 290 # - user 291 # - group 292 # - domain 293 # - anyone 294 "additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future. 295 "A String", 296 ], 297 "selfLink": "A String", # A link back to this permission. 298 "photoLink": "A String", # A link to the profile photo, if available. 299 }, 300 ], 301 "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 Drive; it is not populated for Google Docs or shortcut files. 302 "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. 303 "a_key": "A String", 304 }, 305 "canReadRevisions": True or False, # Deprecated: use capabilities/canReadRevisions. 306 "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. 307 "exposureBias": 3.14, # The exposure bias of the photo (APEX value). 308 "exposureTime": 3.14, # The length of the exposure, in seconds. 309 "cameraMake": "A String", # The make of the camera used to create the photo. 310 "maxApertureValue": 3.14, # The smallest f-number of the lens at the focal length used to create the photo (APEX value). 311 "isoSpeed": 42, # The ISO speed used to create the photo. 312 "focalLength": 3.14, # The focal length used to create the photo, in millimeters. 313 "exposureMode": "A String", # The exposure mode used to create the photo. 314 "colorSpace": "A String", # The color space of the photo. 315 "location": { # Geographic location information stored in the image. 316 "latitude": 3.14, # The latitude stored in the image. 317 "altitude": 3.14, # The altitude stored in the image. 318 "longitude": 3.14, # The longitude stored in the image. 319 }, 320 "subjectDistance": 42, # The distance to the subject of the photo, in meters. 321 "height": 42, # The height of the image in pixels. 322 "lens": "A String", # The lens used to create the photo. 323 "date": "A String", # The date and time the photo was taken (EXIF format timestamp). 324 "width": 42, # The width of the image in pixels. 325 "meteringMode": "A String", # The metering mode used to create the photo. 326 "flashUsed": True or False, # Whether a flash was used to create the photo. 327 "aperture": 3.14, # The aperture used to create the photo (f-number). 328 "rotation": 42, # The rotation in clockwise degrees from the image's original orientation. 329 "sensor": "A String", # The type of sensor used to create the photo. 330 "whiteBalance": "A String", # The white balance mode used to create the photo. 331 "cameraModel": "A String", # The model of the camera used to create the photo. 332 }, 333 "description": "A String", # A short description of the file. 334 "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. 335 "videoMediaMetadata": { # Metadata about video media. This will only be present for video types. 336 "width": 42, # The width of the video in pixels. 337 "durationMillis": "A String", # The duration of the video in milliseconds. 338 "height": 42, # The height of the video in pixels. 339 }, 340 "editable": True or False, # Deprecated: use capabilities/canEdit. 341 "kind": "drive#file", # The type of file. This is always drive#file. 342 "canComment": True or False, # Deprecated: use capabilities/canComment. 343 "quotaBytesUsed": "A String", # The number of quota bytes used by this file. 344 "fileSize": "A String", # The size of the file in bytes. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files. 345 "createdDate": "A String", # Create time for this file (formatted RFC 3339 timestamp). 346 "teamDriveId": "A String", # ID of the Team Drive the file resides in. 347 "properties": [ # The list of properties. 348 { # A key-value pair attached to a file that is either public or private to an application. 349 # The following limits apply to file properties: 350 # - Maximum of 100 properties total per file 351 # - Maximum of 30 private properties per app 352 # - Maximum of 30 public properties 353 # - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property. 354 "kind": "drive#property", # This is always drive#property. 355 "value": "A String", # The value of this property. 356 "etag": "A String", # ETag of the property. 357 "visibility": "A String", # The visibility of this property. 358 "key": "A String", # The key of this property. 359 "selfLink": "A String", # The link back to this property. 360 }, 361 ], 362 "md5Checksum": "A String", # An MD5 checksum for the content of this file. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files. 363 "iconLink": "A String", # A link to the file's icon. 364 "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. 365 "embedLink": "A String", # A link for embedding the file. 366 "alternateLink": "A String", # A link for opening the file in a relevant Google editor or viewer. 367 "title": "A String", # The title of this file. Note that for immutable items such as the top level folders of Team Drives, My Drive root folder, and Application Data folder the title is constant. 368 "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. 369 "thumbnail": { # A thumbnail for the file. This will only be used if Drive cannot generate a standard thumbnail. 370 "mimeType": "A String", # The MIME type of the thumbnail. 371 "image": "A String", # The URL-safe Base64 encoded bytes of the thumbnail image. It should conform to RFC 4648 section 5. 372 }, 373 "downloadUrl": "A String", 374 "userPermission": { # A permission for a file. # The permissions for the authenticated user on this file. 375 "withLink": True or False, # Whether the link is required for this permission. 376 "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. 377 "name": "A String", # The name for this permission. 378 "teamDrivePermissionDetails": [ # Details of whether the permissions on this Team Drive item are inherited or directly on this item. This is an output-only field which is present only for Team Drive items. 379 { 380 "inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field and is only populated for members of the Team Drive. 381 "role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible: 382 # - organizer 383 # - reader 384 # - writer 385 "additionalRoles": [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future. 386 "A String", 387 ], 388 "teamDrivePermissionType": "A String", # The Team Drive permission type for this user. While new values may be added in future, the following are currently possible: 389 # - file 390 # - member 391 "inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field. 392 }, 393 ], 394 "deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions. 395 "kind": "drive#permission", # This is always drive#permission. 396 "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. 397 "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. 398 "authKey": "A String", # The authkey parameter required for this permission. 399 "etag": "A String", # The ETag of the permission. 400 "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. 401 "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: 402 # - They can only be set on user and group permissions 403 # - The date must be in the future 404 # - The date cannot be more than a year in the future 405 # - The date can only be set on drive.permissions.update requests 406 "role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: 407 # - organizer 408 # - owner 409 # - reader 410 # - writer 411 "type": "A String", # The account type. Allowed values are: 412 # - user 413 # - group 414 # - domain 415 # - anyone 416 "additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future. 417 "A String", 418 ], 419 "selfLink": "A String", # A link back to this permission. 420 "photoLink": "A String", # A link to the profile photo, if available. 421 }, 422 "spaces": [ # The list of spaces which contain the file. Supported values are 'drive', 'appDataFolder' and 'photos'. 423 "A String", 424 ], 425 "shareable": True or False, # Deprecated: use capabilities/canShare. 426 "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 Drive. 427 "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 Drive; it is not populated for Google Docs or shortcut files. 428 "hasAugmentedPermissions": True or False, # Whether any users are granted file access directly on this file. This field is only populated for Team Drive files. 429 "headRevisionId": "A String", # The ID of the file's head revision. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files. 430 "selfLink": "A String", # A link back to this file. 431 "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. 432 } 433 434 pinned: boolean, Whether to pin the head revision of the new copy. A file can have a maximum of 200 pinned revisions. 435 convert: boolean, Whether to convert this file to the corresponding Google Docs format. 436 supportsTeamDrives: boolean, Whether the requesting application supports Team Drives. 437 ocrLanguage: string, If ocr is true, hints at the language to use. Valid values are BCP 47 codes. 438 visibility: string, The visibility of the new file. This parameter is only relevant when the source is not a native Google Doc and convert=false. 439 Allowed values 440 DEFAULT - The visibility of the new file is determined by the user's default visibility/sharing policies. 441 PRIVATE - The new file will be visible to only the owner. 442 ocr: boolean, Whether to attempt OCR on .jpg, .png, .gif, or .pdf uploads. 443 timedTextTrackName: string, The timed text track name. 444 timedTextLanguage: string, The language of the timed text. 445 446 Returns: 447 An object of the form: 448 449 { # The metadata for a file. 450 "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. 451 "lastViewedByMeDate": "A String", # Last time this file was viewed by the user (formatted RFC 3339 timestamp). 452 "trashedDate": "A String", # The time that the item was trashed (formatted RFC 3339 timestamp). Only populated for Team Drive files. 453 "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. 454 "appDataContents": True or False, # Whether this file is in the Application Data folder. 455 "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. 456 "labels": { # A group of labels for the file. 457 "restricted": True or False, # Whether viewers and commenters are prevented from downloading, printing, and copying this file. 458 "modified": True or False, # Whether the file has been modified by this user. 459 "trashed": True or False, # Whether this file has been trashed. This label applies to all users accessing the file; however, only owners are allowed to see and untrash files. 460 "hidden": True or False, # Deprecated. 461 "starred": True or False, # Whether this file is starred by the user. 462 "viewed": True or False, # Whether this file has been viewed by this user. 463 }, 464 "indexableText": { # Indexable text attributes for the file (can only be written) 465 "text": "A String", # The text to be indexed for this file. 466 }, 467 "thumbnailVersion": "A String", # The thumbnail version for use in thumbnail cache invalidation. 468 "explicitlyTrashed": True or False, # Whether this file has been explicitly trashed, as opposed to recursively trashed. 469 "isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app. 470 "lastModifyingUserName": "A String", # Name of the last user to modify this file. 471 "writersCanShare": True or False, # Whether writers can share the document with other users. Not populated for Team Drive files. 472 "owners": [ # The owner(s) of this file. Not populated for Team Drive files. 473 { # Information about a Drive user. 474 "picture": { # The user's profile picture. 475 "url": "A String", # A URL that points to a profile picture of this user. 476 }, 477 "kind": "drive#user", # This is always drive#user. 478 "displayName": "A String", # A plain text displayable name for this user. 479 "permissionId": "A String", # The user's ID as visible in the permissions collection. 480 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. 481 "emailAddress": "A String", # The email address of the user. 482 }, 483 ], 484 "ownedByMe": True or False, # Whether the file is owned by the current user. Not populated for Team Drive files. 485 "id": "A String", # The ID of the file. 486 "sharingUser": { # Information about a Drive user. # User that shared the item with the current user, if available. 487 "picture": { # The user's profile picture. 488 "url": "A String", # A URL that points to a profile picture of this user. 489 }, 490 "kind": "drive#user", # This is always drive#user. 491 "displayName": "A String", # A plain text displayable name for this user. 492 "permissionId": "A String", # The user's ID as visible in the permissions collection. 493 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. 494 "emailAddress": "A String", # The email address of the user. 495 }, 496 "trashingUser": { # Information about a Drive user. # If the file has been explicitly trashed, the user who trashed it. Only populated for Team Drive files. 497 "picture": { # The user's profile picture. 498 "url": "A String", # A URL that points to a profile picture of this user. 499 }, 500 "kind": "drive#user", # This is always drive#user. 501 "displayName": "A String", # A plain text displayable name for this user. 502 "permissionId": "A String", # The user's ID as visible in the permissions collection. 503 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. 504 "emailAddress": "A String", # The email address of the user. 505 }, 506 "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. 507 "lastModifyingUser": { # Information about a Drive user. # The last user to modify this file. 508 "picture": { # The user's profile picture. 509 "url": "A String", # A URL that points to a profile picture of this user. 510 }, 511 "kind": "drive#user", # This is always drive#user. 512 "displayName": "A String", # A plain text displayable name for this user. 513 "permissionId": "A String", # The user's ID as visible in the permissions collection. 514 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. 515 "emailAddress": "A String", # The email address of the user. 516 }, 517 "copyable": True or False, # Deprecated: use capabilities/canCopy. 518 "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 Team Drive files. 519 "markedViewedByMeDate": "A String", # Deprecated. 520 "ownerNames": [ # Name(s) of the owner(s) of this file. Not populated for Team Drive files. 521 "A String", 522 ], 523 "capabilities": { # Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take. 524 "canReadRevisions": True or False, # Whether the current user can read the revisions resource of this file. For a Team Drive item, whether revisions of non-folder descendants of this item, or this item itself if it is not a folder, can be read. 525 "canTrash": True or False, # Whether the current user can move this file to trash. 526 "canCopy": True or False, # Whether the current user can copy this file. For a Team Drive item, whether the current user can copy non-folder descendants of this item, or this item itself if it is not a folder. 527 "canShare": True or False, # Whether the current user can modify the sharing settings for this file. 528 "canDelete": True or False, # Whether the current user can delete this file. 529 "canMoveTeamDriveItem": True or False, # Whether the current user can move this Team Drive item by changing its parent. Note that a request to change the parent for this item may still fail depending on the new parent that is being added. Only populated for Team Drive files. 530 "canRename": True or False, # Whether the current user can rename this file. 531 "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. 532 "canChangeRestrictedDownload": True or False, # Whether the current user can change the restricted download label of this file. 533 "canMoveItemIntoTeamDrive": True or False, # Whether the current user can move this item into a Team Drive. If the item is in a Team Drive, this field is equivalent to canMoveTeamDriveItem. 534 "canDownload": True or False, # Whether the current user can download this file. 535 "canComment": True or False, # Whether the current user can comment on this file. 536 "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. 537 "canReadTeamDrive": True or False, # Whether the current user can read the Team Drive to which this file belongs. Only populated for Team Drive files. 538 "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. 539 "canEdit": True or False, # Whether the current user can edit this file. 540 "canUntrash": True or False, # Whether the current user can restore this file from trash. 541 }, 542 "sharedWithMeDate": "A String", # Time at which this file was shared with the user (formatted RFC 3339 timestamp). 543 "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. 544 "etag": "A String", # ETag of the file. 545 "parents": [ # Collection of parent folders which contain this file. 546 # Setting this field will put the file in all of the provided folders. On insert, if no folders are provided, the file will be placed in the default root folder. 547 { # A reference to a file's parent. 548 "selfLink": "A String", # A link back to this reference. 549 "kind": "drive#parentReference", # This is always drive#parentReference. 550 "id": "A String", # The ID of the parent. 551 "isRoot": True or False, # Whether or not the parent is the root folder. 552 "parentLink": "A String", # A link to the parent. 553 }, 554 ], 555 "exportLinks": { # Links for exporting Google Docs to specific formats. 556 "a_key": "A String", # A mapping from export format to URL 557 }, 558 "shared": True or False, # Whether the file has been shared. Not populated for Team Drive files. 559 "permissions": [ # The list of permissions for users with access to this file. Not populated for Team Drive files. 560 { # A permission for a file. 561 "withLink": True or False, # Whether the link is required for this permission. 562 "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. 563 "name": "A String", # The name for this permission. 564 "teamDrivePermissionDetails": [ # Details of whether the permissions on this Team Drive item are inherited or directly on this item. This is an output-only field which is present only for Team Drive items. 565 { 566 "inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field and is only populated for members of the Team Drive. 567 "role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible: 568 # - organizer 569 # - reader 570 # - writer 571 "additionalRoles": [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future. 572 "A String", 573 ], 574 "teamDrivePermissionType": "A String", # The Team Drive permission type for this user. While new values may be added in future, the following are currently possible: 575 # - file 576 # - member 577 "inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field. 578 }, 579 ], 580 "deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions. 581 "kind": "drive#permission", # This is always drive#permission. 582 "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. 583 "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. 584 "authKey": "A String", # The authkey parameter required for this permission. 585 "etag": "A String", # The ETag of the permission. 586 "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. 587 "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: 588 # - They can only be set on user and group permissions 589 # - The date must be in the future 590 # - The date cannot be more than a year in the future 591 # - The date can only be set on drive.permissions.update requests 592 "role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: 593 # - organizer 594 # - owner 595 # - reader 596 # - writer 597 "type": "A String", # The account type. Allowed values are: 598 # - user 599 # - group 600 # - domain 601 # - anyone 602 "additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future. 603 "A String", 604 ], 605 "selfLink": "A String", # A link back to this permission. 606 "photoLink": "A String", # A link to the profile photo, if available. 607 }, 608 ], 609 "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 Drive; it is not populated for Google Docs or shortcut files. 610 "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. 611 "a_key": "A String", 612 }, 613 "canReadRevisions": True or False, # Deprecated: use capabilities/canReadRevisions. 614 "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. 615 "exposureBias": 3.14, # The exposure bias of the photo (APEX value). 616 "exposureTime": 3.14, # The length of the exposure, in seconds. 617 "cameraMake": "A String", # The make of the camera used to create the photo. 618 "maxApertureValue": 3.14, # The smallest f-number of the lens at the focal length used to create the photo (APEX value). 619 "isoSpeed": 42, # The ISO speed used to create the photo. 620 "focalLength": 3.14, # The focal length used to create the photo, in millimeters. 621 "exposureMode": "A String", # The exposure mode used to create the photo. 622 "colorSpace": "A String", # The color space of the photo. 623 "location": { # Geographic location information stored in the image. 624 "latitude": 3.14, # The latitude stored in the image. 625 "altitude": 3.14, # The altitude stored in the image. 626 "longitude": 3.14, # The longitude stored in the image. 627 }, 628 "subjectDistance": 42, # The distance to the subject of the photo, in meters. 629 "height": 42, # The height of the image in pixels. 630 "lens": "A String", # The lens used to create the photo. 631 "date": "A String", # The date and time the photo was taken (EXIF format timestamp). 632 "width": 42, # The width of the image in pixels. 633 "meteringMode": "A String", # The metering mode used to create the photo. 634 "flashUsed": True or False, # Whether a flash was used to create the photo. 635 "aperture": 3.14, # The aperture used to create the photo (f-number). 636 "rotation": 42, # The rotation in clockwise degrees from the image's original orientation. 637 "sensor": "A String", # The type of sensor used to create the photo. 638 "whiteBalance": "A String", # The white balance mode used to create the photo. 639 "cameraModel": "A String", # The model of the camera used to create the photo. 640 }, 641 "description": "A String", # A short description of the file. 642 "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. 643 "videoMediaMetadata": { # Metadata about video media. This will only be present for video types. 644 "width": 42, # The width of the video in pixels. 645 "durationMillis": "A String", # The duration of the video in milliseconds. 646 "height": 42, # The height of the video in pixels. 647 }, 648 "editable": True or False, # Deprecated: use capabilities/canEdit. 649 "kind": "drive#file", # The type of file. This is always drive#file. 650 "canComment": True or False, # Deprecated: use capabilities/canComment. 651 "quotaBytesUsed": "A String", # The number of quota bytes used by this file. 652 "fileSize": "A String", # The size of the file in bytes. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files. 653 "createdDate": "A String", # Create time for this file (formatted RFC 3339 timestamp). 654 "teamDriveId": "A String", # ID of the Team Drive the file resides in. 655 "properties": [ # The list of properties. 656 { # A key-value pair attached to a file that is either public or private to an application. 657 # The following limits apply to file properties: 658 # - Maximum of 100 properties total per file 659 # - Maximum of 30 private properties per app 660 # - Maximum of 30 public properties 661 # - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property. 662 "kind": "drive#property", # This is always drive#property. 663 "value": "A String", # The value of this property. 664 "etag": "A String", # ETag of the property. 665 "visibility": "A String", # The visibility of this property. 666 "key": "A String", # The key of this property. 667 "selfLink": "A String", # The link back to this property. 668 }, 669 ], 670 "md5Checksum": "A String", # An MD5 checksum for the content of this file. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files. 671 "iconLink": "A String", # A link to the file's icon. 672 "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. 673 "embedLink": "A String", # A link for embedding the file. 674 "alternateLink": "A String", # A link for opening the file in a relevant Google editor or viewer. 675 "title": "A String", # The title of this file. Note that for immutable items such as the top level folders of Team Drives, My Drive root folder, and Application Data folder the title is constant. 676 "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. 677 "thumbnail": { # A thumbnail for the file. This will only be used if Drive cannot generate a standard thumbnail. 678 "mimeType": "A String", # The MIME type of the thumbnail. 679 "image": "A String", # The URL-safe Base64 encoded bytes of the thumbnail image. It should conform to RFC 4648 section 5. 680 }, 681 "downloadUrl": "A String", 682 "userPermission": { # A permission for a file. # The permissions for the authenticated user on this file. 683 "withLink": True or False, # Whether the link is required for this permission. 684 "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. 685 "name": "A String", # The name for this permission. 686 "teamDrivePermissionDetails": [ # Details of whether the permissions on this Team Drive item are inherited or directly on this item. This is an output-only field which is present only for Team Drive items. 687 { 688 "inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field and is only populated for members of the Team Drive. 689 "role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible: 690 # - organizer 691 # - reader 692 # - writer 693 "additionalRoles": [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future. 694 "A String", 695 ], 696 "teamDrivePermissionType": "A String", # The Team Drive permission type for this user. While new values may be added in future, the following are currently possible: 697 # - file 698 # - member 699 "inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field. 700 }, 701 ], 702 "deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions. 703 "kind": "drive#permission", # This is always drive#permission. 704 "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. 705 "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. 706 "authKey": "A String", # The authkey parameter required for this permission. 707 "etag": "A String", # The ETag of the permission. 708 "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. 709 "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: 710 # - They can only be set on user and group permissions 711 # - The date must be in the future 712 # - The date cannot be more than a year in the future 713 # - The date can only be set on drive.permissions.update requests 714 "role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: 715 # - organizer 716 # - owner 717 # - reader 718 # - writer 719 "type": "A String", # The account type. Allowed values are: 720 # - user 721 # - group 722 # - domain 723 # - anyone 724 "additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future. 725 "A String", 726 ], 727 "selfLink": "A String", # A link back to this permission. 728 "photoLink": "A String", # A link to the profile photo, if available. 729 }, 730 "spaces": [ # The list of spaces which contain the file. Supported values are 'drive', 'appDataFolder' and 'photos'. 731 "A String", 732 ], 733 "shareable": True or False, # Deprecated: use capabilities/canShare. 734 "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 Drive. 735 "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 Drive; it is not populated for Google Docs or shortcut files. 736 "hasAugmentedPermissions": True or False, # Whether any users are granted file access directly on this file. This field is only populated for Team Drive files. 737 "headRevisionId": "A String", # The ID of the file's head revision. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files. 738 "selfLink": "A String", # A link back to this file. 739 "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. 740 }</pre> 741 </div> 742 743 <div class="method"> 744 <code class="details" id="delete">delete(fileId, supportsTeamDrives=None)</code> 745 <pre>Permanently deletes a file by ID. Skips the trash. The currently authenticated user must own the file or be an organizer on the parent for Team Drive files. 746 747 Args: 748 fileId: string, The ID of the file to delete. (required) 749 supportsTeamDrives: boolean, Whether the requesting application supports Team Drives. 750 </pre> 751 </div> 752 753 <div class="method"> 754 <code class="details" id="emptyTrash">emptyTrash()</code> 755 <pre>Permanently deletes all of the user's trashed files. 756 757 Args: 758 </pre> 759 </div> 760 761 <div class="method"> 762 <code class="details" id="export">export(fileId, mimeType)</code> 763 <pre>Exports a Google Doc to the requested MIME type and returns the exported content. 764 765 Args: 766 fileId: string, The ID of the file. (required) 767 mimeType: string, The MIME type of the format requested for this export. (required) 768 </pre> 769 </div> 770 771 <div class="method"> 772 <code class="details" id="export_media">export_media(fileId, mimeType)</code> 773 <pre>Exports a Google Doc to the requested MIME type and returns the exported content. 774 775 Args: 776 fileId: string, The ID of the file. (required) 777 mimeType: string, The MIME type of the format requested for this export. (required) 778 </pre> 779 </div> 780 781 <div class="method"> 782 <code class="details" id="generateIds">generateIds(space=None, maxResults=None)</code> 783 <pre>Generates a set of file IDs which can be provided in insert requests. 784 785 Args: 786 space: string, The space in which the IDs can be used to create new files. Supported values are 'drive' and 'appDataFolder'. 787 maxResults: integer, Maximum number of IDs to return. 788 789 Returns: 790 An object of the form: 791 792 { # A list of generated IDs which can be provided in insert requests 793 "kind": "drive#generatedIds", # This is always drive#generatedIds 794 "ids": [ # The IDs generated for the requesting user in the specified space. 795 "A String", 796 ], 797 "space": "A String", # The type of file that can be created with these IDs. 798 }</pre> 799 </div> 800 801 <div class="method"> 802 <code class="details" id="get">get(fileId, projection=None, revisionId=None, supportsTeamDrives=None, acknowledgeAbuse=None, updateViewedDate=None)</code> 803 <pre>Gets a file's metadata by ID. 804 805 Args: 806 fileId: string, The ID for the file in question. (required) 807 projection: string, This parameter is deprecated and has no function. 808 Allowed values 809 BASIC - Deprecated 810 FULL - Deprecated 811 revisionId: string, Specifies the Revision ID that should be downloaded. Ignored unless alt=media is specified. 812 supportsTeamDrives: boolean, Whether the requesting application supports Team Drives. 813 acknowledgeAbuse: boolean, Whether the user is acknowledging the risk of downloading known malware or other abusive files. 814 updateViewedDate: boolean, Deprecated: Use files.update with modifiedDateBehavior=noChange, updateViewedDate=true and an empty request body. 815 816 Returns: 817 An object of the form: 818 819 { # The metadata for a file. 820 "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. 821 "lastViewedByMeDate": "A String", # Last time this file was viewed by the user (formatted RFC 3339 timestamp). 822 "trashedDate": "A String", # The time that the item was trashed (formatted RFC 3339 timestamp). Only populated for Team Drive files. 823 "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. 824 "appDataContents": True or False, # Whether this file is in the Application Data folder. 825 "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. 826 "labels": { # A group of labels for the file. 827 "restricted": True or False, # Whether viewers and commenters are prevented from downloading, printing, and copying this file. 828 "modified": True or False, # Whether the file has been modified by this user. 829 "trashed": True or False, # Whether this file has been trashed. This label applies to all users accessing the file; however, only owners are allowed to see and untrash files. 830 "hidden": True or False, # Deprecated. 831 "starred": True or False, # Whether this file is starred by the user. 832 "viewed": True or False, # Whether this file has been viewed by this user. 833 }, 834 "indexableText": { # Indexable text attributes for the file (can only be written) 835 "text": "A String", # The text to be indexed for this file. 836 }, 837 "thumbnailVersion": "A String", # The thumbnail version for use in thumbnail cache invalidation. 838 "explicitlyTrashed": True or False, # Whether this file has been explicitly trashed, as opposed to recursively trashed. 839 "isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app. 840 "lastModifyingUserName": "A String", # Name of the last user to modify this file. 841 "writersCanShare": True or False, # Whether writers can share the document with other users. Not populated for Team Drive files. 842 "owners": [ # The owner(s) of this file. Not populated for Team Drive files. 843 { # Information about a Drive user. 844 "picture": { # The user's profile picture. 845 "url": "A String", # A URL that points to a profile picture of this user. 846 }, 847 "kind": "drive#user", # This is always drive#user. 848 "displayName": "A String", # A plain text displayable name for this user. 849 "permissionId": "A String", # The user's ID as visible in the permissions collection. 850 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. 851 "emailAddress": "A String", # The email address of the user. 852 }, 853 ], 854 "ownedByMe": True or False, # Whether the file is owned by the current user. Not populated for Team Drive files. 855 "id": "A String", # The ID of the file. 856 "sharingUser": { # Information about a Drive user. # User that shared the item with the current user, if available. 857 "picture": { # The user's profile picture. 858 "url": "A String", # A URL that points to a profile picture of this user. 859 }, 860 "kind": "drive#user", # This is always drive#user. 861 "displayName": "A String", # A plain text displayable name for this user. 862 "permissionId": "A String", # The user's ID as visible in the permissions collection. 863 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. 864 "emailAddress": "A String", # The email address of the user. 865 }, 866 "trashingUser": { # Information about a Drive user. # If the file has been explicitly trashed, the user who trashed it. Only populated for Team Drive files. 867 "picture": { # The user's profile picture. 868 "url": "A String", # A URL that points to a profile picture of this user. 869 }, 870 "kind": "drive#user", # This is always drive#user. 871 "displayName": "A String", # A plain text displayable name for this user. 872 "permissionId": "A String", # The user's ID as visible in the permissions collection. 873 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. 874 "emailAddress": "A String", # The email address of the user. 875 }, 876 "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. 877 "lastModifyingUser": { # Information about a Drive user. # The last user to modify this file. 878 "picture": { # The user's profile picture. 879 "url": "A String", # A URL that points to a profile picture of this user. 880 }, 881 "kind": "drive#user", # This is always drive#user. 882 "displayName": "A String", # A plain text displayable name for this user. 883 "permissionId": "A String", # The user's ID as visible in the permissions collection. 884 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. 885 "emailAddress": "A String", # The email address of the user. 886 }, 887 "copyable": True or False, # Deprecated: use capabilities/canCopy. 888 "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 Team Drive files. 889 "markedViewedByMeDate": "A String", # Deprecated. 890 "ownerNames": [ # Name(s) of the owner(s) of this file. Not populated for Team Drive files. 891 "A String", 892 ], 893 "capabilities": { # Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take. 894 "canReadRevisions": True or False, # Whether the current user can read the revisions resource of this file. For a Team Drive item, whether revisions of non-folder descendants of this item, or this item itself if it is not a folder, can be read. 895 "canTrash": True or False, # Whether the current user can move this file to trash. 896 "canCopy": True or False, # Whether the current user can copy this file. For a Team Drive item, whether the current user can copy non-folder descendants of this item, or this item itself if it is not a folder. 897 "canShare": True or False, # Whether the current user can modify the sharing settings for this file. 898 "canDelete": True or False, # Whether the current user can delete this file. 899 "canMoveTeamDriveItem": True or False, # Whether the current user can move this Team Drive item by changing its parent. Note that a request to change the parent for this item may still fail depending on the new parent that is being added. Only populated for Team Drive files. 900 "canRename": True or False, # Whether the current user can rename this file. 901 "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. 902 "canChangeRestrictedDownload": True or False, # Whether the current user can change the restricted download label of this file. 903 "canMoveItemIntoTeamDrive": True or False, # Whether the current user can move this item into a Team Drive. If the item is in a Team Drive, this field is equivalent to canMoveTeamDriveItem. 904 "canDownload": True or False, # Whether the current user can download this file. 905 "canComment": True or False, # Whether the current user can comment on this file. 906 "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. 907 "canReadTeamDrive": True or False, # Whether the current user can read the Team Drive to which this file belongs. Only populated for Team Drive files. 908 "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. 909 "canEdit": True or False, # Whether the current user can edit this file. 910 "canUntrash": True or False, # Whether the current user can restore this file from trash. 911 }, 912 "sharedWithMeDate": "A String", # Time at which this file was shared with the user (formatted RFC 3339 timestamp). 913 "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. 914 "etag": "A String", # ETag of the file. 915 "parents": [ # Collection of parent folders which contain this file. 916 # Setting this field will put the file in all of the provided folders. On insert, if no folders are provided, the file will be placed in the default root folder. 917 { # A reference to a file's parent. 918 "selfLink": "A String", # A link back to this reference. 919 "kind": "drive#parentReference", # This is always drive#parentReference. 920 "id": "A String", # The ID of the parent. 921 "isRoot": True or False, # Whether or not the parent is the root folder. 922 "parentLink": "A String", # A link to the parent. 923 }, 924 ], 925 "exportLinks": { # Links for exporting Google Docs to specific formats. 926 "a_key": "A String", # A mapping from export format to URL 927 }, 928 "shared": True or False, # Whether the file has been shared. Not populated for Team Drive files. 929 "permissions": [ # The list of permissions for users with access to this file. Not populated for Team Drive files. 930 { # A permission for a file. 931 "withLink": True or False, # Whether the link is required for this permission. 932 "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. 933 "name": "A String", # The name for this permission. 934 "teamDrivePermissionDetails": [ # Details of whether the permissions on this Team Drive item are inherited or directly on this item. This is an output-only field which is present only for Team Drive items. 935 { 936 "inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field and is only populated for members of the Team Drive. 937 "role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible: 938 # - organizer 939 # - reader 940 # - writer 941 "additionalRoles": [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future. 942 "A String", 943 ], 944 "teamDrivePermissionType": "A String", # The Team Drive permission type for this user. While new values may be added in future, the following are currently possible: 945 # - file 946 # - member 947 "inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field. 948 }, 949 ], 950 "deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions. 951 "kind": "drive#permission", # This is always drive#permission. 952 "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. 953 "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. 954 "authKey": "A String", # The authkey parameter required for this permission. 955 "etag": "A String", # The ETag of the permission. 956 "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. 957 "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: 958 # - They can only be set on user and group permissions 959 # - The date must be in the future 960 # - The date cannot be more than a year in the future 961 # - The date can only be set on drive.permissions.update requests 962 "role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: 963 # - organizer 964 # - owner 965 # - reader 966 # - writer 967 "type": "A String", # The account type. Allowed values are: 968 # - user 969 # - group 970 # - domain 971 # - anyone 972 "additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future. 973 "A String", 974 ], 975 "selfLink": "A String", # A link back to this permission. 976 "photoLink": "A String", # A link to the profile photo, if available. 977 }, 978 ], 979 "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 Drive; it is not populated for Google Docs or shortcut files. 980 "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. 981 "a_key": "A String", 982 }, 983 "canReadRevisions": True or False, # Deprecated: use capabilities/canReadRevisions. 984 "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. 985 "exposureBias": 3.14, # The exposure bias of the photo (APEX value). 986 "exposureTime": 3.14, # The length of the exposure, in seconds. 987 "cameraMake": "A String", # The make of the camera used to create the photo. 988 "maxApertureValue": 3.14, # The smallest f-number of the lens at the focal length used to create the photo (APEX value). 989 "isoSpeed": 42, # The ISO speed used to create the photo. 990 "focalLength": 3.14, # The focal length used to create the photo, in millimeters. 991 "exposureMode": "A String", # The exposure mode used to create the photo. 992 "colorSpace": "A String", # The color space of the photo. 993 "location": { # Geographic location information stored in the image. 994 "latitude": 3.14, # The latitude stored in the image. 995 "altitude": 3.14, # The altitude stored in the image. 996 "longitude": 3.14, # The longitude stored in the image. 997 }, 998 "subjectDistance": 42, # The distance to the subject of the photo, in meters. 999 "height": 42, # The height of the image in pixels. 1000 "lens": "A String", # The lens used to create the photo. 1001 "date": "A String", # The date and time the photo was taken (EXIF format timestamp). 1002 "width": 42, # The width of the image in pixels. 1003 "meteringMode": "A String", # The metering mode used to create the photo. 1004 "flashUsed": True or False, # Whether a flash was used to create the photo. 1005 "aperture": 3.14, # The aperture used to create the photo (f-number). 1006 "rotation": 42, # The rotation in clockwise degrees from the image's original orientation. 1007 "sensor": "A String", # The type of sensor used to create the photo. 1008 "whiteBalance": "A String", # The white balance mode used to create the photo. 1009 "cameraModel": "A String", # The model of the camera used to create the photo. 1010 }, 1011 "description": "A String", # A short description of the file. 1012 "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. 1013 "videoMediaMetadata": { # Metadata about video media. This will only be present for video types. 1014 "width": 42, # The width of the video in pixels. 1015 "durationMillis": "A String", # The duration of the video in milliseconds. 1016 "height": 42, # The height of the video in pixels. 1017 }, 1018 "editable": True or False, # Deprecated: use capabilities/canEdit. 1019 "kind": "drive#file", # The type of file. This is always drive#file. 1020 "canComment": True or False, # Deprecated: use capabilities/canComment. 1021 "quotaBytesUsed": "A String", # The number of quota bytes used by this file. 1022 "fileSize": "A String", # The size of the file in bytes. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files. 1023 "createdDate": "A String", # Create time for this file (formatted RFC 3339 timestamp). 1024 "teamDriveId": "A String", # ID of the Team Drive the file resides in. 1025 "properties": [ # The list of properties. 1026 { # A key-value pair attached to a file that is either public or private to an application. 1027 # The following limits apply to file properties: 1028 # - Maximum of 100 properties total per file 1029 # - Maximum of 30 private properties per app 1030 # - Maximum of 30 public properties 1031 # - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property. 1032 "kind": "drive#property", # This is always drive#property. 1033 "value": "A String", # The value of this property. 1034 "etag": "A String", # ETag of the property. 1035 "visibility": "A String", # The visibility of this property. 1036 "key": "A String", # The key of this property. 1037 "selfLink": "A String", # The link back to this property. 1038 }, 1039 ], 1040 "md5Checksum": "A String", # An MD5 checksum for the content of this file. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files. 1041 "iconLink": "A String", # A link to the file's icon. 1042 "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. 1043 "embedLink": "A String", # A link for embedding the file. 1044 "alternateLink": "A String", # A link for opening the file in a relevant Google editor or viewer. 1045 "title": "A String", # The title of this file. Note that for immutable items such as the top level folders of Team Drives, My Drive root folder, and Application Data folder the title is constant. 1046 "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. 1047 "thumbnail": { # A thumbnail for the file. This will only be used if Drive cannot generate a standard thumbnail. 1048 "mimeType": "A String", # The MIME type of the thumbnail. 1049 "image": "A String", # The URL-safe Base64 encoded bytes of the thumbnail image. It should conform to RFC 4648 section 5. 1050 }, 1051 "downloadUrl": "A String", 1052 "userPermission": { # A permission for a file. # The permissions for the authenticated user on this file. 1053 "withLink": True or False, # Whether the link is required for this permission. 1054 "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. 1055 "name": "A String", # The name for this permission. 1056 "teamDrivePermissionDetails": [ # Details of whether the permissions on this Team Drive item are inherited or directly on this item. This is an output-only field which is present only for Team Drive items. 1057 { 1058 "inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field and is only populated for members of the Team Drive. 1059 "role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible: 1060 # - organizer 1061 # - reader 1062 # - writer 1063 "additionalRoles": [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future. 1064 "A String", 1065 ], 1066 "teamDrivePermissionType": "A String", # The Team Drive permission type for this user. While new values may be added in future, the following are currently possible: 1067 # - file 1068 # - member 1069 "inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field. 1070 }, 1071 ], 1072 "deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions. 1073 "kind": "drive#permission", # This is always drive#permission. 1074 "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. 1075 "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. 1076 "authKey": "A String", # The authkey parameter required for this permission. 1077 "etag": "A String", # The ETag of the permission. 1078 "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. 1079 "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: 1080 # - They can only be set on user and group permissions 1081 # - The date must be in the future 1082 # - The date cannot be more than a year in the future 1083 # - The date can only be set on drive.permissions.update requests 1084 "role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: 1085 # - organizer 1086 # - owner 1087 # - reader 1088 # - writer 1089 "type": "A String", # The account type. Allowed values are: 1090 # - user 1091 # - group 1092 # - domain 1093 # - anyone 1094 "additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future. 1095 "A String", 1096 ], 1097 "selfLink": "A String", # A link back to this permission. 1098 "photoLink": "A String", # A link to the profile photo, if available. 1099 }, 1100 "spaces": [ # The list of spaces which contain the file. Supported values are 'drive', 'appDataFolder' and 'photos'. 1101 "A String", 1102 ], 1103 "shareable": True or False, # Deprecated: use capabilities/canShare. 1104 "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 Drive. 1105 "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 Drive; it is not populated for Google Docs or shortcut files. 1106 "hasAugmentedPermissions": True or False, # Whether any users are granted file access directly on this file. This field is only populated for Team Drive files. 1107 "headRevisionId": "A String", # The ID of the file's head revision. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files. 1108 "selfLink": "A String", # A link back to this file. 1109 "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. 1110 }</pre> 1111 </div> 1112 1113 <div class="method"> 1114 <code class="details" id="get_media">get_media(fileId, projection=None, revisionId=None, supportsTeamDrives=None, acknowledgeAbuse=None, updateViewedDate=None)</code> 1115 <pre>Gets a file's metadata by ID. 1116 1117 Args: 1118 fileId: string, The ID for the file in question. (required) 1119 projection: string, This parameter is deprecated and has no function. 1120 Allowed values 1121 BASIC - Deprecated 1122 FULL - Deprecated 1123 revisionId: string, Specifies the Revision ID that should be downloaded. Ignored unless alt=media is specified. 1124 supportsTeamDrives: boolean, Whether the requesting application supports Team Drives. 1125 acknowledgeAbuse: boolean, Whether the user is acknowledging the risk of downloading known malware or other abusive files. 1126 updateViewedDate: boolean, Deprecated: Use files.update with modifiedDateBehavior=noChange, updateViewedDate=true and an empty request body. 1127 1128 Returns: 1129 The media object as a string. 1130 1131 </pre> 1132 </div> 1133 1134 <div class="method"> 1135 <code class="details" id="insert">insert(body=None, supportsTeamDrives=None, media_body=None, ocrLanguage=None, ocr=None, pinned=None, visibility=None, timedTextTrackName=None, convert=None, useContentAsIndexableText=None, media_mime_type=None, timedTextLanguage=None)</code> 1136 <pre>Insert a new file. 1137 1138 Args: 1139 body: object, The request body. 1140 The object takes the form of: 1141 1142 { # The metadata for a file. 1143 "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. 1144 "lastViewedByMeDate": "A String", # Last time this file was viewed by the user (formatted RFC 3339 timestamp). 1145 "trashedDate": "A String", # The time that the item was trashed (formatted RFC 3339 timestamp). Only populated for Team Drive files. 1146 "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. 1147 "appDataContents": True or False, # Whether this file is in the Application Data folder. 1148 "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. 1149 "labels": { # A group of labels for the file. 1150 "restricted": True or False, # Whether viewers and commenters are prevented from downloading, printing, and copying this file. 1151 "modified": True or False, # Whether the file has been modified by this user. 1152 "trashed": True or False, # Whether this file has been trashed. This label applies to all users accessing the file; however, only owners are allowed to see and untrash files. 1153 "hidden": True or False, # Deprecated. 1154 "starred": True or False, # Whether this file is starred by the user. 1155 "viewed": True or False, # Whether this file has been viewed by this user. 1156 }, 1157 "indexableText": { # Indexable text attributes for the file (can only be written) 1158 "text": "A String", # The text to be indexed for this file. 1159 }, 1160 "thumbnailVersion": "A String", # The thumbnail version for use in thumbnail cache invalidation. 1161 "explicitlyTrashed": True or False, # Whether this file has been explicitly trashed, as opposed to recursively trashed. 1162 "isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app. 1163 "lastModifyingUserName": "A String", # Name of the last user to modify this file. 1164 "writersCanShare": True or False, # Whether writers can share the document with other users. Not populated for Team Drive files. 1165 "owners": [ # The owner(s) of this file. Not populated for Team Drive files. 1166 { # Information about a Drive user. 1167 "picture": { # The user's profile picture. 1168 "url": "A String", # A URL that points to a profile picture of this user. 1169 }, 1170 "kind": "drive#user", # This is always drive#user. 1171 "displayName": "A String", # A plain text displayable name for this user. 1172 "permissionId": "A String", # The user's ID as visible in the permissions collection. 1173 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. 1174 "emailAddress": "A String", # The email address of the user. 1175 }, 1176 ], 1177 "ownedByMe": True or False, # Whether the file is owned by the current user. Not populated for Team Drive files. 1178 "id": "A String", # The ID of the file. 1179 "sharingUser": { # Information about a Drive user. # User that shared the item with the current user, if available. 1180 "picture": { # The user's profile picture. 1181 "url": "A String", # A URL that points to a profile picture of this user. 1182 }, 1183 "kind": "drive#user", # This is always drive#user. 1184 "displayName": "A String", # A plain text displayable name for this user. 1185 "permissionId": "A String", # The user's ID as visible in the permissions collection. 1186 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. 1187 "emailAddress": "A String", # The email address of the user. 1188 }, 1189 "trashingUser": { # Information about a Drive user. # If the file has been explicitly trashed, the user who trashed it. Only populated for Team Drive files. 1190 "picture": { # The user's profile picture. 1191 "url": "A String", # A URL that points to a profile picture of this user. 1192 }, 1193 "kind": "drive#user", # This is always drive#user. 1194 "displayName": "A String", # A plain text displayable name for this user. 1195 "permissionId": "A String", # The user's ID as visible in the permissions collection. 1196 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. 1197 "emailAddress": "A String", # The email address of the user. 1198 }, 1199 "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. 1200 "lastModifyingUser": { # Information about a Drive user. # The last user to modify this file. 1201 "picture": { # The user's profile picture. 1202 "url": "A String", # A URL that points to a profile picture of this user. 1203 }, 1204 "kind": "drive#user", # This is always drive#user. 1205 "displayName": "A String", # A plain text displayable name for this user. 1206 "permissionId": "A String", # The user's ID as visible in the permissions collection. 1207 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. 1208 "emailAddress": "A String", # The email address of the user. 1209 }, 1210 "copyable": True or False, # Deprecated: use capabilities/canCopy. 1211 "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 Team Drive files. 1212 "markedViewedByMeDate": "A String", # Deprecated. 1213 "ownerNames": [ # Name(s) of the owner(s) of this file. Not populated for Team Drive files. 1214 "A String", 1215 ], 1216 "capabilities": { # Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take. 1217 "canReadRevisions": True or False, # Whether the current user can read the revisions resource of this file. For a Team Drive item, whether revisions of non-folder descendants of this item, or this item itself if it is not a folder, can be read. 1218 "canTrash": True or False, # Whether the current user can move this file to trash. 1219 "canCopy": True or False, # Whether the current user can copy this file. For a Team Drive item, whether the current user can copy non-folder descendants of this item, or this item itself if it is not a folder. 1220 "canShare": True or False, # Whether the current user can modify the sharing settings for this file. 1221 "canDelete": True or False, # Whether the current user can delete this file. 1222 "canMoveTeamDriveItem": True or False, # Whether the current user can move this Team Drive item by changing its parent. Note that a request to change the parent for this item may still fail depending on the new parent that is being added. Only populated for Team Drive files. 1223 "canRename": True or False, # Whether the current user can rename this file. 1224 "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. 1225 "canChangeRestrictedDownload": True or False, # Whether the current user can change the restricted download label of this file. 1226 "canMoveItemIntoTeamDrive": True or False, # Whether the current user can move this item into a Team Drive. If the item is in a Team Drive, this field is equivalent to canMoveTeamDriveItem. 1227 "canDownload": True or False, # Whether the current user can download this file. 1228 "canComment": True or False, # Whether the current user can comment on this file. 1229 "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. 1230 "canReadTeamDrive": True or False, # Whether the current user can read the Team Drive to which this file belongs. Only populated for Team Drive files. 1231 "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. 1232 "canEdit": True or False, # Whether the current user can edit this file. 1233 "canUntrash": True or False, # Whether the current user can restore this file from trash. 1234 }, 1235 "sharedWithMeDate": "A String", # Time at which this file was shared with the user (formatted RFC 3339 timestamp). 1236 "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. 1237 "etag": "A String", # ETag of the file. 1238 "parents": [ # Collection of parent folders which contain this file. 1239 # Setting this field will put the file in all of the provided folders. On insert, if no folders are provided, the file will be placed in the default root folder. 1240 { # A reference to a file's parent. 1241 "selfLink": "A String", # A link back to this reference. 1242 "kind": "drive#parentReference", # This is always drive#parentReference. 1243 "id": "A String", # The ID of the parent. 1244 "isRoot": True or False, # Whether or not the parent is the root folder. 1245 "parentLink": "A String", # A link to the parent. 1246 }, 1247 ], 1248 "exportLinks": { # Links for exporting Google Docs to specific formats. 1249 "a_key": "A String", # A mapping from export format to URL 1250 }, 1251 "shared": True or False, # Whether the file has been shared. Not populated for Team Drive files. 1252 "permissions": [ # The list of permissions for users with access to this file. Not populated for Team Drive files. 1253 { # A permission for a file. 1254 "withLink": True or False, # Whether the link is required for this permission. 1255 "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. 1256 "name": "A String", # The name for this permission. 1257 "teamDrivePermissionDetails": [ # Details of whether the permissions on this Team Drive item are inherited or directly on this item. This is an output-only field which is present only for Team Drive items. 1258 { 1259 "inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field and is only populated for members of the Team Drive. 1260 "role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible: 1261 # - organizer 1262 # - reader 1263 # - writer 1264 "additionalRoles": [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future. 1265 "A String", 1266 ], 1267 "teamDrivePermissionType": "A String", # The Team Drive permission type for this user. While new values may be added in future, the following are currently possible: 1268 # - file 1269 # - member 1270 "inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field. 1271 }, 1272 ], 1273 "deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions. 1274 "kind": "drive#permission", # This is always drive#permission. 1275 "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. 1276 "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. 1277 "authKey": "A String", # The authkey parameter required for this permission. 1278 "etag": "A String", # The ETag of the permission. 1279 "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. 1280 "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: 1281 # - They can only be set on user and group permissions 1282 # - The date must be in the future 1283 # - The date cannot be more than a year in the future 1284 # - The date can only be set on drive.permissions.update requests 1285 "role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: 1286 # - organizer 1287 # - owner 1288 # - reader 1289 # - writer 1290 "type": "A String", # The account type. Allowed values are: 1291 # - user 1292 # - group 1293 # - domain 1294 # - anyone 1295 "additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future. 1296 "A String", 1297 ], 1298 "selfLink": "A String", # A link back to this permission. 1299 "photoLink": "A String", # A link to the profile photo, if available. 1300 }, 1301 ], 1302 "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 Drive; it is not populated for Google Docs or shortcut files. 1303 "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. 1304 "a_key": "A String", 1305 }, 1306 "canReadRevisions": True or False, # Deprecated: use capabilities/canReadRevisions. 1307 "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. 1308 "exposureBias": 3.14, # The exposure bias of the photo (APEX value). 1309 "exposureTime": 3.14, # The length of the exposure, in seconds. 1310 "cameraMake": "A String", # The make of the camera used to create the photo. 1311 "maxApertureValue": 3.14, # The smallest f-number of the lens at the focal length used to create the photo (APEX value). 1312 "isoSpeed": 42, # The ISO speed used to create the photo. 1313 "focalLength": 3.14, # The focal length used to create the photo, in millimeters. 1314 "exposureMode": "A String", # The exposure mode used to create the photo. 1315 "colorSpace": "A String", # The color space of the photo. 1316 "location": { # Geographic location information stored in the image. 1317 "latitude": 3.14, # The latitude stored in the image. 1318 "altitude": 3.14, # The altitude stored in the image. 1319 "longitude": 3.14, # The longitude stored in the image. 1320 }, 1321 "subjectDistance": 42, # The distance to the subject of the photo, in meters. 1322 "height": 42, # The height of the image in pixels. 1323 "lens": "A String", # The lens used to create the photo. 1324 "date": "A String", # The date and time the photo was taken (EXIF format timestamp). 1325 "width": 42, # The width of the image in pixels. 1326 "meteringMode": "A String", # The metering mode used to create the photo. 1327 "flashUsed": True or False, # Whether a flash was used to create the photo. 1328 "aperture": 3.14, # The aperture used to create the photo (f-number). 1329 "rotation": 42, # The rotation in clockwise degrees from the image's original orientation. 1330 "sensor": "A String", # The type of sensor used to create the photo. 1331 "whiteBalance": "A String", # The white balance mode used to create the photo. 1332 "cameraModel": "A String", # The model of the camera used to create the photo. 1333 }, 1334 "description": "A String", # A short description of the file. 1335 "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. 1336 "videoMediaMetadata": { # Metadata about video media. This will only be present for video types. 1337 "width": 42, # The width of the video in pixels. 1338 "durationMillis": "A String", # The duration of the video in milliseconds. 1339 "height": 42, # The height of the video in pixels. 1340 }, 1341 "editable": True or False, # Deprecated: use capabilities/canEdit. 1342 "kind": "drive#file", # The type of file. This is always drive#file. 1343 "canComment": True or False, # Deprecated: use capabilities/canComment. 1344 "quotaBytesUsed": "A String", # The number of quota bytes used by this file. 1345 "fileSize": "A String", # The size of the file in bytes. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files. 1346 "createdDate": "A String", # Create time for this file (formatted RFC 3339 timestamp). 1347 "teamDriveId": "A String", # ID of the Team Drive the file resides in. 1348 "properties": [ # The list of properties. 1349 { # A key-value pair attached to a file that is either public or private to an application. 1350 # The following limits apply to file properties: 1351 # - Maximum of 100 properties total per file 1352 # - Maximum of 30 private properties per app 1353 # - Maximum of 30 public properties 1354 # - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property. 1355 "kind": "drive#property", # This is always drive#property. 1356 "value": "A String", # The value of this property. 1357 "etag": "A String", # ETag of the property. 1358 "visibility": "A String", # The visibility of this property. 1359 "key": "A String", # The key of this property. 1360 "selfLink": "A String", # The link back to this property. 1361 }, 1362 ], 1363 "md5Checksum": "A String", # An MD5 checksum for the content of this file. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files. 1364 "iconLink": "A String", # A link to the file's icon. 1365 "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. 1366 "embedLink": "A String", # A link for embedding the file. 1367 "alternateLink": "A String", # A link for opening the file in a relevant Google editor or viewer. 1368 "title": "A String", # The title of this file. Note that for immutable items such as the top level folders of Team Drives, My Drive root folder, and Application Data folder the title is constant. 1369 "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. 1370 "thumbnail": { # A thumbnail for the file. This will only be used if Drive cannot generate a standard thumbnail. 1371 "mimeType": "A String", # The MIME type of the thumbnail. 1372 "image": "A String", # The URL-safe Base64 encoded bytes of the thumbnail image. It should conform to RFC 4648 section 5. 1373 }, 1374 "downloadUrl": "A String", 1375 "userPermission": { # A permission for a file. # The permissions for the authenticated user on this file. 1376 "withLink": True or False, # Whether the link is required for this permission. 1377 "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. 1378 "name": "A String", # The name for this permission. 1379 "teamDrivePermissionDetails": [ # Details of whether the permissions on this Team Drive item are inherited or directly on this item. This is an output-only field which is present only for Team Drive items. 1380 { 1381 "inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field and is only populated for members of the Team Drive. 1382 "role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible: 1383 # - organizer 1384 # - reader 1385 # - writer 1386 "additionalRoles": [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future. 1387 "A String", 1388 ], 1389 "teamDrivePermissionType": "A String", # The Team Drive permission type for this user. While new values may be added in future, the following are currently possible: 1390 # - file 1391 # - member 1392 "inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field. 1393 }, 1394 ], 1395 "deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions. 1396 "kind": "drive#permission", # This is always drive#permission. 1397 "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. 1398 "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. 1399 "authKey": "A String", # The authkey parameter required for this permission. 1400 "etag": "A String", # The ETag of the permission. 1401 "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. 1402 "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: 1403 # - They can only be set on user and group permissions 1404 # - The date must be in the future 1405 # - The date cannot be more than a year in the future 1406 # - The date can only be set on drive.permissions.update requests 1407 "role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: 1408 # - organizer 1409 # - owner 1410 # - reader 1411 # - writer 1412 "type": "A String", # The account type. Allowed values are: 1413 # - user 1414 # - group 1415 # - domain 1416 # - anyone 1417 "additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future. 1418 "A String", 1419 ], 1420 "selfLink": "A String", # A link back to this permission. 1421 "photoLink": "A String", # A link to the profile photo, if available. 1422 }, 1423 "spaces": [ # The list of spaces which contain the file. Supported values are 'drive', 'appDataFolder' and 'photos'. 1424 "A String", 1425 ], 1426 "shareable": True or False, # Deprecated: use capabilities/canShare. 1427 "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 Drive. 1428 "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 Drive; it is not populated for Google Docs or shortcut files. 1429 "hasAugmentedPermissions": True or False, # Whether any users are granted file access directly on this file. This field is only populated for Team Drive files. 1430 "headRevisionId": "A String", # The ID of the file's head revision. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files. 1431 "selfLink": "A String", # A link back to this file. 1432 "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. 1433 } 1434 1435 supportsTeamDrives: boolean, Whether the requesting application supports Team Drives. 1436 media_body: string, The filename of the media request body, or an instance of a MediaUpload object. 1437 ocrLanguage: string, If ocr is true, hints at the language to use. Valid values are BCP 47 codes. 1438 ocr: boolean, Whether to attempt OCR on .jpg, .png, .gif, or .pdf uploads. 1439 pinned: boolean, Whether to pin the head revision of the uploaded file. A file can have a maximum of 200 pinned revisions. 1440 visibility: string, The visibility of the new file. This parameter is only relevant when convert=false. 1441 Allowed values 1442 DEFAULT - The visibility of the new file is determined by the user's default visibility/sharing policies. 1443 PRIVATE - The new file will be visible to only the owner. 1444 timedTextTrackName: string, The timed text track name. 1445 convert: boolean, Whether to convert this file to the corresponding Google Docs format. 1446 useContentAsIndexableText: boolean, Whether to use the content as indexable text. 1447 media_mime_type: string, The MIME type of the media request body, or an instance of a MediaUpload object. 1448 timedTextLanguage: string, The language of the timed text. 1449 1450 Returns: 1451 An object of the form: 1452 1453 { # The metadata for a file. 1454 "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. 1455 "lastViewedByMeDate": "A String", # Last time this file was viewed by the user (formatted RFC 3339 timestamp). 1456 "trashedDate": "A String", # The time that the item was trashed (formatted RFC 3339 timestamp). Only populated for Team Drive files. 1457 "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. 1458 "appDataContents": True or False, # Whether this file is in the Application Data folder. 1459 "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. 1460 "labels": { # A group of labels for the file. 1461 "restricted": True or False, # Whether viewers and commenters are prevented from downloading, printing, and copying this file. 1462 "modified": True or False, # Whether the file has been modified by this user. 1463 "trashed": True or False, # Whether this file has been trashed. This label applies to all users accessing the file; however, only owners are allowed to see and untrash files. 1464 "hidden": True or False, # Deprecated. 1465 "starred": True or False, # Whether this file is starred by the user. 1466 "viewed": True or False, # Whether this file has been viewed by this user. 1467 }, 1468 "indexableText": { # Indexable text attributes for the file (can only be written) 1469 "text": "A String", # The text to be indexed for this file. 1470 }, 1471 "thumbnailVersion": "A String", # The thumbnail version for use in thumbnail cache invalidation. 1472 "explicitlyTrashed": True or False, # Whether this file has been explicitly trashed, as opposed to recursively trashed. 1473 "isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app. 1474 "lastModifyingUserName": "A String", # Name of the last user to modify this file. 1475 "writersCanShare": True or False, # Whether writers can share the document with other users. Not populated for Team Drive files. 1476 "owners": [ # The owner(s) of this file. Not populated for Team Drive files. 1477 { # Information about a Drive user. 1478 "picture": { # The user's profile picture. 1479 "url": "A String", # A URL that points to a profile picture of this user. 1480 }, 1481 "kind": "drive#user", # This is always drive#user. 1482 "displayName": "A String", # A plain text displayable name for this user. 1483 "permissionId": "A String", # The user's ID as visible in the permissions collection. 1484 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. 1485 "emailAddress": "A String", # The email address of the user. 1486 }, 1487 ], 1488 "ownedByMe": True or False, # Whether the file is owned by the current user. Not populated for Team Drive files. 1489 "id": "A String", # The ID of the file. 1490 "sharingUser": { # Information about a Drive user. # User that shared the item with the current user, if available. 1491 "picture": { # The user's profile picture. 1492 "url": "A String", # A URL that points to a profile picture of this user. 1493 }, 1494 "kind": "drive#user", # This is always drive#user. 1495 "displayName": "A String", # A plain text displayable name for this user. 1496 "permissionId": "A String", # The user's ID as visible in the permissions collection. 1497 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. 1498 "emailAddress": "A String", # The email address of the user. 1499 }, 1500 "trashingUser": { # Information about a Drive user. # If the file has been explicitly trashed, the user who trashed it. Only populated for Team Drive files. 1501 "picture": { # The user's profile picture. 1502 "url": "A String", # A URL that points to a profile picture of this user. 1503 }, 1504 "kind": "drive#user", # This is always drive#user. 1505 "displayName": "A String", # A plain text displayable name for this user. 1506 "permissionId": "A String", # The user's ID as visible in the permissions collection. 1507 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. 1508 "emailAddress": "A String", # The email address of the user. 1509 }, 1510 "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. 1511 "lastModifyingUser": { # Information about a Drive user. # The last user to modify this file. 1512 "picture": { # The user's profile picture. 1513 "url": "A String", # A URL that points to a profile picture of this user. 1514 }, 1515 "kind": "drive#user", # This is always drive#user. 1516 "displayName": "A String", # A plain text displayable name for this user. 1517 "permissionId": "A String", # The user's ID as visible in the permissions collection. 1518 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. 1519 "emailAddress": "A String", # The email address of the user. 1520 }, 1521 "copyable": True or False, # Deprecated: use capabilities/canCopy. 1522 "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 Team Drive files. 1523 "markedViewedByMeDate": "A String", # Deprecated. 1524 "ownerNames": [ # Name(s) of the owner(s) of this file. Not populated for Team Drive files. 1525 "A String", 1526 ], 1527 "capabilities": { # Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take. 1528 "canReadRevisions": True or False, # Whether the current user can read the revisions resource of this file. For a Team Drive item, whether revisions of non-folder descendants of this item, or this item itself if it is not a folder, can be read. 1529 "canTrash": True or False, # Whether the current user can move this file to trash. 1530 "canCopy": True or False, # Whether the current user can copy this file. For a Team Drive item, whether the current user can copy non-folder descendants of this item, or this item itself if it is not a folder. 1531 "canShare": True or False, # Whether the current user can modify the sharing settings for this file. 1532 "canDelete": True or False, # Whether the current user can delete this file. 1533 "canMoveTeamDriveItem": True or False, # Whether the current user can move this Team Drive item by changing its parent. Note that a request to change the parent for this item may still fail depending on the new parent that is being added. Only populated for Team Drive files. 1534 "canRename": True or False, # Whether the current user can rename this file. 1535 "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. 1536 "canChangeRestrictedDownload": True or False, # Whether the current user can change the restricted download label of this file. 1537 "canMoveItemIntoTeamDrive": True or False, # Whether the current user can move this item into a Team Drive. If the item is in a Team Drive, this field is equivalent to canMoveTeamDriveItem. 1538 "canDownload": True or False, # Whether the current user can download this file. 1539 "canComment": True or False, # Whether the current user can comment on this file. 1540 "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. 1541 "canReadTeamDrive": True or False, # Whether the current user can read the Team Drive to which this file belongs. Only populated for Team Drive files. 1542 "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. 1543 "canEdit": True or False, # Whether the current user can edit this file. 1544 "canUntrash": True or False, # Whether the current user can restore this file from trash. 1545 }, 1546 "sharedWithMeDate": "A String", # Time at which this file was shared with the user (formatted RFC 3339 timestamp). 1547 "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. 1548 "etag": "A String", # ETag of the file. 1549 "parents": [ # Collection of parent folders which contain this file. 1550 # Setting this field will put the file in all of the provided folders. On insert, if no folders are provided, the file will be placed in the default root folder. 1551 { # A reference to a file's parent. 1552 "selfLink": "A String", # A link back to this reference. 1553 "kind": "drive#parentReference", # This is always drive#parentReference. 1554 "id": "A String", # The ID of the parent. 1555 "isRoot": True or False, # Whether or not the parent is the root folder. 1556 "parentLink": "A String", # A link to the parent. 1557 }, 1558 ], 1559 "exportLinks": { # Links for exporting Google Docs to specific formats. 1560 "a_key": "A String", # A mapping from export format to URL 1561 }, 1562 "shared": True or False, # Whether the file has been shared. Not populated for Team Drive files. 1563 "permissions": [ # The list of permissions for users with access to this file. Not populated for Team Drive files. 1564 { # A permission for a file. 1565 "withLink": True or False, # Whether the link is required for this permission. 1566 "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. 1567 "name": "A String", # The name for this permission. 1568 "teamDrivePermissionDetails": [ # Details of whether the permissions on this Team Drive item are inherited or directly on this item. This is an output-only field which is present only for Team Drive items. 1569 { 1570 "inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field and is only populated for members of the Team Drive. 1571 "role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible: 1572 # - organizer 1573 # - reader 1574 # - writer 1575 "additionalRoles": [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future. 1576 "A String", 1577 ], 1578 "teamDrivePermissionType": "A String", # The Team Drive permission type for this user. While new values may be added in future, the following are currently possible: 1579 # - file 1580 # - member 1581 "inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field. 1582 }, 1583 ], 1584 "deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions. 1585 "kind": "drive#permission", # This is always drive#permission. 1586 "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. 1587 "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. 1588 "authKey": "A String", # The authkey parameter required for this permission. 1589 "etag": "A String", # The ETag of the permission. 1590 "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. 1591 "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: 1592 # - They can only be set on user and group permissions 1593 # - The date must be in the future 1594 # - The date cannot be more than a year in the future 1595 # - The date can only be set on drive.permissions.update requests 1596 "role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: 1597 # - organizer 1598 # - owner 1599 # - reader 1600 # - writer 1601 "type": "A String", # The account type. Allowed values are: 1602 # - user 1603 # - group 1604 # - domain 1605 # - anyone 1606 "additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future. 1607 "A String", 1608 ], 1609 "selfLink": "A String", # A link back to this permission. 1610 "photoLink": "A String", # A link to the profile photo, if available. 1611 }, 1612 ], 1613 "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 Drive; it is not populated for Google Docs or shortcut files. 1614 "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. 1615 "a_key": "A String", 1616 }, 1617 "canReadRevisions": True or False, # Deprecated: use capabilities/canReadRevisions. 1618 "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. 1619 "exposureBias": 3.14, # The exposure bias of the photo (APEX value). 1620 "exposureTime": 3.14, # The length of the exposure, in seconds. 1621 "cameraMake": "A String", # The make of the camera used to create the photo. 1622 "maxApertureValue": 3.14, # The smallest f-number of the lens at the focal length used to create the photo (APEX value). 1623 "isoSpeed": 42, # The ISO speed used to create the photo. 1624 "focalLength": 3.14, # The focal length used to create the photo, in millimeters. 1625 "exposureMode": "A String", # The exposure mode used to create the photo. 1626 "colorSpace": "A String", # The color space of the photo. 1627 "location": { # Geographic location information stored in the image. 1628 "latitude": 3.14, # The latitude stored in the image. 1629 "altitude": 3.14, # The altitude stored in the image. 1630 "longitude": 3.14, # The longitude stored in the image. 1631 }, 1632 "subjectDistance": 42, # The distance to the subject of the photo, in meters. 1633 "height": 42, # The height of the image in pixels. 1634 "lens": "A String", # The lens used to create the photo. 1635 "date": "A String", # The date and time the photo was taken (EXIF format timestamp). 1636 "width": 42, # The width of the image in pixels. 1637 "meteringMode": "A String", # The metering mode used to create the photo. 1638 "flashUsed": True or False, # Whether a flash was used to create the photo. 1639 "aperture": 3.14, # The aperture used to create the photo (f-number). 1640 "rotation": 42, # The rotation in clockwise degrees from the image's original orientation. 1641 "sensor": "A String", # The type of sensor used to create the photo. 1642 "whiteBalance": "A String", # The white balance mode used to create the photo. 1643 "cameraModel": "A String", # The model of the camera used to create the photo. 1644 }, 1645 "description": "A String", # A short description of the file. 1646 "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. 1647 "videoMediaMetadata": { # Metadata about video media. This will only be present for video types. 1648 "width": 42, # The width of the video in pixels. 1649 "durationMillis": "A String", # The duration of the video in milliseconds. 1650 "height": 42, # The height of the video in pixels. 1651 }, 1652 "editable": True or False, # Deprecated: use capabilities/canEdit. 1653 "kind": "drive#file", # The type of file. This is always drive#file. 1654 "canComment": True or False, # Deprecated: use capabilities/canComment. 1655 "quotaBytesUsed": "A String", # The number of quota bytes used by this file. 1656 "fileSize": "A String", # The size of the file in bytes. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files. 1657 "createdDate": "A String", # Create time for this file (formatted RFC 3339 timestamp). 1658 "teamDriveId": "A String", # ID of the Team Drive the file resides in. 1659 "properties": [ # The list of properties. 1660 { # A key-value pair attached to a file that is either public or private to an application. 1661 # The following limits apply to file properties: 1662 # - Maximum of 100 properties total per file 1663 # - Maximum of 30 private properties per app 1664 # - Maximum of 30 public properties 1665 # - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property. 1666 "kind": "drive#property", # This is always drive#property. 1667 "value": "A String", # The value of this property. 1668 "etag": "A String", # ETag of the property. 1669 "visibility": "A String", # The visibility of this property. 1670 "key": "A String", # The key of this property. 1671 "selfLink": "A String", # The link back to this property. 1672 }, 1673 ], 1674 "md5Checksum": "A String", # An MD5 checksum for the content of this file. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files. 1675 "iconLink": "A String", # A link to the file's icon. 1676 "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. 1677 "embedLink": "A String", # A link for embedding the file. 1678 "alternateLink": "A String", # A link for opening the file in a relevant Google editor or viewer. 1679 "title": "A String", # The title of this file. Note that for immutable items such as the top level folders of Team Drives, My Drive root folder, and Application Data folder the title is constant. 1680 "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. 1681 "thumbnail": { # A thumbnail for the file. This will only be used if Drive cannot generate a standard thumbnail. 1682 "mimeType": "A String", # The MIME type of the thumbnail. 1683 "image": "A String", # The URL-safe Base64 encoded bytes of the thumbnail image. It should conform to RFC 4648 section 5. 1684 }, 1685 "downloadUrl": "A String", 1686 "userPermission": { # A permission for a file. # The permissions for the authenticated user on this file. 1687 "withLink": True or False, # Whether the link is required for this permission. 1688 "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. 1689 "name": "A String", # The name for this permission. 1690 "teamDrivePermissionDetails": [ # Details of whether the permissions on this Team Drive item are inherited or directly on this item. This is an output-only field which is present only for Team Drive items. 1691 { 1692 "inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field and is only populated for members of the Team Drive. 1693 "role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible: 1694 # - organizer 1695 # - reader 1696 # - writer 1697 "additionalRoles": [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future. 1698 "A String", 1699 ], 1700 "teamDrivePermissionType": "A String", # The Team Drive permission type for this user. While new values may be added in future, the following are currently possible: 1701 # - file 1702 # - member 1703 "inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field. 1704 }, 1705 ], 1706 "deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions. 1707 "kind": "drive#permission", # This is always drive#permission. 1708 "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. 1709 "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. 1710 "authKey": "A String", # The authkey parameter required for this permission. 1711 "etag": "A String", # The ETag of the permission. 1712 "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. 1713 "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: 1714 # - They can only be set on user and group permissions 1715 # - The date must be in the future 1716 # - The date cannot be more than a year in the future 1717 # - The date can only be set on drive.permissions.update requests 1718 "role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: 1719 # - organizer 1720 # - owner 1721 # - reader 1722 # - writer 1723 "type": "A String", # The account type. Allowed values are: 1724 # - user 1725 # - group 1726 # - domain 1727 # - anyone 1728 "additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future. 1729 "A String", 1730 ], 1731 "selfLink": "A String", # A link back to this permission. 1732 "photoLink": "A String", # A link to the profile photo, if available. 1733 }, 1734 "spaces": [ # The list of spaces which contain the file. Supported values are 'drive', 'appDataFolder' and 'photos'. 1735 "A String", 1736 ], 1737 "shareable": True or False, # Deprecated: use capabilities/canShare. 1738 "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 Drive. 1739 "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 Drive; it is not populated for Google Docs or shortcut files. 1740 "hasAugmentedPermissions": True or False, # Whether any users are granted file access directly on this file. This field is only populated for Team Drive files. 1741 "headRevisionId": "A String", # The ID of the file's head revision. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files. 1742 "selfLink": "A String", # A link back to this file. 1743 "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. 1744 }</pre> 1745 </div> 1746 1747 <div class="method"> 1748 <code class="details" id="list">list(orderBy=None, projection=None, supportsTeamDrives=None, spaces=None, pageToken=None, corpus=None, maxResults=None, teamDriveId=None, includeTeamDriveItems=None, corpora=None, q=None)</code> 1749 <pre>Lists the user's files. 1750 1751 Args: 1752 orderBy: string, A comma-separated list of sort keys. Valid keys are 'createdDate', 'folder', 'lastViewedByMeDate', 'modifiedByMeDate', 'modifiedDate', 'quotaBytesUsed', 'recency', 'sharedWithMeDate', 'starred', and 'title'. Each key sorts ascending by default, but may be reversed with the 'desc' modifier. Example usage: ?orderBy=folder,modifiedDate desc,title. Please note that there is a current limitation for users with approximately one million files in which the requested sort order is ignored. 1753 projection: string, This parameter is deprecated and has no function. 1754 Allowed values 1755 BASIC - Deprecated 1756 FULL - Deprecated 1757 supportsTeamDrives: boolean, Whether the requesting application supports Team Drives. 1758 spaces: string, A comma-separated list of spaces to query. Supported values are 'drive', 'appDataFolder' and 'photos'. 1759 pageToken: string, Page token for files. 1760 corpus: string, The body of items (files/documents) to which the query applies. Deprecated: use 'corpora' instead. 1761 Allowed values 1762 DEFAULT - The items that the user has accessed. 1763 DOMAIN - Items shared to the user's domain. 1764 maxResults: integer, The maximum number of files to return per page. Partial or empty result pages are possible even before the end of the files list has been reached. 1765 teamDriveId: string, ID of Team Drive to search. 1766 includeTeamDriveItems: boolean, Whether Team Drive items should be included in results. 1767 corpora: string, Comma-separated list of bodies of items (files/documents) to which the query applies. Supported bodies are 'default', 'domain', 'teamDrive' and 'allTeamDrives'. 'allTeamDrives' must be combined with 'default'; all other values must be used in isolation. Prefer 'default' or 'teamDrive' to 'allTeamDrives' for efficiency. 1768 q: string, Query string for searching files. 1769 1770 Returns: 1771 An object of the form: 1772 1773 { # A list of files. 1774 "incompleteSearch": True or False, # Whether the search process was incomplete. If true, then some search results may be missing, since all documents were not searched. This may occur when searching multiple Team Drives with the "default,allTeamDrives" corpora, but all corpora could not be searched. When this happens, it is suggested that clients narrow their query by choosing a different corpus such as "default" or "teamDrive". 1775 "nextPageToken": "A String", # The page token for the next page of files. This will be absent if the end of the files list has been reached. If the token is rejected for any reason, it should be discarded, and pagination should be restarted from the first page of results. 1776 "kind": "drive#fileList", # This is always drive#fileList. 1777 "items": [ # The list of files. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched. 1778 { # The metadata for a file. 1779 "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. 1780 "lastViewedByMeDate": "A String", # Last time this file was viewed by the user (formatted RFC 3339 timestamp). 1781 "trashedDate": "A String", # The time that the item was trashed (formatted RFC 3339 timestamp). Only populated for Team Drive files. 1782 "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. 1783 "appDataContents": True or False, # Whether this file is in the Application Data folder. 1784 "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. 1785 "labels": { # A group of labels for the file. 1786 "restricted": True or False, # Whether viewers and commenters are prevented from downloading, printing, and copying this file. 1787 "modified": True or False, # Whether the file has been modified by this user. 1788 "trashed": True or False, # Whether this file has been trashed. This label applies to all users accessing the file; however, only owners are allowed to see and untrash files. 1789 "hidden": True or False, # Deprecated. 1790 "starred": True or False, # Whether this file is starred by the user. 1791 "viewed": True or False, # Whether this file has been viewed by this user. 1792 }, 1793 "indexableText": { # Indexable text attributes for the file (can only be written) 1794 "text": "A String", # The text to be indexed for this file. 1795 }, 1796 "thumbnailVersion": "A String", # The thumbnail version for use in thumbnail cache invalidation. 1797 "explicitlyTrashed": True or False, # Whether this file has been explicitly trashed, as opposed to recursively trashed. 1798 "isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app. 1799 "lastModifyingUserName": "A String", # Name of the last user to modify this file. 1800 "writersCanShare": True or False, # Whether writers can share the document with other users. Not populated for Team Drive files. 1801 "owners": [ # The owner(s) of this file. Not populated for Team Drive files. 1802 { # Information about a Drive user. 1803 "picture": { # The user's profile picture. 1804 "url": "A String", # A URL that points to a profile picture of this user. 1805 }, 1806 "kind": "drive#user", # This is always drive#user. 1807 "displayName": "A String", # A plain text displayable name for this user. 1808 "permissionId": "A String", # The user's ID as visible in the permissions collection. 1809 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. 1810 "emailAddress": "A String", # The email address of the user. 1811 }, 1812 ], 1813 "ownedByMe": True or False, # Whether the file is owned by the current user. Not populated for Team Drive files. 1814 "id": "A String", # The ID of the file. 1815 "sharingUser": { # Information about a Drive user. # User that shared the item with the current user, if available. 1816 "picture": { # The user's profile picture. 1817 "url": "A String", # A URL that points to a profile picture of this user. 1818 }, 1819 "kind": "drive#user", # This is always drive#user. 1820 "displayName": "A String", # A plain text displayable name for this user. 1821 "permissionId": "A String", # The user's ID as visible in the permissions collection. 1822 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. 1823 "emailAddress": "A String", # The email address of the user. 1824 }, 1825 "trashingUser": { # Information about a Drive user. # If the file has been explicitly trashed, the user who trashed it. Only populated for Team Drive files. 1826 "picture": { # The user's profile picture. 1827 "url": "A String", # A URL that points to a profile picture of this user. 1828 }, 1829 "kind": "drive#user", # This is always drive#user. 1830 "displayName": "A String", # A plain text displayable name for this user. 1831 "permissionId": "A String", # The user's ID as visible in the permissions collection. 1832 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. 1833 "emailAddress": "A String", # The email address of the user. 1834 }, 1835 "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. 1836 "lastModifyingUser": { # Information about a Drive user. # The last user to modify this file. 1837 "picture": { # The user's profile picture. 1838 "url": "A String", # A URL that points to a profile picture of this user. 1839 }, 1840 "kind": "drive#user", # This is always drive#user. 1841 "displayName": "A String", # A plain text displayable name for this user. 1842 "permissionId": "A String", # The user's ID as visible in the permissions collection. 1843 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. 1844 "emailAddress": "A String", # The email address of the user. 1845 }, 1846 "copyable": True or False, # Deprecated: use capabilities/canCopy. 1847 "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 Team Drive files. 1848 "markedViewedByMeDate": "A String", # Deprecated. 1849 "ownerNames": [ # Name(s) of the owner(s) of this file. Not populated for Team Drive files. 1850 "A String", 1851 ], 1852 "capabilities": { # Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take. 1853 "canReadRevisions": True or False, # Whether the current user can read the revisions resource of this file. For a Team Drive item, whether revisions of non-folder descendants of this item, or this item itself if it is not a folder, can be read. 1854 "canTrash": True or False, # Whether the current user can move this file to trash. 1855 "canCopy": True or False, # Whether the current user can copy this file. For a Team Drive item, whether the current user can copy non-folder descendants of this item, or this item itself if it is not a folder. 1856 "canShare": True or False, # Whether the current user can modify the sharing settings for this file. 1857 "canDelete": True or False, # Whether the current user can delete this file. 1858 "canMoveTeamDriveItem": True or False, # Whether the current user can move this Team Drive item by changing its parent. Note that a request to change the parent for this item may still fail depending on the new parent that is being added. Only populated for Team Drive files. 1859 "canRename": True or False, # Whether the current user can rename this file. 1860 "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. 1861 "canChangeRestrictedDownload": True or False, # Whether the current user can change the restricted download label of this file. 1862 "canMoveItemIntoTeamDrive": True or False, # Whether the current user can move this item into a Team Drive. If the item is in a Team Drive, this field is equivalent to canMoveTeamDriveItem. 1863 "canDownload": True or False, # Whether the current user can download this file. 1864 "canComment": True or False, # Whether the current user can comment on this file. 1865 "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. 1866 "canReadTeamDrive": True or False, # Whether the current user can read the Team Drive to which this file belongs. Only populated for Team Drive files. 1867 "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. 1868 "canEdit": True or False, # Whether the current user can edit this file. 1869 "canUntrash": True or False, # Whether the current user can restore this file from trash. 1870 }, 1871 "sharedWithMeDate": "A String", # Time at which this file was shared with the user (formatted RFC 3339 timestamp). 1872 "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. 1873 "etag": "A String", # ETag of the file. 1874 "parents": [ # Collection of parent folders which contain this file. 1875 # Setting this field will put the file in all of the provided folders. On insert, if no folders are provided, the file will be placed in the default root folder. 1876 { # A reference to a file's parent. 1877 "selfLink": "A String", # A link back to this reference. 1878 "kind": "drive#parentReference", # This is always drive#parentReference. 1879 "id": "A String", # The ID of the parent. 1880 "isRoot": True or False, # Whether or not the parent is the root folder. 1881 "parentLink": "A String", # A link to the parent. 1882 }, 1883 ], 1884 "exportLinks": { # Links for exporting Google Docs to specific formats. 1885 "a_key": "A String", # A mapping from export format to URL 1886 }, 1887 "shared": True or False, # Whether the file has been shared. Not populated for Team Drive files. 1888 "permissions": [ # The list of permissions for users with access to this file. Not populated for Team Drive files. 1889 { # A permission for a file. 1890 "withLink": True or False, # Whether the link is required for this permission. 1891 "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. 1892 "name": "A String", # The name for this permission. 1893 "teamDrivePermissionDetails": [ # Details of whether the permissions on this Team Drive item are inherited or directly on this item. This is an output-only field which is present only for Team Drive items. 1894 { 1895 "inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field and is only populated for members of the Team Drive. 1896 "role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible: 1897 # - organizer 1898 # - reader 1899 # - writer 1900 "additionalRoles": [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future. 1901 "A String", 1902 ], 1903 "teamDrivePermissionType": "A String", # The Team Drive permission type for this user. While new values may be added in future, the following are currently possible: 1904 # - file 1905 # - member 1906 "inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field. 1907 }, 1908 ], 1909 "deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions. 1910 "kind": "drive#permission", # This is always drive#permission. 1911 "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. 1912 "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. 1913 "authKey": "A String", # The authkey parameter required for this permission. 1914 "etag": "A String", # The ETag of the permission. 1915 "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. 1916 "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: 1917 # - They can only be set on user and group permissions 1918 # - The date must be in the future 1919 # - The date cannot be more than a year in the future 1920 # - The date can only be set on drive.permissions.update requests 1921 "role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: 1922 # - organizer 1923 # - owner 1924 # - reader 1925 # - writer 1926 "type": "A String", # The account type. Allowed values are: 1927 # - user 1928 # - group 1929 # - domain 1930 # - anyone 1931 "additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future. 1932 "A String", 1933 ], 1934 "selfLink": "A String", # A link back to this permission. 1935 "photoLink": "A String", # A link to the profile photo, if available. 1936 }, 1937 ], 1938 "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 Drive; it is not populated for Google Docs or shortcut files. 1939 "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. 1940 "a_key": "A String", 1941 }, 1942 "canReadRevisions": True or False, # Deprecated: use capabilities/canReadRevisions. 1943 "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. 1944 "exposureBias": 3.14, # The exposure bias of the photo (APEX value). 1945 "exposureTime": 3.14, # The length of the exposure, in seconds. 1946 "cameraMake": "A String", # The make of the camera used to create the photo. 1947 "maxApertureValue": 3.14, # The smallest f-number of the lens at the focal length used to create the photo (APEX value). 1948 "isoSpeed": 42, # The ISO speed used to create the photo. 1949 "focalLength": 3.14, # The focal length used to create the photo, in millimeters. 1950 "exposureMode": "A String", # The exposure mode used to create the photo. 1951 "colorSpace": "A String", # The color space of the photo. 1952 "location": { # Geographic location information stored in the image. 1953 "latitude": 3.14, # The latitude stored in the image. 1954 "altitude": 3.14, # The altitude stored in the image. 1955 "longitude": 3.14, # The longitude stored in the image. 1956 }, 1957 "subjectDistance": 42, # The distance to the subject of the photo, in meters. 1958 "height": 42, # The height of the image in pixels. 1959 "lens": "A String", # The lens used to create the photo. 1960 "date": "A String", # The date and time the photo was taken (EXIF format timestamp). 1961 "width": 42, # The width of the image in pixels. 1962 "meteringMode": "A String", # The metering mode used to create the photo. 1963 "flashUsed": True or False, # Whether a flash was used to create the photo. 1964 "aperture": 3.14, # The aperture used to create the photo (f-number). 1965 "rotation": 42, # The rotation in clockwise degrees from the image's original orientation. 1966 "sensor": "A String", # The type of sensor used to create the photo. 1967 "whiteBalance": "A String", # The white balance mode used to create the photo. 1968 "cameraModel": "A String", # The model of the camera used to create the photo. 1969 }, 1970 "description": "A String", # A short description of the file. 1971 "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. 1972 "videoMediaMetadata": { # Metadata about video media. This will only be present for video types. 1973 "width": 42, # The width of the video in pixels. 1974 "durationMillis": "A String", # The duration of the video in milliseconds. 1975 "height": 42, # The height of the video in pixels. 1976 }, 1977 "editable": True or False, # Deprecated: use capabilities/canEdit. 1978 "kind": "drive#file", # The type of file. This is always drive#file. 1979 "canComment": True or False, # Deprecated: use capabilities/canComment. 1980 "quotaBytesUsed": "A String", # The number of quota bytes used by this file. 1981 "fileSize": "A String", # The size of the file in bytes. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files. 1982 "createdDate": "A String", # Create time for this file (formatted RFC 3339 timestamp). 1983 "teamDriveId": "A String", # ID of the Team Drive the file resides in. 1984 "properties": [ # The list of properties. 1985 { # A key-value pair attached to a file that is either public or private to an application. 1986 # The following limits apply to file properties: 1987 # - Maximum of 100 properties total per file 1988 # - Maximum of 30 private properties per app 1989 # - Maximum of 30 public properties 1990 # - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property. 1991 "kind": "drive#property", # This is always drive#property. 1992 "value": "A String", # The value of this property. 1993 "etag": "A String", # ETag of the property. 1994 "visibility": "A String", # The visibility of this property. 1995 "key": "A String", # The key of this property. 1996 "selfLink": "A String", # The link back to this property. 1997 }, 1998 ], 1999 "md5Checksum": "A String", # An MD5 checksum for the content of this file. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files. 2000 "iconLink": "A String", # A link to the file's icon. 2001 "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. 2002 "embedLink": "A String", # A link for embedding the file. 2003 "alternateLink": "A String", # A link for opening the file in a relevant Google editor or viewer. 2004 "title": "A String", # The title of this file. Note that for immutable items such as the top level folders of Team Drives, My Drive root folder, and Application Data folder the title is constant. 2005 "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. 2006 "thumbnail": { # A thumbnail for the file. This will only be used if Drive cannot generate a standard thumbnail. 2007 "mimeType": "A String", # The MIME type of the thumbnail. 2008 "image": "A String", # The URL-safe Base64 encoded bytes of the thumbnail image. It should conform to RFC 4648 section 5. 2009 }, 2010 "downloadUrl": "A String", 2011 "userPermission": { # A permission for a file. # The permissions for the authenticated user on this file. 2012 "withLink": True or False, # Whether the link is required for this permission. 2013 "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. 2014 "name": "A String", # The name for this permission. 2015 "teamDrivePermissionDetails": [ # Details of whether the permissions on this Team Drive item are inherited or directly on this item. This is an output-only field which is present only for Team Drive items. 2016 { 2017 "inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field and is only populated for members of the Team Drive. 2018 "role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible: 2019 # - organizer 2020 # - reader 2021 # - writer 2022 "additionalRoles": [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future. 2023 "A String", 2024 ], 2025 "teamDrivePermissionType": "A String", # The Team Drive permission type for this user. While new values may be added in future, the following are currently possible: 2026 # - file 2027 # - member 2028 "inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field. 2029 }, 2030 ], 2031 "deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions. 2032 "kind": "drive#permission", # This is always drive#permission. 2033 "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. 2034 "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. 2035 "authKey": "A String", # The authkey parameter required for this permission. 2036 "etag": "A String", # The ETag of the permission. 2037 "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. 2038 "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: 2039 # - They can only be set on user and group permissions 2040 # - The date must be in the future 2041 # - The date cannot be more than a year in the future 2042 # - The date can only be set on drive.permissions.update requests 2043 "role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: 2044 # - organizer 2045 # - owner 2046 # - reader 2047 # - writer 2048 "type": "A String", # The account type. Allowed values are: 2049 # - user 2050 # - group 2051 # - domain 2052 # - anyone 2053 "additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future. 2054 "A String", 2055 ], 2056 "selfLink": "A String", # A link back to this permission. 2057 "photoLink": "A String", # A link to the profile photo, if available. 2058 }, 2059 "spaces": [ # The list of spaces which contain the file. Supported values are 'drive', 'appDataFolder' and 'photos'. 2060 "A String", 2061 ], 2062 "shareable": True or False, # Deprecated: use capabilities/canShare. 2063 "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 Drive. 2064 "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 Drive; it is not populated for Google Docs or shortcut files. 2065 "hasAugmentedPermissions": True or False, # Whether any users are granted file access directly on this file. This field is only populated for Team Drive files. 2066 "headRevisionId": "A String", # The ID of the file's head revision. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files. 2067 "selfLink": "A String", # A link back to this file. 2068 "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. 2069 }, 2070 ], 2071 "nextLink": "A String", # A link to the next page of files. 2072 "etag": "A String", # The ETag of the list. 2073 "selfLink": "A String", # A link back to this list. 2074 }</pre> 2075 </div> 2076 2077 <div class="method"> 2078 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 2079 <pre>Retrieves the next page of results. 2080 2081 Args: 2082 previous_request: The request for the previous page. (required) 2083 previous_response: The response from the request for the previous page. (required) 2084 2085 Returns: 2086 A request object that you can call 'execute()' on to request the next 2087 page. Returns None if there are no more items in the collection. 2088 </pre> 2089 </div> 2090 2091 <div class="method"> 2092 <code class="details" id="patch">patch(fileId, body, supportsTeamDrives=None, newRevision=None, modifiedDateBehavior=None, pinned=None, ocrLanguage=None, ocr=None, addParents=None, removeParents=None, updateViewedDate=None, timedTextTrackName=None, convert=None, useContentAsIndexableText=None, setModifiedDate=None, timedTextLanguage=None)</code> 2093 <pre>Updates file metadata and/or content. This method supports patch semantics. 2094 2095 Args: 2096 fileId: string, The ID of the file to update. (required) 2097 body: object, The request body. (required) 2098 The object takes the form of: 2099 2100 { # The metadata for a file. 2101 "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. 2102 "lastViewedByMeDate": "A String", # Last time this file was viewed by the user (formatted RFC 3339 timestamp). 2103 "trashedDate": "A String", # The time that the item was trashed (formatted RFC 3339 timestamp). Only populated for Team Drive files. 2104 "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. 2105 "appDataContents": True or False, # Whether this file is in the Application Data folder. 2106 "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. 2107 "labels": { # A group of labels for the file. 2108 "restricted": True or False, # Whether viewers and commenters are prevented from downloading, printing, and copying this file. 2109 "modified": True or False, # Whether the file has been modified by this user. 2110 "trashed": True or False, # Whether this file has been trashed. This label applies to all users accessing the file; however, only owners are allowed to see and untrash files. 2111 "hidden": True or False, # Deprecated. 2112 "starred": True or False, # Whether this file is starred by the user. 2113 "viewed": True or False, # Whether this file has been viewed by this user. 2114 }, 2115 "indexableText": { # Indexable text attributes for the file (can only be written) 2116 "text": "A String", # The text to be indexed for this file. 2117 }, 2118 "thumbnailVersion": "A String", # The thumbnail version for use in thumbnail cache invalidation. 2119 "explicitlyTrashed": True or False, # Whether this file has been explicitly trashed, as opposed to recursively trashed. 2120 "isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app. 2121 "lastModifyingUserName": "A String", # Name of the last user to modify this file. 2122 "writersCanShare": True or False, # Whether writers can share the document with other users. Not populated for Team Drive files. 2123 "owners": [ # The owner(s) of this file. Not populated for Team Drive files. 2124 { # Information about a Drive user. 2125 "picture": { # The user's profile picture. 2126 "url": "A String", # A URL that points to a profile picture of this user. 2127 }, 2128 "kind": "drive#user", # This is always drive#user. 2129 "displayName": "A String", # A plain text displayable name for this user. 2130 "permissionId": "A String", # The user's ID as visible in the permissions collection. 2131 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. 2132 "emailAddress": "A String", # The email address of the user. 2133 }, 2134 ], 2135 "ownedByMe": True or False, # Whether the file is owned by the current user. Not populated for Team Drive files. 2136 "id": "A String", # The ID of the file. 2137 "sharingUser": { # Information about a Drive user. # User that shared the item with the current user, if available. 2138 "picture": { # The user's profile picture. 2139 "url": "A String", # A URL that points to a profile picture of this user. 2140 }, 2141 "kind": "drive#user", # This is always drive#user. 2142 "displayName": "A String", # A plain text displayable name for this user. 2143 "permissionId": "A String", # The user's ID as visible in the permissions collection. 2144 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. 2145 "emailAddress": "A String", # The email address of the user. 2146 }, 2147 "trashingUser": { # Information about a Drive user. # If the file has been explicitly trashed, the user who trashed it. Only populated for Team Drive files. 2148 "picture": { # The user's profile picture. 2149 "url": "A String", # A URL that points to a profile picture of this user. 2150 }, 2151 "kind": "drive#user", # This is always drive#user. 2152 "displayName": "A String", # A plain text displayable name for this user. 2153 "permissionId": "A String", # The user's ID as visible in the permissions collection. 2154 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. 2155 "emailAddress": "A String", # The email address of the user. 2156 }, 2157 "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. 2158 "lastModifyingUser": { # Information about a Drive user. # The last user to modify this file. 2159 "picture": { # The user's profile picture. 2160 "url": "A String", # A URL that points to a profile picture of this user. 2161 }, 2162 "kind": "drive#user", # This is always drive#user. 2163 "displayName": "A String", # A plain text displayable name for this user. 2164 "permissionId": "A String", # The user's ID as visible in the permissions collection. 2165 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. 2166 "emailAddress": "A String", # The email address of the user. 2167 }, 2168 "copyable": True or False, # Deprecated: use capabilities/canCopy. 2169 "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 Team Drive files. 2170 "markedViewedByMeDate": "A String", # Deprecated. 2171 "ownerNames": [ # Name(s) of the owner(s) of this file. Not populated for Team Drive files. 2172 "A String", 2173 ], 2174 "capabilities": { # Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take. 2175 "canReadRevisions": True or False, # Whether the current user can read the revisions resource of this file. For a Team Drive item, whether revisions of non-folder descendants of this item, or this item itself if it is not a folder, can be read. 2176 "canTrash": True or False, # Whether the current user can move this file to trash. 2177 "canCopy": True or False, # Whether the current user can copy this file. For a Team Drive item, whether the current user can copy non-folder descendants of this item, or this item itself if it is not a folder. 2178 "canShare": True or False, # Whether the current user can modify the sharing settings for this file. 2179 "canDelete": True or False, # Whether the current user can delete this file. 2180 "canMoveTeamDriveItem": True or False, # Whether the current user can move this Team Drive item by changing its parent. Note that a request to change the parent for this item may still fail depending on the new parent that is being added. Only populated for Team Drive files. 2181 "canRename": True or False, # Whether the current user can rename this file. 2182 "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. 2183 "canChangeRestrictedDownload": True or False, # Whether the current user can change the restricted download label of this file. 2184 "canMoveItemIntoTeamDrive": True or False, # Whether the current user can move this item into a Team Drive. If the item is in a Team Drive, this field is equivalent to canMoveTeamDriveItem. 2185 "canDownload": True or False, # Whether the current user can download this file. 2186 "canComment": True or False, # Whether the current user can comment on this file. 2187 "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. 2188 "canReadTeamDrive": True or False, # Whether the current user can read the Team Drive to which this file belongs. Only populated for Team Drive files. 2189 "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. 2190 "canEdit": True or False, # Whether the current user can edit this file. 2191 "canUntrash": True or False, # Whether the current user can restore this file from trash. 2192 }, 2193 "sharedWithMeDate": "A String", # Time at which this file was shared with the user (formatted RFC 3339 timestamp). 2194 "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. 2195 "etag": "A String", # ETag of the file. 2196 "parents": [ # Collection of parent folders which contain this file. 2197 # Setting this field will put the file in all of the provided folders. On insert, if no folders are provided, the file will be placed in the default root folder. 2198 { # A reference to a file's parent. 2199 "selfLink": "A String", # A link back to this reference. 2200 "kind": "drive#parentReference", # This is always drive#parentReference. 2201 "id": "A String", # The ID of the parent. 2202 "isRoot": True or False, # Whether or not the parent is the root folder. 2203 "parentLink": "A String", # A link to the parent. 2204 }, 2205 ], 2206 "exportLinks": { # Links for exporting Google Docs to specific formats. 2207 "a_key": "A String", # A mapping from export format to URL 2208 }, 2209 "shared": True or False, # Whether the file has been shared. Not populated for Team Drive files. 2210 "permissions": [ # The list of permissions for users with access to this file. Not populated for Team Drive files. 2211 { # A permission for a file. 2212 "withLink": True or False, # Whether the link is required for this permission. 2213 "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. 2214 "name": "A String", # The name for this permission. 2215 "teamDrivePermissionDetails": [ # Details of whether the permissions on this Team Drive item are inherited or directly on this item. This is an output-only field which is present only for Team Drive items. 2216 { 2217 "inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field and is only populated for members of the Team Drive. 2218 "role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible: 2219 # - organizer 2220 # - reader 2221 # - writer 2222 "additionalRoles": [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future. 2223 "A String", 2224 ], 2225 "teamDrivePermissionType": "A String", # The Team Drive permission type for this user. While new values may be added in future, the following are currently possible: 2226 # - file 2227 # - member 2228 "inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field. 2229 }, 2230 ], 2231 "deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions. 2232 "kind": "drive#permission", # This is always drive#permission. 2233 "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. 2234 "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. 2235 "authKey": "A String", # The authkey parameter required for this permission. 2236 "etag": "A String", # The ETag of the permission. 2237 "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. 2238 "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: 2239 # - They can only be set on user and group permissions 2240 # - The date must be in the future 2241 # - The date cannot be more than a year in the future 2242 # - The date can only be set on drive.permissions.update requests 2243 "role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: 2244 # - organizer 2245 # - owner 2246 # - reader 2247 # - writer 2248 "type": "A String", # The account type. Allowed values are: 2249 # - user 2250 # - group 2251 # - domain 2252 # - anyone 2253 "additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future. 2254 "A String", 2255 ], 2256 "selfLink": "A String", # A link back to this permission. 2257 "photoLink": "A String", # A link to the profile photo, if available. 2258 }, 2259 ], 2260 "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 Drive; it is not populated for Google Docs or shortcut files. 2261 "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. 2262 "a_key": "A String", 2263 }, 2264 "canReadRevisions": True or False, # Deprecated: use capabilities/canReadRevisions. 2265 "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. 2266 "exposureBias": 3.14, # The exposure bias of the photo (APEX value). 2267 "exposureTime": 3.14, # The length of the exposure, in seconds. 2268 "cameraMake": "A String", # The make of the camera used to create the photo. 2269 "maxApertureValue": 3.14, # The smallest f-number of the lens at the focal length used to create the photo (APEX value). 2270 "isoSpeed": 42, # The ISO speed used to create the photo. 2271 "focalLength": 3.14, # The focal length used to create the photo, in millimeters. 2272 "exposureMode": "A String", # The exposure mode used to create the photo. 2273 "colorSpace": "A String", # The color space of the photo. 2274 "location": { # Geographic location information stored in the image. 2275 "latitude": 3.14, # The latitude stored in the image. 2276 "altitude": 3.14, # The altitude stored in the image. 2277 "longitude": 3.14, # The longitude stored in the image. 2278 }, 2279 "subjectDistance": 42, # The distance to the subject of the photo, in meters. 2280 "height": 42, # The height of the image in pixels. 2281 "lens": "A String", # The lens used to create the photo. 2282 "date": "A String", # The date and time the photo was taken (EXIF format timestamp). 2283 "width": 42, # The width of the image in pixels. 2284 "meteringMode": "A String", # The metering mode used to create the photo. 2285 "flashUsed": True or False, # Whether a flash was used to create the photo. 2286 "aperture": 3.14, # The aperture used to create the photo (f-number). 2287 "rotation": 42, # The rotation in clockwise degrees from the image's original orientation. 2288 "sensor": "A String", # The type of sensor used to create the photo. 2289 "whiteBalance": "A String", # The white balance mode used to create the photo. 2290 "cameraModel": "A String", # The model of the camera used to create the photo. 2291 }, 2292 "description": "A String", # A short description of the file. 2293 "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. 2294 "videoMediaMetadata": { # Metadata about video media. This will only be present for video types. 2295 "width": 42, # The width of the video in pixels. 2296 "durationMillis": "A String", # The duration of the video in milliseconds. 2297 "height": 42, # The height of the video in pixels. 2298 }, 2299 "editable": True or False, # Deprecated: use capabilities/canEdit. 2300 "kind": "drive#file", # The type of file. This is always drive#file. 2301 "canComment": True or False, # Deprecated: use capabilities/canComment. 2302 "quotaBytesUsed": "A String", # The number of quota bytes used by this file. 2303 "fileSize": "A String", # The size of the file in bytes. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files. 2304 "createdDate": "A String", # Create time for this file (formatted RFC 3339 timestamp). 2305 "teamDriveId": "A String", # ID of the Team Drive the file resides in. 2306 "properties": [ # The list of properties. 2307 { # A key-value pair attached to a file that is either public or private to an application. 2308 # The following limits apply to file properties: 2309 # - Maximum of 100 properties total per file 2310 # - Maximum of 30 private properties per app 2311 # - Maximum of 30 public properties 2312 # - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property. 2313 "kind": "drive#property", # This is always drive#property. 2314 "value": "A String", # The value of this property. 2315 "etag": "A String", # ETag of the property. 2316 "visibility": "A String", # The visibility of this property. 2317 "key": "A String", # The key of this property. 2318 "selfLink": "A String", # The link back to this property. 2319 }, 2320 ], 2321 "md5Checksum": "A String", # An MD5 checksum for the content of this file. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files. 2322 "iconLink": "A String", # A link to the file's icon. 2323 "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. 2324 "embedLink": "A String", # A link for embedding the file. 2325 "alternateLink": "A String", # A link for opening the file in a relevant Google editor or viewer. 2326 "title": "A String", # The title of this file. Note that for immutable items such as the top level folders of Team Drives, My Drive root folder, and Application Data folder the title is constant. 2327 "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. 2328 "thumbnail": { # A thumbnail for the file. This will only be used if Drive cannot generate a standard thumbnail. 2329 "mimeType": "A String", # The MIME type of the thumbnail. 2330 "image": "A String", # The URL-safe Base64 encoded bytes of the thumbnail image. It should conform to RFC 4648 section 5. 2331 }, 2332 "downloadUrl": "A String", 2333 "userPermission": { # A permission for a file. # The permissions for the authenticated user on this file. 2334 "withLink": True or False, # Whether the link is required for this permission. 2335 "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. 2336 "name": "A String", # The name for this permission. 2337 "teamDrivePermissionDetails": [ # Details of whether the permissions on this Team Drive item are inherited or directly on this item. This is an output-only field which is present only for Team Drive items. 2338 { 2339 "inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field and is only populated for members of the Team Drive. 2340 "role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible: 2341 # - organizer 2342 # - reader 2343 # - writer 2344 "additionalRoles": [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future. 2345 "A String", 2346 ], 2347 "teamDrivePermissionType": "A String", # The Team Drive permission type for this user. While new values may be added in future, the following are currently possible: 2348 # - file 2349 # - member 2350 "inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field. 2351 }, 2352 ], 2353 "deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions. 2354 "kind": "drive#permission", # This is always drive#permission. 2355 "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. 2356 "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. 2357 "authKey": "A String", # The authkey parameter required for this permission. 2358 "etag": "A String", # The ETag of the permission. 2359 "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. 2360 "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: 2361 # - They can only be set on user and group permissions 2362 # - The date must be in the future 2363 # - The date cannot be more than a year in the future 2364 # - The date can only be set on drive.permissions.update requests 2365 "role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: 2366 # - organizer 2367 # - owner 2368 # - reader 2369 # - writer 2370 "type": "A String", # The account type. Allowed values are: 2371 # - user 2372 # - group 2373 # - domain 2374 # - anyone 2375 "additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future. 2376 "A String", 2377 ], 2378 "selfLink": "A String", # A link back to this permission. 2379 "photoLink": "A String", # A link to the profile photo, if available. 2380 }, 2381 "spaces": [ # The list of spaces which contain the file. Supported values are 'drive', 'appDataFolder' and 'photos'. 2382 "A String", 2383 ], 2384 "shareable": True or False, # Deprecated: use capabilities/canShare. 2385 "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 Drive. 2386 "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 Drive; it is not populated for Google Docs or shortcut files. 2387 "hasAugmentedPermissions": True or False, # Whether any users are granted file access directly on this file. This field is only populated for Team Drive files. 2388 "headRevisionId": "A String", # The ID of the file's head revision. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files. 2389 "selfLink": "A String", # A link back to this file. 2390 "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. 2391 } 2392 2393 supportsTeamDrives: boolean, Whether the requesting application supports Team Drives. 2394 newRevision: boolean, Whether a blob upload should create a new revision. If false, the blob data in the current head revision is replaced. If true or not set, a new blob is created as head revision, and previous unpinned revisions are preserved for a short period of time. Pinned revisions are stored indefinitely, using additional storage quota, up to a maximum of 200 revisions. For details on how revisions are retained, see the Drive Help Center. 2395 modifiedDateBehavior: string, Determines the behavior in which modifiedDate is updated. This overrides setModifiedDate. 2396 Allowed values 2397 fromBody - Set modifiedDate to the value provided in the body of the request. No change if no value was provided. 2398 fromBodyIfNeeded - Set modifiedDate to the value provided in the body of the request depending on other contents of the update. 2399 fromBodyOrNow - Set modifiedDate to the value provided in the body of the request, or to the current time if no value was provided. 2400 noChange - Maintain the previous value of modifiedDate. 2401 now - Set modifiedDate to the current time. 2402 nowIfNeeded - Set modifiedDate to the current time depending on contents of the update. 2403 pinned: boolean, Whether to pin the new revision. A file can have a maximum of 200 pinned revisions. 2404 ocrLanguage: string, If ocr is true, hints at the language to use. Valid values are BCP 47 codes. 2405 ocr: boolean, Whether to attempt OCR on .jpg, .png, .gif, or .pdf uploads. 2406 addParents: string, Comma-separated list of parent IDs to add. 2407 removeParents: string, Comma-separated list of parent IDs to remove. 2408 updateViewedDate: boolean, Whether to update the view date after successfully updating the file. 2409 timedTextTrackName: string, The timed text track name. 2410 convert: boolean, This parameter is deprecated and has no function. 2411 useContentAsIndexableText: boolean, Whether to use the content as indexable text. 2412 setModifiedDate: boolean, Whether to set the modified date with the supplied modified date. 2413 timedTextLanguage: string, The language of the timed text. 2414 2415 Returns: 2416 An object of the form: 2417 2418 { # The metadata for a file. 2419 "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. 2420 "lastViewedByMeDate": "A String", # Last time this file was viewed by the user (formatted RFC 3339 timestamp). 2421 "trashedDate": "A String", # The time that the item was trashed (formatted RFC 3339 timestamp). Only populated for Team Drive files. 2422 "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. 2423 "appDataContents": True or False, # Whether this file is in the Application Data folder. 2424 "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. 2425 "labels": { # A group of labels for the file. 2426 "restricted": True or False, # Whether viewers and commenters are prevented from downloading, printing, and copying this file. 2427 "modified": True or False, # Whether the file has been modified by this user. 2428 "trashed": True or False, # Whether this file has been trashed. This label applies to all users accessing the file; however, only owners are allowed to see and untrash files. 2429 "hidden": True or False, # Deprecated. 2430 "starred": True or False, # Whether this file is starred by the user. 2431 "viewed": True or False, # Whether this file has been viewed by this user. 2432 }, 2433 "indexableText": { # Indexable text attributes for the file (can only be written) 2434 "text": "A String", # The text to be indexed for this file. 2435 }, 2436 "thumbnailVersion": "A String", # The thumbnail version for use in thumbnail cache invalidation. 2437 "explicitlyTrashed": True or False, # Whether this file has been explicitly trashed, as opposed to recursively trashed. 2438 "isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app. 2439 "lastModifyingUserName": "A String", # Name of the last user to modify this file. 2440 "writersCanShare": True or False, # Whether writers can share the document with other users. Not populated for Team Drive files. 2441 "owners": [ # The owner(s) of this file. Not populated for Team Drive files. 2442 { # Information about a Drive user. 2443 "picture": { # The user's profile picture. 2444 "url": "A String", # A URL that points to a profile picture of this user. 2445 }, 2446 "kind": "drive#user", # This is always drive#user. 2447 "displayName": "A String", # A plain text displayable name for this user. 2448 "permissionId": "A String", # The user's ID as visible in the permissions collection. 2449 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. 2450 "emailAddress": "A String", # The email address of the user. 2451 }, 2452 ], 2453 "ownedByMe": True or False, # Whether the file is owned by the current user. Not populated for Team Drive files. 2454 "id": "A String", # The ID of the file. 2455 "sharingUser": { # Information about a Drive user. # User that shared the item with the current user, if available. 2456 "picture": { # The user's profile picture. 2457 "url": "A String", # A URL that points to a profile picture of this user. 2458 }, 2459 "kind": "drive#user", # This is always drive#user. 2460 "displayName": "A String", # A plain text displayable name for this user. 2461 "permissionId": "A String", # The user's ID as visible in the permissions collection. 2462 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. 2463 "emailAddress": "A String", # The email address of the user. 2464 }, 2465 "trashingUser": { # Information about a Drive user. # If the file has been explicitly trashed, the user who trashed it. Only populated for Team Drive files. 2466 "picture": { # The user's profile picture. 2467 "url": "A String", # A URL that points to a profile picture of this user. 2468 }, 2469 "kind": "drive#user", # This is always drive#user. 2470 "displayName": "A String", # A plain text displayable name for this user. 2471 "permissionId": "A String", # The user's ID as visible in the permissions collection. 2472 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. 2473 "emailAddress": "A String", # The email address of the user. 2474 }, 2475 "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. 2476 "lastModifyingUser": { # Information about a Drive user. # The last user to modify this file. 2477 "picture": { # The user's profile picture. 2478 "url": "A String", # A URL that points to a profile picture of this user. 2479 }, 2480 "kind": "drive#user", # This is always drive#user. 2481 "displayName": "A String", # A plain text displayable name for this user. 2482 "permissionId": "A String", # The user's ID as visible in the permissions collection. 2483 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. 2484 "emailAddress": "A String", # The email address of the user. 2485 }, 2486 "copyable": True or False, # Deprecated: use capabilities/canCopy. 2487 "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 Team Drive files. 2488 "markedViewedByMeDate": "A String", # Deprecated. 2489 "ownerNames": [ # Name(s) of the owner(s) of this file. Not populated for Team Drive files. 2490 "A String", 2491 ], 2492 "capabilities": { # Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take. 2493 "canReadRevisions": True or False, # Whether the current user can read the revisions resource of this file. For a Team Drive item, whether revisions of non-folder descendants of this item, or this item itself if it is not a folder, can be read. 2494 "canTrash": True or False, # Whether the current user can move this file to trash. 2495 "canCopy": True or False, # Whether the current user can copy this file. For a Team Drive item, whether the current user can copy non-folder descendants of this item, or this item itself if it is not a folder. 2496 "canShare": True or False, # Whether the current user can modify the sharing settings for this file. 2497 "canDelete": True or False, # Whether the current user can delete this file. 2498 "canMoveTeamDriveItem": True or False, # Whether the current user can move this Team Drive item by changing its parent. Note that a request to change the parent for this item may still fail depending on the new parent that is being added. Only populated for Team Drive files. 2499 "canRename": True or False, # Whether the current user can rename this file. 2500 "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. 2501 "canChangeRestrictedDownload": True or False, # Whether the current user can change the restricted download label of this file. 2502 "canMoveItemIntoTeamDrive": True or False, # Whether the current user can move this item into a Team Drive. If the item is in a Team Drive, this field is equivalent to canMoveTeamDriveItem. 2503 "canDownload": True or False, # Whether the current user can download this file. 2504 "canComment": True or False, # Whether the current user can comment on this file. 2505 "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. 2506 "canReadTeamDrive": True or False, # Whether the current user can read the Team Drive to which this file belongs. Only populated for Team Drive files. 2507 "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. 2508 "canEdit": True or False, # Whether the current user can edit this file. 2509 "canUntrash": True or False, # Whether the current user can restore this file from trash. 2510 }, 2511 "sharedWithMeDate": "A String", # Time at which this file was shared with the user (formatted RFC 3339 timestamp). 2512 "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. 2513 "etag": "A String", # ETag of the file. 2514 "parents": [ # Collection of parent folders which contain this file. 2515 # Setting this field will put the file in all of the provided folders. On insert, if no folders are provided, the file will be placed in the default root folder. 2516 { # A reference to a file's parent. 2517 "selfLink": "A String", # A link back to this reference. 2518 "kind": "drive#parentReference", # This is always drive#parentReference. 2519 "id": "A String", # The ID of the parent. 2520 "isRoot": True or False, # Whether or not the parent is the root folder. 2521 "parentLink": "A String", # A link to the parent. 2522 }, 2523 ], 2524 "exportLinks": { # Links for exporting Google Docs to specific formats. 2525 "a_key": "A String", # A mapping from export format to URL 2526 }, 2527 "shared": True or False, # Whether the file has been shared. Not populated for Team Drive files. 2528 "permissions": [ # The list of permissions for users with access to this file. Not populated for Team Drive files. 2529 { # A permission for a file. 2530 "withLink": True or False, # Whether the link is required for this permission. 2531 "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. 2532 "name": "A String", # The name for this permission. 2533 "teamDrivePermissionDetails": [ # Details of whether the permissions on this Team Drive item are inherited or directly on this item. This is an output-only field which is present only for Team Drive items. 2534 { 2535 "inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field and is only populated for members of the Team Drive. 2536 "role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible: 2537 # - organizer 2538 # - reader 2539 # - writer 2540 "additionalRoles": [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future. 2541 "A String", 2542 ], 2543 "teamDrivePermissionType": "A String", # The Team Drive permission type for this user. While new values may be added in future, the following are currently possible: 2544 # - file 2545 # - member 2546 "inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field. 2547 }, 2548 ], 2549 "deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions. 2550 "kind": "drive#permission", # This is always drive#permission. 2551 "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. 2552 "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. 2553 "authKey": "A String", # The authkey parameter required for this permission. 2554 "etag": "A String", # The ETag of the permission. 2555 "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. 2556 "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: 2557 # - They can only be set on user and group permissions 2558 # - The date must be in the future 2559 # - The date cannot be more than a year in the future 2560 # - The date can only be set on drive.permissions.update requests 2561 "role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: 2562 # - organizer 2563 # - owner 2564 # - reader 2565 # - writer 2566 "type": "A String", # The account type. Allowed values are: 2567 # - user 2568 # - group 2569 # - domain 2570 # - anyone 2571 "additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future. 2572 "A String", 2573 ], 2574 "selfLink": "A String", # A link back to this permission. 2575 "photoLink": "A String", # A link to the profile photo, if available. 2576 }, 2577 ], 2578 "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 Drive; it is not populated for Google Docs or shortcut files. 2579 "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. 2580 "a_key": "A String", 2581 }, 2582 "canReadRevisions": True or False, # Deprecated: use capabilities/canReadRevisions. 2583 "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. 2584 "exposureBias": 3.14, # The exposure bias of the photo (APEX value). 2585 "exposureTime": 3.14, # The length of the exposure, in seconds. 2586 "cameraMake": "A String", # The make of the camera used to create the photo. 2587 "maxApertureValue": 3.14, # The smallest f-number of the lens at the focal length used to create the photo (APEX value). 2588 "isoSpeed": 42, # The ISO speed used to create the photo. 2589 "focalLength": 3.14, # The focal length used to create the photo, in millimeters. 2590 "exposureMode": "A String", # The exposure mode used to create the photo. 2591 "colorSpace": "A String", # The color space of the photo. 2592 "location": { # Geographic location information stored in the image. 2593 "latitude": 3.14, # The latitude stored in the image. 2594 "altitude": 3.14, # The altitude stored in the image. 2595 "longitude": 3.14, # The longitude stored in the image. 2596 }, 2597 "subjectDistance": 42, # The distance to the subject of the photo, in meters. 2598 "height": 42, # The height of the image in pixels. 2599 "lens": "A String", # The lens used to create the photo. 2600 "date": "A String", # The date and time the photo was taken (EXIF format timestamp). 2601 "width": 42, # The width of the image in pixels. 2602 "meteringMode": "A String", # The metering mode used to create the photo. 2603 "flashUsed": True or False, # Whether a flash was used to create the photo. 2604 "aperture": 3.14, # The aperture used to create the photo (f-number). 2605 "rotation": 42, # The rotation in clockwise degrees from the image's original orientation. 2606 "sensor": "A String", # The type of sensor used to create the photo. 2607 "whiteBalance": "A String", # The white balance mode used to create the photo. 2608 "cameraModel": "A String", # The model of the camera used to create the photo. 2609 }, 2610 "description": "A String", # A short description of the file. 2611 "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. 2612 "videoMediaMetadata": { # Metadata about video media. This will only be present for video types. 2613 "width": 42, # The width of the video in pixels. 2614 "durationMillis": "A String", # The duration of the video in milliseconds. 2615 "height": 42, # The height of the video in pixels. 2616 }, 2617 "editable": True or False, # Deprecated: use capabilities/canEdit. 2618 "kind": "drive#file", # The type of file. This is always drive#file. 2619 "canComment": True or False, # Deprecated: use capabilities/canComment. 2620 "quotaBytesUsed": "A String", # The number of quota bytes used by this file. 2621 "fileSize": "A String", # The size of the file in bytes. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files. 2622 "createdDate": "A String", # Create time for this file (formatted RFC 3339 timestamp). 2623 "teamDriveId": "A String", # ID of the Team Drive the file resides in. 2624 "properties": [ # The list of properties. 2625 { # A key-value pair attached to a file that is either public or private to an application. 2626 # The following limits apply to file properties: 2627 # - Maximum of 100 properties total per file 2628 # - Maximum of 30 private properties per app 2629 # - Maximum of 30 public properties 2630 # - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property. 2631 "kind": "drive#property", # This is always drive#property. 2632 "value": "A String", # The value of this property. 2633 "etag": "A String", # ETag of the property. 2634 "visibility": "A String", # The visibility of this property. 2635 "key": "A String", # The key of this property. 2636 "selfLink": "A String", # The link back to this property. 2637 }, 2638 ], 2639 "md5Checksum": "A String", # An MD5 checksum for the content of this file. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files. 2640 "iconLink": "A String", # A link to the file's icon. 2641 "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. 2642 "embedLink": "A String", # A link for embedding the file. 2643 "alternateLink": "A String", # A link for opening the file in a relevant Google editor or viewer. 2644 "title": "A String", # The title of this file. Note that for immutable items such as the top level folders of Team Drives, My Drive root folder, and Application Data folder the title is constant. 2645 "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. 2646 "thumbnail": { # A thumbnail for the file. This will only be used if Drive cannot generate a standard thumbnail. 2647 "mimeType": "A String", # The MIME type of the thumbnail. 2648 "image": "A String", # The URL-safe Base64 encoded bytes of the thumbnail image. It should conform to RFC 4648 section 5. 2649 }, 2650 "downloadUrl": "A String", 2651 "userPermission": { # A permission for a file. # The permissions for the authenticated user on this file. 2652 "withLink": True or False, # Whether the link is required for this permission. 2653 "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. 2654 "name": "A String", # The name for this permission. 2655 "teamDrivePermissionDetails": [ # Details of whether the permissions on this Team Drive item are inherited or directly on this item. This is an output-only field which is present only for Team Drive items. 2656 { 2657 "inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field and is only populated for members of the Team Drive. 2658 "role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible: 2659 # - organizer 2660 # - reader 2661 # - writer 2662 "additionalRoles": [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future. 2663 "A String", 2664 ], 2665 "teamDrivePermissionType": "A String", # The Team Drive permission type for this user. While new values may be added in future, the following are currently possible: 2666 # - file 2667 # - member 2668 "inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field. 2669 }, 2670 ], 2671 "deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions. 2672 "kind": "drive#permission", # This is always drive#permission. 2673 "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. 2674 "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. 2675 "authKey": "A String", # The authkey parameter required for this permission. 2676 "etag": "A String", # The ETag of the permission. 2677 "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. 2678 "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: 2679 # - They can only be set on user and group permissions 2680 # - The date must be in the future 2681 # - The date cannot be more than a year in the future 2682 # - The date can only be set on drive.permissions.update requests 2683 "role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: 2684 # - organizer 2685 # - owner 2686 # - reader 2687 # - writer 2688 "type": "A String", # The account type. Allowed values are: 2689 # - user 2690 # - group 2691 # - domain 2692 # - anyone 2693 "additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future. 2694 "A String", 2695 ], 2696 "selfLink": "A String", # A link back to this permission. 2697 "photoLink": "A String", # A link to the profile photo, if available. 2698 }, 2699 "spaces": [ # The list of spaces which contain the file. Supported values are 'drive', 'appDataFolder' and 'photos'. 2700 "A String", 2701 ], 2702 "shareable": True or False, # Deprecated: use capabilities/canShare. 2703 "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 Drive. 2704 "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 Drive; it is not populated for Google Docs or shortcut files. 2705 "hasAugmentedPermissions": True or False, # Whether any users are granted file access directly on this file. This field is only populated for Team Drive files. 2706 "headRevisionId": "A String", # The ID of the file's head revision. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files. 2707 "selfLink": "A String", # A link back to this file. 2708 "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. 2709 }</pre> 2710 </div> 2711 2712 <div class="method"> 2713 <code class="details" id="touch">touch(fileId, supportsTeamDrives=None)</code> 2714 <pre>Set the file's updated time to the current server time. 2715 2716 Args: 2717 fileId: string, The ID of the file to update. (required) 2718 supportsTeamDrives: boolean, Whether the requesting application supports Team Drives. 2719 2720 Returns: 2721 An object of the form: 2722 2723 { # The metadata for a file. 2724 "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. 2725 "lastViewedByMeDate": "A String", # Last time this file was viewed by the user (formatted RFC 3339 timestamp). 2726 "trashedDate": "A String", # The time that the item was trashed (formatted RFC 3339 timestamp). Only populated for Team Drive files. 2727 "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. 2728 "appDataContents": True or False, # Whether this file is in the Application Data folder. 2729 "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. 2730 "labels": { # A group of labels for the file. 2731 "restricted": True or False, # Whether viewers and commenters are prevented from downloading, printing, and copying this file. 2732 "modified": True or False, # Whether the file has been modified by this user. 2733 "trashed": True or False, # Whether this file has been trashed. This label applies to all users accessing the file; however, only owners are allowed to see and untrash files. 2734 "hidden": True or False, # Deprecated. 2735 "starred": True or False, # Whether this file is starred by the user. 2736 "viewed": True or False, # Whether this file has been viewed by this user. 2737 }, 2738 "indexableText": { # Indexable text attributes for the file (can only be written) 2739 "text": "A String", # The text to be indexed for this file. 2740 }, 2741 "thumbnailVersion": "A String", # The thumbnail version for use in thumbnail cache invalidation. 2742 "explicitlyTrashed": True or False, # Whether this file has been explicitly trashed, as opposed to recursively trashed. 2743 "isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app. 2744 "lastModifyingUserName": "A String", # Name of the last user to modify this file. 2745 "writersCanShare": True or False, # Whether writers can share the document with other users. Not populated for Team Drive files. 2746 "owners": [ # The owner(s) of this file. Not populated for Team Drive files. 2747 { # Information about a Drive user. 2748 "picture": { # The user's profile picture. 2749 "url": "A String", # A URL that points to a profile picture of this user. 2750 }, 2751 "kind": "drive#user", # This is always drive#user. 2752 "displayName": "A String", # A plain text displayable name for this user. 2753 "permissionId": "A String", # The user's ID as visible in the permissions collection. 2754 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. 2755 "emailAddress": "A String", # The email address of the user. 2756 }, 2757 ], 2758 "ownedByMe": True or False, # Whether the file is owned by the current user. Not populated for Team Drive files. 2759 "id": "A String", # The ID of the file. 2760 "sharingUser": { # Information about a Drive user. # User that shared the item with the current user, if available. 2761 "picture": { # The user's profile picture. 2762 "url": "A String", # A URL that points to a profile picture of this user. 2763 }, 2764 "kind": "drive#user", # This is always drive#user. 2765 "displayName": "A String", # A plain text displayable name for this user. 2766 "permissionId": "A String", # The user's ID as visible in the permissions collection. 2767 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. 2768 "emailAddress": "A String", # The email address of the user. 2769 }, 2770 "trashingUser": { # Information about a Drive user. # If the file has been explicitly trashed, the user who trashed it. Only populated for Team Drive files. 2771 "picture": { # The user's profile picture. 2772 "url": "A String", # A URL that points to a profile picture of this user. 2773 }, 2774 "kind": "drive#user", # This is always drive#user. 2775 "displayName": "A String", # A plain text displayable name for this user. 2776 "permissionId": "A String", # The user's ID as visible in the permissions collection. 2777 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. 2778 "emailAddress": "A String", # The email address of the user. 2779 }, 2780 "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. 2781 "lastModifyingUser": { # Information about a Drive user. # The last user to modify this file. 2782 "picture": { # The user's profile picture. 2783 "url": "A String", # A URL that points to a profile picture of this user. 2784 }, 2785 "kind": "drive#user", # This is always drive#user. 2786 "displayName": "A String", # A plain text displayable name for this user. 2787 "permissionId": "A String", # The user's ID as visible in the permissions collection. 2788 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. 2789 "emailAddress": "A String", # The email address of the user. 2790 }, 2791 "copyable": True or False, # Deprecated: use capabilities/canCopy. 2792 "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 Team Drive files. 2793 "markedViewedByMeDate": "A String", # Deprecated. 2794 "ownerNames": [ # Name(s) of the owner(s) of this file. Not populated for Team Drive files. 2795 "A String", 2796 ], 2797 "capabilities": { # Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take. 2798 "canReadRevisions": True or False, # Whether the current user can read the revisions resource of this file. For a Team Drive item, whether revisions of non-folder descendants of this item, or this item itself if it is not a folder, can be read. 2799 "canTrash": True or False, # Whether the current user can move this file to trash. 2800 "canCopy": True or False, # Whether the current user can copy this file. For a Team Drive item, whether the current user can copy non-folder descendants of this item, or this item itself if it is not a folder. 2801 "canShare": True or False, # Whether the current user can modify the sharing settings for this file. 2802 "canDelete": True or False, # Whether the current user can delete this file. 2803 "canMoveTeamDriveItem": True or False, # Whether the current user can move this Team Drive item by changing its parent. Note that a request to change the parent for this item may still fail depending on the new parent that is being added. Only populated for Team Drive files. 2804 "canRename": True or False, # Whether the current user can rename this file. 2805 "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. 2806 "canChangeRestrictedDownload": True or False, # Whether the current user can change the restricted download label of this file. 2807 "canMoveItemIntoTeamDrive": True or False, # Whether the current user can move this item into a Team Drive. If the item is in a Team Drive, this field is equivalent to canMoveTeamDriveItem. 2808 "canDownload": True or False, # Whether the current user can download this file. 2809 "canComment": True or False, # Whether the current user can comment on this file. 2810 "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. 2811 "canReadTeamDrive": True or False, # Whether the current user can read the Team Drive to which this file belongs. Only populated for Team Drive files. 2812 "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. 2813 "canEdit": True or False, # Whether the current user can edit this file. 2814 "canUntrash": True or False, # Whether the current user can restore this file from trash. 2815 }, 2816 "sharedWithMeDate": "A String", # Time at which this file was shared with the user (formatted RFC 3339 timestamp). 2817 "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. 2818 "etag": "A String", # ETag of the file. 2819 "parents": [ # Collection of parent folders which contain this file. 2820 # Setting this field will put the file in all of the provided folders. On insert, if no folders are provided, the file will be placed in the default root folder. 2821 { # A reference to a file's parent. 2822 "selfLink": "A String", # A link back to this reference. 2823 "kind": "drive#parentReference", # This is always drive#parentReference. 2824 "id": "A String", # The ID of the parent. 2825 "isRoot": True or False, # Whether or not the parent is the root folder. 2826 "parentLink": "A String", # A link to the parent. 2827 }, 2828 ], 2829 "exportLinks": { # Links for exporting Google Docs to specific formats. 2830 "a_key": "A String", # A mapping from export format to URL 2831 }, 2832 "shared": True or False, # Whether the file has been shared. Not populated for Team Drive files. 2833 "permissions": [ # The list of permissions for users with access to this file. Not populated for Team Drive files. 2834 { # A permission for a file. 2835 "withLink": True or False, # Whether the link is required for this permission. 2836 "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. 2837 "name": "A String", # The name for this permission. 2838 "teamDrivePermissionDetails": [ # Details of whether the permissions on this Team Drive item are inherited or directly on this item. This is an output-only field which is present only for Team Drive items. 2839 { 2840 "inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field and is only populated for members of the Team Drive. 2841 "role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible: 2842 # - organizer 2843 # - reader 2844 # - writer 2845 "additionalRoles": [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future. 2846 "A String", 2847 ], 2848 "teamDrivePermissionType": "A String", # The Team Drive permission type for this user. While new values may be added in future, the following are currently possible: 2849 # - file 2850 # - member 2851 "inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field. 2852 }, 2853 ], 2854 "deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions. 2855 "kind": "drive#permission", # This is always drive#permission. 2856 "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. 2857 "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. 2858 "authKey": "A String", # The authkey parameter required for this permission. 2859 "etag": "A String", # The ETag of the permission. 2860 "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. 2861 "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: 2862 # - They can only be set on user and group permissions 2863 # - The date must be in the future 2864 # - The date cannot be more than a year in the future 2865 # - The date can only be set on drive.permissions.update requests 2866 "role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: 2867 # - organizer 2868 # - owner 2869 # - reader 2870 # - writer 2871 "type": "A String", # The account type. Allowed values are: 2872 # - user 2873 # - group 2874 # - domain 2875 # - anyone 2876 "additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future. 2877 "A String", 2878 ], 2879 "selfLink": "A String", # A link back to this permission. 2880 "photoLink": "A String", # A link to the profile photo, if available. 2881 }, 2882 ], 2883 "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 Drive; it is not populated for Google Docs or shortcut files. 2884 "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. 2885 "a_key": "A String", 2886 }, 2887 "canReadRevisions": True or False, # Deprecated: use capabilities/canReadRevisions. 2888 "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. 2889 "exposureBias": 3.14, # The exposure bias of the photo (APEX value). 2890 "exposureTime": 3.14, # The length of the exposure, in seconds. 2891 "cameraMake": "A String", # The make of the camera used to create the photo. 2892 "maxApertureValue": 3.14, # The smallest f-number of the lens at the focal length used to create the photo (APEX value). 2893 "isoSpeed": 42, # The ISO speed used to create the photo. 2894 "focalLength": 3.14, # The focal length used to create the photo, in millimeters. 2895 "exposureMode": "A String", # The exposure mode used to create the photo. 2896 "colorSpace": "A String", # The color space of the photo. 2897 "location": { # Geographic location information stored in the image. 2898 "latitude": 3.14, # The latitude stored in the image. 2899 "altitude": 3.14, # The altitude stored in the image. 2900 "longitude": 3.14, # The longitude stored in the image. 2901 }, 2902 "subjectDistance": 42, # The distance to the subject of the photo, in meters. 2903 "height": 42, # The height of the image in pixels. 2904 "lens": "A String", # The lens used to create the photo. 2905 "date": "A String", # The date and time the photo was taken (EXIF format timestamp). 2906 "width": 42, # The width of the image in pixels. 2907 "meteringMode": "A String", # The metering mode used to create the photo. 2908 "flashUsed": True or False, # Whether a flash was used to create the photo. 2909 "aperture": 3.14, # The aperture used to create the photo (f-number). 2910 "rotation": 42, # The rotation in clockwise degrees from the image's original orientation. 2911 "sensor": "A String", # The type of sensor used to create the photo. 2912 "whiteBalance": "A String", # The white balance mode used to create the photo. 2913 "cameraModel": "A String", # The model of the camera used to create the photo. 2914 }, 2915 "description": "A String", # A short description of the file. 2916 "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. 2917 "videoMediaMetadata": { # Metadata about video media. This will only be present for video types. 2918 "width": 42, # The width of the video in pixels. 2919 "durationMillis": "A String", # The duration of the video in milliseconds. 2920 "height": 42, # The height of the video in pixels. 2921 }, 2922 "editable": True or False, # Deprecated: use capabilities/canEdit. 2923 "kind": "drive#file", # The type of file. This is always drive#file. 2924 "canComment": True or False, # Deprecated: use capabilities/canComment. 2925 "quotaBytesUsed": "A String", # The number of quota bytes used by this file. 2926 "fileSize": "A String", # The size of the file in bytes. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files. 2927 "createdDate": "A String", # Create time for this file (formatted RFC 3339 timestamp). 2928 "teamDriveId": "A String", # ID of the Team Drive the file resides in. 2929 "properties": [ # The list of properties. 2930 { # A key-value pair attached to a file that is either public or private to an application. 2931 # The following limits apply to file properties: 2932 # - Maximum of 100 properties total per file 2933 # - Maximum of 30 private properties per app 2934 # - Maximum of 30 public properties 2935 # - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property. 2936 "kind": "drive#property", # This is always drive#property. 2937 "value": "A String", # The value of this property. 2938 "etag": "A String", # ETag of the property. 2939 "visibility": "A String", # The visibility of this property. 2940 "key": "A String", # The key of this property. 2941 "selfLink": "A String", # The link back to this property. 2942 }, 2943 ], 2944 "md5Checksum": "A String", # An MD5 checksum for the content of this file. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files. 2945 "iconLink": "A String", # A link to the file's icon. 2946 "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. 2947 "embedLink": "A String", # A link for embedding the file. 2948 "alternateLink": "A String", # A link for opening the file in a relevant Google editor or viewer. 2949 "title": "A String", # The title of this file. Note that for immutable items such as the top level folders of Team Drives, My Drive root folder, and Application Data folder the title is constant. 2950 "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. 2951 "thumbnail": { # A thumbnail for the file. This will only be used if Drive cannot generate a standard thumbnail. 2952 "mimeType": "A String", # The MIME type of the thumbnail. 2953 "image": "A String", # The URL-safe Base64 encoded bytes of the thumbnail image. It should conform to RFC 4648 section 5. 2954 }, 2955 "downloadUrl": "A String", 2956 "userPermission": { # A permission for a file. # The permissions for the authenticated user on this file. 2957 "withLink": True or False, # Whether the link is required for this permission. 2958 "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. 2959 "name": "A String", # The name for this permission. 2960 "teamDrivePermissionDetails": [ # Details of whether the permissions on this Team Drive item are inherited or directly on this item. This is an output-only field which is present only for Team Drive items. 2961 { 2962 "inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field and is only populated for members of the Team Drive. 2963 "role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible: 2964 # - organizer 2965 # - reader 2966 # - writer 2967 "additionalRoles": [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future. 2968 "A String", 2969 ], 2970 "teamDrivePermissionType": "A String", # The Team Drive permission type for this user. While new values may be added in future, the following are currently possible: 2971 # - file 2972 # - member 2973 "inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field. 2974 }, 2975 ], 2976 "deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions. 2977 "kind": "drive#permission", # This is always drive#permission. 2978 "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. 2979 "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. 2980 "authKey": "A String", # The authkey parameter required for this permission. 2981 "etag": "A String", # The ETag of the permission. 2982 "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. 2983 "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: 2984 # - They can only be set on user and group permissions 2985 # - The date must be in the future 2986 # - The date cannot be more than a year in the future 2987 # - The date can only be set on drive.permissions.update requests 2988 "role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: 2989 # - organizer 2990 # - owner 2991 # - reader 2992 # - writer 2993 "type": "A String", # The account type. Allowed values are: 2994 # - user 2995 # - group 2996 # - domain 2997 # - anyone 2998 "additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future. 2999 "A String", 3000 ], 3001 "selfLink": "A String", # A link back to this permission. 3002 "photoLink": "A String", # A link to the profile photo, if available. 3003 }, 3004 "spaces": [ # The list of spaces which contain the file. Supported values are 'drive', 'appDataFolder' and 'photos'. 3005 "A String", 3006 ], 3007 "shareable": True or False, # Deprecated: use capabilities/canShare. 3008 "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 Drive. 3009 "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 Drive; it is not populated for Google Docs or shortcut files. 3010 "hasAugmentedPermissions": True or False, # Whether any users are granted file access directly on this file. This field is only populated for Team Drive files. 3011 "headRevisionId": "A String", # The ID of the file's head revision. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files. 3012 "selfLink": "A String", # A link back to this file. 3013 "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. 3014 }</pre> 3015 </div> 3016 3017 <div class="method"> 3018 <code class="details" id="trash">trash(fileId, supportsTeamDrives=None)</code> 3019 <pre>Moves a file to the trash. The currently authenticated user must own the file or be an organizer on the parent for Team Drive files. 3020 3021 Args: 3022 fileId: string, The ID of the file to trash. (required) 3023 supportsTeamDrives: boolean, Whether the requesting application supports Team Drives. 3024 3025 Returns: 3026 An object of the form: 3027 3028 { # The metadata for a file. 3029 "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. 3030 "lastViewedByMeDate": "A String", # Last time this file was viewed by the user (formatted RFC 3339 timestamp). 3031 "trashedDate": "A String", # The time that the item was trashed (formatted RFC 3339 timestamp). Only populated for Team Drive files. 3032 "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. 3033 "appDataContents": True or False, # Whether this file is in the Application Data folder. 3034 "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. 3035 "labels": { # A group of labels for the file. 3036 "restricted": True or False, # Whether viewers and commenters are prevented from downloading, printing, and copying this file. 3037 "modified": True or False, # Whether the file has been modified by this user. 3038 "trashed": True or False, # Whether this file has been trashed. This label applies to all users accessing the file; however, only owners are allowed to see and untrash files. 3039 "hidden": True or False, # Deprecated. 3040 "starred": True or False, # Whether this file is starred by the user. 3041 "viewed": True or False, # Whether this file has been viewed by this user. 3042 }, 3043 "indexableText": { # Indexable text attributes for the file (can only be written) 3044 "text": "A String", # The text to be indexed for this file. 3045 }, 3046 "thumbnailVersion": "A String", # The thumbnail version for use in thumbnail cache invalidation. 3047 "explicitlyTrashed": True or False, # Whether this file has been explicitly trashed, as opposed to recursively trashed. 3048 "isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app. 3049 "lastModifyingUserName": "A String", # Name of the last user to modify this file. 3050 "writersCanShare": True or False, # Whether writers can share the document with other users. Not populated for Team Drive files. 3051 "owners": [ # The owner(s) of this file. Not populated for Team Drive files. 3052 { # Information about a Drive user. 3053 "picture": { # The user's profile picture. 3054 "url": "A String", # A URL that points to a profile picture of this user. 3055 }, 3056 "kind": "drive#user", # This is always drive#user. 3057 "displayName": "A String", # A plain text displayable name for this user. 3058 "permissionId": "A String", # The user's ID as visible in the permissions collection. 3059 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. 3060 "emailAddress": "A String", # The email address of the user. 3061 }, 3062 ], 3063 "ownedByMe": True or False, # Whether the file is owned by the current user. Not populated for Team Drive files. 3064 "id": "A String", # The ID of the file. 3065 "sharingUser": { # Information about a Drive user. # User that shared the item with the current user, if available. 3066 "picture": { # The user's profile picture. 3067 "url": "A String", # A URL that points to a profile picture of this user. 3068 }, 3069 "kind": "drive#user", # This is always drive#user. 3070 "displayName": "A String", # A plain text displayable name for this user. 3071 "permissionId": "A String", # The user's ID as visible in the permissions collection. 3072 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. 3073 "emailAddress": "A String", # The email address of the user. 3074 }, 3075 "trashingUser": { # Information about a Drive user. # If the file has been explicitly trashed, the user who trashed it. Only populated for Team Drive files. 3076 "picture": { # The user's profile picture. 3077 "url": "A String", # A URL that points to a profile picture of this user. 3078 }, 3079 "kind": "drive#user", # This is always drive#user. 3080 "displayName": "A String", # A plain text displayable name for this user. 3081 "permissionId": "A String", # The user's ID as visible in the permissions collection. 3082 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. 3083 "emailAddress": "A String", # The email address of the user. 3084 }, 3085 "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. 3086 "lastModifyingUser": { # Information about a Drive user. # The last user to modify this file. 3087 "picture": { # The user's profile picture. 3088 "url": "A String", # A URL that points to a profile picture of this user. 3089 }, 3090 "kind": "drive#user", # This is always drive#user. 3091 "displayName": "A String", # A plain text displayable name for this user. 3092 "permissionId": "A String", # The user's ID as visible in the permissions collection. 3093 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. 3094 "emailAddress": "A String", # The email address of the user. 3095 }, 3096 "copyable": True or False, # Deprecated: use capabilities/canCopy. 3097 "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 Team Drive files. 3098 "markedViewedByMeDate": "A String", # Deprecated. 3099 "ownerNames": [ # Name(s) of the owner(s) of this file. Not populated for Team Drive files. 3100 "A String", 3101 ], 3102 "capabilities": { # Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take. 3103 "canReadRevisions": True or False, # Whether the current user can read the revisions resource of this file. For a Team Drive item, whether revisions of non-folder descendants of this item, or this item itself if it is not a folder, can be read. 3104 "canTrash": True or False, # Whether the current user can move this file to trash. 3105 "canCopy": True or False, # Whether the current user can copy this file. For a Team Drive item, whether the current user can copy non-folder descendants of this item, or this item itself if it is not a folder. 3106 "canShare": True or False, # Whether the current user can modify the sharing settings for this file. 3107 "canDelete": True or False, # Whether the current user can delete this file. 3108 "canMoveTeamDriveItem": True or False, # Whether the current user can move this Team Drive item by changing its parent. Note that a request to change the parent for this item may still fail depending on the new parent that is being added. Only populated for Team Drive files. 3109 "canRename": True or False, # Whether the current user can rename this file. 3110 "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. 3111 "canChangeRestrictedDownload": True or False, # Whether the current user can change the restricted download label of this file. 3112 "canMoveItemIntoTeamDrive": True or False, # Whether the current user can move this item into a Team Drive. If the item is in a Team Drive, this field is equivalent to canMoveTeamDriveItem. 3113 "canDownload": True or False, # Whether the current user can download this file. 3114 "canComment": True or False, # Whether the current user can comment on this file. 3115 "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. 3116 "canReadTeamDrive": True or False, # Whether the current user can read the Team Drive to which this file belongs. Only populated for Team Drive files. 3117 "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. 3118 "canEdit": True or False, # Whether the current user can edit this file. 3119 "canUntrash": True or False, # Whether the current user can restore this file from trash. 3120 }, 3121 "sharedWithMeDate": "A String", # Time at which this file was shared with the user (formatted RFC 3339 timestamp). 3122 "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. 3123 "etag": "A String", # ETag of the file. 3124 "parents": [ # Collection of parent folders which contain this file. 3125 # Setting this field will put the file in all of the provided folders. On insert, if no folders are provided, the file will be placed in the default root folder. 3126 { # A reference to a file's parent. 3127 "selfLink": "A String", # A link back to this reference. 3128 "kind": "drive#parentReference", # This is always drive#parentReference. 3129 "id": "A String", # The ID of the parent. 3130 "isRoot": True or False, # Whether or not the parent is the root folder. 3131 "parentLink": "A String", # A link to the parent. 3132 }, 3133 ], 3134 "exportLinks": { # Links for exporting Google Docs to specific formats. 3135 "a_key": "A String", # A mapping from export format to URL 3136 }, 3137 "shared": True or False, # Whether the file has been shared. Not populated for Team Drive files. 3138 "permissions": [ # The list of permissions for users with access to this file. Not populated for Team Drive files. 3139 { # A permission for a file. 3140 "withLink": True or False, # Whether the link is required for this permission. 3141 "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. 3142 "name": "A String", # The name for this permission. 3143 "teamDrivePermissionDetails": [ # Details of whether the permissions on this Team Drive item are inherited or directly on this item. This is an output-only field which is present only for Team Drive items. 3144 { 3145 "inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field and is only populated for members of the Team Drive. 3146 "role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible: 3147 # - organizer 3148 # - reader 3149 # - writer 3150 "additionalRoles": [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future. 3151 "A String", 3152 ], 3153 "teamDrivePermissionType": "A String", # The Team Drive permission type for this user. While new values may be added in future, the following are currently possible: 3154 # - file 3155 # - member 3156 "inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field. 3157 }, 3158 ], 3159 "deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions. 3160 "kind": "drive#permission", # This is always drive#permission. 3161 "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. 3162 "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. 3163 "authKey": "A String", # The authkey parameter required for this permission. 3164 "etag": "A String", # The ETag of the permission. 3165 "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. 3166 "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: 3167 # - They can only be set on user and group permissions 3168 # - The date must be in the future 3169 # - The date cannot be more than a year in the future 3170 # - The date can only be set on drive.permissions.update requests 3171 "role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: 3172 # - organizer 3173 # - owner 3174 # - reader 3175 # - writer 3176 "type": "A String", # The account type. Allowed values are: 3177 # - user 3178 # - group 3179 # - domain 3180 # - anyone 3181 "additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future. 3182 "A String", 3183 ], 3184 "selfLink": "A String", # A link back to this permission. 3185 "photoLink": "A String", # A link to the profile photo, if available. 3186 }, 3187 ], 3188 "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 Drive; it is not populated for Google Docs or shortcut files. 3189 "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. 3190 "a_key": "A String", 3191 }, 3192 "canReadRevisions": True or False, # Deprecated: use capabilities/canReadRevisions. 3193 "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. 3194 "exposureBias": 3.14, # The exposure bias of the photo (APEX value). 3195 "exposureTime": 3.14, # The length of the exposure, in seconds. 3196 "cameraMake": "A String", # The make of the camera used to create the photo. 3197 "maxApertureValue": 3.14, # The smallest f-number of the lens at the focal length used to create the photo (APEX value). 3198 "isoSpeed": 42, # The ISO speed used to create the photo. 3199 "focalLength": 3.14, # The focal length used to create the photo, in millimeters. 3200 "exposureMode": "A String", # The exposure mode used to create the photo. 3201 "colorSpace": "A String", # The color space of the photo. 3202 "location": { # Geographic location information stored in the image. 3203 "latitude": 3.14, # The latitude stored in the image. 3204 "altitude": 3.14, # The altitude stored in the image. 3205 "longitude": 3.14, # The longitude stored in the image. 3206 }, 3207 "subjectDistance": 42, # The distance to the subject of the photo, in meters. 3208 "height": 42, # The height of the image in pixels. 3209 "lens": "A String", # The lens used to create the photo. 3210 "date": "A String", # The date and time the photo was taken (EXIF format timestamp). 3211 "width": 42, # The width of the image in pixels. 3212 "meteringMode": "A String", # The metering mode used to create the photo. 3213 "flashUsed": True or False, # Whether a flash was used to create the photo. 3214 "aperture": 3.14, # The aperture used to create the photo (f-number). 3215 "rotation": 42, # The rotation in clockwise degrees from the image's original orientation. 3216 "sensor": "A String", # The type of sensor used to create the photo. 3217 "whiteBalance": "A String", # The white balance mode used to create the photo. 3218 "cameraModel": "A String", # The model of the camera used to create the photo. 3219 }, 3220 "description": "A String", # A short description of the file. 3221 "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. 3222 "videoMediaMetadata": { # Metadata about video media. This will only be present for video types. 3223 "width": 42, # The width of the video in pixels. 3224 "durationMillis": "A String", # The duration of the video in milliseconds. 3225 "height": 42, # The height of the video in pixels. 3226 }, 3227 "editable": True or False, # Deprecated: use capabilities/canEdit. 3228 "kind": "drive#file", # The type of file. This is always drive#file. 3229 "canComment": True or False, # Deprecated: use capabilities/canComment. 3230 "quotaBytesUsed": "A String", # The number of quota bytes used by this file. 3231 "fileSize": "A String", # The size of the file in bytes. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files. 3232 "createdDate": "A String", # Create time for this file (formatted RFC 3339 timestamp). 3233 "teamDriveId": "A String", # ID of the Team Drive the file resides in. 3234 "properties": [ # The list of properties. 3235 { # A key-value pair attached to a file that is either public or private to an application. 3236 # The following limits apply to file properties: 3237 # - Maximum of 100 properties total per file 3238 # - Maximum of 30 private properties per app 3239 # - Maximum of 30 public properties 3240 # - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property. 3241 "kind": "drive#property", # This is always drive#property. 3242 "value": "A String", # The value of this property. 3243 "etag": "A String", # ETag of the property. 3244 "visibility": "A String", # The visibility of this property. 3245 "key": "A String", # The key of this property. 3246 "selfLink": "A String", # The link back to this property. 3247 }, 3248 ], 3249 "md5Checksum": "A String", # An MD5 checksum for the content of this file. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files. 3250 "iconLink": "A String", # A link to the file's icon. 3251 "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. 3252 "embedLink": "A String", # A link for embedding the file. 3253 "alternateLink": "A String", # A link for opening the file in a relevant Google editor or viewer. 3254 "title": "A String", # The title of this file. Note that for immutable items such as the top level folders of Team Drives, My Drive root folder, and Application Data folder the title is constant. 3255 "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. 3256 "thumbnail": { # A thumbnail for the file. This will only be used if Drive cannot generate a standard thumbnail. 3257 "mimeType": "A String", # The MIME type of the thumbnail. 3258 "image": "A String", # The URL-safe Base64 encoded bytes of the thumbnail image. It should conform to RFC 4648 section 5. 3259 }, 3260 "downloadUrl": "A String", 3261 "userPermission": { # A permission for a file. # The permissions for the authenticated user on this file. 3262 "withLink": True or False, # Whether the link is required for this permission. 3263 "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. 3264 "name": "A String", # The name for this permission. 3265 "teamDrivePermissionDetails": [ # Details of whether the permissions on this Team Drive item are inherited or directly on this item. This is an output-only field which is present only for Team Drive items. 3266 { 3267 "inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field and is only populated for members of the Team Drive. 3268 "role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible: 3269 # - organizer 3270 # - reader 3271 # - writer 3272 "additionalRoles": [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future. 3273 "A String", 3274 ], 3275 "teamDrivePermissionType": "A String", # The Team Drive permission type for this user. While new values may be added in future, the following are currently possible: 3276 # - file 3277 # - member 3278 "inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field. 3279 }, 3280 ], 3281 "deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions. 3282 "kind": "drive#permission", # This is always drive#permission. 3283 "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. 3284 "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. 3285 "authKey": "A String", # The authkey parameter required for this permission. 3286 "etag": "A String", # The ETag of the permission. 3287 "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. 3288 "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: 3289 # - They can only be set on user and group permissions 3290 # - The date must be in the future 3291 # - The date cannot be more than a year in the future 3292 # - The date can only be set on drive.permissions.update requests 3293 "role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: 3294 # - organizer 3295 # - owner 3296 # - reader 3297 # - writer 3298 "type": "A String", # The account type. Allowed values are: 3299 # - user 3300 # - group 3301 # - domain 3302 # - anyone 3303 "additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future. 3304 "A String", 3305 ], 3306 "selfLink": "A String", # A link back to this permission. 3307 "photoLink": "A String", # A link to the profile photo, if available. 3308 }, 3309 "spaces": [ # The list of spaces which contain the file. Supported values are 'drive', 'appDataFolder' and 'photos'. 3310 "A String", 3311 ], 3312 "shareable": True or False, # Deprecated: use capabilities/canShare. 3313 "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 Drive. 3314 "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 Drive; it is not populated for Google Docs or shortcut files. 3315 "hasAugmentedPermissions": True or False, # Whether any users are granted file access directly on this file. This field is only populated for Team Drive files. 3316 "headRevisionId": "A String", # The ID of the file's head revision. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files. 3317 "selfLink": "A String", # A link back to this file. 3318 "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. 3319 }</pre> 3320 </div> 3321 3322 <div class="method"> 3323 <code class="details" id="untrash">untrash(fileId, supportsTeamDrives=None)</code> 3324 <pre>Restores a file from the trash. 3325 3326 Args: 3327 fileId: string, The ID of the file to untrash. (required) 3328 supportsTeamDrives: boolean, Whether the requesting application supports Team Drives. 3329 3330 Returns: 3331 An object of the form: 3332 3333 { # The metadata for a file. 3334 "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. 3335 "lastViewedByMeDate": "A String", # Last time this file was viewed by the user (formatted RFC 3339 timestamp). 3336 "trashedDate": "A String", # The time that the item was trashed (formatted RFC 3339 timestamp). Only populated for Team Drive files. 3337 "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. 3338 "appDataContents": True or False, # Whether this file is in the Application Data folder. 3339 "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. 3340 "labels": { # A group of labels for the file. 3341 "restricted": True or False, # Whether viewers and commenters are prevented from downloading, printing, and copying this file. 3342 "modified": True or False, # Whether the file has been modified by this user. 3343 "trashed": True or False, # Whether this file has been trashed. This label applies to all users accessing the file; however, only owners are allowed to see and untrash files. 3344 "hidden": True or False, # Deprecated. 3345 "starred": True or False, # Whether this file is starred by the user. 3346 "viewed": True or False, # Whether this file has been viewed by this user. 3347 }, 3348 "indexableText": { # Indexable text attributes for the file (can only be written) 3349 "text": "A String", # The text to be indexed for this file. 3350 }, 3351 "thumbnailVersion": "A String", # The thumbnail version for use in thumbnail cache invalidation. 3352 "explicitlyTrashed": True or False, # Whether this file has been explicitly trashed, as opposed to recursively trashed. 3353 "isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app. 3354 "lastModifyingUserName": "A String", # Name of the last user to modify this file. 3355 "writersCanShare": True or False, # Whether writers can share the document with other users. Not populated for Team Drive files. 3356 "owners": [ # The owner(s) of this file. Not populated for Team Drive files. 3357 { # Information about a Drive user. 3358 "picture": { # The user's profile picture. 3359 "url": "A String", # A URL that points to a profile picture of this user. 3360 }, 3361 "kind": "drive#user", # This is always drive#user. 3362 "displayName": "A String", # A plain text displayable name for this user. 3363 "permissionId": "A String", # The user's ID as visible in the permissions collection. 3364 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. 3365 "emailAddress": "A String", # The email address of the user. 3366 }, 3367 ], 3368 "ownedByMe": True or False, # Whether the file is owned by the current user. Not populated for Team Drive files. 3369 "id": "A String", # The ID of the file. 3370 "sharingUser": { # Information about a Drive user. # User that shared the item with the current user, if available. 3371 "picture": { # The user's profile picture. 3372 "url": "A String", # A URL that points to a profile picture of this user. 3373 }, 3374 "kind": "drive#user", # This is always drive#user. 3375 "displayName": "A String", # A plain text displayable name for this user. 3376 "permissionId": "A String", # The user's ID as visible in the permissions collection. 3377 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. 3378 "emailAddress": "A String", # The email address of the user. 3379 }, 3380 "trashingUser": { # Information about a Drive user. # If the file has been explicitly trashed, the user who trashed it. Only populated for Team Drive files. 3381 "picture": { # The user's profile picture. 3382 "url": "A String", # A URL that points to a profile picture of this user. 3383 }, 3384 "kind": "drive#user", # This is always drive#user. 3385 "displayName": "A String", # A plain text displayable name for this user. 3386 "permissionId": "A String", # The user's ID as visible in the permissions collection. 3387 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. 3388 "emailAddress": "A String", # The email address of the user. 3389 }, 3390 "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. 3391 "lastModifyingUser": { # Information about a Drive user. # The last user to modify this file. 3392 "picture": { # The user's profile picture. 3393 "url": "A String", # A URL that points to a profile picture of this user. 3394 }, 3395 "kind": "drive#user", # This is always drive#user. 3396 "displayName": "A String", # A plain text displayable name for this user. 3397 "permissionId": "A String", # The user's ID as visible in the permissions collection. 3398 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. 3399 "emailAddress": "A String", # The email address of the user. 3400 }, 3401 "copyable": True or False, # Deprecated: use capabilities/canCopy. 3402 "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 Team Drive files. 3403 "markedViewedByMeDate": "A String", # Deprecated. 3404 "ownerNames": [ # Name(s) of the owner(s) of this file. Not populated for Team Drive files. 3405 "A String", 3406 ], 3407 "capabilities": { # Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take. 3408 "canReadRevisions": True or False, # Whether the current user can read the revisions resource of this file. For a Team Drive item, whether revisions of non-folder descendants of this item, or this item itself if it is not a folder, can be read. 3409 "canTrash": True or False, # Whether the current user can move this file to trash. 3410 "canCopy": True or False, # Whether the current user can copy this file. For a Team Drive item, whether the current user can copy non-folder descendants of this item, or this item itself if it is not a folder. 3411 "canShare": True or False, # Whether the current user can modify the sharing settings for this file. 3412 "canDelete": True or False, # Whether the current user can delete this file. 3413 "canMoveTeamDriveItem": True or False, # Whether the current user can move this Team Drive item by changing its parent. Note that a request to change the parent for this item may still fail depending on the new parent that is being added. Only populated for Team Drive files. 3414 "canRename": True or False, # Whether the current user can rename this file. 3415 "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. 3416 "canChangeRestrictedDownload": True or False, # Whether the current user can change the restricted download label of this file. 3417 "canMoveItemIntoTeamDrive": True or False, # Whether the current user can move this item into a Team Drive. If the item is in a Team Drive, this field is equivalent to canMoveTeamDriveItem. 3418 "canDownload": True or False, # Whether the current user can download this file. 3419 "canComment": True or False, # Whether the current user can comment on this file. 3420 "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. 3421 "canReadTeamDrive": True or False, # Whether the current user can read the Team Drive to which this file belongs. Only populated for Team Drive files. 3422 "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. 3423 "canEdit": True or False, # Whether the current user can edit this file. 3424 "canUntrash": True or False, # Whether the current user can restore this file from trash. 3425 }, 3426 "sharedWithMeDate": "A String", # Time at which this file was shared with the user (formatted RFC 3339 timestamp). 3427 "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. 3428 "etag": "A String", # ETag of the file. 3429 "parents": [ # Collection of parent folders which contain this file. 3430 # Setting this field will put the file in all of the provided folders. On insert, if no folders are provided, the file will be placed in the default root folder. 3431 { # A reference to a file's parent. 3432 "selfLink": "A String", # A link back to this reference. 3433 "kind": "drive#parentReference", # This is always drive#parentReference. 3434 "id": "A String", # The ID of the parent. 3435 "isRoot": True or False, # Whether or not the parent is the root folder. 3436 "parentLink": "A String", # A link to the parent. 3437 }, 3438 ], 3439 "exportLinks": { # Links for exporting Google Docs to specific formats. 3440 "a_key": "A String", # A mapping from export format to URL 3441 }, 3442 "shared": True or False, # Whether the file has been shared. Not populated for Team Drive files. 3443 "permissions": [ # The list of permissions for users with access to this file. Not populated for Team Drive files. 3444 { # A permission for a file. 3445 "withLink": True or False, # Whether the link is required for this permission. 3446 "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. 3447 "name": "A String", # The name for this permission. 3448 "teamDrivePermissionDetails": [ # Details of whether the permissions on this Team Drive item are inherited or directly on this item. This is an output-only field which is present only for Team Drive items. 3449 { 3450 "inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field and is only populated for members of the Team Drive. 3451 "role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible: 3452 # - organizer 3453 # - reader 3454 # - writer 3455 "additionalRoles": [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future. 3456 "A String", 3457 ], 3458 "teamDrivePermissionType": "A String", # The Team Drive permission type for this user. While new values may be added in future, the following are currently possible: 3459 # - file 3460 # - member 3461 "inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field. 3462 }, 3463 ], 3464 "deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions. 3465 "kind": "drive#permission", # This is always drive#permission. 3466 "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. 3467 "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. 3468 "authKey": "A String", # The authkey parameter required for this permission. 3469 "etag": "A String", # The ETag of the permission. 3470 "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. 3471 "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: 3472 # - They can only be set on user and group permissions 3473 # - The date must be in the future 3474 # - The date cannot be more than a year in the future 3475 # - The date can only be set on drive.permissions.update requests 3476 "role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: 3477 # - organizer 3478 # - owner 3479 # - reader 3480 # - writer 3481 "type": "A String", # The account type. Allowed values are: 3482 # - user 3483 # - group 3484 # - domain 3485 # - anyone 3486 "additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future. 3487 "A String", 3488 ], 3489 "selfLink": "A String", # A link back to this permission. 3490 "photoLink": "A String", # A link to the profile photo, if available. 3491 }, 3492 ], 3493 "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 Drive; it is not populated for Google Docs or shortcut files. 3494 "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. 3495 "a_key": "A String", 3496 }, 3497 "canReadRevisions": True or False, # Deprecated: use capabilities/canReadRevisions. 3498 "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. 3499 "exposureBias": 3.14, # The exposure bias of the photo (APEX value). 3500 "exposureTime": 3.14, # The length of the exposure, in seconds. 3501 "cameraMake": "A String", # The make of the camera used to create the photo. 3502 "maxApertureValue": 3.14, # The smallest f-number of the lens at the focal length used to create the photo (APEX value). 3503 "isoSpeed": 42, # The ISO speed used to create the photo. 3504 "focalLength": 3.14, # The focal length used to create the photo, in millimeters. 3505 "exposureMode": "A String", # The exposure mode used to create the photo. 3506 "colorSpace": "A String", # The color space of the photo. 3507 "location": { # Geographic location information stored in the image. 3508 "latitude": 3.14, # The latitude stored in the image. 3509 "altitude": 3.14, # The altitude stored in the image. 3510 "longitude": 3.14, # The longitude stored in the image. 3511 }, 3512 "subjectDistance": 42, # The distance to the subject of the photo, in meters. 3513 "height": 42, # The height of the image in pixels. 3514 "lens": "A String", # The lens used to create the photo. 3515 "date": "A String", # The date and time the photo was taken (EXIF format timestamp). 3516 "width": 42, # The width of the image in pixels. 3517 "meteringMode": "A String", # The metering mode used to create the photo. 3518 "flashUsed": True or False, # Whether a flash was used to create the photo. 3519 "aperture": 3.14, # The aperture used to create the photo (f-number). 3520 "rotation": 42, # The rotation in clockwise degrees from the image's original orientation. 3521 "sensor": "A String", # The type of sensor used to create the photo. 3522 "whiteBalance": "A String", # The white balance mode used to create the photo. 3523 "cameraModel": "A String", # The model of the camera used to create the photo. 3524 }, 3525 "description": "A String", # A short description of the file. 3526 "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. 3527 "videoMediaMetadata": { # Metadata about video media. This will only be present for video types. 3528 "width": 42, # The width of the video in pixels. 3529 "durationMillis": "A String", # The duration of the video in milliseconds. 3530 "height": 42, # The height of the video in pixels. 3531 }, 3532 "editable": True or False, # Deprecated: use capabilities/canEdit. 3533 "kind": "drive#file", # The type of file. This is always drive#file. 3534 "canComment": True or False, # Deprecated: use capabilities/canComment. 3535 "quotaBytesUsed": "A String", # The number of quota bytes used by this file. 3536 "fileSize": "A String", # The size of the file in bytes. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files. 3537 "createdDate": "A String", # Create time for this file (formatted RFC 3339 timestamp). 3538 "teamDriveId": "A String", # ID of the Team Drive the file resides in. 3539 "properties": [ # The list of properties. 3540 { # A key-value pair attached to a file that is either public or private to an application. 3541 # The following limits apply to file properties: 3542 # - Maximum of 100 properties total per file 3543 # - Maximum of 30 private properties per app 3544 # - Maximum of 30 public properties 3545 # - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property. 3546 "kind": "drive#property", # This is always drive#property. 3547 "value": "A String", # The value of this property. 3548 "etag": "A String", # ETag of the property. 3549 "visibility": "A String", # The visibility of this property. 3550 "key": "A String", # The key of this property. 3551 "selfLink": "A String", # The link back to this property. 3552 }, 3553 ], 3554 "md5Checksum": "A String", # An MD5 checksum for the content of this file. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files. 3555 "iconLink": "A String", # A link to the file's icon. 3556 "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. 3557 "embedLink": "A String", # A link for embedding the file. 3558 "alternateLink": "A String", # A link for opening the file in a relevant Google editor or viewer. 3559 "title": "A String", # The title of this file. Note that for immutable items such as the top level folders of Team Drives, My Drive root folder, and Application Data folder the title is constant. 3560 "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. 3561 "thumbnail": { # A thumbnail for the file. This will only be used if Drive cannot generate a standard thumbnail. 3562 "mimeType": "A String", # The MIME type of the thumbnail. 3563 "image": "A String", # The URL-safe Base64 encoded bytes of the thumbnail image. It should conform to RFC 4648 section 5. 3564 }, 3565 "downloadUrl": "A String", 3566 "userPermission": { # A permission for a file. # The permissions for the authenticated user on this file. 3567 "withLink": True or False, # Whether the link is required for this permission. 3568 "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. 3569 "name": "A String", # The name for this permission. 3570 "teamDrivePermissionDetails": [ # Details of whether the permissions on this Team Drive item are inherited or directly on this item. This is an output-only field which is present only for Team Drive items. 3571 { 3572 "inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field and is only populated for members of the Team Drive. 3573 "role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible: 3574 # - organizer 3575 # - reader 3576 # - writer 3577 "additionalRoles": [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future. 3578 "A String", 3579 ], 3580 "teamDrivePermissionType": "A String", # The Team Drive permission type for this user. While new values may be added in future, the following are currently possible: 3581 # - file 3582 # - member 3583 "inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field. 3584 }, 3585 ], 3586 "deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions. 3587 "kind": "drive#permission", # This is always drive#permission. 3588 "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. 3589 "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. 3590 "authKey": "A String", # The authkey parameter required for this permission. 3591 "etag": "A String", # The ETag of the permission. 3592 "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. 3593 "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: 3594 # - They can only be set on user and group permissions 3595 # - The date must be in the future 3596 # - The date cannot be more than a year in the future 3597 # - The date can only be set on drive.permissions.update requests 3598 "role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: 3599 # - organizer 3600 # - owner 3601 # - reader 3602 # - writer 3603 "type": "A String", # The account type. Allowed values are: 3604 # - user 3605 # - group 3606 # - domain 3607 # - anyone 3608 "additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future. 3609 "A String", 3610 ], 3611 "selfLink": "A String", # A link back to this permission. 3612 "photoLink": "A String", # A link to the profile photo, if available. 3613 }, 3614 "spaces": [ # The list of spaces which contain the file. Supported values are 'drive', 'appDataFolder' and 'photos'. 3615 "A String", 3616 ], 3617 "shareable": True or False, # Deprecated: use capabilities/canShare. 3618 "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 Drive. 3619 "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 Drive; it is not populated for Google Docs or shortcut files. 3620 "hasAugmentedPermissions": True or False, # Whether any users are granted file access directly on this file. This field is only populated for Team Drive files. 3621 "headRevisionId": "A String", # The ID of the file's head revision. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files. 3622 "selfLink": "A String", # A link back to this file. 3623 "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. 3624 }</pre> 3625 </div> 3626 3627 <div class="method"> 3628 <code class="details" id="update">update(fileId, body=None, supportsTeamDrives=None, newRevision=None, modifiedDateBehavior=None, media_body=None, ocrLanguage=None, ocr=None, pinned=None, addParents=None, removeParents=None, updateViewedDate=None, timedTextTrackName=None, convert=None, useContentAsIndexableText=None, media_mime_type=None, setModifiedDate=None, timedTextLanguage=None)</code> 3629 <pre>Updates file metadata and/or content. 3630 3631 Args: 3632 fileId: string, The ID of the file to update. (required) 3633 body: object, The request body. 3634 The object takes the form of: 3635 3636 { # The metadata for a file. 3637 "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. 3638 "lastViewedByMeDate": "A String", # Last time this file was viewed by the user (formatted RFC 3339 timestamp). 3639 "trashedDate": "A String", # The time that the item was trashed (formatted RFC 3339 timestamp). Only populated for Team Drive files. 3640 "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. 3641 "appDataContents": True or False, # Whether this file is in the Application Data folder. 3642 "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. 3643 "labels": { # A group of labels for the file. 3644 "restricted": True or False, # Whether viewers and commenters are prevented from downloading, printing, and copying this file. 3645 "modified": True or False, # Whether the file has been modified by this user. 3646 "trashed": True or False, # Whether this file has been trashed. This label applies to all users accessing the file; however, only owners are allowed to see and untrash files. 3647 "hidden": True or False, # Deprecated. 3648 "starred": True or False, # Whether this file is starred by the user. 3649 "viewed": True or False, # Whether this file has been viewed by this user. 3650 }, 3651 "indexableText": { # Indexable text attributes for the file (can only be written) 3652 "text": "A String", # The text to be indexed for this file. 3653 }, 3654 "thumbnailVersion": "A String", # The thumbnail version for use in thumbnail cache invalidation. 3655 "explicitlyTrashed": True or False, # Whether this file has been explicitly trashed, as opposed to recursively trashed. 3656 "isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app. 3657 "lastModifyingUserName": "A String", # Name of the last user to modify this file. 3658 "writersCanShare": True or False, # Whether writers can share the document with other users. Not populated for Team Drive files. 3659 "owners": [ # The owner(s) of this file. Not populated for Team Drive files. 3660 { # Information about a Drive user. 3661 "picture": { # The user's profile picture. 3662 "url": "A String", # A URL that points to a profile picture of this user. 3663 }, 3664 "kind": "drive#user", # This is always drive#user. 3665 "displayName": "A String", # A plain text displayable name for this user. 3666 "permissionId": "A String", # The user's ID as visible in the permissions collection. 3667 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. 3668 "emailAddress": "A String", # The email address of the user. 3669 }, 3670 ], 3671 "ownedByMe": True or False, # Whether the file is owned by the current user. Not populated for Team Drive files. 3672 "id": "A String", # The ID of the file. 3673 "sharingUser": { # Information about a Drive user. # User that shared the item with the current user, if available. 3674 "picture": { # The user's profile picture. 3675 "url": "A String", # A URL that points to a profile picture of this user. 3676 }, 3677 "kind": "drive#user", # This is always drive#user. 3678 "displayName": "A String", # A plain text displayable name for this user. 3679 "permissionId": "A String", # The user's ID as visible in the permissions collection. 3680 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. 3681 "emailAddress": "A String", # The email address of the user. 3682 }, 3683 "trashingUser": { # Information about a Drive user. # If the file has been explicitly trashed, the user who trashed it. Only populated for Team Drive files. 3684 "picture": { # The user's profile picture. 3685 "url": "A String", # A URL that points to a profile picture of this user. 3686 }, 3687 "kind": "drive#user", # This is always drive#user. 3688 "displayName": "A String", # A plain text displayable name for this user. 3689 "permissionId": "A String", # The user's ID as visible in the permissions collection. 3690 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. 3691 "emailAddress": "A String", # The email address of the user. 3692 }, 3693 "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. 3694 "lastModifyingUser": { # Information about a Drive user. # The last user to modify this file. 3695 "picture": { # The user's profile picture. 3696 "url": "A String", # A URL that points to a profile picture of this user. 3697 }, 3698 "kind": "drive#user", # This is always drive#user. 3699 "displayName": "A String", # A plain text displayable name for this user. 3700 "permissionId": "A String", # The user's ID as visible in the permissions collection. 3701 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. 3702 "emailAddress": "A String", # The email address of the user. 3703 }, 3704 "copyable": True or False, # Deprecated: use capabilities/canCopy. 3705 "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 Team Drive files. 3706 "markedViewedByMeDate": "A String", # Deprecated. 3707 "ownerNames": [ # Name(s) of the owner(s) of this file. Not populated for Team Drive files. 3708 "A String", 3709 ], 3710 "capabilities": { # Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take. 3711 "canReadRevisions": True or False, # Whether the current user can read the revisions resource of this file. For a Team Drive item, whether revisions of non-folder descendants of this item, or this item itself if it is not a folder, can be read. 3712 "canTrash": True or False, # Whether the current user can move this file to trash. 3713 "canCopy": True or False, # Whether the current user can copy this file. For a Team Drive item, whether the current user can copy non-folder descendants of this item, or this item itself if it is not a folder. 3714 "canShare": True or False, # Whether the current user can modify the sharing settings for this file. 3715 "canDelete": True or False, # Whether the current user can delete this file. 3716 "canMoveTeamDriveItem": True or False, # Whether the current user can move this Team Drive item by changing its parent. Note that a request to change the parent for this item may still fail depending on the new parent that is being added. Only populated for Team Drive files. 3717 "canRename": True or False, # Whether the current user can rename this file. 3718 "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. 3719 "canChangeRestrictedDownload": True or False, # Whether the current user can change the restricted download label of this file. 3720 "canMoveItemIntoTeamDrive": True or False, # Whether the current user can move this item into a Team Drive. If the item is in a Team Drive, this field is equivalent to canMoveTeamDriveItem. 3721 "canDownload": True or False, # Whether the current user can download this file. 3722 "canComment": True or False, # Whether the current user can comment on this file. 3723 "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. 3724 "canReadTeamDrive": True or False, # Whether the current user can read the Team Drive to which this file belongs. Only populated for Team Drive files. 3725 "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. 3726 "canEdit": True or False, # Whether the current user can edit this file. 3727 "canUntrash": True or False, # Whether the current user can restore this file from trash. 3728 }, 3729 "sharedWithMeDate": "A String", # Time at which this file was shared with the user (formatted RFC 3339 timestamp). 3730 "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. 3731 "etag": "A String", # ETag of the file. 3732 "parents": [ # Collection of parent folders which contain this file. 3733 # Setting this field will put the file in all of the provided folders. On insert, if no folders are provided, the file will be placed in the default root folder. 3734 { # A reference to a file's parent. 3735 "selfLink": "A String", # A link back to this reference. 3736 "kind": "drive#parentReference", # This is always drive#parentReference. 3737 "id": "A String", # The ID of the parent. 3738 "isRoot": True or False, # Whether or not the parent is the root folder. 3739 "parentLink": "A String", # A link to the parent. 3740 }, 3741 ], 3742 "exportLinks": { # Links for exporting Google Docs to specific formats. 3743 "a_key": "A String", # A mapping from export format to URL 3744 }, 3745 "shared": True or False, # Whether the file has been shared. Not populated for Team Drive files. 3746 "permissions": [ # The list of permissions for users with access to this file. Not populated for Team Drive files. 3747 { # A permission for a file. 3748 "withLink": True or False, # Whether the link is required for this permission. 3749 "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. 3750 "name": "A String", # The name for this permission. 3751 "teamDrivePermissionDetails": [ # Details of whether the permissions on this Team Drive item are inherited or directly on this item. This is an output-only field which is present only for Team Drive items. 3752 { 3753 "inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field and is only populated for members of the Team Drive. 3754 "role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible: 3755 # - organizer 3756 # - reader 3757 # - writer 3758 "additionalRoles": [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future. 3759 "A String", 3760 ], 3761 "teamDrivePermissionType": "A String", # The Team Drive permission type for this user. While new values may be added in future, the following are currently possible: 3762 # - file 3763 # - member 3764 "inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field. 3765 }, 3766 ], 3767 "deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions. 3768 "kind": "drive#permission", # This is always drive#permission. 3769 "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. 3770 "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. 3771 "authKey": "A String", # The authkey parameter required for this permission. 3772 "etag": "A String", # The ETag of the permission. 3773 "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. 3774 "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: 3775 # - They can only be set on user and group permissions 3776 # - The date must be in the future 3777 # - The date cannot be more than a year in the future 3778 # - The date can only be set on drive.permissions.update requests 3779 "role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: 3780 # - organizer 3781 # - owner 3782 # - reader 3783 # - writer 3784 "type": "A String", # The account type. Allowed values are: 3785 # - user 3786 # - group 3787 # - domain 3788 # - anyone 3789 "additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future. 3790 "A String", 3791 ], 3792 "selfLink": "A String", # A link back to this permission. 3793 "photoLink": "A String", # A link to the profile photo, if available. 3794 }, 3795 ], 3796 "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 Drive; it is not populated for Google Docs or shortcut files. 3797 "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. 3798 "a_key": "A String", 3799 }, 3800 "canReadRevisions": True or False, # Deprecated: use capabilities/canReadRevisions. 3801 "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. 3802 "exposureBias": 3.14, # The exposure bias of the photo (APEX value). 3803 "exposureTime": 3.14, # The length of the exposure, in seconds. 3804 "cameraMake": "A String", # The make of the camera used to create the photo. 3805 "maxApertureValue": 3.14, # The smallest f-number of the lens at the focal length used to create the photo (APEX value). 3806 "isoSpeed": 42, # The ISO speed used to create the photo. 3807 "focalLength": 3.14, # The focal length used to create the photo, in millimeters. 3808 "exposureMode": "A String", # The exposure mode used to create the photo. 3809 "colorSpace": "A String", # The color space of the photo. 3810 "location": { # Geographic location information stored in the image. 3811 "latitude": 3.14, # The latitude stored in the image. 3812 "altitude": 3.14, # The altitude stored in the image. 3813 "longitude": 3.14, # The longitude stored in the image. 3814 }, 3815 "subjectDistance": 42, # The distance to the subject of the photo, in meters. 3816 "height": 42, # The height of the image in pixels. 3817 "lens": "A String", # The lens used to create the photo. 3818 "date": "A String", # The date and time the photo was taken (EXIF format timestamp). 3819 "width": 42, # The width of the image in pixels. 3820 "meteringMode": "A String", # The metering mode used to create the photo. 3821 "flashUsed": True or False, # Whether a flash was used to create the photo. 3822 "aperture": 3.14, # The aperture used to create the photo (f-number). 3823 "rotation": 42, # The rotation in clockwise degrees from the image's original orientation. 3824 "sensor": "A String", # The type of sensor used to create the photo. 3825 "whiteBalance": "A String", # The white balance mode used to create the photo. 3826 "cameraModel": "A String", # The model of the camera used to create the photo. 3827 }, 3828 "description": "A String", # A short description of the file. 3829 "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. 3830 "videoMediaMetadata": { # Metadata about video media. This will only be present for video types. 3831 "width": 42, # The width of the video in pixels. 3832 "durationMillis": "A String", # The duration of the video in milliseconds. 3833 "height": 42, # The height of the video in pixels. 3834 }, 3835 "editable": True or False, # Deprecated: use capabilities/canEdit. 3836 "kind": "drive#file", # The type of file. This is always drive#file. 3837 "canComment": True or False, # Deprecated: use capabilities/canComment. 3838 "quotaBytesUsed": "A String", # The number of quota bytes used by this file. 3839 "fileSize": "A String", # The size of the file in bytes. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files. 3840 "createdDate": "A String", # Create time for this file (formatted RFC 3339 timestamp). 3841 "teamDriveId": "A String", # ID of the Team Drive the file resides in. 3842 "properties": [ # The list of properties. 3843 { # A key-value pair attached to a file that is either public or private to an application. 3844 # The following limits apply to file properties: 3845 # - Maximum of 100 properties total per file 3846 # - Maximum of 30 private properties per app 3847 # - Maximum of 30 public properties 3848 # - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property. 3849 "kind": "drive#property", # This is always drive#property. 3850 "value": "A String", # The value of this property. 3851 "etag": "A String", # ETag of the property. 3852 "visibility": "A String", # The visibility of this property. 3853 "key": "A String", # The key of this property. 3854 "selfLink": "A String", # The link back to this property. 3855 }, 3856 ], 3857 "md5Checksum": "A String", # An MD5 checksum for the content of this file. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files. 3858 "iconLink": "A String", # A link to the file's icon. 3859 "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. 3860 "embedLink": "A String", # A link for embedding the file. 3861 "alternateLink": "A String", # A link for opening the file in a relevant Google editor or viewer. 3862 "title": "A String", # The title of this file. Note that for immutable items such as the top level folders of Team Drives, My Drive root folder, and Application Data folder the title is constant. 3863 "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. 3864 "thumbnail": { # A thumbnail for the file. This will only be used if Drive cannot generate a standard thumbnail. 3865 "mimeType": "A String", # The MIME type of the thumbnail. 3866 "image": "A String", # The URL-safe Base64 encoded bytes of the thumbnail image. It should conform to RFC 4648 section 5. 3867 }, 3868 "downloadUrl": "A String", 3869 "userPermission": { # A permission for a file. # The permissions for the authenticated user on this file. 3870 "withLink": True or False, # Whether the link is required for this permission. 3871 "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. 3872 "name": "A String", # The name for this permission. 3873 "teamDrivePermissionDetails": [ # Details of whether the permissions on this Team Drive item are inherited or directly on this item. This is an output-only field which is present only for Team Drive items. 3874 { 3875 "inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field and is only populated for members of the Team Drive. 3876 "role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible: 3877 # - organizer 3878 # - reader 3879 # - writer 3880 "additionalRoles": [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future. 3881 "A String", 3882 ], 3883 "teamDrivePermissionType": "A String", # The Team Drive permission type for this user. While new values may be added in future, the following are currently possible: 3884 # - file 3885 # - member 3886 "inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field. 3887 }, 3888 ], 3889 "deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions. 3890 "kind": "drive#permission", # This is always drive#permission. 3891 "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. 3892 "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. 3893 "authKey": "A String", # The authkey parameter required for this permission. 3894 "etag": "A String", # The ETag of the permission. 3895 "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. 3896 "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: 3897 # - They can only be set on user and group permissions 3898 # - The date must be in the future 3899 # - The date cannot be more than a year in the future 3900 # - The date can only be set on drive.permissions.update requests 3901 "role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: 3902 # - organizer 3903 # - owner 3904 # - reader 3905 # - writer 3906 "type": "A String", # The account type. Allowed values are: 3907 # - user 3908 # - group 3909 # - domain 3910 # - anyone 3911 "additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future. 3912 "A String", 3913 ], 3914 "selfLink": "A String", # A link back to this permission. 3915 "photoLink": "A String", # A link to the profile photo, if available. 3916 }, 3917 "spaces": [ # The list of spaces which contain the file. Supported values are 'drive', 'appDataFolder' and 'photos'. 3918 "A String", 3919 ], 3920 "shareable": True or False, # Deprecated: use capabilities/canShare. 3921 "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 Drive. 3922 "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 Drive; it is not populated for Google Docs or shortcut files. 3923 "hasAugmentedPermissions": True or False, # Whether any users are granted file access directly on this file. This field is only populated for Team Drive files. 3924 "headRevisionId": "A String", # The ID of the file's head revision. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files. 3925 "selfLink": "A String", # A link back to this file. 3926 "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. 3927 } 3928 3929 supportsTeamDrives: boolean, Whether the requesting application supports Team Drives. 3930 newRevision: boolean, Whether a blob upload should create a new revision. If false, the blob data in the current head revision is replaced. If true or not set, a new blob is created as head revision, and previous unpinned revisions are preserved for a short period of time. Pinned revisions are stored indefinitely, using additional storage quota, up to a maximum of 200 revisions. For details on how revisions are retained, see the Drive Help Center. 3931 modifiedDateBehavior: string, Determines the behavior in which modifiedDate is updated. This overrides setModifiedDate. 3932 Allowed values 3933 fromBody - Set modifiedDate to the value provided in the body of the request. No change if no value was provided. 3934 fromBodyIfNeeded - Set modifiedDate to the value provided in the body of the request depending on other contents of the update. 3935 fromBodyOrNow - Set modifiedDate to the value provided in the body of the request, or to the current time if no value was provided. 3936 noChange - Maintain the previous value of modifiedDate. 3937 now - Set modifiedDate to the current time. 3938 nowIfNeeded - Set modifiedDate to the current time depending on contents of the update. 3939 media_body: string, The filename of the media request body, or an instance of a MediaUpload object. 3940 ocrLanguage: string, If ocr is true, hints at the language to use. Valid values are BCP 47 codes. 3941 ocr: boolean, Whether to attempt OCR on .jpg, .png, .gif, or .pdf uploads. 3942 pinned: boolean, Whether to pin the new revision. A file can have a maximum of 200 pinned revisions. 3943 addParents: string, Comma-separated list of parent IDs to add. 3944 removeParents: string, Comma-separated list of parent IDs to remove. 3945 updateViewedDate: boolean, Whether to update the view date after successfully updating the file. 3946 timedTextTrackName: string, The timed text track name. 3947 convert: boolean, This parameter is deprecated and has no function. 3948 useContentAsIndexableText: boolean, Whether to use the content as indexable text. 3949 media_mime_type: string, The MIME type of the media request body, or an instance of a MediaUpload object. 3950 setModifiedDate: boolean, Whether to set the modified date with the supplied modified date. 3951 timedTextLanguage: string, The language of the timed text. 3952 3953 Returns: 3954 An object of the form: 3955 3956 { # The metadata for a file. 3957 "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. 3958 "lastViewedByMeDate": "A String", # Last time this file was viewed by the user (formatted RFC 3339 timestamp). 3959 "trashedDate": "A String", # The time that the item was trashed (formatted RFC 3339 timestamp). Only populated for Team Drive files. 3960 "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. 3961 "appDataContents": True or False, # Whether this file is in the Application Data folder. 3962 "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. 3963 "labels": { # A group of labels for the file. 3964 "restricted": True or False, # Whether viewers and commenters are prevented from downloading, printing, and copying this file. 3965 "modified": True or False, # Whether the file has been modified by this user. 3966 "trashed": True or False, # Whether this file has been trashed. This label applies to all users accessing the file; however, only owners are allowed to see and untrash files. 3967 "hidden": True or False, # Deprecated. 3968 "starred": True or False, # Whether this file is starred by the user. 3969 "viewed": True or False, # Whether this file has been viewed by this user. 3970 }, 3971 "indexableText": { # Indexable text attributes for the file (can only be written) 3972 "text": "A String", # The text to be indexed for this file. 3973 }, 3974 "thumbnailVersion": "A String", # The thumbnail version for use in thumbnail cache invalidation. 3975 "explicitlyTrashed": True or False, # Whether this file has been explicitly trashed, as opposed to recursively trashed. 3976 "isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app. 3977 "lastModifyingUserName": "A String", # Name of the last user to modify this file. 3978 "writersCanShare": True or False, # Whether writers can share the document with other users. Not populated for Team Drive files. 3979 "owners": [ # The owner(s) of this file. Not populated for Team Drive files. 3980 { # Information about a Drive user. 3981 "picture": { # The user's profile picture. 3982 "url": "A String", # A URL that points to a profile picture of this user. 3983 }, 3984 "kind": "drive#user", # This is always drive#user. 3985 "displayName": "A String", # A plain text displayable name for this user. 3986 "permissionId": "A String", # The user's ID as visible in the permissions collection. 3987 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. 3988 "emailAddress": "A String", # The email address of the user. 3989 }, 3990 ], 3991 "ownedByMe": True or False, # Whether the file is owned by the current user. Not populated for Team Drive files. 3992 "id": "A String", # The ID of the file. 3993 "sharingUser": { # Information about a Drive user. # User that shared the item with the current user, if available. 3994 "picture": { # The user's profile picture. 3995 "url": "A String", # A URL that points to a profile picture of this user. 3996 }, 3997 "kind": "drive#user", # This is always drive#user. 3998 "displayName": "A String", # A plain text displayable name for this user. 3999 "permissionId": "A String", # The user's ID as visible in the permissions collection. 4000 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. 4001 "emailAddress": "A String", # The email address of the user. 4002 }, 4003 "trashingUser": { # Information about a Drive user. # If the file has been explicitly trashed, the user who trashed it. Only populated for Team Drive files. 4004 "picture": { # The user's profile picture. 4005 "url": "A String", # A URL that points to a profile picture of this user. 4006 }, 4007 "kind": "drive#user", # This is always drive#user. 4008 "displayName": "A String", # A plain text displayable name for this user. 4009 "permissionId": "A String", # The user's ID as visible in the permissions collection. 4010 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. 4011 "emailAddress": "A String", # The email address of the user. 4012 }, 4013 "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. 4014 "lastModifyingUser": { # Information about a Drive user. # The last user to modify this file. 4015 "picture": { # The user's profile picture. 4016 "url": "A String", # A URL that points to a profile picture of this user. 4017 }, 4018 "kind": "drive#user", # This is always drive#user. 4019 "displayName": "A String", # A plain text displayable name for this user. 4020 "permissionId": "A String", # The user's ID as visible in the permissions collection. 4021 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. 4022 "emailAddress": "A String", # The email address of the user. 4023 }, 4024 "copyable": True or False, # Deprecated: use capabilities/canCopy. 4025 "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 Team Drive files. 4026 "markedViewedByMeDate": "A String", # Deprecated. 4027 "ownerNames": [ # Name(s) of the owner(s) of this file. Not populated for Team Drive files. 4028 "A String", 4029 ], 4030 "capabilities": { # Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take. 4031 "canReadRevisions": True or False, # Whether the current user can read the revisions resource of this file. For a Team Drive item, whether revisions of non-folder descendants of this item, or this item itself if it is not a folder, can be read. 4032 "canTrash": True or False, # Whether the current user can move this file to trash. 4033 "canCopy": True or False, # Whether the current user can copy this file. For a Team Drive item, whether the current user can copy non-folder descendants of this item, or this item itself if it is not a folder. 4034 "canShare": True or False, # Whether the current user can modify the sharing settings for this file. 4035 "canDelete": True or False, # Whether the current user can delete this file. 4036 "canMoveTeamDriveItem": True or False, # Whether the current user can move this Team Drive item by changing its parent. Note that a request to change the parent for this item may still fail depending on the new parent that is being added. Only populated for Team Drive files. 4037 "canRename": True or False, # Whether the current user can rename this file. 4038 "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. 4039 "canChangeRestrictedDownload": True or False, # Whether the current user can change the restricted download label of this file. 4040 "canMoveItemIntoTeamDrive": True or False, # Whether the current user can move this item into a Team Drive. If the item is in a Team Drive, this field is equivalent to canMoveTeamDriveItem. 4041 "canDownload": True or False, # Whether the current user can download this file. 4042 "canComment": True or False, # Whether the current user can comment on this file. 4043 "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. 4044 "canReadTeamDrive": True or False, # Whether the current user can read the Team Drive to which this file belongs. Only populated for Team Drive files. 4045 "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. 4046 "canEdit": True or False, # Whether the current user can edit this file. 4047 "canUntrash": True or False, # Whether the current user can restore this file from trash. 4048 }, 4049 "sharedWithMeDate": "A String", # Time at which this file was shared with the user (formatted RFC 3339 timestamp). 4050 "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. 4051 "etag": "A String", # ETag of the file. 4052 "parents": [ # Collection of parent folders which contain this file. 4053 # Setting this field will put the file in all of the provided folders. On insert, if no folders are provided, the file will be placed in the default root folder. 4054 { # A reference to a file's parent. 4055 "selfLink": "A String", # A link back to this reference. 4056 "kind": "drive#parentReference", # This is always drive#parentReference. 4057 "id": "A String", # The ID of the parent. 4058 "isRoot": True or False, # Whether or not the parent is the root folder. 4059 "parentLink": "A String", # A link to the parent. 4060 }, 4061 ], 4062 "exportLinks": { # Links for exporting Google Docs to specific formats. 4063 "a_key": "A String", # A mapping from export format to URL 4064 }, 4065 "shared": True or False, # Whether the file has been shared. Not populated for Team Drive files. 4066 "permissions": [ # The list of permissions for users with access to this file. Not populated for Team Drive files. 4067 { # A permission for a file. 4068 "withLink": True or False, # Whether the link is required for this permission. 4069 "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. 4070 "name": "A String", # The name for this permission. 4071 "teamDrivePermissionDetails": [ # Details of whether the permissions on this Team Drive item are inherited or directly on this item. This is an output-only field which is present only for Team Drive items. 4072 { 4073 "inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field and is only populated for members of the Team Drive. 4074 "role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible: 4075 # - organizer 4076 # - reader 4077 # - writer 4078 "additionalRoles": [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future. 4079 "A String", 4080 ], 4081 "teamDrivePermissionType": "A String", # The Team Drive permission type for this user. While new values may be added in future, the following are currently possible: 4082 # - file 4083 # - member 4084 "inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field. 4085 }, 4086 ], 4087 "deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions. 4088 "kind": "drive#permission", # This is always drive#permission. 4089 "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. 4090 "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. 4091 "authKey": "A String", # The authkey parameter required for this permission. 4092 "etag": "A String", # The ETag of the permission. 4093 "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. 4094 "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: 4095 # - They can only be set on user and group permissions 4096 # - The date must be in the future 4097 # - The date cannot be more than a year in the future 4098 # - The date can only be set on drive.permissions.update requests 4099 "role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: 4100 # - organizer 4101 # - owner 4102 # - reader 4103 # - writer 4104 "type": "A String", # The account type. Allowed values are: 4105 # - user 4106 # - group 4107 # - domain 4108 # - anyone 4109 "additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future. 4110 "A String", 4111 ], 4112 "selfLink": "A String", # A link back to this permission. 4113 "photoLink": "A String", # A link to the profile photo, if available. 4114 }, 4115 ], 4116 "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 Drive; it is not populated for Google Docs or shortcut files. 4117 "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. 4118 "a_key": "A String", 4119 }, 4120 "canReadRevisions": True or False, # Deprecated: use capabilities/canReadRevisions. 4121 "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. 4122 "exposureBias": 3.14, # The exposure bias of the photo (APEX value). 4123 "exposureTime": 3.14, # The length of the exposure, in seconds. 4124 "cameraMake": "A String", # The make of the camera used to create the photo. 4125 "maxApertureValue": 3.14, # The smallest f-number of the lens at the focal length used to create the photo (APEX value). 4126 "isoSpeed": 42, # The ISO speed used to create the photo. 4127 "focalLength": 3.14, # The focal length used to create the photo, in millimeters. 4128 "exposureMode": "A String", # The exposure mode used to create the photo. 4129 "colorSpace": "A String", # The color space of the photo. 4130 "location": { # Geographic location information stored in the image. 4131 "latitude": 3.14, # The latitude stored in the image. 4132 "altitude": 3.14, # The altitude stored in the image. 4133 "longitude": 3.14, # The longitude stored in the image. 4134 }, 4135 "subjectDistance": 42, # The distance to the subject of the photo, in meters. 4136 "height": 42, # The height of the image in pixels. 4137 "lens": "A String", # The lens used to create the photo. 4138 "date": "A String", # The date and time the photo was taken (EXIF format timestamp). 4139 "width": 42, # The width of the image in pixels. 4140 "meteringMode": "A String", # The metering mode used to create the photo. 4141 "flashUsed": True or False, # Whether a flash was used to create the photo. 4142 "aperture": 3.14, # The aperture used to create the photo (f-number). 4143 "rotation": 42, # The rotation in clockwise degrees from the image's original orientation. 4144 "sensor": "A String", # The type of sensor used to create the photo. 4145 "whiteBalance": "A String", # The white balance mode used to create the photo. 4146 "cameraModel": "A String", # The model of the camera used to create the photo. 4147 }, 4148 "description": "A String", # A short description of the file. 4149 "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. 4150 "videoMediaMetadata": { # Metadata about video media. This will only be present for video types. 4151 "width": 42, # The width of the video in pixels. 4152 "durationMillis": "A String", # The duration of the video in milliseconds. 4153 "height": 42, # The height of the video in pixels. 4154 }, 4155 "editable": True or False, # Deprecated: use capabilities/canEdit. 4156 "kind": "drive#file", # The type of file. This is always drive#file. 4157 "canComment": True or False, # Deprecated: use capabilities/canComment. 4158 "quotaBytesUsed": "A String", # The number of quota bytes used by this file. 4159 "fileSize": "A String", # The size of the file in bytes. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files. 4160 "createdDate": "A String", # Create time for this file (formatted RFC 3339 timestamp). 4161 "teamDriveId": "A String", # ID of the Team Drive the file resides in. 4162 "properties": [ # The list of properties. 4163 { # A key-value pair attached to a file that is either public or private to an application. 4164 # The following limits apply to file properties: 4165 # - Maximum of 100 properties total per file 4166 # - Maximum of 30 private properties per app 4167 # - Maximum of 30 public properties 4168 # - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property. 4169 "kind": "drive#property", # This is always drive#property. 4170 "value": "A String", # The value of this property. 4171 "etag": "A String", # ETag of the property. 4172 "visibility": "A String", # The visibility of this property. 4173 "key": "A String", # The key of this property. 4174 "selfLink": "A String", # The link back to this property. 4175 }, 4176 ], 4177 "md5Checksum": "A String", # An MD5 checksum for the content of this file. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files. 4178 "iconLink": "A String", # A link to the file's icon. 4179 "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. 4180 "embedLink": "A String", # A link for embedding the file. 4181 "alternateLink": "A String", # A link for opening the file in a relevant Google editor or viewer. 4182 "title": "A String", # The title of this file. Note that for immutable items such as the top level folders of Team Drives, My Drive root folder, and Application Data folder the title is constant. 4183 "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. 4184 "thumbnail": { # A thumbnail for the file. This will only be used if Drive cannot generate a standard thumbnail. 4185 "mimeType": "A String", # The MIME type of the thumbnail. 4186 "image": "A String", # The URL-safe Base64 encoded bytes of the thumbnail image. It should conform to RFC 4648 section 5. 4187 }, 4188 "downloadUrl": "A String", 4189 "userPermission": { # A permission for a file. # The permissions for the authenticated user on this file. 4190 "withLink": True or False, # Whether the link is required for this permission. 4191 "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. 4192 "name": "A String", # The name for this permission. 4193 "teamDrivePermissionDetails": [ # Details of whether the permissions on this Team Drive item are inherited or directly on this item. This is an output-only field which is present only for Team Drive items. 4194 { 4195 "inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field and is only populated for members of the Team Drive. 4196 "role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible: 4197 # - organizer 4198 # - reader 4199 # - writer 4200 "additionalRoles": [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future. 4201 "A String", 4202 ], 4203 "teamDrivePermissionType": "A String", # The Team Drive permission type for this user. While new values may be added in future, the following are currently possible: 4204 # - file 4205 # - member 4206 "inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field. 4207 }, 4208 ], 4209 "deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions. 4210 "kind": "drive#permission", # This is always drive#permission. 4211 "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. 4212 "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. 4213 "authKey": "A String", # The authkey parameter required for this permission. 4214 "etag": "A String", # The ETag of the permission. 4215 "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. 4216 "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: 4217 # - They can only be set on user and group permissions 4218 # - The date must be in the future 4219 # - The date cannot be more than a year in the future 4220 # - The date can only be set on drive.permissions.update requests 4221 "role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: 4222 # - organizer 4223 # - owner 4224 # - reader 4225 # - writer 4226 "type": "A String", # The account type. Allowed values are: 4227 # - user 4228 # - group 4229 # - domain 4230 # - anyone 4231 "additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future. 4232 "A String", 4233 ], 4234 "selfLink": "A String", # A link back to this permission. 4235 "photoLink": "A String", # A link to the profile photo, if available. 4236 }, 4237 "spaces": [ # The list of spaces which contain the file. Supported values are 'drive', 'appDataFolder' and 'photos'. 4238 "A String", 4239 ], 4240 "shareable": True or False, # Deprecated: use capabilities/canShare. 4241 "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 Drive. 4242 "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 Drive; it is not populated for Google Docs or shortcut files. 4243 "hasAugmentedPermissions": True or False, # Whether any users are granted file access directly on this file. This field is only populated for Team Drive files. 4244 "headRevisionId": "A String", # The ID of the file's head revision. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files. 4245 "selfLink": "A String", # A link back to this file. 4246 "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. 4247 }</pre> 4248 </div> 4249 4250 <div class="method"> 4251 <code class="details" id="watch">watch(fileId, body, projection=None, revisionId=None, supportsTeamDrives=None, acknowledgeAbuse=None, updateViewedDate=None)</code> 4252 <pre>Subscribe to changes on a file 4253 4254 Args: 4255 fileId: string, The ID for the file in question. (required) 4256 body: object, The request body. (required) 4257 The object takes the form of: 4258 4259 { # An notification channel used to watch for resource changes. 4260 "resourceUri": "A String", # A version-specific identifier for the watched resource. 4261 "kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource. Value: the fixed string "api#channel". 4262 "resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions. 4263 "payload": True or False, # A Boolean value to indicate whether payload is wanted. Optional. 4264 "token": "A String", # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional. 4265 "params": { # Additional parameters controlling delivery channel behavior. Optional. 4266 "a_key": "A String", # Declares a new parameter by name. 4267 }, 4268 "expiration": "A String", # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional. 4269 "address": "A String", # The address where notifications are delivered for this channel. 4270 "type": "A String", # The type of delivery mechanism used for this channel. 4271 "id": "A String", # A UUID or similar unique string that identifies this channel. 4272 } 4273 4274 projection: string, This parameter is deprecated and has no function. 4275 Allowed values 4276 BASIC - Deprecated 4277 FULL - Deprecated 4278 revisionId: string, Specifies the Revision ID that should be downloaded. Ignored unless alt=media is specified. 4279 supportsTeamDrives: boolean, Whether the requesting application supports Team Drives. 4280 acknowledgeAbuse: boolean, Whether the user is acknowledging the risk of downloading known malware or other abusive files. 4281 updateViewedDate: boolean, Deprecated: Use files.update with modifiedDateBehavior=noChange, updateViewedDate=true and an empty request body. 4282 4283 Returns: 4284 An object of the form: 4285 4286 { # An notification channel used to watch for resource changes. 4287 "resourceUri": "A String", # A version-specific identifier for the watched resource. 4288 "kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource. Value: the fixed string "api#channel". 4289 "resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions. 4290 "payload": True or False, # A Boolean value to indicate whether payload is wanted. Optional. 4291 "token": "A String", # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional. 4292 "params": { # Additional parameters controlling delivery channel behavior. Optional. 4293 "a_key": "A String", # Declares a new parameter by name. 4294 }, 4295 "expiration": "A String", # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional. 4296 "address": "A String", # The address where notifications are delivered for this channel. 4297 "type": "A String", # The type of delivery mechanism used for this channel. 4298 "id": "A String", # A UUID or similar unique string that identifies this channel. 4299 }</pre> 4300 </div> 4301 4302 <div class="method"> 4303 <code class="details" id="watch_media">watch_media(fileId, body, projection=None, revisionId=None, supportsTeamDrives=None, acknowledgeAbuse=None, updateViewedDate=None)</code> 4304 <pre>Subscribe to changes on a file 4305 4306 Args: 4307 fileId: string, The ID for the file in question. (required) 4308 body: object, The request body. (required) 4309 The object takes the form of: 4310 4311 { # An notification channel used to watch for resource changes. 4312 "resourceUri": "A String", # A version-specific identifier for the watched resource. 4313 "kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource. Value: the fixed string "api#channel". 4314 "resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions. 4315 "payload": True or False, # A Boolean value to indicate whether payload is wanted. Optional. 4316 "token": "A String", # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional. 4317 "params": { # Additional parameters controlling delivery channel behavior. Optional. 4318 "a_key": "A String", # Declares a new parameter by name. 4319 }, 4320 "expiration": "A String", # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional. 4321 "address": "A String", # The address where notifications are delivered for this channel. 4322 "type": "A String", # The type of delivery mechanism used for this channel. 4323 "id": "A String", # A UUID or similar unique string that identifies this channel. 4324 } 4325 4326 projection: string, This parameter is deprecated and has no function. 4327 Allowed values 4328 BASIC - Deprecated 4329 FULL - Deprecated 4330 revisionId: string, Specifies the Revision ID that should be downloaded. Ignored unless alt=media is specified. 4331 supportsTeamDrives: boolean, Whether the requesting application supports Team Drives. 4332 acknowledgeAbuse: boolean, Whether the user is acknowledging the risk of downloading known malware or other abusive files. 4333 updateViewedDate: boolean, Deprecated: Use files.update with modifiedDateBehavior=noChange, updateViewedDate=true and an empty request body. 4334 4335 Returns: 4336 The media object as a string. 4337 4338 </pre> 4339 </div> 4340 4341 </body></html>
