Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / f80be181200f4aae910badec3f4bddea08ae5044 / . / docs / dyn / drive_v2.files.html
blob: f720b58a868a525f6af92a2554bf02ae1263937a [file] [log] [blame]
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1<html><body>
2<style>
3
4body, 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
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, 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">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]78 <code><a href="#copy">copy(fileId, body=None, supportsTeamDrives=None, pinned=None, ocrLanguage=None, ocr=None, visibility=None, timedTextTrackName=None, enforceSingleParent=None, convert=None, supportsAllDrives=None, timedTextLanguage=None)</a></code></p>
John Asmuth614db982014-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 Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]81 <code><a href="#delete">delete(fileId, supportsTeamDrives=None, supportsAllDrives=None)</a></code></p>
82<p class="firstline">Permanently deletes a file by ID. Skips the trash. The currently authenticated user must own the file or be an organizer on the parent for shared drive files.</p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]83<p class="toc_element">
Craig Citro065b5302014-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 Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]87 <code><a href="#export">export(fileId, mimeType)</a></code></p>
Bu Sun Kim715bd7f2019-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 Cheemalapatidf613972016-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 Kim715bd7f2019-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 Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]92<p class="toc_element">
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]93 <code><a href="#generateIds">generateIds(space=None, maxResults=None)</a></code></p>
Dan O'Mearadd494642020-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 Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]95<p class="toc_element">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]96 <code><a href="#get">get(fileId, projection=None, revisionId=None, supportsTeamDrives=None, supportsAllDrives=None, acknowledgeAbuse=None, updateViewedDate=None)</a></code></p>
Craig Citroe633be12015-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 Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]99 <code><a href="#get_media">get_media(fileId, projection=None, revisionId=None, supportsTeamDrives=None, supportsAllDrives=None, acknowledgeAbuse=None, updateViewedDate=None)</a></code></p>
John Asmuth614db982014-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">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]102 <code><a href="#insert">insert(body=None, supportsTeamDrives=None, media_body=None, ocrLanguage=None, ocr=None, pinned=None, visibility=None, timedTextTrackName=None, enforceSingleParent=None, convert=None, useContentAsIndexableText=None, supportsAllDrives=None, media_mime_type=None, timedTextLanguage=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]103<p class="firstline">Insert a new file.</p>
104<p class="toc_element">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]105 <code><a href="#list">list(orderBy=None, projection=None, supportsTeamDrives=None, spaces=None, q=None, pageToken=None, corpus=None, maxResults=None, teamDriveId=None, includeItemsFromAllDrives=None, includeTeamDriveItems=None, corpora=None, supportsAllDrives=None, driveId=None)</a></code></p>
John Asmuth614db982014-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">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]111 <code><a href="#patch">patch(fileId, body=None, supportsTeamDrives=None, newRevision=None, modifiedDateBehavior=None, ocrLanguage=None, pinned=None, ocr=None, addParents=None, removeParents=None, updateViewedDate=None, timedTextTrackName=None, enforceSingleParent=None, convert=None, useContentAsIndexableText=None, supportsAllDrives=None, setModifiedDate=None, timedTextLanguage=None)</a></code></p>
John Asmuth614db982014-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 Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]114 <code><a href="#touch">touch(fileId, supportsTeamDrives=None, supportsAllDrives=None)</a></code></p>
John Asmuth614db982014-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 Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]117 <code><a href="#trash">trash(fileId, supportsTeamDrives=None, supportsAllDrives=None)</a></code></p>
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 Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]119<p class="toc_element">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]120 <code><a href="#untrash">untrash(fileId, supportsTeamDrives=None, supportsAllDrives=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]121<p class="firstline">Restores a file from the trash.</p>
122<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]123 <code><a href="#update">update(fileId, body=None, supportsTeamDrives=None, newRevision=None, modifiedDateBehavior=None, media_body=None, ocrLanguage=None, pinned=None, ocr=None, addParents=None, removeParents=None, updateViewedDate=None, timedTextTrackName=None, enforceSingleParent=None, convert=None, useContentAsIndexableText=None, supportsAllDrives=None, media_mime_type=None, setModifiedDate=None, timedTextLanguage=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]124<p class="firstline">Updates file metadata and/or content.</p>
125<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]126 <code><a href="#watch">watch(fileId, body=None, projection=None, revisionId=None, supportsTeamDrives=None, supportsAllDrives=None, acknowledgeAbuse=None, updateViewedDate=None)</a></code></p>
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]127<p class="firstline">Subscribe to changes on a file</p>
128<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]129 <code><a href="#watch_media">watch_media(fileId, body=None, projection=None, revisionId=None, supportsTeamDrives=None, supportsAllDrives=None, acknowledgeAbuse=None, updateViewedDate=None)</a></code></p>
John Asmuth614db982014-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">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]133 <code class="details" id="copy">copy(fileId, body=None, supportsTeamDrives=None, pinned=None, ocrLanguage=None, ocr=None, visibility=None, timedTextTrackName=None, enforceSingleParent=None, convert=None, supportsAllDrives=None, timedTextLanguage=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]134 <pre>Creates a copy of the specified file.
135
136Args:
137 fileId: string, The ID of the file to copy. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]138 body: object, The request body.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]139 The object takes the form of:
140
141{ # The metadata for a file.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]142 "hasThumbnail": True or False, # Whether this file has a thumbnail. This does not indicate whether the requesting app has access to the thumbnail. To check access, look for the presence of the thumbnailLink field.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]143 "lastViewedByMeDate": "A String", # Last time this file was viewed by the user (formatted RFC 3339 timestamp).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]144 "trashedDate": "A String", # The time that the item was trashed (formatted RFC 3339 timestamp). Only populated for items in shared drives.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]145 "version": "A String", # A monotonically increasing version number for the file. This reflects every change made to the file on the server, even those not visible to the requesting user.
146 "appDataContents": True or False, # Whether this file is in the Application Data folder.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]147 "thumbnailLink": "A String", # A short-lived link to the file's thumbnail. Typically lasts on the order of hours. Only populated when the requesting app can access the file's content.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]148 "labels": { # A group of labels for the file.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]149 "restricted": True or False, # Deprecated - use copyRequiresWriterPermission instead.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]150 "modified": True or False, # Whether the file has been modified by this user.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]151 "trashed": True or False, # Whether this file has been trashed. This label applies to all users accessing the file; however, only owners are allowed to see and untrash files.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]152 "hidden": True or False, # Deprecated.
153 "starred": True or False, # Whether this file is starred by the user.
154 "viewed": True or False, # Whether this file has been viewed by this user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]155 },
156 "indexableText": { # Indexable text attributes for the file (can only be written)
157 "text": "A String", # The text to be indexed for this file.
158 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]159 "thumbnailVersion": "A String", # The thumbnail version for use in thumbnail cache invalidation.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]160 "explicitlyTrashed": True or False, # Whether this file has been explicitly trashed, as opposed to recursively trashed.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]161 "isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]162 "lastModifyingUserName": "A String", # Name of the last user to modify this file.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]163 "writersCanShare": True or False, # Whether writers can share the document with other users. Not populated for items in shared drives.
164 "owners": [ # The owner(s) of this file. Not populated for items in shared drives.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]165 { # Information about a Drive user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]166 "picture": { # The user's profile picture.
167 "url": "A String", # A URL that points to a profile picture of this user.
168 },
169 "kind": "drive#user", # This is always drive#user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]170 "displayName": "A String", # A plain text displayable name for this user.
171 "permissionId": "A String", # The user's ID as visible in the permissions collection.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]172 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
173 "emailAddress": "A String", # The email address of the user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]174 },
175 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]176 "ownedByMe": True or False, # Whether the file is owned by the current user. Not populated for items in shared drives.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]177 "id": "A String", # The ID of the file.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]178 "sharingUser": { # Information about a Drive user. # User that shared the item with the current user, if available.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]179 "picture": { # The user's profile picture.
180 "url": "A String", # A URL that points to a profile picture of this user.
181 },
182 "kind": "drive#user", # This is always drive#user.
183 "displayName": "A String", # A plain text displayable name for this user.
184 "permissionId": "A String", # The user's ID as visible in the permissions collection.
185 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
186 "emailAddress": "A String", # The email address of the user.
187 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]188 "shortcutDetails": { # Shortcut file details. Only populated for shortcut files, which have the mimeType field set to application/vnd.google-apps.shortcut.
189 "targetId": "A String", # The ID of the file that this shortcut points to.
190 "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.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]191 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]192 "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.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]193 "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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]194 "lastModifyingUser": { # Information about a Drive user. # The last user to modify this file.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]195 "picture": { # The user's profile picture.
196 "url": "A String", # A URL that points to a profile picture of this user.
197 },
198 "kind": "drive#user", # This is always drive#user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]199 "displayName": "A String", # A plain text displayable name for this user.
200 "permissionId": "A String", # The user's ID as visible in the permissions collection.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]201 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
202 "emailAddress": "A String", # The email address of the user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]203 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]204 "copyable": True or False, # Deprecated: use capabilities/canCopy.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]205 "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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]206 "markedViewedByMeDate": "A String", # Deprecated.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]207 "ownerNames": [ # Name(s) of the owner(s) of this file. Not populated for items in shared drives.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]208 "A String",
209 ],
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]210 "capabilities": { # Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]211 "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.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]212 "canUntrash": True or False, # Whether the current user can restore this file from trash.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]213 "canMoveItemWithinTeamDrive": True or False, # Deprecated - use canMoveItemWithinDrive instead.
214 "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.
215 "canMoveChildrenWithinTeamDrive": True or False, # Deprecated - use canMoveChildrenWithinDrive instead.
216 "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.
217 "canRename": True or False, # Whether the current user can rename this file.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]218 "canModifyContent": True or False, # Whether the current user can modify the content of this file.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]219 "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.
220 "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.
221 "canChangeRestrictedDownload": True or False, # Deprecated
222 "canShare": True or False, # Whether the current user can modify the sharing settings for this file.
223 "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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]224 "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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]225 "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.
226 "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.
227 "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.
228 "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.
229 "canMoveItemIntoTeamDrive": True or False, # Deprecated - use canMoveItemOutOfDrive instead.
230 "canMoveItemOutOfTeamDrive": True or False, # Deprecated - use canMoveItemOutOfDrive instead.
231 "canComment": True or False, # Whether the current user can comment on this file.
232 "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.
233 "canTrash": True or False, # Whether the current user can move this file to trash.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]234 "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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]235 "canDelete": True or False, # Whether the current user can delete this file.
236 "canMoveTeamDriveItem": True or False, # Deprecated - use canMoveItemWithinDrive or canMoveItemOutOfDrive instead.
237 "canDownload": True or False, # Whether the current user can download this file.
238 "canChangeCopyRequiresWriterPermission": True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this file.
239 "canMoveChildrenOutOfTeamDrive": True or False, # Deprecated - use canMoveChildrenOutOfDrive instead.
240 "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.
241 "canReadTeamDrive": True or False, # Deprecated - use canReadDrive instead.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]242 "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.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]243 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]244 "sharedWithMeDate": "A String", # Time at which this file was shared with the user (formatted RFC 3339 timestamp).
245 "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.
246 "etag": "A String", # ETag of the file.
247 "parents": [ # Collection of parent folders which contain this file.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]248 # 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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]249 { # A reference to a file's parent.
250 "selfLink": "A String", # A link back to this reference.
251 "kind": "drive#parentReference", # This is always drive#parentReference.
252 "id": "A String", # The ID of the parent.
253 "isRoot": True or False, # Whether or not the parent is the root folder.
254 "parentLink": "A String", # A link to the parent.
255 },
256 ],
257 "exportLinks": { # Links for exporting Google Docs to specific formats.
258 "a_key": "A String", # A mapping from export format to URL
259 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]260 "shareable": True or False, # Deprecated: use capabilities/canShare.
261 "copyRequiresWriterPermission": True or False, # Whether the options to copy, print, or download this file, should be disabled for readers and commenters.
262 "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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]263 "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.
264 "a_key": "A String",
265 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]266 "canReadRevisions": True or False, # Deprecated: use capabilities/canReadRevisions.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]267 "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.
268 "exposureBias": 3.14, # The exposure bias of the photo (APEX value).
269 "exposureTime": 3.14, # The length of the exposure, in seconds.
270 "cameraMake": "A String", # The make of the camera used to create the photo.
271 "maxApertureValue": 3.14, # The smallest f-number of the lens at the focal length used to create the photo (APEX value).
272 "isoSpeed": 42, # The ISO speed used to create the photo.
273 "focalLength": 3.14, # The focal length used to create the photo, in millimeters.
274 "exposureMode": "A String", # The exposure mode used to create the photo.
275 "colorSpace": "A String", # The color space of the photo.
276 "location": { # Geographic location information stored in the image.
277 "latitude": 3.14, # The latitude stored in the image.
278 "altitude": 3.14, # The altitude stored in the image.
279 "longitude": 3.14, # The longitude stored in the image.
280 },
281 "subjectDistance": 42, # The distance to the subject of the photo, in meters.
282 "height": 42, # The height of the image in pixels.
283 "lens": "A String", # The lens used to create the photo.
284 "date": "A String", # The date and time the photo was taken (EXIF format timestamp).
285 "width": 42, # The width of the image in pixels.
286 "meteringMode": "A String", # The metering mode used to create the photo.
287 "flashUsed": True or False, # Whether a flash was used to create the photo.
288 "aperture": 3.14, # The aperture used to create the photo (f-number).
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]289 "rotation": 42, # The number of clockwise 90 degree rotations applied from the image's original orientation.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]290 "sensor": "A String", # The type of sensor used to create the photo.
291 "whiteBalance": "A String", # The white balance mode used to create the photo.
292 "cameraModel": "A String", # The model of the camera used to create the photo.
293 },
294 "description": "A String", # A short description of the file.
295 "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.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]296 "videoMediaMetadata": { # Metadata about video media. This will only be present for video types.
297 "width": 42, # The width of the video in pixels.
298 "durationMillis": "A String", # The duration of the video in milliseconds.
299 "height": 42, # The height of the video in pixels.
300 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]301 "editable": True or False, # Deprecated: use capabilities/canEdit.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]302 "kind": "drive#file", # The type of file. This is always drive#file.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]303 "canComment": True or False, # Deprecated: use capabilities/canComment.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]304 "quotaBytesUsed": "A String", # The number of quota bytes used by this file.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]305 "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.
306 "picture": { # The user's profile picture.
307 "url": "A String", # A URL that points to a profile picture of this user.
308 },
309 "kind": "drive#user", # This is always drive#user.
310 "displayName": "A String", # A plain text displayable name for this user.
311 "permissionId": "A String", # The user's ID as visible in the permissions collection.
312 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
313 "emailAddress": "A String", # The email address of the user.
314 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]315 "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.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]316 "createdDate": "A String", # Create time for this file (formatted RFC 3339 timestamp).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]317 "teamDriveId": "A String", # Deprecated - use driveId instead.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]318 "properties": [ # The list of properties.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]319 { # A key-value pair attached to a file that is either public or private to an application.
320 # The following limits apply to file properties:
321 # - Maximum of 100 properties total per file
322 # - Maximum of 30 private properties per app
323 # - Maximum of 30 public properties
324 # - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]325 "kind": "drive#property", # This is always drive#property.
326 "value": "A String", # The value of this property.
327 "etag": "A String", # ETag of the property.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]328 "visibility": "A String", # The visibility of this property. Allowed values are PRIVATE and PUBLIC. (Default: PRIVATE)
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]329 "key": "A String", # The key of this property.
330 "selfLink": "A String", # The link back to this property.
331 },
332 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]333 "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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]334 "iconLink": "A String", # A link to the file's icon.
335 "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.
336 "embedLink": "A String", # A link for embedding the file.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]337 "alternateLink": "A String", # A link for opening the file in a relevant Google editor or viewer.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]338 "shared": True or False, # Whether the file has been shared. Not populated for items in shared drives.
339 "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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]340 "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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]341 "thumbnail": { # A thumbnail for the file. This will only be used if a standard thumbnail cannot be generated.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]342 "mimeType": "A String", # The MIME type of the thumbnail.
343 "image": "A String", # The URL-safe Base64 encoded bytes of the thumbnail image. It should conform to RFC 4648 section 5.
344 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]345 "driveId": "A String", # ID of the shared drive the file resides in. Only populated for items in shared drives.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]346 "userPermission": { # A permission for a file. # The permissions for the authenticated user on this file.
347 "withLink": True or False, # Whether the link is required for this permission.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]348 "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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]349 "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.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]350 {
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]351 "role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible:
352 # - organizer
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]353 # - fileOrganizer
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]354 # - writer
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]355 # - reader
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]356 "inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]357 "permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible:
358 # - file
359 # - member
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]360 "additionalRoles": [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future.
361 "A String",
362 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]363 "inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field.
364 },
365 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]366 "name": "A String", # The name for this permission.
367 "teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead.
368 {
369 "inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead.
370 "role": "A String", # Deprecated - use permissionDetails/role instead.
371 "additionalRoles": [ # Deprecated - use permissionDetails/additionalRoles instead.
372 "A String",
373 ],
374 "teamDrivePermissionType": "A String", # Deprecated - use permissionDetails/permissionType instead.
375 "inherited": True or False, # Deprecated - use permissionDetails/inherited instead.
376 },
377 ],
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]378 "deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]379 "kind": "drive#permission", # This is always drive#permission.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]380 "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.
381 "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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]382 "authKey": "A String", # Deprecated.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]383 "etag": "A String", # The ETag of the permission.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]384 "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.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]385 "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]386 # - They cannot be set on shared drive items
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]387 # - They can only be set on user and group permissions
388 # - The date must be in the future
389 # - The date cannot be more than a year in the future
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]390 # - The date can only be set on drive.permissions.update or drive.permissions.patch requests
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]391 "role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed:
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]392 # - owner
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]393 # - organizer
394 # - fileOrganizer
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]395 # - writer
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]396 # - reader
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]397 "type": "A String", # The account type. Allowed values are:
398 # - user
399 # - group
400 # - domain
401 # - anyone
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]402 "additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]403 "A String",
404 ],
405 "selfLink": "A String", # A link back to this permission.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]406 "photoLink": "A String", # A link to the profile photo, if available.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]407 },
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]408 "spaces": [ # The list of spaces which contain the file. Supported values are 'drive', 'appDataFolder' and 'photos'.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]409 "A String",
410 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]411 "permissionIds": [ # List of permission IDs for users with access to this file.
412 "A String",
413 ],
414 "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.
415 "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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]416 "hasAugmentedPermissions": True or False, # Whether there are permissions directly on this file. This field is only populated for items in shared drives.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]417 "permissions": [ # The list of permissions for users with access to this file. Not populated for items in shared drives.
418 { # A permission for a file.
419 "withLink": True or False, # Whether the link is required for this permission.
420 "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.
421 "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.
422 {
423 "role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible:
424 # - organizer
425 # - fileOrganizer
426 # - writer
427 # - reader
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]428 "inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]429 "permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible:
430 # - file
431 # - member
432 "additionalRoles": [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future.
433 "A String",
434 ],
435 "inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field.
436 },
437 ],
438 "name": "A String", # The name for this permission.
439 "teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead.
440 {
441 "inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead.
442 "role": "A String", # Deprecated - use permissionDetails/role instead.
443 "additionalRoles": [ # Deprecated - use permissionDetails/additionalRoles instead.
444 "A String",
445 ],
446 "teamDrivePermissionType": "A String", # Deprecated - use permissionDetails/permissionType instead.
447 "inherited": True or False, # Deprecated - use permissionDetails/inherited instead.
448 },
449 ],
450 "deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.
451 "kind": "drive#permission", # This is always drive#permission.
452 "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.
453 "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.
454 "authKey": "A String", # Deprecated.
455 "etag": "A String", # The ETag of the permission.
456 "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.
457 "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]458 # - They cannot be set on shared drive items
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]459 # - They can only be set on user and group permissions
460 # - The date must be in the future
461 # - The date cannot be more than a year in the future
462 # - The date can only be set on drive.permissions.update or drive.permissions.patch requests
463 "role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed:
464 # - owner
465 # - organizer
466 # - fileOrganizer
467 # - writer
468 # - reader
469 "type": "A String", # The account type. Allowed values are:
470 # - user
471 # - group
472 # - domain
473 # - anyone
474 "additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future.
475 "A String",
476 ],
477 "selfLink": "A String", # A link back to this permission.
478 "photoLink": "A String", # A link to the profile photo, if available.
479 },
480 ],
481 "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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]482 "selfLink": "A String", # A link back to this file.
483 "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.
484}
485
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]486 supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]487 pinned: boolean, Whether to pin the head revision of the new copy. A file can have a maximum of 200 pinned revisions.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]488 ocrLanguage: string, If ocr is true, hints at the language to use. Valid values are BCP 47 codes.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]489 ocr: boolean, Whether to attempt OCR on .jpg, .png, .gif, or .pdf uploads.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]490 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.
491 Allowed values
492 DEFAULT - The visibility of the new file is determined by the user's default visibility/sharing policies.
493 PRIVATE - The new file will be visible to only the owner.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]494 timedTextTrackName: string, The timed text track name.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]495 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 Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]496 convert: boolean, Whether to convert this file to the corresponding Google Docs format.
497 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.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]498 timedTextLanguage: string, The language of the timed text.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]499
500Returns:
501 An object of the form:
502
503 { # The metadata for a file.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]504 "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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]505 "lastViewedByMeDate": "A String", # Last time this file was viewed by the user (formatted RFC 3339 timestamp).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]506 "trashedDate": "A String", # The time that the item was trashed (formatted RFC 3339 timestamp). Only populated for items in shared drives.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]507 "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.
508 "appDataContents": True or False, # Whether this file is in the Application Data folder.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]509 "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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]510 "labels": { # A group of labels for the file.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]511 "restricted": True or False, # Deprecated - use copyRequiresWriterPermission instead.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]512 "modified": True or False, # Whether the file has been modified by this user.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]513 "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.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]514 "hidden": True or False, # Deprecated.
515 "starred": True or False, # Whether this file is starred by the user.
516 "viewed": True or False, # Whether this file has been viewed by this user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]517 },
518 "indexableText": { # Indexable text attributes for the file (can only be written)
519 "text": "A String", # The text to be indexed for this file.
520 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]521 "thumbnailVersion": "A String", # The thumbnail version for use in thumbnail cache invalidation.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]522 "explicitlyTrashed": True or False, # Whether this file has been explicitly trashed, as opposed to recursively trashed.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]523 "isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]524 "lastModifyingUserName": "A String", # Name of the last user to modify this file.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]525 "writersCanShare": True or False, # Whether writers can share the document with other users. Not populated for items in shared drives.
526 "owners": [ # The owner(s) of this file. Not populated for items in shared drives.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]527 { # Information about a Drive user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]528 "picture": { # The user's profile picture.
529 "url": "A String", # A URL that points to a profile picture of this user.
530 },
531 "kind": "drive#user", # This is always drive#user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]532 "displayName": "A String", # A plain text displayable name for this user.
533 "permissionId": "A String", # The user's ID as visible in the permissions collection.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]534 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
535 "emailAddress": "A String", # The email address of the user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]536 },
537 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]538 "ownedByMe": True or False, # Whether the file is owned by the current user. Not populated for items in shared drives.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]539 "id": "A String", # The ID of the file.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]540 "sharingUser": { # Information about a Drive user. # User that shared the item with the current user, if available.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]541 "picture": { # The user's profile picture.
542 "url": "A String", # A URL that points to a profile picture of this user.
543 },
544 "kind": "drive#user", # This is always drive#user.
545 "displayName": "A String", # A plain text displayable name for this user.
546 "permissionId": "A String", # The user's ID as visible in the permissions collection.
547 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
548 "emailAddress": "A String", # The email address of the user.
549 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]550 "shortcutDetails": { # Shortcut file details. Only populated for shortcut files, which have the mimeType field set to application/vnd.google-apps.shortcut.
551 "targetId": "A String", # The ID of the file that this shortcut points to.
552 "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.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]553 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]554 "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.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]555 "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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]556 "lastModifyingUser": { # Information about a Drive user. # The last user to modify this file.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]557 "picture": { # The user's profile picture.
558 "url": "A String", # A URL that points to a profile picture of this user.
559 },
560 "kind": "drive#user", # This is always drive#user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]561 "displayName": "A String", # A plain text displayable name for this user.
562 "permissionId": "A String", # The user's ID as visible in the permissions collection.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]563 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
564 "emailAddress": "A String", # The email address of the user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]565 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]566 "copyable": True or False, # Deprecated: use capabilities/canCopy.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]567 "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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]568 "markedViewedByMeDate": "A String", # Deprecated.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]569 "ownerNames": [ # Name(s) of the owner(s) of this file. Not populated for items in shared drives.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]570 "A String",
571 ],
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]572 "capabilities": { # Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]573 "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.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]574 "canUntrash": True or False, # Whether the current user can restore this file from trash.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]575 "canMoveItemWithinTeamDrive": True or False, # Deprecated - use canMoveItemWithinDrive instead.
576 "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.
577 "canMoveChildrenWithinTeamDrive": True or False, # Deprecated - use canMoveChildrenWithinDrive instead.
578 "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.
579 "canRename": True or False, # Whether the current user can rename this file.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]580 "canModifyContent": True or False, # Whether the current user can modify the content of this file.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]581 "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.
582 "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.
583 "canChangeRestrictedDownload": True or False, # Deprecated
584 "canShare": True or False, # Whether the current user can modify the sharing settings for this file.
585 "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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]586 "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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]587 "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.
588 "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.
589 "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.
590 "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.
591 "canMoveItemIntoTeamDrive": True or False, # Deprecated - use canMoveItemOutOfDrive instead.
592 "canMoveItemOutOfTeamDrive": True or False, # Deprecated - use canMoveItemOutOfDrive instead.
593 "canComment": True or False, # Whether the current user can comment on this file.
594 "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.
595 "canTrash": True or False, # Whether the current user can move this file to trash.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]596 "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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]597 "canDelete": True or False, # Whether the current user can delete this file.
598 "canMoveTeamDriveItem": True or False, # Deprecated - use canMoveItemWithinDrive or canMoveItemOutOfDrive instead.
599 "canDownload": True or False, # Whether the current user can download this file.
600 "canChangeCopyRequiresWriterPermission": True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this file.
601 "canMoveChildrenOutOfTeamDrive": True or False, # Deprecated - use canMoveChildrenOutOfDrive instead.
602 "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.
603 "canReadTeamDrive": True or False, # Deprecated - use canReadDrive instead.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]604 "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.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]605 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]606 "sharedWithMeDate": "A String", # Time at which this file was shared with the user (formatted RFC 3339 timestamp).
607 "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.
608 "etag": "A String", # ETag of the file.
609 "parents": [ # Collection of parent folders which contain this file.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]610 # 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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]611 { # A reference to a file's parent.
612 "selfLink": "A String", # A link back to this reference.
613 "kind": "drive#parentReference", # This is always drive#parentReference.
614 "id": "A String", # The ID of the parent.
615 "isRoot": True or False, # Whether or not the parent is the root folder.
616 "parentLink": "A String", # A link to the parent.
617 },
618 ],
619 "exportLinks": { # Links for exporting Google Docs to specific formats.
620 "a_key": "A String", # A mapping from export format to URL
621 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]622 "shareable": True or False, # Deprecated: use capabilities/canShare.
623 "copyRequiresWriterPermission": True or False, # Whether the options to copy, print, or download this file, should be disabled for readers and commenters.
624 "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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]625 "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.
626 "a_key": "A String",
627 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]628 "canReadRevisions": True or False, # Deprecated: use capabilities/canReadRevisions.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]629 "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.
630 "exposureBias": 3.14, # The exposure bias of the photo (APEX value).
631 "exposureTime": 3.14, # The length of the exposure, in seconds.
632 "cameraMake": "A String", # The make of the camera used to create the photo.
633 "maxApertureValue": 3.14, # The smallest f-number of the lens at the focal length used to create the photo (APEX value).
634 "isoSpeed": 42, # The ISO speed used to create the photo.
635 "focalLength": 3.14, # The focal length used to create the photo, in millimeters.
636 "exposureMode": "A String", # The exposure mode used to create the photo.
637 "colorSpace": "A String", # The color space of the photo.
638 "location": { # Geographic location information stored in the image.
639 "latitude": 3.14, # The latitude stored in the image.
640 "altitude": 3.14, # The altitude stored in the image.
641 "longitude": 3.14, # The longitude stored in the image.
642 },
643 "subjectDistance": 42, # The distance to the subject of the photo, in meters.
644 "height": 42, # The height of the image in pixels.
645 "lens": "A String", # The lens used to create the photo.
646 "date": "A String", # The date and time the photo was taken (EXIF format timestamp).
647 "width": 42, # The width of the image in pixels.
648 "meteringMode": "A String", # The metering mode used to create the photo.
649 "flashUsed": True or False, # Whether a flash was used to create the photo.
650 "aperture": 3.14, # The aperture used to create the photo (f-number).
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]651 "rotation": 42, # The number of clockwise 90 degree rotations applied from the image's original orientation.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]652 "sensor": "A String", # The type of sensor used to create the photo.
653 "whiteBalance": "A String", # The white balance mode used to create the photo.
654 "cameraModel": "A String", # The model of the camera used to create the photo.
655 },
656 "description": "A String", # A short description of the file.
657 "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.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]658 "videoMediaMetadata": { # Metadata about video media. This will only be present for video types.
659 "width": 42, # The width of the video in pixels.
660 "durationMillis": "A String", # The duration of the video in milliseconds.
661 "height": 42, # The height of the video in pixels.
662 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]663 "editable": True or False, # Deprecated: use capabilities/canEdit.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]664 "kind": "drive#file", # The type of file. This is always drive#file.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]665 "canComment": True or False, # Deprecated: use capabilities/canComment.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]666 "quotaBytesUsed": "A String", # The number of quota bytes used by this file.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]667 "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.
668 "picture": { # The user's profile picture.
669 "url": "A String", # A URL that points to a profile picture of this user.
670 },
671 "kind": "drive#user", # This is always drive#user.
672 "displayName": "A String", # A plain text displayable name for this user.
673 "permissionId": "A String", # The user's ID as visible in the permissions collection.
674 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
675 "emailAddress": "A String", # The email address of the user.
676 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]677 "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.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]678 "createdDate": "A String", # Create time for this file (formatted RFC 3339 timestamp).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]679 "teamDriveId": "A String", # Deprecated - use driveId instead.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]680 "properties": [ # The list of properties.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]681 { # A key-value pair attached to a file that is either public or private to an application.
682 # The following limits apply to file properties:
683 # - Maximum of 100 properties total per file
684 # - Maximum of 30 private properties per app
685 # - Maximum of 30 public properties
686 # - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]687 "kind": "drive#property", # This is always drive#property.
688 "value": "A String", # The value of this property.
689 "etag": "A String", # ETag of the property.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]690 "visibility": "A String", # The visibility of this property. Allowed values are PRIVATE and PUBLIC. (Default: PRIVATE)
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]691 "key": "A String", # The key of this property.
692 "selfLink": "A String", # The link back to this property.
693 },
694 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]695 "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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]696 "iconLink": "A String", # A link to the file's icon.
697 "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.
698 "embedLink": "A String", # A link for embedding the file.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]699 "alternateLink": "A String", # A link for opening the file in a relevant Google editor or viewer.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]700 "shared": True or False, # Whether the file has been shared. Not populated for items in shared drives.
701 "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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]702 "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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]703 "thumbnail": { # A thumbnail for the file. This will only be used if a standard thumbnail cannot be generated.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]704 "mimeType": "A String", # The MIME type of the thumbnail.
705 "image": "A String", # The URL-safe Base64 encoded bytes of the thumbnail image. It should conform to RFC 4648 section 5.
706 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]707 "driveId": "A String", # ID of the shared drive the file resides in. Only populated for items in shared drives.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]708 "userPermission": { # A permission for a file. # The permissions for the authenticated user on this file.
709 "withLink": True or False, # Whether the link is required for this permission.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]710 "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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]711 "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.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]712 {
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]713 "role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible:
714 # - organizer
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]715 # - fileOrganizer
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]716 # - writer
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]717 # - reader
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]718 "inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]719 "permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible:
720 # - file
721 # - member
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]722 "additionalRoles": [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future.
723 "A String",
724 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]725 "inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field.
726 },
727 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]728 "name": "A String", # The name for this permission.
729 "teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead.
730 {
731 "inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead.
732 "role": "A String", # Deprecated - use permissionDetails/role instead.
733 "additionalRoles": [ # Deprecated - use permissionDetails/additionalRoles instead.
734 "A String",
735 ],
736 "teamDrivePermissionType": "A String", # Deprecated - use permissionDetails/permissionType instead.
737 "inherited": True or False, # Deprecated - use permissionDetails/inherited instead.
738 },
739 ],
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]740 "deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]741 "kind": "drive#permission", # This is always drive#permission.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]742 "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.
743 "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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]744 "authKey": "A String", # Deprecated.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]745 "etag": "A String", # The ETag of the permission.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]746 "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.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]747 "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]748 # - They cannot be set on shared drive items
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]749 # - They can only be set on user and group permissions
750 # - The date must be in the future
751 # - The date cannot be more than a year in the future
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]752 # - The date can only be set on drive.permissions.update or drive.permissions.patch requests
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]753 "role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed:
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]754 # - owner
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]755 # - organizer
756 # - fileOrganizer
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]757 # - writer
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]758 # - reader
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]759 "type": "A String", # The account type. Allowed values are:
760 # - user
761 # - group
762 # - domain
763 # - anyone
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]764 "additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]765 "A String",
766 ],
767 "selfLink": "A String", # A link back to this permission.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]768 "photoLink": "A String", # A link to the profile photo, if available.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]769 },
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]770 "spaces": [ # The list of spaces which contain the file. Supported values are 'drive', 'appDataFolder' and 'photos'.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]771 "A String",
772 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]773 "permissionIds": [ # List of permission IDs for users with access to this file.
774 "A String",
775 ],
776 "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.
777 "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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]778 "hasAugmentedPermissions": True or False, # Whether there are permissions directly on this file. This field is only populated for items in shared drives.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]779 "permissions": [ # The list of permissions for users with access to this file. Not populated for items in shared drives.
780 { # A permission for a file.
781 "withLink": True or False, # Whether the link is required for this permission.
782 "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.
783 "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.
784 {
785 "role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible:
786 # - organizer
787 # - fileOrganizer
788 # - writer
789 # - reader
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]790 "inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]791 "permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible:
792 # - file
793 # - member
794 "additionalRoles": [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future.
795 "A String",
796 ],
797 "inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field.
798 },
799 ],
800 "name": "A String", # The name for this permission.
801 "teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead.
802 {
803 "inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead.
804 "role": "A String", # Deprecated - use permissionDetails/role instead.
805 "additionalRoles": [ # Deprecated - use permissionDetails/additionalRoles instead.
806 "A String",
807 ],
808 "teamDrivePermissionType": "A String", # Deprecated - use permissionDetails/permissionType instead.
809 "inherited": True or False, # Deprecated - use permissionDetails/inherited instead.
810 },
811 ],
812 "deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.
813 "kind": "drive#permission", # This is always drive#permission.
814 "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.
815 "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.
816 "authKey": "A String", # Deprecated.
817 "etag": "A String", # The ETag of the permission.
818 "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.
819 "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]820 # - They cannot be set on shared drive items
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]821 # - They can only be set on user and group permissions
822 # - The date must be in the future
823 # - The date cannot be more than a year in the future
824 # - The date can only be set on drive.permissions.update or drive.permissions.patch requests
825 "role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed:
826 # - owner
827 # - organizer
828 # - fileOrganizer
829 # - writer
830 # - reader
831 "type": "A String", # The account type. Allowed values are:
832 # - user
833 # - group
834 # - domain
835 # - anyone
836 "additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future.
837 "A String",
838 ],
839 "selfLink": "A String", # A link back to this permission.
840 "photoLink": "A String", # A link to the profile photo, if available.
841 },
842 ],
843 "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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]844 "selfLink": "A String", # A link back to this file.
845 "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.
846 }</pre>
847</div>
848
849<div class="method">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]850 <code class="details" id="delete">delete(fileId, supportsTeamDrives=None, supportsAllDrives=None)</code>
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 Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]852
853Args:
854 fileId: string, The ID of the file to delete. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]855 supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead.
856 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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]857</pre>
858</div>
859
860<div class="method">
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]861 <code class="details" id="emptyTrash">emptyTrash()</code>
862 <pre>Permanently deletes all of the user's trashed files.
863
864Args:
865</pre>
866</div>
867
868<div class="method">
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]869 <code class="details" id="export">export(fileId, mimeType)</code>
Bu Sun Kim715bd7f2019-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 Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]871
872Args:
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 Kim715bd7f2019-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 Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]881
882Args:
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">
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]889 <code class="details" id="generateIds">generateIds(space=None, maxResults=None)</code>
Dan O'Mearadd494642020-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 Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]891
892Args:
893 space: string, The space in which the IDs can be used to create new files. Supported values are 'drive' and 'appDataFolder'.
894 maxResults: integer, Maximum number of IDs to return.
895
896Returns:
897 An object of the form:
898
899 { # A list of generated IDs which can be provided in insert requests
900 "kind": "drive#generatedIds", # This is always drive#generatedIds
901 "ids": [ # The IDs generated for the requesting user in the specified space.
902 "A String",
903 ],
904 "space": "A String", # The type of file that can be created with these IDs.
905 }</pre>
906</div>
907
908<div class="method">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]909 <code class="details" id="get">get(fileId, projection=None, revisionId=None, supportsTeamDrives=None, supportsAllDrives=None, acknowledgeAbuse=None, updateViewedDate=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]910 <pre>Gets a file's metadata by ID.
911
912Args:
913 fileId: string, The ID for the file in question. (required)
914 projection: string, This parameter is deprecated and has no function.
915 Allowed values
916 BASIC - Deprecated
917 FULL - Deprecated
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]918 revisionId: string, Specifies the Revision ID that should be downloaded. Ignored unless alt=media is specified.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]919 supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead.
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.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]921 acknowledgeAbuse: boolean, Whether the user is acknowledging the risk of downloading known malware or other abusive files.
Sai Cheemalapatidf613972016-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 Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]923
924Returns:
925 An object of the form:
926
927 { # The metadata for a file.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]928 "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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]929 "lastViewedByMeDate": "A String", # Last time this file was viewed by the user (formatted RFC 3339 timestamp).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]930 "trashedDate": "A String", # The time that the item was trashed (formatted RFC 3339 timestamp). Only populated for items in shared drives.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]931 "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.
932 "appDataContents": True or False, # Whether this file is in the Application Data folder.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]933 "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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]934 "labels": { # A group of labels for the file.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]935 "restricted": True or False, # Deprecated - use copyRequiresWriterPermission instead.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]936 "modified": True or False, # Whether the file has been modified by this user.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]937 "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.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]938 "hidden": True or False, # Deprecated.
939 "starred": True or False, # Whether this file is starred by the user.
940 "viewed": True or False, # Whether this file has been viewed by this user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]941 },
942 "indexableText": { # Indexable text attributes for the file (can only be written)
943 "text": "A String", # The text to be indexed for this file.
944 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]945 "thumbnailVersion": "A String", # The thumbnail version for use in thumbnail cache invalidation.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]946 "explicitlyTrashed": True or False, # Whether this file has been explicitly trashed, as opposed to recursively trashed.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]947 "isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]948 "lastModifyingUserName": "A String", # Name of the last user to modify this file.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]949 "writersCanShare": True or False, # Whether writers can share the document with other users. Not populated for items in shared drives.
950 "owners": [ # The owner(s) of this file. Not populated for items in shared drives.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]951 { # Information about a Drive user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]952 "picture": { # The user's profile picture.
953 "url": "A String", # A URL that points to a profile picture of this user.
954 },
955 "kind": "drive#user", # This is always drive#user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]956 "displayName": "A String", # A plain text displayable name for this user.
957 "permissionId": "A String", # The user's ID as visible in the permissions collection.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]958 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
959 "emailAddress": "A String", # The email address of the user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]960 },
961 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]962 "ownedByMe": True or False, # Whether the file is owned by the current user. Not populated for items in shared drives.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]963 "id": "A String", # The ID of the file.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]964 "sharingUser": { # Information about a Drive user. # User that shared the item with the current user, if available.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]965 "picture": { # The user's profile picture.
966 "url": "A String", # A URL that points to a profile picture of this user.
967 },
968 "kind": "drive#user", # This is always drive#user.
969 "displayName": "A String", # A plain text displayable name for this user.
970 "permissionId": "A String", # The user's ID as visible in the permissions collection.
971 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
972 "emailAddress": "A String", # The email address of the user.
973 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]974 "shortcutDetails": { # Shortcut file details. Only populated for shortcut files, which have the mimeType field set to application/vnd.google-apps.shortcut.
975 "targetId": "A String", # The ID of the file that this shortcut points to.
976 "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.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]977 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]978 "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.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]979 "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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]980 "lastModifyingUser": { # Information about a Drive user. # The last user to modify this file.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]981 "picture": { # The user's profile picture.
982 "url": "A String", # A URL that points to a profile picture of this user.
983 },
984 "kind": "drive#user", # This is always drive#user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]985 "displayName": "A String", # A plain text displayable name for this user.
986 "permissionId": "A String", # The user's ID as visible in the permissions collection.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]987 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
988 "emailAddress": "A String", # The email address of the user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]989 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]990 "copyable": True or False, # Deprecated: use capabilities/canCopy.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]991 "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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]992 "markedViewedByMeDate": "A String", # Deprecated.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]993 "ownerNames": [ # Name(s) of the owner(s) of this file. Not populated for items in shared drives.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]994 "A String",
995 ],
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]996 "capabilities": { # Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]997 "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.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]998 "canUntrash": True or False, # Whether the current user can restore this file from trash.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]999 "canMoveItemWithinTeamDrive": True or False, # Deprecated - use canMoveItemWithinDrive instead.
1000 "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.
1001 "canMoveChildrenWithinTeamDrive": True or False, # Deprecated - use canMoveChildrenWithinDrive instead.
1002 "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.
1003 "canRename": True or False, # Whether the current user can rename this file.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1004 "canModifyContent": True or False, # Whether the current user can modify the content of this file.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1005 "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.
1006 "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.
1007 "canChangeRestrictedDownload": True or False, # Deprecated
1008 "canShare": True or False, # Whether the current user can modify the sharing settings for this file.
1009 "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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1010 "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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1011 "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.
1012 "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.
1013 "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.
1014 "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.
1015 "canMoveItemIntoTeamDrive": True or False, # Deprecated - use canMoveItemOutOfDrive instead.
1016 "canMoveItemOutOfTeamDrive": True or False, # Deprecated - use canMoveItemOutOfDrive instead.
1017 "canComment": True or False, # Whether the current user can comment on this file.
1018 "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.
1019 "canTrash": True or False, # Whether the current user can move this file to trash.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1020 "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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1021 "canDelete": True or False, # Whether the current user can delete this file.
1022 "canMoveTeamDriveItem": True or False, # Deprecated - use canMoveItemWithinDrive or canMoveItemOutOfDrive instead.
1023 "canDownload": True or False, # Whether the current user can download this file.
1024 "canChangeCopyRequiresWriterPermission": True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this file.
1025 "canMoveChildrenOutOfTeamDrive": True or False, # Deprecated - use canMoveChildrenOutOfDrive instead.
1026 "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.
1027 "canReadTeamDrive": True or False, # Deprecated - use canReadDrive instead.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1028 "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.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1029 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1030 "sharedWithMeDate": "A String", # Time at which this file was shared with the user (formatted RFC 3339 timestamp).
1031 "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.
1032 "etag": "A String", # ETag of the file.
1033 "parents": [ # Collection of parent folders which contain this file.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1034 # 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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1035 { # A reference to a file's parent.
1036 "selfLink": "A String", # A link back to this reference.
1037 "kind": "drive#parentReference", # This is always drive#parentReference.
1038 "id": "A String", # The ID of the parent.
1039 "isRoot": True or False, # Whether or not the parent is the root folder.
1040 "parentLink": "A String", # A link to the parent.
1041 },
1042 ],
1043 "exportLinks": { # Links for exporting Google Docs to specific formats.
1044 "a_key": "A String", # A mapping from export format to URL
1045 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1046 "shareable": True or False, # Deprecated: use capabilities/canShare.
1047 "copyRequiresWriterPermission": True or False, # Whether the options to copy, print, or download this file, should be disabled for readers and commenters.
1048 "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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1049 "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.
1050 "a_key": "A String",
1051 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]1052 "canReadRevisions": True or False, # Deprecated: use capabilities/canReadRevisions.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1053 "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.
1054 "exposureBias": 3.14, # The exposure bias of the photo (APEX value).
1055 "exposureTime": 3.14, # The length of the exposure, in seconds.
1056 "cameraMake": "A String", # The make of the camera used to create the photo.
1057 "maxApertureValue": 3.14, # The smallest f-number of the lens at the focal length used to create the photo (APEX value).
1058 "isoSpeed": 42, # The ISO speed used to create the photo.
1059 "focalLength": 3.14, # The focal length used to create the photo, in millimeters.
1060 "exposureMode": "A String", # The exposure mode used to create the photo.
1061 "colorSpace": "A String", # The color space of the photo.
1062 "location": { # Geographic location information stored in the image.
1063 "latitude": 3.14, # The latitude stored in the image.
1064 "altitude": 3.14, # The altitude stored in the image.
1065 "longitude": 3.14, # The longitude stored in the image.
1066 },
1067 "subjectDistance": 42, # The distance to the subject of the photo, in meters.
1068 "height": 42, # The height of the image in pixels.
1069 "lens": "A String", # The lens used to create the photo.
1070 "date": "A String", # The date and time the photo was taken (EXIF format timestamp).
1071 "width": 42, # The width of the image in pixels.
1072 "meteringMode": "A String", # The metering mode used to create the photo.
1073 "flashUsed": True or False, # Whether a flash was used to create the photo.
1074 "aperture": 3.14, # The aperture used to create the photo (f-number).
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1075 "rotation": 42, # The number of clockwise 90 degree rotations applied from the image's original orientation.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1076 "sensor": "A String", # The type of sensor used to create the photo.
1077 "whiteBalance": "A String", # The white balance mode used to create the photo.
1078 "cameraModel": "A String", # The model of the camera used to create the photo.
1079 },
1080 "description": "A String", # A short description of the file.
1081 "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.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1082 "videoMediaMetadata": { # Metadata about video media. This will only be present for video types.
1083 "width": 42, # The width of the video in pixels.
1084 "durationMillis": "A String", # The duration of the video in milliseconds.
1085 "height": 42, # The height of the video in pixels.
1086 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]1087 "editable": True or False, # Deprecated: use capabilities/canEdit.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1088 "kind": "drive#file", # The type of file. This is always drive#file.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]1089 "canComment": True or False, # Deprecated: use capabilities/canComment.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1090 "quotaBytesUsed": "A String", # The number of quota bytes used by this file.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1091 "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.
1092 "picture": { # The user's profile picture.
1093 "url": "A String", # A URL that points to a profile picture of this user.
1094 },
1095 "kind": "drive#user", # This is always drive#user.
1096 "displayName": "A String", # A plain text displayable name for this user.
1097 "permissionId": "A String", # The user's ID as visible in the permissions collection.
1098 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
1099 "emailAddress": "A String", # The email address of the user.
1100 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1101 "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.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]1102 "createdDate": "A String", # Create time for this file (formatted RFC 3339 timestamp).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1103 "teamDriveId": "A String", # Deprecated - use driveId instead.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1104 "properties": [ # The list of properties.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]1105 { # A key-value pair attached to a file that is either public or private to an application.
1106 # The following limits apply to file properties:
1107 # - Maximum of 100 properties total per file
1108 # - Maximum of 30 private properties per app
1109 # - Maximum of 30 public properties
1110 # - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1111 "kind": "drive#property", # This is always drive#property.
1112 "value": "A String", # The value of this property.
1113 "etag": "A String", # ETag of the property.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1114 "visibility": "A String", # The visibility of this property. Allowed values are PRIVATE and PUBLIC. (Default: PRIVATE)
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1115 "key": "A String", # The key of this property.
1116 "selfLink": "A String", # The link back to this property.
1117 },
1118 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1119 "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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1120 "iconLink": "A String", # A link to the file's icon.
1121 "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.
1122 "embedLink": "A String", # A link for embedding the file.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]1123 "alternateLink": "A String", # A link for opening the file in a relevant Google editor or viewer.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1124 "shared": True or False, # Whether the file has been shared. Not populated for items in shared drives.
1125 "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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1126 "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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1127 "thumbnail": { # A thumbnail for the file. This will only be used if a standard thumbnail cannot be generated.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]1128 "mimeType": "A String", # The MIME type of the thumbnail.
1129 "image": "A String", # The URL-safe Base64 encoded bytes of the thumbnail image. It should conform to RFC 4648 section 5.
1130 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1131 "driveId": "A String", # ID of the shared drive the file resides in. Only populated for items in shared drives.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1132 "userPermission": { # A permission for a file. # The permissions for the authenticated user on this file.
1133 "withLink": True or False, # Whether the link is required for this permission.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]1134 "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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1135 "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.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1136 {
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1137 "role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible:
1138 # - organizer
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1139 # - fileOrganizer
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1140 # - writer
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1141 # - reader
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1142 "inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1143 "permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible:
1144 # - file
1145 # - member
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1146 "additionalRoles": [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future.
1147 "A String",
1148 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1149 "inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field.
1150 },
1151 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1152 "name": "A String", # The name for this permission.
1153 "teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead.
1154 {
1155 "inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead.
1156 "role": "A String", # Deprecated - use permissionDetails/role instead.
1157 "additionalRoles": [ # Deprecated - use permissionDetails/additionalRoles instead.
1158 "A String",
1159 ],
1160 "teamDrivePermissionType": "A String", # Deprecated - use permissionDetails/permissionType instead.
1161 "inherited": True or False, # Deprecated - use permissionDetails/inherited instead.
1162 },
1163 ],
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]1164 "deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1165 "kind": "drive#permission", # This is always drive#permission.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1166 "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.
1167 "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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1168 "authKey": "A String", # Deprecated.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1169 "etag": "A String", # The ETag of the permission.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]1170 "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.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1171 "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1172 # - They cannot be set on shared drive items
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1173 # - They can only be set on user and group permissions
1174 # - The date must be in the future
1175 # - The date cannot be more than a year in the future
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1176 # - The date can only be set on drive.permissions.update or drive.permissions.patch requests
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1177 "role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed:
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1178 # - owner
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1179 # - organizer
1180 # - fileOrganizer
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1181 # - writer
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1182 # - reader
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1183 "type": "A String", # The account type. Allowed values are:
1184 # - user
1185 # - group
1186 # - domain
1187 # - anyone
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1188 "additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1189 "A String",
1190 ],
1191 "selfLink": "A String", # A link back to this permission.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]1192 "photoLink": "A String", # A link to the profile photo, if available.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1193 },
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]1194 "spaces": [ # The list of spaces which contain the file. Supported values are 'drive', 'appDataFolder' and 'photos'.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]1195 "A String",
1196 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1197 "permissionIds": [ # List of permission IDs for users with access to this file.
1198 "A String",
1199 ],
1200 "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.
1201 "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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1202 "hasAugmentedPermissions": True or False, # Whether there are permissions directly on this file. This field is only populated for items in shared drives.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1203 "permissions": [ # The list of permissions for users with access to this file. Not populated for items in shared drives.
1204 { # A permission for a file.
1205 "withLink": True or False, # Whether the link is required for this permission.
1206 "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.
1207 "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.
1208 {
1209 "role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible:
1210 # - organizer
1211 # - fileOrganizer
1212 # - writer
1213 # - reader
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1214 "inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1215 "permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible:
1216 # - file
1217 # - member
1218 "additionalRoles": [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future.
1219 "A String",
1220 ],
1221 "inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field.
1222 },
1223 ],
1224 "name": "A String", # The name for this permission.
1225 "teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead.
1226 {
1227 "inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead.
1228 "role": "A String", # Deprecated - use permissionDetails/role instead.
1229 "additionalRoles": [ # Deprecated - use permissionDetails/additionalRoles instead.
1230 "A String",
1231 ],
1232 "teamDrivePermissionType": "A String", # Deprecated - use permissionDetails/permissionType instead.
1233 "inherited": True or False, # Deprecated - use permissionDetails/inherited instead.
1234 },
1235 ],
1236 "deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.
1237 "kind": "drive#permission", # This is always drive#permission.
1238 "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.
1239 "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.
1240 "authKey": "A String", # Deprecated.
1241 "etag": "A String", # The ETag of the permission.
1242 "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.
1243 "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1244 # - They cannot be set on shared drive items
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1245 # - They can only be set on user and group permissions
1246 # - The date must be in the future
1247 # - The date cannot be more than a year in the future
1248 # - The date can only be set on drive.permissions.update or drive.permissions.patch requests
1249 "role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed:
1250 # - owner
1251 # - organizer
1252 # - fileOrganizer
1253 # - writer
1254 # - reader
1255 "type": "A String", # The account type. Allowed values are:
1256 # - user
1257 # - group
1258 # - domain
1259 # - anyone
1260 "additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future.
1261 "A String",
1262 ],
1263 "selfLink": "A String", # A link back to this permission.
1264 "photoLink": "A String", # A link to the profile photo, if available.
1265 },
1266 ],
1267 "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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1268 "selfLink": "A String", # A link back to this file.
1269 "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.
1270 }</pre>
1271</div>
1272
1273<div class="method">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1274 <code class="details" id="get_media">get_media(fileId, projection=None, revisionId=None, supportsTeamDrives=None, supportsAllDrives=None, acknowledgeAbuse=None, updateViewedDate=None)</code>
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]1275 <pre>Gets a file's metadata by ID.
1276
1277Args:
1278 fileId: string, The ID for the file in question. (required)
1279 projection: string, This parameter is deprecated and has no function.
1280 Allowed values
1281 BASIC - Deprecated
1282 FULL - Deprecated
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]1283 revisionId: string, Specifies the Revision ID that should be downloaded. Ignored unless alt=media is specified.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1284 supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead.
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.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]1286 acknowledgeAbuse: boolean, Whether the user is acknowledging the risk of downloading known malware or other abusive files.
Sai Cheemalapatidf613972016-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 Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]1288
1289Returns:
1290 The media object as a string.
1291
1292 </pre>
1293</div>
1294
1295<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1296 <code class="details" id="insert">insert(body=None, supportsTeamDrives=None, media_body=None, ocrLanguage=None, ocr=None, pinned=None, visibility=None, timedTextTrackName=None, enforceSingleParent=None, convert=None, useContentAsIndexableText=None, supportsAllDrives=None, media_mime_type=None, timedTextLanguage=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1297 <pre>Insert a new file.
1298
1299Args:
1300 body: object, The request body.
1301 The object takes the form of:
1302
1303{ # The metadata for a file.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]1304 "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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1305 "lastViewedByMeDate": "A String", # Last time this file was viewed by the user (formatted RFC 3339 timestamp).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1306 "trashedDate": "A String", # The time that the item was trashed (formatted RFC 3339 timestamp). Only populated for items in shared drives.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]1307 "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.
1308 "appDataContents": True or False, # Whether this file is in the Application Data folder.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1309 "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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1310 "labels": { # A group of labels for the file.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1311 "restricted": True or False, # Deprecated - use copyRequiresWriterPermission instead.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1312 "modified": True or False, # Whether the file has been modified by this user.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]1313 "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.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1314 "hidden": True or False, # Deprecated.
1315 "starred": True or False, # Whether this file is starred by the user.
1316 "viewed": True or False, # Whether this file has been viewed by this user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1317 },
1318 "indexableText": { # Indexable text attributes for the file (can only be written)
1319 "text": "A String", # The text to be indexed for this file.
1320 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1321 "thumbnailVersion": "A String", # The thumbnail version for use in thumbnail cache invalidation.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]1322 "explicitlyTrashed": True or False, # Whether this file has been explicitly trashed, as opposed to recursively trashed.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]1323 "isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1324 "lastModifyingUserName": "A String", # Name of the last user to modify this file.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1325 "writersCanShare": True or False, # Whether writers can share the document with other users. Not populated for items in shared drives.
1326 "owners": [ # The owner(s) of this file. Not populated for items in shared drives.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]1327 { # Information about a Drive user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1328 "picture": { # The user's profile picture.
1329 "url": "A String", # A URL that points to a profile picture of this user.
1330 },
1331 "kind": "drive#user", # This is always drive#user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1332 "displayName": "A String", # A plain text displayable name for this user.
1333 "permissionId": "A String", # The user's ID as visible in the permissions collection.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]1334 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
1335 "emailAddress": "A String", # The email address of the user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1336 },
1337 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1338 "ownedByMe": True or False, # Whether the file is owned by the current user. Not populated for items in shared drives.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1339 "id": "A String", # The ID of the file.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]1340 "sharingUser": { # Information about a Drive user. # User that shared the item with the current user, if available.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]1341 "picture": { # The user's profile picture.
1342 "url": "A String", # A URL that points to a profile picture of this user.
1343 },
1344 "kind": "drive#user", # This is always drive#user.
1345 "displayName": "A String", # A plain text displayable name for this user.
1346 "permissionId": "A String", # The user's ID as visible in the permissions collection.
1347 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
1348 "emailAddress": "A String", # The email address of the user.
1349 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1350 "shortcutDetails": { # Shortcut file details. Only populated for shortcut files, which have the mimeType field set to application/vnd.google-apps.shortcut.
1351 "targetId": "A String", # The ID of the file that this shortcut points to.
1352 "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.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1353 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1354 "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.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1355 "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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]1356 "lastModifyingUser": { # Information about a Drive user. # The last user to modify this file.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1357 "picture": { # The user's profile picture.
1358 "url": "A String", # A URL that points to a profile picture of this user.
1359 },
1360 "kind": "drive#user", # This is always drive#user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1361 "displayName": "A String", # A plain text displayable name for this user.
1362 "permissionId": "A String", # The user's ID as visible in the permissions collection.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]1363 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
1364 "emailAddress": "A String", # The email address of the user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1365 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]1366 "copyable": True or False, # Deprecated: use capabilities/canCopy.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1367 "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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]1368 "markedViewedByMeDate": "A String", # Deprecated.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1369 "ownerNames": [ # Name(s) of the owner(s) of this file. Not populated for items in shared drives.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1370 "A String",
1371 ],
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]1372 "capabilities": { # Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1373 "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.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]1374 "canUntrash": True or False, # Whether the current user can restore this file from trash.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1375 "canMoveItemWithinTeamDrive": True or False, # Deprecated - use canMoveItemWithinDrive instead.
1376 "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.
1377 "canMoveChildrenWithinTeamDrive": True or False, # Deprecated - use canMoveChildrenWithinDrive instead.
1378 "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.
1379 "canRename": True or False, # Whether the current user can rename this file.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1380 "canModifyContent": True or False, # Whether the current user can modify the content of this file.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1381 "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.
1382 "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.
1383 "canChangeRestrictedDownload": True or False, # Deprecated
1384 "canShare": True or False, # Whether the current user can modify the sharing settings for this file.
1385 "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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1386 "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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1387 "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.
1388 "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.
1389 "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.
1390 "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.
1391 "canMoveItemIntoTeamDrive": True or False, # Deprecated - use canMoveItemOutOfDrive instead.
1392 "canMoveItemOutOfTeamDrive": True or False, # Deprecated - use canMoveItemOutOfDrive instead.
1393 "canComment": True or False, # Whether the current user can comment on this file.
1394 "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.
1395 "canTrash": True or False, # Whether the current user can move this file to trash.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1396 "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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1397 "canDelete": True or False, # Whether the current user can delete this file.
1398 "canMoveTeamDriveItem": True or False, # Deprecated - use canMoveItemWithinDrive or canMoveItemOutOfDrive instead.
1399 "canDownload": True or False, # Whether the current user can download this file.
1400 "canChangeCopyRequiresWriterPermission": True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this file.
1401 "canMoveChildrenOutOfTeamDrive": True or False, # Deprecated - use canMoveChildrenOutOfDrive instead.
1402 "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.
1403 "canReadTeamDrive": True or False, # Deprecated - use canReadDrive instead.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1404 "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.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1405 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1406 "sharedWithMeDate": "A String", # Time at which this file was shared with the user (formatted RFC 3339 timestamp).
1407 "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.
1408 "etag": "A String", # ETag of the file.
1409 "parents": [ # Collection of parent folders which contain this file.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1410 # 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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1411 { # A reference to a file's parent.
1412 "selfLink": "A String", # A link back to this reference.
1413 "kind": "drive#parentReference", # This is always drive#parentReference.
1414 "id": "A String", # The ID of the parent.
1415 "isRoot": True or False, # Whether or not the parent is the root folder.
1416 "parentLink": "A String", # A link to the parent.
1417 },
1418 ],
1419 "exportLinks": { # Links for exporting Google Docs to specific formats.
1420 "a_key": "A String", # A mapping from export format to URL
1421 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1422 "shareable": True or False, # Deprecated: use capabilities/canShare.
1423 "copyRequiresWriterPermission": True or False, # Whether the options to copy, print, or download this file, should be disabled for readers and commenters.
1424 "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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1425 "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.
1426 "a_key": "A String",
1427 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]1428 "canReadRevisions": True or False, # Deprecated: use capabilities/canReadRevisions.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1429 "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.
1430 "exposureBias": 3.14, # The exposure bias of the photo (APEX value).
1431 "exposureTime": 3.14, # The length of the exposure, in seconds.
1432 "cameraMake": "A String", # The make of the camera used to create the photo.
1433 "maxApertureValue": 3.14, # The smallest f-number of the lens at the focal length used to create the photo (APEX value).
1434 "isoSpeed": 42, # The ISO speed used to create the photo.
1435 "focalLength": 3.14, # The focal length used to create the photo, in millimeters.
1436 "exposureMode": "A String", # The exposure mode used to create the photo.
1437 "colorSpace": "A String", # The color space of the photo.
1438 "location": { # Geographic location information stored in the image.
1439 "latitude": 3.14, # The latitude stored in the image.
1440 "altitude": 3.14, # The altitude stored in the image.
1441 "longitude": 3.14, # The longitude stored in the image.
1442 },
1443 "subjectDistance": 42, # The distance to the subject of the photo, in meters.
1444 "height": 42, # The height of the image in pixels.
1445 "lens": "A String", # The lens used to create the photo.
1446 "date": "A String", # The date and time the photo was taken (EXIF format timestamp).
1447 "width": 42, # The width of the image in pixels.
1448 "meteringMode": "A String", # The metering mode used to create the photo.
1449 "flashUsed": True or False, # Whether a flash was used to create the photo.
1450 "aperture": 3.14, # The aperture used to create the photo (f-number).
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1451 "rotation": 42, # The number of clockwise 90 degree rotations applied from the image's original orientation.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1452 "sensor": "A String", # The type of sensor used to create the photo.
1453 "whiteBalance": "A String", # The white balance mode used to create the photo.
1454 "cameraModel": "A String", # The model of the camera used to create the photo.
1455 },
1456 "description": "A String", # A short description of the file.
1457 "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.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1458 "videoMediaMetadata": { # Metadata about video media. This will only be present for video types.
1459 "width": 42, # The width of the video in pixels.
1460 "durationMillis": "A String", # The duration of the video in milliseconds.
1461 "height": 42, # The height of the video in pixels.
1462 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]1463 "editable": True or False, # Deprecated: use capabilities/canEdit.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1464 "kind": "drive#file", # The type of file. This is always drive#file.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]1465 "canComment": True or False, # Deprecated: use capabilities/canComment.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1466 "quotaBytesUsed": "A String", # The number of quota bytes used by this file.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1467 "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.
1468 "picture": { # The user's profile picture.
1469 "url": "A String", # A URL that points to a profile picture of this user.
1470 },
1471 "kind": "drive#user", # This is always drive#user.
1472 "displayName": "A String", # A plain text displayable name for this user.
1473 "permissionId": "A String", # The user's ID as visible in the permissions collection.
1474 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
1475 "emailAddress": "A String", # The email address of the user.
1476 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1477 "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.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]1478 "createdDate": "A String", # Create time for this file (formatted RFC 3339 timestamp).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1479 "teamDriveId": "A String", # Deprecated - use driveId instead.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1480 "properties": [ # The list of properties.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]1481 { # A key-value pair attached to a file that is either public or private to an application.
1482 # The following limits apply to file properties:
1483 # - Maximum of 100 properties total per file
1484 # - Maximum of 30 private properties per app
1485 # - Maximum of 30 public properties
1486 # - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1487 "kind": "drive#property", # This is always drive#property.
1488 "value": "A String", # The value of this property.
1489 "etag": "A String", # ETag of the property.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1490 "visibility": "A String", # The visibility of this property. Allowed values are PRIVATE and PUBLIC. (Default: PRIVATE)
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1491 "key": "A String", # The key of this property.
1492 "selfLink": "A String", # The link back to this property.
1493 },
1494 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1495 "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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1496 "iconLink": "A String", # A link to the file's icon.
1497 "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.
1498 "embedLink": "A String", # A link for embedding the file.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]1499 "alternateLink": "A String", # A link for opening the file in a relevant Google editor or viewer.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1500 "shared": True or False, # Whether the file has been shared. Not populated for items in shared drives.
1501 "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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1502 "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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1503 "thumbnail": { # A thumbnail for the file. This will only be used if a standard thumbnail cannot be generated.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]1504 "mimeType": "A String", # The MIME type of the thumbnail.
1505 "image": "A String", # The URL-safe Base64 encoded bytes of the thumbnail image. It should conform to RFC 4648 section 5.
1506 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1507 "driveId": "A String", # ID of the shared drive the file resides in. Only populated for items in shared drives.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1508 "userPermission": { # A permission for a file. # The permissions for the authenticated user on this file.
1509 "withLink": True or False, # Whether the link is required for this permission.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]1510 "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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1511 "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.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1512 {
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1513 "role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible:
1514 # - organizer
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1515 # - fileOrganizer
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1516 # - writer
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1517 # - reader
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1518 "inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1519 "permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible:
1520 # - file
1521 # - member
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1522 "additionalRoles": [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future.
1523 "A String",
1524 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1525 "inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field.
1526 },
1527 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1528 "name": "A String", # The name for this permission.
1529 "teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead.
1530 {
1531 "inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead.
1532 "role": "A String", # Deprecated - use permissionDetails/role instead.
1533 "additionalRoles": [ # Deprecated - use permissionDetails/additionalRoles instead.
1534 "A String",
1535 ],
1536 "teamDrivePermissionType": "A String", # Deprecated - use permissionDetails/permissionType instead.
1537 "inherited": True or False, # Deprecated - use permissionDetails/inherited instead.
1538 },
1539 ],
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]1540 "deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1541 "kind": "drive#permission", # This is always drive#permission.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1542 "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.
1543 "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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1544 "authKey": "A String", # Deprecated.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1545 "etag": "A String", # The ETag of the permission.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]1546 "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.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1547 "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1548 # - They cannot be set on shared drive items
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1549 # - They can only be set on user and group permissions
1550 # - The date must be in the future
1551 # - The date cannot be more than a year in the future
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1552 # - The date can only be set on drive.permissions.update or drive.permissions.patch requests
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1553 "role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed:
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1554 # - owner
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1555 # - organizer
1556 # - fileOrganizer
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1557 # - writer
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1558 # - reader
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1559 "type": "A String", # The account type. Allowed values are:
1560 # - user
1561 # - group
1562 # - domain
1563 # - anyone
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1564 "additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1565 "A String",
1566 ],
1567 "selfLink": "A String", # A link back to this permission.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]1568 "photoLink": "A String", # A link to the profile photo, if available.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1569 },
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]1570 "spaces": [ # The list of spaces which contain the file. Supported values are 'drive', 'appDataFolder' and 'photos'.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]1571 "A String",
1572 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1573 "permissionIds": [ # List of permission IDs for users with access to this file.
1574 "A String",
1575 ],
1576 "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.
1577 "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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1578 "hasAugmentedPermissions": True or False, # Whether there are permissions directly on this file. This field is only populated for items in shared drives.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1579 "permissions": [ # The list of permissions for users with access to this file. Not populated for items in shared drives.
1580 { # A permission for a file.
1581 "withLink": True or False, # Whether the link is required for this permission.
1582 "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.
1583 "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.
1584 {
1585 "role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible:
1586 # - organizer
1587 # - fileOrganizer
1588 # - writer
1589 # - reader
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1590 "inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1591 "permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible:
1592 # - file
1593 # - member
1594 "additionalRoles": [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future.
1595 "A String",
1596 ],
1597 "inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field.
1598 },
1599 ],
1600 "name": "A String", # The name for this permission.
1601 "teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead.
1602 {
1603 "inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead.
1604 "role": "A String", # Deprecated - use permissionDetails/role instead.
1605 "additionalRoles": [ # Deprecated - use permissionDetails/additionalRoles instead.
1606 "A String",
1607 ],
1608 "teamDrivePermissionType": "A String", # Deprecated - use permissionDetails/permissionType instead.
1609 "inherited": True or False, # Deprecated - use permissionDetails/inherited instead.
1610 },
1611 ],
1612 "deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.
1613 "kind": "drive#permission", # This is always drive#permission.
1614 "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.
1615 "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.
1616 "authKey": "A String", # Deprecated.
1617 "etag": "A String", # The ETag of the permission.
1618 "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.
1619 "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1620 # - They cannot be set on shared drive items
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1621 # - They can only be set on user and group permissions
1622 # - The date must be in the future
1623 # - The date cannot be more than a year in the future
1624 # - The date can only be set on drive.permissions.update or drive.permissions.patch requests
1625 "role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed:
1626 # - owner
1627 # - organizer
1628 # - fileOrganizer
1629 # - writer
1630 # - reader
1631 "type": "A String", # The account type. Allowed values are:
1632 # - user
1633 # - group
1634 # - domain
1635 # - anyone
1636 "additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future.
1637 "A String",
1638 ],
1639 "selfLink": "A String", # A link back to this permission.
1640 "photoLink": "A String", # A link to the profile photo, if available.
1641 },
1642 ],
1643 "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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1644 "selfLink": "A String", # A link back to this file.
1645 "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.
1646}
1647
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1648 supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1649 media_body: string, The filename of the media request body, or an instance of a MediaUpload object.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1650 ocrLanguage: string, If ocr is true, hints at the language to use. Valid values are BCP 47 codes.
1651 ocr: boolean, Whether to attempt OCR on .jpg, .png, .gif, or .pdf uploads.
1652 pinned: boolean, Whether to pin the head revision of the uploaded file. A file can have a maximum of 200 pinned revisions.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1653 visibility: string, The visibility of the new file. This parameter is only relevant when convert=false.
1654 Allowed values
1655 DEFAULT - The visibility of the new file is determined by the user's default visibility/sharing policies.
1656 PRIVATE - The new file will be visible to only the owner.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1657 timedTextTrackName: string, The timed text track name.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1658 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 Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1659 convert: boolean, Whether to convert this file to the corresponding Google Docs format.
1660 useContentAsIndexableText: boolean, Whether to use the content as indexable text.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1661 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.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1662 media_mime_type: string, The MIME type of the media request body, or an instance of a MediaUpload object.
1663 timedTextLanguage: string, The language of the timed text.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1664
1665Returns:
1666 An object of the form:
1667
1668 { # The metadata for a file.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]1669 "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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1670 "lastViewedByMeDate": "A String", # Last time this file was viewed by the user (formatted RFC 3339 timestamp).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1671 "trashedDate": "A String", # The time that the item was trashed (formatted RFC 3339 timestamp). Only populated for items in shared drives.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]1672 "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.
1673 "appDataContents": True or False, # Whether this file is in the Application Data folder.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1674 "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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1675 "labels": { # A group of labels for the file.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1676 "restricted": True or False, # Deprecated - use copyRequiresWriterPermission instead.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1677 "modified": True or False, # Whether the file has been modified by this user.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]1678 "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.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1679 "hidden": True or False, # Deprecated.
1680 "starred": True or False, # Whether this file is starred by the user.
1681 "viewed": True or False, # Whether this file has been viewed by this user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1682 },
1683 "indexableText": { # Indexable text attributes for the file (can only be written)
1684 "text": "A String", # The text to be indexed for this file.
1685 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1686 "thumbnailVersion": "A String", # The thumbnail version for use in thumbnail cache invalidation.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]1687 "explicitlyTrashed": True or False, # Whether this file has been explicitly trashed, as opposed to recursively trashed.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]1688 "isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1689 "lastModifyingUserName": "A String", # Name of the last user to modify this file.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1690 "writersCanShare": True or False, # Whether writers can share the document with other users. Not populated for items in shared drives.
1691 "owners": [ # The owner(s) of this file. Not populated for items in shared drives.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]1692 { # Information about a Drive user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1693 "picture": { # The user's profile picture.
1694 "url": "A String", # A URL that points to a profile picture of this user.
1695 },
1696 "kind": "drive#user", # This is always drive#user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1697 "displayName": "A String", # A plain text displayable name for this user.
1698 "permissionId": "A String", # The user's ID as visible in the permissions collection.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]1699 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
1700 "emailAddress": "A String", # The email address of the user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1701 },
1702 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1703 "ownedByMe": True or False, # Whether the file is owned by the current user. Not populated for items in shared drives.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1704 "id": "A String", # The ID of the file.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]1705 "sharingUser": { # Information about a Drive user. # User that shared the item with the current user, if available.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]1706 "picture": { # The user's profile picture.
1707 "url": "A String", # A URL that points to a profile picture of this user.
1708 },
1709 "kind": "drive#user", # This is always drive#user.
1710 "displayName": "A String", # A plain text displayable name for this user.
1711 "permissionId": "A String", # The user's ID as visible in the permissions collection.
1712 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
1713 "emailAddress": "A String", # The email address of the user.
1714 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1715 "shortcutDetails": { # Shortcut file details. Only populated for shortcut files, which have the mimeType field set to application/vnd.google-apps.shortcut.
1716 "targetId": "A String", # The ID of the file that this shortcut points to.
1717 "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.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1718 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1719 "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.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1720 "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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]1721 "lastModifyingUser": { # Information about a Drive user. # The last user to modify this file.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1722 "picture": { # The user's profile picture.
1723 "url": "A String", # A URL that points to a profile picture of this user.
1724 },
1725 "kind": "drive#user", # This is always drive#user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1726 "displayName": "A String", # A plain text displayable name for this user.
1727 "permissionId": "A String", # The user's ID as visible in the permissions collection.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]1728 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
1729 "emailAddress": "A String", # The email address of the user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1730 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]1731 "copyable": True or False, # Deprecated: use capabilities/canCopy.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1732 "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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]1733 "markedViewedByMeDate": "A String", # Deprecated.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1734 "ownerNames": [ # Name(s) of the owner(s) of this file. Not populated for items in shared drives.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1735 "A String",
1736 ],
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]1737 "capabilities": { # Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1738 "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.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]1739 "canUntrash": True or False, # Whether the current user can restore this file from trash.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1740 "canMoveItemWithinTeamDrive": True or False, # Deprecated - use canMoveItemWithinDrive instead.
1741 "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.
1742 "canMoveChildrenWithinTeamDrive": True or False, # Deprecated - use canMoveChildrenWithinDrive instead.
1743 "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.
1744 "canRename": True or False, # Whether the current user can rename this file.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1745 "canModifyContent": True or False, # Whether the current user can modify the content of this file.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1746 "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.
1747 "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.
1748 "canChangeRestrictedDownload": True or False, # Deprecated
1749 "canShare": True or False, # Whether the current user can modify the sharing settings for this file.
1750 "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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1751 "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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1752 "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.
1753 "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.
1754 "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.
1755 "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.
1756 "canMoveItemIntoTeamDrive": True or False, # Deprecated - use canMoveItemOutOfDrive instead.
1757 "canMoveItemOutOfTeamDrive": True or False, # Deprecated - use canMoveItemOutOfDrive instead.
1758 "canComment": True or False, # Whether the current user can comment on this file.
1759 "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.
1760 "canTrash": True or False, # Whether the current user can move this file to trash.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1761 "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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1762 "canDelete": True or False, # Whether the current user can delete this file.
1763 "canMoveTeamDriveItem": True or False, # Deprecated - use canMoveItemWithinDrive or canMoveItemOutOfDrive instead.
1764 "canDownload": True or False, # Whether the current user can download this file.
1765 "canChangeCopyRequiresWriterPermission": True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this file.
1766 "canMoveChildrenOutOfTeamDrive": True or False, # Deprecated - use canMoveChildrenOutOfDrive instead.
1767 "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.
1768 "canReadTeamDrive": True or False, # Deprecated - use canReadDrive instead.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1769 "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.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1770 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1771 "sharedWithMeDate": "A String", # Time at which this file was shared with the user (formatted RFC 3339 timestamp).
1772 "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.
1773 "etag": "A String", # ETag of the file.
1774 "parents": [ # Collection of parent folders which contain this file.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1775 # 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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1776 { # A reference to a file's parent.
1777 "selfLink": "A String", # A link back to this reference.
1778 "kind": "drive#parentReference", # This is always drive#parentReference.
1779 "id": "A String", # The ID of the parent.
1780 "isRoot": True or False, # Whether or not the parent is the root folder.
1781 "parentLink": "A String", # A link to the parent.
1782 },
1783 ],
1784 "exportLinks": { # Links for exporting Google Docs to specific formats.
1785 "a_key": "A String", # A mapping from export format to URL
1786 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1787 "shareable": True or False, # Deprecated: use capabilities/canShare.
1788 "copyRequiresWriterPermission": True or False, # Whether the options to copy, print, or download this file, should be disabled for readers and commenters.
1789 "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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1790 "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.
1791 "a_key": "A String",
1792 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]1793 "canReadRevisions": True or False, # Deprecated: use capabilities/canReadRevisions.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1794 "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.
1795 "exposureBias": 3.14, # The exposure bias of the photo (APEX value).
1796 "exposureTime": 3.14, # The length of the exposure, in seconds.
1797 "cameraMake": "A String", # The make of the camera used to create the photo.
1798 "maxApertureValue": 3.14, # The smallest f-number of the lens at the focal length used to create the photo (APEX value).
1799 "isoSpeed": 42, # The ISO speed used to create the photo.
1800 "focalLength": 3.14, # The focal length used to create the photo, in millimeters.
1801 "exposureMode": "A String", # The exposure mode used to create the photo.
1802 "colorSpace": "A String", # The color space of the photo.
1803 "location": { # Geographic location information stored in the image.
1804 "latitude": 3.14, # The latitude stored in the image.
1805 "altitude": 3.14, # The altitude stored in the image.
1806 "longitude": 3.14, # The longitude stored in the image.
1807 },
1808 "subjectDistance": 42, # The distance to the subject of the photo, in meters.
1809 "height": 42, # The height of the image in pixels.
1810 "lens": "A String", # The lens used to create the photo.
1811 "date": "A String", # The date and time the photo was taken (EXIF format timestamp).
1812 "width": 42, # The width of the image in pixels.
1813 "meteringMode": "A String", # The metering mode used to create the photo.
1814 "flashUsed": True or False, # Whether a flash was used to create the photo.
1815 "aperture": 3.14, # The aperture used to create the photo (f-number).
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1816 "rotation": 42, # The number of clockwise 90 degree rotations applied from the image's original orientation.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1817 "sensor": "A String", # The type of sensor used to create the photo.
1818 "whiteBalance": "A String", # The white balance mode used to create the photo.
1819 "cameraModel": "A String", # The model of the camera used to create the photo.
1820 },
1821 "description": "A String", # A short description of the file.
1822 "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.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1823 "videoMediaMetadata": { # Metadata about video media. This will only be present for video types.
1824 "width": 42, # The width of the video in pixels.
1825 "durationMillis": "A String", # The duration of the video in milliseconds.
1826 "height": 42, # The height of the video in pixels.
1827 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]1828 "editable": True or False, # Deprecated: use capabilities/canEdit.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1829 "kind": "drive#file", # The type of file. This is always drive#file.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]1830 "canComment": True or False, # Deprecated: use capabilities/canComment.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1831 "quotaBytesUsed": "A String", # The number of quota bytes used by this file.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1832 "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.
1833 "picture": { # The user's profile picture.
1834 "url": "A String", # A URL that points to a profile picture of this user.
1835 },
1836 "kind": "drive#user", # This is always drive#user.
1837 "displayName": "A String", # A plain text displayable name for this user.
1838 "permissionId": "A String", # The user's ID as visible in the permissions collection.
1839 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
1840 "emailAddress": "A String", # The email address of the user.
1841 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1842 "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.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]1843 "createdDate": "A String", # Create time for this file (formatted RFC 3339 timestamp).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1844 "teamDriveId": "A String", # Deprecated - use driveId instead.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1845 "properties": [ # The list of properties.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]1846 { # A key-value pair attached to a file that is either public or private to an application.
1847 # The following limits apply to file properties:
1848 # - Maximum of 100 properties total per file
1849 # - Maximum of 30 private properties per app
1850 # - Maximum of 30 public properties
1851 # - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1852 "kind": "drive#property", # This is always drive#property.
1853 "value": "A String", # The value of this property.
1854 "etag": "A String", # ETag of the property.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1855 "visibility": "A String", # The visibility of this property. Allowed values are PRIVATE and PUBLIC. (Default: PRIVATE)
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1856 "key": "A String", # The key of this property.
1857 "selfLink": "A String", # The link back to this property.
1858 },
1859 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1860 "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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1861 "iconLink": "A String", # A link to the file's icon.
1862 "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.
1863 "embedLink": "A String", # A link for embedding the file.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]1864 "alternateLink": "A String", # A link for opening the file in a relevant Google editor or viewer.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1865 "shared": True or False, # Whether the file has been shared. Not populated for items in shared drives.
1866 "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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1867 "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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1868 "thumbnail": { # A thumbnail for the file. This will only be used if a standard thumbnail cannot be generated.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]1869 "mimeType": "A String", # The MIME type of the thumbnail.
1870 "image": "A String", # The URL-safe Base64 encoded bytes of the thumbnail image. It should conform to RFC 4648 section 5.
1871 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1872 "driveId": "A String", # ID of the shared drive the file resides in. Only populated for items in shared drives.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1873 "userPermission": { # A permission for a file. # The permissions for the authenticated user on this file.
1874 "withLink": True or False, # Whether the link is required for this permission.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]1875 "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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1876 "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.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1877 {
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1878 "role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible:
1879 # - organizer
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1880 # - fileOrganizer
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1881 # - writer
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1882 # - reader
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1883 "inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1884 "permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible:
1885 # - file
1886 # - member
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1887 "additionalRoles": [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future.
1888 "A String",
1889 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1890 "inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field.
1891 },
1892 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1893 "name": "A String", # The name for this permission.
1894 "teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead.
1895 {
1896 "inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead.
1897 "role": "A String", # Deprecated - use permissionDetails/role instead.
1898 "additionalRoles": [ # Deprecated - use permissionDetails/additionalRoles instead.
1899 "A String",
1900 ],
1901 "teamDrivePermissionType": "A String", # Deprecated - use permissionDetails/permissionType instead.
1902 "inherited": True or False, # Deprecated - use permissionDetails/inherited instead.
1903 },
1904 ],
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]1905 "deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1906 "kind": "drive#permission", # This is always drive#permission.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1907 "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.
1908 "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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1909 "authKey": "A String", # Deprecated.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1910 "etag": "A String", # The ETag of the permission.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]1911 "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.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1912 "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1913 # - They cannot be set on shared drive items
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1914 # - They can only be set on user and group permissions
1915 # - The date must be in the future
1916 # - The date cannot be more than a year in the future
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1917 # - The date can only be set on drive.permissions.update or drive.permissions.patch requests
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1918 "role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed:
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1919 # - owner
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1920 # - organizer
1921 # - fileOrganizer
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1922 # - writer
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1923 # - reader
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1924 "type": "A String", # The account type. Allowed values are:
1925 # - user
1926 # - group
1927 # - domain
1928 # - anyone
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1929 "additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1930 "A String",
1931 ],
1932 "selfLink": "A String", # A link back to this permission.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]1933 "photoLink": "A String", # A link to the profile photo, if available.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1934 },
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]1935 "spaces": [ # The list of spaces which contain the file. Supported values are 'drive', 'appDataFolder' and 'photos'.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]1936 "A String",
1937 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1938 "permissionIds": [ # List of permission IDs for users with access to this file.
1939 "A String",
1940 ],
1941 "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.
1942 "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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1943 "hasAugmentedPermissions": True or False, # Whether there are permissions directly on this file. This field is only populated for items in shared drives.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1944 "permissions": [ # The list of permissions for users with access to this file. Not populated for items in shared drives.
1945 { # A permission for a file.
1946 "withLink": True or False, # Whether the link is required for this permission.
1947 "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.
1948 "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.
1949 {
1950 "role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible:
1951 # - organizer
1952 # - fileOrganizer
1953 # - writer
1954 # - reader
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1955 "inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1956 "permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible:
1957 # - file
1958 # - member
1959 "additionalRoles": [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future.
1960 "A String",
1961 ],
1962 "inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field.
1963 },
1964 ],
1965 "name": "A String", # The name for this permission.
1966 "teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead.
1967 {
1968 "inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead.
1969 "role": "A String", # Deprecated - use permissionDetails/role instead.
1970 "additionalRoles": [ # Deprecated - use permissionDetails/additionalRoles instead.
1971 "A String",
1972 ],
1973 "teamDrivePermissionType": "A String", # Deprecated - use permissionDetails/permissionType instead.
1974 "inherited": True or False, # Deprecated - use permissionDetails/inherited instead.
1975 },
1976 ],
1977 "deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.
1978 "kind": "drive#permission", # This is always drive#permission.
1979 "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.
1980 "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.
1981 "authKey": "A String", # Deprecated.
1982 "etag": "A String", # The ETag of the permission.
1983 "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.
1984 "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1985 # - They cannot be set on shared drive items
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1986 # - They can only be set on user and group permissions
1987 # - The date must be in the future
1988 # - The date cannot be more than a year in the future
1989 # - The date can only be set on drive.permissions.update or drive.permissions.patch requests
1990 "role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed:
1991 # - owner
1992 # - organizer
1993 # - fileOrganizer
1994 # - writer
1995 # - reader
1996 "type": "A String", # The account type. Allowed values are:
1997 # - user
1998 # - group
1999 # - domain
2000 # - anyone
2001 "additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future.
2002 "A String",
2003 ],
2004 "selfLink": "A String", # A link back to this permission.
2005 "photoLink": "A String", # A link to the profile photo, if available.
2006 },
2007 ],
2008 "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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]2009 "selfLink": "A String", # A link back to this file.
2010 "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.
2011 }</pre>
2012</div>
2013
2014<div class="method">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2015 <code class="details" id="list">list(orderBy=None, projection=None, supportsTeamDrives=None, spaces=None, q=None, pageToken=None, corpus=None, maxResults=None, teamDriveId=None, includeItemsFromAllDrives=None, includeTeamDriveItems=None, corpora=None, supportsAllDrives=None, driveId=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]2016 <pre>Lists the user's files.
2017
2018Args:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2019 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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]2020 projection: string, This parameter is deprecated and has no function.
2021 Allowed values
2022 BASIC - Deprecated
2023 FULL - Deprecated
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2024 supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]2025 spaces: string, A comma-separated list of spaces to query. Supported values are 'drive', 'appDataFolder' and 'photos'.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2026 q: string, Query string for searching files.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]2027 pageToken: string, Page token for files.
2028 corpus: string, The body of items (files/documents) to which the query applies. Deprecated: use 'corpora' instead.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]2029 Allowed values
2030 DEFAULT - The items that the user has accessed.
2031 DOMAIN - Items shared to the user's domain.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]2032 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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2033 teamDriveId: string, Deprecated use driveId instead.
2034 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.
2035 includeTeamDriveItems: boolean, Deprecated use includeItemsFromAllDrives instead.
2036 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.
2037 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.
2038 driveId: string, ID of the shared drive to search.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]2039
2040Returns:
2041 An object of the form:
2042
2043 { # A list of files.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2044 "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".
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]2045 "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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]2046 "kind": "drive#fileList", # This is always drive#fileList.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]2047 "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 Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]2048 { # The metadata for a file.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]2049 "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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]2050 "lastViewedByMeDate": "A String", # Last time this file was viewed by the user (formatted RFC 3339 timestamp).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2051 "trashedDate": "A String", # The time that the item was trashed (formatted RFC 3339 timestamp). Only populated for items in shared drives.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]2052 "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.
2053 "appDataContents": True or False, # Whether this file is in the Application Data folder.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]2054 "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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]2055 "labels": { # A group of labels for the file.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2056 "restricted": True or False, # Deprecated - use copyRequiresWriterPermission instead.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]2057 "modified": True or False, # Whether the file has been modified by this user.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]2058 "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.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]2059 "hidden": True or False, # Deprecated.
2060 "starred": True or False, # Whether this file is starred by the user.
2061 "viewed": True or False, # Whether this file has been viewed by this user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]2062 },
2063 "indexableText": { # Indexable text attributes for the file (can only be written)
2064 "text": "A String", # The text to be indexed for this file.
2065 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]2066 "thumbnailVersion": "A String", # The thumbnail version for use in thumbnail cache invalidation.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]2067 "explicitlyTrashed": True or False, # Whether this file has been explicitly trashed, as opposed to recursively trashed.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]2068 "isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]2069 "lastModifyingUserName": "A String", # Name of the last user to modify this file.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2070 "writersCanShare": True or False, # Whether writers can share the document with other users. Not populated for items in shared drives.
2071 "owners": [ # The owner(s) of this file. Not populated for items in shared drives.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]2072 { # Information about a Drive user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]2073 "picture": { # The user's profile picture.
2074 "url": "A String", # A URL that points to a profile picture of this user.
2075 },
2076 "kind": "drive#user", # This is always drive#user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]2077 "displayName": "A String", # A plain text displayable name for this user.
2078 "permissionId": "A String", # The user's ID as visible in the permissions collection.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]2079 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
2080 "emailAddress": "A String", # The email address of the user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]2081 },
2082 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2083 "ownedByMe": True or False, # Whether the file is owned by the current user. Not populated for items in shared drives.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]2084 "id": "A String", # The ID of the file.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]2085 "sharingUser": { # Information about a Drive user. # User that shared the item with the current user, if available.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]2086 "picture": { # The user's profile picture.
2087 "url": "A String", # A URL that points to a profile picture of this user.
2088 },
2089 "kind": "drive#user", # This is always drive#user.
2090 "displayName": "A String", # A plain text displayable name for this user.
2091 "permissionId": "A String", # The user's ID as visible in the permissions collection.
2092 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
2093 "emailAddress": "A String", # The email address of the user.
2094 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]2095 "shortcutDetails": { # Shortcut file details. Only populated for shortcut files, which have the mimeType field set to application/vnd.google-apps.shortcut.
2096 "targetId": "A String", # The ID of the file that this shortcut points to.
2097 "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.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]2098 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2099 "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.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]2100 "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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]2101 "lastModifyingUser": { # Information about a Drive user. # The last user to modify this file.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]2102 "picture": { # The user's profile picture.
2103 "url": "A String", # A URL that points to a profile picture of this user.
2104 },
2105 "kind": "drive#user", # This is always drive#user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]2106 "displayName": "A String", # A plain text displayable name for this user.
2107 "permissionId": "A String", # The user's ID as visible in the permissions collection.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]2108 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
2109 "emailAddress": "A String", # The email address of the user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]2110 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]2111 "copyable": True or False, # Deprecated: use capabilities/canCopy.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2112 "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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]2113 "markedViewedByMeDate": "A String", # Deprecated.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2114 "ownerNames": [ # Name(s) of the owner(s) of this file. Not populated for items in shared drives.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]2115 "A String",
2116 ],
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]2117 "capabilities": { # Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2118 "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.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]2119 "canUntrash": True or False, # Whether the current user can restore this file from trash.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2120 "canMoveItemWithinTeamDrive": True or False, # Deprecated - use canMoveItemWithinDrive instead.
2121 "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.
2122 "canMoveChildrenWithinTeamDrive": True or False, # Deprecated - use canMoveChildrenWithinDrive instead.
2123 "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.
2124 "canRename": True or False, # Whether the current user can rename this file.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]2125 "canModifyContent": True or False, # Whether the current user can modify the content of this file.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2126 "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.
2127 "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.
2128 "canChangeRestrictedDownload": True or False, # Deprecated
2129 "canShare": True or False, # Whether the current user can modify the sharing settings for this file.
2130 "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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]2131 "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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2132 "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.
2133 "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.
2134 "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.
2135 "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.
2136 "canMoveItemIntoTeamDrive": True or False, # Deprecated - use canMoveItemOutOfDrive instead.
2137 "canMoveItemOutOfTeamDrive": True or False, # Deprecated - use canMoveItemOutOfDrive instead.
2138 "canComment": True or False, # Whether the current user can comment on this file.
2139 "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.
2140 "canTrash": True or False, # Whether the current user can move this file to trash.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]2141 "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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2142 "canDelete": True or False, # Whether the current user can delete this file.
2143 "canMoveTeamDriveItem": True or False, # Deprecated - use canMoveItemWithinDrive or canMoveItemOutOfDrive instead.
2144 "canDownload": True or False, # Whether the current user can download this file.
2145 "canChangeCopyRequiresWriterPermission": True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this file.
2146 "canMoveChildrenOutOfTeamDrive": True or False, # Deprecated - use canMoveChildrenOutOfDrive instead.
2147 "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.
2148 "canReadTeamDrive": True or False, # Deprecated - use canReadDrive instead.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]2149 "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.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]2150 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]2151 "sharedWithMeDate": "A String", # Time at which this file was shared with the user (formatted RFC 3339 timestamp).
2152 "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.
2153 "etag": "A String", # ETag of the file.
2154 "parents": [ # Collection of parent folders which contain this file.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2155 # 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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]2156 { # A reference to a file's parent.
2157 "selfLink": "A String", # A link back to this reference.
2158 "kind": "drive#parentReference", # This is always drive#parentReference.
2159 "id": "A String", # The ID of the parent.
2160 "isRoot": True or False, # Whether or not the parent is the root folder.
2161 "parentLink": "A String", # A link to the parent.
2162 },
2163 ],
2164 "exportLinks": { # Links for exporting Google Docs to specific formats.
2165 "a_key": "A String", # A mapping from export format to URL
2166 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2167 "shareable": True or False, # Deprecated: use capabilities/canShare.
2168 "copyRequiresWriterPermission": True or False, # Whether the options to copy, print, or download this file, should be disabled for readers and commenters.
2169 "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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]2170 "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.
2171 "a_key": "A String",
2172 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]2173 "canReadRevisions": True or False, # Deprecated: use capabilities/canReadRevisions.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]2174 "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.
2175 "exposureBias": 3.14, # The exposure bias of the photo (APEX value).
2176 "exposureTime": 3.14, # The length of the exposure, in seconds.
2177 "cameraMake": "A String", # The make of the camera used to create the photo.
2178 "maxApertureValue": 3.14, # The smallest f-number of the lens at the focal length used to create the photo (APEX value).
2179 "isoSpeed": 42, # The ISO speed used to create the photo.
2180 "focalLength": 3.14, # The focal length used to create the photo, in millimeters.
2181 "exposureMode": "A String", # The exposure mode used to create the photo.
2182 "colorSpace": "A String", # The color space of the photo.
2183 "location": { # Geographic location information stored in the image.
2184 "latitude": 3.14, # The latitude stored in the image.
2185 "altitude": 3.14, # The altitude stored in the image.
2186 "longitude": 3.14, # The longitude stored in the image.
2187 },
2188 "subjectDistance": 42, # The distance to the subject of the photo, in meters.
2189 "height": 42, # The height of the image in pixels.
2190 "lens": "A String", # The lens used to create the photo.
2191 "date": "A String", # The date and time the photo was taken (EXIF format timestamp).
2192 "width": 42, # The width of the image in pixels.
2193 "meteringMode": "A String", # The metering mode used to create the photo.
2194 "flashUsed": True or False, # Whether a flash was used to create the photo.
2195 "aperture": 3.14, # The aperture used to create the photo (f-number).
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]2196 "rotation": 42, # The number of clockwise 90 degree rotations applied from the image's original orientation.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]2197 "sensor": "A String", # The type of sensor used to create the photo.
2198 "whiteBalance": "A String", # The white balance mode used to create the photo.
2199 "cameraModel": "A String", # The model of the camera used to create the photo.
2200 },
2201 "description": "A String", # A short description of the file.
2202 "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.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]2203 "videoMediaMetadata": { # Metadata about video media. This will only be present for video types.
2204 "width": 42, # The width of the video in pixels.
2205 "durationMillis": "A String", # The duration of the video in milliseconds.
2206 "height": 42, # The height of the video in pixels.
2207 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]2208 "editable": True or False, # Deprecated: use capabilities/canEdit.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]2209 "kind": "drive#file", # The type of file. This is always drive#file.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]2210 "canComment": True or False, # Deprecated: use capabilities/canComment.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]2211 "quotaBytesUsed": "A String", # The number of quota bytes used by this file.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]2212 "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.
2213 "picture": { # The user's profile picture.
2214 "url": "A String", # A URL that points to a profile picture of this user.
2215 },
2216 "kind": "drive#user", # This is always drive#user.
2217 "displayName": "A String", # A plain text displayable name for this user.
2218 "permissionId": "A String", # The user's ID as visible in the permissions collection.
2219 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
2220 "emailAddress": "A String", # The email address of the user.
2221 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2222 "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.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]2223 "createdDate": "A String", # Create time for this file (formatted RFC 3339 timestamp).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2224 "teamDriveId": "A String", # Deprecated - use driveId instead.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]2225 "properties": [ # The list of properties.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]2226 { # A key-value pair attached to a file that is either public or private to an application.
2227 # The following limits apply to file properties:
2228 # - Maximum of 100 properties total per file
2229 # - Maximum of 30 private properties per app
2230 # - Maximum of 30 public properties
2231 # - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]2232 "kind": "drive#property", # This is always drive#property.
2233 "value": "A String", # The value of this property.
2234 "etag": "A String", # ETag of the property.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2235 "visibility": "A String", # The visibility of this property. Allowed values are PRIVATE and PUBLIC. (Default: PRIVATE)
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]2236 "key": "A String", # The key of this property.
2237 "selfLink": "A String", # The link back to this property.
2238 },
2239 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2240 "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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]2241 "iconLink": "A String", # A link to the file's icon.
2242 "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.
2243 "embedLink": "A String", # A link for embedding the file.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]2244 "alternateLink": "A String", # A link for opening the file in a relevant Google editor or viewer.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2245 "shared": True or False, # Whether the file has been shared. Not populated for items in shared drives.
2246 "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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]2247 "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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2248 "thumbnail": { # A thumbnail for the file. This will only be used if a standard thumbnail cannot be generated.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]2249 "mimeType": "A String", # The MIME type of the thumbnail.
2250 "image": "A String", # The URL-safe Base64 encoded bytes of the thumbnail image. It should conform to RFC 4648 section 5.
2251 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2252 "driveId": "A String", # ID of the shared drive the file resides in. Only populated for items in shared drives.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]2253 "userPermission": { # A permission for a file. # The permissions for the authenticated user on this file.
2254 "withLink": True or False, # Whether the link is required for this permission.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]2255 "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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2256 "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.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]2257 {
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]2258 "role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible:
2259 # - organizer
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2260 # - fileOrganizer
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]2261 # - writer
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2262 # - reader
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]2263 "inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2264 "permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible:
2265 # - file
2266 # - member
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]2267 "additionalRoles": [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future.
2268 "A String",
2269 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]2270 "inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field.
2271 },
2272 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2273 "name": "A String", # The name for this permission.
2274 "teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead.
2275 {
2276 "inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead.
2277 "role": "A String", # Deprecated - use permissionDetails/role instead.
2278 "additionalRoles": [ # Deprecated - use permissionDetails/additionalRoles instead.
2279 "A String",
2280 ],
2281 "teamDrivePermissionType": "A String", # Deprecated - use permissionDetails/permissionType instead.
2282 "inherited": True or False, # Deprecated - use permissionDetails/inherited instead.
2283 },
2284 ],
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]2285 "deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]2286 "kind": "drive#permission", # This is always drive#permission.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]2287 "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.
2288 "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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2289 "authKey": "A String", # Deprecated.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]2290 "etag": "A String", # The ETag of the permission.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]2291 "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.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]2292 "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]2293 # - They cannot be set on shared drive items
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]2294 # - They can only be set on user and group permissions
2295 # - The date must be in the future
2296 # - The date cannot be more than a year in the future
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2297 # - The date can only be set on drive.permissions.update or drive.permissions.patch requests
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]2298 "role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed:
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]2299 # - owner
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2300 # - organizer
2301 # - fileOrganizer
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]2302 # - writer
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2303 # - reader
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]2304 "type": "A String", # The account type. Allowed values are:
2305 # - user
2306 # - group
2307 # - domain
2308 # - anyone
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]2309 "additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]2310 "A String",
2311 ],
2312 "selfLink": "A String", # A link back to this permission.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]2313 "photoLink": "A String", # A link to the profile photo, if available.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]2314 },
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]2315 "spaces": [ # The list of spaces which contain the file. Supported values are 'drive', 'appDataFolder' and 'photos'.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]2316 "A String",
2317 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2318 "permissionIds": [ # List of permission IDs for users with access to this file.
2319 "A String",
2320 ],
2321 "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.
2322 "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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]2323 "hasAugmentedPermissions": True or False, # Whether there are permissions directly on this file. This field is only populated for items in shared drives.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2324 "permissions": [ # The list of permissions for users with access to this file. Not populated for items in shared drives.
2325 { # A permission for a file.
2326 "withLink": True or False, # Whether the link is required for this permission.
2327 "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.
2328 "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.
2329 {
2330 "role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible:
2331 # - organizer
2332 # - fileOrganizer
2333 # - writer
2334 # - reader
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]2335 "inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2336 "permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible:
2337 # - file
2338 # - member
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 },
2344 ],
2345 "name": "A String", # The name for this permission.
2346 "teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead.
2347 {
2348 "inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead.
2349 "role": "A String", # Deprecated - use permissionDetails/role instead.
2350 "additionalRoles": [ # Deprecated - use permissionDetails/additionalRoles instead.
2351 "A String",
2352 ],
2353 "teamDrivePermissionType": "A String", # Deprecated - use permissionDetails/permissionType instead.
2354 "inherited": True or False, # Deprecated - use permissionDetails/inherited instead.
2355 },
2356 ],
2357 "deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.
2358 "kind": "drive#permission", # This is always drive#permission.
2359 "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.
2360 "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.
2361 "authKey": "A String", # Deprecated.
2362 "etag": "A String", # The ETag of the permission.
2363 "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.
2364 "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]2365 # - They cannot be set on shared drive items
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2366 # - They can only be set on user and group permissions
2367 # - The date must be in the future
2368 # - The date cannot be more than a year in the future
2369 # - The date can only be set on drive.permissions.update or drive.permissions.patch requests
2370 "role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed:
2371 # - owner
2372 # - organizer
2373 # - fileOrganizer
2374 # - writer
2375 # - reader
2376 "type": "A String", # The account type. Allowed values are:
2377 # - user
2378 # - group
2379 # - domain
2380 # - anyone
2381 "additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future.
2382 "A String",
2383 ],
2384 "selfLink": "A String", # A link back to this permission.
2385 "photoLink": "A String", # A link to the profile photo, if available.
2386 },
2387 ],
2388 "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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]2389 "selfLink": "A String", # A link back to this file.
2390 "modifiedDate": "A String", # Last time this file was modified by anyone (formatted RFC 3339 timestamp). This is only mutable on update when the setModifiedDate parameter is set.
2391 },
2392 ],
2393 "nextLink": "A String", # A link to the next page of files.
2394 "etag": "A String", # The ETag of the list.
2395 "selfLink": "A String", # A link back to this list.
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
2403Args:
2404 previous_request: The request for the previous page. (required)
2405 previous_response: The response from the request for the previous page. (required)
2406
2407Returns:
2408 A request object that you can call 'execute()' on to request the next
2409 page. Returns None if there are no more items in the collection.
2410 </pre>
2411</div>
2412
2413<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]2414 <code class="details" id="patch">patch(fileId, body=None, supportsTeamDrives=None, newRevision=None, modifiedDateBehavior=None, ocrLanguage=None, pinned=None, ocr=None, addParents=None, removeParents=None, updateViewedDate=None, timedTextTrackName=None, enforceSingleParent=None, convert=None, useContentAsIndexableText=None, supportsAllDrives=None, setModifiedDate=None, timedTextLanguage=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]2415 <pre>Updates file metadata and/or content. This method supports patch semantics.
2416
2417Args:
2418 fileId: string, The ID of the file to update. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]2419 body: object, The request body.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]2420 The object takes the form of:
2421
2422{ # The metadata for a file.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]2423 "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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]2424 "lastViewedByMeDate": "A String", # Last time this file was viewed by the user (formatted RFC 3339 timestamp).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2425 "trashedDate": "A String", # The time that the item was trashed (formatted RFC 3339 timestamp). Only populated for items in shared drives.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]2426 "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.
2427 "appDataContents": True or False, # Whether this file is in the Application Data folder.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]2428 "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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]2429 "labels": { # A group of labels for the file.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2430 "restricted": True or False, # Deprecated - use copyRequiresWriterPermission instead.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]2431 "modified": True or False, # Whether the file has been modified by this user.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]2432 "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.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]2433 "hidden": True or False, # Deprecated.
2434 "starred": True or False, # Whether this file is starred by the user.
2435 "viewed": True or False, # Whether this file has been viewed by this user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]2436 },
2437 "indexableText": { # Indexable text attributes for the file (can only be written)
2438 "text": "A String", # The text to be indexed for this file.
2439 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]2440 "thumbnailVersion": "A String", # The thumbnail version for use in thumbnail cache invalidation.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]2441 "explicitlyTrashed": True or False, # Whether this file has been explicitly trashed, as opposed to recursively trashed.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]2442 "isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]2443 "lastModifyingUserName": "A String", # Name of the last user to modify this file.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2444 "writersCanShare": True or False, # Whether writers can share the document with other users. Not populated for items in shared drives.
2445 "owners": [ # The owner(s) of this file. Not populated for items in shared drives.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]2446 { # Information about a Drive user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]2447 "picture": { # The user's profile picture.
2448 "url": "A String", # A URL that points to a profile picture of this user.
2449 },
2450 "kind": "drive#user", # This is always drive#user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]2451 "displayName": "A String", # A plain text displayable name for this user.
2452 "permissionId": "A String", # The user's ID as visible in the permissions collection.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]2453 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
2454 "emailAddress": "A String", # The email address of the user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]2455 },
2456 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2457 "ownedByMe": True or False, # Whether the file is owned by the current user. Not populated for items in shared drives.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]2458 "id": "A String", # The ID of the file.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]2459 "sharingUser": { # Information about a Drive user. # User that shared the item with the current user, if available.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]2460 "picture": { # The user's profile picture.
2461 "url": "A String", # A URL that points to a profile picture of this user.
2462 },
2463 "kind": "drive#user", # This is always drive#user.
2464 "displayName": "A String", # A plain text displayable name for this user.
2465 "permissionId": "A String", # The user's ID as visible in the permissions collection.
2466 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
2467 "emailAddress": "A String", # The email address of the user.
2468 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]2469 "shortcutDetails": { # Shortcut file details. Only populated for shortcut files, which have the mimeType field set to application/vnd.google-apps.shortcut.
2470 "targetId": "A String", # The ID of the file that this shortcut points to.
2471 "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.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]2472 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2473 "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.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]2474 "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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]2475 "lastModifyingUser": { # Information about a Drive user. # The last user to modify this file.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]2476 "picture": { # The user's profile picture.
2477 "url": "A String", # A URL that points to a profile picture of this user.
2478 },
2479 "kind": "drive#user", # This is always drive#user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]2480 "displayName": "A String", # A plain text displayable name for this user.
2481 "permissionId": "A String", # The user's ID as visible in the permissions collection.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]2482 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
2483 "emailAddress": "A String", # The email address of the user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]2484 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]2485 "copyable": True or False, # Deprecated: use capabilities/canCopy.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2486 "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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]2487 "markedViewedByMeDate": "A String", # Deprecated.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2488 "ownerNames": [ # Name(s) of the owner(s) of this file. Not populated for items in shared drives.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]2489 "A String",
2490 ],
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]2491 "capabilities": { # Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2492 "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.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]2493 "canUntrash": True or False, # Whether the current user can restore this file from trash.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2494 "canMoveItemWithinTeamDrive": True or False, # Deprecated - use canMoveItemWithinDrive instead.
2495 "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.
2496 "canMoveChildrenWithinTeamDrive": True or False, # Deprecated - use canMoveChildrenWithinDrive instead.
2497 "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.
2498 "canRename": True or False, # Whether the current user can rename this file.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]2499 "canModifyContent": True or False, # Whether the current user can modify the content of this file.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2500 "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.
2501 "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.
2502 "canChangeRestrictedDownload": True or False, # Deprecated
2503 "canShare": True or False, # Whether the current user can modify the sharing settings for this file.
2504 "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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]2505 "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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2506 "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.
2507 "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.
2508 "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.
2509 "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.
2510 "canMoveItemIntoTeamDrive": True or False, # Deprecated - use canMoveItemOutOfDrive instead.
2511 "canMoveItemOutOfTeamDrive": True or False, # Deprecated - use canMoveItemOutOfDrive instead.
2512 "canComment": True or False, # Whether the current user can comment on this file.
2513 "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.
2514 "canTrash": True or False, # Whether the current user can move this file to trash.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]2515 "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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2516 "canDelete": True or False, # Whether the current user can delete this file.
2517 "canMoveTeamDriveItem": True or False, # Deprecated - use canMoveItemWithinDrive or canMoveItemOutOfDrive instead.
2518 "canDownload": True or False, # Whether the current user can download this file.
2519 "canChangeCopyRequiresWriterPermission": True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this file.
2520 "canMoveChildrenOutOfTeamDrive": True or False, # Deprecated - use canMoveChildrenOutOfDrive instead.
2521 "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.
2522 "canReadTeamDrive": True or False, # Deprecated - use canReadDrive instead.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]2523 "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.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]2524 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]2525 "sharedWithMeDate": "A String", # Time at which this file was shared with the user (formatted RFC 3339 timestamp).
2526 "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.
2527 "etag": "A String", # ETag of the file.
2528 "parents": [ # Collection of parent folders which contain this file.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2529 # 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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]2530 { # A reference to a file's parent.
2531 "selfLink": "A String", # A link back to this reference.
2532 "kind": "drive#parentReference", # This is always drive#parentReference.
2533 "id": "A String", # The ID of the parent.
2534 "isRoot": True or False, # Whether or not the parent is the root folder.
2535 "parentLink": "A String", # A link to the parent.
2536 },
2537 ],
2538 "exportLinks": { # Links for exporting Google Docs to specific formats.
2539 "a_key": "A String", # A mapping from export format to URL
2540 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2541 "shareable": True or False, # Deprecated: use capabilities/canShare.
2542 "copyRequiresWriterPermission": True or False, # Whether the options to copy, print, or download this file, should be disabled for readers and commenters.
2543 "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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]2544 "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.
2545 "a_key": "A String",
2546 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]2547 "canReadRevisions": True or False, # Deprecated: use capabilities/canReadRevisions.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]2548 "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.
2549 "exposureBias": 3.14, # The exposure bias of the photo (APEX value).
2550 "exposureTime": 3.14, # The length of the exposure, in seconds.
2551 "cameraMake": "A String", # The make of the camera used to create the photo.
2552 "maxApertureValue": 3.14, # The smallest f-number of the lens at the focal length used to create the photo (APEX value).
2553 "isoSpeed": 42, # The ISO speed used to create the photo.
2554 "focalLength": 3.14, # The focal length used to create the photo, in millimeters.
2555 "exposureMode": "A String", # The exposure mode used to create the photo.
2556 "colorSpace": "A String", # The color space of the photo.
2557 "location": { # Geographic location information stored in the image.
2558 "latitude": 3.14, # The latitude stored in the image.
2559 "altitude": 3.14, # The altitude stored in the image.
2560 "longitude": 3.14, # The longitude stored in the image.
2561 },
2562 "subjectDistance": 42, # The distance to the subject of the photo, in meters.
2563 "height": 42, # The height of the image in pixels.
2564 "lens": "A String", # The lens used to create the photo.
2565 "date": "A String", # The date and time the photo was taken (EXIF format timestamp).
2566 "width": 42, # The width of the image in pixels.
2567 "meteringMode": "A String", # The metering mode used to create the photo.
2568 "flashUsed": True or False, # Whether a flash was used to create the photo.
2569 "aperture": 3.14, # The aperture used to create the photo (f-number).
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]2570 "rotation": 42, # The number of clockwise 90 degree rotations applied from the image's original orientation.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]2571 "sensor": "A String", # The type of sensor used to create the photo.
2572 "whiteBalance": "A String", # The white balance mode used to create the photo.
2573 "cameraModel": "A String", # The model of the camera used to create the photo.
2574 },
2575 "description": "A String", # A short description of the file.
2576 "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.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]2577 "videoMediaMetadata": { # Metadata about video media. This will only be present for video types.
2578 "width": 42, # The width of the video in pixels.
2579 "durationMillis": "A String", # The duration of the video in milliseconds.
2580 "height": 42, # The height of the video in pixels.
2581 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]2582 "editable": True or False, # Deprecated: use capabilities/canEdit.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]2583 "kind": "drive#file", # The type of file. This is always drive#file.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]2584 "canComment": True or False, # Deprecated: use capabilities/canComment.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]2585 "quotaBytesUsed": "A String", # The number of quota bytes used by this file.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]2586 "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.
2587 "picture": { # The user's profile picture.
2588 "url": "A String", # A URL that points to a profile picture of this user.
2589 },
2590 "kind": "drive#user", # This is always drive#user.
2591 "displayName": "A String", # A plain text displayable name for this user.
2592 "permissionId": "A String", # The user's ID as visible in the permissions collection.
2593 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
2594 "emailAddress": "A String", # The email address of the user.
2595 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2596 "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.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]2597 "createdDate": "A String", # Create time for this file (formatted RFC 3339 timestamp).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2598 "teamDriveId": "A String", # Deprecated - use driveId instead.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]2599 "properties": [ # The list of properties.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]2600 { # A key-value pair attached to a file that is either public or private to an application.
2601 # The following limits apply to file properties:
2602 # - Maximum of 100 properties total per file
2603 # - Maximum of 30 private properties per app
2604 # - Maximum of 30 public properties
2605 # - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]2606 "kind": "drive#property", # This is always drive#property.
2607 "value": "A String", # The value of this property.
2608 "etag": "A String", # ETag of the property.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2609 "visibility": "A String", # The visibility of this property. Allowed values are PRIVATE and PUBLIC. (Default: PRIVATE)
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]2610 "key": "A String", # The key of this property.
2611 "selfLink": "A String", # The link back to this property.
2612 },
2613 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2614 "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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]2615 "iconLink": "A String", # A link to the file's icon.
2616 "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.
2617 "embedLink": "A String", # A link for embedding the file.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]2618 "alternateLink": "A String", # A link for opening the file in a relevant Google editor or viewer.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2619 "shared": True or False, # Whether the file has been shared. Not populated for items in shared drives.
2620 "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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]2621 "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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2622 "thumbnail": { # A thumbnail for the file. This will only be used if a standard thumbnail cannot be generated.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]2623 "mimeType": "A String", # The MIME type of the thumbnail.
2624 "image": "A String", # The URL-safe Base64 encoded bytes of the thumbnail image. It should conform to RFC 4648 section 5.
2625 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2626 "driveId": "A String", # ID of the shared drive the file resides in. Only populated for items in shared drives.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]2627 "userPermission": { # A permission for a file. # The permissions for the authenticated user on this file.
2628 "withLink": True or False, # Whether the link is required for this permission.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]2629 "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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2630 "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.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]2631 {
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]2632 "role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible:
2633 # - organizer
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2634 # - fileOrganizer
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]2635 # - writer
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2636 # - reader
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]2637 "inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2638 "permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible:
2639 # - file
2640 # - member
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]2641 "additionalRoles": [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future.
2642 "A String",
2643 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]2644 "inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field.
2645 },
2646 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2647 "name": "A String", # The name for this permission.
2648 "teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead.
2649 {
2650 "inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead.
2651 "role": "A String", # Deprecated - use permissionDetails/role instead.
2652 "additionalRoles": [ # Deprecated - use permissionDetails/additionalRoles instead.
2653 "A String",
2654 ],
2655 "teamDrivePermissionType": "A String", # Deprecated - use permissionDetails/permissionType instead.
2656 "inherited": True or False, # Deprecated - use permissionDetails/inherited instead.
2657 },
2658 ],
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]2659 "deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]2660 "kind": "drive#permission", # This is always drive#permission.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]2661 "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.
2662 "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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2663 "authKey": "A String", # Deprecated.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]2664 "etag": "A String", # The ETag of the permission.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]2665 "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.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]2666 "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]2667 # - They cannot be set on shared drive items
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]2668 # - They can only be set on user and group permissions
2669 # - The date must be in the future
2670 # - The date cannot be more than a year in the future
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2671 # - The date can only be set on drive.permissions.update or drive.permissions.patch requests
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]2672 "role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed:
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]2673 # - owner
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2674 # - organizer
2675 # - fileOrganizer
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]2676 # - writer
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2677 # - reader
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]2678 "type": "A String", # The account type. Allowed values are:
2679 # - user
2680 # - group
2681 # - domain
2682 # - anyone
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]2683 "additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]2684 "A String",
2685 ],
2686 "selfLink": "A String", # A link back to this permission.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]2687 "photoLink": "A String", # A link to the profile photo, if available.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]2688 },
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]2689 "spaces": [ # The list of spaces which contain the file. Supported values are 'drive', 'appDataFolder' and 'photos'.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]2690 "A String",
2691 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2692 "permissionIds": [ # List of permission IDs for users with access to this file.
2693 "A String",
2694 ],
2695 "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.
2696 "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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]2697 "hasAugmentedPermissions": True or False, # Whether there are permissions directly on this file. This field is only populated for items in shared drives.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2698 "permissions": [ # The list of permissions for users with access to this file. Not populated for items in shared drives.
2699 { # A permission for a file.
2700 "withLink": True or False, # Whether the link is required for this permission.
2701 "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.
2702 "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.
2703 {
2704 "role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible:
2705 # - organizer
2706 # - fileOrganizer
2707 # - writer
2708 # - reader
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]2709 "inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2710 "permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible:
2711 # - file
2712 # - member
2713 "additionalRoles": [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future.
2714 "A String",
2715 ],
2716 "inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field.
2717 },
2718 ],
2719 "name": "A String", # The name for this permission.
2720 "teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead.
2721 {
2722 "inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead.
2723 "role": "A String", # Deprecated - use permissionDetails/role instead.
2724 "additionalRoles": [ # Deprecated - use permissionDetails/additionalRoles instead.
2725 "A String",
2726 ],
2727 "teamDrivePermissionType": "A String", # Deprecated - use permissionDetails/permissionType instead.
2728 "inherited": True or False, # Deprecated - use permissionDetails/inherited instead.
2729 },
2730 ],
2731 "deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.
2732 "kind": "drive#permission", # This is always drive#permission.
2733 "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.
2734 "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.
2735 "authKey": "A String", # Deprecated.
2736 "etag": "A String", # The ETag of the permission.
2737 "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.
2738 "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]2739 # - They cannot be set on shared drive items
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2740 # - They can only be set on user and group permissions
2741 # - The date must be in the future
2742 # - The date cannot be more than a year in the future
2743 # - The date can only be set on drive.permissions.update or drive.permissions.patch requests
2744 "role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed:
2745 # - owner
2746 # - organizer
2747 # - fileOrganizer
2748 # - writer
2749 # - reader
2750 "type": "A String", # The account type. Allowed values are:
2751 # - user
2752 # - group
2753 # - domain
2754 # - anyone
2755 "additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future.
2756 "A String",
2757 ],
2758 "selfLink": "A String", # A link back to this permission.
2759 "photoLink": "A String", # A link to the profile photo, if available.
2760 },
2761 ],
2762 "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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]2763 "selfLink": "A String", # A link back to this file.
2764 "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.
2765}
2766
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2767 supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]2768 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.
2769 modifiedDateBehavior: string, Determines the behavior in which modifiedDate is updated. This overrides setModifiedDate.
2770 Allowed values
2771 fromBody - Set modifiedDate to the value provided in the body of the request. No change if no value was provided.
2772 fromBodyIfNeeded - Set modifiedDate to the value provided in the body of the request depending on other contents of the update.
2773 fromBodyOrNow - Set modifiedDate to the value provided in the body of the request, or to the current time if no value was provided.
2774 noChange - Maintain the previous value of modifiedDate.
2775 now - Set modifiedDate to the current time.
2776 nowIfNeeded - Set modifiedDate to the current time depending on contents of the update.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]2777 ocrLanguage: string, If ocr is true, hints at the language to use. Valid values are BCP 47 codes.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]2778 pinned: boolean, Whether to pin the new revision. A file can have a maximum of 200 pinned revisions.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]2779 ocr: boolean, Whether to attempt OCR on .jpg, .png, .gif, or .pdf uploads.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]2780 addParents: string, Comma-separated list of parent IDs to add.
2781 removeParents: string, Comma-separated list of parent IDs to remove.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]2782 updateViewedDate: boolean, Whether to update the view date after successfully updating the file.
2783 timedTextTrackName: string, The timed text track name.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]2784 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 Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]2785 convert: boolean, This parameter is deprecated and has no function.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]2786 useContentAsIndexableText: boolean, Whether to use the content as indexable text.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2787 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.
2788 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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]2789 timedTextLanguage: string, The language of the timed text.
2790
2791Returns:
2792 An object of the form:
2793
2794 { # The metadata for a file.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]2795 "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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]2796 "lastViewedByMeDate": "A String", # Last time this file was viewed by the user (formatted RFC 3339 timestamp).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2797 "trashedDate": "A String", # The time that the item was trashed (formatted RFC 3339 timestamp). Only populated for items in shared drives.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]2798 "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.
2799 "appDataContents": True or False, # Whether this file is in the Application Data folder.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]2800 "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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]2801 "labels": { # A group of labels for the file.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2802 "restricted": True or False, # Deprecated - use copyRequiresWriterPermission instead.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]2803 "modified": True or False, # Whether the file has been modified by this user.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]2804 "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.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]2805 "hidden": True or False, # Deprecated.
2806 "starred": True or False, # Whether this file is starred by the user.
2807 "viewed": True or False, # Whether this file has been viewed by this user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]2808 },
2809 "indexableText": { # Indexable text attributes for the file (can only be written)
2810 "text": "A String", # The text to be indexed for this file.
2811 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]2812 "thumbnailVersion": "A String", # The thumbnail version for use in thumbnail cache invalidation.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]2813 "explicitlyTrashed": True or False, # Whether this file has been explicitly trashed, as opposed to recursively trashed.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]2814 "isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]2815 "lastModifyingUserName": "A String", # Name of the last user to modify this file.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2816 "writersCanShare": True or False, # Whether writers can share the document with other users. Not populated for items in shared drives.
2817 "owners": [ # The owner(s) of this file. Not populated for items in shared drives.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]2818 { # Information about a Drive user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]2819 "picture": { # The user's profile picture.
2820 "url": "A String", # A URL that points to a profile picture of this user.
2821 },
2822 "kind": "drive#user", # This is always drive#user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]2823 "displayName": "A String", # A plain text displayable name for this user.
2824 "permissionId": "A String", # The user's ID as visible in the permissions collection.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]2825 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
2826 "emailAddress": "A String", # The email address of the user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]2827 },
2828 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2829 "ownedByMe": True or False, # Whether the file is owned by the current user. Not populated for items in shared drives.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]2830 "id": "A String", # The ID of the file.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]2831 "sharingUser": { # Information about a Drive user. # User that shared the item with the current user, if available.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]2832 "picture": { # The user's profile picture.
2833 "url": "A String", # A URL that points to a profile picture of this user.
2834 },
2835 "kind": "drive#user", # This is always drive#user.
2836 "displayName": "A String", # A plain text displayable name for this user.
2837 "permissionId": "A String", # The user's ID as visible in the permissions collection.
2838 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
2839 "emailAddress": "A String", # The email address of the user.
2840 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]2841 "shortcutDetails": { # Shortcut file details. Only populated for shortcut files, which have the mimeType field set to application/vnd.google-apps.shortcut.
2842 "targetId": "A String", # The ID of the file that this shortcut points to.
2843 "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.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]2844 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2845 "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.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]2846 "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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]2847 "lastModifyingUser": { # Information about a Drive user. # The last user to modify this file.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]2848 "picture": { # The user's profile picture.
2849 "url": "A String", # A URL that points to a profile picture of this user.
2850 },
2851 "kind": "drive#user", # This is always drive#user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]2852 "displayName": "A String", # A plain text displayable name for this user.
2853 "permissionId": "A String", # The user's ID as visible in the permissions collection.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]2854 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
2855 "emailAddress": "A String", # The email address of the user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]2856 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]2857 "copyable": True or False, # Deprecated: use capabilities/canCopy.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2858 "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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]2859 "markedViewedByMeDate": "A String", # Deprecated.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2860 "ownerNames": [ # Name(s) of the owner(s) of this file. Not populated for items in shared drives.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]2861 "A String",
2862 ],
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]2863 "capabilities": { # Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2864 "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.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]2865 "canUntrash": True or False, # Whether the current user can restore this file from trash.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2866 "canMoveItemWithinTeamDrive": True or False, # Deprecated - use canMoveItemWithinDrive instead.
2867 "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.
2868 "canMoveChildrenWithinTeamDrive": True or False, # Deprecated - use canMoveChildrenWithinDrive instead.
2869 "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.
2870 "canRename": True or False, # Whether the current user can rename this file.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]2871 "canModifyContent": True or False, # Whether the current user can modify the content of this file.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2872 "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.
2873 "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.
2874 "canChangeRestrictedDownload": True or False, # Deprecated
2875 "canShare": True or False, # Whether the current user can modify the sharing settings for this file.
2876 "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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]2877 "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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2878 "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.
2879 "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.
2880 "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.
2881 "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.
2882 "canMoveItemIntoTeamDrive": True or False, # Deprecated - use canMoveItemOutOfDrive instead.
2883 "canMoveItemOutOfTeamDrive": True or False, # Deprecated - use canMoveItemOutOfDrive instead.
2884 "canComment": True or False, # Whether the current user can comment on this file.
2885 "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.
2886 "canTrash": True or False, # Whether the current user can move this file to trash.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]2887 "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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2888 "canDelete": True or False, # Whether the current user can delete this file.
2889 "canMoveTeamDriveItem": True or False, # Deprecated - use canMoveItemWithinDrive or canMoveItemOutOfDrive instead.
2890 "canDownload": True or False, # Whether the current user can download this file.
2891 "canChangeCopyRequiresWriterPermission": True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this file.
2892 "canMoveChildrenOutOfTeamDrive": True or False, # Deprecated - use canMoveChildrenOutOfDrive instead.
2893 "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.
2894 "canReadTeamDrive": True or False, # Deprecated - use canReadDrive instead.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]2895 "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.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]2896 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]2897 "sharedWithMeDate": "A String", # Time at which this file was shared with the user (formatted RFC 3339 timestamp).
2898 "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.
2899 "etag": "A String", # ETag of the file.
2900 "parents": [ # Collection of parent folders which contain this file.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2901 # 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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]2902 { # A reference to a file's parent.
2903 "selfLink": "A String", # A link back to this reference.
2904 "kind": "drive#parentReference", # This is always drive#parentReference.
2905 "id": "A String", # The ID of the parent.
2906 "isRoot": True or False, # Whether or not the parent is the root folder.
2907 "parentLink": "A String", # A link to the parent.
2908 },
2909 ],
2910 "exportLinks": { # Links for exporting Google Docs to specific formats.
2911 "a_key": "A String", # A mapping from export format to URL
2912 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2913 "shareable": True or False, # Deprecated: use capabilities/canShare.
2914 "copyRequiresWriterPermission": True or False, # Whether the options to copy, print, or download this file, should be disabled for readers and commenters.
2915 "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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]2916 "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.
2917 "a_key": "A String",
2918 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]2919 "canReadRevisions": True or False, # Deprecated: use capabilities/canReadRevisions.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]2920 "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.
2921 "exposureBias": 3.14, # The exposure bias of the photo (APEX value).
2922 "exposureTime": 3.14, # The length of the exposure, in seconds.
2923 "cameraMake": "A String", # The make of the camera used to create the photo.
2924 "maxApertureValue": 3.14, # The smallest f-number of the lens at the focal length used to create the photo (APEX value).
2925 "isoSpeed": 42, # The ISO speed used to create the photo.
2926 "focalLength": 3.14, # The focal length used to create the photo, in millimeters.
2927 "exposureMode": "A String", # The exposure mode used to create the photo.
2928 "colorSpace": "A String", # The color space of the photo.
2929 "location": { # Geographic location information stored in the image.
2930 "latitude": 3.14, # The latitude stored in the image.
2931 "altitude": 3.14, # The altitude stored in the image.
2932 "longitude": 3.14, # The longitude stored in the image.
2933 },
2934 "subjectDistance": 42, # The distance to the subject of the photo, in meters.
2935 "height": 42, # The height of the image in pixels.
2936 "lens": "A String", # The lens used to create the photo.
2937 "date": "A String", # The date and time the photo was taken (EXIF format timestamp).
2938 "width": 42, # The width of the image in pixels.
2939 "meteringMode": "A String", # The metering mode used to create the photo.
2940 "flashUsed": True or False, # Whether a flash was used to create the photo.
2941 "aperture": 3.14, # The aperture used to create the photo (f-number).
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]2942 "rotation": 42, # The number of clockwise 90 degree rotations applied from the image's original orientation.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]2943 "sensor": "A String", # The type of sensor used to create the photo.
2944 "whiteBalance": "A String", # The white balance mode used to create the photo.
2945 "cameraModel": "A String", # The model of the camera used to create the photo.
2946 },
2947 "description": "A String", # A short description of the file.
2948 "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.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]2949 "videoMediaMetadata": { # Metadata about video media. This will only be present for video types.
2950 "width": 42, # The width of the video in pixels.
2951 "durationMillis": "A String", # The duration of the video in milliseconds.
2952 "height": 42, # The height of the video in pixels.
2953 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]2954 "editable": True or False, # Deprecated: use capabilities/canEdit.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]2955 "kind": "drive#file", # The type of file. This is always drive#file.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]2956 "canComment": True or False, # Deprecated: use capabilities/canComment.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]2957 "quotaBytesUsed": "A String", # The number of quota bytes used by this file.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]2958 "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.
2959 "picture": { # The user's profile picture.
2960 "url": "A String", # A URL that points to a profile picture of this user.
2961 },
2962 "kind": "drive#user", # This is always drive#user.
2963 "displayName": "A String", # A plain text displayable name for this user.
2964 "permissionId": "A String", # The user's ID as visible in the permissions collection.
2965 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
2966 "emailAddress": "A String", # The email address of the user.
2967 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2968 "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.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]2969 "createdDate": "A String", # Create time for this file (formatted RFC 3339 timestamp).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2970 "teamDriveId": "A String", # Deprecated - use driveId instead.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]2971 "properties": [ # The list of properties.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]2972 { # A key-value pair attached to a file that is either public or private to an application.
2973 # The following limits apply to file properties:
2974 # - Maximum of 100 properties total per file
2975 # - Maximum of 30 private properties per app
2976 # - Maximum of 30 public properties
2977 # - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]2978 "kind": "drive#property", # This is always drive#property.
2979 "value": "A String", # The value of this property.
2980 "etag": "A String", # ETag of the property.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2981 "visibility": "A String", # The visibility of this property. Allowed values are PRIVATE and PUBLIC. (Default: PRIVATE)
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]2982 "key": "A String", # The key of this property.
2983 "selfLink": "A String", # The link back to this property.
2984 },
2985 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2986 "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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]2987 "iconLink": "A String", # A link to the file's icon.
2988 "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.
2989 "embedLink": "A String", # A link for embedding the file.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]2990 "alternateLink": "A String", # A link for opening the file in a relevant Google editor or viewer.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2991 "shared": True or False, # Whether the file has been shared. Not populated for items in shared drives.
2992 "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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]2993 "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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2994 "thumbnail": { # A thumbnail for the file. This will only be used if a standard thumbnail cannot be generated.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]2995 "mimeType": "A String", # The MIME type of the thumbnail.
2996 "image": "A String", # The URL-safe Base64 encoded bytes of the thumbnail image. It should conform to RFC 4648 section 5.
2997 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2998 "driveId": "A String", # ID of the shared drive the file resides in. Only populated for items in shared drives.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]2999 "userPermission": { # A permission for a file. # The permissions for the authenticated user on this file.
3000 "withLink": True or False, # Whether the link is required for this permission.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]3001 "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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3002 "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.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]3003 {
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]3004 "role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible:
3005 # - organizer
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3006 # - fileOrganizer
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]3007 # - writer
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3008 # - reader
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]3009 "inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3010 "permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible:
3011 # - file
3012 # - member
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]3013 "additionalRoles": [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future.
3014 "A String",
3015 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]3016 "inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field.
3017 },
3018 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3019 "name": "A String", # The name for this permission.
3020 "teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead.
3021 {
3022 "inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead.
3023 "role": "A String", # Deprecated - use permissionDetails/role instead.
3024 "additionalRoles": [ # Deprecated - use permissionDetails/additionalRoles instead.
3025 "A String",
3026 ],
3027 "teamDrivePermissionType": "A String", # Deprecated - use permissionDetails/permissionType instead.
3028 "inherited": True or False, # Deprecated - use permissionDetails/inherited instead.
3029 },
3030 ],
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]3031 "deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]3032 "kind": "drive#permission", # This is always drive#permission.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]3033 "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.
3034 "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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3035 "authKey": "A String", # Deprecated.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]3036 "etag": "A String", # The ETag of the permission.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]3037 "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.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]3038 "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]3039 # - They cannot be set on shared drive items
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]3040 # - They can only be set on user and group permissions
3041 # - The date must be in the future
3042 # - The date cannot be more than a year in the future
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3043 # - The date can only be set on drive.permissions.update or drive.permissions.patch requests
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]3044 "role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed:
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]3045 # - owner
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3046 # - organizer
3047 # - fileOrganizer
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]3048 # - writer
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3049 # - reader
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]3050 "type": "A String", # The account type. Allowed values are:
3051 # - user
3052 # - group
3053 # - domain
3054 # - anyone
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]3055 "additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]3056 "A String",
3057 ],
3058 "selfLink": "A String", # A link back to this permission.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]3059 "photoLink": "A String", # A link to the profile photo, if available.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]3060 },
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]3061 "spaces": [ # The list of spaces which contain the file. Supported values are 'drive', 'appDataFolder' and 'photos'.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]3062 "A String",
3063 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3064 "permissionIds": [ # List of permission IDs for users with access to this file.
3065 "A String",
3066 ],
3067 "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.
3068 "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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]3069 "hasAugmentedPermissions": True or False, # Whether there are permissions directly on this file. This field is only populated for items in shared drives.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3070 "permissions": [ # The list of permissions for users with access to this file. Not populated for items in shared drives.
3071 { # A permission for a file.
3072 "withLink": True or False, # Whether the link is required for this permission.
3073 "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.
3074 "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.
3075 {
3076 "role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible:
3077 # - organizer
3078 # - fileOrganizer
3079 # - writer
3080 # - reader
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]3081 "inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3082 "permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible:
3083 # - file
3084 # - member
3085 "additionalRoles": [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future.
3086 "A String",
3087 ],
3088 "inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field.
3089 },
3090 ],
3091 "name": "A String", # The name for this permission.
3092 "teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead.
3093 {
3094 "inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead.
3095 "role": "A String", # Deprecated - use permissionDetails/role instead.
3096 "additionalRoles": [ # Deprecated - use permissionDetails/additionalRoles instead.
3097 "A String",
3098 ],
3099 "teamDrivePermissionType": "A String", # Deprecated - use permissionDetails/permissionType instead.
3100 "inherited": True or False, # Deprecated - use permissionDetails/inherited instead.
3101 },
3102 ],
3103 "deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.
3104 "kind": "drive#permission", # This is always drive#permission.
3105 "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.
3106 "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.
3107 "authKey": "A String", # Deprecated.
3108 "etag": "A String", # The ETag of the permission.
3109 "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.
3110 "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]3111 # - They cannot be set on shared drive items
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3112 # - They can only be set on user and group permissions
3113 # - The date must be in the future
3114 # - The date cannot be more than a year in the future
3115 # - The date can only be set on drive.permissions.update or drive.permissions.patch requests
3116 "role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed:
3117 # - owner
3118 # - organizer
3119 # - fileOrganizer
3120 # - writer
3121 # - reader
3122 "type": "A String", # The account type. Allowed values are:
3123 # - user
3124 # - group
3125 # - domain
3126 # - anyone
3127 "additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future.
3128 "A String",
3129 ],
3130 "selfLink": "A String", # A link back to this permission.
3131 "photoLink": "A String", # A link to the profile photo, if available.
3132 },
3133 ],
3134 "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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]3135 "selfLink": "A String", # A link back to this file.
3136 "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.
3137 }</pre>
3138</div>
3139
3140<div class="method">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3141 <code class="details" id="touch">touch(fileId, supportsTeamDrives=None, supportsAllDrives=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]3142 <pre>Set the file's updated time to the current server time.
3143
3144Args:
3145 fileId: string, The ID of the file to update. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3146 supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead.
3147 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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]3148
3149Returns:
3150 An object of the form:
3151
3152 { # The metadata for a file.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]3153 "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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]3154 "lastViewedByMeDate": "A String", # Last time this file was viewed by the user (formatted RFC 3339 timestamp).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3155 "trashedDate": "A String", # The time that the item was trashed (formatted RFC 3339 timestamp). Only populated for items in shared drives.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]3156 "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.
3157 "appDataContents": True or False, # Whether this file is in the Application Data folder.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]3158 "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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]3159 "labels": { # A group of labels for the file.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3160 "restricted": True or False, # Deprecated - use copyRequiresWriterPermission instead.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]3161 "modified": True or False, # Whether the file has been modified by this user.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]3162 "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.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]3163 "hidden": True or False, # Deprecated.
3164 "starred": True or False, # Whether this file is starred by the user.
3165 "viewed": True or False, # Whether this file has been viewed by this user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]3166 },
3167 "indexableText": { # Indexable text attributes for the file (can only be written)
3168 "text": "A String", # The text to be indexed for this file.
3169 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]3170 "thumbnailVersion": "A String", # The thumbnail version for use in thumbnail cache invalidation.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]3171 "explicitlyTrashed": True or False, # Whether this file has been explicitly trashed, as opposed to recursively trashed.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]3172 "isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]3173 "lastModifyingUserName": "A String", # Name of the last user to modify this file.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3174 "writersCanShare": True or False, # Whether writers can share the document with other users. Not populated for items in shared drives.
3175 "owners": [ # The owner(s) of this file. Not populated for items in shared drives.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]3176 { # Information about a Drive user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]3177 "picture": { # The user's profile picture.
3178 "url": "A String", # A URL that points to a profile picture of this user.
3179 },
3180 "kind": "drive#user", # This is always drive#user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]3181 "displayName": "A String", # A plain text displayable name for this user.
3182 "permissionId": "A String", # The user's ID as visible in the permissions collection.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]3183 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
3184 "emailAddress": "A String", # The email address of the user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]3185 },
3186 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3187 "ownedByMe": True or False, # Whether the file is owned by the current user. Not populated for items in shared drives.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]3188 "id": "A String", # The ID of the file.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]3189 "sharingUser": { # Information about a Drive user. # User that shared the item with the current user, if available.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]3190 "picture": { # The user's profile picture.
3191 "url": "A String", # A URL that points to a profile picture of this user.
3192 },
3193 "kind": "drive#user", # This is always drive#user.
3194 "displayName": "A String", # A plain text displayable name for this user.
3195 "permissionId": "A String", # The user's ID as visible in the permissions collection.
3196 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
3197 "emailAddress": "A String", # The email address of the user.
3198 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]3199 "shortcutDetails": { # Shortcut file details. Only populated for shortcut files, which have the mimeType field set to application/vnd.google-apps.shortcut.
3200 "targetId": "A String", # The ID of the file that this shortcut points to.
3201 "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.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]3202 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3203 "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.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]3204 "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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]3205 "lastModifyingUser": { # Information about a Drive user. # The last user to modify this file.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]3206 "picture": { # The user's profile picture.
3207 "url": "A String", # A URL that points to a profile picture of this user.
3208 },
3209 "kind": "drive#user", # This is always drive#user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]3210 "displayName": "A String", # A plain text displayable name for this user.
3211 "permissionId": "A String", # The user's ID as visible in the permissions collection.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]3212 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
3213 "emailAddress": "A String", # The email address of the user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]3214 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]3215 "copyable": True or False, # Deprecated: use capabilities/canCopy.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3216 "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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]3217 "markedViewedByMeDate": "A String", # Deprecated.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3218 "ownerNames": [ # Name(s) of the owner(s) of this file. Not populated for items in shared drives.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]3219 "A String",
3220 ],
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]3221 "capabilities": { # Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3222 "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.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]3223 "canUntrash": True or False, # Whether the current user can restore this file from trash.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3224 "canMoveItemWithinTeamDrive": True or False, # Deprecated - use canMoveItemWithinDrive instead.
3225 "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.
3226 "canMoveChildrenWithinTeamDrive": True or False, # Deprecated - use canMoveChildrenWithinDrive instead.
3227 "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.
3228 "canRename": True or False, # Whether the current user can rename this file.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]3229 "canModifyContent": True or False, # Whether the current user can modify the content of this file.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3230 "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.
3231 "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.
3232 "canChangeRestrictedDownload": True or False, # Deprecated
3233 "canShare": True or False, # Whether the current user can modify the sharing settings for this file.
3234 "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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]3235 "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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3236 "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.
3237 "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.
3238 "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.
3239 "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.
3240 "canMoveItemIntoTeamDrive": True or False, # Deprecated - use canMoveItemOutOfDrive instead.
3241 "canMoveItemOutOfTeamDrive": True or False, # Deprecated - use canMoveItemOutOfDrive instead.
3242 "canComment": True or False, # Whether the current user can comment on this file.
3243 "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.
3244 "canTrash": True or False, # Whether the current user can move this file to trash.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]3245 "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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3246 "canDelete": True or False, # Whether the current user can delete this file.
3247 "canMoveTeamDriveItem": True or False, # Deprecated - use canMoveItemWithinDrive or canMoveItemOutOfDrive instead.
3248 "canDownload": True or False, # Whether the current user can download this file.
3249 "canChangeCopyRequiresWriterPermission": True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this file.
3250 "canMoveChildrenOutOfTeamDrive": True or False, # Deprecated - use canMoveChildrenOutOfDrive instead.
3251 "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.
3252 "canReadTeamDrive": True or False, # Deprecated - use canReadDrive instead.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]3253 "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.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]3254 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]3255 "sharedWithMeDate": "A String", # Time at which this file was shared with the user (formatted RFC 3339 timestamp).
3256 "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.
3257 "etag": "A String", # ETag of the file.
3258 "parents": [ # Collection of parent folders which contain this file.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3259 # 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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]3260 { # A reference to a file's parent.
3261 "selfLink": "A String", # A link back to this reference.
3262 "kind": "drive#parentReference", # This is always drive#parentReference.
3263 "id": "A String", # The ID of the parent.
3264 "isRoot": True or False, # Whether or not the parent is the root folder.
3265 "parentLink": "A String", # A link to the parent.
3266 },
3267 ],
3268 "exportLinks": { # Links for exporting Google Docs to specific formats.
3269 "a_key": "A String", # A mapping from export format to URL
3270 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3271 "shareable": True or False, # Deprecated: use capabilities/canShare.
3272 "copyRequiresWriterPermission": True or False, # Whether the options to copy, print, or download this file, should be disabled for readers and commenters.
3273 "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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]3274 "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.
3275 "a_key": "A String",
3276 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]3277 "canReadRevisions": True or False, # Deprecated: use capabilities/canReadRevisions.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]3278 "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.
3279 "exposureBias": 3.14, # The exposure bias of the photo (APEX value).
3280 "exposureTime": 3.14, # The length of the exposure, in seconds.
3281 "cameraMake": "A String", # The make of the camera used to create the photo.
3282 "maxApertureValue": 3.14, # The smallest f-number of the lens at the focal length used to create the photo (APEX value).
3283 "isoSpeed": 42, # The ISO speed used to create the photo.
3284 "focalLength": 3.14, # The focal length used to create the photo, in millimeters.
3285 "exposureMode": "A String", # The exposure mode used to create the photo.
3286 "colorSpace": "A String", # The color space of the photo.
3287 "location": { # Geographic location information stored in the image.
3288 "latitude": 3.14, # The latitude stored in the image.
3289 "altitude": 3.14, # The altitude stored in the image.
3290 "longitude": 3.14, # The longitude stored in the image.
3291 },
3292 "subjectDistance": 42, # The distance to the subject of the photo, in meters.
3293 "height": 42, # The height of the image in pixels.
3294 "lens": "A String", # The lens used to create the photo.
3295 "date": "A String", # The date and time the photo was taken (EXIF format timestamp).
3296 "width": 42, # The width of the image in pixels.
3297 "meteringMode": "A String", # The metering mode used to create the photo.
3298 "flashUsed": True or False, # Whether a flash was used to create the photo.
3299 "aperture": 3.14, # The aperture used to create the photo (f-number).
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]3300 "rotation": 42, # The number of clockwise 90 degree rotations applied from the image's original orientation.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]3301 "sensor": "A String", # The type of sensor used to create the photo.
3302 "whiteBalance": "A String", # The white balance mode used to create the photo.
3303 "cameraModel": "A String", # The model of the camera used to create the photo.
3304 },
3305 "description": "A String", # A short description of the file.
3306 "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.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]3307 "videoMediaMetadata": { # Metadata about video media. This will only be present for video types.
3308 "width": 42, # The width of the video in pixels.
3309 "durationMillis": "A String", # The duration of the video in milliseconds.
3310 "height": 42, # The height of the video in pixels.
3311 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]3312 "editable": True or False, # Deprecated: use capabilities/canEdit.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]3313 "kind": "drive#file", # The type of file. This is always drive#file.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]3314 "canComment": True or False, # Deprecated: use capabilities/canComment.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]3315 "quotaBytesUsed": "A String", # The number of quota bytes used by this file.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]3316 "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.
3317 "picture": { # The user's profile picture.
3318 "url": "A String", # A URL that points to a profile picture of this user.
3319 },
3320 "kind": "drive#user", # This is always drive#user.
3321 "displayName": "A String", # A plain text displayable name for this user.
3322 "permissionId": "A String", # The user's ID as visible in the permissions collection.
3323 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
3324 "emailAddress": "A String", # The email address of the user.
3325 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3326 "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.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]3327 "createdDate": "A String", # Create time for this file (formatted RFC 3339 timestamp).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3328 "teamDriveId": "A String", # Deprecated - use driveId instead.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]3329 "properties": [ # The list of properties.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]3330 { # A key-value pair attached to a file that is either public or private to an application.
3331 # The following limits apply to file properties:
3332 # - Maximum of 100 properties total per file
3333 # - Maximum of 30 private properties per app
3334 # - Maximum of 30 public properties
3335 # - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]3336 "kind": "drive#property", # This is always drive#property.
3337 "value": "A String", # The value of this property.
3338 "etag": "A String", # ETag of the property.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3339 "visibility": "A String", # The visibility of this property. Allowed values are PRIVATE and PUBLIC. (Default: PRIVATE)
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]3340 "key": "A String", # The key of this property.
3341 "selfLink": "A String", # The link back to this property.
3342 },
3343 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3344 "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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]3345 "iconLink": "A String", # A link to the file's icon.
3346 "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.
3347 "embedLink": "A String", # A link for embedding the file.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]3348 "alternateLink": "A String", # A link for opening the file in a relevant Google editor or viewer.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3349 "shared": True or False, # Whether the file has been shared. Not populated for items in shared drives.
3350 "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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]3351 "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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3352 "thumbnail": { # A thumbnail for the file. This will only be used if a standard thumbnail cannot be generated.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]3353 "mimeType": "A String", # The MIME type of the thumbnail.
3354 "image": "A String", # The URL-safe Base64 encoded bytes of the thumbnail image. It should conform to RFC 4648 section 5.
3355 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3356 "driveId": "A String", # ID of the shared drive the file resides in. Only populated for items in shared drives.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]3357 "userPermission": { # A permission for a file. # The permissions for the authenticated user on this file.
3358 "withLink": True or False, # Whether the link is required for this permission.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]3359 "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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3360 "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.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]3361 {
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]3362 "role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible:
3363 # - organizer
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3364 # - fileOrganizer
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]3365 # - writer
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3366 # - reader
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]3367 "inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3368 "permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible:
3369 # - file
3370 # - member
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]3371 "additionalRoles": [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future.
3372 "A String",
3373 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]3374 "inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field.
3375 },
3376 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3377 "name": "A String", # The name for this permission.
3378 "teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead.
3379 {
3380 "inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead.
3381 "role": "A String", # Deprecated - use permissionDetails/role instead.
3382 "additionalRoles": [ # Deprecated - use permissionDetails/additionalRoles instead.
3383 "A String",
3384 ],
3385 "teamDrivePermissionType": "A String", # Deprecated - use permissionDetails/permissionType instead.
3386 "inherited": True or False, # Deprecated - use permissionDetails/inherited instead.
3387 },
3388 ],
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]3389 "deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]3390 "kind": "drive#permission", # This is always drive#permission.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]3391 "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.
3392 "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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3393 "authKey": "A String", # Deprecated.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]3394 "etag": "A String", # The ETag of the permission.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]3395 "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.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]3396 "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]3397 # - They cannot be set on shared drive items
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]3398 # - They can only be set on user and group permissions
3399 # - The date must be in the future
3400 # - The date cannot be more than a year in the future
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3401 # - The date can only be set on drive.permissions.update or drive.permissions.patch requests
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]3402 "role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed:
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]3403 # - owner
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3404 # - organizer
3405 # - fileOrganizer
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]3406 # - writer
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3407 # - reader
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]3408 "type": "A String", # The account type. Allowed values are:
3409 # - user
3410 # - group
3411 # - domain
3412 # - anyone
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]3413 "additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]3414 "A String",
3415 ],
3416 "selfLink": "A String", # A link back to this permission.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]3417 "photoLink": "A String", # A link to the profile photo, if available.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]3418 },
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]3419 "spaces": [ # The list of spaces which contain the file. Supported values are 'drive', 'appDataFolder' and 'photos'.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]3420 "A String",
3421 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3422 "permissionIds": [ # List of permission IDs for users with access to this file.
3423 "A String",
3424 ],
3425 "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.
3426 "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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]3427 "hasAugmentedPermissions": True or False, # Whether there are permissions directly on this file. This field is only populated for items in shared drives.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3428 "permissions": [ # The list of permissions for users with access to this file. Not populated for items in shared drives.
3429 { # A permission for a file.
3430 "withLink": True or False, # Whether the link is required for this permission.
3431 "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.
3432 "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.
3433 {
3434 "role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible:
3435 # - organizer
3436 # - fileOrganizer
3437 # - writer
3438 # - reader
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]3439 "inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3440 "permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible:
3441 # - file
3442 # - member
3443 "additionalRoles": [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future.
3444 "A String",
3445 ],
3446 "inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field.
3447 },
3448 ],
3449 "name": "A String", # The name for this permission.
3450 "teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead.
3451 {
3452 "inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead.
3453 "role": "A String", # Deprecated - use permissionDetails/role instead.
3454 "additionalRoles": [ # Deprecated - use permissionDetails/additionalRoles instead.
3455 "A String",
3456 ],
3457 "teamDrivePermissionType": "A String", # Deprecated - use permissionDetails/permissionType instead.
3458 "inherited": True or False, # Deprecated - use permissionDetails/inherited instead.
3459 },
3460 ],
3461 "deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.
3462 "kind": "drive#permission", # This is always drive#permission.
3463 "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.
3464 "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.
3465 "authKey": "A String", # Deprecated.
3466 "etag": "A String", # The ETag of the permission.
3467 "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.
3468 "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]3469 # - They cannot be set on shared drive items
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3470 # - They can only be set on user and group permissions
3471 # - The date must be in the future
3472 # - The date cannot be more than a year in the future
3473 # - The date can only be set on drive.permissions.update or drive.permissions.patch requests
3474 "role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed:
3475 # - owner
3476 # - organizer
3477 # - fileOrganizer
3478 # - writer
3479 # - reader
3480 "type": "A String", # The account type. Allowed values are:
3481 # - user
3482 # - group
3483 # - domain
3484 # - anyone
3485 "additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future.
3486 "A String",
3487 ],
3488 "selfLink": "A String", # A link back to this permission.
3489 "photoLink": "A String", # A link to the profile photo, if available.
3490 },
3491 ],
3492 "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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]3493 "selfLink": "A String", # A link back to this file.
3494 "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.
3495 }</pre>
3496</div>
3497
3498<div class="method">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3499 <code class="details" id="trash">trash(fileId, supportsTeamDrives=None, supportsAllDrives=None)</code>
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 Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]3501
3502Args:
3503 fileId: string, The ID of the file to trash. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3504 supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead.
3505 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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]3506
3507Returns:
3508 An object of the form:
3509
3510 { # The metadata for a file.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]3511 "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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]3512 "lastViewedByMeDate": "A String", # Last time this file was viewed by the user (formatted RFC 3339 timestamp).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3513 "trashedDate": "A String", # The time that the item was trashed (formatted RFC 3339 timestamp). Only populated for items in shared drives.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]3514 "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.
3515 "appDataContents": True or False, # Whether this file is in the Application Data folder.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]3516 "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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]3517 "labels": { # A group of labels for the file.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3518 "restricted": True or False, # Deprecated - use copyRequiresWriterPermission instead.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]3519 "modified": True or False, # Whether the file has been modified by this user.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]3520 "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.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]3521 "hidden": True or False, # Deprecated.
3522 "starred": True or False, # Whether this file is starred by the user.
3523 "viewed": True or False, # Whether this file has been viewed by this user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]3524 },
3525 "indexableText": { # Indexable text attributes for the file (can only be written)
3526 "text": "A String", # The text to be indexed for this file.
3527 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]3528 "thumbnailVersion": "A String", # The thumbnail version for use in thumbnail cache invalidation.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]3529 "explicitlyTrashed": True or False, # Whether this file has been explicitly trashed, as opposed to recursively trashed.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]3530 "isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]3531 "lastModifyingUserName": "A String", # Name of the last user to modify this file.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3532 "writersCanShare": True or False, # Whether writers can share the document with other users. Not populated for items in shared drives.
3533 "owners": [ # The owner(s) of this file. Not populated for items in shared drives.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]3534 { # Information about a Drive user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]3535 "picture": { # The user's profile picture.
3536 "url": "A String", # A URL that points to a profile picture of this user.
3537 },
3538 "kind": "drive#user", # This is always drive#user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]3539 "displayName": "A String", # A plain text displayable name for this user.
3540 "permissionId": "A String", # The user's ID as visible in the permissions collection.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]3541 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
3542 "emailAddress": "A String", # The email address of the user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]3543 },
3544 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3545 "ownedByMe": True or False, # Whether the file is owned by the current user. Not populated for items in shared drives.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]3546 "id": "A String", # The ID of the file.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]3547 "sharingUser": { # Information about a Drive user. # User that shared the item with the current user, if available.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]3548 "picture": { # The user's profile picture.
3549 "url": "A String", # A URL that points to a profile picture of this user.
3550 },
3551 "kind": "drive#user", # This is always drive#user.
3552 "displayName": "A String", # A plain text displayable name for this user.
3553 "permissionId": "A String", # The user's ID as visible in the permissions collection.
3554 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
3555 "emailAddress": "A String", # The email address of the user.
3556 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]3557 "shortcutDetails": { # Shortcut file details. Only populated for shortcut files, which have the mimeType field set to application/vnd.google-apps.shortcut.
3558 "targetId": "A String", # The ID of the file that this shortcut points to.
3559 "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.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]3560 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3561 "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.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]3562 "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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]3563 "lastModifyingUser": { # Information about a Drive user. # The last user to modify this file.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]3564 "picture": { # The user's profile picture.
3565 "url": "A String", # A URL that points to a profile picture of this user.
3566 },
3567 "kind": "drive#user", # This is always drive#user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]3568 "displayName": "A String", # A plain text displayable name for this user.
3569 "permissionId": "A String", # The user's ID as visible in the permissions collection.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]3570 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
3571 "emailAddress": "A String", # The email address of the user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]3572 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]3573 "copyable": True or False, # Deprecated: use capabilities/canCopy.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3574 "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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]3575 "markedViewedByMeDate": "A String", # Deprecated.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3576 "ownerNames": [ # Name(s) of the owner(s) of this file. Not populated for items in shared drives.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]3577 "A String",
3578 ],
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]3579 "capabilities": { # Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3580 "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.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]3581 "canUntrash": True or False, # Whether the current user can restore this file from trash.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3582 "canMoveItemWithinTeamDrive": True or False, # Deprecated - use canMoveItemWithinDrive instead.
3583 "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.
3584 "canMoveChildrenWithinTeamDrive": True or False, # Deprecated - use canMoveChildrenWithinDrive instead.
3585 "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.
3586 "canRename": True or False, # Whether the current user can rename this file.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]3587 "canModifyContent": True or False, # Whether the current user can modify the content of this file.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3588 "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.
3589 "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.
3590 "canChangeRestrictedDownload": True or False, # Deprecated
3591 "canShare": True or False, # Whether the current user can modify the sharing settings for this file.
3592 "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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]3593 "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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3594 "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.
3595 "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.
3596 "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.
3597 "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.
3598 "canMoveItemIntoTeamDrive": True or False, # Deprecated - use canMoveItemOutOfDrive instead.
3599 "canMoveItemOutOfTeamDrive": True or False, # Deprecated - use canMoveItemOutOfDrive instead.
3600 "canComment": True or False, # Whether the current user can comment on this file.
3601 "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.
3602 "canTrash": True or False, # Whether the current user can move this file to trash.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]3603 "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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3604 "canDelete": True or False, # Whether the current user can delete this file.
3605 "canMoveTeamDriveItem": True or False, # Deprecated - use canMoveItemWithinDrive or canMoveItemOutOfDrive instead.
3606 "canDownload": True or False, # Whether the current user can download this file.
3607 "canChangeCopyRequiresWriterPermission": True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this file.
3608 "canMoveChildrenOutOfTeamDrive": True or False, # Deprecated - use canMoveChildrenOutOfDrive instead.
3609 "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.
3610 "canReadTeamDrive": True or False, # Deprecated - use canReadDrive instead.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]3611 "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.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]3612 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]3613 "sharedWithMeDate": "A String", # Time at which this file was shared with the user (formatted RFC 3339 timestamp).
3614 "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.
3615 "etag": "A String", # ETag of the file.
3616 "parents": [ # Collection of parent folders which contain this file.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3617 # 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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]3618 { # A reference to a file's parent.
3619 "selfLink": "A String", # A link back to this reference.
3620 "kind": "drive#parentReference", # This is always drive#parentReference.
3621 "id": "A String", # The ID of the parent.
3622 "isRoot": True or False, # Whether or not the parent is the root folder.
3623 "parentLink": "A String", # A link to the parent.
3624 },
3625 ],
3626 "exportLinks": { # Links for exporting Google Docs to specific formats.
3627 "a_key": "A String", # A mapping from export format to URL
3628 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3629 "shareable": True or False, # Deprecated: use capabilities/canShare.
3630 "copyRequiresWriterPermission": True or False, # Whether the options to copy, print, or download this file, should be disabled for readers and commenters.
3631 "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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]3632 "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.
3633 "a_key": "A String",
3634 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]3635 "canReadRevisions": True or False, # Deprecated: use capabilities/canReadRevisions.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]3636 "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.
3637 "exposureBias": 3.14, # The exposure bias of the photo (APEX value).
3638 "exposureTime": 3.14, # The length of the exposure, in seconds.
3639 "cameraMake": "A String", # The make of the camera used to create the photo.
3640 "maxApertureValue": 3.14, # The smallest f-number of the lens at the focal length used to create the photo (APEX value).
3641 "isoSpeed": 42, # The ISO speed used to create the photo.
3642 "focalLength": 3.14, # The focal length used to create the photo, in millimeters.
3643 "exposureMode": "A String", # The exposure mode used to create the photo.
3644 "colorSpace": "A String", # The color space of the photo.
3645 "location": { # Geographic location information stored in the image.
3646 "latitude": 3.14, # The latitude stored in the image.
3647 "altitude": 3.14, # The altitude stored in the image.
3648 "longitude": 3.14, # The longitude stored in the image.
3649 },
3650 "subjectDistance": 42, # The distance to the subject of the photo, in meters.
3651 "height": 42, # The height of the image in pixels.
3652 "lens": "A String", # The lens used to create the photo.
3653 "date": "A String", # The date and time the photo was taken (EXIF format timestamp).
3654 "width": 42, # The width of the image in pixels.
3655 "meteringMode": "A String", # The metering mode used to create the photo.
3656 "flashUsed": True or False, # Whether a flash was used to create the photo.
3657 "aperture": 3.14, # The aperture used to create the photo (f-number).
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]3658 "rotation": 42, # The number of clockwise 90 degree rotations applied from the image's original orientation.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]3659 "sensor": "A String", # The type of sensor used to create the photo.
3660 "whiteBalance": "A String", # The white balance mode used to create the photo.
3661 "cameraModel": "A String", # The model of the camera used to create the photo.
3662 },
3663 "description": "A String", # A short description of the file.
3664 "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.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]3665 "videoMediaMetadata": { # Metadata about video media. This will only be present for video types.
3666 "width": 42, # The width of the video in pixels.
3667 "durationMillis": "A String", # The duration of the video in milliseconds.
3668 "height": 42, # The height of the video in pixels.
3669 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]3670 "editable": True or False, # Deprecated: use capabilities/canEdit.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]3671 "kind": "drive#file", # The type of file. This is always drive#file.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]3672 "canComment": True or False, # Deprecated: use capabilities/canComment.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]3673 "quotaBytesUsed": "A String", # The number of quota bytes used by this file.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]3674 "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.
3675 "picture": { # The user's profile picture.
3676 "url": "A String", # A URL that points to a profile picture of this user.
3677 },
3678 "kind": "drive#user", # This is always drive#user.
3679 "displayName": "A String", # A plain text displayable name for this user.
3680 "permissionId": "A String", # The user's ID as visible in the permissions collection.
3681 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
3682 "emailAddress": "A String", # The email address of the user.
3683 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3684 "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.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]3685 "createdDate": "A String", # Create time for this file (formatted RFC 3339 timestamp).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3686 "teamDriveId": "A String", # Deprecated - use driveId instead.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]3687 "properties": [ # The list of properties.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]3688 { # A key-value pair attached to a file that is either public or private to an application.
3689 # The following limits apply to file properties:
3690 # - Maximum of 100 properties total per file
3691 # - Maximum of 30 private properties per app
3692 # - Maximum of 30 public properties
3693 # - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]3694 "kind": "drive#property", # This is always drive#property.
3695 "value": "A String", # The value of this property.
3696 "etag": "A String", # ETag of the property.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3697 "visibility": "A String", # The visibility of this property. Allowed values are PRIVATE and PUBLIC. (Default: PRIVATE)
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]3698 "key": "A String", # The key of this property.
3699 "selfLink": "A String", # The link back to this property.
3700 },
3701 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3702 "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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]3703 "iconLink": "A String", # A link to the file's icon.
3704 "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.
3705 "embedLink": "A String", # A link for embedding the file.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]3706 "alternateLink": "A String", # A link for opening the file in a relevant Google editor or viewer.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3707 "shared": True or False, # Whether the file has been shared. Not populated for items in shared drives.
3708 "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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]3709 "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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3710 "thumbnail": { # A thumbnail for the file. This will only be used if a standard thumbnail cannot be generated.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]3711 "mimeType": "A String", # The MIME type of the thumbnail.
3712 "image": "A String", # The URL-safe Base64 encoded bytes of the thumbnail image. It should conform to RFC 4648 section 5.
3713 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3714 "driveId": "A String", # ID of the shared drive the file resides in. Only populated for items in shared drives.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]3715 "userPermission": { # A permission for a file. # The permissions for the authenticated user on this file.
3716 "withLink": True or False, # Whether the link is required for this permission.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]3717 "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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3718 "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.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]3719 {
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]3720 "role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible:
3721 # - organizer
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3722 # - fileOrganizer
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]3723 # - writer
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3724 # - reader
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]3725 "inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3726 "permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible:
3727 # - file
3728 # - member
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]3729 "additionalRoles": [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future.
3730 "A String",
3731 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]3732 "inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field.
3733 },
3734 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3735 "name": "A String", # The name for this permission.
3736 "teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead.
3737 {
3738 "inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead.
3739 "role": "A String", # Deprecated - use permissionDetails/role instead.
3740 "additionalRoles": [ # Deprecated - use permissionDetails/additionalRoles instead.
3741 "A String",
3742 ],
3743 "teamDrivePermissionType": "A String", # Deprecated - use permissionDetails/permissionType instead.
3744 "inherited": True or False, # Deprecated - use permissionDetails/inherited instead.
3745 },
3746 ],
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]3747 "deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]3748 "kind": "drive#permission", # This is always drive#permission.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]3749 "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.
3750 "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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3751 "authKey": "A String", # Deprecated.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]3752 "etag": "A String", # The ETag of the permission.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]3753 "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.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]3754 "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]3755 # - They cannot be set on shared drive items
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]3756 # - They can only be set on user and group permissions
3757 # - The date must be in the future
3758 # - The date cannot be more than a year in the future
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3759 # - The date can only be set on drive.permissions.update or drive.permissions.patch requests
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]3760 "role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed:
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]3761 # - owner
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3762 # - organizer
3763 # - fileOrganizer
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]3764 # - writer
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3765 # - reader
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]3766 "type": "A String", # The account type. Allowed values are:
3767 # - user
3768 # - group
3769 # - domain
3770 # - anyone
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]3771 "additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]3772 "A String",
3773 ],
3774 "selfLink": "A String", # A link back to this permission.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]3775 "photoLink": "A String", # A link to the profile photo, if available.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]3776 },
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]3777 "spaces": [ # The list of spaces which contain the file. Supported values are 'drive', 'appDataFolder' and 'photos'.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]3778 "A String",
3779 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3780 "permissionIds": [ # List of permission IDs for users with access to this file.
3781 "A String",
3782 ],
3783 "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.
3784 "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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]3785 "hasAugmentedPermissions": True or False, # Whether there are permissions directly on this file. This field is only populated for items in shared drives.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3786 "permissions": [ # The list of permissions for users with access to this file. Not populated for items in shared drives.
3787 { # A permission for a file.
3788 "withLink": True or False, # Whether the link is required for this permission.
3789 "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.
3790 "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.
3791 {
3792 "role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible:
3793 # - organizer
3794 # - fileOrganizer
3795 # - writer
3796 # - reader
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]3797 "inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3798 "permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible:
3799 # - file
3800 # - member
3801 "additionalRoles": [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future.
3802 "A String",
3803 ],
3804 "inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field.
3805 },
3806 ],
3807 "name": "A String", # The name for this permission.
3808 "teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead.
3809 {
3810 "inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead.
3811 "role": "A String", # Deprecated - use permissionDetails/role instead.
3812 "additionalRoles": [ # Deprecated - use permissionDetails/additionalRoles instead.
3813 "A String",
3814 ],
3815 "teamDrivePermissionType": "A String", # Deprecated - use permissionDetails/permissionType instead.
3816 "inherited": True or False, # Deprecated - use permissionDetails/inherited instead.
3817 },
3818 ],
3819 "deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.
3820 "kind": "drive#permission", # This is always drive#permission.
3821 "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.
3822 "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.
3823 "authKey": "A String", # Deprecated.
3824 "etag": "A String", # The ETag of the permission.
3825 "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.
3826 "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]3827 # - They cannot be set on shared drive items
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3828 # - They can only be set on user and group permissions
3829 # - The date must be in the future
3830 # - The date cannot be more than a year in the future
3831 # - The date can only be set on drive.permissions.update or drive.permissions.patch requests
3832 "role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed:
3833 # - owner
3834 # - organizer
3835 # - fileOrganizer
3836 # - writer
3837 # - reader
3838 "type": "A String", # The account type. Allowed values are:
3839 # - user
3840 # - group
3841 # - domain
3842 # - anyone
3843 "additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future.
3844 "A String",
3845 ],
3846 "selfLink": "A String", # A link back to this permission.
3847 "photoLink": "A String", # A link to the profile photo, if available.
3848 },
3849 ],
3850 "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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]3851 "selfLink": "A String", # A link back to this file.
3852 "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.
3853 }</pre>
3854</div>
3855
3856<div class="method">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3857 <code class="details" id="untrash">untrash(fileId, supportsTeamDrives=None, supportsAllDrives=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]3858 <pre>Restores a file from the trash.
3859
3860Args:
3861 fileId: string, The ID of the file to untrash. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3862 supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead.
3863 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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]3864
3865Returns:
3866 An object of the form:
3867
3868 { # The metadata for a file.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]3869 "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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]3870 "lastViewedByMeDate": "A String", # Last time this file was viewed by the user (formatted RFC 3339 timestamp).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3871 "trashedDate": "A String", # The time that the item was trashed (formatted RFC 3339 timestamp). Only populated for items in shared drives.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]3872 "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.
3873 "appDataContents": True or False, # Whether this file is in the Application Data folder.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]3874 "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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]3875 "labels": { # A group of labels for the file.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3876 "restricted": True or False, # Deprecated - use copyRequiresWriterPermission instead.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]3877 "modified": True or False, # Whether the file has been modified by this user.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]3878 "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.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]3879 "hidden": True or False, # Deprecated.
3880 "starred": True or False, # Whether this file is starred by the user.
3881 "viewed": True or False, # Whether this file has been viewed by this user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]3882 },
3883 "indexableText": { # Indexable text attributes for the file (can only be written)
3884 "text": "A String", # The text to be indexed for this file.
3885 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]3886 "thumbnailVersion": "A String", # The thumbnail version for use in thumbnail cache invalidation.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]3887 "explicitlyTrashed": True or False, # Whether this file has been explicitly trashed, as opposed to recursively trashed.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]3888 "isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]3889 "lastModifyingUserName": "A String", # Name of the last user to modify this file.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3890 "writersCanShare": True or False, # Whether writers can share the document with other users. Not populated for items in shared drives.
3891 "owners": [ # The owner(s) of this file. Not populated for items in shared drives.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]3892 { # Information about a Drive user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]3893 "picture": { # The user's profile picture.
3894 "url": "A String", # A URL that points to a profile picture of this user.
3895 },
3896 "kind": "drive#user", # This is always drive#user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]3897 "displayName": "A String", # A plain text displayable name for this user.
3898 "permissionId": "A String", # The user's ID as visible in the permissions collection.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]3899 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
3900 "emailAddress": "A String", # The email address of the user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]3901 },
3902 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3903 "ownedByMe": True or False, # Whether the file is owned by the current user. Not populated for items in shared drives.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]3904 "id": "A String", # The ID of the file.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]3905 "sharingUser": { # Information about a Drive user. # User that shared the item with the current user, if available.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]3906 "picture": { # The user's profile picture.
3907 "url": "A String", # A URL that points to a profile picture of this user.
3908 },
3909 "kind": "drive#user", # This is always drive#user.
3910 "displayName": "A String", # A plain text displayable name for this user.
3911 "permissionId": "A String", # The user's ID as visible in the permissions collection.
3912 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
3913 "emailAddress": "A String", # The email address of the user.
3914 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]3915 "shortcutDetails": { # Shortcut file details. Only populated for shortcut files, which have the mimeType field set to application/vnd.google-apps.shortcut.
3916 "targetId": "A String", # The ID of the file that this shortcut points to.
3917 "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.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]3918 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3919 "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.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]3920 "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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]3921 "lastModifyingUser": { # Information about a Drive user. # The last user to modify this file.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]3922 "picture": { # The user's profile picture.
3923 "url": "A String", # A URL that points to a profile picture of this user.
3924 },
3925 "kind": "drive#user", # This is always drive#user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]3926 "displayName": "A String", # A plain text displayable name for this user.
3927 "permissionId": "A String", # The user's ID as visible in the permissions collection.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]3928 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
3929 "emailAddress": "A String", # The email address of the user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]3930 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]3931 "copyable": True or False, # Deprecated: use capabilities/canCopy.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3932 "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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]3933 "markedViewedByMeDate": "A String", # Deprecated.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3934 "ownerNames": [ # Name(s) of the owner(s) of this file. Not populated for items in shared drives.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]3935 "A String",
3936 ],
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]3937 "capabilities": { # Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3938 "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.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]3939 "canUntrash": True or False, # Whether the current user can restore this file from trash.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3940 "canMoveItemWithinTeamDrive": True or False, # Deprecated - use canMoveItemWithinDrive instead.
3941 "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.
3942 "canMoveChildrenWithinTeamDrive": True or False, # Deprecated - use canMoveChildrenWithinDrive instead.
3943 "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.
3944 "canRename": True or False, # Whether the current user can rename this file.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]3945 "canModifyContent": True or False, # Whether the current user can modify the content of this file.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3946 "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.
3947 "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.
3948 "canChangeRestrictedDownload": True or False, # Deprecated
3949 "canShare": True or False, # Whether the current user can modify the sharing settings for this file.
3950 "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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]3951 "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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3952 "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.
3953 "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.
3954 "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.
3955 "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.
3956 "canMoveItemIntoTeamDrive": True or False, # Deprecated - use canMoveItemOutOfDrive instead.
3957 "canMoveItemOutOfTeamDrive": True or False, # Deprecated - use canMoveItemOutOfDrive instead.
3958 "canComment": True or False, # Whether the current user can comment on this file.
3959 "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.
3960 "canTrash": True or False, # Whether the current user can move this file to trash.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]3961 "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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3962 "canDelete": True or False, # Whether the current user can delete this file.
3963 "canMoveTeamDriveItem": True or False, # Deprecated - use canMoveItemWithinDrive or canMoveItemOutOfDrive instead.
3964 "canDownload": True or False, # Whether the current user can download this file.
3965 "canChangeCopyRequiresWriterPermission": True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this file.
3966 "canMoveChildrenOutOfTeamDrive": True or False, # Deprecated - use canMoveChildrenOutOfDrive instead.
3967 "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.
3968 "canReadTeamDrive": True or False, # Deprecated - use canReadDrive instead.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]3969 "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.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]3970 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]3971 "sharedWithMeDate": "A String", # Time at which this file was shared with the user (formatted RFC 3339 timestamp).
3972 "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.
3973 "etag": "A String", # ETag of the file.
3974 "parents": [ # Collection of parent folders which contain this file.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3975 # 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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]3976 { # A reference to a file's parent.
3977 "selfLink": "A String", # A link back to this reference.
3978 "kind": "drive#parentReference", # This is always drive#parentReference.
3979 "id": "A String", # The ID of the parent.
3980 "isRoot": True or False, # Whether or not the parent is the root folder.
3981 "parentLink": "A String", # A link to the parent.
3982 },
3983 ],
3984 "exportLinks": { # Links for exporting Google Docs to specific formats.
3985 "a_key": "A String", # A mapping from export format to URL
3986 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3987 "shareable": True or False, # Deprecated: use capabilities/canShare.
3988 "copyRequiresWriterPermission": True or False, # Whether the options to copy, print, or download this file, should be disabled for readers and commenters.
3989 "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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]3990 "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.
3991 "a_key": "A String",
3992 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]3993 "canReadRevisions": True or False, # Deprecated: use capabilities/canReadRevisions.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]3994 "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.
3995 "exposureBias": 3.14, # The exposure bias of the photo (APEX value).
3996 "exposureTime": 3.14, # The length of the exposure, in seconds.
3997 "cameraMake": "A String", # The make of the camera used to create the photo.
3998 "maxApertureValue": 3.14, # The smallest f-number of the lens at the focal length used to create the photo (APEX value).
3999 "isoSpeed": 42, # The ISO speed used to create the photo.
4000 "focalLength": 3.14, # The focal length used to create the photo, in millimeters.
4001 "exposureMode": "A String", # The exposure mode used to create the photo.
4002 "colorSpace": "A String", # The color space of the photo.
4003 "location": { # Geographic location information stored in the image.
4004 "latitude": 3.14, # The latitude stored in the image.
4005 "altitude": 3.14, # The altitude stored in the image.
4006 "longitude": 3.14, # The longitude stored in the image.
4007 },
4008 "subjectDistance": 42, # The distance to the subject of the photo, in meters.
4009 "height": 42, # The height of the image in pixels.
4010 "lens": "A String", # The lens used to create the photo.
4011 "date": "A String", # The date and time the photo was taken (EXIF format timestamp).
4012 "width": 42, # The width of the image in pixels.
4013 "meteringMode": "A String", # The metering mode used to create the photo.
4014 "flashUsed": True or False, # Whether a flash was used to create the photo.
4015 "aperture": 3.14, # The aperture used to create the photo (f-number).
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]4016 "rotation": 42, # The number of clockwise 90 degree rotations applied from the image's original orientation.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]4017 "sensor": "A String", # The type of sensor used to create the photo.
4018 "whiteBalance": "A String", # The white balance mode used to create the photo.
4019 "cameraModel": "A String", # The model of the camera used to create the photo.
4020 },
4021 "description": "A String", # A short description of the file.
4022 "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.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]4023 "videoMediaMetadata": { # Metadata about video media. This will only be present for video types.
4024 "width": 42, # The width of the video in pixels.
4025 "durationMillis": "A String", # The duration of the video in milliseconds.
4026 "height": 42, # The height of the video in pixels.
4027 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]4028 "editable": True or False, # Deprecated: use capabilities/canEdit.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]4029 "kind": "drive#file", # The type of file. This is always drive#file.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]4030 "canComment": True or False, # Deprecated: use capabilities/canComment.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]4031 "quotaBytesUsed": "A String", # The number of quota bytes used by this file.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]4032 "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.
4033 "picture": { # The user's profile picture.
4034 "url": "A String", # A URL that points to a profile picture of this user.
4035 },
4036 "kind": "drive#user", # This is always drive#user.
4037 "displayName": "A String", # A plain text displayable name for this user.
4038 "permissionId": "A String", # The user's ID as visible in the permissions collection.
4039 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
4040 "emailAddress": "A String", # The email address of the user.
4041 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4042 "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.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]4043 "createdDate": "A String", # Create time for this file (formatted RFC 3339 timestamp).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4044 "teamDriveId": "A String", # Deprecated - use driveId instead.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]4045 "properties": [ # The list of properties.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]4046 { # A key-value pair attached to a file that is either public or private to an application.
4047 # The following limits apply to file properties:
4048 # - Maximum of 100 properties total per file
4049 # - Maximum of 30 private properties per app
4050 # - Maximum of 30 public properties
4051 # - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]4052 "kind": "drive#property", # This is always drive#property.
4053 "value": "A String", # The value of this property.
4054 "etag": "A String", # ETag of the property.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4055 "visibility": "A String", # The visibility of this property. Allowed values are PRIVATE and PUBLIC. (Default: PRIVATE)
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]4056 "key": "A String", # The key of this property.
4057 "selfLink": "A String", # The link back to this property.
4058 },
4059 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4060 "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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]4061 "iconLink": "A String", # A link to the file's icon.
4062 "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.
4063 "embedLink": "A String", # A link for embedding the file.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]4064 "alternateLink": "A String", # A link for opening the file in a relevant Google editor or viewer.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4065 "shared": True or False, # Whether the file has been shared. Not populated for items in shared drives.
4066 "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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]4067 "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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4068 "thumbnail": { # A thumbnail for the file. This will only be used if a standard thumbnail cannot be generated.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]4069 "mimeType": "A String", # The MIME type of the thumbnail.
4070 "image": "A String", # The URL-safe Base64 encoded bytes of the thumbnail image. It should conform to RFC 4648 section 5.
4071 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4072 "driveId": "A String", # ID of the shared drive the file resides in. Only populated for items in shared drives.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]4073 "userPermission": { # A permission for a file. # The permissions for the authenticated user on this file.
4074 "withLink": True or False, # Whether the link is required for this permission.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]4075 "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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4076 "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.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]4077 {
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]4078 "role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible:
4079 # - organizer
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4080 # - fileOrganizer
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]4081 # - writer
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4082 # - reader
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]4083 "inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4084 "permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible:
4085 # - file
4086 # - member
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]4087 "additionalRoles": [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future.
4088 "A String",
4089 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]4090 "inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field.
4091 },
4092 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4093 "name": "A String", # The name for this permission.
4094 "teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead.
4095 {
4096 "inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead.
4097 "role": "A String", # Deprecated - use permissionDetails/role instead.
4098 "additionalRoles": [ # Deprecated - use permissionDetails/additionalRoles instead.
4099 "A String",
4100 ],
4101 "teamDrivePermissionType": "A String", # Deprecated - use permissionDetails/permissionType instead.
4102 "inherited": True or False, # Deprecated - use permissionDetails/inherited instead.
4103 },
4104 ],
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]4105 "deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]4106 "kind": "drive#permission", # This is always drive#permission.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]4107 "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.
4108 "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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4109 "authKey": "A String", # Deprecated.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]4110 "etag": "A String", # The ETag of the permission.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]4111 "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.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]4112 "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]4113 # - They cannot be set on shared drive items
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]4114 # - They can only be set on user and group permissions
4115 # - The date must be in the future
4116 # - The date cannot be more than a year in the future
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4117 # - The date can only be set on drive.permissions.update or drive.permissions.patch requests
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]4118 "role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed:
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]4119 # - owner
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4120 # - organizer
4121 # - fileOrganizer
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]4122 # - writer
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4123 # - reader
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]4124 "type": "A String", # The account type. Allowed values are:
4125 # - user
4126 # - group
4127 # - domain
4128 # - anyone
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]4129 "additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]4130 "A String",
4131 ],
4132 "selfLink": "A String", # A link back to this permission.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]4133 "photoLink": "A String", # A link to the profile photo, if available.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]4134 },
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]4135 "spaces": [ # The list of spaces which contain the file. Supported values are 'drive', 'appDataFolder' and 'photos'.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]4136 "A String",
4137 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4138 "permissionIds": [ # List of permission IDs for users with access to this file.
4139 "A String",
4140 ],
4141 "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.
4142 "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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]4143 "hasAugmentedPermissions": True or False, # Whether there are permissions directly on this file. This field is only populated for items in shared drives.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4144 "permissions": [ # The list of permissions for users with access to this file. Not populated for items in shared drives.
4145 { # A permission for a file.
4146 "withLink": True or False, # Whether the link is required for this permission.
4147 "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.
4148 "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.
4149 {
4150 "role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible:
4151 # - organizer
4152 # - fileOrganizer
4153 # - writer
4154 # - reader
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]4155 "inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4156 "permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible:
4157 # - file
4158 # - member
4159 "additionalRoles": [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future.
4160 "A String",
4161 ],
4162 "inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field.
4163 },
4164 ],
4165 "name": "A String", # The name for this permission.
4166 "teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead.
4167 {
4168 "inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead.
4169 "role": "A String", # Deprecated - use permissionDetails/role instead.
4170 "additionalRoles": [ # Deprecated - use permissionDetails/additionalRoles instead.
4171 "A String",
4172 ],
4173 "teamDrivePermissionType": "A String", # Deprecated - use permissionDetails/permissionType instead.
4174 "inherited": True or False, # Deprecated - use permissionDetails/inherited instead.
4175 },
4176 ],
4177 "deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.
4178 "kind": "drive#permission", # This is always drive#permission.
4179 "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.
4180 "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.
4181 "authKey": "A String", # Deprecated.
4182 "etag": "A String", # The ETag of the permission.
4183 "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.
4184 "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]4185 # - They cannot be set on shared drive items
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4186 # - They can only be set on user and group permissions
4187 # - The date must be in the future
4188 # - The date cannot be more than a year in the future
4189 # - The date can only be set on drive.permissions.update or drive.permissions.patch requests
4190 "role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed:
4191 # - owner
4192 # - organizer
4193 # - fileOrganizer
4194 # - writer
4195 # - reader
4196 "type": "A String", # The account type. Allowed values are:
4197 # - user
4198 # - group
4199 # - domain
4200 # - anyone
4201 "additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future.
4202 "A String",
4203 ],
4204 "selfLink": "A String", # A link back to this permission.
4205 "photoLink": "A String", # A link to the profile photo, if available.
4206 },
4207 ],
4208 "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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]4209 "selfLink": "A String", # A link back to this file.
4210 "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.
4211 }</pre>
4212</div>
4213
4214<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]4215 <code class="details" id="update">update(fileId, body=None, supportsTeamDrives=None, newRevision=None, modifiedDateBehavior=None, media_body=None, ocrLanguage=None, pinned=None, ocr=None, addParents=None, removeParents=None, updateViewedDate=None, timedTextTrackName=None, enforceSingleParent=None, convert=None, useContentAsIndexableText=None, supportsAllDrives=None, media_mime_type=None, setModifiedDate=None, timedTextLanguage=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]4216 <pre>Updates file metadata and/or content.
4217
4218Args:
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.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]4224 "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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]4225 "lastViewedByMeDate": "A String", # Last time this file was viewed by the user (formatted RFC 3339 timestamp).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4226 "trashedDate": "A String", # The time that the item was trashed (formatted RFC 3339 timestamp). Only populated for items in shared drives.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]4227 "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.
4228 "appDataContents": True or False, # Whether this file is in the Application Data folder.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]4229 "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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]4230 "labels": { # A group of labels for the file.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4231 "restricted": True or False, # Deprecated - use copyRequiresWriterPermission instead.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]4232 "modified": True or False, # Whether the file has been modified by this user.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]4233 "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.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]4234 "hidden": True or False, # Deprecated.
4235 "starred": True or False, # Whether this file is starred by the user.
4236 "viewed": True or False, # Whether this file has been viewed by this user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]4237 },
4238 "indexableText": { # Indexable text attributes for the file (can only be written)
4239 "text": "A String", # The text to be indexed for this file.
4240 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]4241 "thumbnailVersion": "A String", # The thumbnail version for use in thumbnail cache invalidation.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]4242 "explicitlyTrashed": True or False, # Whether this file has been explicitly trashed, as opposed to recursively trashed.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]4243 "isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]4244 "lastModifyingUserName": "A String", # Name of the last user to modify this file.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4245 "writersCanShare": True or False, # Whether writers can share the document with other users. Not populated for items in shared drives.
4246 "owners": [ # The owner(s) of this file. Not populated for items in shared drives.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]4247 { # Information about a Drive user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]4248 "picture": { # The user's profile picture.
4249 "url": "A String", # A URL that points to a profile picture of this user.
4250 },
4251 "kind": "drive#user", # This is always drive#user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]4252 "displayName": "A String", # A plain text displayable name for this user.
4253 "permissionId": "A String", # The user's ID as visible in the permissions collection.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]4254 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
4255 "emailAddress": "A String", # The email address of the user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]4256 },
4257 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4258 "ownedByMe": True or False, # Whether the file is owned by the current user. Not populated for items in shared drives.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]4259 "id": "A String", # The ID of the file.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]4260 "sharingUser": { # Information about a Drive user. # User that shared the item with the current user, if available.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]4261 "picture": { # The user's profile picture.
4262 "url": "A String", # A URL that points to a profile picture of this user.
4263 },
4264 "kind": "drive#user", # This is always drive#user.
4265 "displayName": "A String", # A plain text displayable name for this user.
4266 "permissionId": "A String", # The user's ID as visible in the permissions collection.
4267 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
4268 "emailAddress": "A String", # The email address of the user.
4269 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]4270 "shortcutDetails": { # Shortcut file details. Only populated for shortcut files, which have the mimeType field set to application/vnd.google-apps.shortcut.
4271 "targetId": "A String", # The ID of the file that this shortcut points to.
4272 "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.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]4273 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4274 "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.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]4275 "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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]4276 "lastModifyingUser": { # Information about a Drive user. # The last user to modify this file.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]4277 "picture": { # The user's profile picture.
4278 "url": "A String", # A URL that points to a profile picture of this user.
4279 },
4280 "kind": "drive#user", # This is always drive#user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]4281 "displayName": "A String", # A plain text displayable name for this user.
4282 "permissionId": "A String", # The user's ID as visible in the permissions collection.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]4283 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
4284 "emailAddress": "A String", # The email address of the user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]4285 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]4286 "copyable": True or False, # Deprecated: use capabilities/canCopy.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4287 "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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]4288 "markedViewedByMeDate": "A String", # Deprecated.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4289 "ownerNames": [ # Name(s) of the owner(s) of this file. Not populated for items in shared drives.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]4290 "A String",
4291 ],
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]4292 "capabilities": { # Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4293 "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.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]4294 "canUntrash": True or False, # Whether the current user can restore this file from trash.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4295 "canMoveItemWithinTeamDrive": True or False, # Deprecated - use canMoveItemWithinDrive instead.
4296 "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.
4297 "canMoveChildrenWithinTeamDrive": True or False, # Deprecated - use canMoveChildrenWithinDrive instead.
4298 "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.
4299 "canRename": True or False, # Whether the current user can rename this file.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]4300 "canModifyContent": True or False, # Whether the current user can modify the content of this file.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4301 "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.
4302 "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.
4303 "canChangeRestrictedDownload": True or False, # Deprecated
4304 "canShare": True or False, # Whether the current user can modify the sharing settings for this file.
4305 "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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]4306 "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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4307 "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.
4308 "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.
4309 "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.
4310 "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.
4311 "canMoveItemIntoTeamDrive": True or False, # Deprecated - use canMoveItemOutOfDrive instead.
4312 "canMoveItemOutOfTeamDrive": True or False, # Deprecated - use canMoveItemOutOfDrive instead.
4313 "canComment": True or False, # Whether the current user can comment on this file.
4314 "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.
4315 "canTrash": True or False, # Whether the current user can move this file to trash.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]4316 "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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4317 "canDelete": True or False, # Whether the current user can delete this file.
4318 "canMoveTeamDriveItem": True or False, # Deprecated - use canMoveItemWithinDrive or canMoveItemOutOfDrive instead.
4319 "canDownload": True or False, # Whether the current user can download this file.
4320 "canChangeCopyRequiresWriterPermission": True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this file.
4321 "canMoveChildrenOutOfTeamDrive": True or False, # Deprecated - use canMoveChildrenOutOfDrive instead.
4322 "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.
4323 "canReadTeamDrive": True or False, # Deprecated - use canReadDrive instead.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]4324 "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.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]4325 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]4326 "sharedWithMeDate": "A String", # Time at which this file was shared with the user (formatted RFC 3339 timestamp).
4327 "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.
4328 "etag": "A String", # ETag of the file.
4329 "parents": [ # Collection of parent folders which contain this file.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4330 # 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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]4331 { # A reference to a file's parent.
4332 "selfLink": "A String", # A link back to this reference.
4333 "kind": "drive#parentReference", # This is always drive#parentReference.
4334 "id": "A String", # The ID of the parent.
4335 "isRoot": True or False, # Whether or not the parent is the root folder.
4336 "parentLink": "A String", # A link to the parent.
4337 },
4338 ],
4339 "exportLinks": { # Links for exporting Google Docs to specific formats.
4340 "a_key": "A String", # A mapping from export format to URL
4341 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4342 "shareable": True or False, # Deprecated: use capabilities/canShare.
4343 "copyRequiresWriterPermission": True or False, # Whether the options to copy, print, or download this file, should be disabled for readers and commenters.
4344 "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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]4345 "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.
4346 "a_key": "A String",
4347 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]4348 "canReadRevisions": True or False, # Deprecated: use capabilities/canReadRevisions.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]4349 "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.
4350 "exposureBias": 3.14, # The exposure bias of the photo (APEX value).
4351 "exposureTime": 3.14, # The length of the exposure, in seconds.
4352 "cameraMake": "A String", # The make of the camera used to create the photo.
4353 "maxApertureValue": 3.14, # The smallest f-number of the lens at the focal length used to create the photo (APEX value).
4354 "isoSpeed": 42, # The ISO speed used to create the photo.
4355 "focalLength": 3.14, # The focal length used to create the photo, in millimeters.
4356 "exposureMode": "A String", # The exposure mode used to create the photo.
4357 "colorSpace": "A String", # The color space of the photo.
4358 "location": { # Geographic location information stored in the image.
4359 "latitude": 3.14, # The latitude stored in the image.
4360 "altitude": 3.14, # The altitude stored in the image.
4361 "longitude": 3.14, # The longitude stored in the image.
4362 },
4363 "subjectDistance": 42, # The distance to the subject of the photo, in meters.
4364 "height": 42, # The height of the image in pixels.
4365 "lens": "A String", # The lens used to create the photo.
4366 "date": "A String", # The date and time the photo was taken (EXIF format timestamp).
4367 "width": 42, # The width of the image in pixels.
4368 "meteringMode": "A String", # The metering mode used to create the photo.
4369 "flashUsed": True or False, # Whether a flash was used to create the photo.
4370 "aperture": 3.14, # The aperture used to create the photo (f-number).
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]4371 "rotation": 42, # The number of clockwise 90 degree rotations applied from the image's original orientation.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]4372 "sensor": "A String", # The type of sensor used to create the photo.
4373 "whiteBalance": "A String", # The white balance mode used to create the photo.
4374 "cameraModel": "A String", # The model of the camera used to create the photo.
4375 },
4376 "description": "A String", # A short description of the file.
4377 "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.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]4378 "videoMediaMetadata": { # Metadata about video media. This will only be present for video types.
4379 "width": 42, # The width of the video in pixels.
4380 "durationMillis": "A String", # The duration of the video in milliseconds.
4381 "height": 42, # The height of the video in pixels.
4382 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]4383 "editable": True or False, # Deprecated: use capabilities/canEdit.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]4384 "kind": "drive#file", # The type of file. This is always drive#file.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]4385 "canComment": True or False, # Deprecated: use capabilities/canComment.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]4386 "quotaBytesUsed": "A String", # The number of quota bytes used by this file.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]4387 "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.
4388 "picture": { # The user's profile picture.
4389 "url": "A String", # A URL that points to a profile picture of this user.
4390 },
4391 "kind": "drive#user", # This is always drive#user.
4392 "displayName": "A String", # A plain text displayable name for this user.
4393 "permissionId": "A String", # The user's ID as visible in the permissions collection.
4394 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
4395 "emailAddress": "A String", # The email address of the user.
4396 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4397 "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.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]4398 "createdDate": "A String", # Create time for this file (formatted RFC 3339 timestamp).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4399 "teamDriveId": "A String", # Deprecated - use driveId instead.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]4400 "properties": [ # The list of properties.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]4401 { # A key-value pair attached to a file that is either public or private to an application.
4402 # The following limits apply to file properties:
4403 # - Maximum of 100 properties total per file
4404 # - Maximum of 30 private properties per app
4405 # - Maximum of 30 public properties
4406 # - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]4407 "kind": "drive#property", # This is always drive#property.
4408 "value": "A String", # The value of this property.
4409 "etag": "A String", # ETag of the property.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4410 "visibility": "A String", # The visibility of this property. Allowed values are PRIVATE and PUBLIC. (Default: PRIVATE)
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]4411 "key": "A String", # The key of this property.
4412 "selfLink": "A String", # The link back to this property.
4413 },
4414 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4415 "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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]4416 "iconLink": "A String", # A link to the file's icon.
4417 "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.
4418 "embedLink": "A String", # A link for embedding the file.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]4419 "alternateLink": "A String", # A link for opening the file in a relevant Google editor or viewer.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4420 "shared": True or False, # Whether the file has been shared. Not populated for items in shared drives.
4421 "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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]4422 "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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4423 "thumbnail": { # A thumbnail for the file. This will only be used if a standard thumbnail cannot be generated.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]4424 "mimeType": "A String", # The MIME type of the thumbnail.
4425 "image": "A String", # The URL-safe Base64 encoded bytes of the thumbnail image. It should conform to RFC 4648 section 5.
4426 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4427 "driveId": "A String", # ID of the shared drive the file resides in. Only populated for items in shared drives.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]4428 "userPermission": { # A permission for a file. # The permissions for the authenticated user on this file.
4429 "withLink": True or False, # Whether the link is required for this permission.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]4430 "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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4431 "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.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]4432 {
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]4433 "role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible:
4434 # - organizer
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4435 # - fileOrganizer
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]4436 # - writer
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4437 # - reader
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]4438 "inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4439 "permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible:
4440 # - file
4441 # - member
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]4442 "additionalRoles": [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future.
4443 "A String",
4444 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]4445 "inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field.
4446 },
4447 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4448 "name": "A String", # The name for this permission.
4449 "teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead.
4450 {
4451 "inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead.
4452 "role": "A String", # Deprecated - use permissionDetails/role instead.
4453 "additionalRoles": [ # Deprecated - use permissionDetails/additionalRoles instead.
4454 "A String",
4455 ],
4456 "teamDrivePermissionType": "A String", # Deprecated - use permissionDetails/permissionType instead.
4457 "inherited": True or False, # Deprecated - use permissionDetails/inherited instead.
4458 },
4459 ],
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]4460 "deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]4461 "kind": "drive#permission", # This is always drive#permission.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]4462 "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.
4463 "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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4464 "authKey": "A String", # Deprecated.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]4465 "etag": "A String", # The ETag of the permission.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]4466 "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.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]4467 "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]4468 # - They cannot be set on shared drive items
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]4469 # - They can only be set on user and group permissions
4470 # - The date must be in the future
4471 # - The date cannot be more than a year in the future
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4472 # - The date can only be set on drive.permissions.update or drive.permissions.patch requests
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]4473 "role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed:
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]4474 # - owner
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4475 # - organizer
4476 # - fileOrganizer
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]4477 # - writer
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4478 # - reader
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]4479 "type": "A String", # The account type. Allowed values are:
4480 # - user
4481 # - group
4482 # - domain
4483 # - anyone
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]4484 "additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]4485 "A String",
4486 ],
4487 "selfLink": "A String", # A link back to this permission.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]4488 "photoLink": "A String", # A link to the profile photo, if available.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]4489 },
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]4490 "spaces": [ # The list of spaces which contain the file. Supported values are 'drive', 'appDataFolder' and 'photos'.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]4491 "A String",
4492 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4493 "permissionIds": [ # List of permission IDs for users with access to this file.
4494 "A String",
4495 ],
4496 "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.
4497 "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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]4498 "hasAugmentedPermissions": True or False, # Whether there are permissions directly on this file. This field is only populated for items in shared drives.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4499 "permissions": [ # The list of permissions for users with access to this file. Not populated for items in shared drives.
4500 { # A permission for a file.
4501 "withLink": True or False, # Whether the link is required for this permission.
4502 "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.
4503 "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.
4504 {
4505 "role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible:
4506 # - organizer
4507 # - fileOrganizer
4508 # - writer
4509 # - reader
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]4510 "inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4511 "permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible:
4512 # - file
4513 # - member
4514 "additionalRoles": [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future.
4515 "A String",
4516 ],
4517 "inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field.
4518 },
4519 ],
4520 "name": "A String", # The name for this permission.
4521 "teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead.
4522 {
4523 "inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead.
4524 "role": "A String", # Deprecated - use permissionDetails/role instead.
4525 "additionalRoles": [ # Deprecated - use permissionDetails/additionalRoles instead.
4526 "A String",
4527 ],
4528 "teamDrivePermissionType": "A String", # Deprecated - use permissionDetails/permissionType instead.
4529 "inherited": True or False, # Deprecated - use permissionDetails/inherited instead.
4530 },
4531 ],
4532 "deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.
4533 "kind": "drive#permission", # This is always drive#permission.
4534 "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.
4535 "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.
4536 "authKey": "A String", # Deprecated.
4537 "etag": "A String", # The ETag of the permission.
4538 "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.
4539 "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]4540 # - They cannot be set on shared drive items
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4541 # - They can only be set on user and group permissions
4542 # - The date must be in the future
4543 # - The date cannot be more than a year in the future
4544 # - The date can only be set on drive.permissions.update or drive.permissions.patch requests
4545 "role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed:
4546 # - owner
4547 # - organizer
4548 # - fileOrganizer
4549 # - writer
4550 # - reader
4551 "type": "A String", # The account type. Allowed values are:
4552 # - user
4553 # - group
4554 # - domain
4555 # - anyone
4556 "additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future.
4557 "A String",
4558 ],
4559 "selfLink": "A String", # A link back to this permission.
4560 "photoLink": "A String", # A link to the profile photo, if available.
4561 },
4562 ],
4563 "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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]4564 "selfLink": "A String", # A link back to this file.
4565 "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.
4566}
4567
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4568 supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]4569 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.
4570 modifiedDateBehavior: string, Determines the behavior in which modifiedDate is updated. This overrides setModifiedDate.
4571 Allowed values
4572 fromBody - Set modifiedDate to the value provided in the body of the request. No change if no value was provided.
4573 fromBodyIfNeeded - Set modifiedDate to the value provided in the body of the request depending on other contents of the update.
4574 fromBodyOrNow - Set modifiedDate to the value provided in the body of the request, or to the current time if no value was provided.
4575 noChange - Maintain the previous value of modifiedDate.
4576 now - Set modifiedDate to the current time.
4577 nowIfNeeded - Set modifiedDate to the current time depending on contents of the update.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]4578 media_body: string, The filename of the media request body, or an instance of a MediaUpload object.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]4579 ocrLanguage: string, If ocr is true, hints at the language to use. Valid values are BCP 47 codes.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]4580 pinned: boolean, Whether to pin the new revision. A file can have a maximum of 200 pinned revisions.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]4581 ocr: boolean, Whether to attempt OCR on .jpg, .png, .gif, or .pdf uploads.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]4582 addParents: string, Comma-separated list of parent IDs to add.
4583 removeParents: string, Comma-separated list of parent IDs to remove.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]4584 updateViewedDate: boolean, Whether to update the view date after successfully updating the file.
4585 timedTextTrackName: string, The timed text track name.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]4586 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 Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]4587 convert: boolean, This parameter is deprecated and has no function.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]4588 useContentAsIndexableText: boolean, Whether to use the content as indexable text.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4589 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.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]4590 media_mime_type: string, The MIME type of the media request body, or an instance of a MediaUpload object.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4591 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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]4592 timedTextLanguage: string, The language of the timed text.
4593
4594Returns:
4595 An object of the form:
4596
4597 { # The metadata for a file.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]4598 "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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]4599 "lastViewedByMeDate": "A String", # Last time this file was viewed by the user (formatted RFC 3339 timestamp).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4600 "trashedDate": "A String", # The time that the item was trashed (formatted RFC 3339 timestamp). Only populated for items in shared drives.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]4601 "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.
4602 "appDataContents": True or False, # Whether this file is in the Application Data folder.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]4603 "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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]4604 "labels": { # A group of labels for the file.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4605 "restricted": True or False, # Deprecated - use copyRequiresWriterPermission instead.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]4606 "modified": True or False, # Whether the file has been modified by this user.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]4607 "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.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]4608 "hidden": True or False, # Deprecated.
4609 "starred": True or False, # Whether this file is starred by the user.
4610 "viewed": True or False, # Whether this file has been viewed by this user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]4611 },
4612 "indexableText": { # Indexable text attributes for the file (can only be written)
4613 "text": "A String", # The text to be indexed for this file.
4614 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]4615 "thumbnailVersion": "A String", # The thumbnail version for use in thumbnail cache invalidation.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]4616 "explicitlyTrashed": True or False, # Whether this file has been explicitly trashed, as opposed to recursively trashed.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]4617 "isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]4618 "lastModifyingUserName": "A String", # Name of the last user to modify this file.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4619 "writersCanShare": True or False, # Whether writers can share the document with other users. Not populated for items in shared drives.
4620 "owners": [ # The owner(s) of this file. Not populated for items in shared drives.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]4621 { # Information about a Drive user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]4622 "picture": { # The user's profile picture.
4623 "url": "A String", # A URL that points to a profile picture of this user.
4624 },
4625 "kind": "drive#user", # This is always drive#user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]4626 "displayName": "A String", # A plain text displayable name for this user.
4627 "permissionId": "A String", # The user's ID as visible in the permissions collection.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]4628 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
4629 "emailAddress": "A String", # The email address of the user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]4630 },
4631 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4632 "ownedByMe": True or False, # Whether the file is owned by the current user. Not populated for items in shared drives.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]4633 "id": "A String", # The ID of the file.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]4634 "sharingUser": { # Information about a Drive user. # User that shared the item with the current user, if available.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]4635 "picture": { # The user's profile picture.
4636 "url": "A String", # A URL that points to a profile picture of this user.
4637 },
4638 "kind": "drive#user", # This is always drive#user.
4639 "displayName": "A String", # A plain text displayable name for this user.
4640 "permissionId": "A String", # The user's ID as visible in the permissions collection.
4641 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
4642 "emailAddress": "A String", # The email address of the user.
4643 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]4644 "shortcutDetails": { # Shortcut file details. Only populated for shortcut files, which have the mimeType field set to application/vnd.google-apps.shortcut.
4645 "targetId": "A String", # The ID of the file that this shortcut points to.
4646 "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.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]4647 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4648 "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.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]4649 "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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]4650 "lastModifyingUser": { # Information about a Drive user. # The last user to modify this file.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]4651 "picture": { # The user's profile picture.
4652 "url": "A String", # A URL that points to a profile picture of this user.
4653 },
4654 "kind": "drive#user", # This is always drive#user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]4655 "displayName": "A String", # A plain text displayable name for this user.
4656 "permissionId": "A String", # The user's ID as visible in the permissions collection.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]4657 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
4658 "emailAddress": "A String", # The email address of the user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]4659 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]4660 "copyable": True or False, # Deprecated: use capabilities/canCopy.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4661 "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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]4662 "markedViewedByMeDate": "A String", # Deprecated.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4663 "ownerNames": [ # Name(s) of the owner(s) of this file. Not populated for items in shared drives.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]4664 "A String",
4665 ],
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]4666 "capabilities": { # Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4667 "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.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]4668 "canUntrash": True or False, # Whether the current user can restore this file from trash.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4669 "canMoveItemWithinTeamDrive": True or False, # Deprecated - use canMoveItemWithinDrive instead.
4670 "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.
4671 "canMoveChildrenWithinTeamDrive": True or False, # Deprecated - use canMoveChildrenWithinDrive instead.
4672 "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.
4673 "canRename": True or False, # Whether the current user can rename this file.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]4674 "canModifyContent": True or False, # Whether the current user can modify the content of this file.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4675 "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.
4676 "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.
4677 "canChangeRestrictedDownload": True or False, # Deprecated
4678 "canShare": True or False, # Whether the current user can modify the sharing settings for this file.
4679 "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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]4680 "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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4681 "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.
4682 "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.
4683 "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.
4684 "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.
4685 "canMoveItemIntoTeamDrive": True or False, # Deprecated - use canMoveItemOutOfDrive instead.
4686 "canMoveItemOutOfTeamDrive": True or False, # Deprecated - use canMoveItemOutOfDrive instead.
4687 "canComment": True or False, # Whether the current user can comment on this file.
4688 "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.
4689 "canTrash": True or False, # Whether the current user can move this file to trash.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]4690 "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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4691 "canDelete": True or False, # Whether the current user can delete this file.
4692 "canMoveTeamDriveItem": True or False, # Deprecated - use canMoveItemWithinDrive or canMoveItemOutOfDrive instead.
4693 "canDownload": True or False, # Whether the current user can download this file.
4694 "canChangeCopyRequiresWriterPermission": True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this file.
4695 "canMoveChildrenOutOfTeamDrive": True or False, # Deprecated - use canMoveChildrenOutOfDrive instead.
4696 "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.
4697 "canReadTeamDrive": True or False, # Deprecated - use canReadDrive instead.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]4698 "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.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]4699 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]4700 "sharedWithMeDate": "A String", # Time at which this file was shared with the user (formatted RFC 3339 timestamp).
4701 "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.
4702 "etag": "A String", # ETag of the file.
4703 "parents": [ # Collection of parent folders which contain this file.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4704 # 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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]4705 { # A reference to a file's parent.
4706 "selfLink": "A String", # A link back to this reference.
4707 "kind": "drive#parentReference", # This is always drive#parentReference.
4708 "id": "A String", # The ID of the parent.
4709 "isRoot": True or False, # Whether or not the parent is the root folder.
4710 "parentLink": "A String", # A link to the parent.
4711 },
4712 ],
4713 "exportLinks": { # Links for exporting Google Docs to specific formats.
4714 "a_key": "A String", # A mapping from export format to URL
4715 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4716 "shareable": True or False, # Deprecated: use capabilities/canShare.
4717 "copyRequiresWriterPermission": True or False, # Whether the options to copy, print, or download this file, should be disabled for readers and commenters.
4718 "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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]4719 "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.
4720 "a_key": "A String",
4721 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]4722 "canReadRevisions": True or False, # Deprecated: use capabilities/canReadRevisions.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]4723 "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.
4724 "exposureBias": 3.14, # The exposure bias of the photo (APEX value).
4725 "exposureTime": 3.14, # The length of the exposure, in seconds.
4726 "cameraMake": "A String", # The make of the camera used to create the photo.
4727 "maxApertureValue": 3.14, # The smallest f-number of the lens at the focal length used to create the photo (APEX value).
4728 "isoSpeed": 42, # The ISO speed used to create the photo.
4729 "focalLength": 3.14, # The focal length used to create the photo, in millimeters.
4730 "exposureMode": "A String", # The exposure mode used to create the photo.
4731 "colorSpace": "A String", # The color space of the photo.
4732 "location": { # Geographic location information stored in the image.
4733 "latitude": 3.14, # The latitude stored in the image.
4734 "altitude": 3.14, # The altitude stored in the image.
4735 "longitude": 3.14, # The longitude stored in the image.
4736 },
4737 "subjectDistance": 42, # The distance to the subject of the photo, in meters.
4738 "height": 42, # The height of the image in pixels.
4739 "lens": "A String", # The lens used to create the photo.
4740 "date": "A String", # The date and time the photo was taken (EXIF format timestamp).
4741 "width": 42, # The width of the image in pixels.
4742 "meteringMode": "A String", # The metering mode used to create the photo.
4743 "flashUsed": True or False, # Whether a flash was used to create the photo.
4744 "aperture": 3.14, # The aperture used to create the photo (f-number).
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]4745 "rotation": 42, # The number of clockwise 90 degree rotations applied from the image's original orientation.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]4746 "sensor": "A String", # The type of sensor used to create the photo.
4747 "whiteBalance": "A String", # The white balance mode used to create the photo.
4748 "cameraModel": "A String", # The model of the camera used to create the photo.
4749 },
4750 "description": "A String", # A short description of the file.
4751 "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.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]4752 "videoMediaMetadata": { # Metadata about video media. This will only be present for video types.
4753 "width": 42, # The width of the video in pixels.
4754 "durationMillis": "A String", # The duration of the video in milliseconds.
4755 "height": 42, # The height of the video in pixels.
4756 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]4757 "editable": True or False, # Deprecated: use capabilities/canEdit.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]4758 "kind": "drive#file", # The type of file. This is always drive#file.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]4759 "canComment": True or False, # Deprecated: use capabilities/canComment.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]4760 "quotaBytesUsed": "A String", # The number of quota bytes used by this file.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]4761 "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.
4762 "picture": { # The user's profile picture.
4763 "url": "A String", # A URL that points to a profile picture of this user.
4764 },
4765 "kind": "drive#user", # This is always drive#user.
4766 "displayName": "A String", # A plain text displayable name for this user.
4767 "permissionId": "A String", # The user's ID as visible in the permissions collection.
4768 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
4769 "emailAddress": "A String", # The email address of the user.
4770 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4771 "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.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]4772 "createdDate": "A String", # Create time for this file (formatted RFC 3339 timestamp).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4773 "teamDriveId": "A String", # Deprecated - use driveId instead.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]4774 "properties": [ # The list of properties.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]4775 { # A key-value pair attached to a file that is either public or private to an application.
4776 # The following limits apply to file properties:
4777 # - Maximum of 100 properties total per file
4778 # - Maximum of 30 private properties per app
4779 # - Maximum of 30 public properties
4780 # - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]4781 "kind": "drive#property", # This is always drive#property.
4782 "value": "A String", # The value of this property.
4783 "etag": "A String", # ETag of the property.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4784 "visibility": "A String", # The visibility of this property. Allowed values are PRIVATE and PUBLIC. (Default: PRIVATE)
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]4785 "key": "A String", # The key of this property.
4786 "selfLink": "A String", # The link back to this property.
4787 },
4788 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4789 "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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]4790 "iconLink": "A String", # A link to the file's icon.
4791 "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.
4792 "embedLink": "A String", # A link for embedding the file.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]4793 "alternateLink": "A String", # A link for opening the file in a relevant Google editor or viewer.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4794 "shared": True or False, # Whether the file has been shared. Not populated for items in shared drives.
4795 "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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]4796 "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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4797 "thumbnail": { # A thumbnail for the file. This will only be used if a standard thumbnail cannot be generated.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]4798 "mimeType": "A String", # The MIME type of the thumbnail.
4799 "image": "A String", # The URL-safe Base64 encoded bytes of the thumbnail image. It should conform to RFC 4648 section 5.
4800 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4801 "driveId": "A String", # ID of the shared drive the file resides in. Only populated for items in shared drives.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]4802 "userPermission": { # A permission for a file. # The permissions for the authenticated user on this file.
4803 "withLink": True or False, # Whether the link is required for this permission.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]4804 "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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4805 "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.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]4806 {
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]4807 "role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible:
4808 # - organizer
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4809 # - fileOrganizer
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]4810 # - writer
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4811 # - reader
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]4812 "inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4813 "permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible:
4814 # - file
4815 # - member
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]4816 "additionalRoles": [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future.
4817 "A String",
4818 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]4819 "inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field.
4820 },
4821 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4822 "name": "A String", # The name for this permission.
4823 "teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead.
4824 {
4825 "inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead.
4826 "role": "A String", # Deprecated - use permissionDetails/role instead.
4827 "additionalRoles": [ # Deprecated - use permissionDetails/additionalRoles instead.
4828 "A String",
4829 ],
4830 "teamDrivePermissionType": "A String", # Deprecated - use permissionDetails/permissionType instead.
4831 "inherited": True or False, # Deprecated - use permissionDetails/inherited instead.
4832 },
4833 ],
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]4834 "deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]4835 "kind": "drive#permission", # This is always drive#permission.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]4836 "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.
4837 "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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4838 "authKey": "A String", # Deprecated.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]4839 "etag": "A String", # The ETag of the permission.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]4840 "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.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]4841 "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]4842 # - They cannot be set on shared drive items
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]4843 # - They can only be set on user and group permissions
4844 # - The date must be in the future
4845 # - The date cannot be more than a year in the future
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4846 # - The date can only be set on drive.permissions.update or drive.permissions.patch requests
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]4847 "role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed:
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]4848 # - owner
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4849 # - organizer
4850 # - fileOrganizer
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]4851 # - writer
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4852 # - reader
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]4853 "type": "A String", # The account type. Allowed values are:
4854 # - user
4855 # - group
4856 # - domain
4857 # - anyone
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]4858 "additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]4859 "A String",
4860 ],
4861 "selfLink": "A String", # A link back to this permission.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]4862 "photoLink": "A String", # A link to the profile photo, if available.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]4863 },
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]4864 "spaces": [ # The list of spaces which contain the file. Supported values are 'drive', 'appDataFolder' and 'photos'.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]4865 "A String",
4866 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4867 "permissionIds": [ # List of permission IDs for users with access to this file.
4868 "A String",
4869 ],
4870 "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.
4871 "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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]4872 "hasAugmentedPermissions": True or False, # Whether there are permissions directly on this file. This field is only populated for items in shared drives.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4873 "permissions": [ # The list of permissions for users with access to this file. Not populated for items in shared drives.
4874 { # A permission for a file.
4875 "withLink": True or False, # Whether the link is required for this permission.
4876 "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.
4877 "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.
4878 {
4879 "role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible:
4880 # - organizer
4881 # - fileOrganizer
4882 # - writer
4883 # - reader
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]4884 "inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4885 "permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible:
4886 # - file
4887 # - member
4888 "additionalRoles": [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future.
4889 "A String",
4890 ],
4891 "inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field.
4892 },
4893 ],
4894 "name": "A String", # The name for this permission.
4895 "teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead.
4896 {
4897 "inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead.
4898 "role": "A String", # Deprecated - use permissionDetails/role instead.
4899 "additionalRoles": [ # Deprecated - use permissionDetails/additionalRoles instead.
4900 "A String",
4901 ],
4902 "teamDrivePermissionType": "A String", # Deprecated - use permissionDetails/permissionType instead.
4903 "inherited": True or False, # Deprecated - use permissionDetails/inherited instead.
4904 },
4905 ],
4906 "deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.
4907 "kind": "drive#permission", # This is always drive#permission.
4908 "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.
4909 "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.
4910 "authKey": "A String", # Deprecated.
4911 "etag": "A String", # The ETag of the permission.
4912 "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.
4913 "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]4914 # - They cannot be set on shared drive items
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4915 # - They can only be set on user and group permissions
4916 # - The date must be in the future
4917 # - The date cannot be more than a year in the future
4918 # - The date can only be set on drive.permissions.update or drive.permissions.patch requests
4919 "role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed:
4920 # - owner
4921 # - organizer
4922 # - fileOrganizer
4923 # - writer
4924 # - reader
4925 "type": "A String", # The account type. Allowed values are:
4926 # - user
4927 # - group
4928 # - domain
4929 # - anyone
4930 "additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future.
4931 "A String",
4932 ],
4933 "selfLink": "A String", # A link back to this permission.
4934 "photoLink": "A String", # A link to the profile photo, if available.
4935 },
4936 ],
4937 "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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]4938 "selfLink": "A String", # A link back to this file.
4939 "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.
4940 }</pre>
4941</div>
4942
4943<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]4944 <code class="details" id="watch">watch(fileId, body=None, projection=None, revisionId=None, supportsTeamDrives=None, supportsAllDrives=None, acknowledgeAbuse=None, updateViewedDate=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]4945 <pre>Subscribe to changes on a file
4946
4947Args:
4948 fileId: string, The ID for the file in question. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]4949 body: object, The request body.
John Asmuth614db982014-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.
4953 "resourceUri": "A String", # A version-specific identifier for the watched resource.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]4954 "kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource, which is "api#channel".
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]4955 "resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.
4956 "payload": True or False, # A Boolean value to indicate whether payload is wanted. Optional.
4957 "token": "A String", # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.
4958 "params": { # Additional parameters controlling delivery channel behavior. Optional.
4959 "a_key": "A String", # Declares a new parameter by name.
4960 },
4961 "expiration": "A String", # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.
4962 "address": "A String", # The address where notifications are delivered for this channel.
4963 "type": "A String", # The type of delivery mechanism used for this channel.
4964 "id": "A String", # A UUID or similar unique string that identifies this channel.
4965 }
4966
4967 projection: string, This parameter is deprecated and has no function.
4968 Allowed values
4969 BASIC - Deprecated
4970 FULL - Deprecated
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]4971 revisionId: string, Specifies the Revision ID that should be downloaded. Ignored unless alt=media is specified.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4972 supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead.
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.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]4974 acknowledgeAbuse: boolean, Whether the user is acknowledging the risk of downloading known malware or other abusive files.
Sai Cheemalapatidf613972016-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 Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]4976
4977Returns:
4978 An object of the form:
4979
4980 { # An notification channel used to watch for resource changes.
4981 "resourceUri": "A String", # A version-specific identifier for the watched resource.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]4982 "kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource, which is "api#channel".
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]4983 "resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.
4984 "payload": True or False, # A Boolean value to indicate whether payload is wanted. Optional.
4985 "token": "A String", # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.
4986 "params": { # Additional parameters controlling delivery channel behavior. Optional.
4987 "a_key": "A String", # Declares a new parameter by name.
4988 },
4989 "expiration": "A String", # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.
4990 "address": "A String", # The address where notifications are delivered for this channel.
4991 "type": "A String", # The type of delivery mechanism used for this channel.
4992 "id": "A String", # A UUID or similar unique string that identifies this channel.
4993 }</pre>
4994</div>
4995
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]4996<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]4997 <code class="details" id="watch_media">watch_media(fileId, body=None, projection=None, revisionId=None, supportsTeamDrives=None, supportsAllDrives=None, acknowledgeAbuse=None, updateViewedDate=None)</code>
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]4998 <pre>Subscribe to changes on a file
4999
5000Args:
5001 fileId: string, The ID for the file in question. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]5002 body: object, The request body.
Craig Citroe633be12015-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.
5006 "resourceUri": "A String", # A version-specific identifier for the watched resource.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]5007 "kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource, which is "api#channel".
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]5008 "resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.
5009 "payload": True or False, # A Boolean value to indicate whether payload is wanted. Optional.
5010 "token": "A String", # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.
5011 "params": { # Additional parameters controlling delivery channel behavior. Optional.
5012 "a_key": "A String", # Declares a new parameter by name.
5013 },
5014 "expiration": "A String", # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.
5015 "address": "A String", # The address where notifications are delivered for this channel.
5016 "type": "A String", # The type of delivery mechanism used for this channel.
5017 "id": "A String", # A UUID or similar unique string that identifies this channel.
5018 }
5019
5020 projection: string, This parameter is deprecated and has no function.
5021 Allowed values
5022 BASIC - Deprecated
5023 FULL - Deprecated
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]5024 revisionId: string, Specifies the Revision ID that should be downloaded. Ignored unless alt=media is specified.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5025 supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead.
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.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]5027 acknowledgeAbuse: boolean, Whether the user is acknowledging the risk of downloading known malware or other abusive files.
Sai Cheemalapatidf613972016-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 Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]5029
5030Returns:
5031 The media object as a string.
5032
5033 </pre>
5034</div>
5035
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]5036</body></html>