| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1 | <html><body> |
| 2 | <style> |
| 3 | |
| 4 | body, h1, h2, h3, div, span, p, pre, a { |
| 5 | margin: 0; |
| 6 | padding: 0; |
| 7 | border: 0; |
| 8 | font-weight: inherit; |
| 9 | font-style: inherit; |
| 10 | font-size: 100%; |
| 11 | font-family: inherit; |
| 12 | vertical-align: baseline; |
| 13 | } |
| 14 | |
| 15 | body { |
| 16 | font-size: 13px; |
| 17 | padding: 1em; |
| 18 | } |
| 19 | |
| 20 | h1 { |
| 21 | font-size: 26px; |
| 22 | margin-bottom: 1em; |
| 23 | } |
| 24 | |
| 25 | h2 { |
| 26 | font-size: 24px; |
| 27 | margin-bottom: 1em; |
| 28 | } |
| 29 | |
| 30 | h3 { |
| 31 | font-size: 20px; |
| 32 | margin-bottom: 1em; |
| 33 | margin-top: 1em; |
| 34 | } |
| 35 | |
| 36 | pre, code { |
| 37 | line-height: 1.5; |
| 38 | font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 | } |
| 40 | |
| 41 | pre { |
| 42 | margin-top: 0.5em; |
| 43 | } |
| 44 | |
| 45 | h1, h2, h3, p { |
| 46 | font-family: Arial, sans serif; |
| 47 | } |
| 48 | |
| 49 | h1, h2, h3 { |
| 50 | border-bottom: solid #CCC 1px; |
| 51 | } |
| 52 | |
| 53 | .toc_element { |
| 54 | margin-top: 0.5em; |
| 55 | } |
| 56 | |
| 57 | .firstline { |
| 58 | margin-left: 2 em; |
| 59 | } |
| 60 | |
| 61 | .method { |
| 62 | margin-top: 1em; |
| 63 | border: solid 1px #CCC; |
| 64 | padding: 1em; |
| 65 | background: #EEE; |
| 66 | } |
| 67 | |
| 68 | .details { |
| 69 | font-weight: bold; |
| 70 | font-size: 14px; |
| 71 | } |
| 72 | |
| 73 | </style> |
| 74 | |
| 75 | <h1><a href="drive_v2.html">Drive API</a> . <a href="drive_v2.files.html">files</a></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 78 | <code><a href="#copy">copy(fileId, body=None, convert=None, enforceSingleParent=None, ocr=None, ocrLanguage=None, pinned=None, supportsAllDrives=None, supportsTeamDrives=None, timedTextLanguage=None, timedTextTrackName=None, visibility=None)</a></code></p> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 79 | <p class="firstline">Creates a copy of the specified file.</p> |
| 80 | <p class="toc_element"> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 81 | <code><a href="#delete">delete(fileId, supportsAllDrives=None, supportsTeamDrives=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 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 shared drive files.</p> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 83 | <p class="toc_element"> |
| Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 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"> |
| Sai Cheemalapati | df61397 | 2016-10-21 13:59:49 -0700 | [diff] [blame] | 87 | <code><a href="#export">export(fileId, mimeType)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 88 | <p class="firstline">Exports a Google Doc to the requested MIME type and returns the exported content. Please note that the exported content is limited to 10MB.</p> |
| Sai Cheemalapati | df61397 | 2016-10-21 13:59:49 -0700 | [diff] [blame] | 89 | <p class="toc_element"> |
| 90 | <code><a href="#export_media">export_media(fileId, mimeType)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 91 | <p class="firstline">Exports a Google Doc to the requested MIME type and returns the exported content. Please note that the exported content is limited to 10MB.</p> |
| Sai Cheemalapati | df61397 | 2016-10-21 13:59:49 -0700 | [diff] [blame] | 92 | <p class="toc_element"> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 93 | <code><a href="#generateIds">generateIds(maxResults=None, space=None)</a></code></p> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 94 | <p class="firstline">Generates a set of file IDs which can be provided in insert or copy requests.</p> |
| Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 95 | <p class="toc_element"> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 96 | <code><a href="#get">get(fileId, acknowledgeAbuse=None, projection=None, revisionId=None, supportsAllDrives=None, supportsTeamDrives=None, updateViewedDate=None)</a></code></p> |
| Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [diff] [blame] | 97 | <p class="firstline">Gets a file's metadata by ID.</p> |
| 98 | <p class="toc_element"> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 99 | <code><a href="#get_media">get_media(fileId, acknowledgeAbuse=None, projection=None, revisionId=None, supportsAllDrives=None, supportsTeamDrives=None, updateViewedDate=None)</a></code></p> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 100 | <p class="firstline">Gets a file's metadata by ID.</p> |
| 101 | <p class="toc_element"> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 102 | <code><a href="#insert">insert(body=None, convert=None, enforceSingleParent=None, ocr=None, ocrLanguage=None, pinned=None, supportsAllDrives=None, supportsTeamDrives=None, timedTextLanguage=None, timedTextTrackName=None, useContentAsIndexableText=None, visibility=None, media_body=None, media_mime_type=None)</a></code></p> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 103 | <p class="firstline">Insert a new file.</p> |
| 104 | <p class="toc_element"> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 105 | <code><a href="#list">list(corpora=None, corpus=None, driveId=None, includeItemsFromAllDrives=None, includeTeamDriveItems=None, maxResults=None, orderBy=None, pageToken=None, projection=None, q=None, spaces=None, supportsAllDrives=None, supportsTeamDrives=None, teamDriveId=None)</a></code></p> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 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"> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 111 | <code><a href="#patch">patch(fileId, body=None, addParents=None, convert=None, enforceSingleParent=None, modifiedDateBehavior=None, newRevision=None, ocr=None, ocrLanguage=None, pinned=None, removeParents=None, setModifiedDate=None, supportsAllDrives=None, supportsTeamDrives=None, timedTextLanguage=None, timedTextTrackName=None, updateViewedDate=None, useContentAsIndexableText=None)</a></code></p> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 112 | <p class="firstline">Updates file metadata and/or content. This method supports patch semantics.</p> |
| 113 | <p class="toc_element"> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 114 | <code><a href="#touch">touch(fileId, supportsAllDrives=None, supportsTeamDrives=None)</a></code></p> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 115 | <p class="firstline">Set the file's updated time to the current server time.</p> |
| 116 | <p class="toc_element"> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 117 | <code><a href="#trash">trash(fileId, supportsAllDrives=None, supportsTeamDrives=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 118 | <p class="firstline">Moves a file to the trash. The currently authenticated user must own the file or be at least a fileOrganizer on the parent for shared drive files.</p> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 119 | <p class="toc_element"> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 120 | <code><a href="#untrash">untrash(fileId, supportsAllDrives=None, supportsTeamDrives=None)</a></code></p> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 121 | <p class="firstline">Restores a file from the trash.</p> |
| 122 | <p class="toc_element"> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 123 | <code><a href="#update">update(fileId, body=None, addParents=None, convert=None, enforceSingleParent=None, modifiedDateBehavior=None, newRevision=None, ocr=None, ocrLanguage=None, pinned=None, removeParents=None, setModifiedDate=None, supportsAllDrives=None, supportsTeamDrives=None, timedTextLanguage=None, timedTextTrackName=None, updateViewedDate=None, useContentAsIndexableText=None, media_body=None, media_mime_type=None)</a></code></p> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 124 | <p class="firstline">Updates file metadata and/or content.</p> |
| 125 | <p class="toc_element"> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 126 | <code><a href="#watch">watch(fileId, body=None, acknowledgeAbuse=None, projection=None, revisionId=None, supportsAllDrives=None, supportsTeamDrives=None, updateViewedDate=None)</a></code></p> |
| Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [diff] [blame] | 127 | <p class="firstline">Subscribe to changes on a file</p> |
| 128 | <p class="toc_element"> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 129 | <code><a href="#watch_media">watch_media(fileId, body=None, acknowledgeAbuse=None, projection=None, revisionId=None, supportsAllDrives=None, supportsTeamDrives=None, updateViewedDate=None)</a></code></p> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 130 | <p class="firstline">Subscribe to changes on a file</p> |
| 131 | <h3>Method Details</h3> |
| 132 | <div class="method"> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 133 | <code class="details" id="copy">copy(fileId, body=None, convert=None, enforceSingleParent=None, ocr=None, ocrLanguage=None, pinned=None, supportsAllDrives=None, supportsTeamDrives=None, timedTextLanguage=None, timedTextTrackName=None, visibility=None)</code> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 134 | <pre>Creates a copy of the specified file. |
| 135 | |
| 136 | Args: |
| 137 | fileId: string, The ID of the file to copy. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 138 | body: object, The request body. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 139 | The object takes the form of: |
| 140 | |
| 141 | { # The metadata for a file. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 142 | "alternateLink": "A String", # A link for opening the file in a relevant Google editor or viewer. |
| 143 | "appDataContents": True or False, # Whether this file is in the Application Data folder. |
| 144 | "canComment": True or False, # Deprecated: use capabilities/canComment. |
| 145 | "canReadRevisions": True or False, # Deprecated: use capabilities/canReadRevisions. |
| 146 | "capabilities": { # Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take. |
| 147 | "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. |
| 148 | "canAddMyDriveParent": True or False, # Whether the current user can add a parent for the item without removing an existing parent in the same request. Not populated for shared drive files. |
| 149 | "canChangeCopyRequiresWriterPermission": True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this file. |
| 150 | "canChangeRestrictedDownload": True or False, # Deprecated |
| 151 | "canComment": True or False, # Whether the current user can comment on this file. |
| 152 | "canCopy": True or False, # Whether the current user can copy this file. For an item in a shared drive, whether the current user can copy non-folder descendants of this item, or this item itself if it is not a folder. |
| 153 | "canDelete": True or False, # Whether the current user can delete this file. |
| 154 | "canDeleteChildren": True or False, # Whether the current user can delete children of this folder. This is false when the item is not a folder. Only populated for items in shared drives. |
| 155 | "canDownload": True or False, # Whether the current user can download this file. |
| 156 | "canEdit": True or False, # Whether the current user can edit this file. Other factors may limit the type of changes a user can make to a file. For example, see canChangeCopyRequiresWriterPermission or canModifyContent. |
| 157 | "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. |
| 158 | "canModifyContent": True or False, # Whether the current user can modify the content of this file. |
| 159 | "canMoveChildrenOutOfDrive": True or False, # Whether the current user can move children of this folder outside of the shared drive. This is false when the item is not a folder. Only populated for items in shared drives. |
| 160 | "canMoveChildrenOutOfTeamDrive": True or False, # Deprecated - use canMoveChildrenOutOfDrive instead. |
| 161 | "canMoveChildrenWithinDrive": True or False, # Whether the current user can move children of this folder within the shared drive. This is false when the item is not a folder. Only populated for items in shared drives. |
| 162 | "canMoveChildrenWithinTeamDrive": True or False, # Deprecated - use canMoveChildrenWithinDrive instead. |
| 163 | "canMoveItemIntoTeamDrive": True or False, # Deprecated - use canMoveItemOutOfDrive instead. |
| 164 | "canMoveItemOutOfDrive": True or False, # Whether the current user can move this item outside of this drive by changing its parent. Note that a request to change the parent of the item may still fail depending on the new parent that is being added. |
| 165 | "canMoveItemOutOfTeamDrive": True or False, # Deprecated - use canMoveItemOutOfDrive instead. |
| 166 | "canMoveItemWithinDrive": True or False, # Whether the current user can move this item within this shared drive. Note that a request to change the parent of the item may still fail depending on the new parent that is being added. Only populated for items in shared drives. |
| 167 | "canMoveItemWithinTeamDrive": True or False, # Deprecated - use canMoveItemWithinDrive instead. |
| 168 | "canMoveTeamDriveItem": True or False, # Deprecated - use canMoveItemWithinDrive or canMoveItemOutOfDrive instead. |
| 169 | "canReadDrive": True or False, # Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives. |
| 170 | "canReadRevisions": True or False, # Whether the current user can read the revisions resource of this file. For a shared drive item, whether revisions of non-folder descendants of this item, or this item itself if it is not a folder, can be read. |
| 171 | "canReadTeamDrive": True or False, # Deprecated - use canReadDrive instead. |
| 172 | "canRemoveChildren": True or False, # Whether the current user can remove children from this folder. This is always false when the item is not a folder. For a folder in a shared drive, use canDeleteChildren or canTrashChildren instead. |
| 173 | "canRemoveMyDriveParent": True or False, # Whether the current user can remove a parent from the item without adding another parent in the same request. Not populated for shared drive files. |
| 174 | "canRename": True or False, # Whether the current user can rename this file. |
| 175 | "canShare": True or False, # Whether the current user can modify the sharing settings for this file. |
| 176 | "canTrash": True or False, # Whether the current user can move this file to trash. |
| 177 | "canTrashChildren": True or False, # Whether the current user can trash children of this folder. This is false when the item is not a folder. Only populated for items in shared drives. |
| 178 | "canUntrash": True or False, # Whether the current user can restore this file from trash. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 179 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 180 | "copyRequiresWriterPermission": True or False, # Whether the options to copy, print, or download this file, should be disabled for readers and commenters. |
| 181 | "copyable": True or False, # Deprecated: use capabilities/canCopy. |
| 182 | "createdDate": "A String", # Create time for this file (formatted RFC 3339 timestamp). |
| 183 | "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. |
| 184 | "description": "A String", # A short description of the file. |
| 185 | "downloadUrl": "A String", # Short lived download URL for the file. This field is only populated for files with content stored in Google Drive; it is not populated for Google Docs or shortcut files. |
| 186 | "driveId": "A String", # ID of the shared drive the file resides in. Only populated for items in shared drives. |
| 187 | "editable": True or False, # Deprecated: use capabilities/canEdit. |
| 188 | "embedLink": "A String", # A link for embedding the file. |
| 189 | "etag": "A String", # ETag of the file. |
| 190 | "explicitlyTrashed": True or False, # Whether this file has been explicitly trashed, as opposed to recursively trashed. |
| 191 | "exportLinks": { # Links for exporting Google Docs to specific formats. |
| 192 | "a_key": "A String", # A mapping from export format to URL |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 193 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 194 | "fileExtension": "A String", # The final component of fullFileExtension with trailing text that does not appear to be part of the extension removed. This field is only populated for files with content stored in Google Drive; it is not populated for Google Docs or shortcut files. |
| 195 | "fileSize": "A String", # The size of the file in bytes. This field is only populated for files with content stored in Google Drive; it is not populated for Google Docs or shortcut files. |
| 196 | "folderColorRgb": "A String", # Folder color as an RGB hex string if the file is a folder. The list of supported colors is available in the folderColorPalette field of the About resource. If an unsupported color is specified, it will be changed to the closest color in the palette. Not populated for items in shared drives. |
| 197 | "fullFileExtension": "A String", # The full file extension; extracted from the title. May contain multiple concatenated extensions, such as "tar.gz". Removing an extension from the title does not clear this field; however, changing the extension on the title does update this field. This field is only populated for files with content stored in Google Drive; it is not populated for Google Docs or shortcut files. |
| 198 | "hasAugmentedPermissions": True or False, # Whether there are permissions directly on this file. This field is only populated for items in shared drives. |
| 199 | "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. |
| 200 | "headRevisionId": "A String", # The ID of the file's head revision. This field is only populated for files with content stored in Google Drive; it is not populated for Google Docs or shortcut files. |
| 201 | "iconLink": "A String", # A link to the file's icon. |
| 202 | "id": "A String", # The ID of the file. |
| 203 | "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. |
| 204 | "aperture": 3.14, # The aperture used to create the photo (f-number). |
| 205 | "cameraMake": "A String", # The make of the camera used to create the photo. |
| 206 | "cameraModel": "A String", # The model of the camera used to create the photo. |
| 207 | "colorSpace": "A String", # The color space of the photo. |
| 208 | "date": "A String", # The date and time the photo was taken (EXIF format timestamp). |
| 209 | "exposureBias": 3.14, # The exposure bias of the photo (APEX value). |
| 210 | "exposureMode": "A String", # The exposure mode used to create the photo. |
| 211 | "exposureTime": 3.14, # The length of the exposure, in seconds. |
| 212 | "flashUsed": True or False, # Whether a flash was used to create the photo. |
| 213 | "focalLength": 3.14, # The focal length used to create the photo, in millimeters. |
| 214 | "height": 42, # The height of the image in pixels. |
| 215 | "isoSpeed": 42, # The ISO speed used to create the photo. |
| 216 | "lens": "A String", # The lens used to create the photo. |
| 217 | "location": { # Geographic location information stored in the image. |
| 218 | "altitude": 3.14, # The altitude stored in the image. |
| 219 | "latitude": 3.14, # The latitude stored in the image. |
| 220 | "longitude": 3.14, # The longitude stored in the image. |
| 221 | }, |
| 222 | "maxApertureValue": 3.14, # The smallest f-number of the lens at the focal length used to create the photo (APEX value). |
| 223 | "meteringMode": "A String", # The metering mode used to create the photo. |
| 224 | "rotation": 42, # The number of clockwise 90 degree rotations applied from the image's original orientation. |
| 225 | "sensor": "A String", # The type of sensor used to create the photo. |
| 226 | "subjectDistance": 42, # The distance to the subject of the photo, in meters. |
| 227 | "whiteBalance": "A String", # The white balance mode used to create the photo. |
| 228 | "width": 42, # The width of the image in pixels. |
| 229 | }, |
| 230 | "indexableText": { # Indexable text attributes for the file (can only be written) |
| 231 | "text": "A String", # The text to be indexed for this file. |
| 232 | }, |
| 233 | "isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app. |
| 234 | "kind": "drive#file", # The type of file. This is always drive#file. |
| 235 | "labels": { # A group of labels for the file. |
| 236 | "hidden": True or False, # Deprecated. |
| 237 | "modified": True or False, # Whether the file has been modified by this user. |
| 238 | "restricted": True or False, # Deprecated - use copyRequiresWriterPermission instead. |
| 239 | "starred": True or False, # Whether this file is starred by the user. |
| 240 | "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. |
| 241 | "viewed": True or False, # Whether this file has been viewed by this user. |
| 242 | }, |
| 243 | "lastModifyingUser": { # Information about a Drive user. # The last user to modify this file. |
| 244 | "displayName": "A String", # A plain text displayable name for this user. |
| 245 | "emailAddress": "A String", # The email address of the user. |
| 246 | "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. |
| 247 | "kind": "drive#user", # This is always drive#user. |
| 248 | "permissionId": "A String", # The user's ID as visible in the permissions collection. |
| 249 | "picture": { # The user's profile picture. |
| 250 | "url": "A String", # A URL that points to a profile picture of this user. |
| 251 | }, |
| 252 | }, |
| 253 | "lastModifyingUserName": "A String", # Name of the last user to modify this file. |
| 254 | "lastViewedByMeDate": "A String", # Last time this file was viewed by the user (formatted RFC 3339 timestamp). |
| 255 | "markedViewedByMeDate": "A String", # Deprecated. |
| 256 | "md5Checksum": "A String", # An MD5 checksum for the content of this file. This field is only populated for files with content stored in Google Drive; it is not populated for Google Docs or shortcut files. |
| 257 | "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. |
| 258 | "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. |
| 259 | "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. |
| 260 | "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. |
| 261 | "a_key": "A String", |
| 262 | }, |
| 263 | "originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the title field. This is only available for files with binary content in Google Drive. |
| 264 | "ownedByMe": True or False, # Whether the file is owned by the current user. Not populated for items in shared drives. |
| 265 | "ownerNames": [ # Name(s) of the owner(s) of this file. Not populated for items in shared drives. |
| 266 | "A String", |
| 267 | ], |
| 268 | "owners": [ # The owner(s) of this file. Not populated for items in shared drives. |
| Sai Cheemalapati | df61397 | 2016-10-21 13:59:49 -0700 | [diff] [blame] | 269 | { # Information about a Drive user. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 270 | "displayName": "A String", # A plain text displayable name for this user. |
| 271 | "emailAddress": "A String", # The email address of the user. |
| 272 | "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. |
| 273 | "kind": "drive#user", # This is always drive#user. |
| 274 | "permissionId": "A String", # The user's ID as visible in the permissions collection. |
| 275 | "picture": { # The user's profile picture. |
| 276 | "url": "A String", # A URL that points to a profile picture of this user. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 277 | }, |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 278 | }, |
| 279 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 280 | "parents": [ # Collection of parent folders which contain this file. |
| 281 | # If not specified as part of an insert request, the file will be placed directly in the user's My Drive folder. If not specified as part of a copy request, the file will inherit any discoverable parents of the source file. Update requests can also use the addParents and removeParents parameters to modify the parents list. |
| 282 | { # A reference to a file's parent. |
| 283 | "id": "A String", # The ID of the parent. |
| 284 | "isRoot": True or False, # Whether or not the parent is the root folder. |
| 285 | "kind": "drive#parentReference", # This is always drive#parentReference. |
| 286 | "parentLink": "A String", # A link to the parent. |
| 287 | "selfLink": "A String", # A link back to this reference. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 288 | }, |
| 289 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 290 | "permissionIds": [ # List of permission IDs for users with access to this file. |
| 291 | "A String", |
| 292 | ], |
| 293 | "permissions": [ # The list of permissions for users with access to this file. Not populated for items in shared drives. |
| 294 | { # A permission for a file. |
| 295 | "additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future. |
| 296 | "A String", |
| 297 | ], |
| 298 | "authKey": "A String", # Deprecated. |
| 299 | "deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions. |
| 300 | "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. |
| 301 | "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. |
| 302 | "etag": "A String", # The ETag of the permission. |
| 303 | "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: |
| 304 | # - They cannot be set on shared drive items |
| 305 | # - They can only be set on user and group permissions |
| 306 | # - The date must be in the future |
| 307 | # - The date cannot be more than a year in the future |
| 308 | # - The date can only be set on drive.permissions.update or drive.permissions.patch requests |
| 309 | "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. |
| 310 | "kind": "drive#permission", # This is always drive#permission. |
| 311 | "name": "A String", # The name for this permission. |
| 312 | "permissionDetails": [ # Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. |
| 313 | { |
| 314 | "additionalRoles": [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future. |
| 315 | "A String", |
| 316 | ], |
| 317 | "inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field. |
| 318 | "inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field. |
| 319 | "permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible: |
| 320 | # - file |
| 321 | # - member |
| 322 | "role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible: |
| 323 | # - organizer |
| 324 | # - fileOrganizer |
| 325 | # - writer |
| 326 | # - reader |
| 327 | }, |
| 328 | ], |
| 329 | "photoLink": "A String", # A link to the profile photo, if available. |
| 330 | "role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: |
| 331 | # - owner |
| 332 | # - organizer |
| 333 | # - fileOrganizer |
| 334 | # - writer |
| 335 | # - reader |
| 336 | "selfLink": "A String", # A link back to this permission. |
| 337 | "teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead. |
| 338 | { |
| 339 | "additionalRoles": [ # Deprecated - use permissionDetails/additionalRoles instead. |
| 340 | "A String", |
| 341 | ], |
| 342 | "inherited": True or False, # Deprecated - use permissionDetails/inherited instead. |
| 343 | "inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead. |
| 344 | "role": "A String", # Deprecated - use permissionDetails/role instead. |
| 345 | "teamDrivePermissionType": "A String", # Deprecated - use permissionDetails/permissionType instead. |
| 346 | }, |
| 347 | ], |
| 348 | "type": "A String", # The account type. Allowed values are: |
| 349 | # - user |
| 350 | # - group |
| 351 | # - domain |
| 352 | # - anyone |
| 353 | "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. |
| 354 | "withLink": True or False, # Whether the link is required for this permission. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 355 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 356 | ], |
| 357 | "properties": [ # The list of properties. |
| Nathaniel Manista | 4f877e5 | 2015-06-15 16:44:50 +0000 | [diff] [blame] | 358 | { # A key-value pair attached to a file that is either public or private to an application. |
| 359 | # The following limits apply to file properties: |
| 360 | # - Maximum of 100 properties total per file |
| 361 | # - Maximum of 30 private properties per app |
| 362 | # - Maximum of 30 public properties |
| 363 | # - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 364 | "etag": "A String", # ETag of the property. |
| 365 | "key": "A String", # The key of this property. |
| 366 | "kind": "drive#property", # This is always drive#property. |
| 367 | "selfLink": "A String", # The link back to this property. |
| 368 | "value": "A String", # The value of this property. |
| 369 | "visibility": "A String", # The visibility of this property. Allowed values are PRIVATE and PUBLIC. (Default: PRIVATE) |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 370 | }, |
| 371 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 372 | "quotaBytesUsed": "A String", # The number of quota bytes used by this file. |
| 373 | "selfLink": "A String", # A link back to this file. |
| 374 | "shareable": True or False, # Deprecated: use capabilities/canShare. |
| 375 | "shared": True or False, # Whether the file has been shared. Not populated for items in shared drives. |
| 376 | "sharedWithMeDate": "A String", # Time at which this file was shared with the user (formatted RFC 3339 timestamp). |
| 377 | "sharingUser": { # Information about a Drive user. # User that shared the item with the current user, if available. |
| 378 | "displayName": "A String", # A plain text displayable name for this user. |
| 379 | "emailAddress": "A String", # The email address of the user. |
| 380 | "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. |
| 381 | "kind": "drive#user", # This is always drive#user. |
| 382 | "permissionId": "A String", # The user's ID as visible in the permissions collection. |
| 383 | "picture": { # The user's profile picture. |
| 384 | "url": "A String", # A URL that points to a profile picture of this user. |
| 385 | }, |
| Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 386 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 387 | "shortcutDetails": { # Shortcut file details. Only populated for shortcut files, which have the mimeType field set to application/vnd.google-apps.shortcut. |
| 388 | "targetId": "A String", # The ID of the file that this shortcut points to. |
| 389 | "targetMimeType": "A String", # The MIME type of the file that this shortcut points to. The value of this field is a snapshot of the target's MIME type, captured when the shortcut is created. |
| 390 | }, |
| 391 | "spaces": [ # The list of spaces which contain the file. Supported values are 'drive', 'appDataFolder' and 'photos'. |
| 392 | "A String", |
| 393 | ], |
| 394 | "teamDriveId": "A String", # Deprecated - use driveId instead. |
| 395 | "thumbnail": { # A thumbnail for the file. This will only be used if a standard thumbnail cannot be generated. |
| 396 | "image": "A String", # The URL-safe Base64 encoded bytes of the thumbnail image. It should conform to RFC 4648 section 5. |
| 397 | "mimeType": "A String", # The MIME type of the thumbnail. |
| 398 | }, |
| 399 | "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. |
| 400 | "thumbnailVersion": "A String", # The thumbnail version for use in thumbnail cache invalidation. |
| 401 | "title": "A String", # The title of this file. Note that for immutable items such as the top level folders of shared drives, My Drive root folder, and Application Data folder the title is constant. |
| 402 | "trashedDate": "A String", # The time that the item was trashed (formatted RFC 3339 timestamp). Only populated for items in shared drives. |
| 403 | "trashingUser": { # Information about a Drive user. # If the file has been explicitly trashed, the user who trashed it. Only populated for items in shared drives. |
| 404 | "displayName": "A String", # A plain text displayable name for this user. |
| 405 | "emailAddress": "A String", # The email address of the user. |
| 406 | "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. |
| 407 | "kind": "drive#user", # This is always drive#user. |
| 408 | "permissionId": "A String", # The user's ID as visible in the permissions collection. |
| 409 | "picture": { # The user's profile picture. |
| 410 | "url": "A String", # A URL that points to a profile picture of this user. |
| 411 | }, |
| 412 | }, |
| 413 | "userPermission": { # A permission for a file. # The permissions for the authenticated user on this file. |
| 414 | "additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future. |
| 415 | "A String", |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 416 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 417 | "authKey": "A String", # Deprecated. |
| 418 | "deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions. |
| 419 | "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. |
| 420 | "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. |
| 421 | "etag": "A String", # The ETag of the permission. |
| 422 | "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 423 | # - They cannot be set on shared drive items |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 424 | # - They can only be set on user and group permissions |
| 425 | # - The date must be in the future |
| 426 | # - The date cannot be more than a year in the future |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 427 | # - The date can only be set on drive.permissions.update or drive.permissions.patch requests |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 428 | "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. |
| 429 | "kind": "drive#permission", # This is always drive#permission. |
| 430 | "name": "A String", # The name for this permission. |
| 431 | "permissionDetails": [ # Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. |
| 432 | { |
| 433 | "additionalRoles": [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future. |
| 434 | "A String", |
| 435 | ], |
| 436 | "inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field. |
| 437 | "inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field. |
| 438 | "permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible: |
| 439 | # - file |
| 440 | # - member |
| 441 | "role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible: |
| 442 | # - organizer |
| 443 | # - fileOrganizer |
| 444 | # - writer |
| 445 | # - reader |
| 446 | }, |
| 447 | ], |
| 448 | "photoLink": "A String", # A link to the profile photo, if available. |
| 449 | "role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 450 | # - owner |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 451 | # - organizer |
| 452 | # - fileOrganizer |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 453 | # - writer |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 454 | # - reader |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 455 | "selfLink": "A String", # A link back to this permission. |
| 456 | "teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead. |
| 457 | { |
| 458 | "additionalRoles": [ # Deprecated - use permissionDetails/additionalRoles instead. |
| 459 | "A String", |
| 460 | ], |
| 461 | "inherited": True or False, # Deprecated - use permissionDetails/inherited instead. |
| 462 | "inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead. |
| 463 | "role": "A String", # Deprecated - use permissionDetails/role instead. |
| 464 | "teamDrivePermissionType": "A String", # Deprecated - use permissionDetails/permissionType instead. |
| 465 | }, |
| 466 | ], |
| 467 | "type": "A String", # The account type. Allowed values are: |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 468 | # - user |
| 469 | # - group |
| 470 | # - domain |
| 471 | # - anyone |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 472 | "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. |
| 473 | "withLink": True or False, # Whether the link is required for this permission. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 474 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 475 | "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. |
| 476 | "videoMediaMetadata": { # Metadata about video media. This will only be present for video types. |
| 477 | "durationMillis": "A String", # The duration of the video in milliseconds. |
| 478 | "height": 42, # The height of the video in pixels. |
| 479 | "width": 42, # The width of the video in pixels. |
| 480 | }, |
| 481 | "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. |
| 482 | "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. |
| 483 | "writersCanShare": True or False, # Whether writers can share the document with other users. Not populated for items in shared drives. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 484 | } |
| 485 | |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 486 | convert: boolean, Whether to convert this file to the corresponding Google Docs format. |
| 487 | enforceSingleParent: boolean, Set to true to opt in to API behavior that aims for all items to have exactly one parent. This parameter only takes effect if the item is not in a shared drive. Requests that specify more than one parent fail. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 488 | ocr: boolean, Whether to attempt OCR on .jpg, .png, .gif, or .pdf uploads. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 489 | ocrLanguage: string, If ocr is true, hints at the language to use. Valid values are BCP 47 codes. |
| 490 | pinned: boolean, Whether to pin the head revision of the new copy. A file can have a maximum of 200 pinned revisions. |
| 491 | supportsAllDrives: boolean, Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives. |
| 492 | supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead. |
| 493 | timedTextLanguage: string, The language of the timed text. |
| 494 | timedTextTrackName: string, The timed text track name. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 495 | 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. |
| 496 | Allowed values |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 497 | DEFAULT - The visibility of the new file is determined by the user's default visibility/sharing policies. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 498 | PRIVATE - The new file will be visible to only the owner. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 499 | |
| 500 | Returns: |
| 501 | An object of the form: |
| 502 | |
| 503 | { # The metadata for a file. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 504 | "alternateLink": "A String", # A link for opening the file in a relevant Google editor or viewer. |
| 505 | "appDataContents": True or False, # Whether this file is in the Application Data folder. |
| 506 | "canComment": True or False, # Deprecated: use capabilities/canComment. |
| 507 | "canReadRevisions": True or False, # Deprecated: use capabilities/canReadRevisions. |
| 508 | "capabilities": { # Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take. |
| 509 | "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. |
| 510 | "canAddMyDriveParent": True or False, # Whether the current user can add a parent for the item without removing an existing parent in the same request. Not populated for shared drive files. |
| 511 | "canChangeCopyRequiresWriterPermission": True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this file. |
| 512 | "canChangeRestrictedDownload": True or False, # Deprecated |
| 513 | "canComment": True or False, # Whether the current user can comment on this file. |
| 514 | "canCopy": True or False, # Whether the current user can copy this file. For an item in a shared drive, whether the current user can copy non-folder descendants of this item, or this item itself if it is not a folder. |
| 515 | "canDelete": True or False, # Whether the current user can delete this file. |
| 516 | "canDeleteChildren": True or False, # Whether the current user can delete children of this folder. This is false when the item is not a folder. Only populated for items in shared drives. |
| 517 | "canDownload": True or False, # Whether the current user can download this file. |
| 518 | "canEdit": True or False, # Whether the current user can edit this file. Other factors may limit the type of changes a user can make to a file. For example, see canChangeCopyRequiresWriterPermission or canModifyContent. |
| 519 | "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. |
| 520 | "canModifyContent": True or False, # Whether the current user can modify the content of this file. |
| 521 | "canMoveChildrenOutOfDrive": True or False, # Whether the current user can move children of this folder outside of the shared drive. This is false when the item is not a folder. Only populated for items in shared drives. |
| 522 | "canMoveChildrenOutOfTeamDrive": True or False, # Deprecated - use canMoveChildrenOutOfDrive instead. |
| 523 | "canMoveChildrenWithinDrive": True or False, # Whether the current user can move children of this folder within the shared drive. This is false when the item is not a folder. Only populated for items in shared drives. |
| 524 | "canMoveChildrenWithinTeamDrive": True or False, # Deprecated - use canMoveChildrenWithinDrive instead. |
| 525 | "canMoveItemIntoTeamDrive": True or False, # Deprecated - use canMoveItemOutOfDrive instead. |
| 526 | "canMoveItemOutOfDrive": True or False, # Whether the current user can move this item outside of this drive by changing its parent. Note that a request to change the parent of the item may still fail depending on the new parent that is being added. |
| 527 | "canMoveItemOutOfTeamDrive": True or False, # Deprecated - use canMoveItemOutOfDrive instead. |
| 528 | "canMoveItemWithinDrive": True or False, # Whether the current user can move this item within this shared drive. Note that a request to change the parent of the item may still fail depending on the new parent that is being added. Only populated for items in shared drives. |
| 529 | "canMoveItemWithinTeamDrive": True or False, # Deprecated - use canMoveItemWithinDrive instead. |
| 530 | "canMoveTeamDriveItem": True or False, # Deprecated - use canMoveItemWithinDrive or canMoveItemOutOfDrive instead. |
| 531 | "canReadDrive": True or False, # Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives. |
| 532 | "canReadRevisions": True or False, # Whether the current user can read the revisions resource of this file. For a shared drive item, whether revisions of non-folder descendants of this item, or this item itself if it is not a folder, can be read. |
| 533 | "canReadTeamDrive": True or False, # Deprecated - use canReadDrive instead. |
| 534 | "canRemoveChildren": True or False, # Whether the current user can remove children from this folder. This is always false when the item is not a folder. For a folder in a shared drive, use canDeleteChildren or canTrashChildren instead. |
| 535 | "canRemoveMyDriveParent": True or False, # Whether the current user can remove a parent from the item without adding another parent in the same request. Not populated for shared drive files. |
| 536 | "canRename": True or False, # Whether the current user can rename this file. |
| 537 | "canShare": True or False, # Whether the current user can modify the sharing settings for this file. |
| 538 | "canTrash": True or False, # Whether the current user can move this file to trash. |
| 539 | "canTrashChildren": True or False, # Whether the current user can trash children of this folder. This is false when the item is not a folder. Only populated for items in shared drives. |
| 540 | "canUntrash": True or False, # Whether the current user can restore this file from trash. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 541 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 542 | "copyRequiresWriterPermission": True or False, # Whether the options to copy, print, or download this file, should be disabled for readers and commenters. |
| 543 | "copyable": True or False, # Deprecated: use capabilities/canCopy. |
| 544 | "createdDate": "A String", # Create time for this file (formatted RFC 3339 timestamp). |
| 545 | "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. |
| 546 | "description": "A String", # A short description of the file. |
| 547 | "downloadUrl": "A String", # Short lived download URL for the file. This field is only populated for files with content stored in Google Drive; it is not populated for Google Docs or shortcut files. |
| 548 | "driveId": "A String", # ID of the shared drive the file resides in. Only populated for items in shared drives. |
| 549 | "editable": True or False, # Deprecated: use capabilities/canEdit. |
| 550 | "embedLink": "A String", # A link for embedding the file. |
| 551 | "etag": "A String", # ETag of the file. |
| 552 | "explicitlyTrashed": True or False, # Whether this file has been explicitly trashed, as opposed to recursively trashed. |
| 553 | "exportLinks": { # Links for exporting Google Docs to specific formats. |
| 554 | "a_key": "A String", # A mapping from export format to URL |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 555 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 556 | "fileExtension": "A String", # The final component of fullFileExtension with trailing text that does not appear to be part of the extension removed. This field is only populated for files with content stored in Google Drive; it is not populated for Google Docs or shortcut files. |
| 557 | "fileSize": "A String", # The size of the file in bytes. This field is only populated for files with content stored in Google Drive; it is not populated for Google Docs or shortcut files. |
| 558 | "folderColorRgb": "A String", # Folder color as an RGB hex string if the file is a folder. The list of supported colors is available in the folderColorPalette field of the About resource. If an unsupported color is specified, it will be changed to the closest color in the palette. Not populated for items in shared drives. |
| 559 | "fullFileExtension": "A String", # The full file extension; extracted from the title. May contain multiple concatenated extensions, such as "tar.gz". Removing an extension from the title does not clear this field; however, changing the extension on the title does update this field. This field is only populated for files with content stored in Google Drive; it is not populated for Google Docs or shortcut files. |
| 560 | "hasAugmentedPermissions": True or False, # Whether there are permissions directly on this file. This field is only populated for items in shared drives. |
| 561 | "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. |
| 562 | "headRevisionId": "A String", # The ID of the file's head revision. This field is only populated for files with content stored in Google Drive; it is not populated for Google Docs or shortcut files. |
| 563 | "iconLink": "A String", # A link to the file's icon. |
| 564 | "id": "A String", # The ID of the file. |
| 565 | "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. |
| 566 | "aperture": 3.14, # The aperture used to create the photo (f-number). |
| 567 | "cameraMake": "A String", # The make of the camera used to create the photo. |
| 568 | "cameraModel": "A String", # The model of the camera used to create the photo. |
| 569 | "colorSpace": "A String", # The color space of the photo. |
| 570 | "date": "A String", # The date and time the photo was taken (EXIF format timestamp). |
| 571 | "exposureBias": 3.14, # The exposure bias of the photo (APEX value). |
| 572 | "exposureMode": "A String", # The exposure mode used to create the photo. |
| 573 | "exposureTime": 3.14, # The length of the exposure, in seconds. |
| 574 | "flashUsed": True or False, # Whether a flash was used to create the photo. |
| 575 | "focalLength": 3.14, # The focal length used to create the photo, in millimeters. |
| 576 | "height": 42, # The height of the image in pixels. |
| 577 | "isoSpeed": 42, # The ISO speed used to create the photo. |
| 578 | "lens": "A String", # The lens used to create the photo. |
| 579 | "location": { # Geographic location information stored in the image. |
| 580 | "altitude": 3.14, # The altitude stored in the image. |
| 581 | "latitude": 3.14, # The latitude stored in the image. |
| 582 | "longitude": 3.14, # The longitude stored in the image. |
| 583 | }, |
| 584 | "maxApertureValue": 3.14, # The smallest f-number of the lens at the focal length used to create the photo (APEX value). |
| 585 | "meteringMode": "A String", # The metering mode used to create the photo. |
| 586 | "rotation": 42, # The number of clockwise 90 degree rotations applied from the image's original orientation. |
| 587 | "sensor": "A String", # The type of sensor used to create the photo. |
| 588 | "subjectDistance": 42, # The distance to the subject of the photo, in meters. |
| 589 | "whiteBalance": "A String", # The white balance mode used to create the photo. |
| 590 | "width": 42, # The width of the image in pixels. |
| 591 | }, |
| 592 | "indexableText": { # Indexable text attributes for the file (can only be written) |
| 593 | "text": "A String", # The text to be indexed for this file. |
| 594 | }, |
| 595 | "isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app. |
| 596 | "kind": "drive#file", # The type of file. This is always drive#file. |
| 597 | "labels": { # A group of labels for the file. |
| 598 | "hidden": True or False, # Deprecated. |
| 599 | "modified": True or False, # Whether the file has been modified by this user. |
| 600 | "restricted": True or False, # Deprecated - use copyRequiresWriterPermission instead. |
| 601 | "starred": True or False, # Whether this file is starred by the user. |
| 602 | "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. |
| 603 | "viewed": True or False, # Whether this file has been viewed by this user. |
| 604 | }, |
| 605 | "lastModifyingUser": { # Information about a Drive user. # The last user to modify this file. |
| 606 | "displayName": "A String", # A plain text displayable name for this user. |
| 607 | "emailAddress": "A String", # The email address of the user. |
| 608 | "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. |
| 609 | "kind": "drive#user", # This is always drive#user. |
| 610 | "permissionId": "A String", # The user's ID as visible in the permissions collection. |
| 611 | "picture": { # The user's profile picture. |
| 612 | "url": "A String", # A URL that points to a profile picture of this user. |
| 613 | }, |
| 614 | }, |
| 615 | "lastModifyingUserName": "A String", # Name of the last user to modify this file. |
| 616 | "lastViewedByMeDate": "A String", # Last time this file was viewed by the user (formatted RFC 3339 timestamp). |
| 617 | "markedViewedByMeDate": "A String", # Deprecated. |
| 618 | "md5Checksum": "A String", # An MD5 checksum for the content of this file. This field is only populated for files with content stored in Google Drive; it is not populated for Google Docs or shortcut files. |
| 619 | "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. |
| 620 | "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. |
| 621 | "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. |
| 622 | "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. |
| 623 | "a_key": "A String", |
| 624 | }, |
| 625 | "originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the title field. This is only available for files with binary content in Google Drive. |
| 626 | "ownedByMe": True or False, # Whether the file is owned by the current user. Not populated for items in shared drives. |
| 627 | "ownerNames": [ # Name(s) of the owner(s) of this file. Not populated for items in shared drives. |
| 628 | "A String", |
| 629 | ], |
| 630 | "owners": [ # The owner(s) of this file. Not populated for items in shared drives. |
| Sai Cheemalapati | df61397 | 2016-10-21 13:59:49 -0700 | [diff] [blame] | 631 | { # Information about a Drive user. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 632 | "displayName": "A String", # A plain text displayable name for this user. |
| 633 | "emailAddress": "A String", # The email address of the user. |
| 634 | "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. |
| 635 | "kind": "drive#user", # This is always drive#user. |
| 636 | "permissionId": "A String", # The user's ID as visible in the permissions collection. |
| 637 | "picture": { # The user's profile picture. |
| 638 | "url": "A String", # A URL that points to a profile picture of this user. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 639 | }, |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 640 | }, |
| 641 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 642 | "parents": [ # Collection of parent folders which contain this file. |
| 643 | # If not specified as part of an insert request, the file will be placed directly in the user's My Drive folder. If not specified as part of a copy request, the file will inherit any discoverable parents of the source file. Update requests can also use the addParents and removeParents parameters to modify the parents list. |
| 644 | { # A reference to a file's parent. |
| 645 | "id": "A String", # The ID of the parent. |
| 646 | "isRoot": True or False, # Whether or not the parent is the root folder. |
| 647 | "kind": "drive#parentReference", # This is always drive#parentReference. |
| 648 | "parentLink": "A String", # A link to the parent. |
| 649 | "selfLink": "A String", # A link back to this reference. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 650 | }, |
| 651 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 652 | "permissionIds": [ # List of permission IDs for users with access to this file. |
| 653 | "A String", |
| 654 | ], |
| 655 | "permissions": [ # The list of permissions for users with access to this file. Not populated for items in shared drives. |
| 656 | { # A permission for a file. |
| 657 | "additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future. |
| 658 | "A String", |
| 659 | ], |
| 660 | "authKey": "A String", # Deprecated. |
| 661 | "deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions. |
| 662 | "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. |
| 663 | "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. |
| 664 | "etag": "A String", # The ETag of the permission. |
| 665 | "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: |
| 666 | # - They cannot be set on shared drive items |
| 667 | # - They can only be set on user and group permissions |
| 668 | # - The date must be in the future |
| 669 | # - The date cannot be more than a year in the future |
| 670 | # - The date can only be set on drive.permissions.update or drive.permissions.patch requests |
| 671 | "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. |
| 672 | "kind": "drive#permission", # This is always drive#permission. |
| 673 | "name": "A String", # The name for this permission. |
| 674 | "permissionDetails": [ # Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. |
| 675 | { |
| 676 | "additionalRoles": [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future. |
| 677 | "A String", |
| 678 | ], |
| 679 | "inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field. |
| 680 | "inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field. |
| 681 | "permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible: |
| 682 | # - file |
| 683 | # - member |
| 684 | "role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible: |
| 685 | # - organizer |
| 686 | # - fileOrganizer |
| 687 | # - writer |
| 688 | # - reader |
| 689 | }, |
| 690 | ], |
| 691 | "photoLink": "A String", # A link to the profile photo, if available. |
| 692 | "role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: |
| 693 | # - owner |
| 694 | # - organizer |
| 695 | # - fileOrganizer |
| 696 | # - writer |
| 697 | # - reader |
| 698 | "selfLink": "A String", # A link back to this permission. |
| 699 | "teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead. |
| 700 | { |
| 701 | "additionalRoles": [ # Deprecated - use permissionDetails/additionalRoles instead. |
| 702 | "A String", |
| 703 | ], |
| 704 | "inherited": True or False, # Deprecated - use permissionDetails/inherited instead. |
| 705 | "inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead. |
| 706 | "role": "A String", # Deprecated - use permissionDetails/role instead. |
| 707 | "teamDrivePermissionType": "A String", # Deprecated - use permissionDetails/permissionType instead. |
| 708 | }, |
| 709 | ], |
| 710 | "type": "A String", # The account type. Allowed values are: |
| 711 | # - user |
| 712 | # - group |
| 713 | # - domain |
| 714 | # - anyone |
| 715 | "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. |
| 716 | "withLink": True or False, # Whether the link is required for this permission. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 717 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 718 | ], |
| 719 | "properties": [ # The list of properties. |
| Nathaniel Manista | 4f877e5 | 2015-06-15 16:44:50 +0000 | [diff] [blame] | 720 | { # A key-value pair attached to a file that is either public or private to an application. |
| 721 | # The following limits apply to file properties: |
| 722 | # - Maximum of 100 properties total per file |
| 723 | # - Maximum of 30 private properties per app |
| 724 | # - Maximum of 30 public properties |
| 725 | # - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 726 | "etag": "A String", # ETag of the property. |
| 727 | "key": "A String", # The key of this property. |
| 728 | "kind": "drive#property", # This is always drive#property. |
| 729 | "selfLink": "A String", # The link back to this property. |
| 730 | "value": "A String", # The value of this property. |
| 731 | "visibility": "A String", # The visibility of this property. Allowed values are PRIVATE and PUBLIC. (Default: PRIVATE) |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 732 | }, |
| 733 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 734 | "quotaBytesUsed": "A String", # The number of quota bytes used by this file. |
| 735 | "selfLink": "A String", # A link back to this file. |
| 736 | "shareable": True or False, # Deprecated: use capabilities/canShare. |
| 737 | "shared": True or False, # Whether the file has been shared. Not populated for items in shared drives. |
| 738 | "sharedWithMeDate": "A String", # Time at which this file was shared with the user (formatted RFC 3339 timestamp). |
| 739 | "sharingUser": { # Information about a Drive user. # User that shared the item with the current user, if available. |
| 740 | "displayName": "A String", # A plain text displayable name for this user. |
| 741 | "emailAddress": "A String", # The email address of the user. |
| 742 | "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. |
| 743 | "kind": "drive#user", # This is always drive#user. |
| 744 | "permissionId": "A String", # The user's ID as visible in the permissions collection. |
| 745 | "picture": { # The user's profile picture. |
| 746 | "url": "A String", # A URL that points to a profile picture of this user. |
| 747 | }, |
| Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 748 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 749 | "shortcutDetails": { # Shortcut file details. Only populated for shortcut files, which have the mimeType field set to application/vnd.google-apps.shortcut. |
| 750 | "targetId": "A String", # The ID of the file that this shortcut points to. |
| 751 | "targetMimeType": "A String", # The MIME type of the file that this shortcut points to. The value of this field is a snapshot of the target's MIME type, captured when the shortcut is created. |
| 752 | }, |
| 753 | "spaces": [ # The list of spaces which contain the file. Supported values are 'drive', 'appDataFolder' and 'photos'. |
| 754 | "A String", |
| 755 | ], |
| 756 | "teamDriveId": "A String", # Deprecated - use driveId instead. |
| 757 | "thumbnail": { # A thumbnail for the file. This will only be used if a standard thumbnail cannot be generated. |
| 758 | "image": "A String", # The URL-safe Base64 encoded bytes of the thumbnail image. It should conform to RFC 4648 section 5. |
| 759 | "mimeType": "A String", # The MIME type of the thumbnail. |
| 760 | }, |
| 761 | "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. |
| 762 | "thumbnailVersion": "A String", # The thumbnail version for use in thumbnail cache invalidation. |
| 763 | "title": "A String", # The title of this file. Note that for immutable items such as the top level folders of shared drives, My Drive root folder, and Application Data folder the title is constant. |
| 764 | "trashedDate": "A String", # The time that the item was trashed (formatted RFC 3339 timestamp). Only populated for items in shared drives. |
| 765 | "trashingUser": { # Information about a Drive user. # If the file has been explicitly trashed, the user who trashed it. Only populated for items in shared drives. |
| 766 | "displayName": "A String", # A plain text displayable name for this user. |
| 767 | "emailAddress": "A String", # The email address of the user. |
| 768 | "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. |
| 769 | "kind": "drive#user", # This is always drive#user. |
| 770 | "permissionId": "A String", # The user's ID as visible in the permissions collection. |
| 771 | "picture": { # The user's profile picture. |
| 772 | "url": "A String", # A URL that points to a profile picture of this user. |
| 773 | }, |
| 774 | }, |
| 775 | "userPermission": { # A permission for a file. # The permissions for the authenticated user on this file. |
| 776 | "additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future. |
| 777 | "A String", |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 778 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 779 | "authKey": "A String", # Deprecated. |
| 780 | "deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions. |
| 781 | "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. |
| 782 | "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. |
| 783 | "etag": "A String", # The ETag of the permission. |
| 784 | "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 785 | # - They cannot be set on shared drive items |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 786 | # - They can only be set on user and group permissions |
| 787 | # - The date must be in the future |
| 788 | # - The date cannot be more than a year in the future |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 789 | # - The date can only be set on drive.permissions.update or drive.permissions.patch requests |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 790 | "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. |
| 791 | "kind": "drive#permission", # This is always drive#permission. |
| 792 | "name": "A String", # The name for this permission. |
| 793 | "permissionDetails": [ # Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. |
| 794 | { |
| 795 | "additionalRoles": [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future. |
| 796 | "A String", |
| 797 | ], |
| 798 | "inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field. |
| 799 | "inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field. |
| 800 | "permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible: |
| 801 | # - file |
| 802 | # - member |
| 803 | "role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible: |
| 804 | # - organizer |
| 805 | # - fileOrganizer |
| 806 | # - writer |
| 807 | # - reader |
| 808 | }, |
| 809 | ], |
| 810 | "photoLink": "A String", # A link to the profile photo, if available. |
| 811 | "role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 812 | # - owner |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 813 | # - organizer |
| 814 | # - fileOrganizer |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 815 | # - writer |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 816 | # - reader |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 817 | "selfLink": "A String", # A link back to this permission. |
| 818 | "teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead. |
| 819 | { |
| 820 | "additionalRoles": [ # Deprecated - use permissionDetails/additionalRoles instead. |
| 821 | "A String", |
| 822 | ], |
| 823 | "inherited": True or False, # Deprecated - use permissionDetails/inherited instead. |
| 824 | "inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead. |
| 825 | "role": "A String", # Deprecated - use permissionDetails/role instead. |
| 826 | "teamDrivePermissionType": "A String", # Deprecated - use permissionDetails/permissionType instead. |
| 827 | }, |
| 828 | ], |
| 829 | "type": "A String", # The account type. Allowed values are: |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 830 | # - user |
| 831 | # - group |
| 832 | # - domain |
| 833 | # - anyone |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 834 | "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. |
| 835 | "withLink": True or False, # Whether the link is required for this permission. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 836 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 837 | "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. |
| 838 | "videoMediaMetadata": { # Metadata about video media. This will only be present for video types. |
| 839 | "durationMillis": "A String", # The duration of the video in milliseconds. |
| 840 | "height": 42, # The height of the video in pixels. |
| 841 | "width": 42, # The width of the video in pixels. |
| 842 | }, |
| 843 | "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. |
| 844 | "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. |
| 845 | "writersCanShare": True or False, # Whether writers can share the document with other users. Not populated for items in shared drives. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 846 | }</pre> |
| 847 | </div> |
| 848 | |
| 849 | <div class="method"> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 850 | <code class="details" id="delete">delete(fileId, supportsAllDrives=None, supportsTeamDrives=None)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 851 | <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 shared drive files. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 852 | |
| 853 | Args: |
| 854 | fileId: string, The ID of the file to delete. (required) |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 855 | supportsAllDrives: boolean, Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 856 | supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 857 | </pre> |
| 858 | </div> |
| 859 | |
| 860 | <div class="method"> |
| Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 861 | <code class="details" id="emptyTrash">emptyTrash()</code> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 862 | <pre>Permanently deletes all of the user's trashed files. |
| Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 863 | |
| 864 | Args: |
| 865 | </pre> |
| 866 | </div> |
| 867 | |
| 868 | <div class="method"> |
| Sai Cheemalapati | df61397 | 2016-10-21 13:59:49 -0700 | [diff] [blame] | 869 | <code class="details" id="export">export(fileId, mimeType)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 870 | <pre>Exports a Google Doc to the requested MIME type and returns the exported content. Please note that the exported content is limited to 10MB. |
| Sai Cheemalapati | df61397 | 2016-10-21 13:59:49 -0700 | [diff] [blame] | 871 | |
| 872 | Args: |
| 873 | fileId: string, The ID of the file. (required) |
| 874 | mimeType: string, The MIME type of the format requested for this export. (required) |
| 875 | </pre> |
| 876 | </div> |
| 877 | |
| 878 | <div class="method"> |
| 879 | <code class="details" id="export_media">export_media(fileId, mimeType)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 880 | <pre>Exports a Google Doc to the requested MIME type and returns the exported content. Please note that the exported content is limited to 10MB. |
| Sai Cheemalapati | df61397 | 2016-10-21 13:59:49 -0700 | [diff] [blame] | 881 | |
| 882 | Args: |
| 883 | fileId: string, The ID of the file. (required) |
| 884 | mimeType: string, The MIME type of the format requested for this export. (required) |
| 885 | </pre> |
| 886 | </div> |
| 887 | |
| 888 | <div class="method"> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 889 | <code class="details" id="generateIds">generateIds(maxResults=None, space=None)</code> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 890 | <pre>Generates a set of file IDs which can be provided in insert or copy requests. |
| Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 891 | |
| 892 | Args: |
| Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 893 | maxResults: integer, Maximum number of IDs to return. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 894 | space: string, The space in which the IDs can be used to create new files. Supported values are 'drive' and 'appDataFolder'. |
| Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 895 | |
| 896 | Returns: |
| 897 | An object of the form: |
| 898 | |
| 899 | { # A list of generated IDs which can be provided in insert requests |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 900 | "ids": [ # The IDs generated for the requesting user in the specified space. |
| 901 | "A String", |
| Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 902 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 903 | "kind": "drive#generatedIds", # This is always drive#generatedIds |
| 904 | "space": "A String", # The type of file that can be created with these IDs. |
| Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 905 | }</pre> |
| 906 | </div> |
| 907 | |
| 908 | <div class="method"> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 909 | <code class="details" id="get">get(fileId, acknowledgeAbuse=None, projection=None, revisionId=None, supportsAllDrives=None, supportsTeamDrives=None, updateViewedDate=None)</code> |
| 910 | <pre>Gets a file's metadata by ID. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 911 | |
| 912 | Args: |
| 913 | fileId: string, The ID for the file in question. (required) |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 914 | acknowledgeAbuse: boolean, Whether the user is acknowledging the risk of downloading known malware or other abusive files. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 915 | projection: string, This parameter is deprecated and has no function. |
| 916 | Allowed values |
| 917 | BASIC - Deprecated |
| 918 | FULL - Deprecated |
| Nathaniel Manista | 4f877e5 | 2015-06-15 16:44:50 +0000 | [diff] [blame] | 919 | revisionId: string, Specifies the Revision ID that should be downloaded. Ignored unless alt=media is specified. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 920 | supportsAllDrives: boolean, Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 921 | supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead. |
| Sai Cheemalapati | df61397 | 2016-10-21 13:59:49 -0700 | [diff] [blame] | 922 | updateViewedDate: boolean, Deprecated: Use files.update with modifiedDateBehavior=noChange, updateViewedDate=true and an empty request body. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 923 | |
| 924 | Returns: |
| 925 | An object of the form: |
| 926 | |
| 927 | { # The metadata for a file. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 928 | "alternateLink": "A String", # A link for opening the file in a relevant Google editor or viewer. |
| 929 | "appDataContents": True or False, # Whether this file is in the Application Data folder. |
| 930 | "canComment": True or False, # Deprecated: use capabilities/canComment. |
| 931 | "canReadRevisions": True or False, # Deprecated: use capabilities/canReadRevisions. |
| 932 | "capabilities": { # Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take. |
| 933 | "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. |
| 934 | "canAddMyDriveParent": True or False, # Whether the current user can add a parent for the item without removing an existing parent in the same request. Not populated for shared drive files. |
| 935 | "canChangeCopyRequiresWriterPermission": True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this file. |
| 936 | "canChangeRestrictedDownload": True or False, # Deprecated |
| 937 | "canComment": True or False, # Whether the current user can comment on this file. |
| 938 | "canCopy": True or False, # Whether the current user can copy this file. For an item in a shared drive, whether the current user can copy non-folder descendants of this item, or this item itself if it is not a folder. |
| 939 | "canDelete": True or False, # Whether the current user can delete this file. |
| 940 | "canDeleteChildren": True or False, # Whether the current user can delete children of this folder. This is false when the item is not a folder. Only populated for items in shared drives. |
| 941 | "canDownload": True or False, # Whether the current user can download this file. |
| 942 | "canEdit": True or False, # Whether the current user can edit this file. Other factors may limit the type of changes a user can make to a file. For example, see canChangeCopyRequiresWriterPermission or canModifyContent. |
| 943 | "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. |
| 944 | "canModifyContent": True or False, # Whether the current user can modify the content of this file. |
| 945 | "canMoveChildrenOutOfDrive": True or False, # Whether the current user can move children of this folder outside of the shared drive. This is false when the item is not a folder. Only populated for items in shared drives. |
| 946 | "canMoveChildrenOutOfTeamDrive": True or False, # Deprecated - use canMoveChildrenOutOfDrive instead. |
| 947 | "canMoveChildrenWithinDrive": True or False, # Whether the current user can move children of this folder within the shared drive. This is false when the item is not a folder. Only populated for items in shared drives. |
| 948 | "canMoveChildrenWithinTeamDrive": True or False, # Deprecated - use canMoveChildrenWithinDrive instead. |
| 949 | "canMoveItemIntoTeamDrive": True or False, # Deprecated - use canMoveItemOutOfDrive instead. |
| 950 | "canMoveItemOutOfDrive": True or False, # Whether the current user can move this item outside of this drive by changing its parent. Note that a request to change the parent of the item may still fail depending on the new parent that is being added. |
| 951 | "canMoveItemOutOfTeamDrive": True or False, # Deprecated - use canMoveItemOutOfDrive instead. |
| 952 | "canMoveItemWithinDrive": True or False, # Whether the current user can move this item within this shared drive. Note that a request to change the parent of the item may still fail depending on the new parent that is being added. Only populated for items in shared drives. |
| 953 | "canMoveItemWithinTeamDrive": True or False, # Deprecated - use canMoveItemWithinDrive instead. |
| 954 | "canMoveTeamDriveItem": True or False, # Deprecated - use canMoveItemWithinDrive or canMoveItemOutOfDrive instead. |
| 955 | "canReadDrive": True or False, # Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives. |
| 956 | "canReadRevisions": True or False, # Whether the current user can read the revisions resource of this file. For a shared drive item, whether revisions of non-folder descendants of this item, or this item itself if it is not a folder, can be read. |
| 957 | "canReadTeamDrive": True or False, # Deprecated - use canReadDrive instead. |
| 958 | "canRemoveChildren": True or False, # Whether the current user can remove children from this folder. This is always false when the item is not a folder. For a folder in a shared drive, use canDeleteChildren or canTrashChildren instead. |
| 959 | "canRemoveMyDriveParent": True or False, # Whether the current user can remove a parent from the item without adding another parent in the same request. Not populated for shared drive files. |
| 960 | "canRename": True or False, # Whether the current user can rename this file. |
| 961 | "canShare": True or False, # Whether the current user can modify the sharing settings for this file. |
| 962 | "canTrash": True or False, # Whether the current user can move this file to trash. |
| 963 | "canTrashChildren": True or False, # Whether the current user can trash children of this folder. This is false when the item is not a folder. Only populated for items in shared drives. |
| 964 | "canUntrash": True or False, # Whether the current user can restore this file from trash. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 965 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 966 | "copyRequiresWriterPermission": True or False, # Whether the options to copy, print, or download this file, should be disabled for readers and commenters. |
| 967 | "copyable": True or False, # Deprecated: use capabilities/canCopy. |
| 968 | "createdDate": "A String", # Create time for this file (formatted RFC 3339 timestamp). |
| 969 | "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. |
| 970 | "description": "A String", # A short description of the file. |
| 971 | "downloadUrl": "A String", # Short lived download URL for the file. This field is only populated for files with content stored in Google Drive; it is not populated for Google Docs or shortcut files. |
| 972 | "driveId": "A String", # ID of the shared drive the file resides in. Only populated for items in shared drives. |
| 973 | "editable": True or False, # Deprecated: use capabilities/canEdit. |
| 974 | "embedLink": "A String", # A link for embedding the file. |
| 975 | "etag": "A String", # ETag of the file. |
| 976 | "explicitlyTrashed": True or False, # Whether this file has been explicitly trashed, as opposed to recursively trashed. |
| 977 | "exportLinks": { # Links for exporting Google Docs to specific formats. |
| 978 | "a_key": "A String", # A mapping from export format to URL |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 979 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 980 | "fileExtension": "A String", # The final component of fullFileExtension with trailing text that does not appear to be part of the extension removed. This field is only populated for files with content stored in Google Drive; it is not populated for Google Docs or shortcut files. |
| 981 | "fileSize": "A String", # The size of the file in bytes. This field is only populated for files with content stored in Google Drive; it is not populated for Google Docs or shortcut files. |
| 982 | "folderColorRgb": "A String", # Folder color as an RGB hex string if the file is a folder. The list of supported colors is available in the folderColorPalette field of the About resource. If an unsupported color is specified, it will be changed to the closest color in the palette. Not populated for items in shared drives. |
| 983 | "fullFileExtension": "A String", # The full file extension; extracted from the title. May contain multiple concatenated extensions, such as "tar.gz". Removing an extension from the title does not clear this field; however, changing the extension on the title does update this field. This field is only populated for files with content stored in Google Drive; it is not populated for Google Docs or shortcut files. |
| 984 | "hasAugmentedPermissions": True or False, # Whether there are permissions directly on this file. This field is only populated for items in shared drives. |
| 985 | "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. |
| 986 | "headRevisionId": "A String", # The ID of the file's head revision. This field is only populated for files with content stored in Google Drive; it is not populated for Google Docs or shortcut files. |
| 987 | "iconLink": "A String", # A link to the file's icon. |
| 988 | "id": "A String", # The ID of the file. |
| 989 | "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. |
| 990 | "aperture": 3.14, # The aperture used to create the photo (f-number). |
| 991 | "cameraMake": "A String", # The make of the camera used to create the photo. |
| 992 | "cameraModel": "A String", # The model of the camera used to create the photo. |
| 993 | "colorSpace": "A String", # The color space of the photo. |
| 994 | "date": "A String", # The date and time the photo was taken (EXIF format timestamp). |
| 995 | "exposureBias": 3.14, # The exposure bias of the photo (APEX value). |
| 996 | "exposureMode": "A String", # The exposure mode used to create the photo. |
| 997 | "exposureTime": 3.14, # The length of the exposure, in seconds. |
| 998 | "flashUsed": True or False, # Whether a flash was used to create the photo. |
| 999 | "focalLength": 3.14, # The focal length used to create the photo, in millimeters. |
| 1000 | "height": 42, # The height of the image in pixels. |
| 1001 | "isoSpeed": 42, # The ISO speed used to create the photo. |
| 1002 | "lens": "A String", # The lens used to create the photo. |
| 1003 | "location": { # Geographic location information stored in the image. |
| 1004 | "altitude": 3.14, # The altitude stored in the image. |
| 1005 | "latitude": 3.14, # The latitude stored in the image. |
| 1006 | "longitude": 3.14, # The longitude stored in the image. |
| 1007 | }, |
| 1008 | "maxApertureValue": 3.14, # The smallest f-number of the lens at the focal length used to create the photo (APEX value). |
| 1009 | "meteringMode": "A String", # The metering mode used to create the photo. |
| 1010 | "rotation": 42, # The number of clockwise 90 degree rotations applied from the image's original orientation. |
| 1011 | "sensor": "A String", # The type of sensor used to create the photo. |
| 1012 | "subjectDistance": 42, # The distance to the subject of the photo, in meters. |
| 1013 | "whiteBalance": "A String", # The white balance mode used to create the photo. |
| 1014 | "width": 42, # The width of the image in pixels. |
| 1015 | }, |
| 1016 | "indexableText": { # Indexable text attributes for the file (can only be written) |
| 1017 | "text": "A String", # The text to be indexed for this file. |
| 1018 | }, |
| 1019 | "isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app. |
| 1020 | "kind": "drive#file", # The type of file. This is always drive#file. |
| 1021 | "labels": { # A group of labels for the file. |
| 1022 | "hidden": True or False, # Deprecated. |
| 1023 | "modified": True or False, # Whether the file has been modified by this user. |
| 1024 | "restricted": True or False, # Deprecated - use copyRequiresWriterPermission instead. |
| 1025 | "starred": True or False, # Whether this file is starred by the user. |
| 1026 | "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. |
| 1027 | "viewed": True or False, # Whether this file has been viewed by this user. |
| 1028 | }, |
| 1029 | "lastModifyingUser": { # Information about a Drive user. # The last user to modify this file. |
| 1030 | "displayName": "A String", # A plain text displayable name for this user. |
| 1031 | "emailAddress": "A String", # The email address of the user. |
| 1032 | "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. |
| 1033 | "kind": "drive#user", # This is always drive#user. |
| 1034 | "permissionId": "A String", # The user's ID as visible in the permissions collection. |
| 1035 | "picture": { # The user's profile picture. |
| 1036 | "url": "A String", # A URL that points to a profile picture of this user. |
| 1037 | }, |
| 1038 | }, |
| 1039 | "lastModifyingUserName": "A String", # Name of the last user to modify this file. |
| 1040 | "lastViewedByMeDate": "A String", # Last time this file was viewed by the user (formatted RFC 3339 timestamp). |
| 1041 | "markedViewedByMeDate": "A String", # Deprecated. |
| 1042 | "md5Checksum": "A String", # An MD5 checksum for the content of this file. This field is only populated for files with content stored in Google Drive; it is not populated for Google Docs or shortcut files. |
| 1043 | "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. |
| 1044 | "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. |
| 1045 | "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. |
| 1046 | "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. |
| 1047 | "a_key": "A String", |
| 1048 | }, |
| 1049 | "originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the title field. This is only available for files with binary content in Google Drive. |
| 1050 | "ownedByMe": True or False, # Whether the file is owned by the current user. Not populated for items in shared drives. |
| 1051 | "ownerNames": [ # Name(s) of the owner(s) of this file. Not populated for items in shared drives. |
| 1052 | "A String", |
| 1053 | ], |
| 1054 | "owners": [ # The owner(s) of this file. Not populated for items in shared drives. |
| Sai Cheemalapati | df61397 | 2016-10-21 13:59:49 -0700 | [diff] [blame] | 1055 | { # Information about a Drive user. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1056 | "displayName": "A String", # A plain text displayable name for this user. |
| 1057 | "emailAddress": "A String", # The email address of the user. |
| 1058 | "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. |
| 1059 | "kind": "drive#user", # This is always drive#user. |
| 1060 | "permissionId": "A String", # The user's ID as visible in the permissions collection. |
| 1061 | "picture": { # The user's profile picture. |
| 1062 | "url": "A String", # A URL that points to a profile picture of this user. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1063 | }, |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1064 | }, |
| 1065 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1066 | "parents": [ # Collection of parent folders which contain this file. |
| 1067 | # If not specified as part of an insert request, the file will be placed directly in the user's My Drive folder. If not specified as part of a copy request, the file will inherit any discoverable parents of the source file. Update requests can also use the addParents and removeParents parameters to modify the parents list. |
| 1068 | { # A reference to a file's parent. |
| 1069 | "id": "A String", # The ID of the parent. |
| 1070 | "isRoot": True or False, # Whether or not the parent is the root folder. |
| 1071 | "kind": "drive#parentReference", # This is always drive#parentReference. |
| 1072 | "parentLink": "A String", # A link to the parent. |
| 1073 | "selfLink": "A String", # A link back to this reference. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1074 | }, |
| 1075 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1076 | "permissionIds": [ # List of permission IDs for users with access to this file. |
| 1077 | "A String", |
| 1078 | ], |
| 1079 | "permissions": [ # The list of permissions for users with access to this file. Not populated for items in shared drives. |
| 1080 | { # A permission for a file. |
| 1081 | "additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future. |
| 1082 | "A String", |
| 1083 | ], |
| 1084 | "authKey": "A String", # Deprecated. |
| 1085 | "deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions. |
| 1086 | "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. |
| 1087 | "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. |
| 1088 | "etag": "A String", # The ETag of the permission. |
| 1089 | "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: |
| 1090 | # - They cannot be set on shared drive items |
| 1091 | # - They can only be set on user and group permissions |
| 1092 | # - The date must be in the future |
| 1093 | # - The date cannot be more than a year in the future |
| 1094 | # - The date can only be set on drive.permissions.update or drive.permissions.patch requests |
| 1095 | "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. |
| 1096 | "kind": "drive#permission", # This is always drive#permission. |
| 1097 | "name": "A String", # The name for this permission. |
| 1098 | "permissionDetails": [ # Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. |
| 1099 | { |
| 1100 | "additionalRoles": [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future. |
| 1101 | "A String", |
| 1102 | ], |
| 1103 | "inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field. |
| 1104 | "inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field. |
| 1105 | "permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible: |
| 1106 | # - file |
| 1107 | # - member |
| 1108 | "role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible: |
| 1109 | # - organizer |
| 1110 | # - fileOrganizer |
| 1111 | # - writer |
| 1112 | # - reader |
| 1113 | }, |
| 1114 | ], |
| 1115 | "photoLink": "A String", # A link to the profile photo, if available. |
| 1116 | "role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: |
| 1117 | # - owner |
| 1118 | # - organizer |
| 1119 | # - fileOrganizer |
| 1120 | # - writer |
| 1121 | # - reader |
| 1122 | "selfLink": "A String", # A link back to this permission. |
| 1123 | "teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead. |
| 1124 | { |
| 1125 | "additionalRoles": [ # Deprecated - use permissionDetails/additionalRoles instead. |
| 1126 | "A String", |
| 1127 | ], |
| 1128 | "inherited": True or False, # Deprecated - use permissionDetails/inherited instead. |
| 1129 | "inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead. |
| 1130 | "role": "A String", # Deprecated - use permissionDetails/role instead. |
| 1131 | "teamDrivePermissionType": "A String", # Deprecated - use permissionDetails/permissionType instead. |
| 1132 | }, |
| 1133 | ], |
| 1134 | "type": "A String", # The account type. Allowed values are: |
| 1135 | # - user |
| 1136 | # - group |
| 1137 | # - domain |
| 1138 | # - anyone |
| 1139 | "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. |
| 1140 | "withLink": True or False, # Whether the link is required for this permission. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1141 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1142 | ], |
| 1143 | "properties": [ # The list of properties. |
| Nathaniel Manista | 4f877e5 | 2015-06-15 16:44:50 +0000 | [diff] [blame] | 1144 | { # A key-value pair attached to a file that is either public or private to an application. |
| 1145 | # The following limits apply to file properties: |
| 1146 | # - Maximum of 100 properties total per file |
| 1147 | # - Maximum of 30 private properties per app |
| 1148 | # - Maximum of 30 public properties |
| 1149 | # - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1150 | "etag": "A String", # ETag of the property. |
| 1151 | "key": "A String", # The key of this property. |
| 1152 | "kind": "drive#property", # This is always drive#property. |
| 1153 | "selfLink": "A String", # The link back to this property. |
| 1154 | "value": "A String", # The value of this property. |
| 1155 | "visibility": "A String", # The visibility of this property. Allowed values are PRIVATE and PUBLIC. (Default: PRIVATE) |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1156 | }, |
| 1157 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1158 | "quotaBytesUsed": "A String", # The number of quota bytes used by this file. |
| 1159 | "selfLink": "A String", # A link back to this file. |
| 1160 | "shareable": True or False, # Deprecated: use capabilities/canShare. |
| 1161 | "shared": True or False, # Whether the file has been shared. Not populated for items in shared drives. |
| 1162 | "sharedWithMeDate": "A String", # Time at which this file was shared with the user (formatted RFC 3339 timestamp). |
| 1163 | "sharingUser": { # Information about a Drive user. # User that shared the item with the current user, if available. |
| 1164 | "displayName": "A String", # A plain text displayable name for this user. |
| 1165 | "emailAddress": "A String", # The email address of the user. |
| 1166 | "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. |
| 1167 | "kind": "drive#user", # This is always drive#user. |
| 1168 | "permissionId": "A String", # The user's ID as visible in the permissions collection. |
| 1169 | "picture": { # The user's profile picture. |
| 1170 | "url": "A String", # A URL that points to a profile picture of this user. |
| 1171 | }, |
| Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 1172 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1173 | "shortcutDetails": { # Shortcut file details. Only populated for shortcut files, which have the mimeType field set to application/vnd.google-apps.shortcut. |
| 1174 | "targetId": "A String", # The ID of the file that this shortcut points to. |
| 1175 | "targetMimeType": "A String", # The MIME type of the file that this shortcut points to. The value of this field is a snapshot of the target's MIME type, captured when the shortcut is created. |
| 1176 | }, |
| 1177 | "spaces": [ # The list of spaces which contain the file. Supported values are 'drive', 'appDataFolder' and 'photos'. |
| 1178 | "A String", |
| 1179 | ], |
| 1180 | "teamDriveId": "A String", # Deprecated - use driveId instead. |
| 1181 | "thumbnail": { # A thumbnail for the file. This will only be used if a standard thumbnail cannot be generated. |
| 1182 | "image": "A String", # The URL-safe Base64 encoded bytes of the thumbnail image. It should conform to RFC 4648 section 5. |
| 1183 | "mimeType": "A String", # The MIME type of the thumbnail. |
| 1184 | }, |
| 1185 | "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. |
| 1186 | "thumbnailVersion": "A String", # The thumbnail version for use in thumbnail cache invalidation. |
| 1187 | "title": "A String", # The title of this file. Note that for immutable items such as the top level folders of shared drives, My Drive root folder, and Application Data folder the title is constant. |
| 1188 | "trashedDate": "A String", # The time that the item was trashed (formatted RFC 3339 timestamp). Only populated for items in shared drives. |
| 1189 | "trashingUser": { # Information about a Drive user. # If the file has been explicitly trashed, the user who trashed it. Only populated for items in shared drives. |
| 1190 | "displayName": "A String", # A plain text displayable name for this user. |
| 1191 | "emailAddress": "A String", # The email address of the user. |
| 1192 | "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. |
| 1193 | "kind": "drive#user", # This is always drive#user. |
| 1194 | "permissionId": "A String", # The user's ID as visible in the permissions collection. |
| 1195 | "picture": { # The user's profile picture. |
| 1196 | "url": "A String", # A URL that points to a profile picture of this user. |
| 1197 | }, |
| 1198 | }, |
| 1199 | "userPermission": { # A permission for a file. # The permissions for the authenticated user on this file. |
| 1200 | "additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future. |
| 1201 | "A String", |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 1202 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1203 | "authKey": "A String", # Deprecated. |
| 1204 | "deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions. |
| 1205 | "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. |
| 1206 | "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. |
| 1207 | "etag": "A String", # The ETag of the permission. |
| 1208 | "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1209 | # - They cannot be set on shared drive items |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 1210 | # - They can only be set on user and group permissions |
| 1211 | # - The date must be in the future |
| 1212 | # - The date cannot be more than a year in the future |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1213 | # - The date can only be set on drive.permissions.update or drive.permissions.patch requests |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1214 | "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. |
| 1215 | "kind": "drive#permission", # This is always drive#permission. |
| 1216 | "name": "A String", # The name for this permission. |
| 1217 | "permissionDetails": [ # Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. |
| 1218 | { |
| 1219 | "additionalRoles": [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future. |
| 1220 | "A String", |
| 1221 | ], |
| 1222 | "inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field. |
| 1223 | "inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field. |
| 1224 | "permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible: |
| 1225 | # - file |
| 1226 | # - member |
| 1227 | "role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible: |
| 1228 | # - organizer |
| 1229 | # - fileOrganizer |
| 1230 | # - writer |
| 1231 | # - reader |
| 1232 | }, |
| 1233 | ], |
| 1234 | "photoLink": "A String", # A link to the profile photo, if available. |
| 1235 | "role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1236 | # - owner |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1237 | # - organizer |
| 1238 | # - fileOrganizer |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1239 | # - writer |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1240 | # - reader |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1241 | "selfLink": "A String", # A link back to this permission. |
| 1242 | "teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead. |
| 1243 | { |
| 1244 | "additionalRoles": [ # Deprecated - use permissionDetails/additionalRoles instead. |
| 1245 | "A String", |
| 1246 | ], |
| 1247 | "inherited": True or False, # Deprecated - use permissionDetails/inherited instead. |
| 1248 | "inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead. |
| 1249 | "role": "A String", # Deprecated - use permissionDetails/role instead. |
| 1250 | "teamDrivePermissionType": "A String", # Deprecated - use permissionDetails/permissionType instead. |
| 1251 | }, |
| 1252 | ], |
| 1253 | "type": "A String", # The account type. Allowed values are: |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1254 | # - user |
| 1255 | # - group |
| 1256 | # - domain |
| 1257 | # - anyone |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1258 | "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. |
| 1259 | "withLink": True or False, # Whether the link is required for this permission. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1260 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1261 | "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. |
| 1262 | "videoMediaMetadata": { # Metadata about video media. This will only be present for video types. |
| 1263 | "durationMillis": "A String", # The duration of the video in milliseconds. |
| 1264 | "height": 42, # The height of the video in pixels. |
| 1265 | "width": 42, # The width of the video in pixels. |
| 1266 | }, |
| 1267 | "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. |
| 1268 | "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. |
| 1269 | "writersCanShare": True or False, # Whether writers can share the document with other users. Not populated for items in shared drives. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1270 | }</pre> |
| 1271 | </div> |
| 1272 | |
| 1273 | <div class="method"> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1274 | <code class="details" id="get_media">get_media(fileId, acknowledgeAbuse=None, projection=None, revisionId=None, supportsAllDrives=None, supportsTeamDrives=None, updateViewedDate=None)</code> |
| 1275 | <pre>Gets a file's metadata by ID. |
| Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [diff] [blame] | 1276 | |
| 1277 | Args: |
| 1278 | fileId: string, The ID for the file in question. (required) |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1279 | acknowledgeAbuse: boolean, Whether the user is acknowledging the risk of downloading known malware or other abusive files. |
| Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [diff] [blame] | 1280 | projection: string, This parameter is deprecated and has no function. |
| 1281 | Allowed values |
| 1282 | BASIC - Deprecated |
| 1283 | FULL - Deprecated |
| Nathaniel Manista | 4f877e5 | 2015-06-15 16:44:50 +0000 | [diff] [blame] | 1284 | revisionId: string, Specifies the Revision ID that should be downloaded. Ignored unless alt=media is specified. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1285 | supportsAllDrives: boolean, Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1286 | supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead. |
| Sai Cheemalapati | df61397 | 2016-10-21 13:59:49 -0700 | [diff] [blame] | 1287 | updateViewedDate: boolean, Deprecated: Use files.update with modifiedDateBehavior=noChange, updateViewedDate=true and an empty request body. |
| Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [diff] [blame] | 1288 | |
| 1289 | Returns: |
| 1290 | The media object as a string. |
| 1291 | |
| 1292 | </pre> |
| 1293 | </div> |
| 1294 | |
| 1295 | <div class="method"> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1296 | <code class="details" id="insert">insert(body=None, convert=None, enforceSingleParent=None, ocr=None, ocrLanguage=None, pinned=None, supportsAllDrives=None, supportsTeamDrives=None, timedTextLanguage=None, timedTextTrackName=None, useContentAsIndexableText=None, visibility=None, media_body=None, media_mime_type=None)</code> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1297 | <pre>Insert a new file. |
| 1298 | |
| 1299 | Args: |
| 1300 | body: object, The request body. |
| 1301 | The object takes the form of: |
| 1302 | |
| 1303 | { # The metadata for a file. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1304 | "alternateLink": "A String", # A link for opening the file in a relevant Google editor or viewer. |
| 1305 | "appDataContents": True or False, # Whether this file is in the Application Data folder. |
| 1306 | "canComment": True or False, # Deprecated: use capabilities/canComment. |
| 1307 | "canReadRevisions": True or False, # Deprecated: use capabilities/canReadRevisions. |
| 1308 | "capabilities": { # Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take. |
| 1309 | "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. |
| 1310 | "canAddMyDriveParent": True or False, # Whether the current user can add a parent for the item without removing an existing parent in the same request. Not populated for shared drive files. |
| 1311 | "canChangeCopyRequiresWriterPermission": True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this file. |
| 1312 | "canChangeRestrictedDownload": True or False, # Deprecated |
| 1313 | "canComment": True or False, # Whether the current user can comment on this file. |
| 1314 | "canCopy": True or False, # Whether the current user can copy this file. For an item in a shared drive, whether the current user can copy non-folder descendants of this item, or this item itself if it is not a folder. |
| 1315 | "canDelete": True or False, # Whether the current user can delete this file. |
| 1316 | "canDeleteChildren": True or False, # Whether the current user can delete children of this folder. This is false when the item is not a folder. Only populated for items in shared drives. |
| 1317 | "canDownload": True or False, # Whether the current user can download this file. |
| 1318 | "canEdit": True or False, # Whether the current user can edit this file. Other factors may limit the type of changes a user can make to a file. For example, see canChangeCopyRequiresWriterPermission or canModifyContent. |
| 1319 | "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. |
| 1320 | "canModifyContent": True or False, # Whether the current user can modify the content of this file. |
| 1321 | "canMoveChildrenOutOfDrive": True or False, # Whether the current user can move children of this folder outside of the shared drive. This is false when the item is not a folder. Only populated for items in shared drives. |
| 1322 | "canMoveChildrenOutOfTeamDrive": True or False, # Deprecated - use canMoveChildrenOutOfDrive instead. |
| 1323 | "canMoveChildrenWithinDrive": True or False, # Whether the current user can move children of this folder within the shared drive. This is false when the item is not a folder. Only populated for items in shared drives. |
| 1324 | "canMoveChildrenWithinTeamDrive": True or False, # Deprecated - use canMoveChildrenWithinDrive instead. |
| 1325 | "canMoveItemIntoTeamDrive": True or False, # Deprecated - use canMoveItemOutOfDrive instead. |
| 1326 | "canMoveItemOutOfDrive": True or False, # Whether the current user can move this item outside of this drive by changing its parent. Note that a request to change the parent of the item may still fail depending on the new parent that is being added. |
| 1327 | "canMoveItemOutOfTeamDrive": True or False, # Deprecated - use canMoveItemOutOfDrive instead. |
| 1328 | "canMoveItemWithinDrive": True or False, # Whether the current user can move this item within this shared drive. Note that a request to change the parent of the item may still fail depending on the new parent that is being added. Only populated for items in shared drives. |
| 1329 | "canMoveItemWithinTeamDrive": True or False, # Deprecated - use canMoveItemWithinDrive instead. |
| 1330 | "canMoveTeamDriveItem": True or False, # Deprecated - use canMoveItemWithinDrive or canMoveItemOutOfDrive instead. |
| 1331 | "canReadDrive": True or False, # Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives. |
| 1332 | "canReadRevisions": True or False, # Whether the current user can read the revisions resource of this file. For a shared drive item, whether revisions of non-folder descendants of this item, or this item itself if it is not a folder, can be read. |
| 1333 | "canReadTeamDrive": True or False, # Deprecated - use canReadDrive instead. |
| 1334 | "canRemoveChildren": True or False, # Whether the current user can remove children from this folder. This is always false when the item is not a folder. For a folder in a shared drive, use canDeleteChildren or canTrashChildren instead. |
| 1335 | "canRemoveMyDriveParent": True or False, # Whether the current user can remove a parent from the item without adding another parent in the same request. Not populated for shared drive files. |
| 1336 | "canRename": True or False, # Whether the current user can rename this file. |
| 1337 | "canShare": True or False, # Whether the current user can modify the sharing settings for this file. |
| 1338 | "canTrash": True or False, # Whether the current user can move this file to trash. |
| 1339 | "canTrashChildren": True or False, # Whether the current user can trash children of this folder. This is false when the item is not a folder. Only populated for items in shared drives. |
| 1340 | "canUntrash": True or False, # Whether the current user can restore this file from trash. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1341 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1342 | "copyRequiresWriterPermission": True or False, # Whether the options to copy, print, or download this file, should be disabled for readers and commenters. |
| 1343 | "copyable": True or False, # Deprecated: use capabilities/canCopy. |
| 1344 | "createdDate": "A String", # Create time for this file (formatted RFC 3339 timestamp). |
| 1345 | "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. |
| 1346 | "description": "A String", # A short description of the file. |
| 1347 | "downloadUrl": "A String", # Short lived download URL for the file. This field is only populated for files with content stored in Google Drive; it is not populated for Google Docs or shortcut files. |
| 1348 | "driveId": "A String", # ID of the shared drive the file resides in. Only populated for items in shared drives. |
| 1349 | "editable": True or False, # Deprecated: use capabilities/canEdit. |
| 1350 | "embedLink": "A String", # A link for embedding the file. |
| 1351 | "etag": "A String", # ETag of the file. |
| 1352 | "explicitlyTrashed": True or False, # Whether this file has been explicitly trashed, as opposed to recursively trashed. |
| 1353 | "exportLinks": { # Links for exporting Google Docs to specific formats. |
| 1354 | "a_key": "A String", # A mapping from export format to URL |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1355 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1356 | "fileExtension": "A String", # The final component of fullFileExtension with trailing text that does not appear to be part of the extension removed. This field is only populated for files with content stored in Google Drive; it is not populated for Google Docs or shortcut files. |
| 1357 | "fileSize": "A String", # The size of the file in bytes. This field is only populated for files with content stored in Google Drive; it is not populated for Google Docs or shortcut files. |
| 1358 | "folderColorRgb": "A String", # Folder color as an RGB hex string if the file is a folder. The list of supported colors is available in the folderColorPalette field of the About resource. If an unsupported color is specified, it will be changed to the closest color in the palette. Not populated for items in shared drives. |
| 1359 | "fullFileExtension": "A String", # The full file extension; extracted from the title. May contain multiple concatenated extensions, such as "tar.gz". Removing an extension from the title does not clear this field; however, changing the extension on the title does update this field. This field is only populated for files with content stored in Google Drive; it is not populated for Google Docs or shortcut files. |
| 1360 | "hasAugmentedPermissions": True or False, # Whether there are permissions directly on this file. This field is only populated for items in shared drives. |
| 1361 | "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. |
| 1362 | "headRevisionId": "A String", # The ID of the file's head revision. This field is only populated for files with content stored in Google Drive; it is not populated for Google Docs or shortcut files. |
| 1363 | "iconLink": "A String", # A link to the file's icon. |
| 1364 | "id": "A String", # The ID of the file. |
| 1365 | "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. |
| 1366 | "aperture": 3.14, # The aperture used to create the photo (f-number). |
| 1367 | "cameraMake": "A String", # The make of the camera used to create the photo. |
| 1368 | "cameraModel": "A String", # The model of the camera used to create the photo. |
| 1369 | "colorSpace": "A String", # The color space of the photo. |
| 1370 | "date": "A String", # The date and time the photo was taken (EXIF format timestamp). |
| 1371 | "exposureBias": 3.14, # The exposure bias of the photo (APEX value). |
| 1372 | "exposureMode": "A String", # The exposure mode used to create the photo. |
| 1373 | "exposureTime": 3.14, # The length of the exposure, in seconds. |
| 1374 | "flashUsed": True or False, # Whether a flash was used to create the photo. |
| 1375 | "focalLength": 3.14, # The focal length used to create the photo, in millimeters. |
| 1376 | "height": 42, # The height of the image in pixels. |
| 1377 | "isoSpeed": 42, # The ISO speed used to create the photo. |
| 1378 | "lens": "A String", # The lens used to create the photo. |
| 1379 | "location": { # Geographic location information stored in the image. |
| 1380 | "altitude": 3.14, # The altitude stored in the image. |
| 1381 | "latitude": 3.14, # The latitude stored in the image. |
| 1382 | "longitude": 3.14, # The longitude stored in the image. |
| 1383 | }, |
| 1384 | "maxApertureValue": 3.14, # The smallest f-number of the lens at the focal length used to create the photo (APEX value). |
| 1385 | "meteringMode": "A String", # The metering mode used to create the photo. |
| 1386 | "rotation": 42, # The number of clockwise 90 degree rotations applied from the image's original orientation. |
| 1387 | "sensor": "A String", # The type of sensor used to create the photo. |
| 1388 | "subjectDistance": 42, # The distance to the subject of the photo, in meters. |
| 1389 | "whiteBalance": "A String", # The white balance mode used to create the photo. |
| 1390 | "width": 42, # The width of the image in pixels. |
| 1391 | }, |
| 1392 | "indexableText": { # Indexable text attributes for the file (can only be written) |
| 1393 | "text": "A String", # The text to be indexed for this file. |
| 1394 | }, |
| 1395 | "isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app. |
| 1396 | "kind": "drive#file", # The type of file. This is always drive#file. |
| 1397 | "labels": { # A group of labels for the file. |
| 1398 | "hidden": True or False, # Deprecated. |
| 1399 | "modified": True or False, # Whether the file has been modified by this user. |
| 1400 | "restricted": True or False, # Deprecated - use copyRequiresWriterPermission instead. |
| 1401 | "starred": True or False, # Whether this file is starred by the user. |
| 1402 | "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. |
| 1403 | "viewed": True or False, # Whether this file has been viewed by this user. |
| 1404 | }, |
| 1405 | "lastModifyingUser": { # Information about a Drive user. # The last user to modify this file. |
| 1406 | "displayName": "A String", # A plain text displayable name for this user. |
| 1407 | "emailAddress": "A String", # The email address of the user. |
| 1408 | "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. |
| 1409 | "kind": "drive#user", # This is always drive#user. |
| 1410 | "permissionId": "A String", # The user's ID as visible in the permissions collection. |
| 1411 | "picture": { # The user's profile picture. |
| 1412 | "url": "A String", # A URL that points to a profile picture of this user. |
| 1413 | }, |
| 1414 | }, |
| 1415 | "lastModifyingUserName": "A String", # Name of the last user to modify this file. |
| 1416 | "lastViewedByMeDate": "A String", # Last time this file was viewed by the user (formatted RFC 3339 timestamp). |
| 1417 | "markedViewedByMeDate": "A String", # Deprecated. |
| 1418 | "md5Checksum": "A String", # An MD5 checksum for the content of this file. This field is only populated for files with content stored in Google Drive; it is not populated for Google Docs or shortcut files. |
| 1419 | "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. |
| 1420 | "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. |
| 1421 | "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. |
| 1422 | "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. |
| 1423 | "a_key": "A String", |
| 1424 | }, |
| 1425 | "originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the title field. This is only available for files with binary content in Google Drive. |
| 1426 | "ownedByMe": True or False, # Whether the file is owned by the current user. Not populated for items in shared drives. |
| 1427 | "ownerNames": [ # Name(s) of the owner(s) of this file. Not populated for items in shared drives. |
| 1428 | "A String", |
| 1429 | ], |
| 1430 | "owners": [ # The owner(s) of this file. Not populated for items in shared drives. |
| Sai Cheemalapati | df61397 | 2016-10-21 13:59:49 -0700 | [diff] [blame] | 1431 | { # Information about a Drive user. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1432 | "displayName": "A String", # A plain text displayable name for this user. |
| 1433 | "emailAddress": "A String", # The email address of the user. |
| 1434 | "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. |
| 1435 | "kind": "drive#user", # This is always drive#user. |
| 1436 | "permissionId": "A String", # The user's ID as visible in the permissions collection. |
| 1437 | "picture": { # The user's profile picture. |
| 1438 | "url": "A String", # A URL that points to a profile picture of this user. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1439 | }, |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1440 | }, |
| 1441 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1442 | "parents": [ # Collection of parent folders which contain this file. |
| 1443 | # If not specified as part of an insert request, the file will be placed directly in the user's My Drive folder. If not specified as part of a copy request, the file will inherit any discoverable parents of the source file. Update requests can also use the addParents and removeParents parameters to modify the parents list. |
| 1444 | { # A reference to a file's parent. |
| 1445 | "id": "A String", # The ID of the parent. |
| 1446 | "isRoot": True or False, # Whether or not the parent is the root folder. |
| 1447 | "kind": "drive#parentReference", # This is always drive#parentReference. |
| 1448 | "parentLink": "A String", # A link to the parent. |
| 1449 | "selfLink": "A String", # A link back to this reference. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1450 | }, |
| 1451 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1452 | "permissionIds": [ # List of permission IDs for users with access to this file. |
| 1453 | "A String", |
| 1454 | ], |
| 1455 | "permissions": [ # The list of permissions for users with access to this file. Not populated for items in shared drives. |
| 1456 | { # A permission for a file. |
| 1457 | "additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future. |
| 1458 | "A String", |
| 1459 | ], |
| 1460 | "authKey": "A String", # Deprecated. |
| 1461 | "deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions. |
| 1462 | "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. |
| 1463 | "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. |
| 1464 | "etag": "A String", # The ETag of the permission. |
| 1465 | "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: |
| 1466 | # - They cannot be set on shared drive items |
| 1467 | # - They can only be set on user and group permissions |
| 1468 | # - The date must be in the future |
| 1469 | # - The date cannot be more than a year in the future |
| 1470 | # - The date can only be set on drive.permissions.update or drive.permissions.patch requests |
| 1471 | "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. |
| 1472 | "kind": "drive#permission", # This is always drive#permission. |
| 1473 | "name": "A String", # The name for this permission. |
| 1474 | "permissionDetails": [ # Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. |
| 1475 | { |
| 1476 | "additionalRoles": [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future. |
| 1477 | "A String", |
| 1478 | ], |
| 1479 | "inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field. |
| 1480 | "inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field. |
| 1481 | "permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible: |
| 1482 | # - file |
| 1483 | # - member |
| 1484 | "role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible: |
| 1485 | # - organizer |
| 1486 | # - fileOrganizer |
| 1487 | # - writer |
| 1488 | # - reader |
| 1489 | }, |
| 1490 | ], |
| 1491 | "photoLink": "A String", # A link to the profile photo, if available. |
| 1492 | "role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: |
| 1493 | # - owner |
| 1494 | # - organizer |
| 1495 | # - fileOrganizer |
| 1496 | # - writer |
| 1497 | # - reader |
| 1498 | "selfLink": "A String", # A link back to this permission. |
| 1499 | "teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead. |
| 1500 | { |
| 1501 | "additionalRoles": [ # Deprecated - use permissionDetails/additionalRoles instead. |
| 1502 | "A String", |
| 1503 | ], |
| 1504 | "inherited": True or False, # Deprecated - use permissionDetails/inherited instead. |
| 1505 | "inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead. |
| 1506 | "role": "A String", # Deprecated - use permissionDetails/role instead. |
| 1507 | "teamDrivePermissionType": "A String", # Deprecated - use permissionDetails/permissionType instead. |
| 1508 | }, |
| 1509 | ], |
| 1510 | "type": "A String", # The account type. Allowed values are: |
| 1511 | # - user |
| 1512 | # - group |
| 1513 | # - domain |
| 1514 | # - anyone |
| 1515 | "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. |
| 1516 | "withLink": True or False, # Whether the link is required for this permission. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1517 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1518 | ], |
| 1519 | "properties": [ # The list of properties. |
| Nathaniel Manista | 4f877e5 | 2015-06-15 16:44:50 +0000 | [diff] [blame] | 1520 | { # A key-value pair attached to a file that is either public or private to an application. |
| 1521 | # The following limits apply to file properties: |
| 1522 | # - Maximum of 100 properties total per file |
| 1523 | # - Maximum of 30 private properties per app |
| 1524 | # - Maximum of 30 public properties |
| 1525 | # - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1526 | "etag": "A String", # ETag of the property. |
| 1527 | "key": "A String", # The key of this property. |
| 1528 | "kind": "drive#property", # This is always drive#property. |
| 1529 | "selfLink": "A String", # The link back to this property. |
| 1530 | "value": "A String", # The value of this property. |
| 1531 | "visibility": "A String", # The visibility of this property. Allowed values are PRIVATE and PUBLIC. (Default: PRIVATE) |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1532 | }, |
| 1533 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1534 | "quotaBytesUsed": "A String", # The number of quota bytes used by this file. |
| 1535 | "selfLink": "A String", # A link back to this file. |
| 1536 | "shareable": True or False, # Deprecated: use capabilities/canShare. |
| 1537 | "shared": True or False, # Whether the file has been shared. Not populated for items in shared drives. |
| 1538 | "sharedWithMeDate": "A String", # Time at which this file was shared with the user (formatted RFC 3339 timestamp). |
| 1539 | "sharingUser": { # Information about a Drive user. # User that shared the item with the current user, if available. |
| 1540 | "displayName": "A String", # A plain text displayable name for this user. |
| 1541 | "emailAddress": "A String", # The email address of the user. |
| 1542 | "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. |
| 1543 | "kind": "drive#user", # This is always drive#user. |
| 1544 | "permissionId": "A String", # The user's ID as visible in the permissions collection. |
| 1545 | "picture": { # The user's profile picture. |
| 1546 | "url": "A String", # A URL that points to a profile picture of this user. |
| 1547 | }, |
| Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 1548 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1549 | "shortcutDetails": { # Shortcut file details. Only populated for shortcut files, which have the mimeType field set to application/vnd.google-apps.shortcut. |
| 1550 | "targetId": "A String", # The ID of the file that this shortcut points to. |
| 1551 | "targetMimeType": "A String", # The MIME type of the file that this shortcut points to. The value of this field is a snapshot of the target's MIME type, captured when the shortcut is created. |
| 1552 | }, |
| 1553 | "spaces": [ # The list of spaces which contain the file. Supported values are 'drive', 'appDataFolder' and 'photos'. |
| 1554 | "A String", |
| 1555 | ], |
| 1556 | "teamDriveId": "A String", # Deprecated - use driveId instead. |
| 1557 | "thumbnail": { # A thumbnail for the file. This will only be used if a standard thumbnail cannot be generated. |
| 1558 | "image": "A String", # The URL-safe Base64 encoded bytes of the thumbnail image. It should conform to RFC 4648 section 5. |
| 1559 | "mimeType": "A String", # The MIME type of the thumbnail. |
| 1560 | }, |
| 1561 | "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. |
| 1562 | "thumbnailVersion": "A String", # The thumbnail version for use in thumbnail cache invalidation. |
| 1563 | "title": "A String", # The title of this file. Note that for immutable items such as the top level folders of shared drives, My Drive root folder, and Application Data folder the title is constant. |
| 1564 | "trashedDate": "A String", # The time that the item was trashed (formatted RFC 3339 timestamp). Only populated for items in shared drives. |
| 1565 | "trashingUser": { # Information about a Drive user. # If the file has been explicitly trashed, the user who trashed it. Only populated for items in shared drives. |
| 1566 | "displayName": "A String", # A plain text displayable name for this user. |
| 1567 | "emailAddress": "A String", # The email address of the user. |
| 1568 | "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. |
| 1569 | "kind": "drive#user", # This is always drive#user. |
| 1570 | "permissionId": "A String", # The user's ID as visible in the permissions collection. |
| 1571 | "picture": { # The user's profile picture. |
| 1572 | "url": "A String", # A URL that points to a profile picture of this user. |
| 1573 | }, |
| 1574 | }, |
| 1575 | "userPermission": { # A permission for a file. # The permissions for the authenticated user on this file. |
| 1576 | "additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future. |
| 1577 | "A String", |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 1578 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1579 | "authKey": "A String", # Deprecated. |
| 1580 | "deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions. |
| 1581 | "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. |
| 1582 | "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. |
| 1583 | "etag": "A String", # The ETag of the permission. |
| 1584 | "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1585 | # - They cannot be set on shared drive items |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 1586 | # - They can only be set on user and group permissions |
| 1587 | # - The date must be in the future |
| 1588 | # - The date cannot be more than a year in the future |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1589 | # - The date can only be set on drive.permissions.update or drive.permissions.patch requests |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1590 | "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. |
| 1591 | "kind": "drive#permission", # This is always drive#permission. |
| 1592 | "name": "A String", # The name for this permission. |
| 1593 | "permissionDetails": [ # Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. |
| 1594 | { |
| 1595 | "additionalRoles": [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future. |
| 1596 | "A String", |
| 1597 | ], |
| 1598 | "inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field. |
| 1599 | "inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field. |
| 1600 | "permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible: |
| 1601 | # - file |
| 1602 | # - member |
| 1603 | "role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible: |
| 1604 | # - organizer |
| 1605 | # - fileOrganizer |
| 1606 | # - writer |
| 1607 | # - reader |
| 1608 | }, |
| 1609 | ], |
| 1610 | "photoLink": "A String", # A link to the profile photo, if available. |
| 1611 | "role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1612 | # - owner |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1613 | # - organizer |
| 1614 | # - fileOrganizer |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1615 | # - writer |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1616 | # - reader |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1617 | "selfLink": "A String", # A link back to this permission. |
| 1618 | "teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead. |
| 1619 | { |
| 1620 | "additionalRoles": [ # Deprecated - use permissionDetails/additionalRoles instead. |
| 1621 | "A String", |
| 1622 | ], |
| 1623 | "inherited": True or False, # Deprecated - use permissionDetails/inherited instead. |
| 1624 | "inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead. |
| 1625 | "role": "A String", # Deprecated - use permissionDetails/role instead. |
| 1626 | "teamDrivePermissionType": "A String", # Deprecated - use permissionDetails/permissionType instead. |
| 1627 | }, |
| 1628 | ], |
| 1629 | "type": "A String", # The account type. Allowed values are: |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1630 | # - user |
| 1631 | # - group |
| 1632 | # - domain |
| 1633 | # - anyone |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1634 | "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. |
| 1635 | "withLink": True or False, # Whether the link is required for this permission. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1636 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1637 | "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. |
| 1638 | "videoMediaMetadata": { # Metadata about video media. This will only be present for video types. |
| 1639 | "durationMillis": "A String", # The duration of the video in milliseconds. |
| 1640 | "height": 42, # The height of the video in pixels. |
| 1641 | "width": 42, # The width of the video in pixels. |
| 1642 | }, |
| 1643 | "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. |
| 1644 | "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. |
| 1645 | "writersCanShare": True or False, # Whether writers can share the document with other users. Not populated for items in shared drives. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1646 | } |
| 1647 | |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1648 | convert: boolean, Whether to convert this file to the corresponding Google Docs format. |
| 1649 | enforceSingleParent: boolean, Set to true to opt in to API behavior that aims for all items to have exactly one parent. This parameter only takes effect if the item is not in a shared drive. Requests that specify more than one parent fail. |
| Jon Wayne Parrott | 692617a | 2017-01-06 09:58:29 -0800 | [diff] [blame] | 1650 | ocr: boolean, Whether to attempt OCR on .jpg, .png, .gif, or .pdf uploads. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1651 | ocrLanguage: string, If ocr is true, hints at the language to use. Valid values are BCP 47 codes. |
| Jon Wayne Parrott | 692617a | 2017-01-06 09:58:29 -0800 | [diff] [blame] | 1652 | pinned: boolean, Whether to pin the head revision of the uploaded file. A file can have a maximum of 200 pinned revisions. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1653 | supportsAllDrives: boolean, Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives. |
| 1654 | supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead. |
| 1655 | timedTextLanguage: string, The language of the timed text. |
| 1656 | timedTextTrackName: string, The timed text track name. |
| 1657 | useContentAsIndexableText: boolean, Whether to use the content as indexable text. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1658 | visibility: string, The visibility of the new file. This parameter is only relevant when convert=false. |
| 1659 | Allowed values |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1660 | DEFAULT - The visibility of the new file is determined by the user's default visibility/sharing policies. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1661 | PRIVATE - The new file will be visible to only the owner. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1662 | media_body: string, The filename of the media request body, or an instance of a MediaUpload object. |
| Jon Wayne Parrott | 692617a | 2017-01-06 09:58:29 -0800 | [diff] [blame] | 1663 | media_mime_type: string, The MIME type of the media request body, or an instance of a MediaUpload object. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1664 | |
| 1665 | Returns: |
| 1666 | An object of the form: |
| 1667 | |
| 1668 | { # The metadata for a file. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1669 | "alternateLink": "A String", # A link for opening the file in a relevant Google editor or viewer. |
| 1670 | "appDataContents": True or False, # Whether this file is in the Application Data folder. |
| 1671 | "canComment": True or False, # Deprecated: use capabilities/canComment. |
| 1672 | "canReadRevisions": True or False, # Deprecated: use capabilities/canReadRevisions. |
| 1673 | "capabilities": { # Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take. |
| 1674 | "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. |
| 1675 | "canAddMyDriveParent": True or False, # Whether the current user can add a parent for the item without removing an existing parent in the same request. Not populated for shared drive files. |
| 1676 | "canChangeCopyRequiresWriterPermission": True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this file. |
| 1677 | "canChangeRestrictedDownload": True or False, # Deprecated |
| 1678 | "canComment": True or False, # Whether the current user can comment on this file. |
| 1679 | "canCopy": True or False, # Whether the current user can copy this file. For an item in a shared drive, whether the current user can copy non-folder descendants of this item, or this item itself if it is not a folder. |
| 1680 | "canDelete": True or False, # Whether the current user can delete this file. |
| 1681 | "canDeleteChildren": True or False, # Whether the current user can delete children of this folder. This is false when the item is not a folder. Only populated for items in shared drives. |
| 1682 | "canDownload": True or False, # Whether the current user can download this file. |
| 1683 | "canEdit": True or False, # Whether the current user can edit this file. Other factors may limit the type of changes a user can make to a file. For example, see canChangeCopyRequiresWriterPermission or canModifyContent. |
| 1684 | "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. |
| 1685 | "canModifyContent": True or False, # Whether the current user can modify the content of this file. |
| 1686 | "canMoveChildrenOutOfDrive": True or False, # Whether the current user can move children of this folder outside of the shared drive. This is false when the item is not a folder. Only populated for items in shared drives. |
| 1687 | "canMoveChildrenOutOfTeamDrive": True or False, # Deprecated - use canMoveChildrenOutOfDrive instead. |
| 1688 | "canMoveChildrenWithinDrive": True or False, # Whether the current user can move children of this folder within the shared drive. This is false when the item is not a folder. Only populated for items in shared drives. |
| 1689 | "canMoveChildrenWithinTeamDrive": True or False, # Deprecated - use canMoveChildrenWithinDrive instead. |
| 1690 | "canMoveItemIntoTeamDrive": True or False, # Deprecated - use canMoveItemOutOfDrive instead. |
| 1691 | "canMoveItemOutOfDrive": True or False, # Whether the current user can move this item outside of this drive by changing its parent. Note that a request to change the parent of the item may still fail depending on the new parent that is being added. |
| 1692 | "canMoveItemOutOfTeamDrive": True or False, # Deprecated - use canMoveItemOutOfDrive instead. |
| 1693 | "canMoveItemWithinDrive": True or False, # Whether the current user can move this item within this shared drive. Note that a request to change the parent of the item may still fail depending on the new parent that is being added. Only populated for items in shared drives. |
| 1694 | "canMoveItemWithinTeamDrive": True or False, # Deprecated - use canMoveItemWithinDrive instead. |
| 1695 | "canMoveTeamDriveItem": True or False, # Deprecated - use canMoveItemWithinDrive or canMoveItemOutOfDrive instead. |
| 1696 | "canReadDrive": True or False, # Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives. |
| 1697 | "canReadRevisions": True or False, # Whether the current user can read the revisions resource of this file. For a shared drive item, whether revisions of non-folder descendants of this item, or this item itself if it is not a folder, can be read. |
| 1698 | "canReadTeamDrive": True or False, # Deprecated - use canReadDrive instead. |
| 1699 | "canRemoveChildren": True or False, # Whether the current user can remove children from this folder. This is always false when the item is not a folder. For a folder in a shared drive, use canDeleteChildren or canTrashChildren instead. |
| 1700 | "canRemoveMyDriveParent": True or False, # Whether the current user can remove a parent from the item without adding another parent in the same request. Not populated for shared drive files. |
| 1701 | "canRename": True or False, # Whether the current user can rename this file. |
| 1702 | "canShare": True or False, # Whether the current user can modify the sharing settings for this file. |
| 1703 | "canTrash": True or False, # Whether the current user can move this file to trash. |
| 1704 | "canTrashChildren": True or False, # Whether the current user can trash children of this folder. This is false when the item is not a folder. Only populated for items in shared drives. |
| 1705 | "canUntrash": True or False, # Whether the current user can restore this file from trash. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1706 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1707 | "copyRequiresWriterPermission": True or False, # Whether the options to copy, print, or download this file, should be disabled for readers and commenters. |
| 1708 | "copyable": True or False, # Deprecated: use capabilities/canCopy. |
| 1709 | "createdDate": "A String", # Create time for this file (formatted RFC 3339 timestamp). |
| 1710 | "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. |
| 1711 | "description": "A String", # A short description of the file. |
| 1712 | "downloadUrl": "A String", # Short lived download URL for the file. This field is only populated for files with content stored in Google Drive; it is not populated for Google Docs or shortcut files. |
| 1713 | "driveId": "A String", # ID of the shared drive the file resides in. Only populated for items in shared drives. |
| 1714 | "editable": True or False, # Deprecated: use capabilities/canEdit. |
| 1715 | "embedLink": "A String", # A link for embedding the file. |
| 1716 | "etag": "A String", # ETag of the file. |
| 1717 | "explicitlyTrashed": True or False, # Whether this file has been explicitly trashed, as opposed to recursively trashed. |
| 1718 | "exportLinks": { # Links for exporting Google Docs to specific formats. |
| 1719 | "a_key": "A String", # A mapping from export format to URL |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1720 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1721 | "fileExtension": "A String", # The final component of fullFileExtension with trailing text that does not appear to be part of the extension removed. This field is only populated for files with content stored in Google Drive; it is not populated for Google Docs or shortcut files. |
| 1722 | "fileSize": "A String", # The size of the file in bytes. This field is only populated for files with content stored in Google Drive; it is not populated for Google Docs or shortcut files. |
| 1723 | "folderColorRgb": "A String", # Folder color as an RGB hex string if the file is a folder. The list of supported colors is available in the folderColorPalette field of the About resource. If an unsupported color is specified, it will be changed to the closest color in the palette. Not populated for items in shared drives. |
| 1724 | "fullFileExtension": "A String", # The full file extension; extracted from the title. May contain multiple concatenated extensions, such as "tar.gz". Removing an extension from the title does not clear this field; however, changing the extension on the title does update this field. This field is only populated for files with content stored in Google Drive; it is not populated for Google Docs or shortcut files. |
| 1725 | "hasAugmentedPermissions": True or False, # Whether there are permissions directly on this file. This field is only populated for items in shared drives. |
| 1726 | "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. |
| 1727 | "headRevisionId": "A String", # The ID of the file's head revision. This field is only populated for files with content stored in Google Drive; it is not populated for Google Docs or shortcut files. |
| 1728 | "iconLink": "A String", # A link to the file's icon. |
| 1729 | "id": "A String", # The ID of the file. |
| 1730 | "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. |
| 1731 | "aperture": 3.14, # The aperture used to create the photo (f-number). |
| 1732 | "cameraMake": "A String", # The make of the camera used to create the photo. |
| 1733 | "cameraModel": "A String", # The model of the camera used to create the photo. |
| 1734 | "colorSpace": "A String", # The color space of the photo. |
| 1735 | "date": "A String", # The date and time the photo was taken (EXIF format timestamp). |
| 1736 | "exposureBias": 3.14, # The exposure bias of the photo (APEX value). |
| 1737 | "exposureMode": "A String", # The exposure mode used to create the photo. |
| 1738 | "exposureTime": 3.14, # The length of the exposure, in seconds. |
| 1739 | "flashUsed": True or False, # Whether a flash was used to create the photo. |
| 1740 | "focalLength": 3.14, # The focal length used to create the photo, in millimeters. |
| 1741 | "height": 42, # The height of the image in pixels. |
| 1742 | "isoSpeed": 42, # The ISO speed used to create the photo. |
| 1743 | "lens": "A String", # The lens used to create the photo. |
| 1744 | "location": { # Geographic location information stored in the image. |
| 1745 | "altitude": 3.14, # The altitude stored in the image. |
| 1746 | "latitude": 3.14, # The latitude stored in the image. |
| 1747 | "longitude": 3.14, # The longitude stored in the image. |
| 1748 | }, |
| 1749 | "maxApertureValue": 3.14, # The smallest f-number of the lens at the focal length used to create the photo (APEX value). |
| 1750 | "meteringMode": "A String", # The metering mode used to create the photo. |
| 1751 | "rotation": 42, # The number of clockwise 90 degree rotations applied from the image's original orientation. |
| 1752 | "sensor": "A String", # The type of sensor used to create the photo. |
| 1753 | "subjectDistance": 42, # The distance to the subject of the photo, in meters. |
| 1754 | "whiteBalance": "A String", # The white balance mode used to create the photo. |
| 1755 | "width": 42, # The width of the image in pixels. |
| 1756 | }, |
| 1757 | "indexableText": { # Indexable text attributes for the file (can only be written) |
| 1758 | "text": "A String", # The text to be indexed for this file. |
| 1759 | }, |
| 1760 | "isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app. |
| 1761 | "kind": "drive#file", # The type of file. This is always drive#file. |
| 1762 | "labels": { # A group of labels for the file. |
| 1763 | "hidden": True or False, # Deprecated. |
| 1764 | "modified": True or False, # Whether the file has been modified by this user. |
| 1765 | "restricted": True or False, # Deprecated - use copyRequiresWriterPermission instead. |
| 1766 | "starred": True or False, # Whether this file is starred by the user. |
| 1767 | "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. |
| 1768 | "viewed": True or False, # Whether this file has been viewed by this user. |
| 1769 | }, |
| 1770 | "lastModifyingUser": { # Information about a Drive user. # The last user to modify this file. |
| 1771 | "displayName": "A String", # A plain text displayable name for this user. |
| 1772 | "emailAddress": "A String", # The email address of the user. |
| 1773 | "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. |
| 1774 | "kind": "drive#user", # This is always drive#user. |
| 1775 | "permissionId": "A String", # The user's ID as visible in the permissions collection. |
| 1776 | "picture": { # The user's profile picture. |
| 1777 | "url": "A String", # A URL that points to a profile picture of this user. |
| 1778 | }, |
| 1779 | }, |
| 1780 | "lastModifyingUserName": "A String", # Name of the last user to modify this file. |
| 1781 | "lastViewedByMeDate": "A String", # Last time this file was viewed by the user (formatted RFC 3339 timestamp). |
| 1782 | "markedViewedByMeDate": "A String", # Deprecated. |
| 1783 | "md5Checksum": "A String", # An MD5 checksum for the content of this file. This field is only populated for files with content stored in Google Drive; it is not populated for Google Docs or shortcut files. |
| 1784 | "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. |
| 1785 | "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. |
| 1786 | "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. |
| 1787 | "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. |
| 1788 | "a_key": "A String", |
| 1789 | }, |
| 1790 | "originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the title field. This is only available for files with binary content in Google Drive. |
| 1791 | "ownedByMe": True or False, # Whether the file is owned by the current user. Not populated for items in shared drives. |
| 1792 | "ownerNames": [ # Name(s) of the owner(s) of this file. Not populated for items in shared drives. |
| 1793 | "A String", |
| 1794 | ], |
| 1795 | "owners": [ # The owner(s) of this file. Not populated for items in shared drives. |
| Sai Cheemalapati | df61397 | 2016-10-21 13:59:49 -0700 | [diff] [blame] | 1796 | { # Information about a Drive user. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1797 | "displayName": "A String", # A plain text displayable name for this user. |
| 1798 | "emailAddress": "A String", # The email address of the user. |
| 1799 | "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. |
| 1800 | "kind": "drive#user", # This is always drive#user. |
| 1801 | "permissionId": "A String", # The user's ID as visible in the permissions collection. |
| 1802 | "picture": { # The user's profile picture. |
| 1803 | "url": "A String", # A URL that points to a profile picture of this user. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1804 | }, |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1805 | }, |
| 1806 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1807 | "parents": [ # Collection of parent folders which contain this file. |
| 1808 | # If not specified as part of an insert request, the file will be placed directly in the user's My Drive folder. If not specified as part of a copy request, the file will inherit any discoverable parents of the source file. Update requests can also use the addParents and removeParents parameters to modify the parents list. |
| 1809 | { # A reference to a file's parent. |
| 1810 | "id": "A String", # The ID of the parent. |
| 1811 | "isRoot": True or False, # Whether or not the parent is the root folder. |
| 1812 | "kind": "drive#parentReference", # This is always drive#parentReference. |
| 1813 | "parentLink": "A String", # A link to the parent. |
| 1814 | "selfLink": "A String", # A link back to this reference. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1815 | }, |
| 1816 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1817 | "permissionIds": [ # List of permission IDs for users with access to this file. |
| 1818 | "A String", |
| 1819 | ], |
| 1820 | "permissions": [ # The list of permissions for users with access to this file. Not populated for items in shared drives. |
| 1821 | { # A permission for a file. |
| 1822 | "additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future. |
| 1823 | "A String", |
| 1824 | ], |
| 1825 | "authKey": "A String", # Deprecated. |
| 1826 | "deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions. |
| 1827 | "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. |
| 1828 | "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. |
| 1829 | "etag": "A String", # The ETag of the permission. |
| 1830 | "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: |
| 1831 | # - They cannot be set on shared drive items |
| 1832 | # - They can only be set on user and group permissions |
| 1833 | # - The date must be in the future |
| 1834 | # - The date cannot be more than a year in the future |
| 1835 | # - The date can only be set on drive.permissions.update or drive.permissions.patch requests |
| 1836 | "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. |
| 1837 | "kind": "drive#permission", # This is always drive#permission. |
| 1838 | "name": "A String", # The name for this permission. |
| 1839 | "permissionDetails": [ # Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. |
| 1840 | { |
| 1841 | "additionalRoles": [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future. |
| 1842 | "A String", |
| 1843 | ], |
| 1844 | "inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field. |
| 1845 | "inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field. |
| 1846 | "permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible: |
| 1847 | # - file |
| 1848 | # - member |
| 1849 | "role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible: |
| 1850 | # - organizer |
| 1851 | # - fileOrganizer |
| 1852 | # - writer |
| 1853 | # - reader |
| 1854 | }, |
| 1855 | ], |
| 1856 | "photoLink": "A String", # A link to the profile photo, if available. |
| 1857 | "role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: |
| 1858 | # - owner |
| 1859 | # - organizer |
| 1860 | # - fileOrganizer |
| 1861 | # - writer |
| 1862 | # - reader |
| 1863 | "selfLink": "A String", # A link back to this permission. |
| 1864 | "teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead. |
| 1865 | { |
| 1866 | "additionalRoles": [ # Deprecated - use permissionDetails/additionalRoles instead. |
| 1867 | "A String", |
| 1868 | ], |
| 1869 | "inherited": True or False, # Deprecated - use permissionDetails/inherited instead. |
| 1870 | "inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead. |
| 1871 | "role": "A String", # Deprecated - use permissionDetails/role instead. |
| 1872 | "teamDrivePermissionType": "A String", # Deprecated - use permissionDetails/permissionType instead. |
| 1873 | }, |
| 1874 | ], |
| 1875 | "type": "A String", # The account type. Allowed values are: |
| 1876 | # - user |
| 1877 | # - group |
| 1878 | # - domain |
| 1879 | # - anyone |
| 1880 | "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. |
| 1881 | "withLink": True or False, # Whether the link is required for this permission. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1882 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1883 | ], |
| 1884 | "properties": [ # The list of properties. |
| Nathaniel Manista | 4f877e5 | 2015-06-15 16:44:50 +0000 | [diff] [blame] | 1885 | { # A key-value pair attached to a file that is either public or private to an application. |
| 1886 | # The following limits apply to file properties: |
| 1887 | # - Maximum of 100 properties total per file |
| 1888 | # - Maximum of 30 private properties per app |
| 1889 | # - Maximum of 30 public properties |
| 1890 | # - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1891 | "etag": "A String", # ETag of the property. |
| 1892 | "key": "A String", # The key of this property. |
| 1893 | "kind": "drive#property", # This is always drive#property. |
| 1894 | "selfLink": "A String", # The link back to this property. |
| 1895 | "value": "A String", # The value of this property. |
| 1896 | "visibility": "A String", # The visibility of this property. Allowed values are PRIVATE and PUBLIC. (Default: PRIVATE) |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1897 | }, |
| 1898 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1899 | "quotaBytesUsed": "A String", # The number of quota bytes used by this file. |
| 1900 | "selfLink": "A String", # A link back to this file. |
| 1901 | "shareable": True or False, # Deprecated: use capabilities/canShare. |
| 1902 | "shared": True or False, # Whether the file has been shared. Not populated for items in shared drives. |
| 1903 | "sharedWithMeDate": "A String", # Time at which this file was shared with the user (formatted RFC 3339 timestamp). |
| 1904 | "sharingUser": { # Information about a Drive user. # User that shared the item with the current user, if available. |
| 1905 | "displayName": "A String", # A plain text displayable name for this user. |
| 1906 | "emailAddress": "A String", # The email address of the user. |
| 1907 | "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. |
| 1908 | "kind": "drive#user", # This is always drive#user. |
| 1909 | "permissionId": "A String", # The user's ID as visible in the permissions collection. |
| 1910 | "picture": { # The user's profile picture. |
| 1911 | "url": "A String", # A URL that points to a profile picture of this user. |
| 1912 | }, |
| Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 1913 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1914 | "shortcutDetails": { # Shortcut file details. Only populated for shortcut files, which have the mimeType field set to application/vnd.google-apps.shortcut. |
| 1915 | "targetId": "A String", # The ID of the file that this shortcut points to. |
| 1916 | "targetMimeType": "A String", # The MIME type of the file that this shortcut points to. The value of this field is a snapshot of the target's MIME type, captured when the shortcut is created. |
| 1917 | }, |
| 1918 | "spaces": [ # The list of spaces which contain the file. Supported values are 'drive', 'appDataFolder' and 'photos'. |
| 1919 | "A String", |
| 1920 | ], |
| 1921 | "teamDriveId": "A String", # Deprecated - use driveId instead. |
| 1922 | "thumbnail": { # A thumbnail for the file. This will only be used if a standard thumbnail cannot be generated. |
| 1923 | "image": "A String", # The URL-safe Base64 encoded bytes of the thumbnail image. It should conform to RFC 4648 section 5. |
| 1924 | "mimeType": "A String", # The MIME type of the thumbnail. |
| 1925 | }, |
| 1926 | "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. |
| 1927 | "thumbnailVersion": "A String", # The thumbnail version for use in thumbnail cache invalidation. |
| 1928 | "title": "A String", # The title of this file. Note that for immutable items such as the top level folders of shared drives, My Drive root folder, and Application Data folder the title is constant. |
| 1929 | "trashedDate": "A String", # The time that the item was trashed (formatted RFC 3339 timestamp). Only populated for items in shared drives. |
| 1930 | "trashingUser": { # Information about a Drive user. # If the file has been explicitly trashed, the user who trashed it. Only populated for items in shared drives. |
| 1931 | "displayName": "A String", # A plain text displayable name for this user. |
| 1932 | "emailAddress": "A String", # The email address of the user. |
| 1933 | "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. |
| 1934 | "kind": "drive#user", # This is always drive#user. |
| 1935 | "permissionId": "A String", # The user's ID as visible in the permissions collection. |
| 1936 | "picture": { # The user's profile picture. |
| 1937 | "url": "A String", # A URL that points to a profile picture of this user. |
| 1938 | }, |
| 1939 | }, |
| 1940 | "userPermission": { # A permission for a file. # The permissions for the authenticated user on this file. |
| 1941 | "additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future. |
| 1942 | "A String", |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 1943 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1944 | "authKey": "A String", # Deprecated. |
| 1945 | "deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions. |
| 1946 | "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. |
| 1947 | "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. |
| 1948 | "etag": "A String", # The ETag of the permission. |
| 1949 | "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1950 | # - They cannot be set on shared drive items |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 1951 | # - They can only be set on user and group permissions |
| 1952 | # - The date must be in the future |
| 1953 | # - The date cannot be more than a year in the future |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1954 | # - The date can only be set on drive.permissions.update or drive.permissions.patch requests |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1955 | "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. |
| 1956 | "kind": "drive#permission", # This is always drive#permission. |
| 1957 | "name": "A String", # The name for this permission. |
| 1958 | "permissionDetails": [ # Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. |
| 1959 | { |
| 1960 | "additionalRoles": [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future. |
| 1961 | "A String", |
| 1962 | ], |
| 1963 | "inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field. |
| 1964 | "inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field. |
| 1965 | "permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible: |
| 1966 | # - file |
| 1967 | # - member |
| 1968 | "role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible: |
| 1969 | # - organizer |
| 1970 | # - fileOrganizer |
| 1971 | # - writer |
| 1972 | # - reader |
| 1973 | }, |
| 1974 | ], |
| 1975 | "photoLink": "A String", # A link to the profile photo, if available. |
| 1976 | "role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1977 | # - owner |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1978 | # - organizer |
| 1979 | # - fileOrganizer |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1980 | # - writer |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1981 | # - reader |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1982 | "selfLink": "A String", # A link back to this permission. |
| 1983 | "teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead. |
| 1984 | { |
| 1985 | "additionalRoles": [ # Deprecated - use permissionDetails/additionalRoles instead. |
| 1986 | "A String", |
| 1987 | ], |
| 1988 | "inherited": True or False, # Deprecated - use permissionDetails/inherited instead. |
| 1989 | "inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead. |
| 1990 | "role": "A String", # Deprecated - use permissionDetails/role instead. |
| 1991 | "teamDrivePermissionType": "A String", # Deprecated - use permissionDetails/permissionType instead. |
| 1992 | }, |
| 1993 | ], |
| 1994 | "type": "A String", # The account type. Allowed values are: |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1995 | # - user |
| 1996 | # - group |
| 1997 | # - domain |
| 1998 | # - anyone |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1999 | "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. |
| 2000 | "withLink": True or False, # Whether the link is required for this permission. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 2001 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2002 | "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. |
| 2003 | "videoMediaMetadata": { # Metadata about video media. This will only be present for video types. |
| 2004 | "durationMillis": "A String", # The duration of the video in milliseconds. |
| 2005 | "height": 42, # The height of the video in pixels. |
| 2006 | "width": 42, # The width of the video in pixels. |
| 2007 | }, |
| 2008 | "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. |
| 2009 | "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. |
| 2010 | "writersCanShare": True or False, # Whether writers can share the document with other users. Not populated for items in shared drives. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 2011 | }</pre> |
| 2012 | </div> |
| 2013 | |
| 2014 | <div class="method"> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2015 | <code class="details" id="list">list(corpora=None, corpus=None, driveId=None, includeItemsFromAllDrives=None, includeTeamDriveItems=None, maxResults=None, orderBy=None, pageToken=None, projection=None, q=None, spaces=None, supportsAllDrives=None, supportsTeamDrives=None, teamDriveId=None)</code> |
| 2016 | <pre>Lists the user's files. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 2017 | |
| 2018 | Args: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2019 | corpora: string, Bodies of items (files/documents) to which the query applies. Supported bodies are 'default', 'domain', 'drive' and 'allDrives'. Prefer 'default' or 'drive' to 'allDrives' for efficiency. |
| 2020 | corpus: string, The body of items (files/documents) to which the query applies. Deprecated: use 'corpora' instead. |
| 2021 | Allowed values |
| 2022 | DEFAULT - The items that the user has accessed. |
| 2023 | DOMAIN - Items shared to the user's domain. |
| 2024 | driveId: string, ID of the shared drive to search. |
| 2025 | includeItemsFromAllDrives: boolean, Deprecated - Whether both My Drive and shared drive items should be included in results. This parameter will only be effective until June 1, 2020. Afterwards shared drive items will be included in the results. |
| 2026 | includeTeamDriveItems: boolean, Deprecated use includeItemsFromAllDrives instead. |
| 2027 | 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. |
| 2028 | orderBy: string, A comma-separated list of sort keys. Valid keys are 'createdDate', 'folder', 'lastViewedByMeDate', 'modifiedByMeDate', 'modifiedDate', 'quotaBytesUsed', 'recency', 'sharedWithMeDate', 'starred', 'title', and 'title_natural'. Each key sorts ascending by default, but may be reversed with the 'desc' modifier. Example usage: ?orderBy=folder,modifiedDate desc,title. Please note that there is a current limitation for users with approximately one million files in which the requested sort order is ignored. |
| 2029 | pageToken: string, Page token for files. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 2030 | projection: string, This parameter is deprecated and has no function. |
| 2031 | Allowed values |
| 2032 | BASIC - Deprecated |
| 2033 | FULL - Deprecated |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2034 | q: string, Query string for searching files. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2035 | spaces: string, A comma-separated list of spaces to query. Supported values are 'drive', 'appDataFolder' and 'photos'. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2036 | supportsAllDrives: boolean, Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2037 | supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead. |
| 2038 | teamDriveId: string, Deprecated use driveId instead. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 2039 | |
| 2040 | Returns: |
| 2041 | An object of the form: |
| 2042 | |
| 2043 | { # A list of files. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2044 | "etag": "A String", # The ETag of the list. |
| 2045 | "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 drives with the "allDrives" 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 "drive". |
| 2046 | "items": [ # The list of files. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 2047 | { # The metadata for a file. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2048 | "alternateLink": "A String", # A link for opening the file in a relevant Google editor or viewer. |
| 2049 | "appDataContents": True or False, # Whether this file is in the Application Data folder. |
| 2050 | "canComment": True or False, # Deprecated: use capabilities/canComment. |
| 2051 | "canReadRevisions": True or False, # Deprecated: use capabilities/canReadRevisions. |
| 2052 | "capabilities": { # Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take. |
| 2053 | "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. |
| 2054 | "canAddMyDriveParent": True or False, # Whether the current user can add a parent for the item without removing an existing parent in the same request. Not populated for shared drive files. |
| 2055 | "canChangeCopyRequiresWriterPermission": True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this file. |
| 2056 | "canChangeRestrictedDownload": True or False, # Deprecated |
| 2057 | "canComment": True or False, # Whether the current user can comment on this file. |
| 2058 | "canCopy": True or False, # Whether the current user can copy this file. For an item in a shared drive, whether the current user can copy non-folder descendants of this item, or this item itself if it is not a folder. |
| 2059 | "canDelete": True or False, # Whether the current user can delete this file. |
| 2060 | "canDeleteChildren": True or False, # Whether the current user can delete children of this folder. This is false when the item is not a folder. Only populated for items in shared drives. |
| 2061 | "canDownload": True or False, # Whether the current user can download this file. |
| 2062 | "canEdit": True or False, # Whether the current user can edit this file. Other factors may limit the type of changes a user can make to a file. For example, see canChangeCopyRequiresWriterPermission or canModifyContent. |
| 2063 | "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. |
| 2064 | "canModifyContent": True or False, # Whether the current user can modify the content of this file. |
| 2065 | "canMoveChildrenOutOfDrive": True or False, # Whether the current user can move children of this folder outside of the shared drive. This is false when the item is not a folder. Only populated for items in shared drives. |
| 2066 | "canMoveChildrenOutOfTeamDrive": True or False, # Deprecated - use canMoveChildrenOutOfDrive instead. |
| 2067 | "canMoveChildrenWithinDrive": True or False, # Whether the current user can move children of this folder within the shared drive. This is false when the item is not a folder. Only populated for items in shared drives. |
| 2068 | "canMoveChildrenWithinTeamDrive": True or False, # Deprecated - use canMoveChildrenWithinDrive instead. |
| 2069 | "canMoveItemIntoTeamDrive": True or False, # Deprecated - use canMoveItemOutOfDrive instead. |
| 2070 | "canMoveItemOutOfDrive": True or False, # Whether the current user can move this item outside of this drive by changing its parent. Note that a request to change the parent of the item may still fail depending on the new parent that is being added. |
| 2071 | "canMoveItemOutOfTeamDrive": True or False, # Deprecated - use canMoveItemOutOfDrive instead. |
| 2072 | "canMoveItemWithinDrive": True or False, # Whether the current user can move this item within this shared drive. Note that a request to change the parent of the item may still fail depending on the new parent that is being added. Only populated for items in shared drives. |
| 2073 | "canMoveItemWithinTeamDrive": True or False, # Deprecated - use canMoveItemWithinDrive instead. |
| 2074 | "canMoveTeamDriveItem": True or False, # Deprecated - use canMoveItemWithinDrive or canMoveItemOutOfDrive instead. |
| 2075 | "canReadDrive": True or False, # Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives. |
| 2076 | "canReadRevisions": True or False, # Whether the current user can read the revisions resource of this file. For a shared drive item, whether revisions of non-folder descendants of this item, or this item itself if it is not a folder, can be read. |
| 2077 | "canReadTeamDrive": True or False, # Deprecated - use canReadDrive instead. |
| 2078 | "canRemoveChildren": True or False, # Whether the current user can remove children from this folder. This is always false when the item is not a folder. For a folder in a shared drive, use canDeleteChildren or canTrashChildren instead. |
| 2079 | "canRemoveMyDriveParent": True or False, # Whether the current user can remove a parent from the item without adding another parent in the same request. Not populated for shared drive files. |
| 2080 | "canRename": True or False, # Whether the current user can rename this file. |
| 2081 | "canShare": True or False, # Whether the current user can modify the sharing settings for this file. |
| 2082 | "canTrash": True or False, # Whether the current user can move this file to trash. |
| 2083 | "canTrashChildren": True or False, # Whether the current user can trash children of this folder. This is false when the item is not a folder. Only populated for items in shared drives. |
| 2084 | "canUntrash": True or False, # Whether the current user can restore this file from trash. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 2085 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2086 | "copyRequiresWriterPermission": True or False, # Whether the options to copy, print, or download this file, should be disabled for readers and commenters. |
| 2087 | "copyable": True or False, # Deprecated: use capabilities/canCopy. |
| 2088 | "createdDate": "A String", # Create time for this file (formatted RFC 3339 timestamp). |
| 2089 | "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. |
| 2090 | "description": "A String", # A short description of the file. |
| 2091 | "downloadUrl": "A String", # Short lived download URL for the file. This field is only populated for files with content stored in Google Drive; it is not populated for Google Docs or shortcut files. |
| 2092 | "driveId": "A String", # ID of the shared drive the file resides in. Only populated for items in shared drives. |
| 2093 | "editable": True or False, # Deprecated: use capabilities/canEdit. |
| 2094 | "embedLink": "A String", # A link for embedding the file. |
| 2095 | "etag": "A String", # ETag of the file. |
| 2096 | "explicitlyTrashed": True or False, # Whether this file has been explicitly trashed, as opposed to recursively trashed. |
| 2097 | "exportLinks": { # Links for exporting Google Docs to specific formats. |
| 2098 | "a_key": "A String", # A mapping from export format to URL |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 2099 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2100 | "fileExtension": "A String", # The final component of fullFileExtension with trailing text that does not appear to be part of the extension removed. This field is only populated for files with content stored in Google Drive; it is not populated for Google Docs or shortcut files. |
| 2101 | "fileSize": "A String", # The size of the file in bytes. This field is only populated for files with content stored in Google Drive; it is not populated for Google Docs or shortcut files. |
| 2102 | "folderColorRgb": "A String", # Folder color as an RGB hex string if the file is a folder. The list of supported colors is available in the folderColorPalette field of the About resource. If an unsupported color is specified, it will be changed to the closest color in the palette. Not populated for items in shared drives. |
| 2103 | "fullFileExtension": "A String", # The full file extension; extracted from the title. May contain multiple concatenated extensions, such as "tar.gz". Removing an extension from the title does not clear this field; however, changing the extension on the title does update this field. This field is only populated for files with content stored in Google Drive; it is not populated for Google Docs or shortcut files. |
| 2104 | "hasAugmentedPermissions": True or False, # Whether there are permissions directly on this file. This field is only populated for items in shared drives. |
| 2105 | "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. |
| 2106 | "headRevisionId": "A String", # The ID of the file's head revision. This field is only populated for files with content stored in Google Drive; it is not populated for Google Docs or shortcut files. |
| 2107 | "iconLink": "A String", # A link to the file's icon. |
| 2108 | "id": "A String", # The ID of the file. |
| 2109 | "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. |
| 2110 | "aperture": 3.14, # The aperture used to create the photo (f-number). |
| 2111 | "cameraMake": "A String", # The make of the camera used to create the photo. |
| 2112 | "cameraModel": "A String", # The model of the camera used to create the photo. |
| 2113 | "colorSpace": "A String", # The color space of the photo. |
| 2114 | "date": "A String", # The date and time the photo was taken (EXIF format timestamp). |
| 2115 | "exposureBias": 3.14, # The exposure bias of the photo (APEX value). |
| 2116 | "exposureMode": "A String", # The exposure mode used to create the photo. |
| 2117 | "exposureTime": 3.14, # The length of the exposure, in seconds. |
| 2118 | "flashUsed": True or False, # Whether a flash was used to create the photo. |
| 2119 | "focalLength": 3.14, # The focal length used to create the photo, in millimeters. |
| 2120 | "height": 42, # The height of the image in pixels. |
| 2121 | "isoSpeed": 42, # The ISO speed used to create the photo. |
| 2122 | "lens": "A String", # The lens used to create the photo. |
| 2123 | "location": { # Geographic location information stored in the image. |
| 2124 | "altitude": 3.14, # The altitude stored in the image. |
| 2125 | "latitude": 3.14, # The latitude stored in the image. |
| 2126 | "longitude": 3.14, # The longitude stored in the image. |
| 2127 | }, |
| 2128 | "maxApertureValue": 3.14, # The smallest f-number of the lens at the focal length used to create the photo (APEX value). |
| 2129 | "meteringMode": "A String", # The metering mode used to create the photo. |
| 2130 | "rotation": 42, # The number of clockwise 90 degree rotations applied from the image's original orientation. |
| 2131 | "sensor": "A String", # The type of sensor used to create the photo. |
| 2132 | "subjectDistance": 42, # The distance to the subject of the photo, in meters. |
| 2133 | "whiteBalance": "A String", # The white balance mode used to create the photo. |
| 2134 | "width": 42, # The width of the image in pixels. |
| 2135 | }, |
| 2136 | "indexableText": { # Indexable text attributes for the file (can only be written) |
| 2137 | "text": "A String", # The text to be indexed for this file. |
| 2138 | }, |
| 2139 | "isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app. |
| 2140 | "kind": "drive#file", # The type of file. This is always drive#file. |
| 2141 | "labels": { # A group of labels for the file. |
| 2142 | "hidden": True or False, # Deprecated. |
| 2143 | "modified": True or False, # Whether the file has been modified by this user. |
| 2144 | "restricted": True or False, # Deprecated - use copyRequiresWriterPermission instead. |
| 2145 | "starred": True or False, # Whether this file is starred by the user. |
| 2146 | "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. |
| 2147 | "viewed": True or False, # Whether this file has been viewed by this user. |
| 2148 | }, |
| 2149 | "lastModifyingUser": { # Information about a Drive user. # The last user to modify this file. |
| 2150 | "displayName": "A String", # A plain text displayable name for this user. |
| 2151 | "emailAddress": "A String", # The email address of the user. |
| 2152 | "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. |
| 2153 | "kind": "drive#user", # This is always drive#user. |
| 2154 | "permissionId": "A String", # The user's ID as visible in the permissions collection. |
| 2155 | "picture": { # The user's profile picture. |
| 2156 | "url": "A String", # A URL that points to a profile picture of this user. |
| 2157 | }, |
| 2158 | }, |
| 2159 | "lastModifyingUserName": "A String", # Name of the last user to modify this file. |
| 2160 | "lastViewedByMeDate": "A String", # Last time this file was viewed by the user (formatted RFC 3339 timestamp). |
| 2161 | "markedViewedByMeDate": "A String", # Deprecated. |
| 2162 | "md5Checksum": "A String", # An MD5 checksum for the content of this file. This field is only populated for files with content stored in Google Drive; it is not populated for Google Docs or shortcut files. |
| 2163 | "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. |
| 2164 | "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. |
| 2165 | "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. |
| 2166 | "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. |
| 2167 | "a_key": "A String", |
| 2168 | }, |
| 2169 | "originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the title field. This is only available for files with binary content in Google Drive. |
| 2170 | "ownedByMe": True or False, # Whether the file is owned by the current user. Not populated for items in shared drives. |
| 2171 | "ownerNames": [ # Name(s) of the owner(s) of this file. Not populated for items in shared drives. |
| 2172 | "A String", |
| 2173 | ], |
| 2174 | "owners": [ # The owner(s) of this file. Not populated for items in shared drives. |
| Sai Cheemalapati | df61397 | 2016-10-21 13:59:49 -0700 | [diff] [blame] | 2175 | { # Information about a Drive user. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2176 | "displayName": "A String", # A plain text displayable name for this user. |
| 2177 | "emailAddress": "A String", # The email address of the user. |
| 2178 | "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. |
| 2179 | "kind": "drive#user", # This is always drive#user. |
| 2180 | "permissionId": "A String", # The user's ID as visible in the permissions collection. |
| 2181 | "picture": { # The user's profile picture. |
| 2182 | "url": "A String", # A URL that points to a profile picture of this user. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 2183 | }, |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 2184 | }, |
| 2185 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2186 | "parents": [ # Collection of parent folders which contain this file. |
| 2187 | # If not specified as part of an insert request, the file will be placed directly in the user's My Drive folder. If not specified as part of a copy request, the file will inherit any discoverable parents of the source file. Update requests can also use the addParents and removeParents parameters to modify the parents list. |
| 2188 | { # A reference to a file's parent. |
| 2189 | "id": "A String", # The ID of the parent. |
| 2190 | "isRoot": True or False, # Whether or not the parent is the root folder. |
| 2191 | "kind": "drive#parentReference", # This is always drive#parentReference. |
| 2192 | "parentLink": "A String", # A link to the parent. |
| 2193 | "selfLink": "A String", # A link back to this reference. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 2194 | }, |
| 2195 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2196 | "permissionIds": [ # List of permission IDs for users with access to this file. |
| 2197 | "A String", |
| 2198 | ], |
| 2199 | "permissions": [ # The list of permissions for users with access to this file. Not populated for items in shared drives. |
| 2200 | { # A permission for a file. |
| 2201 | "additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future. |
| 2202 | "A String", |
| 2203 | ], |
| 2204 | "authKey": "A String", # Deprecated. |
| 2205 | "deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions. |
| 2206 | "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. |
| 2207 | "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. |
| 2208 | "etag": "A String", # The ETag of the permission. |
| 2209 | "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: |
| 2210 | # - They cannot be set on shared drive items |
| 2211 | # - They can only be set on user and group permissions |
| 2212 | # - The date must be in the future |
| 2213 | # - The date cannot be more than a year in the future |
| 2214 | # - The date can only be set on drive.permissions.update or drive.permissions.patch requests |
| 2215 | "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. |
| 2216 | "kind": "drive#permission", # This is always drive#permission. |
| 2217 | "name": "A String", # The name for this permission. |
| 2218 | "permissionDetails": [ # Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. |
| 2219 | { |
| 2220 | "additionalRoles": [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future. |
| 2221 | "A String", |
| 2222 | ], |
| 2223 | "inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field. |
| 2224 | "inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field. |
| 2225 | "permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible: |
| 2226 | # - file |
| 2227 | # - member |
| 2228 | "role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible: |
| 2229 | # - organizer |
| 2230 | # - fileOrganizer |
| 2231 | # - writer |
| 2232 | # - reader |
| 2233 | }, |
| 2234 | ], |
| 2235 | "photoLink": "A String", # A link to the profile photo, if available. |
| 2236 | "role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: |
| 2237 | # - owner |
| 2238 | # - organizer |
| 2239 | # - fileOrganizer |
| 2240 | # - writer |
| 2241 | # - reader |
| 2242 | "selfLink": "A String", # A link back to this permission. |
| 2243 | "teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead. |
| 2244 | { |
| 2245 | "additionalRoles": [ # Deprecated - use permissionDetails/additionalRoles instead. |
| 2246 | "A String", |
| 2247 | ], |
| 2248 | "inherited": True or False, # Deprecated - use permissionDetails/inherited instead. |
| 2249 | "inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead. |
| 2250 | "role": "A String", # Deprecated - use permissionDetails/role instead. |
| 2251 | "teamDrivePermissionType": "A String", # Deprecated - use permissionDetails/permissionType instead. |
| 2252 | }, |
| 2253 | ], |
| 2254 | "type": "A String", # The account type. Allowed values are: |
| 2255 | # - user |
| 2256 | # - group |
| 2257 | # - domain |
| 2258 | # - anyone |
| 2259 | "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. |
| 2260 | "withLink": True or False, # Whether the link is required for this permission. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 2261 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2262 | ], |
| 2263 | "properties": [ # The list of properties. |
| Nathaniel Manista | 4f877e5 | 2015-06-15 16:44:50 +0000 | [diff] [blame] | 2264 | { # A key-value pair attached to a file that is either public or private to an application. |
| 2265 | # The following limits apply to file properties: |
| 2266 | # - Maximum of 100 properties total per file |
| 2267 | # - Maximum of 30 private properties per app |
| 2268 | # - Maximum of 30 public properties |
| 2269 | # - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2270 | "etag": "A String", # ETag of the property. |
| 2271 | "key": "A String", # The key of this property. |
| 2272 | "kind": "drive#property", # This is always drive#property. |
| 2273 | "selfLink": "A String", # The link back to this property. |
| 2274 | "value": "A String", # The value of this property. |
| 2275 | "visibility": "A String", # The visibility of this property. Allowed values are PRIVATE and PUBLIC. (Default: PRIVATE) |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 2276 | }, |
| 2277 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2278 | "quotaBytesUsed": "A String", # The number of quota bytes used by this file. |
| 2279 | "selfLink": "A String", # A link back to this file. |
| 2280 | "shareable": True or False, # Deprecated: use capabilities/canShare. |
| 2281 | "shared": True or False, # Whether the file has been shared. Not populated for items in shared drives. |
| 2282 | "sharedWithMeDate": "A String", # Time at which this file was shared with the user (formatted RFC 3339 timestamp). |
| 2283 | "sharingUser": { # Information about a Drive user. # User that shared the item with the current user, if available. |
| 2284 | "displayName": "A String", # A plain text displayable name for this user. |
| 2285 | "emailAddress": "A String", # The email address of the user. |
| 2286 | "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. |
| 2287 | "kind": "drive#user", # This is always drive#user. |
| 2288 | "permissionId": "A String", # The user's ID as visible in the permissions collection. |
| 2289 | "picture": { # The user's profile picture. |
| 2290 | "url": "A String", # A URL that points to a profile picture of this user. |
| 2291 | }, |
| Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 2292 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2293 | "shortcutDetails": { # Shortcut file details. Only populated for shortcut files, which have the mimeType field set to application/vnd.google-apps.shortcut. |
| 2294 | "targetId": "A String", # The ID of the file that this shortcut points to. |
| 2295 | "targetMimeType": "A String", # The MIME type of the file that this shortcut points to. The value of this field is a snapshot of the target's MIME type, captured when the shortcut is created. |
| 2296 | }, |
| 2297 | "spaces": [ # The list of spaces which contain the file. Supported values are 'drive', 'appDataFolder' and 'photos'. |
| 2298 | "A String", |
| 2299 | ], |
| 2300 | "teamDriveId": "A String", # Deprecated - use driveId instead. |
| 2301 | "thumbnail": { # A thumbnail for the file. This will only be used if a standard thumbnail cannot be generated. |
| 2302 | "image": "A String", # The URL-safe Base64 encoded bytes of the thumbnail image. It should conform to RFC 4648 section 5. |
| 2303 | "mimeType": "A String", # The MIME type of the thumbnail. |
| 2304 | }, |
| 2305 | "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. |
| 2306 | "thumbnailVersion": "A String", # The thumbnail version for use in thumbnail cache invalidation. |
| 2307 | "title": "A String", # The title of this file. Note that for immutable items such as the top level folders of shared drives, My Drive root folder, and Application Data folder the title is constant. |
| 2308 | "trashedDate": "A String", # The time that the item was trashed (formatted RFC 3339 timestamp). Only populated for items in shared drives. |
| 2309 | "trashingUser": { # Information about a Drive user. # If the file has been explicitly trashed, the user who trashed it. Only populated for items in shared drives. |
| 2310 | "displayName": "A String", # A plain text displayable name for this user. |
| 2311 | "emailAddress": "A String", # The email address of the user. |
| 2312 | "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. |
| 2313 | "kind": "drive#user", # This is always drive#user. |
| 2314 | "permissionId": "A String", # The user's ID as visible in the permissions collection. |
| 2315 | "picture": { # The user's profile picture. |
| 2316 | "url": "A String", # A URL that points to a profile picture of this user. |
| 2317 | }, |
| 2318 | }, |
| 2319 | "userPermission": { # A permission for a file. # The permissions for the authenticated user on this file. |
| 2320 | "additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future. |
| 2321 | "A String", |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 2322 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2323 | "authKey": "A String", # Deprecated. |
| 2324 | "deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions. |
| 2325 | "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. |
| 2326 | "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. |
| 2327 | "etag": "A String", # The ETag of the permission. |
| 2328 | "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 2329 | # - They cannot be set on shared drive items |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 2330 | # - They can only be set on user and group permissions |
| 2331 | # - The date must be in the future |
| 2332 | # - The date cannot be more than a year in the future |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2333 | # - The date can only be set on drive.permissions.update or drive.permissions.patch requests |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2334 | "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. |
| 2335 | "kind": "drive#permission", # This is always drive#permission. |
| 2336 | "name": "A String", # The name for this permission. |
| 2337 | "permissionDetails": [ # Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. |
| 2338 | { |
| 2339 | "additionalRoles": [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future. |
| 2340 | "A String", |
| 2341 | ], |
| 2342 | "inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field. |
| 2343 | "inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field. |
| 2344 | "permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible: |
| 2345 | # - file |
| 2346 | # - member |
| 2347 | "role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible: |
| 2348 | # - organizer |
| 2349 | # - fileOrganizer |
| 2350 | # - writer |
| 2351 | # - reader |
| 2352 | }, |
| 2353 | ], |
| 2354 | "photoLink": "A String", # A link to the profile photo, if available. |
| 2355 | "role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 2356 | # - owner |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2357 | # - organizer |
| 2358 | # - fileOrganizer |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 2359 | # - writer |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2360 | # - reader |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2361 | "selfLink": "A String", # A link back to this permission. |
| 2362 | "teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead. |
| 2363 | { |
| 2364 | "additionalRoles": [ # Deprecated - use permissionDetails/additionalRoles instead. |
| 2365 | "A String", |
| 2366 | ], |
| 2367 | "inherited": True or False, # Deprecated - use permissionDetails/inherited instead. |
| 2368 | "inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead. |
| 2369 | "role": "A String", # Deprecated - use permissionDetails/role instead. |
| 2370 | "teamDrivePermissionType": "A String", # Deprecated - use permissionDetails/permissionType instead. |
| 2371 | }, |
| 2372 | ], |
| 2373 | "type": "A String", # The account type. Allowed values are: |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 2374 | # - user |
| 2375 | # - group |
| 2376 | # - domain |
| 2377 | # - anyone |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2378 | "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. |
| 2379 | "withLink": True or False, # Whether the link is required for this permission. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 2380 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2381 | "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. |
| 2382 | "videoMediaMetadata": { # Metadata about video media. This will only be present for video types. |
| 2383 | "durationMillis": "A String", # The duration of the video in milliseconds. |
| 2384 | "height": 42, # The height of the video in pixels. |
| 2385 | "width": 42, # The width of the video in pixels. |
| 2386 | }, |
| 2387 | "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. |
| 2388 | "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. |
| 2389 | "writersCanShare": True or False, # Whether writers can share the document with other users. Not populated for items in shared drives. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 2390 | }, |
| 2391 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2392 | "kind": "drive#fileList", # This is always drive#fileList. |
| 2393 | "nextLink": "A String", # A link to the next page of files. |
| 2394 | "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. |
| 2395 | "selfLink": "A String", # A link back to this list. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 2396 | }</pre> |
| 2397 | </div> |
| 2398 | |
| 2399 | <div class="method"> |
| 2400 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 2401 | <pre>Retrieves the next page of results. |
| 2402 | |
| 2403 | Args: |
| 2404 | previous_request: The request for the previous page. (required) |
| 2405 | previous_response: The response from the request for the previous page. (required) |
| 2406 | |
| 2407 | Returns: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2408 | A request object that you can call 'execute()' on to request the next |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 2409 | page. Returns None if there are no more items in the collection. |
| 2410 | </pre> |
| 2411 | </div> |
| 2412 | |
| 2413 | <div class="method"> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2414 | <code class="details" id="patch">patch(fileId, body=None, addParents=None, convert=None, enforceSingleParent=None, modifiedDateBehavior=None, newRevision=None, ocr=None, ocrLanguage=None, pinned=None, removeParents=None, setModifiedDate=None, supportsAllDrives=None, supportsTeamDrives=None, timedTextLanguage=None, timedTextTrackName=None, updateViewedDate=None, useContentAsIndexableText=None)</code> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 2415 | <pre>Updates file metadata and/or content. This method supports patch semantics. |
| 2416 | |
| 2417 | Args: |
| 2418 | fileId: string, The ID of the file to update. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 2419 | body: object, The request body. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 2420 | The object takes the form of: |
| 2421 | |
| 2422 | { # The metadata for a file. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2423 | "alternateLink": "A String", # A link for opening the file in a relevant Google editor or viewer. |
| 2424 | "appDataContents": True or False, # Whether this file is in the Application Data folder. |
| 2425 | "canComment": True or False, # Deprecated: use capabilities/canComment. |
| 2426 | "canReadRevisions": True or False, # Deprecated: use capabilities/canReadRevisions. |
| 2427 | "capabilities": { # Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take. |
| 2428 | "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. |
| 2429 | "canAddMyDriveParent": True or False, # Whether the current user can add a parent for the item without removing an existing parent in the same request. Not populated for shared drive files. |
| 2430 | "canChangeCopyRequiresWriterPermission": True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this file. |
| 2431 | "canChangeRestrictedDownload": True or False, # Deprecated |
| 2432 | "canComment": True or False, # Whether the current user can comment on this file. |
| 2433 | "canCopy": True or False, # Whether the current user can copy this file. For an item in a shared drive, whether the current user can copy non-folder descendants of this item, or this item itself if it is not a folder. |
| 2434 | "canDelete": True or False, # Whether the current user can delete this file. |
| 2435 | "canDeleteChildren": True or False, # Whether the current user can delete children of this folder. This is false when the item is not a folder. Only populated for items in shared drives. |
| 2436 | "canDownload": True or False, # Whether the current user can download this file. |
| 2437 | "canEdit": True or False, # Whether the current user can edit this file. Other factors may limit the type of changes a user can make to a file. For example, see canChangeCopyRequiresWriterPermission or canModifyContent. |
| 2438 | "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. |
| 2439 | "canModifyContent": True or False, # Whether the current user can modify the content of this file. |
| 2440 | "canMoveChildrenOutOfDrive": True or False, # Whether the current user can move children of this folder outside of the shared drive. This is false when the item is not a folder. Only populated for items in shared drives. |
| 2441 | "canMoveChildrenOutOfTeamDrive": True or False, # Deprecated - use canMoveChildrenOutOfDrive instead. |
| 2442 | "canMoveChildrenWithinDrive": True or False, # Whether the current user can move children of this folder within the shared drive. This is false when the item is not a folder. Only populated for items in shared drives. |
| 2443 | "canMoveChildrenWithinTeamDrive": True or False, # Deprecated - use canMoveChildrenWithinDrive instead. |
| 2444 | "canMoveItemIntoTeamDrive": True or False, # Deprecated - use canMoveItemOutOfDrive instead. |
| 2445 | "canMoveItemOutOfDrive": True or False, # Whether the current user can move this item outside of this drive by changing its parent. Note that a request to change the parent of the item may still fail depending on the new parent that is being added. |
| 2446 | "canMoveItemOutOfTeamDrive": True or False, # Deprecated - use canMoveItemOutOfDrive instead. |
| 2447 | "canMoveItemWithinDrive": True or False, # Whether the current user can move this item within this shared drive. Note that a request to change the parent of the item may still fail depending on the new parent that is being added. Only populated for items in shared drives. |
| 2448 | "canMoveItemWithinTeamDrive": True or False, # Deprecated - use canMoveItemWithinDrive instead. |
| 2449 | "canMoveTeamDriveItem": True or False, # Deprecated - use canMoveItemWithinDrive or canMoveItemOutOfDrive instead. |
| 2450 | "canReadDrive": True or False, # Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives. |
| 2451 | "canReadRevisions": True or False, # Whether the current user can read the revisions resource of this file. For a shared drive item, whether revisions of non-folder descendants of this item, or this item itself if it is not a folder, can be read. |
| 2452 | "canReadTeamDrive": True or False, # Deprecated - use canReadDrive instead. |
| 2453 | "canRemoveChildren": True or False, # Whether the current user can remove children from this folder. This is always false when the item is not a folder. For a folder in a shared drive, use canDeleteChildren or canTrashChildren instead. |
| 2454 | "canRemoveMyDriveParent": True or False, # Whether the current user can remove a parent from the item without adding another parent in the same request. Not populated for shared drive files. |
| 2455 | "canRename": True or False, # Whether the current user can rename this file. |
| 2456 | "canShare": True or False, # Whether the current user can modify the sharing settings for this file. |
| 2457 | "canTrash": True or False, # Whether the current user can move this file to trash. |
| 2458 | "canTrashChildren": True or False, # Whether the current user can trash children of this folder. This is false when the item is not a folder. Only populated for items in shared drives. |
| 2459 | "canUntrash": True or False, # Whether the current user can restore this file from trash. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 2460 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2461 | "copyRequiresWriterPermission": True or False, # Whether the options to copy, print, or download this file, should be disabled for readers and commenters. |
| 2462 | "copyable": True or False, # Deprecated: use capabilities/canCopy. |
| 2463 | "createdDate": "A String", # Create time for this file (formatted RFC 3339 timestamp). |
| 2464 | "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. |
| 2465 | "description": "A String", # A short description of the file. |
| 2466 | "downloadUrl": "A String", # Short lived download URL for the file. This field is only populated for files with content stored in Google Drive; it is not populated for Google Docs or shortcut files. |
| 2467 | "driveId": "A String", # ID of the shared drive the file resides in. Only populated for items in shared drives. |
| 2468 | "editable": True or False, # Deprecated: use capabilities/canEdit. |
| 2469 | "embedLink": "A String", # A link for embedding the file. |
| 2470 | "etag": "A String", # ETag of the file. |
| 2471 | "explicitlyTrashed": True or False, # Whether this file has been explicitly trashed, as opposed to recursively trashed. |
| 2472 | "exportLinks": { # Links for exporting Google Docs to specific formats. |
| 2473 | "a_key": "A String", # A mapping from export format to URL |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 2474 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2475 | "fileExtension": "A String", # The final component of fullFileExtension with trailing text that does not appear to be part of the extension removed. This field is only populated for files with content stored in Google Drive; it is not populated for Google Docs or shortcut files. |
| 2476 | "fileSize": "A String", # The size of the file in bytes. This field is only populated for files with content stored in Google Drive; it is not populated for Google Docs or shortcut files. |
| 2477 | "folderColorRgb": "A String", # Folder color as an RGB hex string if the file is a folder. The list of supported colors is available in the folderColorPalette field of the About resource. If an unsupported color is specified, it will be changed to the closest color in the palette. Not populated for items in shared drives. |
| 2478 | "fullFileExtension": "A String", # The full file extension; extracted from the title. May contain multiple concatenated extensions, such as "tar.gz". Removing an extension from the title does not clear this field; however, changing the extension on the title does update this field. This field is only populated for files with content stored in Google Drive; it is not populated for Google Docs or shortcut files. |
| 2479 | "hasAugmentedPermissions": True or False, # Whether there are permissions directly on this file. This field is only populated for items in shared drives. |
| 2480 | "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. |
| 2481 | "headRevisionId": "A String", # The ID of the file's head revision. This field is only populated for files with content stored in Google Drive; it is not populated for Google Docs or shortcut files. |
| 2482 | "iconLink": "A String", # A link to the file's icon. |
| 2483 | "id": "A String", # The ID of the file. |
| 2484 | "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. |
| 2485 | "aperture": 3.14, # The aperture used to create the photo (f-number). |
| 2486 | "cameraMake": "A String", # The make of the camera used to create the photo. |
| 2487 | "cameraModel": "A String", # The model of the camera used to create the photo. |
| 2488 | "colorSpace": "A String", # The color space of the photo. |
| 2489 | "date": "A String", # The date and time the photo was taken (EXIF format timestamp). |
| 2490 | "exposureBias": 3.14, # The exposure bias of the photo (APEX value). |
| 2491 | "exposureMode": "A String", # The exposure mode used to create the photo. |
| 2492 | "exposureTime": 3.14, # The length of the exposure, in seconds. |
| 2493 | "flashUsed": True or False, # Whether a flash was used to create the photo. |
| 2494 | "focalLength": 3.14, # The focal length used to create the photo, in millimeters. |
| 2495 | "height": 42, # The height of the image in pixels. |
| 2496 | "isoSpeed": 42, # The ISO speed used to create the photo. |
| 2497 | "lens": "A String", # The lens used to create the photo. |
| 2498 | "location": { # Geographic location information stored in the image. |
| 2499 | "altitude": 3.14, # The altitude stored in the image. |
| 2500 | "latitude": 3.14, # The latitude stored in the image. |
| 2501 | "longitude": 3.14, # The longitude stored in the image. |
| 2502 | }, |
| 2503 | "maxApertureValue": 3.14, # The smallest f-number of the lens at the focal length used to create the photo (APEX value). |
| 2504 | "meteringMode": "A String", # The metering mode used to create the photo. |
| 2505 | "rotation": 42, # The number of clockwise 90 degree rotations applied from the image's original orientation. |
| 2506 | "sensor": "A String", # The type of sensor used to create the photo. |
| 2507 | "subjectDistance": 42, # The distance to the subject of the photo, in meters. |
| 2508 | "whiteBalance": "A String", # The white balance mode used to create the photo. |
| 2509 | "width": 42, # The width of the image in pixels. |
| 2510 | }, |
| 2511 | "indexableText": { # Indexable text attributes for the file (can only be written) |
| 2512 | "text": "A String", # The text to be indexed for this file. |
| 2513 | }, |
| 2514 | "isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app. |
| 2515 | "kind": "drive#file", # The type of file. This is always drive#file. |
| 2516 | "labels": { # A group of labels for the file. |
| 2517 | "hidden": True or False, # Deprecated. |
| 2518 | "modified": True or False, # Whether the file has been modified by this user. |
| 2519 | "restricted": True or False, # Deprecated - use copyRequiresWriterPermission instead. |
| 2520 | "starred": True or False, # Whether this file is starred by the user. |
| 2521 | "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. |
| 2522 | "viewed": True or False, # Whether this file has been viewed by this user. |
| 2523 | }, |
| 2524 | "lastModifyingUser": { # Information about a Drive user. # The last user to modify this file. |
| 2525 | "displayName": "A String", # A plain text displayable name for this user. |
| 2526 | "emailAddress": "A String", # The email address of the user. |
| 2527 | "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. |
| 2528 | "kind": "drive#user", # This is always drive#user. |
| 2529 | "permissionId": "A String", # The user's ID as visible in the permissions collection. |
| 2530 | "picture": { # The user's profile picture. |
| 2531 | "url": "A String", # A URL that points to a profile picture of this user. |
| 2532 | }, |
| 2533 | }, |
| 2534 | "lastModifyingUserName": "A String", # Name of the last user to modify this file. |
| 2535 | "lastViewedByMeDate": "A String", # Last time this file was viewed by the user (formatted RFC 3339 timestamp). |
| 2536 | "markedViewedByMeDate": "A String", # Deprecated. |
| 2537 | "md5Checksum": "A String", # An MD5 checksum for the content of this file. This field is only populated for files with content stored in Google Drive; it is not populated for Google Docs or shortcut files. |
| 2538 | "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. |
| 2539 | "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. |
| 2540 | "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. |
| 2541 | "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. |
| 2542 | "a_key": "A String", |
| 2543 | }, |
| 2544 | "originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the title field. This is only available for files with binary content in Google Drive. |
| 2545 | "ownedByMe": True or False, # Whether the file is owned by the current user. Not populated for items in shared drives. |
| 2546 | "ownerNames": [ # Name(s) of the owner(s) of this file. Not populated for items in shared drives. |
| 2547 | "A String", |
| 2548 | ], |
| 2549 | "owners": [ # The owner(s) of this file. Not populated for items in shared drives. |
| Sai Cheemalapati | df61397 | 2016-10-21 13:59:49 -0700 | [diff] [blame] | 2550 | { # Information about a Drive user. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2551 | "displayName": "A String", # A plain text displayable name for this user. |
| 2552 | "emailAddress": "A String", # The email address of the user. |
| 2553 | "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. |
| 2554 | "kind": "drive#user", # This is always drive#user. |
| 2555 | "permissionId": "A String", # The user's ID as visible in the permissions collection. |
| 2556 | "picture": { # The user's profile picture. |
| 2557 | "url": "A String", # A URL that points to a profile picture of this user. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 2558 | }, |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 2559 | }, |
| 2560 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2561 | "parents": [ # Collection of parent folders which contain this file. |
| 2562 | # If not specified as part of an insert request, the file will be placed directly in the user's My Drive folder. If not specified as part of a copy request, the file will inherit any discoverable parents of the source file. Update requests can also use the addParents and removeParents parameters to modify the parents list. |
| 2563 | { # A reference to a file's parent. |
| 2564 | "id": "A String", # The ID of the parent. |
| 2565 | "isRoot": True or False, # Whether or not the parent is the root folder. |
| 2566 | "kind": "drive#parentReference", # This is always drive#parentReference. |
| 2567 | "parentLink": "A String", # A link to the parent. |
| 2568 | "selfLink": "A String", # A link back to this reference. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 2569 | }, |
| 2570 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2571 | "permissionIds": [ # List of permission IDs for users with access to this file. |
| 2572 | "A String", |
| 2573 | ], |
| 2574 | "permissions": [ # The list of permissions for users with access to this file. Not populated for items in shared drives. |
| 2575 | { # A permission for a file. |
| 2576 | "additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future. |
| 2577 | "A String", |
| 2578 | ], |
| 2579 | "authKey": "A String", # Deprecated. |
| 2580 | "deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions. |
| 2581 | "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. |
| 2582 | "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. |
| 2583 | "etag": "A String", # The ETag of the permission. |
| 2584 | "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: |
| 2585 | # - They cannot be set on shared drive items |
| 2586 | # - They can only be set on user and group permissions |
| 2587 | # - The date must be in the future |
| 2588 | # - The date cannot be more than a year in the future |
| 2589 | # - The date can only be set on drive.permissions.update or drive.permissions.patch requests |
| 2590 | "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. |
| 2591 | "kind": "drive#permission", # This is always drive#permission. |
| 2592 | "name": "A String", # The name for this permission. |
| 2593 | "permissionDetails": [ # Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. |
| 2594 | { |
| 2595 | "additionalRoles": [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future. |
| 2596 | "A String", |
| 2597 | ], |
| 2598 | "inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field. |
| 2599 | "inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field. |
| 2600 | "permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible: |
| 2601 | # - file |
| 2602 | # - member |
| 2603 | "role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible: |
| 2604 | # - organizer |
| 2605 | # - fileOrganizer |
| 2606 | # - writer |
| 2607 | # - reader |
| 2608 | }, |
| 2609 | ], |
| 2610 | "photoLink": "A String", # A link to the profile photo, if available. |
| 2611 | "role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: |
| 2612 | # - owner |
| 2613 | # - organizer |
| 2614 | # - fileOrganizer |
| 2615 | # - writer |
| 2616 | # - reader |
| 2617 | "selfLink": "A String", # A link back to this permission. |
| 2618 | "teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead. |
| 2619 | { |
| 2620 | "additionalRoles": [ # Deprecated - use permissionDetails/additionalRoles instead. |
| 2621 | "A String", |
| 2622 | ], |
| 2623 | "inherited": True or False, # Deprecated - use permissionDetails/inherited instead. |
| 2624 | "inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead. |
| 2625 | "role": "A String", # Deprecated - use permissionDetails/role instead. |
| 2626 | "teamDrivePermissionType": "A String", # Deprecated - use permissionDetails/permissionType instead. |
| 2627 | }, |
| 2628 | ], |
| 2629 | "type": "A String", # The account type. Allowed values are: |
| 2630 | # - user |
| 2631 | # - group |
| 2632 | # - domain |
| 2633 | # - anyone |
| 2634 | "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. |
| 2635 | "withLink": True or False, # Whether the link is required for this permission. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 2636 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2637 | ], |
| 2638 | "properties": [ # The list of properties. |
| Nathaniel Manista | 4f877e5 | 2015-06-15 16:44:50 +0000 | [diff] [blame] | 2639 | { # A key-value pair attached to a file that is either public or private to an application. |
| 2640 | # The following limits apply to file properties: |
| 2641 | # - Maximum of 100 properties total per file |
| 2642 | # - Maximum of 30 private properties per app |
| 2643 | # - Maximum of 30 public properties |
| 2644 | # - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2645 | "etag": "A String", # ETag of the property. |
| 2646 | "key": "A String", # The key of this property. |
| 2647 | "kind": "drive#property", # This is always drive#property. |
| 2648 | "selfLink": "A String", # The link back to this property. |
| 2649 | "value": "A String", # The value of this property. |
| 2650 | "visibility": "A String", # The visibility of this property. Allowed values are PRIVATE and PUBLIC. (Default: PRIVATE) |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 2651 | }, |
| 2652 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2653 | "quotaBytesUsed": "A String", # The number of quota bytes used by this file. |
| 2654 | "selfLink": "A String", # A link back to this file. |
| 2655 | "shareable": True or False, # Deprecated: use capabilities/canShare. |
| 2656 | "shared": True or False, # Whether the file has been shared. Not populated for items in shared drives. |
| 2657 | "sharedWithMeDate": "A String", # Time at which this file was shared with the user (formatted RFC 3339 timestamp). |
| 2658 | "sharingUser": { # Information about a Drive user. # User that shared the item with the current user, if available. |
| 2659 | "displayName": "A String", # A plain text displayable name for this user. |
| 2660 | "emailAddress": "A String", # The email address of the user. |
| 2661 | "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. |
| 2662 | "kind": "drive#user", # This is always drive#user. |
| 2663 | "permissionId": "A String", # The user's ID as visible in the permissions collection. |
| 2664 | "picture": { # The user's profile picture. |
| 2665 | "url": "A String", # A URL that points to a profile picture of this user. |
| 2666 | }, |
| Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 2667 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2668 | "shortcutDetails": { # Shortcut file details. Only populated for shortcut files, which have the mimeType field set to application/vnd.google-apps.shortcut. |
| 2669 | "targetId": "A String", # The ID of the file that this shortcut points to. |
| 2670 | "targetMimeType": "A String", # The MIME type of the file that this shortcut points to. The value of this field is a snapshot of the target's MIME type, captured when the shortcut is created. |
| 2671 | }, |
| 2672 | "spaces": [ # The list of spaces which contain the file. Supported values are 'drive', 'appDataFolder' and 'photos'. |
| 2673 | "A String", |
| 2674 | ], |
| 2675 | "teamDriveId": "A String", # Deprecated - use driveId instead. |
| 2676 | "thumbnail": { # A thumbnail for the file. This will only be used if a standard thumbnail cannot be generated. |
| 2677 | "image": "A String", # The URL-safe Base64 encoded bytes of the thumbnail image. It should conform to RFC 4648 section 5. |
| 2678 | "mimeType": "A String", # The MIME type of the thumbnail. |
| 2679 | }, |
| 2680 | "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. |
| 2681 | "thumbnailVersion": "A String", # The thumbnail version for use in thumbnail cache invalidation. |
| 2682 | "title": "A String", # The title of this file. Note that for immutable items such as the top level folders of shared drives, My Drive root folder, and Application Data folder the title is constant. |
| 2683 | "trashedDate": "A String", # The time that the item was trashed (formatted RFC 3339 timestamp). Only populated for items in shared drives. |
| 2684 | "trashingUser": { # Information about a Drive user. # If the file has been explicitly trashed, the user who trashed it. Only populated for items in shared drives. |
| 2685 | "displayName": "A String", # A plain text displayable name for this user. |
| 2686 | "emailAddress": "A String", # The email address of the user. |
| 2687 | "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. |
| 2688 | "kind": "drive#user", # This is always drive#user. |
| 2689 | "permissionId": "A String", # The user's ID as visible in the permissions collection. |
| 2690 | "picture": { # The user's profile picture. |
| 2691 | "url": "A String", # A URL that points to a profile picture of this user. |
| 2692 | }, |
| 2693 | }, |
| 2694 | "userPermission": { # A permission for a file. # The permissions for the authenticated user on this file. |
| 2695 | "additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future. |
| 2696 | "A String", |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 2697 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2698 | "authKey": "A String", # Deprecated. |
| 2699 | "deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions. |
| 2700 | "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. |
| 2701 | "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. |
| 2702 | "etag": "A String", # The ETag of the permission. |
| 2703 | "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 2704 | # - They cannot be set on shared drive items |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 2705 | # - They can only be set on user and group permissions |
| 2706 | # - The date must be in the future |
| 2707 | # - The date cannot be more than a year in the future |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2708 | # - The date can only be set on drive.permissions.update or drive.permissions.patch requests |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2709 | "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. |
| 2710 | "kind": "drive#permission", # This is always drive#permission. |
| 2711 | "name": "A String", # The name for this permission. |
| 2712 | "permissionDetails": [ # Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. |
| 2713 | { |
| 2714 | "additionalRoles": [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future. |
| 2715 | "A String", |
| 2716 | ], |
| 2717 | "inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field. |
| 2718 | "inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field. |
| 2719 | "permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible: |
| 2720 | # - file |
| 2721 | # - member |
| 2722 | "role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible: |
| 2723 | # - organizer |
| 2724 | # - fileOrganizer |
| 2725 | # - writer |
| 2726 | # - reader |
| 2727 | }, |
| 2728 | ], |
| 2729 | "photoLink": "A String", # A link to the profile photo, if available. |
| 2730 | "role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 2731 | # - owner |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2732 | # - organizer |
| 2733 | # - fileOrganizer |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 2734 | # - writer |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2735 | # - reader |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2736 | "selfLink": "A String", # A link back to this permission. |
| 2737 | "teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead. |
| 2738 | { |
| 2739 | "additionalRoles": [ # Deprecated - use permissionDetails/additionalRoles instead. |
| 2740 | "A String", |
| 2741 | ], |
| 2742 | "inherited": True or False, # Deprecated - use permissionDetails/inherited instead. |
| 2743 | "inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead. |
| 2744 | "role": "A String", # Deprecated - use permissionDetails/role instead. |
| 2745 | "teamDrivePermissionType": "A String", # Deprecated - use permissionDetails/permissionType instead. |
| 2746 | }, |
| 2747 | ], |
| 2748 | "type": "A String", # The account type. Allowed values are: |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 2749 | # - user |
| 2750 | # - group |
| 2751 | # - domain |
| 2752 | # - anyone |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2753 | "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. |
| 2754 | "withLink": True or False, # Whether the link is required for this permission. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 2755 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2756 | "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. |
| 2757 | "videoMediaMetadata": { # Metadata about video media. This will only be present for video types. |
| 2758 | "durationMillis": "A String", # The duration of the video in milliseconds. |
| 2759 | "height": 42, # The height of the video in pixels. |
| 2760 | "width": 42, # The width of the video in pixels. |
| 2761 | }, |
| 2762 | "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. |
| 2763 | "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. |
| 2764 | "writersCanShare": True or False, # Whether writers can share the document with other users. Not populated for items in shared drives. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 2765 | } |
| 2766 | |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2767 | addParents: string, Comma-separated list of parent IDs to add. |
| 2768 | convert: boolean, This parameter is deprecated and has no function. |
| 2769 | enforceSingleParent: boolean, Set to true to opt in to API behavior that aims for all items to have exactly one parent. This parameter only takes effect if the item is not in a shared drive. If the item's owner makes a request to add a single parent, the item is removed from all current folders and placed in the requested folder. Other requests that increase the number of parents fail, except when the canAddMyDriveParent file capability is true and a single parent is being added. |
| Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 2770 | modifiedDateBehavior: string, Determines the behavior in which modifiedDate is updated. This overrides setModifiedDate. |
| 2771 | Allowed values |
| 2772 | fromBody - Set modifiedDate to the value provided in the body of the request. No change if no value was provided. |
| 2773 | fromBodyIfNeeded - Set modifiedDate to the value provided in the body of the request depending on other contents of the update. |
| 2774 | fromBodyOrNow - Set modifiedDate to the value provided in the body of the request, or to the current time if no value was provided. |
| 2775 | noChange - Maintain the previous value of modifiedDate. |
| 2776 | now - Set modifiedDate to the current time. |
| 2777 | nowIfNeeded - Set modifiedDate to the current time depending on contents of the update. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2778 | 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. |
| 2779 | ocr: boolean, Whether to attempt OCR on .jpg, .png, .gif, or .pdf uploads. |
| Nathaniel Manista | 4f877e5 | 2015-06-15 16:44:50 +0000 | [diff] [blame] | 2780 | ocrLanguage: string, If ocr is true, hints at the language to use. Valid values are BCP 47 codes. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 2781 | pinned: boolean, Whether to pin the new revision. A file can have a maximum of 200 pinned revisions. |
| Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 2782 | removeParents: string, Comma-separated list of parent IDs to remove. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2783 | setModifiedDate: boolean, Whether to set the modified date using the value supplied in the request body. Setting this field to true is equivalent to modifiedDateBehavior=fromBodyOrNow, and false is equivalent to modifiedDateBehavior=now. To prevent any changes to the modified date set modifiedDateBehavior=noChange. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2784 | supportsAllDrives: boolean, Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives. |
| 2785 | supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 2786 | timedTextLanguage: string, The language of the timed text. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2787 | timedTextTrackName: string, The timed text track name. |
| 2788 | updateViewedDate: boolean, Whether to update the view date after successfully updating the file. |
| 2789 | useContentAsIndexableText: boolean, Whether to use the content as indexable text. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 2790 | |
| 2791 | Returns: |
| 2792 | An object of the form: |
| 2793 | |
| 2794 | { # The metadata for a file. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2795 | "alternateLink": "A String", # A link for opening the file in a relevant Google editor or viewer. |
| 2796 | "appDataContents": True or False, # Whether this file is in the Application Data folder. |
| 2797 | "canComment": True or False, # Deprecated: use capabilities/canComment. |
| 2798 | "canReadRevisions": True or False, # Deprecated: use capabilities/canReadRevisions. |
| 2799 | "capabilities": { # Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take. |
| 2800 | "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. |
| 2801 | "canAddMyDriveParent": True or False, # Whether the current user can add a parent for the item without removing an existing parent in the same request. Not populated for shared drive files. |
| 2802 | "canChangeCopyRequiresWriterPermission": True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this file. |
| 2803 | "canChangeRestrictedDownload": True or False, # Deprecated |
| 2804 | "canComment": True or False, # Whether the current user can comment on this file. |
| 2805 | "canCopy": True or False, # Whether the current user can copy this file. For an item in a shared drive, whether the current user can copy non-folder descendants of this item, or this item itself if it is not a folder. |
| 2806 | "canDelete": True or False, # Whether the current user can delete this file. |
| 2807 | "canDeleteChildren": True or False, # Whether the current user can delete children of this folder. This is false when the item is not a folder. Only populated for items in shared drives. |
| 2808 | "canDownload": True or False, # Whether the current user can download this file. |
| 2809 | "canEdit": True or False, # Whether the current user can edit this file. Other factors may limit the type of changes a user can make to a file. For example, see canChangeCopyRequiresWriterPermission or canModifyContent. |
| 2810 | "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. |
| 2811 | "canModifyContent": True or False, # Whether the current user can modify the content of this file. |
| 2812 | "canMoveChildrenOutOfDrive": True or False, # Whether the current user can move children of this folder outside of the shared drive. This is false when the item is not a folder. Only populated for items in shared drives. |
| 2813 | "canMoveChildrenOutOfTeamDrive": True or False, # Deprecated - use canMoveChildrenOutOfDrive instead. |
| 2814 | "canMoveChildrenWithinDrive": True or False, # Whether the current user can move children of this folder within the shared drive. This is false when the item is not a folder. Only populated for items in shared drives. |
| 2815 | "canMoveChildrenWithinTeamDrive": True or False, # Deprecated - use canMoveChildrenWithinDrive instead. |
| 2816 | "canMoveItemIntoTeamDrive": True or False, # Deprecated - use canMoveItemOutOfDrive instead. |
| 2817 | "canMoveItemOutOfDrive": True or False, # Whether the current user can move this item outside of this drive by changing its parent. Note that a request to change the parent of the item may still fail depending on the new parent that is being added. |
| 2818 | "canMoveItemOutOfTeamDrive": True or False, # Deprecated - use canMoveItemOutOfDrive instead. |
| 2819 | "canMoveItemWithinDrive": True or False, # Whether the current user can move this item within this shared drive. Note that a request to change the parent of the item may still fail depending on the new parent that is being added. Only populated for items in shared drives. |
| 2820 | "canMoveItemWithinTeamDrive": True or False, # Deprecated - use canMoveItemWithinDrive instead. |
| 2821 | "canMoveTeamDriveItem": True or False, # Deprecated - use canMoveItemWithinDrive or canMoveItemOutOfDrive instead. |
| 2822 | "canReadDrive": True or False, # Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives. |
| 2823 | "canReadRevisions": True or False, # Whether the current user can read the revisions resource of this file. For a shared drive item, whether revisions of non-folder descendants of this item, or this item itself if it is not a folder, can be read. |
| 2824 | "canReadTeamDrive": True or False, # Deprecated - use canReadDrive instead. |
| 2825 | "canRemoveChildren": True or False, # Whether the current user can remove children from this folder. This is always false when the item is not a folder. For a folder in a shared drive, use canDeleteChildren or canTrashChildren instead. |
| 2826 | "canRemoveMyDriveParent": True or False, # Whether the current user can remove a parent from the item without adding another parent in the same request. Not populated for shared drive files. |
| 2827 | "canRename": True or False, # Whether the current user can rename this file. |
| 2828 | "canShare": True or False, # Whether the current user can modify the sharing settings for this file. |
| 2829 | "canTrash": True or False, # Whether the current user can move this file to trash. |
| 2830 | "canTrashChildren": True or False, # Whether the current user can trash children of this folder. This is false when the item is not a folder. Only populated for items in shared drives. |
| 2831 | "canUntrash": True or False, # Whether the current user can restore this file from trash. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 2832 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2833 | "copyRequiresWriterPermission": True or False, # Whether the options to copy, print, or download this file, should be disabled for readers and commenters. |
| 2834 | "copyable": True or False, # Deprecated: use capabilities/canCopy. |
| 2835 | "createdDate": "A String", # Create time for this file (formatted RFC 3339 timestamp). |
| 2836 | "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. |
| 2837 | "description": "A String", # A short description of the file. |
| 2838 | "downloadUrl": "A String", # Short lived download URL for the file. This field is only populated for files with content stored in Google Drive; it is not populated for Google Docs or shortcut files. |
| 2839 | "driveId": "A String", # ID of the shared drive the file resides in. Only populated for items in shared drives. |
| 2840 | "editable": True or False, # Deprecated: use capabilities/canEdit. |
| 2841 | "embedLink": "A String", # A link for embedding the file. |
| 2842 | "etag": "A String", # ETag of the file. |
| 2843 | "explicitlyTrashed": True or False, # Whether this file has been explicitly trashed, as opposed to recursively trashed. |
| 2844 | "exportLinks": { # Links for exporting Google Docs to specific formats. |
| 2845 | "a_key": "A String", # A mapping from export format to URL |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 2846 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2847 | "fileExtension": "A String", # The final component of fullFileExtension with trailing text that does not appear to be part of the extension removed. This field is only populated for files with content stored in Google Drive; it is not populated for Google Docs or shortcut files. |
| 2848 | "fileSize": "A String", # The size of the file in bytes. This field is only populated for files with content stored in Google Drive; it is not populated for Google Docs or shortcut files. |
| 2849 | "folderColorRgb": "A String", # Folder color as an RGB hex string if the file is a folder. The list of supported colors is available in the folderColorPalette field of the About resource. If an unsupported color is specified, it will be changed to the closest color in the palette. Not populated for items in shared drives. |
| 2850 | "fullFileExtension": "A String", # The full file extension; extracted from the title. May contain multiple concatenated extensions, such as "tar.gz". Removing an extension from the title does not clear this field; however, changing the extension on the title does update this field. This field is only populated for files with content stored in Google Drive; it is not populated for Google Docs or shortcut files. |
| 2851 | "hasAugmentedPermissions": True or False, # Whether there are permissions directly on this file. This field is only populated for items in shared drives. |
| 2852 | "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. |
| 2853 | "headRevisionId": "A String", # The ID of the file's head revision. This field is only populated for files with content stored in Google Drive; it is not populated for Google Docs or shortcut files. |
| 2854 | "iconLink": "A String", # A link to the file's icon. |
| 2855 | "id": "A String", # The ID of the file. |
| 2856 | "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. |
| 2857 | "aperture": 3.14, # The aperture used to create the photo (f-number). |
| 2858 | "cameraMake": "A String", # The make of the camera used to create the photo. |
| 2859 | "cameraModel": "A String", # The model of the camera used to create the photo. |
| 2860 | "colorSpace": "A String", # The color space of the photo. |
| 2861 | "date": "A String", # The date and time the photo was taken (EXIF format timestamp). |
| 2862 | "exposureBias": 3.14, # The exposure bias of the photo (APEX value). |
| 2863 | "exposureMode": "A String", # The exposure mode used to create the photo. |
| 2864 | "exposureTime": 3.14, # The length of the exposure, in seconds. |
| 2865 | "flashUsed": True or False, # Whether a flash was used to create the photo. |
| 2866 | "focalLength": 3.14, # The focal length used to create the photo, in millimeters. |
| 2867 | "height": 42, # The height of the image in pixels. |
| 2868 | "isoSpeed": 42, # The ISO speed used to create the photo. |
| 2869 | "lens": "A String", # The lens used to create the photo. |
| 2870 | "location": { # Geographic location information stored in the image. |
| 2871 | "altitude": 3.14, # The altitude stored in the image. |
| 2872 | "latitude": 3.14, # The latitude stored in the image. |
| 2873 | "longitude": 3.14, # The longitude stored in the image. |
| 2874 | }, |
| 2875 | "maxApertureValue": 3.14, # The smallest f-number of the lens at the focal length used to create the photo (APEX value). |
| 2876 | "meteringMode": "A String", # The metering mode used to create the photo. |
| 2877 | "rotation": 42, # The number of clockwise 90 degree rotations applied from the image's original orientation. |
| 2878 | "sensor": "A String", # The type of sensor used to create the photo. |
| 2879 | "subjectDistance": 42, # The distance to the subject of the photo, in meters. |
| 2880 | "whiteBalance": "A String", # The white balance mode used to create the photo. |
| 2881 | "width": 42, # The width of the image in pixels. |
| 2882 | }, |
| 2883 | "indexableText": { # Indexable text attributes for the file (can only be written) |
| 2884 | "text": "A String", # The text to be indexed for this file. |
| 2885 | }, |
| 2886 | "isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app. |
| 2887 | "kind": "drive#file", # The type of file. This is always drive#file. |
| 2888 | "labels": { # A group of labels for the file. |
| 2889 | "hidden": True or False, # Deprecated. |
| 2890 | "modified": True or False, # Whether the file has been modified by this user. |
| 2891 | "restricted": True or False, # Deprecated - use copyRequiresWriterPermission instead. |
| 2892 | "starred": True or False, # Whether this file is starred by the user. |
| 2893 | "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. |
| 2894 | "viewed": True or False, # Whether this file has been viewed by this user. |
| 2895 | }, |
| 2896 | "lastModifyingUser": { # Information about a Drive user. # The last user to modify this file. |
| 2897 | "displayName": "A String", # A plain text displayable name for this user. |
| 2898 | "emailAddress": "A String", # The email address of the user. |
| 2899 | "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. |
| 2900 | "kind": "drive#user", # This is always drive#user. |
| 2901 | "permissionId": "A String", # The user's ID as visible in the permissions collection. |
| 2902 | "picture": { # The user's profile picture. |
| 2903 | "url": "A String", # A URL that points to a profile picture of this user. |
| 2904 | }, |
| 2905 | }, |
| 2906 | "lastModifyingUserName": "A String", # Name of the last user to modify this file. |
| 2907 | "lastViewedByMeDate": "A String", # Last time this file was viewed by the user (formatted RFC 3339 timestamp). |
| 2908 | "markedViewedByMeDate": "A String", # Deprecated. |
| 2909 | "md5Checksum": "A String", # An MD5 checksum for the content of this file. This field is only populated for files with content stored in Google Drive; it is not populated for Google Docs or shortcut files. |
| 2910 | "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. |
| 2911 | "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. |
| 2912 | "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. |
| 2913 | "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. |
| 2914 | "a_key": "A String", |
| 2915 | }, |
| 2916 | "originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the title field. This is only available for files with binary content in Google Drive. |
| 2917 | "ownedByMe": True or False, # Whether the file is owned by the current user. Not populated for items in shared drives. |
| 2918 | "ownerNames": [ # Name(s) of the owner(s) of this file. Not populated for items in shared drives. |
| 2919 | "A String", |
| 2920 | ], |
| 2921 | "owners": [ # The owner(s) of this file. Not populated for items in shared drives. |
| Sai Cheemalapati | df61397 | 2016-10-21 13:59:49 -0700 | [diff] [blame] | 2922 | { # Information about a Drive user. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2923 | "displayName": "A String", # A plain text displayable name for this user. |
| 2924 | "emailAddress": "A String", # The email address of the user. |
| 2925 | "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. |
| 2926 | "kind": "drive#user", # This is always drive#user. |
| 2927 | "permissionId": "A String", # The user's ID as visible in the permissions collection. |
| 2928 | "picture": { # The user's profile picture. |
| 2929 | "url": "A String", # A URL that points to a profile picture of this user. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 2930 | }, |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 2931 | }, |
| 2932 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2933 | "parents": [ # Collection of parent folders which contain this file. |
| 2934 | # If not specified as part of an insert request, the file will be placed directly in the user's My Drive folder. If not specified as part of a copy request, the file will inherit any discoverable parents of the source file. Update requests can also use the addParents and removeParents parameters to modify the parents list. |
| 2935 | { # A reference to a file's parent. |
| 2936 | "id": "A String", # The ID of the parent. |
| 2937 | "isRoot": True or False, # Whether or not the parent is the root folder. |
| 2938 | "kind": "drive#parentReference", # This is always drive#parentReference. |
| 2939 | "parentLink": "A String", # A link to the parent. |
| 2940 | "selfLink": "A String", # A link back to this reference. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 2941 | }, |
| 2942 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2943 | "permissionIds": [ # List of permission IDs for users with access to this file. |
| 2944 | "A String", |
| 2945 | ], |
| 2946 | "permissions": [ # The list of permissions for users with access to this file. Not populated for items in shared drives. |
| 2947 | { # A permission for a file. |
| 2948 | "additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future. |
| 2949 | "A String", |
| 2950 | ], |
| 2951 | "authKey": "A String", # Deprecated. |
| 2952 | "deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions. |
| 2953 | "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. |
| 2954 | "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. |
| 2955 | "etag": "A String", # The ETag of the permission. |
| 2956 | "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: |
| 2957 | # - They cannot be set on shared drive items |
| 2958 | # - They can only be set on user and group permissions |
| 2959 | # - The date must be in the future |
| 2960 | # - The date cannot be more than a year in the future |
| 2961 | # - The date can only be set on drive.permissions.update or drive.permissions.patch requests |
| 2962 | "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. |
| 2963 | "kind": "drive#permission", # This is always drive#permission. |
| 2964 | "name": "A String", # The name for this permission. |
| 2965 | "permissionDetails": [ # Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. |
| 2966 | { |
| 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 | "inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field. |
| 2971 | "inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field. |
| 2972 | "permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible: |
| 2973 | # - file |
| 2974 | # - member |
| 2975 | "role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible: |
| 2976 | # - organizer |
| 2977 | # - fileOrganizer |
| 2978 | # - writer |
| 2979 | # - reader |
| 2980 | }, |
| 2981 | ], |
| 2982 | "photoLink": "A String", # A link to the profile photo, if available. |
| 2983 | "role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: |
| 2984 | # - owner |
| 2985 | # - organizer |
| 2986 | # - fileOrganizer |
| 2987 | # - writer |
| 2988 | # - reader |
| 2989 | "selfLink": "A String", # A link back to this permission. |
| 2990 | "teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead. |
| 2991 | { |
| 2992 | "additionalRoles": [ # Deprecated - use permissionDetails/additionalRoles instead. |
| 2993 | "A String", |
| 2994 | ], |
| 2995 | "inherited": True or False, # Deprecated - use permissionDetails/inherited instead. |
| 2996 | "inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead. |
| 2997 | "role": "A String", # Deprecated - use permissionDetails/role instead. |
| 2998 | "teamDrivePermissionType": "A String", # Deprecated - use permissionDetails/permissionType instead. |
| 2999 | }, |
| 3000 | ], |
| 3001 | "type": "A String", # The account type. Allowed values are: |
| 3002 | # - user |
| 3003 | # - group |
| 3004 | # - domain |
| 3005 | # - anyone |
| 3006 | "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. |
| 3007 | "withLink": True or False, # Whether the link is required for this permission. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 3008 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3009 | ], |
| 3010 | "properties": [ # The list of properties. |
| Nathaniel Manista | 4f877e5 | 2015-06-15 16:44:50 +0000 | [diff] [blame] | 3011 | { # A key-value pair attached to a file that is either public or private to an application. |
| 3012 | # The following limits apply to file properties: |
| 3013 | # - Maximum of 100 properties total per file |
| 3014 | # - Maximum of 30 private properties per app |
| 3015 | # - Maximum of 30 public properties |
| 3016 | # - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3017 | "etag": "A String", # ETag of the property. |
| 3018 | "key": "A String", # The key of this property. |
| 3019 | "kind": "drive#property", # This is always drive#property. |
| 3020 | "selfLink": "A String", # The link back to this property. |
| 3021 | "value": "A String", # The value of this property. |
| 3022 | "visibility": "A String", # The visibility of this property. Allowed values are PRIVATE and PUBLIC. (Default: PRIVATE) |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 3023 | }, |
| 3024 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3025 | "quotaBytesUsed": "A String", # The number of quota bytes used by this file. |
| 3026 | "selfLink": "A String", # A link back to this file. |
| 3027 | "shareable": True or False, # Deprecated: use capabilities/canShare. |
| 3028 | "shared": True or False, # Whether the file has been shared. Not populated for items in shared drives. |
| 3029 | "sharedWithMeDate": "A String", # Time at which this file was shared with the user (formatted RFC 3339 timestamp). |
| 3030 | "sharingUser": { # Information about a Drive user. # User that shared the item with the current user, if available. |
| 3031 | "displayName": "A String", # A plain text displayable name for this user. |
| 3032 | "emailAddress": "A String", # The email address of the user. |
| 3033 | "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. |
| 3034 | "kind": "drive#user", # This is always drive#user. |
| 3035 | "permissionId": "A String", # The user's ID as visible in the permissions collection. |
| 3036 | "picture": { # The user's profile picture. |
| 3037 | "url": "A String", # A URL that points to a profile picture of this user. |
| 3038 | }, |
| Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 3039 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3040 | "shortcutDetails": { # Shortcut file details. Only populated for shortcut files, which have the mimeType field set to application/vnd.google-apps.shortcut. |
| 3041 | "targetId": "A String", # The ID of the file that this shortcut points to. |
| 3042 | "targetMimeType": "A String", # The MIME type of the file that this shortcut points to. The value of this field is a snapshot of the target's MIME type, captured when the shortcut is created. |
| 3043 | }, |
| 3044 | "spaces": [ # The list of spaces which contain the file. Supported values are 'drive', 'appDataFolder' and 'photos'. |
| 3045 | "A String", |
| 3046 | ], |
| 3047 | "teamDriveId": "A String", # Deprecated - use driveId instead. |
| 3048 | "thumbnail": { # A thumbnail for the file. This will only be used if a standard thumbnail cannot be generated. |
| 3049 | "image": "A String", # The URL-safe Base64 encoded bytes of the thumbnail image. It should conform to RFC 4648 section 5. |
| 3050 | "mimeType": "A String", # The MIME type of the thumbnail. |
| 3051 | }, |
| 3052 | "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. |
| 3053 | "thumbnailVersion": "A String", # The thumbnail version for use in thumbnail cache invalidation. |
| 3054 | "title": "A String", # The title of this file. Note that for immutable items such as the top level folders of shared drives, My Drive root folder, and Application Data folder the title is constant. |
| 3055 | "trashedDate": "A String", # The time that the item was trashed (formatted RFC 3339 timestamp). Only populated for items in shared drives. |
| 3056 | "trashingUser": { # Information about a Drive user. # If the file has been explicitly trashed, the user who trashed it. Only populated for items in shared drives. |
| 3057 | "displayName": "A String", # A plain text displayable name for this user. |
| 3058 | "emailAddress": "A String", # The email address of the user. |
| 3059 | "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. |
| 3060 | "kind": "drive#user", # This is always drive#user. |
| 3061 | "permissionId": "A String", # The user's ID as visible in the permissions collection. |
| 3062 | "picture": { # The user's profile picture. |
| 3063 | "url": "A String", # A URL that points to a profile picture of this user. |
| 3064 | }, |
| 3065 | }, |
| 3066 | "userPermission": { # A permission for a file. # The permissions for the authenticated user on this file. |
| 3067 | "additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future. |
| 3068 | "A String", |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 3069 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3070 | "authKey": "A String", # Deprecated. |
| 3071 | "deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions. |
| 3072 | "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. |
| 3073 | "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. |
| 3074 | "etag": "A String", # The ETag of the permission. |
| 3075 | "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3076 | # - They cannot be set on shared drive items |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 3077 | # - They can only be set on user and group permissions |
| 3078 | # - The date must be in the future |
| 3079 | # - The date cannot be more than a year in the future |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3080 | # - The date can only be set on drive.permissions.update or drive.permissions.patch requests |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3081 | "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. |
| 3082 | "kind": "drive#permission", # This is always drive#permission. |
| 3083 | "name": "A String", # The name for this permission. |
| 3084 | "permissionDetails": [ # Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. |
| 3085 | { |
| 3086 | "additionalRoles": [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future. |
| 3087 | "A String", |
| 3088 | ], |
| 3089 | "inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field. |
| 3090 | "inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field. |
| 3091 | "permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible: |
| 3092 | # - file |
| 3093 | # - member |
| 3094 | "role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible: |
| 3095 | # - organizer |
| 3096 | # - fileOrganizer |
| 3097 | # - writer |
| 3098 | # - reader |
| 3099 | }, |
| 3100 | ], |
| 3101 | "photoLink": "A String", # A link to the profile photo, if available. |
| 3102 | "role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 3103 | # - owner |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3104 | # - organizer |
| 3105 | # - fileOrganizer |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 3106 | # - writer |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3107 | # - reader |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3108 | "selfLink": "A String", # A link back to this permission. |
| 3109 | "teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead. |
| 3110 | { |
| 3111 | "additionalRoles": [ # Deprecated - use permissionDetails/additionalRoles instead. |
| 3112 | "A String", |
| 3113 | ], |
| 3114 | "inherited": True or False, # Deprecated - use permissionDetails/inherited instead. |
| 3115 | "inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead. |
| 3116 | "role": "A String", # Deprecated - use permissionDetails/role instead. |
| 3117 | "teamDrivePermissionType": "A String", # Deprecated - use permissionDetails/permissionType instead. |
| 3118 | }, |
| 3119 | ], |
| 3120 | "type": "A String", # The account type. Allowed values are: |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 3121 | # - user |
| 3122 | # - group |
| 3123 | # - domain |
| 3124 | # - anyone |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3125 | "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. |
| 3126 | "withLink": True or False, # Whether the link is required for this permission. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 3127 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3128 | "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. |
| 3129 | "videoMediaMetadata": { # Metadata about video media. This will only be present for video types. |
| 3130 | "durationMillis": "A String", # The duration of the video in milliseconds. |
| 3131 | "height": 42, # The height of the video in pixels. |
| 3132 | "width": 42, # The width of the video in pixels. |
| 3133 | }, |
| 3134 | "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. |
| 3135 | "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. |
| 3136 | "writersCanShare": True or False, # Whether writers can share the document with other users. Not populated for items in shared drives. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 3137 | }</pre> |
| 3138 | </div> |
| 3139 | |
| 3140 | <div class="method"> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3141 | <code class="details" id="touch">touch(fileId, supportsAllDrives=None, supportsTeamDrives=None)</code> |
| 3142 | <pre>Set the file's updated time to the current server time. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 3143 | |
| 3144 | Args: |
| 3145 | fileId: string, The ID of the file to update. (required) |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3146 | supportsAllDrives: boolean, Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3147 | supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 3148 | |
| 3149 | Returns: |
| 3150 | An object of the form: |
| 3151 | |
| 3152 | { # The metadata for a file. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3153 | "alternateLink": "A String", # A link for opening the file in a relevant Google editor or viewer. |
| 3154 | "appDataContents": True or False, # Whether this file is in the Application Data folder. |
| 3155 | "canComment": True or False, # Deprecated: use capabilities/canComment. |
| 3156 | "canReadRevisions": True or False, # Deprecated: use capabilities/canReadRevisions. |
| 3157 | "capabilities": { # Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take. |
| 3158 | "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. |
| 3159 | "canAddMyDriveParent": True or False, # Whether the current user can add a parent for the item without removing an existing parent in the same request. Not populated for shared drive files. |
| 3160 | "canChangeCopyRequiresWriterPermission": True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this file. |
| 3161 | "canChangeRestrictedDownload": True or False, # Deprecated |
| 3162 | "canComment": True or False, # Whether the current user can comment on this file. |
| 3163 | "canCopy": True or False, # Whether the current user can copy this file. For an item in a shared drive, whether the current user can copy non-folder descendants of this item, or this item itself if it is not a folder. |
| 3164 | "canDelete": True or False, # Whether the current user can delete this file. |
| 3165 | "canDeleteChildren": True or False, # Whether the current user can delete children of this folder. This is false when the item is not a folder. Only populated for items in shared drives. |
| 3166 | "canDownload": True or False, # Whether the current user can download this file. |
| 3167 | "canEdit": True or False, # Whether the current user can edit this file. Other factors may limit the type of changes a user can make to a file. For example, see canChangeCopyRequiresWriterPermission or canModifyContent. |
| 3168 | "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. |
| 3169 | "canModifyContent": True or False, # Whether the current user can modify the content of this file. |
| 3170 | "canMoveChildrenOutOfDrive": True or False, # Whether the current user can move children of this folder outside of the shared drive. This is false when the item is not a folder. Only populated for items in shared drives. |
| 3171 | "canMoveChildrenOutOfTeamDrive": True or False, # Deprecated - use canMoveChildrenOutOfDrive instead. |
| 3172 | "canMoveChildrenWithinDrive": True or False, # Whether the current user can move children of this folder within the shared drive. This is false when the item is not a folder. Only populated for items in shared drives. |
| 3173 | "canMoveChildrenWithinTeamDrive": True or False, # Deprecated - use canMoveChildrenWithinDrive instead. |
| 3174 | "canMoveItemIntoTeamDrive": True or False, # Deprecated - use canMoveItemOutOfDrive instead. |
| 3175 | "canMoveItemOutOfDrive": True or False, # Whether the current user can move this item outside of this drive by changing its parent. Note that a request to change the parent of the item may still fail depending on the new parent that is being added. |
| 3176 | "canMoveItemOutOfTeamDrive": True or False, # Deprecated - use canMoveItemOutOfDrive instead. |
| 3177 | "canMoveItemWithinDrive": True or False, # Whether the current user can move this item within this shared drive. Note that a request to change the parent of the item may still fail depending on the new parent that is being added. Only populated for items in shared drives. |
| 3178 | "canMoveItemWithinTeamDrive": True or False, # Deprecated - use canMoveItemWithinDrive instead. |
| 3179 | "canMoveTeamDriveItem": True or False, # Deprecated - use canMoveItemWithinDrive or canMoveItemOutOfDrive instead. |
| 3180 | "canReadDrive": True or False, # Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives. |
| 3181 | "canReadRevisions": True or False, # Whether the current user can read the revisions resource of this file. For a shared drive item, whether revisions of non-folder descendants of this item, or this item itself if it is not a folder, can be read. |
| 3182 | "canReadTeamDrive": True or False, # Deprecated - use canReadDrive instead. |
| 3183 | "canRemoveChildren": True or False, # Whether the current user can remove children from this folder. This is always false when the item is not a folder. For a folder in a shared drive, use canDeleteChildren or canTrashChildren instead. |
| 3184 | "canRemoveMyDriveParent": True or False, # Whether the current user can remove a parent from the item without adding another parent in the same request. Not populated for shared drive files. |
| 3185 | "canRename": True or False, # Whether the current user can rename this file. |
| 3186 | "canShare": True or False, # Whether the current user can modify the sharing settings for this file. |
| 3187 | "canTrash": True or False, # Whether the current user can move this file to trash. |
| 3188 | "canTrashChildren": True or False, # Whether the current user can trash children of this folder. This is false when the item is not a folder. Only populated for items in shared drives. |
| 3189 | "canUntrash": True or False, # Whether the current user can restore this file from trash. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 3190 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3191 | "copyRequiresWriterPermission": True or False, # Whether the options to copy, print, or download this file, should be disabled for readers and commenters. |
| 3192 | "copyable": True or False, # Deprecated: use capabilities/canCopy. |
| 3193 | "createdDate": "A String", # Create time for this file (formatted RFC 3339 timestamp). |
| 3194 | "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. |
| 3195 | "description": "A String", # A short description of the file. |
| 3196 | "downloadUrl": "A String", # Short lived download URL for the file. This field is only populated for files with content stored in Google Drive; it is not populated for Google Docs or shortcut files. |
| 3197 | "driveId": "A String", # ID of the shared drive the file resides in. Only populated for items in shared drives. |
| 3198 | "editable": True or False, # Deprecated: use capabilities/canEdit. |
| 3199 | "embedLink": "A String", # A link for embedding the file. |
| 3200 | "etag": "A String", # ETag of the file. |
| 3201 | "explicitlyTrashed": True or False, # Whether this file has been explicitly trashed, as opposed to recursively trashed. |
| 3202 | "exportLinks": { # Links for exporting Google Docs to specific formats. |
| 3203 | "a_key": "A String", # A mapping from export format to URL |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 3204 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3205 | "fileExtension": "A String", # The final component of fullFileExtension with trailing text that does not appear to be part of the extension removed. This field is only populated for files with content stored in Google Drive; it is not populated for Google Docs or shortcut files. |
| 3206 | "fileSize": "A String", # The size of the file in bytes. This field is only populated for files with content stored in Google Drive; it is not populated for Google Docs or shortcut files. |
| 3207 | "folderColorRgb": "A String", # Folder color as an RGB hex string if the file is a folder. The list of supported colors is available in the folderColorPalette field of the About resource. If an unsupported color is specified, it will be changed to the closest color in the palette. Not populated for items in shared drives. |
| 3208 | "fullFileExtension": "A String", # The full file extension; extracted from the title. May contain multiple concatenated extensions, such as "tar.gz". Removing an extension from the title does not clear this field; however, changing the extension on the title does update this field. This field is only populated for files with content stored in Google Drive; it is not populated for Google Docs or shortcut files. |
| 3209 | "hasAugmentedPermissions": True or False, # Whether there are permissions directly on this file. This field is only populated for items in shared drives. |
| 3210 | "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. |
| 3211 | "headRevisionId": "A String", # The ID of the file's head revision. This field is only populated for files with content stored in Google Drive; it is not populated for Google Docs or shortcut files. |
| 3212 | "iconLink": "A String", # A link to the file's icon. |
| 3213 | "id": "A String", # The ID of the file. |
| 3214 | "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. |
| 3215 | "aperture": 3.14, # The aperture used to create the photo (f-number). |
| 3216 | "cameraMake": "A String", # The make of the camera used to create the photo. |
| 3217 | "cameraModel": "A String", # The model of the camera used to create the photo. |
| 3218 | "colorSpace": "A String", # The color space of the photo. |
| 3219 | "date": "A String", # The date and time the photo was taken (EXIF format timestamp). |
| 3220 | "exposureBias": 3.14, # The exposure bias of the photo (APEX value). |
| 3221 | "exposureMode": "A String", # The exposure mode used to create the photo. |
| 3222 | "exposureTime": 3.14, # The length of the exposure, in seconds. |
| 3223 | "flashUsed": True or False, # Whether a flash was used to create the photo. |
| 3224 | "focalLength": 3.14, # The focal length used to create the photo, in millimeters. |
| 3225 | "height": 42, # The height of the image in pixels. |
| 3226 | "isoSpeed": 42, # The ISO speed used to create the photo. |
| 3227 | "lens": "A String", # The lens used to create the photo. |
| 3228 | "location": { # Geographic location information stored in the image. |
| 3229 | "altitude": 3.14, # The altitude stored in the image. |
| 3230 | "latitude": 3.14, # The latitude stored in the image. |
| 3231 | "longitude": 3.14, # The longitude stored in the image. |
| 3232 | }, |
| 3233 | "maxApertureValue": 3.14, # The smallest f-number of the lens at the focal length used to create the photo (APEX value). |
| 3234 | "meteringMode": "A String", # The metering mode used to create the photo. |
| 3235 | "rotation": 42, # The number of clockwise 90 degree rotations applied from the image's original orientation. |
| 3236 | "sensor": "A String", # The type of sensor used to create the photo. |
| 3237 | "subjectDistance": 42, # The distance to the subject of the photo, in meters. |
| 3238 | "whiteBalance": "A String", # The white balance mode used to create the photo. |
| 3239 | "width": 42, # The width of the image in pixels. |
| 3240 | }, |
| 3241 | "indexableText": { # Indexable text attributes for the file (can only be written) |
| 3242 | "text": "A String", # The text to be indexed for this file. |
| 3243 | }, |
| 3244 | "isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app. |
| 3245 | "kind": "drive#file", # The type of file. This is always drive#file. |
| 3246 | "labels": { # A group of labels for the file. |
| 3247 | "hidden": True or False, # Deprecated. |
| 3248 | "modified": True or False, # Whether the file has been modified by this user. |
| 3249 | "restricted": True or False, # Deprecated - use copyRequiresWriterPermission instead. |
| 3250 | "starred": True or False, # Whether this file is starred by the user. |
| 3251 | "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. |
| 3252 | "viewed": True or False, # Whether this file has been viewed by this user. |
| 3253 | }, |
| 3254 | "lastModifyingUser": { # Information about a Drive user. # The last user to modify this file. |
| 3255 | "displayName": "A String", # A plain text displayable name for this user. |
| 3256 | "emailAddress": "A String", # The email address of the user. |
| 3257 | "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. |
| 3258 | "kind": "drive#user", # This is always drive#user. |
| 3259 | "permissionId": "A String", # The user's ID as visible in the permissions collection. |
| 3260 | "picture": { # The user's profile picture. |
| 3261 | "url": "A String", # A URL that points to a profile picture of this user. |
| 3262 | }, |
| 3263 | }, |
| 3264 | "lastModifyingUserName": "A String", # Name of the last user to modify this file. |
| 3265 | "lastViewedByMeDate": "A String", # Last time this file was viewed by the user (formatted RFC 3339 timestamp). |
| 3266 | "markedViewedByMeDate": "A String", # Deprecated. |
| 3267 | "md5Checksum": "A String", # An MD5 checksum for the content of this file. This field is only populated for files with content stored in Google Drive; it is not populated for Google Docs or shortcut files. |
| 3268 | "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. |
| 3269 | "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. |
| 3270 | "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. |
| 3271 | "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. |
| 3272 | "a_key": "A String", |
| 3273 | }, |
| 3274 | "originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the title field. This is only available for files with binary content in Google Drive. |
| 3275 | "ownedByMe": True or False, # Whether the file is owned by the current user. Not populated for items in shared drives. |
| 3276 | "ownerNames": [ # Name(s) of the owner(s) of this file. Not populated for items in shared drives. |
| 3277 | "A String", |
| 3278 | ], |
| 3279 | "owners": [ # The owner(s) of this file. Not populated for items in shared drives. |
| Sai Cheemalapati | df61397 | 2016-10-21 13:59:49 -0700 | [diff] [blame] | 3280 | { # Information about a Drive user. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3281 | "displayName": "A String", # A plain text displayable name for this user. |
| 3282 | "emailAddress": "A String", # The email address of the user. |
| 3283 | "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. |
| 3284 | "kind": "drive#user", # This is always drive#user. |
| 3285 | "permissionId": "A String", # The user's ID as visible in the permissions collection. |
| 3286 | "picture": { # The user's profile picture. |
| 3287 | "url": "A String", # A URL that points to a profile picture of this user. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 3288 | }, |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 3289 | }, |
| 3290 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3291 | "parents": [ # Collection of parent folders which contain this file. |
| 3292 | # If not specified as part of an insert request, the file will be placed directly in the user's My Drive folder. If not specified as part of a copy request, the file will inherit any discoverable parents of the source file. Update requests can also use the addParents and removeParents parameters to modify the parents list. |
| 3293 | { # A reference to a file's parent. |
| 3294 | "id": "A String", # The ID of the parent. |
| 3295 | "isRoot": True or False, # Whether or not the parent is the root folder. |
| 3296 | "kind": "drive#parentReference", # This is always drive#parentReference. |
| 3297 | "parentLink": "A String", # A link to the parent. |
| 3298 | "selfLink": "A String", # A link back to this reference. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 3299 | }, |
| 3300 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3301 | "permissionIds": [ # List of permission IDs for users with access to this file. |
| 3302 | "A String", |
| 3303 | ], |
| 3304 | "permissions": [ # The list of permissions for users with access to this file. Not populated for items in shared drives. |
| 3305 | { # A permission for a file. |
| 3306 | "additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future. |
| 3307 | "A String", |
| 3308 | ], |
| 3309 | "authKey": "A String", # Deprecated. |
| 3310 | "deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions. |
| 3311 | "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. |
| 3312 | "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. |
| 3313 | "etag": "A String", # The ETag of the permission. |
| 3314 | "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: |
| 3315 | # - They cannot be set on shared drive items |
| 3316 | # - They can only be set on user and group permissions |
| 3317 | # - The date must be in the future |
| 3318 | # - The date cannot be more than a year in the future |
| 3319 | # - The date can only be set on drive.permissions.update or drive.permissions.patch requests |
| 3320 | "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. |
| 3321 | "kind": "drive#permission", # This is always drive#permission. |
| 3322 | "name": "A String", # The name for this permission. |
| 3323 | "permissionDetails": [ # Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. |
| 3324 | { |
| 3325 | "additionalRoles": [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future. |
| 3326 | "A String", |
| 3327 | ], |
| 3328 | "inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field. |
| 3329 | "inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field. |
| 3330 | "permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible: |
| 3331 | # - file |
| 3332 | # - member |
| 3333 | "role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible: |
| 3334 | # - organizer |
| 3335 | # - fileOrganizer |
| 3336 | # - writer |
| 3337 | # - reader |
| 3338 | }, |
| 3339 | ], |
| 3340 | "photoLink": "A String", # A link to the profile photo, if available. |
| 3341 | "role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: |
| 3342 | # - owner |
| 3343 | # - organizer |
| 3344 | # - fileOrganizer |
| 3345 | # - writer |
| 3346 | # - reader |
| 3347 | "selfLink": "A String", # A link back to this permission. |
| 3348 | "teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead. |
| 3349 | { |
| 3350 | "additionalRoles": [ # Deprecated - use permissionDetails/additionalRoles instead. |
| 3351 | "A String", |
| 3352 | ], |
| 3353 | "inherited": True or False, # Deprecated - use permissionDetails/inherited instead. |
| 3354 | "inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead. |
| 3355 | "role": "A String", # Deprecated - use permissionDetails/role instead. |
| 3356 | "teamDrivePermissionType": "A String", # Deprecated - use permissionDetails/permissionType instead. |
| 3357 | }, |
| 3358 | ], |
| 3359 | "type": "A String", # The account type. Allowed values are: |
| 3360 | # - user |
| 3361 | # - group |
| 3362 | # - domain |
| 3363 | # - anyone |
| 3364 | "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. |
| 3365 | "withLink": True or False, # Whether the link is required for this permission. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 3366 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3367 | ], |
| 3368 | "properties": [ # The list of properties. |
| Nathaniel Manista | 4f877e5 | 2015-06-15 16:44:50 +0000 | [diff] [blame] | 3369 | { # A key-value pair attached to a file that is either public or private to an application. |
| 3370 | # The following limits apply to file properties: |
| 3371 | # - Maximum of 100 properties total per file |
| 3372 | # - Maximum of 30 private properties per app |
| 3373 | # - Maximum of 30 public properties |
| 3374 | # - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3375 | "etag": "A String", # ETag of the property. |
| 3376 | "key": "A String", # The key of this property. |
| 3377 | "kind": "drive#property", # This is always drive#property. |
| 3378 | "selfLink": "A String", # The link back to this property. |
| 3379 | "value": "A String", # The value of this property. |
| 3380 | "visibility": "A String", # The visibility of this property. Allowed values are PRIVATE and PUBLIC. (Default: PRIVATE) |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 3381 | }, |
| 3382 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3383 | "quotaBytesUsed": "A String", # The number of quota bytes used by this file. |
| 3384 | "selfLink": "A String", # A link back to this file. |
| 3385 | "shareable": True or False, # Deprecated: use capabilities/canShare. |
| 3386 | "shared": True or False, # Whether the file has been shared. Not populated for items in shared drives. |
| 3387 | "sharedWithMeDate": "A String", # Time at which this file was shared with the user (formatted RFC 3339 timestamp). |
| 3388 | "sharingUser": { # Information about a Drive user. # User that shared the item with the current user, if available. |
| 3389 | "displayName": "A String", # A plain text displayable name for this user. |
| 3390 | "emailAddress": "A String", # The email address of the user. |
| 3391 | "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. |
| 3392 | "kind": "drive#user", # This is always drive#user. |
| 3393 | "permissionId": "A String", # The user's ID as visible in the permissions collection. |
| 3394 | "picture": { # The user's profile picture. |
| 3395 | "url": "A String", # A URL that points to a profile picture of this user. |
| 3396 | }, |
| Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 3397 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3398 | "shortcutDetails": { # Shortcut file details. Only populated for shortcut files, which have the mimeType field set to application/vnd.google-apps.shortcut. |
| 3399 | "targetId": "A String", # The ID of the file that this shortcut points to. |
| 3400 | "targetMimeType": "A String", # The MIME type of the file that this shortcut points to. The value of this field is a snapshot of the target's MIME type, captured when the shortcut is created. |
| 3401 | }, |
| 3402 | "spaces": [ # The list of spaces which contain the file. Supported values are 'drive', 'appDataFolder' and 'photos'. |
| 3403 | "A String", |
| 3404 | ], |
| 3405 | "teamDriveId": "A String", # Deprecated - use driveId instead. |
| 3406 | "thumbnail": { # A thumbnail for the file. This will only be used if a standard thumbnail cannot be generated. |
| 3407 | "image": "A String", # The URL-safe Base64 encoded bytes of the thumbnail image. It should conform to RFC 4648 section 5. |
| 3408 | "mimeType": "A String", # The MIME type of the thumbnail. |
| 3409 | }, |
| 3410 | "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. |
| 3411 | "thumbnailVersion": "A String", # The thumbnail version for use in thumbnail cache invalidation. |
| 3412 | "title": "A String", # The title of this file. Note that for immutable items such as the top level folders of shared drives, My Drive root folder, and Application Data folder the title is constant. |
| 3413 | "trashedDate": "A String", # The time that the item was trashed (formatted RFC 3339 timestamp). Only populated for items in shared drives. |
| 3414 | "trashingUser": { # Information about a Drive user. # If the file has been explicitly trashed, the user who trashed it. Only populated for items in shared drives. |
| 3415 | "displayName": "A String", # A plain text displayable name for this user. |
| 3416 | "emailAddress": "A String", # The email address of the user. |
| 3417 | "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. |
| 3418 | "kind": "drive#user", # This is always drive#user. |
| 3419 | "permissionId": "A String", # The user's ID as visible in the permissions collection. |
| 3420 | "picture": { # The user's profile picture. |
| 3421 | "url": "A String", # A URL that points to a profile picture of this user. |
| 3422 | }, |
| 3423 | }, |
| 3424 | "userPermission": { # A permission for a file. # The permissions for the authenticated user on this file. |
| 3425 | "additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future. |
| 3426 | "A String", |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 3427 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3428 | "authKey": "A String", # Deprecated. |
| 3429 | "deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions. |
| 3430 | "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. |
| 3431 | "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. |
| 3432 | "etag": "A String", # The ETag of the permission. |
| 3433 | "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3434 | # - They cannot be set on shared drive items |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 3435 | # - They can only be set on user and group permissions |
| 3436 | # - The date must be in the future |
| 3437 | # - The date cannot be more than a year in the future |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3438 | # - The date can only be set on drive.permissions.update or drive.permissions.patch requests |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3439 | "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. |
| 3440 | "kind": "drive#permission", # This is always drive#permission. |
| 3441 | "name": "A String", # The name for this permission. |
| 3442 | "permissionDetails": [ # Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. |
| 3443 | { |
| 3444 | "additionalRoles": [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future. |
| 3445 | "A String", |
| 3446 | ], |
| 3447 | "inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field. |
| 3448 | "inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field. |
| 3449 | "permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible: |
| 3450 | # - file |
| 3451 | # - member |
| 3452 | "role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible: |
| 3453 | # - organizer |
| 3454 | # - fileOrganizer |
| 3455 | # - writer |
| 3456 | # - reader |
| 3457 | }, |
| 3458 | ], |
| 3459 | "photoLink": "A String", # A link to the profile photo, if available. |
| 3460 | "role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 3461 | # - owner |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3462 | # - organizer |
| 3463 | # - fileOrganizer |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 3464 | # - writer |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3465 | # - reader |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3466 | "selfLink": "A String", # A link back to this permission. |
| 3467 | "teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead. |
| 3468 | { |
| 3469 | "additionalRoles": [ # Deprecated - use permissionDetails/additionalRoles instead. |
| 3470 | "A String", |
| 3471 | ], |
| 3472 | "inherited": True or False, # Deprecated - use permissionDetails/inherited instead. |
| 3473 | "inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead. |
| 3474 | "role": "A String", # Deprecated - use permissionDetails/role instead. |
| 3475 | "teamDrivePermissionType": "A String", # Deprecated - use permissionDetails/permissionType instead. |
| 3476 | }, |
| 3477 | ], |
| 3478 | "type": "A String", # The account type. Allowed values are: |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 3479 | # - user |
| 3480 | # - group |
| 3481 | # - domain |
| 3482 | # - anyone |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3483 | "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. |
| 3484 | "withLink": True or False, # Whether the link is required for this permission. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 3485 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3486 | "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. |
| 3487 | "videoMediaMetadata": { # Metadata about video media. This will only be present for video types. |
| 3488 | "durationMillis": "A String", # The duration of the video in milliseconds. |
| 3489 | "height": 42, # The height of the video in pixels. |
| 3490 | "width": 42, # The width of the video in pixels. |
| 3491 | }, |
| 3492 | "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. |
| 3493 | "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. |
| 3494 | "writersCanShare": True or False, # Whether writers can share the document with other users. Not populated for items in shared drives. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 3495 | }</pre> |
| 3496 | </div> |
| 3497 | |
| 3498 | <div class="method"> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3499 | <code class="details" id="trash">trash(fileId, supportsAllDrives=None, supportsTeamDrives=None)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3500 | <pre>Moves a file to the trash. The currently authenticated user must own the file or be at least a fileOrganizer on the parent for shared drive files. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 3501 | |
| 3502 | Args: |
| 3503 | fileId: string, The ID of the file to trash. (required) |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3504 | supportsAllDrives: boolean, Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3505 | supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 3506 | |
| 3507 | Returns: |
| 3508 | An object of the form: |
| 3509 | |
| 3510 | { # The metadata for a file. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3511 | "alternateLink": "A String", # A link for opening the file in a relevant Google editor or viewer. |
| 3512 | "appDataContents": True or False, # Whether this file is in the Application Data folder. |
| 3513 | "canComment": True or False, # Deprecated: use capabilities/canComment. |
| 3514 | "canReadRevisions": True or False, # Deprecated: use capabilities/canReadRevisions. |
| 3515 | "capabilities": { # Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take. |
| 3516 | "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. |
| 3517 | "canAddMyDriveParent": True or False, # Whether the current user can add a parent for the item without removing an existing parent in the same request. Not populated for shared drive files. |
| 3518 | "canChangeCopyRequiresWriterPermission": True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this file. |
| 3519 | "canChangeRestrictedDownload": True or False, # Deprecated |
| 3520 | "canComment": True or False, # Whether the current user can comment on this file. |
| 3521 | "canCopy": True or False, # Whether the current user can copy this file. For an item in a shared drive, whether the current user can copy non-folder descendants of this item, or this item itself if it is not a folder. |
| 3522 | "canDelete": True or False, # Whether the current user can delete this file. |
| 3523 | "canDeleteChildren": True or False, # Whether the current user can delete children of this folder. This is false when the item is not a folder. Only populated for items in shared drives. |
| 3524 | "canDownload": True or False, # Whether the current user can download this file. |
| 3525 | "canEdit": True or False, # Whether the current user can edit this file. Other factors may limit the type of changes a user can make to a file. For example, see canChangeCopyRequiresWriterPermission or canModifyContent. |
| 3526 | "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. |
| 3527 | "canModifyContent": True or False, # Whether the current user can modify the content of this file. |
| 3528 | "canMoveChildrenOutOfDrive": True or False, # Whether the current user can move children of this folder outside of the shared drive. This is false when the item is not a folder. Only populated for items in shared drives. |
| 3529 | "canMoveChildrenOutOfTeamDrive": True or False, # Deprecated - use canMoveChildrenOutOfDrive instead. |
| 3530 | "canMoveChildrenWithinDrive": True or False, # Whether the current user can move children of this folder within the shared drive. This is false when the item is not a folder. Only populated for items in shared drives. |
| 3531 | "canMoveChildrenWithinTeamDrive": True or False, # Deprecated - use canMoveChildrenWithinDrive instead. |
| 3532 | "canMoveItemIntoTeamDrive": True or False, # Deprecated - use canMoveItemOutOfDrive instead. |
| 3533 | "canMoveItemOutOfDrive": True or False, # Whether the current user can move this item outside of this drive by changing its parent. Note that a request to change the parent of the item may still fail depending on the new parent that is being added. |
| 3534 | "canMoveItemOutOfTeamDrive": True or False, # Deprecated - use canMoveItemOutOfDrive instead. |
| 3535 | "canMoveItemWithinDrive": True or False, # Whether the current user can move this item within this shared drive. Note that a request to change the parent of the item may still fail depending on the new parent that is being added. Only populated for items in shared drives. |
| 3536 | "canMoveItemWithinTeamDrive": True or False, # Deprecated - use canMoveItemWithinDrive instead. |
| 3537 | "canMoveTeamDriveItem": True or False, # Deprecated - use canMoveItemWithinDrive or canMoveItemOutOfDrive instead. |
| 3538 | "canReadDrive": True or False, # Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives. |
| 3539 | "canReadRevisions": True or False, # Whether the current user can read the revisions resource of this file. For a shared drive item, whether revisions of non-folder descendants of this item, or this item itself if it is not a folder, can be read. |
| 3540 | "canReadTeamDrive": True or False, # Deprecated - use canReadDrive instead. |
| 3541 | "canRemoveChildren": True or False, # Whether the current user can remove children from this folder. This is always false when the item is not a folder. For a folder in a shared drive, use canDeleteChildren or canTrashChildren instead. |
| 3542 | "canRemoveMyDriveParent": True or False, # Whether the current user can remove a parent from the item without adding another parent in the same request. Not populated for shared drive files. |
| 3543 | "canRename": True or False, # Whether the current user can rename this file. |
| 3544 | "canShare": True or False, # Whether the current user can modify the sharing settings for this file. |
| 3545 | "canTrash": True or False, # Whether the current user can move this file to trash. |
| 3546 | "canTrashChildren": True or False, # Whether the current user can trash children of this folder. This is false when the item is not a folder. Only populated for items in shared drives. |
| 3547 | "canUntrash": True or False, # Whether the current user can restore this file from trash. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 3548 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3549 | "copyRequiresWriterPermission": True or False, # Whether the options to copy, print, or download this file, should be disabled for readers and commenters. |
| 3550 | "copyable": True or False, # Deprecated: use capabilities/canCopy. |
| 3551 | "createdDate": "A String", # Create time for this file (formatted RFC 3339 timestamp). |
| 3552 | "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. |
| 3553 | "description": "A String", # A short description of the file. |
| 3554 | "downloadUrl": "A String", # Short lived download URL for the file. This field is only populated for files with content stored in Google Drive; it is not populated for Google Docs or shortcut files. |
| 3555 | "driveId": "A String", # ID of the shared drive the file resides in. Only populated for items in shared drives. |
| 3556 | "editable": True or False, # Deprecated: use capabilities/canEdit. |
| 3557 | "embedLink": "A String", # A link for embedding the file. |
| 3558 | "etag": "A String", # ETag of the file. |
| 3559 | "explicitlyTrashed": True or False, # Whether this file has been explicitly trashed, as opposed to recursively trashed. |
| 3560 | "exportLinks": { # Links for exporting Google Docs to specific formats. |
| 3561 | "a_key": "A String", # A mapping from export format to URL |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 3562 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3563 | "fileExtension": "A String", # The final component of fullFileExtension with trailing text that does not appear to be part of the extension removed. This field is only populated for files with content stored in Google Drive; it is not populated for Google Docs or shortcut files. |
| 3564 | "fileSize": "A String", # The size of the file in bytes. This field is only populated for files with content stored in Google Drive; it is not populated for Google Docs or shortcut files. |
| 3565 | "folderColorRgb": "A String", # Folder color as an RGB hex string if the file is a folder. The list of supported colors is available in the folderColorPalette field of the About resource. If an unsupported color is specified, it will be changed to the closest color in the palette. Not populated for items in shared drives. |
| 3566 | "fullFileExtension": "A String", # The full file extension; extracted from the title. May contain multiple concatenated extensions, such as "tar.gz". Removing an extension from the title does not clear this field; however, changing the extension on the title does update this field. This field is only populated for files with content stored in Google Drive; it is not populated for Google Docs or shortcut files. |
| 3567 | "hasAugmentedPermissions": True or False, # Whether there are permissions directly on this file. This field is only populated for items in shared drives. |
| 3568 | "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. |
| 3569 | "headRevisionId": "A String", # The ID of the file's head revision. This field is only populated for files with content stored in Google Drive; it is not populated for Google Docs or shortcut files. |
| 3570 | "iconLink": "A String", # A link to the file's icon. |
| 3571 | "id": "A String", # The ID of the file. |
| 3572 | "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. |
| 3573 | "aperture": 3.14, # The aperture used to create the photo (f-number). |
| 3574 | "cameraMake": "A String", # The make of the camera used to create the photo. |
| 3575 | "cameraModel": "A String", # The model of the camera used to create the photo. |
| 3576 | "colorSpace": "A String", # The color space of the photo. |
| 3577 | "date": "A String", # The date and time the photo was taken (EXIF format timestamp). |
| 3578 | "exposureBias": 3.14, # The exposure bias of the photo (APEX value). |
| 3579 | "exposureMode": "A String", # The exposure mode used to create the photo. |
| 3580 | "exposureTime": 3.14, # The length of the exposure, in seconds. |
| 3581 | "flashUsed": True or False, # Whether a flash was used to create the photo. |
| 3582 | "focalLength": 3.14, # The focal length used to create the photo, in millimeters. |
| 3583 | "height": 42, # The height of the image in pixels. |
| 3584 | "isoSpeed": 42, # The ISO speed used to create the photo. |
| 3585 | "lens": "A String", # The lens used to create the photo. |
| 3586 | "location": { # Geographic location information stored in the image. |
| 3587 | "altitude": 3.14, # The altitude stored in the image. |
| 3588 | "latitude": 3.14, # The latitude stored in the image. |
| 3589 | "longitude": 3.14, # The longitude stored in the image. |
| 3590 | }, |
| 3591 | "maxApertureValue": 3.14, # The smallest f-number of the lens at the focal length used to create the photo (APEX value). |
| 3592 | "meteringMode": "A String", # The metering mode used to create the photo. |
| 3593 | "rotation": 42, # The number of clockwise 90 degree rotations applied from the image's original orientation. |
| 3594 | "sensor": "A String", # The type of sensor used to create the photo. |
| 3595 | "subjectDistance": 42, # The distance to the subject of the photo, in meters. |
| 3596 | "whiteBalance": "A String", # The white balance mode used to create the photo. |
| 3597 | "width": 42, # The width of the image in pixels. |
| 3598 | }, |
| 3599 | "indexableText": { # Indexable text attributes for the file (can only be written) |
| 3600 | "text": "A String", # The text to be indexed for this file. |
| 3601 | }, |
| 3602 | "isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app. |
| 3603 | "kind": "drive#file", # The type of file. This is always drive#file. |
| 3604 | "labels": { # A group of labels for the file. |
| 3605 | "hidden": True or False, # Deprecated. |
| 3606 | "modified": True or False, # Whether the file has been modified by this user. |
| 3607 | "restricted": True or False, # Deprecated - use copyRequiresWriterPermission instead. |
| 3608 | "starred": True or False, # Whether this file is starred by the user. |
| 3609 | "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. |
| 3610 | "viewed": True or False, # Whether this file has been viewed by this user. |
| 3611 | }, |
| 3612 | "lastModifyingUser": { # Information about a Drive user. # The last user to modify this file. |
| 3613 | "displayName": "A String", # A plain text displayable name for this user. |
| 3614 | "emailAddress": "A String", # The email address of the user. |
| 3615 | "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. |
| 3616 | "kind": "drive#user", # This is always drive#user. |
| 3617 | "permissionId": "A String", # The user's ID as visible in the permissions collection. |
| 3618 | "picture": { # The user's profile picture. |
| 3619 | "url": "A String", # A URL that points to a profile picture of this user. |
| 3620 | }, |
| 3621 | }, |
| 3622 | "lastModifyingUserName": "A String", # Name of the last user to modify this file. |
| 3623 | "lastViewedByMeDate": "A String", # Last time this file was viewed by the user (formatted RFC 3339 timestamp). |
| 3624 | "markedViewedByMeDate": "A String", # Deprecated. |
| 3625 | "md5Checksum": "A String", # An MD5 checksum for the content of this file. This field is only populated for files with content stored in Google Drive; it is not populated for Google Docs or shortcut files. |
| 3626 | "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. |
| 3627 | "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. |
| 3628 | "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. |
| 3629 | "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. |
| 3630 | "a_key": "A String", |
| 3631 | }, |
| 3632 | "originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the title field. This is only available for files with binary content in Google Drive. |
| 3633 | "ownedByMe": True or False, # Whether the file is owned by the current user. Not populated for items in shared drives. |
| 3634 | "ownerNames": [ # Name(s) of the owner(s) of this file. Not populated for items in shared drives. |
| 3635 | "A String", |
| 3636 | ], |
| 3637 | "owners": [ # The owner(s) of this file. Not populated for items in shared drives. |
| Sai Cheemalapati | df61397 | 2016-10-21 13:59:49 -0700 | [diff] [blame] | 3638 | { # Information about a Drive user. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3639 | "displayName": "A String", # A plain text displayable name for this user. |
| 3640 | "emailAddress": "A String", # The email address of the user. |
| 3641 | "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. |
| 3642 | "kind": "drive#user", # This is always drive#user. |
| 3643 | "permissionId": "A String", # The user's ID as visible in the permissions collection. |
| 3644 | "picture": { # The user's profile picture. |
| 3645 | "url": "A String", # A URL that points to a profile picture of this user. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 3646 | }, |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 3647 | }, |
| 3648 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3649 | "parents": [ # Collection of parent folders which contain this file. |
| 3650 | # If not specified as part of an insert request, the file will be placed directly in the user's My Drive folder. If not specified as part of a copy request, the file will inherit any discoverable parents of the source file. Update requests can also use the addParents and removeParents parameters to modify the parents list. |
| 3651 | { # A reference to a file's parent. |
| 3652 | "id": "A String", # The ID of the parent. |
| 3653 | "isRoot": True or False, # Whether or not the parent is the root folder. |
| 3654 | "kind": "drive#parentReference", # This is always drive#parentReference. |
| 3655 | "parentLink": "A String", # A link to the parent. |
| 3656 | "selfLink": "A String", # A link back to this reference. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 3657 | }, |
| 3658 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3659 | "permissionIds": [ # List of permission IDs for users with access to this file. |
| 3660 | "A String", |
| 3661 | ], |
| 3662 | "permissions": [ # The list of permissions for users with access to this file. Not populated for items in shared drives. |
| 3663 | { # A permission for a file. |
| 3664 | "additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future. |
| 3665 | "A String", |
| 3666 | ], |
| 3667 | "authKey": "A String", # Deprecated. |
| 3668 | "deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions. |
| 3669 | "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. |
| 3670 | "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. |
| 3671 | "etag": "A String", # The ETag of the permission. |
| 3672 | "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: |
| 3673 | # - They cannot be set on shared drive items |
| 3674 | # - They can only be set on user and group permissions |
| 3675 | # - The date must be in the future |
| 3676 | # - The date cannot be more than a year in the future |
| 3677 | # - The date can only be set on drive.permissions.update or drive.permissions.patch requests |
| 3678 | "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. |
| 3679 | "kind": "drive#permission", # This is always drive#permission. |
| 3680 | "name": "A String", # The name for this permission. |
| 3681 | "permissionDetails": [ # Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. |
| 3682 | { |
| 3683 | "additionalRoles": [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future. |
| 3684 | "A String", |
| 3685 | ], |
| 3686 | "inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field. |
| 3687 | "inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field. |
| 3688 | "permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible: |
| 3689 | # - file |
| 3690 | # - member |
| 3691 | "role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible: |
| 3692 | # - organizer |
| 3693 | # - fileOrganizer |
| 3694 | # - writer |
| 3695 | # - reader |
| 3696 | }, |
| 3697 | ], |
| 3698 | "photoLink": "A String", # A link to the profile photo, if available. |
| 3699 | "role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: |
| 3700 | # - owner |
| 3701 | # - organizer |
| 3702 | # - fileOrganizer |
| 3703 | # - writer |
| 3704 | # - reader |
| 3705 | "selfLink": "A String", # A link back to this permission. |
| 3706 | "teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead. |
| 3707 | { |
| 3708 | "additionalRoles": [ # Deprecated - use permissionDetails/additionalRoles instead. |
| 3709 | "A String", |
| 3710 | ], |
| 3711 | "inherited": True or False, # Deprecated - use permissionDetails/inherited instead. |
| 3712 | "inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead. |
| 3713 | "role": "A String", # Deprecated - use permissionDetails/role instead. |
| 3714 | "teamDrivePermissionType": "A String", # Deprecated - use permissionDetails/permissionType instead. |
| 3715 | }, |
| 3716 | ], |
| 3717 | "type": "A String", # The account type. Allowed values are: |
| 3718 | # - user |
| 3719 | # - group |
| 3720 | # - domain |
| 3721 | # - anyone |
| 3722 | "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. |
| 3723 | "withLink": True or False, # Whether the link is required for this permission. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 3724 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3725 | ], |
| 3726 | "properties": [ # The list of properties. |
| Nathaniel Manista | 4f877e5 | 2015-06-15 16:44:50 +0000 | [diff] [blame] | 3727 | { # A key-value pair attached to a file that is either public or private to an application. |
| 3728 | # The following limits apply to file properties: |
| 3729 | # - Maximum of 100 properties total per file |
| 3730 | # - Maximum of 30 private properties per app |
| 3731 | # - Maximum of 30 public properties |
| 3732 | # - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3733 | "etag": "A String", # ETag of the property. |
| 3734 | "key": "A String", # The key of this property. |
| 3735 | "kind": "drive#property", # This is always drive#property. |
| 3736 | "selfLink": "A String", # The link back to this property. |
| 3737 | "value": "A String", # The value of this property. |
| 3738 | "visibility": "A String", # The visibility of this property. Allowed values are PRIVATE and PUBLIC. (Default: PRIVATE) |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 3739 | }, |
| 3740 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3741 | "quotaBytesUsed": "A String", # The number of quota bytes used by this file. |
| 3742 | "selfLink": "A String", # A link back to this file. |
| 3743 | "shareable": True or False, # Deprecated: use capabilities/canShare. |
| 3744 | "shared": True or False, # Whether the file has been shared. Not populated for items in shared drives. |
| 3745 | "sharedWithMeDate": "A String", # Time at which this file was shared with the user (formatted RFC 3339 timestamp). |
| 3746 | "sharingUser": { # Information about a Drive user. # User that shared the item with the current user, if available. |
| 3747 | "displayName": "A String", # A plain text displayable name for this user. |
| 3748 | "emailAddress": "A String", # The email address of the user. |
| 3749 | "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. |
| 3750 | "kind": "drive#user", # This is always drive#user. |
| 3751 | "permissionId": "A String", # The user's ID as visible in the permissions collection. |
| 3752 | "picture": { # The user's profile picture. |
| 3753 | "url": "A String", # A URL that points to a profile picture of this user. |
| 3754 | }, |
| Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 3755 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3756 | "shortcutDetails": { # Shortcut file details. Only populated for shortcut files, which have the mimeType field set to application/vnd.google-apps.shortcut. |
| 3757 | "targetId": "A String", # The ID of the file that this shortcut points to. |
| 3758 | "targetMimeType": "A String", # The MIME type of the file that this shortcut points to. The value of this field is a snapshot of the target's MIME type, captured when the shortcut is created. |
| 3759 | }, |
| 3760 | "spaces": [ # The list of spaces which contain the file. Supported values are 'drive', 'appDataFolder' and 'photos'. |
| 3761 | "A String", |
| 3762 | ], |
| 3763 | "teamDriveId": "A String", # Deprecated - use driveId instead. |
| 3764 | "thumbnail": { # A thumbnail for the file. This will only be used if a standard thumbnail cannot be generated. |
| 3765 | "image": "A String", # The URL-safe Base64 encoded bytes of the thumbnail image. It should conform to RFC 4648 section 5. |
| 3766 | "mimeType": "A String", # The MIME type of the thumbnail. |
| 3767 | }, |
| 3768 | "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. |
| 3769 | "thumbnailVersion": "A String", # The thumbnail version for use in thumbnail cache invalidation. |
| 3770 | "title": "A String", # The title of this file. Note that for immutable items such as the top level folders of shared drives, My Drive root folder, and Application Data folder the title is constant. |
| 3771 | "trashedDate": "A String", # The time that the item was trashed (formatted RFC 3339 timestamp). Only populated for items in shared drives. |
| 3772 | "trashingUser": { # Information about a Drive user. # If the file has been explicitly trashed, the user who trashed it. Only populated for items in shared drives. |
| 3773 | "displayName": "A String", # A plain text displayable name for this user. |
| 3774 | "emailAddress": "A String", # The email address of the user. |
| 3775 | "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. |
| 3776 | "kind": "drive#user", # This is always drive#user. |
| 3777 | "permissionId": "A String", # The user's ID as visible in the permissions collection. |
| 3778 | "picture": { # The user's profile picture. |
| 3779 | "url": "A String", # A URL that points to a profile picture of this user. |
| 3780 | }, |
| 3781 | }, |
| 3782 | "userPermission": { # A permission for a file. # The permissions for the authenticated user on this file. |
| 3783 | "additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future. |
| 3784 | "A String", |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 3785 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3786 | "authKey": "A String", # Deprecated. |
| 3787 | "deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions. |
| 3788 | "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. |
| 3789 | "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. |
| 3790 | "etag": "A String", # The ETag of the permission. |
| 3791 | "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3792 | # - They cannot be set on shared drive items |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 3793 | # - They can only be set on user and group permissions |
| 3794 | # - The date must be in the future |
| 3795 | # - The date cannot be more than a year in the future |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3796 | # - The date can only be set on drive.permissions.update or drive.permissions.patch requests |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3797 | "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. |
| 3798 | "kind": "drive#permission", # This is always drive#permission. |
| 3799 | "name": "A String", # The name for this permission. |
| 3800 | "permissionDetails": [ # Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. |
| 3801 | { |
| 3802 | "additionalRoles": [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future. |
| 3803 | "A String", |
| 3804 | ], |
| 3805 | "inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field. |
| 3806 | "inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field. |
| 3807 | "permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible: |
| 3808 | # - file |
| 3809 | # - member |
| 3810 | "role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible: |
| 3811 | # - organizer |
| 3812 | # - fileOrganizer |
| 3813 | # - writer |
| 3814 | # - reader |
| 3815 | }, |
| 3816 | ], |
| 3817 | "photoLink": "A String", # A link to the profile photo, if available. |
| 3818 | "role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 3819 | # - owner |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3820 | # - organizer |
| 3821 | # - fileOrganizer |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 3822 | # - writer |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3823 | # - reader |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3824 | "selfLink": "A String", # A link back to this permission. |
| 3825 | "teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead. |
| 3826 | { |
| 3827 | "additionalRoles": [ # Deprecated - use permissionDetails/additionalRoles instead. |
| 3828 | "A String", |
| 3829 | ], |
| 3830 | "inherited": True or False, # Deprecated - use permissionDetails/inherited instead. |
| 3831 | "inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead. |
| 3832 | "role": "A String", # Deprecated - use permissionDetails/role instead. |
| 3833 | "teamDrivePermissionType": "A String", # Deprecated - use permissionDetails/permissionType instead. |
| 3834 | }, |
| 3835 | ], |
| 3836 | "type": "A String", # The account type. Allowed values are: |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 3837 | # - user |
| 3838 | # - group |
| 3839 | # - domain |
| 3840 | # - anyone |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3841 | "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. |
| 3842 | "withLink": True or False, # Whether the link is required for this permission. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 3843 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3844 | "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. |
| 3845 | "videoMediaMetadata": { # Metadata about video media. This will only be present for video types. |
| 3846 | "durationMillis": "A String", # The duration of the video in milliseconds. |
| 3847 | "height": 42, # The height of the video in pixels. |
| 3848 | "width": 42, # The width of the video in pixels. |
| 3849 | }, |
| 3850 | "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. |
| 3851 | "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. |
| 3852 | "writersCanShare": True or False, # Whether writers can share the document with other users. Not populated for items in shared drives. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 3853 | }</pre> |
| 3854 | </div> |
| 3855 | |
| 3856 | <div class="method"> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3857 | <code class="details" id="untrash">untrash(fileId, supportsAllDrives=None, supportsTeamDrives=None)</code> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 3858 | <pre>Restores a file from the trash. |
| 3859 | |
| 3860 | Args: |
| 3861 | fileId: string, The ID of the file to untrash. (required) |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3862 | supportsAllDrives: boolean, Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3863 | supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 3864 | |
| 3865 | Returns: |
| 3866 | An object of the form: |
| 3867 | |
| 3868 | { # The metadata for a file. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3869 | "alternateLink": "A String", # A link for opening the file in a relevant Google editor or viewer. |
| 3870 | "appDataContents": True or False, # Whether this file is in the Application Data folder. |
| 3871 | "canComment": True or False, # Deprecated: use capabilities/canComment. |
| 3872 | "canReadRevisions": True or False, # Deprecated: use capabilities/canReadRevisions. |
| 3873 | "capabilities": { # Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take. |
| 3874 | "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. |
| 3875 | "canAddMyDriveParent": True or False, # Whether the current user can add a parent for the item without removing an existing parent in the same request. Not populated for shared drive files. |
| 3876 | "canChangeCopyRequiresWriterPermission": True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this file. |
| 3877 | "canChangeRestrictedDownload": True or False, # Deprecated |
| 3878 | "canComment": True or False, # Whether the current user can comment on this file. |
| 3879 | "canCopy": True or False, # Whether the current user can copy this file. For an item in a shared drive, whether the current user can copy non-folder descendants of this item, or this item itself if it is not a folder. |
| 3880 | "canDelete": True or False, # Whether the current user can delete this file. |
| 3881 | "canDeleteChildren": True or False, # Whether the current user can delete children of this folder. This is false when the item is not a folder. Only populated for items in shared drives. |
| 3882 | "canDownload": True or False, # Whether the current user can download this file. |
| 3883 | "canEdit": True or False, # Whether the current user can edit this file. Other factors may limit the type of changes a user can make to a file. For example, see canChangeCopyRequiresWriterPermission or canModifyContent. |
| 3884 | "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. |
| 3885 | "canModifyContent": True or False, # Whether the current user can modify the content of this file. |
| 3886 | "canMoveChildrenOutOfDrive": True or False, # Whether the current user can move children of this folder outside of the shared drive. This is false when the item is not a folder. Only populated for items in shared drives. |
| 3887 | "canMoveChildrenOutOfTeamDrive": True or False, # Deprecated - use canMoveChildrenOutOfDrive instead. |
| 3888 | "canMoveChildrenWithinDrive": True or False, # Whether the current user can move children of this folder within the shared drive. This is false when the item is not a folder. Only populated for items in shared drives. |
| 3889 | "canMoveChildrenWithinTeamDrive": True or False, # Deprecated - use canMoveChildrenWithinDrive instead. |
| 3890 | "canMoveItemIntoTeamDrive": True or False, # Deprecated - use canMoveItemOutOfDrive instead. |
| 3891 | "canMoveItemOutOfDrive": True or False, # Whether the current user can move this item outside of this drive by changing its parent. Note that a request to change the parent of the item may still fail depending on the new parent that is being added. |
| 3892 | "canMoveItemOutOfTeamDrive": True or False, # Deprecated - use canMoveItemOutOfDrive instead. |
| 3893 | "canMoveItemWithinDrive": True or False, # Whether the current user can move this item within this shared drive. Note that a request to change the parent of the item may still fail depending on the new parent that is being added. Only populated for items in shared drives. |
| 3894 | "canMoveItemWithinTeamDrive": True or False, # Deprecated - use canMoveItemWithinDrive instead. |
| 3895 | "canMoveTeamDriveItem": True or False, # Deprecated - use canMoveItemWithinDrive or canMoveItemOutOfDrive instead. |
| 3896 | "canReadDrive": True or False, # Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives. |
| 3897 | "canReadRevisions": True or False, # Whether the current user can read the revisions resource of this file. For a shared drive item, whether revisions of non-folder descendants of this item, or this item itself if it is not a folder, can be read. |
| 3898 | "canReadTeamDrive": True or False, # Deprecated - use canReadDrive instead. |
| 3899 | "canRemoveChildren": True or False, # Whether the current user can remove children from this folder. This is always false when the item is not a folder. For a folder in a shared drive, use canDeleteChildren or canTrashChildren instead. |
| 3900 | "canRemoveMyDriveParent": True or False, # Whether the current user can remove a parent from the item without adding another parent in the same request. Not populated for shared drive files. |
| 3901 | "canRename": True or False, # Whether the current user can rename this file. |
| 3902 | "canShare": True or False, # Whether the current user can modify the sharing settings for this file. |
| 3903 | "canTrash": True or False, # Whether the current user can move this file to trash. |
| 3904 | "canTrashChildren": True or False, # Whether the current user can trash children of this folder. This is false when the item is not a folder. Only populated for items in shared drives. |
| 3905 | "canUntrash": True or False, # Whether the current user can restore this file from trash. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 3906 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3907 | "copyRequiresWriterPermission": True or False, # Whether the options to copy, print, or download this file, should be disabled for readers and commenters. |
| 3908 | "copyable": True or False, # Deprecated: use capabilities/canCopy. |
| 3909 | "createdDate": "A String", # Create time for this file (formatted RFC 3339 timestamp). |
| 3910 | "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. |
| 3911 | "description": "A String", # A short description of the file. |
| 3912 | "downloadUrl": "A String", # Short lived download URL for the file. This field is only populated for files with content stored in Google Drive; it is not populated for Google Docs or shortcut files. |
| 3913 | "driveId": "A String", # ID of the shared drive the file resides in. Only populated for items in shared drives. |
| 3914 | "editable": True or False, # Deprecated: use capabilities/canEdit. |
| 3915 | "embedLink": "A String", # A link for embedding the file. |
| 3916 | "etag": "A String", # ETag of the file. |
| 3917 | "explicitlyTrashed": True or False, # Whether this file has been explicitly trashed, as opposed to recursively trashed. |
| 3918 | "exportLinks": { # Links for exporting Google Docs to specific formats. |
| 3919 | "a_key": "A String", # A mapping from export format to URL |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 3920 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3921 | "fileExtension": "A String", # The final component of fullFileExtension with trailing text that does not appear to be part of the extension removed. This field is only populated for files with content stored in Google Drive; it is not populated for Google Docs or shortcut files. |
| 3922 | "fileSize": "A String", # The size of the file in bytes. This field is only populated for files with content stored in Google Drive; it is not populated for Google Docs or shortcut files. |
| 3923 | "folderColorRgb": "A String", # Folder color as an RGB hex string if the file is a folder. The list of supported colors is available in the folderColorPalette field of the About resource. If an unsupported color is specified, it will be changed to the closest color in the palette. Not populated for items in shared drives. |
| 3924 | "fullFileExtension": "A String", # The full file extension; extracted from the title. May contain multiple concatenated extensions, such as "tar.gz". Removing an extension from the title does not clear this field; however, changing the extension on the title does update this field. This field is only populated for files with content stored in Google Drive; it is not populated for Google Docs or shortcut files. |
| 3925 | "hasAugmentedPermissions": True or False, # Whether there are permissions directly on this file. This field is only populated for items in shared drives. |
| 3926 | "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. |
| 3927 | "headRevisionId": "A String", # The ID of the file's head revision. This field is only populated for files with content stored in Google Drive; it is not populated for Google Docs or shortcut files. |
| 3928 | "iconLink": "A String", # A link to the file's icon. |
| 3929 | "id": "A String", # The ID of the file. |
| 3930 | "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. |
| 3931 | "aperture": 3.14, # The aperture used to create the photo (f-number). |
| 3932 | "cameraMake": "A String", # The make of the camera used to create the photo. |
| 3933 | "cameraModel": "A String", # The model of the camera used to create the photo. |
| 3934 | "colorSpace": "A String", # The color space of the photo. |
| 3935 | "date": "A String", # The date and time the photo was taken (EXIF format timestamp). |
| 3936 | "exposureBias": 3.14, # The exposure bias of the photo (APEX value). |
| 3937 | "exposureMode": "A String", # The exposure mode used to create the photo. |
| 3938 | "exposureTime": 3.14, # The length of the exposure, in seconds. |
| 3939 | "flashUsed": True or False, # Whether a flash was used to create the photo. |
| 3940 | "focalLength": 3.14, # The focal length used to create the photo, in millimeters. |
| 3941 | "height": 42, # The height of the image in pixels. |
| 3942 | "isoSpeed": 42, # The ISO speed used to create the photo. |
| 3943 | "lens": "A String", # The lens used to create the photo. |
| 3944 | "location": { # Geographic location information stored in the image. |
| 3945 | "altitude": 3.14, # The altitude stored in the image. |
| 3946 | "latitude": 3.14, # The latitude stored in the image. |
| 3947 | "longitude": 3.14, # The longitude stored in the image. |
| 3948 | }, |
| 3949 | "maxApertureValue": 3.14, # The smallest f-number of the lens at the focal length used to create the photo (APEX value). |
| 3950 | "meteringMode": "A String", # The metering mode used to create the photo. |
| 3951 | "rotation": 42, # The number of clockwise 90 degree rotations applied from the image's original orientation. |
| 3952 | "sensor": "A String", # The type of sensor used to create the photo. |
| 3953 | "subjectDistance": 42, # The distance to the subject of the photo, in meters. |
| 3954 | "whiteBalance": "A String", # The white balance mode used to create the photo. |
| 3955 | "width": 42, # The width of the image in pixels. |
| 3956 | }, |
| 3957 | "indexableText": { # Indexable text attributes for the file (can only be written) |
| 3958 | "text": "A String", # The text to be indexed for this file. |
| 3959 | }, |
| 3960 | "isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app. |
| 3961 | "kind": "drive#file", # The type of file. This is always drive#file. |
| 3962 | "labels": { # A group of labels for the file. |
| 3963 | "hidden": True or False, # Deprecated. |
| 3964 | "modified": True or False, # Whether the file has been modified by this user. |
| 3965 | "restricted": True or False, # Deprecated - use copyRequiresWriterPermission instead. |
| 3966 | "starred": True or False, # Whether this file is starred by the user. |
| 3967 | "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. |
| 3968 | "viewed": True or False, # Whether this file has been viewed by this user. |
| 3969 | }, |
| 3970 | "lastModifyingUser": { # Information about a Drive user. # The last user to modify this file. |
| 3971 | "displayName": "A String", # A plain text displayable name for this user. |
| 3972 | "emailAddress": "A String", # The email address of the user. |
| 3973 | "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. |
| 3974 | "kind": "drive#user", # This is always drive#user. |
| 3975 | "permissionId": "A String", # The user's ID as visible in the permissions collection. |
| 3976 | "picture": { # The user's profile picture. |
| 3977 | "url": "A String", # A URL that points to a profile picture of this user. |
| 3978 | }, |
| 3979 | }, |
| 3980 | "lastModifyingUserName": "A String", # Name of the last user to modify this file. |
| 3981 | "lastViewedByMeDate": "A String", # Last time this file was viewed by the user (formatted RFC 3339 timestamp). |
| 3982 | "markedViewedByMeDate": "A String", # Deprecated. |
| 3983 | "md5Checksum": "A String", # An MD5 checksum for the content of this file. This field is only populated for files with content stored in Google Drive; it is not populated for Google Docs or shortcut files. |
| 3984 | "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. |
| 3985 | "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. |
| 3986 | "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. |
| 3987 | "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. |
| 3988 | "a_key": "A String", |
| 3989 | }, |
| 3990 | "originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the title field. This is only available for files with binary content in Google Drive. |
| 3991 | "ownedByMe": True or False, # Whether the file is owned by the current user. Not populated for items in shared drives. |
| 3992 | "ownerNames": [ # Name(s) of the owner(s) of this file. Not populated for items in shared drives. |
| 3993 | "A String", |
| 3994 | ], |
| 3995 | "owners": [ # The owner(s) of this file. Not populated for items in shared drives. |
| Sai Cheemalapati | df61397 | 2016-10-21 13:59:49 -0700 | [diff] [blame] | 3996 | { # Information about a Drive user. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3997 | "displayName": "A String", # A plain text displayable name for this user. |
| 3998 | "emailAddress": "A String", # The email address of the user. |
| 3999 | "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. |
| 4000 | "kind": "drive#user", # This is always drive#user. |
| 4001 | "permissionId": "A String", # The user's ID as visible in the permissions collection. |
| 4002 | "picture": { # The user's profile picture. |
| 4003 | "url": "A String", # A URL that points to a profile picture of this user. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 4004 | }, |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 4005 | }, |
| 4006 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4007 | "parents": [ # Collection of parent folders which contain this file. |
| 4008 | # If not specified as part of an insert request, the file will be placed directly in the user's My Drive folder. If not specified as part of a copy request, the file will inherit any discoverable parents of the source file. Update requests can also use the addParents and removeParents parameters to modify the parents list. |
| 4009 | { # A reference to a file's parent. |
| 4010 | "id": "A String", # The ID of the parent. |
| 4011 | "isRoot": True or False, # Whether or not the parent is the root folder. |
| 4012 | "kind": "drive#parentReference", # This is always drive#parentReference. |
| 4013 | "parentLink": "A String", # A link to the parent. |
| 4014 | "selfLink": "A String", # A link back to this reference. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 4015 | }, |
| 4016 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4017 | "permissionIds": [ # List of permission IDs for users with access to this file. |
| 4018 | "A String", |
| 4019 | ], |
| 4020 | "permissions": [ # The list of permissions for users with access to this file. Not populated for items in shared drives. |
| 4021 | { # A permission for a file. |
| 4022 | "additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future. |
| 4023 | "A String", |
| 4024 | ], |
| 4025 | "authKey": "A String", # Deprecated. |
| 4026 | "deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions. |
| 4027 | "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. |
| 4028 | "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. |
| 4029 | "etag": "A String", # The ETag of the permission. |
| 4030 | "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: |
| 4031 | # - They cannot be set on shared drive items |
| 4032 | # - They can only be set on user and group permissions |
| 4033 | # - The date must be in the future |
| 4034 | # - The date cannot be more than a year in the future |
| 4035 | # - The date can only be set on drive.permissions.update or drive.permissions.patch requests |
| 4036 | "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. |
| 4037 | "kind": "drive#permission", # This is always drive#permission. |
| 4038 | "name": "A String", # The name for this permission. |
| 4039 | "permissionDetails": [ # Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. |
| 4040 | { |
| 4041 | "additionalRoles": [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future. |
| 4042 | "A String", |
| 4043 | ], |
| 4044 | "inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field. |
| 4045 | "inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field. |
| 4046 | "permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible: |
| 4047 | # - file |
| 4048 | # - member |
| 4049 | "role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible: |
| 4050 | # - organizer |
| 4051 | # - fileOrganizer |
| 4052 | # - writer |
| 4053 | # - reader |
| 4054 | }, |
| 4055 | ], |
| 4056 | "photoLink": "A String", # A link to the profile photo, if available. |
| 4057 | "role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: |
| 4058 | # - owner |
| 4059 | # - organizer |
| 4060 | # - fileOrganizer |
| 4061 | # - writer |
| 4062 | # - reader |
| 4063 | "selfLink": "A String", # A link back to this permission. |
| 4064 | "teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead. |
| 4065 | { |
| 4066 | "additionalRoles": [ # Deprecated - use permissionDetails/additionalRoles instead. |
| 4067 | "A String", |
| 4068 | ], |
| 4069 | "inherited": True or False, # Deprecated - use permissionDetails/inherited instead. |
| 4070 | "inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead. |
| 4071 | "role": "A String", # Deprecated - use permissionDetails/role instead. |
| 4072 | "teamDrivePermissionType": "A String", # Deprecated - use permissionDetails/permissionType instead. |
| 4073 | }, |
| 4074 | ], |
| 4075 | "type": "A String", # The account type. Allowed values are: |
| 4076 | # - user |
| 4077 | # - group |
| 4078 | # - domain |
| 4079 | # - anyone |
| 4080 | "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. |
| 4081 | "withLink": True or False, # Whether the link is required for this permission. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 4082 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4083 | ], |
| 4084 | "properties": [ # The list of properties. |
| Nathaniel Manista | 4f877e5 | 2015-06-15 16:44:50 +0000 | [diff] [blame] | 4085 | { # A key-value pair attached to a file that is either public or private to an application. |
| 4086 | # The following limits apply to file properties: |
| 4087 | # - Maximum of 100 properties total per file |
| 4088 | # - Maximum of 30 private properties per app |
| 4089 | # - Maximum of 30 public properties |
| 4090 | # - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4091 | "etag": "A String", # ETag of the property. |
| 4092 | "key": "A String", # The key of this property. |
| 4093 | "kind": "drive#property", # This is always drive#property. |
| 4094 | "selfLink": "A String", # The link back to this property. |
| 4095 | "value": "A String", # The value of this property. |
| 4096 | "visibility": "A String", # The visibility of this property. Allowed values are PRIVATE and PUBLIC. (Default: PRIVATE) |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 4097 | }, |
| 4098 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4099 | "quotaBytesUsed": "A String", # The number of quota bytes used by this file. |
| 4100 | "selfLink": "A String", # A link back to this file. |
| 4101 | "shareable": True or False, # Deprecated: use capabilities/canShare. |
| 4102 | "shared": True or False, # Whether the file has been shared. Not populated for items in shared drives. |
| 4103 | "sharedWithMeDate": "A String", # Time at which this file was shared with the user (formatted RFC 3339 timestamp). |
| 4104 | "sharingUser": { # Information about a Drive user. # User that shared the item with the current user, if available. |
| 4105 | "displayName": "A String", # A plain text displayable name for this user. |
| 4106 | "emailAddress": "A String", # The email address of the user. |
| 4107 | "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. |
| 4108 | "kind": "drive#user", # This is always drive#user. |
| 4109 | "permissionId": "A String", # The user's ID as visible in the permissions collection. |
| 4110 | "picture": { # The user's profile picture. |
| 4111 | "url": "A String", # A URL that points to a profile picture of this user. |
| 4112 | }, |
| Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 4113 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4114 | "shortcutDetails": { # Shortcut file details. Only populated for shortcut files, which have the mimeType field set to application/vnd.google-apps.shortcut. |
| 4115 | "targetId": "A String", # The ID of the file that this shortcut points to. |
| 4116 | "targetMimeType": "A String", # The MIME type of the file that this shortcut points to. The value of this field is a snapshot of the target's MIME type, captured when the shortcut is created. |
| 4117 | }, |
| 4118 | "spaces": [ # The list of spaces which contain the file. Supported values are 'drive', 'appDataFolder' and 'photos'. |
| 4119 | "A String", |
| 4120 | ], |
| 4121 | "teamDriveId": "A String", # Deprecated - use driveId instead. |
| 4122 | "thumbnail": { # A thumbnail for the file. This will only be used if a standard thumbnail cannot be generated. |
| 4123 | "image": "A String", # The URL-safe Base64 encoded bytes of the thumbnail image. It should conform to RFC 4648 section 5. |
| 4124 | "mimeType": "A String", # The MIME type of the thumbnail. |
| 4125 | }, |
| 4126 | "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. |
| 4127 | "thumbnailVersion": "A String", # The thumbnail version for use in thumbnail cache invalidation. |
| 4128 | "title": "A String", # The title of this file. Note that for immutable items such as the top level folders of shared drives, My Drive root folder, and Application Data folder the title is constant. |
| 4129 | "trashedDate": "A String", # The time that the item was trashed (formatted RFC 3339 timestamp). Only populated for items in shared drives. |
| 4130 | "trashingUser": { # Information about a Drive user. # If the file has been explicitly trashed, the user who trashed it. Only populated for items in shared drives. |
| 4131 | "displayName": "A String", # A plain text displayable name for this user. |
| 4132 | "emailAddress": "A String", # The email address of the user. |
| 4133 | "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. |
| 4134 | "kind": "drive#user", # This is always drive#user. |
| 4135 | "permissionId": "A String", # The user's ID as visible in the permissions collection. |
| 4136 | "picture": { # The user's profile picture. |
| 4137 | "url": "A String", # A URL that points to a profile picture of this user. |
| 4138 | }, |
| 4139 | }, |
| 4140 | "userPermission": { # A permission for a file. # The permissions for the authenticated user on this file. |
| 4141 | "additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future. |
| 4142 | "A String", |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 4143 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4144 | "authKey": "A String", # Deprecated. |
| 4145 | "deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions. |
| 4146 | "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. |
| 4147 | "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. |
| 4148 | "etag": "A String", # The ETag of the permission. |
| 4149 | "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4150 | # - They cannot be set on shared drive items |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 4151 | # - They can only be set on user and group permissions |
| 4152 | # - The date must be in the future |
| 4153 | # - The date cannot be more than a year in the future |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4154 | # - The date can only be set on drive.permissions.update or drive.permissions.patch requests |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4155 | "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. |
| 4156 | "kind": "drive#permission", # This is always drive#permission. |
| 4157 | "name": "A String", # The name for this permission. |
| 4158 | "permissionDetails": [ # Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. |
| 4159 | { |
| 4160 | "additionalRoles": [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future. |
| 4161 | "A String", |
| 4162 | ], |
| 4163 | "inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field. |
| 4164 | "inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field. |
| 4165 | "permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible: |
| 4166 | # - file |
| 4167 | # - member |
| 4168 | "role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible: |
| 4169 | # - organizer |
| 4170 | # - fileOrganizer |
| 4171 | # - writer |
| 4172 | # - reader |
| 4173 | }, |
| 4174 | ], |
| 4175 | "photoLink": "A String", # A link to the profile photo, if available. |
| 4176 | "role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 4177 | # - owner |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4178 | # - organizer |
| 4179 | # - fileOrganizer |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 4180 | # - writer |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4181 | # - reader |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4182 | "selfLink": "A String", # A link back to this permission. |
| 4183 | "teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead. |
| 4184 | { |
| 4185 | "additionalRoles": [ # Deprecated - use permissionDetails/additionalRoles instead. |
| 4186 | "A String", |
| 4187 | ], |
| 4188 | "inherited": True or False, # Deprecated - use permissionDetails/inherited instead. |
| 4189 | "inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead. |
| 4190 | "role": "A String", # Deprecated - use permissionDetails/role instead. |
| 4191 | "teamDrivePermissionType": "A String", # Deprecated - use permissionDetails/permissionType instead. |
| 4192 | }, |
| 4193 | ], |
| 4194 | "type": "A String", # The account type. Allowed values are: |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 4195 | # - user |
| 4196 | # - group |
| 4197 | # - domain |
| 4198 | # - anyone |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4199 | "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. |
| 4200 | "withLink": True or False, # Whether the link is required for this permission. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 4201 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4202 | "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. |
| 4203 | "videoMediaMetadata": { # Metadata about video media. This will only be present for video types. |
| 4204 | "durationMillis": "A String", # The duration of the video in milliseconds. |
| 4205 | "height": 42, # The height of the video in pixels. |
| 4206 | "width": 42, # The width of the video in pixels. |
| 4207 | }, |
| 4208 | "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. |
| 4209 | "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. |
| 4210 | "writersCanShare": True or False, # Whether writers can share the document with other users. Not populated for items in shared drives. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 4211 | }</pre> |
| 4212 | </div> |
| 4213 | |
| 4214 | <div class="method"> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4215 | <code class="details" id="update">update(fileId, body=None, addParents=None, convert=None, enforceSingleParent=None, modifiedDateBehavior=None, newRevision=None, ocr=None, ocrLanguage=None, pinned=None, removeParents=None, setModifiedDate=None, supportsAllDrives=None, supportsTeamDrives=None, timedTextLanguage=None, timedTextTrackName=None, updateViewedDate=None, useContentAsIndexableText=None, media_body=None, media_mime_type=None)</code> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 4216 | <pre>Updates file metadata and/or content. |
| 4217 | |
| 4218 | Args: |
| 4219 | fileId: string, The ID of the file to update. (required) |
| 4220 | body: object, The request body. |
| 4221 | The object takes the form of: |
| 4222 | |
| 4223 | { # The metadata for a file. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4224 | "alternateLink": "A String", # A link for opening the file in a relevant Google editor or viewer. |
| 4225 | "appDataContents": True or False, # Whether this file is in the Application Data folder. |
| 4226 | "canComment": True or False, # Deprecated: use capabilities/canComment. |
| 4227 | "canReadRevisions": True or False, # Deprecated: use capabilities/canReadRevisions. |
| 4228 | "capabilities": { # Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take. |
| 4229 | "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. |
| 4230 | "canAddMyDriveParent": True or False, # Whether the current user can add a parent for the item without removing an existing parent in the same request. Not populated for shared drive files. |
| 4231 | "canChangeCopyRequiresWriterPermission": True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this file. |
| 4232 | "canChangeRestrictedDownload": True or False, # Deprecated |
| 4233 | "canComment": True or False, # Whether the current user can comment on this file. |
| 4234 | "canCopy": True or False, # Whether the current user can copy this file. For an item in a shared drive, whether the current user can copy non-folder descendants of this item, or this item itself if it is not a folder. |
| 4235 | "canDelete": True or False, # Whether the current user can delete this file. |
| 4236 | "canDeleteChildren": True or False, # Whether the current user can delete children of this folder. This is false when the item is not a folder. Only populated for items in shared drives. |
| 4237 | "canDownload": True or False, # Whether the current user can download this file. |
| 4238 | "canEdit": True or False, # Whether the current user can edit this file. Other factors may limit the type of changes a user can make to a file. For example, see canChangeCopyRequiresWriterPermission or canModifyContent. |
| 4239 | "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. |
| 4240 | "canModifyContent": True or False, # Whether the current user can modify the content of this file. |
| 4241 | "canMoveChildrenOutOfDrive": True or False, # Whether the current user can move children of this folder outside of the shared drive. This is false when the item is not a folder. Only populated for items in shared drives. |
| 4242 | "canMoveChildrenOutOfTeamDrive": True or False, # Deprecated - use canMoveChildrenOutOfDrive instead. |
| 4243 | "canMoveChildrenWithinDrive": True or False, # Whether the current user can move children of this folder within the shared drive. This is false when the item is not a folder. Only populated for items in shared drives. |
| 4244 | "canMoveChildrenWithinTeamDrive": True or False, # Deprecated - use canMoveChildrenWithinDrive instead. |
| 4245 | "canMoveItemIntoTeamDrive": True or False, # Deprecated - use canMoveItemOutOfDrive instead. |
| 4246 | "canMoveItemOutOfDrive": True or False, # Whether the current user can move this item outside of this drive by changing its parent. Note that a request to change the parent of the item may still fail depending on the new parent that is being added. |
| 4247 | "canMoveItemOutOfTeamDrive": True or False, # Deprecated - use canMoveItemOutOfDrive instead. |
| 4248 | "canMoveItemWithinDrive": True or False, # Whether the current user can move this item within this shared drive. Note that a request to change the parent of the item may still fail depending on the new parent that is being added. Only populated for items in shared drives. |
| 4249 | "canMoveItemWithinTeamDrive": True or False, # Deprecated - use canMoveItemWithinDrive instead. |
| 4250 | "canMoveTeamDriveItem": True or False, # Deprecated - use canMoveItemWithinDrive or canMoveItemOutOfDrive instead. |
| 4251 | "canReadDrive": True or False, # Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives. |
| 4252 | "canReadRevisions": True or False, # Whether the current user can read the revisions resource of this file. For a shared drive item, whether revisions of non-folder descendants of this item, or this item itself if it is not a folder, can be read. |
| 4253 | "canReadTeamDrive": True or False, # Deprecated - use canReadDrive instead. |
| 4254 | "canRemoveChildren": True or False, # Whether the current user can remove children from this folder. This is always false when the item is not a folder. For a folder in a shared drive, use canDeleteChildren or canTrashChildren instead. |
| 4255 | "canRemoveMyDriveParent": True or False, # Whether the current user can remove a parent from the item without adding another parent in the same request. Not populated for shared drive files. |
| 4256 | "canRename": True or False, # Whether the current user can rename this file. |
| 4257 | "canShare": True or False, # Whether the current user can modify the sharing settings for this file. |
| 4258 | "canTrash": True or False, # Whether the current user can move this file to trash. |
| 4259 | "canTrashChildren": True or False, # Whether the current user can trash children of this folder. This is false when the item is not a folder. Only populated for items in shared drives. |
| 4260 | "canUntrash": True or False, # Whether the current user can restore this file from trash. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 4261 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4262 | "copyRequiresWriterPermission": True or False, # Whether the options to copy, print, or download this file, should be disabled for readers and commenters. |
| 4263 | "copyable": True or False, # Deprecated: use capabilities/canCopy. |
| 4264 | "createdDate": "A String", # Create time for this file (formatted RFC 3339 timestamp). |
| 4265 | "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. |
| 4266 | "description": "A String", # A short description of the file. |
| 4267 | "downloadUrl": "A String", # Short lived download URL for the file. This field is only populated for files with content stored in Google Drive; it is not populated for Google Docs or shortcut files. |
| 4268 | "driveId": "A String", # ID of the shared drive the file resides in. Only populated for items in shared drives. |
| 4269 | "editable": True or False, # Deprecated: use capabilities/canEdit. |
| 4270 | "embedLink": "A String", # A link for embedding the file. |
| 4271 | "etag": "A String", # ETag of the file. |
| 4272 | "explicitlyTrashed": True or False, # Whether this file has been explicitly trashed, as opposed to recursively trashed. |
| 4273 | "exportLinks": { # Links for exporting Google Docs to specific formats. |
| 4274 | "a_key": "A String", # A mapping from export format to URL |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 4275 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4276 | "fileExtension": "A String", # The final component of fullFileExtension with trailing text that does not appear to be part of the extension removed. This field is only populated for files with content stored in Google Drive; it is not populated for Google Docs or shortcut files. |
| 4277 | "fileSize": "A String", # The size of the file in bytes. This field is only populated for files with content stored in Google Drive; it is not populated for Google Docs or shortcut files. |
| 4278 | "folderColorRgb": "A String", # Folder color as an RGB hex string if the file is a folder. The list of supported colors is available in the folderColorPalette field of the About resource. If an unsupported color is specified, it will be changed to the closest color in the palette. Not populated for items in shared drives. |
| 4279 | "fullFileExtension": "A String", # The full file extension; extracted from the title. May contain multiple concatenated extensions, such as "tar.gz". Removing an extension from the title does not clear this field; however, changing the extension on the title does update this field. This field is only populated for files with content stored in Google Drive; it is not populated for Google Docs or shortcut files. |
| 4280 | "hasAugmentedPermissions": True or False, # Whether there are permissions directly on this file. This field is only populated for items in shared drives. |
| 4281 | "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. |
| 4282 | "headRevisionId": "A String", # The ID of the file's head revision. This field is only populated for files with content stored in Google Drive; it is not populated for Google Docs or shortcut files. |
| 4283 | "iconLink": "A String", # A link to the file's icon. |
| 4284 | "id": "A String", # The ID of the file. |
| 4285 | "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. |
| 4286 | "aperture": 3.14, # The aperture used to create the photo (f-number). |
| 4287 | "cameraMake": "A String", # The make of the camera used to create the photo. |
| 4288 | "cameraModel": "A String", # The model of the camera used to create the photo. |
| 4289 | "colorSpace": "A String", # The color space of the photo. |
| 4290 | "date": "A String", # The date and time the photo was taken (EXIF format timestamp). |
| 4291 | "exposureBias": 3.14, # The exposure bias of the photo (APEX value). |
| 4292 | "exposureMode": "A String", # The exposure mode used to create the photo. |
| 4293 | "exposureTime": 3.14, # The length of the exposure, in seconds. |
| 4294 | "flashUsed": True or False, # Whether a flash was used to create the photo. |
| 4295 | "focalLength": 3.14, # The focal length used to create the photo, in millimeters. |
| 4296 | "height": 42, # The height of the image in pixels. |
| 4297 | "isoSpeed": 42, # The ISO speed used to create the photo. |
| 4298 | "lens": "A String", # The lens used to create the photo. |
| 4299 | "location": { # Geographic location information stored in the image. |
| 4300 | "altitude": 3.14, # The altitude stored in the image. |
| 4301 | "latitude": 3.14, # The latitude stored in the image. |
| 4302 | "longitude": 3.14, # The longitude stored in the image. |
| 4303 | }, |
| 4304 | "maxApertureValue": 3.14, # The smallest f-number of the lens at the focal length used to create the photo (APEX value). |
| 4305 | "meteringMode": "A String", # The metering mode used to create the photo. |
| 4306 | "rotation": 42, # The number of clockwise 90 degree rotations applied from the image's original orientation. |
| 4307 | "sensor": "A String", # The type of sensor used to create the photo. |
| 4308 | "subjectDistance": 42, # The distance to the subject of the photo, in meters. |
| 4309 | "whiteBalance": "A String", # The white balance mode used to create the photo. |
| 4310 | "width": 42, # The width of the image in pixels. |
| 4311 | }, |
| 4312 | "indexableText": { # Indexable text attributes for the file (can only be written) |
| 4313 | "text": "A String", # The text to be indexed for this file. |
| 4314 | }, |
| 4315 | "isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app. |
| 4316 | "kind": "drive#file", # The type of file. This is always drive#file. |
| 4317 | "labels": { # A group of labels for the file. |
| 4318 | "hidden": True or False, # Deprecated. |
| 4319 | "modified": True or False, # Whether the file has been modified by this user. |
| 4320 | "restricted": True or False, # Deprecated - use copyRequiresWriterPermission instead. |
| 4321 | "starred": True or False, # Whether this file is starred by the user. |
| 4322 | "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. |
| 4323 | "viewed": True or False, # Whether this file has been viewed by this user. |
| 4324 | }, |
| 4325 | "lastModifyingUser": { # Information about a Drive user. # The last user to modify this file. |
| 4326 | "displayName": "A String", # A plain text displayable name for this user. |
| 4327 | "emailAddress": "A String", # The email address of the user. |
| 4328 | "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. |
| 4329 | "kind": "drive#user", # This is always drive#user. |
| 4330 | "permissionId": "A String", # The user's ID as visible in the permissions collection. |
| 4331 | "picture": { # The user's profile picture. |
| 4332 | "url": "A String", # A URL that points to a profile picture of this user. |
| 4333 | }, |
| 4334 | }, |
| 4335 | "lastModifyingUserName": "A String", # Name of the last user to modify this file. |
| 4336 | "lastViewedByMeDate": "A String", # Last time this file was viewed by the user (formatted RFC 3339 timestamp). |
| 4337 | "markedViewedByMeDate": "A String", # Deprecated. |
| 4338 | "md5Checksum": "A String", # An MD5 checksum for the content of this file. This field is only populated for files with content stored in Google Drive; it is not populated for Google Docs or shortcut files. |
| 4339 | "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. |
| 4340 | "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. |
| 4341 | "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. |
| 4342 | "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. |
| 4343 | "a_key": "A String", |
| 4344 | }, |
| 4345 | "originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the title field. This is only available for files with binary content in Google Drive. |
| 4346 | "ownedByMe": True or False, # Whether the file is owned by the current user. Not populated for items in shared drives. |
| 4347 | "ownerNames": [ # Name(s) of the owner(s) of this file. Not populated for items in shared drives. |
| 4348 | "A String", |
| 4349 | ], |
| 4350 | "owners": [ # The owner(s) of this file. Not populated for items in shared drives. |
| Sai Cheemalapati | df61397 | 2016-10-21 13:59:49 -0700 | [diff] [blame] | 4351 | { # Information about a Drive user. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4352 | "displayName": "A String", # A plain text displayable name for this user. |
| 4353 | "emailAddress": "A String", # The email address of the user. |
| 4354 | "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. |
| 4355 | "kind": "drive#user", # This is always drive#user. |
| 4356 | "permissionId": "A String", # The user's ID as visible in the permissions collection. |
| 4357 | "picture": { # The user's profile picture. |
| 4358 | "url": "A String", # A URL that points to a profile picture of this user. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 4359 | }, |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 4360 | }, |
| 4361 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4362 | "parents": [ # Collection of parent folders which contain this file. |
| 4363 | # If not specified as part of an insert request, the file will be placed directly in the user's My Drive folder. If not specified as part of a copy request, the file will inherit any discoverable parents of the source file. Update requests can also use the addParents and removeParents parameters to modify the parents list. |
| 4364 | { # A reference to a file's parent. |
| 4365 | "id": "A String", # The ID of the parent. |
| 4366 | "isRoot": True or False, # Whether or not the parent is the root folder. |
| 4367 | "kind": "drive#parentReference", # This is always drive#parentReference. |
| 4368 | "parentLink": "A String", # A link to the parent. |
| 4369 | "selfLink": "A String", # A link back to this reference. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 4370 | }, |
| 4371 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4372 | "permissionIds": [ # List of permission IDs for users with access to this file. |
| 4373 | "A String", |
| 4374 | ], |
| 4375 | "permissions": [ # The list of permissions for users with access to this file. Not populated for items in shared drives. |
| 4376 | { # A permission for a file. |
| 4377 | "additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future. |
| 4378 | "A String", |
| 4379 | ], |
| 4380 | "authKey": "A String", # Deprecated. |
| 4381 | "deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions. |
| 4382 | "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. |
| 4383 | "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. |
| 4384 | "etag": "A String", # The ETag of the permission. |
| 4385 | "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: |
| 4386 | # - They cannot be set on shared drive items |
| 4387 | # - They can only be set on user and group permissions |
| 4388 | # - The date must be in the future |
| 4389 | # - The date cannot be more than a year in the future |
| 4390 | # - The date can only be set on drive.permissions.update or drive.permissions.patch requests |
| 4391 | "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. |
| 4392 | "kind": "drive#permission", # This is always drive#permission. |
| 4393 | "name": "A String", # The name for this permission. |
| 4394 | "permissionDetails": [ # Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. |
| 4395 | { |
| 4396 | "additionalRoles": [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future. |
| 4397 | "A String", |
| 4398 | ], |
| 4399 | "inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field. |
| 4400 | "inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field. |
| 4401 | "permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible: |
| 4402 | # - file |
| 4403 | # - member |
| 4404 | "role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible: |
| 4405 | # - organizer |
| 4406 | # - fileOrganizer |
| 4407 | # - writer |
| 4408 | # - reader |
| 4409 | }, |
| 4410 | ], |
| 4411 | "photoLink": "A String", # A link to the profile photo, if available. |
| 4412 | "role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: |
| 4413 | # - owner |
| 4414 | # - organizer |
| 4415 | # - fileOrganizer |
| 4416 | # - writer |
| 4417 | # - reader |
| 4418 | "selfLink": "A String", # A link back to this permission. |
| 4419 | "teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead. |
| 4420 | { |
| 4421 | "additionalRoles": [ # Deprecated - use permissionDetails/additionalRoles instead. |
| 4422 | "A String", |
| 4423 | ], |
| 4424 | "inherited": True or False, # Deprecated - use permissionDetails/inherited instead. |
| 4425 | "inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead. |
| 4426 | "role": "A String", # Deprecated - use permissionDetails/role instead. |
| 4427 | "teamDrivePermissionType": "A String", # Deprecated - use permissionDetails/permissionType instead. |
| 4428 | }, |
| 4429 | ], |
| 4430 | "type": "A String", # The account type. Allowed values are: |
| 4431 | # - user |
| 4432 | # - group |
| 4433 | # - domain |
| 4434 | # - anyone |
| 4435 | "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. |
| 4436 | "withLink": True or False, # Whether the link is required for this permission. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 4437 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4438 | ], |
| 4439 | "properties": [ # The list of properties. |
| Nathaniel Manista | 4f877e5 | 2015-06-15 16:44:50 +0000 | [diff] [blame] | 4440 | { # A key-value pair attached to a file that is either public or private to an application. |
| 4441 | # The following limits apply to file properties: |
| 4442 | # - Maximum of 100 properties total per file |
| 4443 | # - Maximum of 30 private properties per app |
| 4444 | # - Maximum of 30 public properties |
| 4445 | # - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4446 | "etag": "A String", # ETag of the property. |
| 4447 | "key": "A String", # The key of this property. |
| 4448 | "kind": "drive#property", # This is always drive#property. |
| 4449 | "selfLink": "A String", # The link back to this property. |
| 4450 | "value": "A String", # The value of this property. |
| 4451 | "visibility": "A String", # The visibility of this property. Allowed values are PRIVATE and PUBLIC. (Default: PRIVATE) |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 4452 | }, |
| 4453 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4454 | "quotaBytesUsed": "A String", # The number of quota bytes used by this file. |
| 4455 | "selfLink": "A String", # A link back to this file. |
| 4456 | "shareable": True or False, # Deprecated: use capabilities/canShare. |
| 4457 | "shared": True or False, # Whether the file has been shared. Not populated for items in shared drives. |
| 4458 | "sharedWithMeDate": "A String", # Time at which this file was shared with the user (formatted RFC 3339 timestamp). |
| 4459 | "sharingUser": { # Information about a Drive user. # User that shared the item with the current user, if available. |
| 4460 | "displayName": "A String", # A plain text displayable name for this user. |
| 4461 | "emailAddress": "A String", # The email address of the user. |
| 4462 | "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. |
| 4463 | "kind": "drive#user", # This is always drive#user. |
| 4464 | "permissionId": "A String", # The user's ID as visible in the permissions collection. |
| 4465 | "picture": { # The user's profile picture. |
| 4466 | "url": "A String", # A URL that points to a profile picture of this user. |
| 4467 | }, |
| Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 4468 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4469 | "shortcutDetails": { # Shortcut file details. Only populated for shortcut files, which have the mimeType field set to application/vnd.google-apps.shortcut. |
| 4470 | "targetId": "A String", # The ID of the file that this shortcut points to. |
| 4471 | "targetMimeType": "A String", # The MIME type of the file that this shortcut points to. The value of this field is a snapshot of the target's MIME type, captured when the shortcut is created. |
| 4472 | }, |
| 4473 | "spaces": [ # The list of spaces which contain the file. Supported values are 'drive', 'appDataFolder' and 'photos'. |
| 4474 | "A String", |
| 4475 | ], |
| 4476 | "teamDriveId": "A String", # Deprecated - use driveId instead. |
| 4477 | "thumbnail": { # A thumbnail for the file. This will only be used if a standard thumbnail cannot be generated. |
| 4478 | "image": "A String", # The URL-safe Base64 encoded bytes of the thumbnail image. It should conform to RFC 4648 section 5. |
| 4479 | "mimeType": "A String", # The MIME type of the thumbnail. |
| 4480 | }, |
| 4481 | "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. |
| 4482 | "thumbnailVersion": "A String", # The thumbnail version for use in thumbnail cache invalidation. |
| 4483 | "title": "A String", # The title of this file. Note that for immutable items such as the top level folders of shared drives, My Drive root folder, and Application Data folder the title is constant. |
| 4484 | "trashedDate": "A String", # The time that the item was trashed (formatted RFC 3339 timestamp). Only populated for items in shared drives. |
| 4485 | "trashingUser": { # Information about a Drive user. # If the file has been explicitly trashed, the user who trashed it. Only populated for items in shared drives. |
| 4486 | "displayName": "A String", # A plain text displayable name for this user. |
| 4487 | "emailAddress": "A String", # The email address of the user. |
| 4488 | "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. |
| 4489 | "kind": "drive#user", # This is always drive#user. |
| 4490 | "permissionId": "A String", # The user's ID as visible in the permissions collection. |
| 4491 | "picture": { # The user's profile picture. |
| 4492 | "url": "A String", # A URL that points to a profile picture of this user. |
| 4493 | }, |
| 4494 | }, |
| 4495 | "userPermission": { # A permission for a file. # The permissions for the authenticated user on this file. |
| 4496 | "additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future. |
| 4497 | "A String", |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 4498 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4499 | "authKey": "A String", # Deprecated. |
| 4500 | "deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions. |
| 4501 | "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. |
| 4502 | "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. |
| 4503 | "etag": "A String", # The ETag of the permission. |
| 4504 | "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4505 | # - They cannot be set on shared drive items |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 4506 | # - They can only be set on user and group permissions |
| 4507 | # - The date must be in the future |
| 4508 | # - The date cannot be more than a year in the future |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4509 | # - The date can only be set on drive.permissions.update or drive.permissions.patch requests |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4510 | "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. |
| 4511 | "kind": "drive#permission", # This is always drive#permission. |
| 4512 | "name": "A String", # The name for this permission. |
| 4513 | "permissionDetails": [ # Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. |
| 4514 | { |
| 4515 | "additionalRoles": [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future. |
| 4516 | "A String", |
| 4517 | ], |
| 4518 | "inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field. |
| 4519 | "inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field. |
| 4520 | "permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible: |
| 4521 | # - file |
| 4522 | # - member |
| 4523 | "role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible: |
| 4524 | # - organizer |
| 4525 | # - fileOrganizer |
| 4526 | # - writer |
| 4527 | # - reader |
| 4528 | }, |
| 4529 | ], |
| 4530 | "photoLink": "A String", # A link to the profile photo, if available. |
| 4531 | "role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 4532 | # - owner |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4533 | # - organizer |
| 4534 | # - fileOrganizer |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 4535 | # - writer |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4536 | # - reader |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4537 | "selfLink": "A String", # A link back to this permission. |
| 4538 | "teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead. |
| 4539 | { |
| 4540 | "additionalRoles": [ # Deprecated - use permissionDetails/additionalRoles instead. |
| 4541 | "A String", |
| 4542 | ], |
| 4543 | "inherited": True or False, # Deprecated - use permissionDetails/inherited instead. |
| 4544 | "inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead. |
| 4545 | "role": "A String", # Deprecated - use permissionDetails/role instead. |
| 4546 | "teamDrivePermissionType": "A String", # Deprecated - use permissionDetails/permissionType instead. |
| 4547 | }, |
| 4548 | ], |
| 4549 | "type": "A String", # The account type. Allowed values are: |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 4550 | # - user |
| 4551 | # - group |
| 4552 | # - domain |
| 4553 | # - anyone |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4554 | "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. |
| 4555 | "withLink": True or False, # Whether the link is required for this permission. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 4556 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4557 | "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. |
| 4558 | "videoMediaMetadata": { # Metadata about video media. This will only be present for video types. |
| 4559 | "durationMillis": "A String", # The duration of the video in milliseconds. |
| 4560 | "height": 42, # The height of the video in pixels. |
| 4561 | "width": 42, # The width of the video in pixels. |
| 4562 | }, |
| 4563 | "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. |
| 4564 | "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. |
| 4565 | "writersCanShare": True or False, # Whether writers can share the document with other users. Not populated for items in shared drives. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 4566 | } |
| 4567 | |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4568 | addParents: string, Comma-separated list of parent IDs to add. |
| 4569 | convert: boolean, This parameter is deprecated and has no function. |
| 4570 | enforceSingleParent: boolean, Set to true to opt in to API behavior that aims for all items to have exactly one parent. This parameter only takes effect if the item is not in a shared drive. If the item's owner makes a request to add a single parent, the item is removed from all current folders and placed in the requested folder. Other requests that increase the number of parents fail, except when the canAddMyDriveParent file capability is true and a single parent is being added. |
| Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 4571 | modifiedDateBehavior: string, Determines the behavior in which modifiedDate is updated. This overrides setModifiedDate. |
| 4572 | Allowed values |
| 4573 | fromBody - Set modifiedDate to the value provided in the body of the request. No change if no value was provided. |
| 4574 | fromBodyIfNeeded - Set modifiedDate to the value provided in the body of the request depending on other contents of the update. |
| 4575 | fromBodyOrNow - Set modifiedDate to the value provided in the body of the request, or to the current time if no value was provided. |
| 4576 | noChange - Maintain the previous value of modifiedDate. |
| 4577 | now - Set modifiedDate to the current time. |
| 4578 | nowIfNeeded - Set modifiedDate to the current time depending on contents of the update. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4579 | 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. |
| 4580 | ocr: boolean, Whether to attempt OCR on .jpg, .png, .gif, or .pdf uploads. |
| Nathaniel Manista | 4f877e5 | 2015-06-15 16:44:50 +0000 | [diff] [blame] | 4581 | ocrLanguage: string, If ocr is true, hints at the language to use. Valid values are BCP 47 codes. |
| Craig Citro | 0e5b9bf | 2014-10-15 10:26:14 -0700 | [diff] [blame] | 4582 | pinned: boolean, Whether to pin the new revision. A file can have a maximum of 200 pinned revisions. |
| Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 4583 | removeParents: string, Comma-separated list of parent IDs to remove. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4584 | setModifiedDate: boolean, Whether to set the modified date using the value supplied in the request body. Setting this field to true is equivalent to modifiedDateBehavior=fromBodyOrNow, and false is equivalent to modifiedDateBehavior=now. To prevent any changes to the modified date set modifiedDateBehavior=noChange. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4585 | supportsAllDrives: boolean, Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives. |
| 4586 | supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 4587 | timedTextLanguage: string, The language of the timed text. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4588 | timedTextTrackName: string, The timed text track name. |
| 4589 | updateViewedDate: boolean, Whether to update the view date after successfully updating the file. |
| 4590 | useContentAsIndexableText: boolean, Whether to use the content as indexable text. |
| 4591 | media_body: string, The filename of the media request body, or an instance of a MediaUpload object. |
| 4592 | media_mime_type: string, The MIME type of the media request body, or an instance of a MediaUpload object. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 4593 | |
| 4594 | Returns: |
| 4595 | An object of the form: |
| 4596 | |
| 4597 | { # The metadata for a file. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4598 | "alternateLink": "A String", # A link for opening the file in a relevant Google editor or viewer. |
| 4599 | "appDataContents": True or False, # Whether this file is in the Application Data folder. |
| 4600 | "canComment": True or False, # Deprecated: use capabilities/canComment. |
| 4601 | "canReadRevisions": True or False, # Deprecated: use capabilities/canReadRevisions. |
| 4602 | "capabilities": { # Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take. |
| 4603 | "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. |
| 4604 | "canAddMyDriveParent": True or False, # Whether the current user can add a parent for the item without removing an existing parent in the same request. Not populated for shared drive files. |
| 4605 | "canChangeCopyRequiresWriterPermission": True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this file. |
| 4606 | "canChangeRestrictedDownload": True or False, # Deprecated |
| 4607 | "canComment": True or False, # Whether the current user can comment on this file. |
| 4608 | "canCopy": True or False, # Whether the current user can copy this file. For an item in a shared drive, whether the current user can copy non-folder descendants of this item, or this item itself if it is not a folder. |
| 4609 | "canDelete": True or False, # Whether the current user can delete this file. |
| 4610 | "canDeleteChildren": True or False, # Whether the current user can delete children of this folder. This is false when the item is not a folder. Only populated for items in shared drives. |
| 4611 | "canDownload": True or False, # Whether the current user can download this file. |
| 4612 | "canEdit": True or False, # Whether the current user can edit this file. Other factors may limit the type of changes a user can make to a file. For example, see canChangeCopyRequiresWriterPermission or canModifyContent. |
| 4613 | "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. |
| 4614 | "canModifyContent": True or False, # Whether the current user can modify the content of this file. |
| 4615 | "canMoveChildrenOutOfDrive": True or False, # Whether the current user can move children of this folder outside of the shared drive. This is false when the item is not a folder. Only populated for items in shared drives. |
| 4616 | "canMoveChildrenOutOfTeamDrive": True or False, # Deprecated - use canMoveChildrenOutOfDrive instead. |
| 4617 | "canMoveChildrenWithinDrive": True or False, # Whether the current user can move children of this folder within the shared drive. This is false when the item is not a folder. Only populated for items in shared drives. |
| 4618 | "canMoveChildrenWithinTeamDrive": True or False, # Deprecated - use canMoveChildrenWithinDrive instead. |
| 4619 | "canMoveItemIntoTeamDrive": True or False, # Deprecated - use canMoveItemOutOfDrive instead. |
| 4620 | "canMoveItemOutOfDrive": True or False, # Whether the current user can move this item outside of this drive by changing its parent. Note that a request to change the parent of the item may still fail depending on the new parent that is being added. |
| 4621 | "canMoveItemOutOfTeamDrive": True or False, # Deprecated - use canMoveItemOutOfDrive instead. |
| 4622 | "canMoveItemWithinDrive": True or False, # Whether the current user can move this item within this shared drive. Note that a request to change the parent of the item may still fail depending on the new parent that is being added. Only populated for items in shared drives. |
| 4623 | "canMoveItemWithinTeamDrive": True or False, # Deprecated - use canMoveItemWithinDrive instead. |
| 4624 | "canMoveTeamDriveItem": True or False, # Deprecated - use canMoveItemWithinDrive or canMoveItemOutOfDrive instead. |
| 4625 | "canReadDrive": True or False, # Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives. |
| 4626 | "canReadRevisions": True or False, # Whether the current user can read the revisions resource of this file. For a shared drive item, whether revisions of non-folder descendants of this item, or this item itself if it is not a folder, can be read. |
| 4627 | "canReadTeamDrive": True or False, # Deprecated - use canReadDrive instead. |
| 4628 | "canRemoveChildren": True or False, # Whether the current user can remove children from this folder. This is always false when the item is not a folder. For a folder in a shared drive, use canDeleteChildren or canTrashChildren instead. |
| 4629 | "canRemoveMyDriveParent": True or False, # Whether the current user can remove a parent from the item without adding another parent in the same request. Not populated for shared drive files. |
| 4630 | "canRename": True or False, # Whether the current user can rename this file. |
| 4631 | "canShare": True or False, # Whether the current user can modify the sharing settings for this file. |
| 4632 | "canTrash": True or False, # Whether the current user can move this file to trash. |
| 4633 | "canTrashChildren": True or False, # Whether the current user can trash children of this folder. This is false when the item is not a folder. Only populated for items in shared drives. |
| 4634 | "canUntrash": True or False, # Whether the current user can restore this file from trash. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 4635 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4636 | "copyRequiresWriterPermission": True or False, # Whether the options to copy, print, or download this file, should be disabled for readers and commenters. |
| 4637 | "copyable": True or False, # Deprecated: use capabilities/canCopy. |
| 4638 | "createdDate": "A String", # Create time for this file (formatted RFC 3339 timestamp). |
| 4639 | "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. |
| 4640 | "description": "A String", # A short description of the file. |
| 4641 | "downloadUrl": "A String", # Short lived download URL for the file. This field is only populated for files with content stored in Google Drive; it is not populated for Google Docs or shortcut files. |
| 4642 | "driveId": "A String", # ID of the shared drive the file resides in. Only populated for items in shared drives. |
| 4643 | "editable": True or False, # Deprecated: use capabilities/canEdit. |
| 4644 | "embedLink": "A String", # A link for embedding the file. |
| 4645 | "etag": "A String", # ETag of the file. |
| 4646 | "explicitlyTrashed": True or False, # Whether this file has been explicitly trashed, as opposed to recursively trashed. |
| 4647 | "exportLinks": { # Links for exporting Google Docs to specific formats. |
| 4648 | "a_key": "A String", # A mapping from export format to URL |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 4649 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4650 | "fileExtension": "A String", # The final component of fullFileExtension with trailing text that does not appear to be part of the extension removed. This field is only populated for files with content stored in Google Drive; it is not populated for Google Docs or shortcut files. |
| 4651 | "fileSize": "A String", # The size of the file in bytes. This field is only populated for files with content stored in Google Drive; it is not populated for Google Docs or shortcut files. |
| 4652 | "folderColorRgb": "A String", # Folder color as an RGB hex string if the file is a folder. The list of supported colors is available in the folderColorPalette field of the About resource. If an unsupported color is specified, it will be changed to the closest color in the palette. Not populated for items in shared drives. |
| 4653 | "fullFileExtension": "A String", # The full file extension; extracted from the title. May contain multiple concatenated extensions, such as "tar.gz". Removing an extension from the title does not clear this field; however, changing the extension on the title does update this field. This field is only populated for files with content stored in Google Drive; it is not populated for Google Docs or shortcut files. |
| 4654 | "hasAugmentedPermissions": True or False, # Whether there are permissions directly on this file. This field is only populated for items in shared drives. |
| 4655 | "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. |
| 4656 | "headRevisionId": "A String", # The ID of the file's head revision. This field is only populated for files with content stored in Google Drive; it is not populated for Google Docs or shortcut files. |
| 4657 | "iconLink": "A String", # A link to the file's icon. |
| 4658 | "id": "A String", # The ID of the file. |
| 4659 | "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. |
| 4660 | "aperture": 3.14, # The aperture used to create the photo (f-number). |
| 4661 | "cameraMake": "A String", # The make of the camera used to create the photo. |
| 4662 | "cameraModel": "A String", # The model of the camera used to create the photo. |
| 4663 | "colorSpace": "A String", # The color space of the photo. |
| 4664 | "date": "A String", # The date and time the photo was taken (EXIF format timestamp). |
| 4665 | "exposureBias": 3.14, # The exposure bias of the photo (APEX value). |
| 4666 | "exposureMode": "A String", # The exposure mode used to create the photo. |
| 4667 | "exposureTime": 3.14, # The length of the exposure, in seconds. |
| 4668 | "flashUsed": True or False, # Whether a flash was used to create the photo. |
| 4669 | "focalLength": 3.14, # The focal length used to create the photo, in millimeters. |
| 4670 | "height": 42, # The height of the image in pixels. |
| 4671 | "isoSpeed": 42, # The ISO speed used to create the photo. |
| 4672 | "lens": "A String", # The lens used to create the photo. |
| 4673 | "location": { # Geographic location information stored in the image. |
| 4674 | "altitude": 3.14, # The altitude stored in the image. |
| 4675 | "latitude": 3.14, # The latitude stored in the image. |
| 4676 | "longitude": 3.14, # The longitude stored in the image. |
| 4677 | }, |
| 4678 | "maxApertureValue": 3.14, # The smallest f-number of the lens at the focal length used to create the photo (APEX value). |
| 4679 | "meteringMode": "A String", # The metering mode used to create the photo. |
| 4680 | "rotation": 42, # The number of clockwise 90 degree rotations applied from the image's original orientation. |
| 4681 | "sensor": "A String", # The type of sensor used to create the photo. |
| 4682 | "subjectDistance": 42, # The distance to the subject of the photo, in meters. |
| 4683 | "whiteBalance": "A String", # The white balance mode used to create the photo. |
| 4684 | "width": 42, # The width of the image in pixels. |
| 4685 | }, |
| 4686 | "indexableText": { # Indexable text attributes for the file (can only be written) |
| 4687 | "text": "A String", # The text to be indexed for this file. |
| 4688 | }, |
| 4689 | "isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app. |
| 4690 | "kind": "drive#file", # The type of file. This is always drive#file. |
| 4691 | "labels": { # A group of labels for the file. |
| 4692 | "hidden": True or False, # Deprecated. |
| 4693 | "modified": True or False, # Whether the file has been modified by this user. |
| 4694 | "restricted": True or False, # Deprecated - use copyRequiresWriterPermission instead. |
| 4695 | "starred": True or False, # Whether this file is starred by the user. |
| 4696 | "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. |
| 4697 | "viewed": True or False, # Whether this file has been viewed by this user. |
| 4698 | }, |
| 4699 | "lastModifyingUser": { # Information about a Drive user. # The last user to modify this file. |
| 4700 | "displayName": "A String", # A plain text displayable name for this user. |
| 4701 | "emailAddress": "A String", # The email address of the user. |
| 4702 | "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. |
| 4703 | "kind": "drive#user", # This is always drive#user. |
| 4704 | "permissionId": "A String", # The user's ID as visible in the permissions collection. |
| 4705 | "picture": { # The user's profile picture. |
| 4706 | "url": "A String", # A URL that points to a profile picture of this user. |
| 4707 | }, |
| 4708 | }, |
| 4709 | "lastModifyingUserName": "A String", # Name of the last user to modify this file. |
| 4710 | "lastViewedByMeDate": "A String", # Last time this file was viewed by the user (formatted RFC 3339 timestamp). |
| 4711 | "markedViewedByMeDate": "A String", # Deprecated. |
| 4712 | "md5Checksum": "A String", # An MD5 checksum for the content of this file. This field is only populated for files with content stored in Google Drive; it is not populated for Google Docs or shortcut files. |
| 4713 | "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. |
| 4714 | "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. |
| 4715 | "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. |
| 4716 | "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. |
| 4717 | "a_key": "A String", |
| 4718 | }, |
| 4719 | "originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the title field. This is only available for files with binary content in Google Drive. |
| 4720 | "ownedByMe": True or False, # Whether the file is owned by the current user. Not populated for items in shared drives. |
| 4721 | "ownerNames": [ # Name(s) of the owner(s) of this file. Not populated for items in shared drives. |
| 4722 | "A String", |
| 4723 | ], |
| 4724 | "owners": [ # The owner(s) of this file. Not populated for items in shared drives. |
| Sai Cheemalapati | df61397 | 2016-10-21 13:59:49 -0700 | [diff] [blame] | 4725 | { # Information about a Drive user. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4726 | "displayName": "A String", # A plain text displayable name for this user. |
| 4727 | "emailAddress": "A String", # The email address of the user. |
| 4728 | "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. |
| 4729 | "kind": "drive#user", # This is always drive#user. |
| 4730 | "permissionId": "A String", # The user's ID as visible in the permissions collection. |
| 4731 | "picture": { # The user's profile picture. |
| 4732 | "url": "A String", # A URL that points to a profile picture of this user. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 4733 | }, |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 4734 | }, |
| 4735 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4736 | "parents": [ # Collection of parent folders which contain this file. |
| 4737 | # If not specified as part of an insert request, the file will be placed directly in the user's My Drive folder. If not specified as part of a copy request, the file will inherit any discoverable parents of the source file. Update requests can also use the addParents and removeParents parameters to modify the parents list. |
| 4738 | { # A reference to a file's parent. |
| 4739 | "id": "A String", # The ID of the parent. |
| 4740 | "isRoot": True or False, # Whether or not the parent is the root folder. |
| 4741 | "kind": "drive#parentReference", # This is always drive#parentReference. |
| 4742 | "parentLink": "A String", # A link to the parent. |
| 4743 | "selfLink": "A String", # A link back to this reference. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 4744 | }, |
| 4745 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4746 | "permissionIds": [ # List of permission IDs for users with access to this file. |
| 4747 | "A String", |
| 4748 | ], |
| 4749 | "permissions": [ # The list of permissions for users with access to this file. Not populated for items in shared drives. |
| 4750 | { # A permission for a file. |
| 4751 | "additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future. |
| 4752 | "A String", |
| 4753 | ], |
| 4754 | "authKey": "A String", # Deprecated. |
| 4755 | "deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions. |
| 4756 | "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. |
| 4757 | "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. |
| 4758 | "etag": "A String", # The ETag of the permission. |
| 4759 | "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: |
| 4760 | # - They cannot be set on shared drive items |
| 4761 | # - They can only be set on user and group permissions |
| 4762 | # - The date must be in the future |
| 4763 | # - The date cannot be more than a year in the future |
| 4764 | # - The date can only be set on drive.permissions.update or drive.permissions.patch requests |
| 4765 | "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. |
| 4766 | "kind": "drive#permission", # This is always drive#permission. |
| 4767 | "name": "A String", # The name for this permission. |
| 4768 | "permissionDetails": [ # Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. |
| 4769 | { |
| 4770 | "additionalRoles": [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future. |
| 4771 | "A String", |
| 4772 | ], |
| 4773 | "inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field. |
| 4774 | "inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field. |
| 4775 | "permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible: |
| 4776 | # - file |
| 4777 | # - member |
| 4778 | "role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible: |
| 4779 | # - organizer |
| 4780 | # - fileOrganizer |
| 4781 | # - writer |
| 4782 | # - reader |
| 4783 | }, |
| 4784 | ], |
| 4785 | "photoLink": "A String", # A link to the profile photo, if available. |
| 4786 | "role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: |
| 4787 | # - owner |
| 4788 | # - organizer |
| 4789 | # - fileOrganizer |
| 4790 | # - writer |
| 4791 | # - reader |
| 4792 | "selfLink": "A String", # A link back to this permission. |
| 4793 | "teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead. |
| 4794 | { |
| 4795 | "additionalRoles": [ # Deprecated - use permissionDetails/additionalRoles instead. |
| 4796 | "A String", |
| 4797 | ], |
| 4798 | "inherited": True or False, # Deprecated - use permissionDetails/inherited instead. |
| 4799 | "inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead. |
| 4800 | "role": "A String", # Deprecated - use permissionDetails/role instead. |
| 4801 | "teamDrivePermissionType": "A String", # Deprecated - use permissionDetails/permissionType instead. |
| 4802 | }, |
| 4803 | ], |
| 4804 | "type": "A String", # The account type. Allowed values are: |
| 4805 | # - user |
| 4806 | # - group |
| 4807 | # - domain |
| 4808 | # - anyone |
| 4809 | "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. |
| 4810 | "withLink": True or False, # Whether the link is required for this permission. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 4811 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4812 | ], |
| 4813 | "properties": [ # The list of properties. |
| Nathaniel Manista | 4f877e5 | 2015-06-15 16:44:50 +0000 | [diff] [blame] | 4814 | { # A key-value pair attached to a file that is either public or private to an application. |
| 4815 | # The following limits apply to file properties: |
| 4816 | # - Maximum of 100 properties total per file |
| 4817 | # - Maximum of 30 private properties per app |
| 4818 | # - Maximum of 30 public properties |
| 4819 | # - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4820 | "etag": "A String", # ETag of the property. |
| 4821 | "key": "A String", # The key of this property. |
| 4822 | "kind": "drive#property", # This is always drive#property. |
| 4823 | "selfLink": "A String", # The link back to this property. |
| 4824 | "value": "A String", # The value of this property. |
| 4825 | "visibility": "A String", # The visibility of this property. Allowed values are PRIVATE and PUBLIC. (Default: PRIVATE) |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 4826 | }, |
| 4827 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4828 | "quotaBytesUsed": "A String", # The number of quota bytes used by this file. |
| 4829 | "selfLink": "A String", # A link back to this file. |
| 4830 | "shareable": True or False, # Deprecated: use capabilities/canShare. |
| 4831 | "shared": True or False, # Whether the file has been shared. Not populated for items in shared drives. |
| 4832 | "sharedWithMeDate": "A String", # Time at which this file was shared with the user (formatted RFC 3339 timestamp). |
| 4833 | "sharingUser": { # Information about a Drive user. # User that shared the item with the current user, if available. |
| 4834 | "displayName": "A String", # A plain text displayable name for this user. |
| 4835 | "emailAddress": "A String", # The email address of the user. |
| 4836 | "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. |
| 4837 | "kind": "drive#user", # This is always drive#user. |
| 4838 | "permissionId": "A String", # The user's ID as visible in the permissions collection. |
| 4839 | "picture": { # The user's profile picture. |
| 4840 | "url": "A String", # A URL that points to a profile picture of this user. |
| 4841 | }, |
| Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 4842 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4843 | "shortcutDetails": { # Shortcut file details. Only populated for shortcut files, which have the mimeType field set to application/vnd.google-apps.shortcut. |
| 4844 | "targetId": "A String", # The ID of the file that this shortcut points to. |
| 4845 | "targetMimeType": "A String", # The MIME type of the file that this shortcut points to. The value of this field is a snapshot of the target's MIME type, captured when the shortcut is created. |
| 4846 | }, |
| 4847 | "spaces": [ # The list of spaces which contain the file. Supported values are 'drive', 'appDataFolder' and 'photos'. |
| 4848 | "A String", |
| 4849 | ], |
| 4850 | "teamDriveId": "A String", # Deprecated - use driveId instead. |
| 4851 | "thumbnail": { # A thumbnail for the file. This will only be used if a standard thumbnail cannot be generated. |
| 4852 | "image": "A String", # The URL-safe Base64 encoded bytes of the thumbnail image. It should conform to RFC 4648 section 5. |
| 4853 | "mimeType": "A String", # The MIME type of the thumbnail. |
| 4854 | }, |
| 4855 | "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. |
| 4856 | "thumbnailVersion": "A String", # The thumbnail version for use in thumbnail cache invalidation. |
| 4857 | "title": "A String", # The title of this file. Note that for immutable items such as the top level folders of shared drives, My Drive root folder, and Application Data folder the title is constant. |
| 4858 | "trashedDate": "A String", # The time that the item was trashed (formatted RFC 3339 timestamp). Only populated for items in shared drives. |
| 4859 | "trashingUser": { # Information about a Drive user. # If the file has been explicitly trashed, the user who trashed it. Only populated for items in shared drives. |
| 4860 | "displayName": "A String", # A plain text displayable name for this user. |
| 4861 | "emailAddress": "A String", # The email address of the user. |
| 4862 | "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. |
| 4863 | "kind": "drive#user", # This is always drive#user. |
| 4864 | "permissionId": "A String", # The user's ID as visible in the permissions collection. |
| 4865 | "picture": { # The user's profile picture. |
| 4866 | "url": "A String", # A URL that points to a profile picture of this user. |
| 4867 | }, |
| 4868 | }, |
| 4869 | "userPermission": { # A permission for a file. # The permissions for the authenticated user on this file. |
| 4870 | "additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future. |
| 4871 | "A String", |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 4872 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4873 | "authKey": "A String", # Deprecated. |
| 4874 | "deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions. |
| 4875 | "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. |
| 4876 | "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. |
| 4877 | "etag": "A String", # The ETag of the permission. |
| 4878 | "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4879 | # - They cannot be set on shared drive items |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 4880 | # - They can only be set on user and group permissions |
| 4881 | # - The date must be in the future |
| 4882 | # - The date cannot be more than a year in the future |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4883 | # - The date can only be set on drive.permissions.update or drive.permissions.patch requests |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4884 | "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. |
| 4885 | "kind": "drive#permission", # This is always drive#permission. |
| 4886 | "name": "A String", # The name for this permission. |
| 4887 | "permissionDetails": [ # Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. |
| 4888 | { |
| 4889 | "additionalRoles": [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future. |
| 4890 | "A String", |
| 4891 | ], |
| 4892 | "inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field. |
| 4893 | "inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field. |
| 4894 | "permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible: |
| 4895 | # - file |
| 4896 | # - member |
| 4897 | "role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible: |
| 4898 | # - organizer |
| 4899 | # - fileOrganizer |
| 4900 | # - writer |
| 4901 | # - reader |
| 4902 | }, |
| 4903 | ], |
| 4904 | "photoLink": "A String", # A link to the profile photo, if available. |
| 4905 | "role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 4906 | # - owner |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4907 | # - organizer |
| 4908 | # - fileOrganizer |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 4909 | # - writer |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4910 | # - reader |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4911 | "selfLink": "A String", # A link back to this permission. |
| 4912 | "teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead. |
| 4913 | { |
| 4914 | "additionalRoles": [ # Deprecated - use permissionDetails/additionalRoles instead. |
| 4915 | "A String", |
| 4916 | ], |
| 4917 | "inherited": True or False, # Deprecated - use permissionDetails/inherited instead. |
| 4918 | "inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead. |
| 4919 | "role": "A String", # Deprecated - use permissionDetails/role instead. |
| 4920 | "teamDrivePermissionType": "A String", # Deprecated - use permissionDetails/permissionType instead. |
| 4921 | }, |
| 4922 | ], |
| 4923 | "type": "A String", # The account type. Allowed values are: |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 4924 | # - user |
| 4925 | # - group |
| 4926 | # - domain |
| 4927 | # - anyone |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4928 | "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. |
| 4929 | "withLink": True or False, # Whether the link is required for this permission. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 4930 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4931 | "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. |
| 4932 | "videoMediaMetadata": { # Metadata about video media. This will only be present for video types. |
| 4933 | "durationMillis": "A String", # The duration of the video in milliseconds. |
| 4934 | "height": 42, # The height of the video in pixels. |
| 4935 | "width": 42, # The width of the video in pixels. |
| 4936 | }, |
| 4937 | "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. |
| 4938 | "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. |
| 4939 | "writersCanShare": True or False, # Whether writers can share the document with other users. Not populated for items in shared drives. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 4940 | }</pre> |
| 4941 | </div> |
| 4942 | |
| 4943 | <div class="method"> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4944 | <code class="details" id="watch">watch(fileId, body=None, acknowledgeAbuse=None, projection=None, revisionId=None, supportsAllDrives=None, supportsTeamDrives=None, updateViewedDate=None)</code> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 4945 | <pre>Subscribe to changes on a file |
| 4946 | |
| 4947 | Args: |
| 4948 | fileId: string, The ID for the file in question. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4949 | body: object, The request body. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 4950 | The object takes the form of: |
| 4951 | |
| 4952 | { # An notification channel used to watch for resource changes. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4953 | "address": "A String", # The address where notifications are delivered for this channel. |
| 4954 | "expiration": "A String", # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional. |
| 4955 | "id": "A String", # A UUID or similar unique string that identifies this channel. |
| 4956 | "kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource, which is "api#channel". |
| 4957 | "params": { # Additional parameters controlling delivery channel behavior. Optional. |
| 4958 | "a_key": "A String", # Declares a new parameter by name. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 4959 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4960 | "payload": True or False, # A Boolean value to indicate whether payload is wanted. Optional. |
| 4961 | "resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions. |
| 4962 | "resourceUri": "A String", # A version-specific identifier for the watched resource. |
| 4963 | "token": "A String", # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional. |
| 4964 | "type": "A String", # The type of delivery mechanism used for this channel. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 4965 | } |
| 4966 | |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4967 | acknowledgeAbuse: boolean, Whether the user is acknowledging the risk of downloading known malware or other abusive files. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 4968 | projection: string, This parameter is deprecated and has no function. |
| 4969 | Allowed values |
| 4970 | BASIC - Deprecated |
| 4971 | FULL - Deprecated |
| Nathaniel Manista | 4f877e5 | 2015-06-15 16:44:50 +0000 | [diff] [blame] | 4972 | revisionId: string, Specifies the Revision ID that should be downloaded. Ignored unless alt=media is specified. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4973 | supportsAllDrives: boolean, Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4974 | supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead. |
| Sai Cheemalapati | df61397 | 2016-10-21 13:59:49 -0700 | [diff] [blame] | 4975 | updateViewedDate: boolean, Deprecated: Use files.update with modifiedDateBehavior=noChange, updateViewedDate=true and an empty request body. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 4976 | |
| 4977 | Returns: |
| 4978 | An object of the form: |
| 4979 | |
| 4980 | { # An notification channel used to watch for resource changes. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4981 | "address": "A String", # The address where notifications are delivered for this channel. |
| 4982 | "expiration": "A String", # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional. |
| 4983 | "id": "A String", # A UUID or similar unique string that identifies this channel. |
| 4984 | "kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource, which is "api#channel". |
| 4985 | "params": { # Additional parameters controlling delivery channel behavior. Optional. |
| 4986 | "a_key": "A String", # Declares a new parameter by name. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 4987 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4988 | "payload": True or False, # A Boolean value to indicate whether payload is wanted. Optional. |
| 4989 | "resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions. |
| 4990 | "resourceUri": "A String", # A version-specific identifier for the watched resource. |
| 4991 | "token": "A String", # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional. |
| 4992 | "type": "A String", # The type of delivery mechanism used for this channel. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 4993 | }</pre> |
| 4994 | </div> |
| 4995 | |
| Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [diff] [blame] | 4996 | <div class="method"> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4997 | <code class="details" id="watch_media">watch_media(fileId, body=None, acknowledgeAbuse=None, projection=None, revisionId=None, supportsAllDrives=None, supportsTeamDrives=None, updateViewedDate=None)</code> |
| Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [diff] [blame] | 4998 | <pre>Subscribe to changes on a file |
| 4999 | |
| 5000 | Args: |
| 5001 | fileId: string, The ID for the file in question. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 5002 | body: object, The request body. |
| Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [diff] [blame] | 5003 | The object takes the form of: |
| 5004 | |
| 5005 | { # An notification channel used to watch for resource changes. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5006 | "address": "A String", # The address where notifications are delivered for this channel. |
| 5007 | "expiration": "A String", # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional. |
| 5008 | "id": "A String", # A UUID or similar unique string that identifies this channel. |
| 5009 | "kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource, which is "api#channel". |
| 5010 | "params": { # Additional parameters controlling delivery channel behavior. Optional. |
| 5011 | "a_key": "A String", # Declares a new parameter by name. |
| Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [diff] [blame] | 5012 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5013 | "payload": True or False, # A Boolean value to indicate whether payload is wanted. Optional. |
| 5014 | "resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions. |
| 5015 | "resourceUri": "A String", # A version-specific identifier for the watched resource. |
| 5016 | "token": "A String", # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional. |
| 5017 | "type": "A String", # The type of delivery mechanism used for this channel. |
| Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [diff] [blame] | 5018 | } |
| 5019 | |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5020 | acknowledgeAbuse: boolean, Whether the user is acknowledging the risk of downloading known malware or other abusive files. |
| Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [diff] [blame] | 5021 | projection: string, This parameter is deprecated and has no function. |
| 5022 | Allowed values |
| 5023 | BASIC - Deprecated |
| 5024 | FULL - Deprecated |
| Nathaniel Manista | 4f877e5 | 2015-06-15 16:44:50 +0000 | [diff] [blame] | 5025 | revisionId: string, Specifies the Revision ID that should be downloaded. Ignored unless alt=media is specified. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 5026 | supportsAllDrives: boolean, Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 5027 | supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead. |
| Sai Cheemalapati | df61397 | 2016-10-21 13:59:49 -0700 | [diff] [blame] | 5028 | updateViewedDate: boolean, Deprecated: Use files.update with modifiedDateBehavior=noChange, updateViewedDate=true and an empty request body. |
| Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [diff] [blame] | 5029 | |
| 5030 | Returns: |
| 5031 | The media object as a string. |
| 5032 | |
| 5033 | </pre> |
| 5034 | </div> |
| 5035 | |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 5036 | </body></html> |