Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 04bafe14efe7a6d1a7da03de89312062a4afa127 / . / docs / dyn / drive_v2.files.html
blob: 07e32b7278c851261413251266799780ff83f0c5 [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">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]78 <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
80<p class="toc_element">
81 <code><a href="#copy">copy(fileId, body=None, convert=None, enforceSingleParent=None, includePermissionsForView=None, ocr=None, ocrLanguage=None, pinned=None, supportsAllDrives=None, supportsTeamDrives=None, timedTextLanguage=None, timedTextTrackName=None, visibility=None)</a></code></p>
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]82<p class="firstline">Creates a copy of the specified file. Folders cannot be copied.</p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]83<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]84 <code><a href="#delete">delete(fileId, enforceSingleParent=None, supportsAllDrives=None, supportsTeamDrives=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]85<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]86<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]87 <code><a href="#emptyTrash">emptyTrash(enforceSingleParent=None)</a></code></p>
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]88<p class="firstline">Permanently deletes all of the user's trashed files.</p>
89<p class="toc_element">
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]90 <code><a href="#export">export(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">
93 <code><a href="#export_media">export_media(fileId, mimeType)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]94<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]95<p class="toc_element">
yoshi-code-botc2cd3262021-05-16 02:16:04 -0700[diff] [blame]96 <code><a href="#generateIds">generateIds(maxResults=None, space=None, type=None)</a></code></p>
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]97<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]98<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]99 <code><a href="#get">get(fileId, acknowledgeAbuse=None, includePermissionsForView=None, projection=None, revisionId=None, supportsAllDrives=None, supportsTeamDrives=None, updateViewedDate=None)</a></code></p>
yoshi-code-bot3dd15272021-04-21 15:07:48 -0700[diff] [blame]100<p class="firstline">Gets a file's metadata or content by ID.</p>
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]101<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]102 <code><a href="#get_media">get_media(fileId, acknowledgeAbuse=None, includePermissionsForView=None, projection=None, revisionId=None, supportsAllDrives=None, supportsTeamDrives=None, updateViewedDate=None)</a></code></p>
yoshi-code-bot3dd15272021-04-21 15:07:48 -0700[diff] [blame]103<p class="firstline">Gets a file's metadata or content by ID.</p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]104<p class="toc_element">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]105 <code><a href="#insert">insert(body=None, convert=None, enforceSingleParent=None, includePermissionsForView=None, media_body=None, media_mime_type=None, ocr=None, ocrLanguage=None, pinned=None, supportsAllDrives=None, supportsTeamDrives=None, timedTextLanguage=None, timedTextTrackName=None, useContentAsIndexableText=None, visibility=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]106<p class="firstline">Insert a new file.</p>
107<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]108 <code><a href="#list">list(corpora=None, corpus=None, driveId=None, includeItemsFromAllDrives=None, includePermissionsForView=None, includeTeamDriveItems=None, maxResults=None, orderBy=None, pageToken=None, projection=None, q=None, spaces=None, supportsAllDrives=None, supportsTeamDrives=None, teamDriveId=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]109<p class="firstline">Lists the user's files.</p>
110<p class="toc_element">
111 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
112<p class="firstline">Retrieves the next page of results.</p>
113<p class="toc_element">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]114 <code><a href="#patch">patch(fileId, addParents=None, body=None, convert=None, enforceSingleParent=None, includePermissionsForView=None, modifiedDateBehavior=None, newRevision=None, ocr=None, ocrLanguage=None, pinned=None, removeParents=None, setModifiedDate=None, supportsAllDrives=None, supportsTeamDrives=None, timedTextLanguage=None, timedTextTrackName=None, updateViewedDate=None, useContentAsIndexableText=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]115<p class="firstline">Updates file metadata and/or content. This method supports patch semantics.</p>
116<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]117 <code><a href="#touch">touch(fileId, includePermissionsForView=None, supportsAllDrives=None, supportsTeamDrives=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]118<p class="firstline">Set the file's updated time to the current server time.</p>
119<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]120 <code><a href="#trash">trash(fileId, includePermissionsForView=None, supportsAllDrives=None, supportsTeamDrives=None)</a></code></p>
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]121<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. Only the owner may trash a file. The trashed item is excluded from all files.list responses returned for any user who does not own the file. However, all users with access to the file can see the trashed item metadata in an API response. All users with access can copy, download, export, and share the file.</p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]122<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]123 <code><a href="#untrash">untrash(fileId, includePermissionsForView=None, supportsAllDrives=None, supportsTeamDrives=None)</a></code></p>
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]124<p class="firstline">Restores a file from the trash. The currently authenticated user must own the file or be at least a fileOrganizer on the parent for shared drive files. Only the owner may untrash a file.</p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]125<p class="toc_element">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]126 <code><a href="#update">update(fileId, addParents=None, body=None, convert=None, enforceSingleParent=None, includePermissionsForView=None, media_body=None, media_mime_type=None, modifiedDateBehavior=None, newRevision=None, ocr=None, ocrLanguage=None, pinned=None, removeParents=None, setModifiedDate=None, supportsAllDrives=None, supportsTeamDrives=None, timedTextLanguage=None, timedTextTrackName=None, updateViewedDate=None, useContentAsIndexableText=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]127<p class="firstline">Updates file metadata and/or content.</p>
128<p class="toc_element">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]129 <code><a href="#watch">watch(fileId, acknowledgeAbuse=None, body=None, includePermissionsForView=None, projection=None, revisionId=None, supportsAllDrives=None, supportsTeamDrives=None, updateViewedDate=None)</a></code></p>
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]130<p class="firstline">Subscribe to changes on a file</p>
131<p class="toc_element">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]132 <code><a href="#watch_media">watch_media(fileId, acknowledgeAbuse=None, body=None, includePermissionsForView=None, projection=None, revisionId=None, supportsAllDrives=None, supportsTeamDrives=None, updateViewedDate=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]133<p class="firstline">Subscribe to changes on a file</p>
134<h3>Method Details</h3>
135<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]136 <code class="details" id="close">close()</code>
137 <pre>Close httplib2 connections.</pre>
138</div>
139
140<div class="method">
141 <code class="details" id="copy">copy(fileId, body=None, convert=None, enforceSingleParent=None, includePermissionsForView=None, ocr=None, ocrLanguage=None, pinned=None, supportsAllDrives=None, supportsTeamDrives=None, timedTextLanguage=None, timedTextTrackName=None, visibility=None)</code>
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]142 <pre>Creates a copy of the specified file. Folders cannot be copied.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]143
144Args:
145 fileId: string, The ID of the file to copy. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]146 body: object, The request body.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]147 The object takes the form of:
148
149{ # The metadata for a file.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]150 &quot;alternateLink&quot;: &quot;A String&quot;, # A link for opening the file in a relevant Google editor or viewer.
151 &quot;appDataContents&quot;: True or False, # Whether this file is in the Application Data folder.
152 &quot;canComment&quot;: True or False, # Deprecated: use capabilities/canComment.
153 &quot;canReadRevisions&quot;: True or False, # Deprecated: use capabilities/canReadRevisions.
154 &quot;capabilities&quot;: { # Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take.
155 &quot;canAddChildren&quot;: True or False, # Whether the current user can add children to this folder. This is always false when the item is not a folder.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]156 &quot;canAddFolderFromAnotherDrive&quot;: True or False, # Whether the current user can add a folder from another drive (different shared drive or My Drive) to this folder. This is false when the item is not a folder. Only populated for items in shared drives.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]157 &quot;canAddMyDriveParent&quot;: 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.
158 &quot;canChangeCopyRequiresWriterPermission&quot;: True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this file.
159 &quot;canChangeRestrictedDownload&quot;: True or False, # Deprecated
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700[diff] [blame^]160 &quot;canChangeSecurityUpdateEnabled&quot;: True or False, # Whether the current user can change the securityUpdateEnabled field on link share metadata.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]161 &quot;canComment&quot;: True or False, # Whether the current user can comment on this file.
162 &quot;canCopy&quot;: 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.
163 &quot;canDelete&quot;: True or False, # Whether the current user can delete this file.
164 &quot;canDeleteChildren&quot;: 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.
165 &quot;canDownload&quot;: True or False, # Whether the current user can download this file.
166 &quot;canEdit&quot;: 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.
167 &quot;canListChildren&quot;: 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.
168 &quot;canModifyContent&quot;: True or False, # Whether the current user can modify the content of this file.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]169 &quot;canModifyContentRestriction&quot;: True or False, # Whether the current user can modify restrictions on content of this file.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]170 &quot;canMoveChildrenOutOfDrive&quot;: 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.
171 &quot;canMoveChildrenOutOfTeamDrive&quot;: True or False, # Deprecated - use canMoveChildrenOutOfDrive instead.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]172 &quot;canMoveChildrenWithinDrive&quot;: True or False, # Whether the current user can move children of this folder within this drive. This is false when the item is not a folder. Note that a request to move the child may still fail depending on the current user&#x27;s access to the child and to the destination folder.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]173 &quot;canMoveChildrenWithinTeamDrive&quot;: True or False, # Deprecated - use canMoveChildrenWithinDrive instead.
174 &quot;canMoveItemIntoTeamDrive&quot;: True or False, # Deprecated - use canMoveItemOutOfDrive instead.
175 &quot;canMoveItemOutOfDrive&quot;: 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.
176 &quot;canMoveItemOutOfTeamDrive&quot;: True or False, # Deprecated - use canMoveItemOutOfDrive instead.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]177 &quot;canMoveItemWithinDrive&quot;: True or False, # Whether the current user can move this item within this drive. Note that a request to change the parent of the item may still fail depending on the new parent that is being added and the parent that is being removed.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]178 &quot;canMoveItemWithinTeamDrive&quot;: True or False, # Deprecated - use canMoveItemWithinDrive instead.
179 &quot;canMoveTeamDriveItem&quot;: True or False, # Deprecated - use canMoveItemWithinDrive or canMoveItemOutOfDrive instead.
180 &quot;canReadDrive&quot;: True or False, # Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives.
181 &quot;canReadRevisions&quot;: 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.
182 &quot;canReadTeamDrive&quot;: True or False, # Deprecated - use canReadDrive instead.
183 &quot;canRemoveChildren&quot;: 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.
184 &quot;canRemoveMyDriveParent&quot;: 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.
185 &quot;canRename&quot;: True or False, # Whether the current user can rename this file.
186 &quot;canShare&quot;: True or False, # Whether the current user can modify the sharing settings for this file.
187 &quot;canTrash&quot;: True or False, # Whether the current user can move this file to trash.
188 &quot;canTrashChildren&quot;: 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.
189 &quot;canUntrash&quot;: True or False, # Whether the current user can restore this file from trash.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]190 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]191 &quot;contentRestrictions&quot;: [ # Restrictions for accessing the content of the file. Only populated if such a restriction exists.
192 { # A restriction for accessing the content of the file.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]193 &quot;readOnly&quot;: True or False, # Whether the content of the file is read-only. If a file is read-only, a new revision of the file may not be added, comments may not be added or modified, and the title of the file may not be modified.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]194 &quot;reason&quot;: &quot;A String&quot;, # Reason for why the content of the file is restricted. This is only mutable on requests that also set readOnly=true.
195 &quot;restrictingUser&quot;: { # Information about a Drive user. # The user who set the content restriction. Only populated if readOnly is true.
196 &quot;displayName&quot;: &quot;A String&quot;, # A plain text displayable name for this user.
197 &quot;emailAddress&quot;: &quot;A String&quot;, # The email address of the user.
198 &quot;isAuthenticatedUser&quot;: True or False, # Whether this user is the same as the authenticated user for whom the request was made.
199 &quot;kind&quot;: &quot;drive#user&quot;, # This is always drive#user.
200 &quot;permissionId&quot;: &quot;A String&quot;, # The user&#x27;s ID as visible in the permissions collection.
201 &quot;picture&quot;: { # The user&#x27;s profile picture.
202 &quot;url&quot;: &quot;A String&quot;, # A URL that points to a profile picture of this user.
203 },
204 },
205 &quot;restrictionDate&quot;: &quot;A String&quot;, # The time at which the content restriction was set (formatted RFC 3339 timestamp). Only populated if readOnly is true.
206 &quot;type&quot;: &quot;A String&quot;, # The type of the content restriction. Currently the only possible value is globalContentRestriction.
207 },
208 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]209 &quot;copyRequiresWriterPermission&quot;: True or False, # Whether the options to copy, print, or download this file, should be disabled for readers and commenters.
210 &quot;copyable&quot;: True or False, # Deprecated: use capabilities/canCopy.
211 &quot;createdDate&quot;: &quot;A String&quot;, # Create time for this file (formatted RFC 3339 timestamp).
212 &quot;defaultOpenWithLink&quot;: &quot;A String&quot;, # A link to open this file with the user&#x27;s default app for this file. Only populated when the drive.apps.readonly scope is used.
213 &quot;description&quot;: &quot;A String&quot;, # A short description of the file.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]214 &quot;downloadUrl&quot;: &quot;A String&quot;, # Short lived download URL for the file. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]215 &quot;driveId&quot;: &quot;A String&quot;, # ID of the shared drive the file resides in. Only populated for items in shared drives.
216 &quot;editable&quot;: True or False, # Deprecated: use capabilities/canEdit.
217 &quot;embedLink&quot;: &quot;A String&quot;, # A link for embedding the file.
218 &quot;etag&quot;: &quot;A String&quot;, # ETag of the file.
219 &quot;explicitlyTrashed&quot;: True or False, # Whether this file has been explicitly trashed, as opposed to recursively trashed.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]220 &quot;exportLinks&quot;: { # Links for exporting Docs Editors files to specific formats.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]221 &quot;a_key&quot;: &quot;A String&quot;, # A mapping from export format to URL
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]222 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]223 &quot;fileExtension&quot;: &quot;A String&quot;, # The final component of fullFileExtension with trailing text that does not appear to be part of the extension removed. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.
224 &quot;fileSize&quot;: &quot;A String&quot;, # The size of the file in bytes. This field is populated for files with content stored in Google Drive and for files in Docs Editors; it is not populated for shortcut files.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]225 &quot;folderColorRgb&quot;: &quot;A String&quot;, # 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.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]226 &quot;fullFileExtension&quot;: &quot;A String&quot;, # The full file extension; extracted from the title. May contain multiple concatenated extensions, such as &quot;tar.gz&quot;. Removing an extension from the title does not clear this field; however, changing the extension on the title does update this field. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]227 &quot;hasAugmentedPermissions&quot;: True or False, # Whether there are permissions directly on this file. This field is only populated for items in shared drives.
228 &quot;hasThumbnail&quot;: 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.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]229 &quot;headRevisionId&quot;: &quot;A String&quot;, # The ID of the file&#x27;s head revision. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]230 &quot;iconLink&quot;: &quot;A String&quot;, # A link to the file&#x27;s icon.
231 &quot;id&quot;: &quot;A String&quot;, # The ID of the file.
232 &quot;imageMediaMetadata&quot;: { # 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.
233 &quot;aperture&quot;: 3.14, # The aperture used to create the photo (f-number).
234 &quot;cameraMake&quot;: &quot;A String&quot;, # The make of the camera used to create the photo.
235 &quot;cameraModel&quot;: &quot;A String&quot;, # The model of the camera used to create the photo.
236 &quot;colorSpace&quot;: &quot;A String&quot;, # The color space of the photo.
237 &quot;date&quot;: &quot;A String&quot;, # The date and time the photo was taken (EXIF format timestamp).
238 &quot;exposureBias&quot;: 3.14, # The exposure bias of the photo (APEX value).
239 &quot;exposureMode&quot;: &quot;A String&quot;, # The exposure mode used to create the photo.
240 &quot;exposureTime&quot;: 3.14, # The length of the exposure, in seconds.
241 &quot;flashUsed&quot;: True or False, # Whether a flash was used to create the photo.
242 &quot;focalLength&quot;: 3.14, # The focal length used to create the photo, in millimeters.
243 &quot;height&quot;: 42, # The height of the image in pixels.
244 &quot;isoSpeed&quot;: 42, # The ISO speed used to create the photo.
245 &quot;lens&quot;: &quot;A String&quot;, # The lens used to create the photo.
246 &quot;location&quot;: { # Geographic location information stored in the image.
247 &quot;altitude&quot;: 3.14, # The altitude stored in the image.
248 &quot;latitude&quot;: 3.14, # The latitude stored in the image.
249 &quot;longitude&quot;: 3.14, # The longitude stored in the image.
250 },
251 &quot;maxApertureValue&quot;: 3.14, # The smallest f-number of the lens at the focal length used to create the photo (APEX value).
252 &quot;meteringMode&quot;: &quot;A String&quot;, # The metering mode used to create the photo.
253 &quot;rotation&quot;: 42, # The number of clockwise 90 degree rotations applied from the image&#x27;s original orientation.
254 &quot;sensor&quot;: &quot;A String&quot;, # The type of sensor used to create the photo.
255 &quot;subjectDistance&quot;: 42, # The distance to the subject of the photo, in meters.
256 &quot;whiteBalance&quot;: &quot;A String&quot;, # The white balance mode used to create the photo.
257 &quot;width&quot;: 42, # The width of the image in pixels.
258 },
259 &quot;indexableText&quot;: { # Indexable text attributes for the file (can only be written)
260 &quot;text&quot;: &quot;A String&quot;, # The text to be indexed for this file.
261 },
262 &quot;isAppAuthorized&quot;: True or False, # Whether the file was created or opened by the requesting app.
263 &quot;kind&quot;: &quot;drive#file&quot;, # The type of file. This is always drive#file.
264 &quot;labels&quot;: { # A group of labels for the file.
265 &quot;hidden&quot;: True or False, # Deprecated.
266 &quot;modified&quot;: True or False, # Whether the file has been modified by this user.
267 &quot;restricted&quot;: True or False, # Deprecated - use copyRequiresWriterPermission instead.
268 &quot;starred&quot;: True or False, # Whether this file is starred by the user.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]269 &quot;trashed&quot;: True or False, # Whether the file has been trashed, either explicitly or from a trashed parent folder. Only the owner may trash a file. The trashed item is excluded from all files.list responses returned for any user who does not own the file. However, all users with access to the file can see the trashed item metadata in an API response. All users with access can copy, download, export, and share the file.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]270 &quot;viewed&quot;: True or False, # Whether this file has been viewed by this user.
271 },
272 &quot;lastModifyingUser&quot;: { # Information about a Drive user. # The last user to modify this file.
273 &quot;displayName&quot;: &quot;A String&quot;, # A plain text displayable name for this user.
274 &quot;emailAddress&quot;: &quot;A String&quot;, # The email address of the user.
275 &quot;isAuthenticatedUser&quot;: True or False, # Whether this user is the same as the authenticated user for whom the request was made.
276 &quot;kind&quot;: &quot;drive#user&quot;, # This is always drive#user.
277 &quot;permissionId&quot;: &quot;A String&quot;, # The user&#x27;s ID as visible in the permissions collection.
278 &quot;picture&quot;: { # The user&#x27;s profile picture.
279 &quot;url&quot;: &quot;A String&quot;, # A URL that points to a profile picture of this user.
280 },
281 },
282 &quot;lastModifyingUserName&quot;: &quot;A String&quot;, # Name of the last user to modify this file.
283 &quot;lastViewedByMeDate&quot;: &quot;A String&quot;, # Last time this file was viewed by the user (formatted RFC 3339 timestamp).
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700[diff] [blame^]284 &quot;linkShareMetadata&quot;: { # Contains details about the link URLs that clients are using to refer to this item.
285 &quot;securityUpdateEligible&quot;: True or False, # Whether the file is eligible for security update.
286 &quot;securityUpdateEnabled&quot;: True or False, # Whether the security update is enabled for this file.
287 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]288 &quot;markedViewedByMeDate&quot;: &quot;A String&quot;, # Deprecated.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]289 &quot;md5Checksum&quot;: &quot;A String&quot;, # An MD5 checksum for the content of this file. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]290 &quot;mimeType&quot;: &quot;A String&quot;, # 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&#x27;s MIME type.
291 &quot;modifiedByMeDate&quot;: &quot;A String&quot;, # 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.
292 &quot;modifiedDate&quot;: &quot;A String&quot;, # Last time this file was modified by anyone (formatted RFC 3339 timestamp). This is only mutable on update when the setModifiedDate parameter is set.
293 &quot;openWithLinks&quot;: { # A map of the id of each of the user&#x27;s apps to a link to open this file with that app. Only populated when the drive.apps.readonly scope is used.
294 &quot;a_key&quot;: &quot;A String&quot;,
295 },
296 &quot;originalFilename&quot;: &quot;A String&quot;, # 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.
297 &quot;ownedByMe&quot;: True or False, # Whether the file is owned by the current user. Not populated for items in shared drives.
298 &quot;ownerNames&quot;: [ # Name(s) of the owner(s) of this file. Not populated for items in shared drives.
299 &quot;A String&quot;,
300 ],
yoshi-code-botab1d6dc2021-05-28 00:42:02 -0700[diff] [blame]301 &quot;owners&quot;: [ # The owner of this file. Only certain legacy files may have more than one owner. This field isn&#x27;t populated for items in shared drives.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]302 { # Information about a Drive user.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]303 &quot;displayName&quot;: &quot;A String&quot;, # A plain text displayable name for this user.
304 &quot;emailAddress&quot;: &quot;A String&quot;, # The email address of the user.
305 &quot;isAuthenticatedUser&quot;: True or False, # Whether this user is the same as the authenticated user for whom the request was made.
306 &quot;kind&quot;: &quot;drive#user&quot;, # This is always drive#user.
307 &quot;permissionId&quot;: &quot;A String&quot;, # The user&#x27;s ID as visible in the permissions collection.
308 &quot;picture&quot;: { # The user&#x27;s profile picture.
309 &quot;url&quot;: &quot;A String&quot;, # A URL that points to a profile picture of this user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]310 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]311 },
312 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]313 &quot;parents&quot;: [ # Collection of parent folders which contain this file.
314 # If not specified as part of an insert request, the file will be placed directly in the user&#x27;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.
315 { # A reference to a file&#x27;s parent.
316 &quot;id&quot;: &quot;A String&quot;, # The ID of the parent.
317 &quot;isRoot&quot;: True or False, # Whether or not the parent is the root folder.
318 &quot;kind&quot;: &quot;drive#parentReference&quot;, # This is always drive#parentReference.
319 &quot;parentLink&quot;: &quot;A String&quot;, # A link to the parent.
320 &quot;selfLink&quot;: &quot;A String&quot;, # A link back to this reference.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]321 },
322 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]323 &quot;permissionIds&quot;: [ # List of permission IDs for users with access to this file.
324 &quot;A String&quot;,
325 ],
326 &quot;permissions&quot;: [ # The list of permissions for users with access to this file. Not populated for items in shared drives.
327 { # A permission for a file.
328 &quot;additionalRoles&quot;: [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future.
329 &quot;A String&quot;,
330 ],
331 &quot;authKey&quot;: &quot;A String&quot;, # Deprecated.
332 &quot;deleted&quot;: True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.
333 &quot;domain&quot;: &quot;A String&quot;, # 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.
334 &quot;emailAddress&quot;: &quot;A String&quot;, # 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.
335 &quot;etag&quot;: &quot;A String&quot;, # The ETag of the permission.
336 &quot;expirationDate&quot;: &quot;A String&quot;, # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions:
337 # - They cannot be set on shared drive items
338 # - They can only be set on user and group permissions
339 # - The date must be in the future
340 # - The date cannot be more than a year in the future
341 # - The date can only be set on drive.permissions.update or drive.permissions.patch requests
342 &quot;id&quot;: &quot;A String&quot;, # 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.
343 &quot;kind&quot;: &quot;drive#permission&quot;, # This is always drive#permission.
344 &quot;name&quot;: &quot;A String&quot;, # The name for this permission.
345 &quot;permissionDetails&quot;: [ # 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.
346 {
347 &quot;additionalRoles&quot;: [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future.
348 &quot;A String&quot;,
349 ],
350 &quot;inherited&quot;: True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field.
351 &quot;inheritedFrom&quot;: &quot;A String&quot;, # The ID of the item from which this permission is inherited. This is an output-only field.
352 &quot;permissionType&quot;: &quot;A String&quot;, # The permission type for this user. While new values may be added in future, the following are currently possible:
353 # - file
354 # - member
355 &quot;role&quot;: &quot;A String&quot;, # The primary role for this user. While new values may be added in the future, the following are currently possible:
356 # - organizer
357 # - fileOrganizer
358 # - writer
359 # - reader
360 },
361 ],
362 &quot;photoLink&quot;: &quot;A String&quot;, # A link to the profile photo, if available.
363 &quot;role&quot;: &quot;A String&quot;, # The primary role for this user. While new values may be supported in the future, the following are currently allowed:
364 # - owner
365 # - organizer
366 # - fileOrganizer
367 # - writer
368 # - reader
369 &quot;selfLink&quot;: &quot;A String&quot;, # A link back to this permission.
370 &quot;teamDrivePermissionDetails&quot;: [ # Deprecated - use permissionDetails instead.
371 {
372 &quot;additionalRoles&quot;: [ # Deprecated - use permissionDetails/additionalRoles instead.
373 &quot;A String&quot;,
374 ],
375 &quot;inherited&quot;: True or False, # Deprecated - use permissionDetails/inherited instead.
376 &quot;inheritedFrom&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/inheritedFrom instead.
377 &quot;role&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/role instead.
378 &quot;teamDrivePermissionType&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/permissionType instead.
379 },
380 ],
381 &quot;type&quot;: &quot;A String&quot;, # The account type. Allowed values are:
382 # - user
383 # - group
384 # - domain
385 # - anyone
386 &quot;value&quot;: &quot;A String&quot;, # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type is anyone, in which case both id and value are ignored.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]387 &quot;view&quot;: &quot;A String&quot;, # Indicates the view for this permission. Only populated for permissions that belong to a view. published is the only supported value.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]388 &quot;withLink&quot;: True or False, # Whether the link is required for this permission.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]389 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]390 ],
391 &quot;properties&quot;: [ # The list of properties.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]392 { # A key-value pair attached to a file that is either public or private to an application.
393 # The following limits apply to file properties:
394 # - Maximum of 100 properties total per file
395 # - Maximum of 30 private properties per app
396 # - Maximum of 30 public properties
397 # - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]398 &quot;etag&quot;: &quot;A String&quot;, # ETag of the property.
399 &quot;key&quot;: &quot;A String&quot;, # The key of this property.
400 &quot;kind&quot;: &quot;drive#property&quot;, # This is always drive#property.
401 &quot;selfLink&quot;: &quot;A String&quot;, # The link back to this property.
402 &quot;value&quot;: &quot;A String&quot;, # The value of this property.
yoshi-code-bot69706592021-03-03 03:54:02 -0800[diff] [blame]403 &quot;visibility&quot;: &quot;A String&quot;, # The visibility of this property. Allowed values are PRIVATE and PUBLIC. (Default: PRIVATE). Private properties can only be retrieved using an authenticated request. An authenticated request uses an access token obtained with a OAuth 2 client ID. You cannot use an API key to retrieve private properties.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]404 },
405 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]406 &quot;quotaBytesUsed&quot;: &quot;A String&quot;, # The number of quota bytes used by this file.
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700[diff] [blame^]407 &quot;resourceKey&quot;: &quot;A String&quot;, # A key needed to access the item via a shared link.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]408 &quot;selfLink&quot;: &quot;A String&quot;, # A link back to this file.
409 &quot;shareable&quot;: True or False, # Deprecated: use capabilities/canShare.
410 &quot;shared&quot;: True or False, # Whether the file has been shared. Not populated for items in shared drives.
411 &quot;sharedWithMeDate&quot;: &quot;A String&quot;, # Time at which this file was shared with the user (formatted RFC 3339 timestamp).
412 &quot;sharingUser&quot;: { # Information about a Drive user. # User that shared the item with the current user, if available.
413 &quot;displayName&quot;: &quot;A String&quot;, # A plain text displayable name for this user.
414 &quot;emailAddress&quot;: &quot;A String&quot;, # The email address of the user.
415 &quot;isAuthenticatedUser&quot;: True or False, # Whether this user is the same as the authenticated user for whom the request was made.
416 &quot;kind&quot;: &quot;drive#user&quot;, # This is always drive#user.
417 &quot;permissionId&quot;: &quot;A String&quot;, # The user&#x27;s ID as visible in the permissions collection.
418 &quot;picture&quot;: { # The user&#x27;s profile picture.
419 &quot;url&quot;: &quot;A String&quot;, # A URL that points to a profile picture of this user.
420 },
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]421 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]422 &quot;shortcutDetails&quot;: { # Shortcut file details. Only populated for shortcut files, which have the mimeType field set to application/vnd.google-apps.shortcut.
423 &quot;targetId&quot;: &quot;A String&quot;, # The ID of the file that this shortcut points to.
424 &quot;targetMimeType&quot;: &quot;A String&quot;, # The MIME type of the file that this shortcut points to. The value of this field is a snapshot of the target&#x27;s MIME type, captured when the shortcut is created.
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700[diff] [blame^]425 &quot;targetResourceKey&quot;: &quot;A String&quot;, # The ResourceKey for the target file.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]426 },
427 &quot;spaces&quot;: [ # The list of spaces which contain the file. Supported values are &#x27;drive&#x27;, &#x27;appDataFolder&#x27; and &#x27;photos&#x27;.
428 &quot;A String&quot;,
429 ],
430 &quot;teamDriveId&quot;: &quot;A String&quot;, # Deprecated - use driveId instead.
431 &quot;thumbnail&quot;: { # A thumbnail for the file. This will only be used if a standard thumbnail cannot be generated.
432 &quot;image&quot;: &quot;A String&quot;, # The URL-safe Base64 encoded bytes of the thumbnail image. It should conform to RFC 4648 section 5.
433 &quot;mimeType&quot;: &quot;A String&quot;, # The MIME type of the thumbnail.
434 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]435 &quot;thumbnailLink&quot;: &quot;A String&quot;, # A short-lived link to the file&#x27;s thumbnail. Typically lasts on the order of hours. Only populated when the requesting app can access the file&#x27;s content. If the file isn&#x27;t shared publicly, the URL returned in Files.thumbnailLink must be fetched using a credentialed request.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]436 &quot;thumbnailVersion&quot;: &quot;A String&quot;, # The thumbnail version for use in thumbnail cache invalidation.
437 &quot;title&quot;: &quot;A String&quot;, # 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.
438 &quot;trashedDate&quot;: &quot;A String&quot;, # The time that the item was trashed (formatted RFC 3339 timestamp). Only populated for items in shared drives.
439 &quot;trashingUser&quot;: { # Information about a Drive user. # If the file has been explicitly trashed, the user who trashed it. Only populated for items in shared drives.
440 &quot;displayName&quot;: &quot;A String&quot;, # A plain text displayable name for this user.
441 &quot;emailAddress&quot;: &quot;A String&quot;, # The email address of the user.
442 &quot;isAuthenticatedUser&quot;: True or False, # Whether this user is the same as the authenticated user for whom the request was made.
443 &quot;kind&quot;: &quot;drive#user&quot;, # This is always drive#user.
444 &quot;permissionId&quot;: &quot;A String&quot;, # The user&#x27;s ID as visible in the permissions collection.
445 &quot;picture&quot;: { # The user&#x27;s profile picture.
446 &quot;url&quot;: &quot;A String&quot;, # A URL that points to a profile picture of this user.
447 },
448 },
449 &quot;userPermission&quot;: { # A permission for a file. # The permissions for the authenticated user on this file.
450 &quot;additionalRoles&quot;: [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future.
451 &quot;A String&quot;,
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]452 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]453 &quot;authKey&quot;: &quot;A String&quot;, # Deprecated.
454 &quot;deleted&quot;: True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.
455 &quot;domain&quot;: &quot;A String&quot;, # 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.
456 &quot;emailAddress&quot;: &quot;A String&quot;, # 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 &quot;etag&quot;: &quot;A String&quot;, # The ETag of the permission.
458 &quot;expirationDate&quot;: &quot;A String&quot;, # 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]459 # - They cannot be set on shared drive items
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]460 # - They can only be set on user and group permissions
461 # - The date must be in the future
462 # - The date cannot be more than a year in the future
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]463 # - The date can only be set on drive.permissions.update or drive.permissions.patch requests
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]464 &quot;id&quot;: &quot;A String&quot;, # 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.
465 &quot;kind&quot;: &quot;drive#permission&quot;, # This is always drive#permission.
466 &quot;name&quot;: &quot;A String&quot;, # The name for this permission.
467 &quot;permissionDetails&quot;: [ # 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.
468 {
469 &quot;additionalRoles&quot;: [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future.
470 &quot;A String&quot;,
471 ],
472 &quot;inherited&quot;: True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field.
473 &quot;inheritedFrom&quot;: &quot;A String&quot;, # The ID of the item from which this permission is inherited. This is an output-only field.
474 &quot;permissionType&quot;: &quot;A String&quot;, # The permission type for this user. While new values may be added in future, the following are currently possible:
475 # - file
476 # - member
477 &quot;role&quot;: &quot;A String&quot;, # The primary role for this user. While new values may be added in the future, the following are currently possible:
478 # - organizer
479 # - fileOrganizer
480 # - writer
481 # - reader
482 },
483 ],
484 &quot;photoLink&quot;: &quot;A String&quot;, # A link to the profile photo, if available.
485 &quot;role&quot;: &quot;A String&quot;, # 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]486 # - owner
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]487 # - organizer
488 # - fileOrganizer
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]489 # - writer
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]490 # - reader
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]491 &quot;selfLink&quot;: &quot;A String&quot;, # A link back to this permission.
492 &quot;teamDrivePermissionDetails&quot;: [ # Deprecated - use permissionDetails instead.
493 {
494 &quot;additionalRoles&quot;: [ # Deprecated - use permissionDetails/additionalRoles instead.
495 &quot;A String&quot;,
496 ],
497 &quot;inherited&quot;: True or False, # Deprecated - use permissionDetails/inherited instead.
498 &quot;inheritedFrom&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/inheritedFrom instead.
499 &quot;role&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/role instead.
500 &quot;teamDrivePermissionType&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/permissionType instead.
501 },
502 ],
503 &quot;type&quot;: &quot;A String&quot;, # The account type. Allowed values are:
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]504 # - user
505 # - group
506 # - domain
507 # - anyone
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]508 &quot;value&quot;: &quot;A String&quot;, # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type is anyone, in which case both id and value are ignored.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]509 &quot;view&quot;: &quot;A String&quot;, # Indicates the view for this permission. Only populated for permissions that belong to a view. published is the only supported value.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]510 &quot;withLink&quot;: True or False, # Whether the link is required for this permission.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]511 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]512 &quot;version&quot;: &quot;A String&quot;, # 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.
513 &quot;videoMediaMetadata&quot;: { # Metadata about video media. This will only be present for video types.
514 &quot;durationMillis&quot;: &quot;A String&quot;, # The duration of the video in milliseconds.
515 &quot;height&quot;: 42, # The height of the video in pixels.
516 &quot;width&quot;: 42, # The width of the video in pixels.
517 },
518 &quot;webContentLink&quot;: &quot;A String&quot;, # 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.
519 &quot;webViewLink&quot;: &quot;A String&quot;, # A link only available on public folders for viewing their static web assets (HTML, CSS, JS, etc) via Google Drive&#x27;s Website Hosting.
520 &quot;writersCanShare&quot;: True or False, # Whether writers can share the document with other users. Not populated for items in shared drives.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]521}
522
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]523 convert: boolean, Whether to convert this file to the corresponding Docs Editors format.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]524 enforceSingleParent: boolean, Deprecated. Copying files into multiple folders is no longer supported. Use shortcuts instead.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]525 includePermissionsForView: string, Specifies which additional view&#x27;s permissions to include in the response. Only &#x27;published&#x27; is supported.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]526 ocr: boolean, Whether to attempt OCR on .jpg, .png, .gif, or .pdf uploads.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]527 ocrLanguage: string, If ocr is true, hints at the language to use. Valid values are BCP 47 codes.
528 pinned: boolean, Whether to pin the head revision of the new copy. A file can have a maximum of 200 pinned revisions.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]529 supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]530 supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead.
531 timedTextLanguage: string, The language of the timed text.
532 timedTextTrackName: string, The timed text track name.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]533 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.
534 Allowed values
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]535 DEFAULT - The visibility of the new file is determined by the user&#x27;s default visibility/sharing policies.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]536 PRIVATE - The new file will be visible to only the owner.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]537
538Returns:
539 An object of the form:
540
541 { # The metadata for a file.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]542 &quot;alternateLink&quot;: &quot;A String&quot;, # A link for opening the file in a relevant Google editor or viewer.
543 &quot;appDataContents&quot;: True or False, # Whether this file is in the Application Data folder.
544 &quot;canComment&quot;: True or False, # Deprecated: use capabilities/canComment.
545 &quot;canReadRevisions&quot;: True or False, # Deprecated: use capabilities/canReadRevisions.
546 &quot;capabilities&quot;: { # Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take.
547 &quot;canAddChildren&quot;: True or False, # Whether the current user can add children to this folder. This is always false when the item is not a folder.
548 &quot;canAddFolderFromAnotherDrive&quot;: True or False, # Whether the current user can add a folder from another drive (different shared drive or My Drive) to this folder. This is false when the item is not a folder. Only populated for items in shared drives.
549 &quot;canAddMyDriveParent&quot;: 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.
550 &quot;canChangeCopyRequiresWriterPermission&quot;: True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this file.
551 &quot;canChangeRestrictedDownload&quot;: True or False, # Deprecated
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700[diff] [blame^]552 &quot;canChangeSecurityUpdateEnabled&quot;: True or False, # Whether the current user can change the securityUpdateEnabled field on link share metadata.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]553 &quot;canComment&quot;: True or False, # Whether the current user can comment on this file.
554 &quot;canCopy&quot;: 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.
555 &quot;canDelete&quot;: True or False, # Whether the current user can delete this file.
556 &quot;canDeleteChildren&quot;: 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.
557 &quot;canDownload&quot;: True or False, # Whether the current user can download this file.
558 &quot;canEdit&quot;: 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.
559 &quot;canListChildren&quot;: 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.
560 &quot;canModifyContent&quot;: True or False, # Whether the current user can modify the content of this file.
561 &quot;canModifyContentRestriction&quot;: True or False, # Whether the current user can modify restrictions on content of this file.
562 &quot;canMoveChildrenOutOfDrive&quot;: 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.
563 &quot;canMoveChildrenOutOfTeamDrive&quot;: True or False, # Deprecated - use canMoveChildrenOutOfDrive instead.
564 &quot;canMoveChildrenWithinDrive&quot;: True or False, # Whether the current user can move children of this folder within this drive. This is false when the item is not a folder. Note that a request to move the child may still fail depending on the current user&#x27;s access to the child and to the destination folder.
565 &quot;canMoveChildrenWithinTeamDrive&quot;: True or False, # Deprecated - use canMoveChildrenWithinDrive instead.
566 &quot;canMoveItemIntoTeamDrive&quot;: True or False, # Deprecated - use canMoveItemOutOfDrive instead.
567 &quot;canMoveItemOutOfDrive&quot;: 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.
568 &quot;canMoveItemOutOfTeamDrive&quot;: True or False, # Deprecated - use canMoveItemOutOfDrive instead.
569 &quot;canMoveItemWithinDrive&quot;: True or False, # Whether the current user can move this item within this drive. Note that a request to change the parent of the item may still fail depending on the new parent that is being added and the parent that is being removed.
570 &quot;canMoveItemWithinTeamDrive&quot;: True or False, # Deprecated - use canMoveItemWithinDrive instead.
571 &quot;canMoveTeamDriveItem&quot;: True or False, # Deprecated - use canMoveItemWithinDrive or canMoveItemOutOfDrive instead.
572 &quot;canReadDrive&quot;: True or False, # Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives.
573 &quot;canReadRevisions&quot;: 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.
574 &quot;canReadTeamDrive&quot;: True or False, # Deprecated - use canReadDrive instead.
575 &quot;canRemoveChildren&quot;: 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.
576 &quot;canRemoveMyDriveParent&quot;: 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.
577 &quot;canRename&quot;: True or False, # Whether the current user can rename this file.
578 &quot;canShare&quot;: True or False, # Whether the current user can modify the sharing settings for this file.
579 &quot;canTrash&quot;: True or False, # Whether the current user can move this file to trash.
580 &quot;canTrashChildren&quot;: 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.
581 &quot;canUntrash&quot;: True or False, # Whether the current user can restore this file from trash.
582 },
583 &quot;contentRestrictions&quot;: [ # Restrictions for accessing the content of the file. Only populated if such a restriction exists.
584 { # A restriction for accessing the content of the file.
585 &quot;readOnly&quot;: True or False, # Whether the content of the file is read-only. If a file is read-only, a new revision of the file may not be added, comments may not be added or modified, and the title of the file may not be modified.
586 &quot;reason&quot;: &quot;A String&quot;, # Reason for why the content of the file is restricted. This is only mutable on requests that also set readOnly=true.
587 &quot;restrictingUser&quot;: { # Information about a Drive user. # The user who set the content restriction. Only populated if readOnly is true.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]588 &quot;displayName&quot;: &quot;A String&quot;, # A plain text displayable name for this user.
589 &quot;emailAddress&quot;: &quot;A String&quot;, # The email address of the user.
590 &quot;isAuthenticatedUser&quot;: True or False, # Whether this user is the same as the authenticated user for whom the request was made.
591 &quot;kind&quot;: &quot;drive#user&quot;, # This is always drive#user.
592 &quot;permissionId&quot;: &quot;A String&quot;, # The user&#x27;s ID as visible in the permissions collection.
593 &quot;picture&quot;: { # The user&#x27;s profile picture.
594 &quot;url&quot;: &quot;A String&quot;, # A URL that points to a profile picture of this user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]595 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]596 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]597 &quot;restrictionDate&quot;: &quot;A String&quot;, # The time at which the content restriction was set (formatted RFC 3339 timestamp). Only populated if readOnly is true.
598 &quot;type&quot;: &quot;A String&quot;, # The type of the content restriction. Currently the only possible value is globalContentRestriction.
599 },
600 ],
601 &quot;copyRequiresWriterPermission&quot;: True or False, # Whether the options to copy, print, or download this file, should be disabled for readers and commenters.
602 &quot;copyable&quot;: True or False, # Deprecated: use capabilities/canCopy.
603 &quot;createdDate&quot;: &quot;A String&quot;, # Create time for this file (formatted RFC 3339 timestamp).
604 &quot;defaultOpenWithLink&quot;: &quot;A String&quot;, # A link to open this file with the user&#x27;s default app for this file. Only populated when the drive.apps.readonly scope is used.
605 &quot;description&quot;: &quot;A String&quot;, # A short description of the file.
606 &quot;downloadUrl&quot;: &quot;A String&quot;, # Short lived download URL for the file. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.
607 &quot;driveId&quot;: &quot;A String&quot;, # ID of the shared drive the file resides in. Only populated for items in shared drives.
608 &quot;editable&quot;: True or False, # Deprecated: use capabilities/canEdit.
609 &quot;embedLink&quot;: &quot;A String&quot;, # A link for embedding the file.
610 &quot;etag&quot;: &quot;A String&quot;, # ETag of the file.
611 &quot;explicitlyTrashed&quot;: True or False, # Whether this file has been explicitly trashed, as opposed to recursively trashed.
612 &quot;exportLinks&quot;: { # Links for exporting Docs Editors files to specific formats.
613 &quot;a_key&quot;: &quot;A String&quot;, # A mapping from export format to URL
614 },
615 &quot;fileExtension&quot;: &quot;A String&quot;, # The final component of fullFileExtension with trailing text that does not appear to be part of the extension removed. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.
616 &quot;fileSize&quot;: &quot;A String&quot;, # The size of the file in bytes. This field is populated for files with content stored in Google Drive and for files in Docs Editors; it is not populated for shortcut files.
617 &quot;folderColorRgb&quot;: &quot;A String&quot;, # 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.
618 &quot;fullFileExtension&quot;: &quot;A String&quot;, # The full file extension; extracted from the title. May contain multiple concatenated extensions, such as &quot;tar.gz&quot;. Removing an extension from the title does not clear this field; however, changing the extension on the title does update this field. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.
619 &quot;hasAugmentedPermissions&quot;: True or False, # Whether there are permissions directly on this file. This field is only populated for items in shared drives.
620 &quot;hasThumbnail&quot;: 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.
621 &quot;headRevisionId&quot;: &quot;A String&quot;, # The ID of the file&#x27;s head revision. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.
622 &quot;iconLink&quot;: &quot;A String&quot;, # A link to the file&#x27;s icon.
623 &quot;id&quot;: &quot;A String&quot;, # The ID of the file.
624 &quot;imageMediaMetadata&quot;: { # 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.
625 &quot;aperture&quot;: 3.14, # The aperture used to create the photo (f-number).
626 &quot;cameraMake&quot;: &quot;A String&quot;, # The make of the camera used to create the photo.
627 &quot;cameraModel&quot;: &quot;A String&quot;, # The model of the camera used to create the photo.
628 &quot;colorSpace&quot;: &quot;A String&quot;, # The color space of the photo.
629 &quot;date&quot;: &quot;A String&quot;, # The date and time the photo was taken (EXIF format timestamp).
630 &quot;exposureBias&quot;: 3.14, # The exposure bias of the photo (APEX value).
631 &quot;exposureMode&quot;: &quot;A String&quot;, # The exposure mode used to create the photo.
632 &quot;exposureTime&quot;: 3.14, # The length of the exposure, in seconds.
633 &quot;flashUsed&quot;: True or False, # Whether a flash was used to create the photo.
634 &quot;focalLength&quot;: 3.14, # The focal length used to create the photo, in millimeters.
635 &quot;height&quot;: 42, # The height of the image in pixels.
636 &quot;isoSpeed&quot;: 42, # The ISO speed used to create the photo.
637 &quot;lens&quot;: &quot;A String&quot;, # The lens used to create the photo.
638 &quot;location&quot;: { # Geographic location information stored in the image.
639 &quot;altitude&quot;: 3.14, # The altitude stored in the image.
640 &quot;latitude&quot;: 3.14, # The latitude stored in the image.
641 &quot;longitude&quot;: 3.14, # The longitude stored in the image.
642 },
643 &quot;maxApertureValue&quot;: 3.14, # The smallest f-number of the lens at the focal length used to create the photo (APEX value).
644 &quot;meteringMode&quot;: &quot;A String&quot;, # The metering mode used to create the photo.
645 &quot;rotation&quot;: 42, # The number of clockwise 90 degree rotations applied from the image&#x27;s original orientation.
646 &quot;sensor&quot;: &quot;A String&quot;, # The type of sensor used to create the photo.
647 &quot;subjectDistance&quot;: 42, # The distance to the subject of the photo, in meters.
648 &quot;whiteBalance&quot;: &quot;A String&quot;, # The white balance mode used to create the photo.
649 &quot;width&quot;: 42, # The width of the image in pixels.
650 },
651 &quot;indexableText&quot;: { # Indexable text attributes for the file (can only be written)
652 &quot;text&quot;: &quot;A String&quot;, # The text to be indexed for this file.
653 },
654 &quot;isAppAuthorized&quot;: True or False, # Whether the file was created or opened by the requesting app.
655 &quot;kind&quot;: &quot;drive#file&quot;, # The type of file. This is always drive#file.
656 &quot;labels&quot;: { # A group of labels for the file.
657 &quot;hidden&quot;: True or False, # Deprecated.
658 &quot;modified&quot;: True or False, # Whether the file has been modified by this user.
659 &quot;restricted&quot;: True or False, # Deprecated - use copyRequiresWriterPermission instead.
660 &quot;starred&quot;: True or False, # Whether this file is starred by the user.
661 &quot;trashed&quot;: True or False, # Whether the file has been trashed, either explicitly or from a trashed parent folder. Only the owner may trash a file. The trashed item is excluded from all files.list responses returned for any user who does not own the file. However, all users with access to the file can see the trashed item metadata in an API response. All users with access can copy, download, export, and share the file.
662 &quot;viewed&quot;: True or False, # Whether this file has been viewed by this user.
663 },
664 &quot;lastModifyingUser&quot;: { # Information about a Drive user. # The last user to modify this file.
665 &quot;displayName&quot;: &quot;A String&quot;, # A plain text displayable name for this user.
666 &quot;emailAddress&quot;: &quot;A String&quot;, # The email address of the user.
667 &quot;isAuthenticatedUser&quot;: True or False, # Whether this user is the same as the authenticated user for whom the request was made.
668 &quot;kind&quot;: &quot;drive#user&quot;, # This is always drive#user.
669 &quot;permissionId&quot;: &quot;A String&quot;, # The user&#x27;s ID as visible in the permissions collection.
670 &quot;picture&quot;: { # The user&#x27;s profile picture.
671 &quot;url&quot;: &quot;A String&quot;, # A URL that points to a profile picture of this user.
672 },
673 },
674 &quot;lastModifyingUserName&quot;: &quot;A String&quot;, # Name of the last user to modify this file.
675 &quot;lastViewedByMeDate&quot;: &quot;A String&quot;, # Last time this file was viewed by the user (formatted RFC 3339 timestamp).
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700[diff] [blame^]676 &quot;linkShareMetadata&quot;: { # Contains details about the link URLs that clients are using to refer to this item.
677 &quot;securityUpdateEligible&quot;: True or False, # Whether the file is eligible for security update.
678 &quot;securityUpdateEnabled&quot;: True or False, # Whether the security update is enabled for this file.
679 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]680 &quot;markedViewedByMeDate&quot;: &quot;A String&quot;, # Deprecated.
681 &quot;md5Checksum&quot;: &quot;A String&quot;, # An MD5 checksum for the content of this file. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.
682 &quot;mimeType&quot;: &quot;A String&quot;, # 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&#x27;s MIME type.
683 &quot;modifiedByMeDate&quot;: &quot;A String&quot;, # 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.
684 &quot;modifiedDate&quot;: &quot;A String&quot;, # Last time this file was modified by anyone (formatted RFC 3339 timestamp). This is only mutable on update when the setModifiedDate parameter is set.
685 &quot;openWithLinks&quot;: { # A map of the id of each of the user&#x27;s apps to a link to open this file with that app. Only populated when the drive.apps.readonly scope is used.
686 &quot;a_key&quot;: &quot;A String&quot;,
687 },
688 &quot;originalFilename&quot;: &quot;A String&quot;, # 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.
689 &quot;ownedByMe&quot;: True or False, # Whether the file is owned by the current user. Not populated for items in shared drives.
690 &quot;ownerNames&quot;: [ # Name(s) of the owner(s) of this file. Not populated for items in shared drives.
691 &quot;A String&quot;,
692 ],
yoshi-code-botab1d6dc2021-05-28 00:42:02 -0700[diff] [blame]693 &quot;owners&quot;: [ # The owner of this file. Only certain legacy files may have more than one owner. This field isn&#x27;t populated for items in shared drives.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]694 { # Information about a Drive user.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]695 &quot;displayName&quot;: &quot;A String&quot;, # A plain text displayable name for this user.
696 &quot;emailAddress&quot;: &quot;A String&quot;, # The email address of the user.
697 &quot;isAuthenticatedUser&quot;: True or False, # Whether this user is the same as the authenticated user for whom the request was made.
698 &quot;kind&quot;: &quot;drive#user&quot;, # This is always drive#user.
699 &quot;permissionId&quot;: &quot;A String&quot;, # The user&#x27;s ID as visible in the permissions collection.
700 &quot;picture&quot;: { # The user&#x27;s profile picture.
701 &quot;url&quot;: &quot;A String&quot;, # A URL that points to a profile picture of this user.
702 },
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]703 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]704 ],
705 &quot;parents&quot;: [ # Collection of parent folders which contain this file.
706 # If not specified as part of an insert request, the file will be placed directly in the user&#x27;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.
707 { # A reference to a file&#x27;s parent.
708 &quot;id&quot;: &quot;A String&quot;, # The ID of the parent.
709 &quot;isRoot&quot;: True or False, # Whether or not the parent is the root folder.
710 &quot;kind&quot;: &quot;drive#parentReference&quot;, # This is always drive#parentReference.
711 &quot;parentLink&quot;: &quot;A String&quot;, # A link to the parent.
712 &quot;selfLink&quot;: &quot;A String&quot;, # A link back to this reference.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]713 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]714 ],
715 &quot;permissionIds&quot;: [ # List of permission IDs for users with access to this file.
716 &quot;A String&quot;,
717 ],
718 &quot;permissions&quot;: [ # The list of permissions for users with access to this file. Not populated for items in shared drives.
719 { # A permission for a file.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]720 &quot;additionalRoles&quot;: [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future.
721 &quot;A String&quot;,
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]722 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]723 &quot;authKey&quot;: &quot;A String&quot;, # Deprecated.
724 &quot;deleted&quot;: True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.
725 &quot;domain&quot;: &quot;A String&quot;, # 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.
726 &quot;emailAddress&quot;: &quot;A String&quot;, # 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.
727 &quot;etag&quot;: &quot;A String&quot;, # The ETag of the permission.
728 &quot;expirationDate&quot;: &quot;A String&quot;, # 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]729 # - They cannot be set on shared drive items
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]730 # - They can only be set on user and group permissions
731 # - The date must be in the future
732 # - The date cannot be more than a year in the future
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]733 # - The date can only be set on drive.permissions.update or drive.permissions.patch requests
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]734 &quot;id&quot;: &quot;A String&quot;, # 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.
735 &quot;kind&quot;: &quot;drive#permission&quot;, # This is always drive#permission.
736 &quot;name&quot;: &quot;A String&quot;, # The name for this permission.
737 &quot;permissionDetails&quot;: [ # 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.
738 {
739 &quot;additionalRoles&quot;: [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future.
740 &quot;A String&quot;,
741 ],
742 &quot;inherited&quot;: True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field.
743 &quot;inheritedFrom&quot;: &quot;A String&quot;, # The ID of the item from which this permission is inherited. This is an output-only field.
744 &quot;permissionType&quot;: &quot;A String&quot;, # The permission type for this user. While new values may be added in future, the following are currently possible:
745 # - file
746 # - member
747 &quot;role&quot;: &quot;A String&quot;, # The primary role for this user. While new values may be added in the future, the following are currently possible:
748 # - organizer
749 # - fileOrganizer
750 # - writer
751 # - reader
752 },
753 ],
754 &quot;photoLink&quot;: &quot;A String&quot;, # A link to the profile photo, if available.
755 &quot;role&quot;: &quot;A String&quot;, # 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]756 # - owner
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]757 # - organizer
758 # - fileOrganizer
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]759 # - writer
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]760 # - reader
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]761 &quot;selfLink&quot;: &quot;A String&quot;, # A link back to this permission.
762 &quot;teamDrivePermissionDetails&quot;: [ # Deprecated - use permissionDetails instead.
763 {
764 &quot;additionalRoles&quot;: [ # Deprecated - use permissionDetails/additionalRoles instead.
765 &quot;A String&quot;,
766 ],
767 &quot;inherited&quot;: True or False, # Deprecated - use permissionDetails/inherited instead.
768 &quot;inheritedFrom&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/inheritedFrom instead.
769 &quot;role&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/role instead.
770 &quot;teamDrivePermissionType&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/permissionType instead.
771 },
772 ],
773 &quot;type&quot;: &quot;A String&quot;, # The account type. Allowed values are:
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]774 # - user
775 # - group
776 # - domain
777 # - anyone
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]778 &quot;value&quot;: &quot;A String&quot;, # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type is anyone, in which case both id and value are ignored.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]779 &quot;view&quot;: &quot;A String&quot;, # Indicates the view for this permission. Only populated for permissions that belong to a view. published is the only supported value.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]780 &quot;withLink&quot;: True or False, # Whether the link is required for this permission.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]781 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]782 ],
783 &quot;properties&quot;: [ # The list of properties.
784 { # A key-value pair attached to a file that is either public or private to an application.
785 # The following limits apply to file properties:
786 # - Maximum of 100 properties total per file
787 # - Maximum of 30 private properties per app
788 # - Maximum of 30 public properties
789 # - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property.
790 &quot;etag&quot;: &quot;A String&quot;, # ETag of the property.
791 &quot;key&quot;: &quot;A String&quot;, # The key of this property.
792 &quot;kind&quot;: &quot;drive#property&quot;, # This is always drive#property.
793 &quot;selfLink&quot;: &quot;A String&quot;, # The link back to this property.
794 &quot;value&quot;: &quot;A String&quot;, # The value of this property.
yoshi-code-bot69706592021-03-03 03:54:02 -0800[diff] [blame]795 &quot;visibility&quot;: &quot;A String&quot;, # The visibility of this property. Allowed values are PRIVATE and PUBLIC. (Default: PRIVATE). Private properties can only be retrieved using an authenticated request. An authenticated request uses an access token obtained with a OAuth 2 client ID. You cannot use an API key to retrieve private properties.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]796 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]797 ],
798 &quot;quotaBytesUsed&quot;: &quot;A String&quot;, # The number of quota bytes used by this file.
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700[diff] [blame^]799 &quot;resourceKey&quot;: &quot;A String&quot;, # A key needed to access the item via a shared link.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]800 &quot;selfLink&quot;: &quot;A String&quot;, # A link back to this file.
801 &quot;shareable&quot;: True or False, # Deprecated: use capabilities/canShare.
802 &quot;shared&quot;: True or False, # Whether the file has been shared. Not populated for items in shared drives.
803 &quot;sharedWithMeDate&quot;: &quot;A String&quot;, # Time at which this file was shared with the user (formatted RFC 3339 timestamp).
804 &quot;sharingUser&quot;: { # Information about a Drive user. # User that shared the item with the current user, if available.
805 &quot;displayName&quot;: &quot;A String&quot;, # A plain text displayable name for this user.
806 &quot;emailAddress&quot;: &quot;A String&quot;, # The email address of the user.
807 &quot;isAuthenticatedUser&quot;: True or False, # Whether this user is the same as the authenticated user for whom the request was made.
808 &quot;kind&quot;: &quot;drive#user&quot;, # This is always drive#user.
809 &quot;permissionId&quot;: &quot;A String&quot;, # The user&#x27;s ID as visible in the permissions collection.
810 &quot;picture&quot;: { # The user&#x27;s profile picture.
811 &quot;url&quot;: &quot;A String&quot;, # A URL that points to a profile picture of this user.
812 },
813 },
814 &quot;shortcutDetails&quot;: { # Shortcut file details. Only populated for shortcut files, which have the mimeType field set to application/vnd.google-apps.shortcut.
815 &quot;targetId&quot;: &quot;A String&quot;, # The ID of the file that this shortcut points to.
816 &quot;targetMimeType&quot;: &quot;A String&quot;, # The MIME type of the file that this shortcut points to. The value of this field is a snapshot of the target&#x27;s MIME type, captured when the shortcut is created.
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700[diff] [blame^]817 &quot;targetResourceKey&quot;: &quot;A String&quot;, # The ResourceKey for the target file.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]818 },
819 &quot;spaces&quot;: [ # The list of spaces which contain the file. Supported values are &#x27;drive&#x27;, &#x27;appDataFolder&#x27; and &#x27;photos&#x27;.
820 &quot;A String&quot;,
821 ],
822 &quot;teamDriveId&quot;: &quot;A String&quot;, # Deprecated - use driveId instead.
823 &quot;thumbnail&quot;: { # A thumbnail for the file. This will only be used if a standard thumbnail cannot be generated.
824 &quot;image&quot;: &quot;A String&quot;, # The URL-safe Base64 encoded bytes of the thumbnail image. It should conform to RFC 4648 section 5.
825 &quot;mimeType&quot;: &quot;A String&quot;, # The MIME type of the thumbnail.
826 },
827 &quot;thumbnailLink&quot;: &quot;A String&quot;, # A short-lived link to the file&#x27;s thumbnail. Typically lasts on the order of hours. Only populated when the requesting app can access the file&#x27;s content. If the file isn&#x27;t shared publicly, the URL returned in Files.thumbnailLink must be fetched using a credentialed request.
828 &quot;thumbnailVersion&quot;: &quot;A String&quot;, # The thumbnail version for use in thumbnail cache invalidation.
829 &quot;title&quot;: &quot;A String&quot;, # 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.
830 &quot;trashedDate&quot;: &quot;A String&quot;, # The time that the item was trashed (formatted RFC 3339 timestamp). Only populated for items in shared drives.
831 &quot;trashingUser&quot;: { # Information about a Drive user. # If the file has been explicitly trashed, the user who trashed it. Only populated for items in shared drives.
832 &quot;displayName&quot;: &quot;A String&quot;, # A plain text displayable name for this user.
833 &quot;emailAddress&quot;: &quot;A String&quot;, # The email address of the user.
834 &quot;isAuthenticatedUser&quot;: True or False, # Whether this user is the same as the authenticated user for whom the request was made.
835 &quot;kind&quot;: &quot;drive#user&quot;, # This is always drive#user.
836 &quot;permissionId&quot;: &quot;A String&quot;, # The user&#x27;s ID as visible in the permissions collection.
837 &quot;picture&quot;: { # The user&#x27;s profile picture.
838 &quot;url&quot;: &quot;A String&quot;, # A URL that points to a profile picture of this user.
839 },
840 },
841 &quot;userPermission&quot;: { # A permission for a file. # The permissions for the authenticated user on this file.
842 &quot;additionalRoles&quot;: [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future.
843 &quot;A String&quot;,
844 ],
845 &quot;authKey&quot;: &quot;A String&quot;, # Deprecated.
846 &quot;deleted&quot;: True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.
847 &quot;domain&quot;: &quot;A String&quot;, # 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.
848 &quot;emailAddress&quot;: &quot;A String&quot;, # 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.
849 &quot;etag&quot;: &quot;A String&quot;, # The ETag of the permission.
850 &quot;expirationDate&quot;: &quot;A String&quot;, # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions:
851 # - They cannot be set on shared drive items
852 # - They can only be set on user and group permissions
853 # - The date must be in the future
854 # - The date cannot be more than a year in the future
855 # - The date can only be set on drive.permissions.update or drive.permissions.patch requests
856 &quot;id&quot;: &quot;A String&quot;, # 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.
857 &quot;kind&quot;: &quot;drive#permission&quot;, # This is always drive#permission.
858 &quot;name&quot;: &quot;A String&quot;, # The name for this permission.
859 &quot;permissionDetails&quot;: [ # 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.
860 {
861 &quot;additionalRoles&quot;: [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future.
862 &quot;A String&quot;,
863 ],
864 &quot;inherited&quot;: True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field.
865 &quot;inheritedFrom&quot;: &quot;A String&quot;, # The ID of the item from which this permission is inherited. This is an output-only field.
866 &quot;permissionType&quot;: &quot;A String&quot;, # The permission type for this user. While new values may be added in future, the following are currently possible:
867 # - file
868 # - member
869 &quot;role&quot;: &quot;A String&quot;, # The primary role for this user. While new values may be added in the future, the following are currently possible:
870 # - organizer
871 # - fileOrganizer
872 # - writer
873 # - reader
874 },
875 ],
876 &quot;photoLink&quot;: &quot;A String&quot;, # A link to the profile photo, if available.
877 &quot;role&quot;: &quot;A String&quot;, # The primary role for this user. While new values may be supported in the future, the following are currently allowed:
878 # - owner
879 # - organizer
880 # - fileOrganizer
881 # - writer
882 # - reader
883 &quot;selfLink&quot;: &quot;A String&quot;, # A link back to this permission.
884 &quot;teamDrivePermissionDetails&quot;: [ # Deprecated - use permissionDetails instead.
885 {
886 &quot;additionalRoles&quot;: [ # Deprecated - use permissionDetails/additionalRoles instead.
887 &quot;A String&quot;,
888 ],
889 &quot;inherited&quot;: True or False, # Deprecated - use permissionDetails/inherited instead.
890 &quot;inheritedFrom&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/inheritedFrom instead.
891 &quot;role&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/role instead.
892 &quot;teamDrivePermissionType&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/permissionType instead.
893 },
894 ],
895 &quot;type&quot;: &quot;A String&quot;, # The account type. Allowed values are:
896 # - user
897 # - group
898 # - domain
899 # - anyone
900 &quot;value&quot;: &quot;A String&quot;, # 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.
901 &quot;view&quot;: &quot;A String&quot;, # Indicates the view for this permission. Only populated for permissions that belong to a view. published is the only supported value.
902 &quot;withLink&quot;: True or False, # Whether the link is required for this permission.
903 },
904 &quot;version&quot;: &quot;A String&quot;, # 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.
905 &quot;videoMediaMetadata&quot;: { # Metadata about video media. This will only be present for video types.
906 &quot;durationMillis&quot;: &quot;A String&quot;, # The duration of the video in milliseconds.
907 &quot;height&quot;: 42, # The height of the video in pixels.
908 &quot;width&quot;: 42, # The width of the video in pixels.
909 },
910 &quot;webContentLink&quot;: &quot;A String&quot;, # 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.
911 &quot;webViewLink&quot;: &quot;A String&quot;, # A link only available on public folders for viewing their static web assets (HTML, CSS, JS, etc) via Google Drive&#x27;s Website Hosting.
912 &quot;writersCanShare&quot;: True or False, # Whether writers can share the document with other users. Not populated for items in shared drives.
913}</pre>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]914</div>
915
916<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]917 <code class="details" id="delete">delete(fileId, enforceSingleParent=None, supportsAllDrives=None, supportsTeamDrives=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]918 <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]919
920Args:
921 fileId: string, The ID of the file to delete. (required)
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]922 enforceSingleParent: boolean, Deprecated. If an item is not in a shared drive and its last parent is deleted but the item itself is not, the item will be placed under its owner&#x27;s root.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]923 supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]924 supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]925</pre>
926</div>
927
928<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]929 <code class="details" id="emptyTrash">emptyTrash(enforceSingleParent=None)</code>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]930 <pre>Permanently deletes all of the user&#x27;s trashed files.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]931
932Args:
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]933 enforceSingleParent: boolean, Deprecated. If an item is not in a shared drive and its last parent is deleted but the item itself is not, the item will be placed under its owner&#x27;s root.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]934</pre>
935</div>
936
937<div class="method">
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]938 <code class="details" id="export">export(fileId, mimeType)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]939 <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]940
941Args:
942 fileId: string, The ID of the file. (required)
943 mimeType: string, The MIME type of the format requested for this export. (required)
944</pre>
945</div>
946
947<div class="method">
948 <code class="details" id="export_media">export_media(fileId, mimeType)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]949 <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]950
951Args:
952 fileId: string, The ID of the file. (required)
953 mimeType: string, The MIME type of the format requested for this export. (required)
954</pre>
955</div>
956
957<div class="method">
yoshi-code-botc2cd3262021-05-16 02:16:04 -0700[diff] [blame]958 <code class="details" id="generateIds">generateIds(maxResults=None, space=None, type=None)</code>
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]959 <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]960
961Args:
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]962 maxResults: integer, Maximum number of IDs to return.
yoshi-code-botc2cd3262021-05-16 02:16:04 -0700[diff] [blame]963 space: string, The space in which the IDs can be used to create new files. Supported values are &#x27;drive&#x27; and &#x27;appDataFolder&#x27;. (Default: &#x27;drive&#x27;)
964 type: string, The type of items which the IDs can be used for. Supported values are &#x27;files&#x27; and &#x27;shortcuts&#x27;. Note that &#x27;shortcuts&#x27; are only supported in the drive &#x27;space&#x27;. (Default: &#x27;files&#x27;)
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]965
966Returns:
967 An object of the form:
968
969 { # A list of generated IDs which can be provided in insert requests
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]970 &quot;ids&quot;: [ # The IDs generated for the requesting user in the specified space.
971 &quot;A String&quot;,
972 ],
973 &quot;kind&quot;: &quot;drive#generatedIds&quot;, # This is always drive#generatedIds
974 &quot;space&quot;: &quot;A String&quot;, # The type of file that can be created with these IDs.
975}</pre>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]976</div>
977
978<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]979 <code class="details" id="get">get(fileId, acknowledgeAbuse=None, includePermissionsForView=None, projection=None, revisionId=None, supportsAllDrives=None, supportsTeamDrives=None, updateViewedDate=None)</code>
yoshi-code-bot3dd15272021-04-21 15:07:48 -0700[diff] [blame]980 <pre>Gets a file&#x27;s metadata or content by ID.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]981
982Args:
983 fileId: string, The ID for the file in question. (required)
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]984 acknowledgeAbuse: boolean, Whether the user is acknowledging the risk of downloading known malware or other abusive files.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]985 includePermissionsForView: string, Specifies which additional view&#x27;s permissions to include in the response. Only &#x27;published&#x27; is supported.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]986 projection: string, This parameter is deprecated and has no function.
987 Allowed values
988 BASIC - Deprecated
989 FULL - Deprecated
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]990 revisionId: string, Specifies the Revision ID that should be downloaded. Ignored unless alt=media is specified.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]991 supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]992 supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]993 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]994
995Returns:
996 An object of the form:
997
998 { # The metadata for a file.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]999 &quot;alternateLink&quot;: &quot;A String&quot;, # A link for opening the file in a relevant Google editor or viewer.
1000 &quot;appDataContents&quot;: True or False, # Whether this file is in the Application Data folder.
1001 &quot;canComment&quot;: True or False, # Deprecated: use capabilities/canComment.
1002 &quot;canReadRevisions&quot;: True or False, # Deprecated: use capabilities/canReadRevisions.
1003 &quot;capabilities&quot;: { # Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take.
1004 &quot;canAddChildren&quot;: True or False, # Whether the current user can add children to this folder. This is always false when the item is not a folder.
1005 &quot;canAddFolderFromAnotherDrive&quot;: True or False, # Whether the current user can add a folder from another drive (different shared drive or My Drive) to this folder. This is false when the item is not a folder. Only populated for items in shared drives.
1006 &quot;canAddMyDriveParent&quot;: 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.
1007 &quot;canChangeCopyRequiresWriterPermission&quot;: True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this file.
1008 &quot;canChangeRestrictedDownload&quot;: True or False, # Deprecated
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700[diff] [blame^]1009 &quot;canChangeSecurityUpdateEnabled&quot;: True or False, # Whether the current user can change the securityUpdateEnabled field on link share metadata.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]1010 &quot;canComment&quot;: True or False, # Whether the current user can comment on this file.
1011 &quot;canCopy&quot;: 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.
1012 &quot;canDelete&quot;: True or False, # Whether the current user can delete this file.
1013 &quot;canDeleteChildren&quot;: 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.
1014 &quot;canDownload&quot;: True or False, # Whether the current user can download this file.
1015 &quot;canEdit&quot;: 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.
1016 &quot;canListChildren&quot;: 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.
1017 &quot;canModifyContent&quot;: True or False, # Whether the current user can modify the content of this file.
1018 &quot;canModifyContentRestriction&quot;: True or False, # Whether the current user can modify restrictions on content of this file.
1019 &quot;canMoveChildrenOutOfDrive&quot;: 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.
1020 &quot;canMoveChildrenOutOfTeamDrive&quot;: True or False, # Deprecated - use canMoveChildrenOutOfDrive instead.
1021 &quot;canMoveChildrenWithinDrive&quot;: True or False, # Whether the current user can move children of this folder within this drive. This is false when the item is not a folder. Note that a request to move the child may still fail depending on the current user&#x27;s access to the child and to the destination folder.
1022 &quot;canMoveChildrenWithinTeamDrive&quot;: True or False, # Deprecated - use canMoveChildrenWithinDrive instead.
1023 &quot;canMoveItemIntoTeamDrive&quot;: True or False, # Deprecated - use canMoveItemOutOfDrive instead.
1024 &quot;canMoveItemOutOfDrive&quot;: 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.
1025 &quot;canMoveItemOutOfTeamDrive&quot;: True or False, # Deprecated - use canMoveItemOutOfDrive instead.
1026 &quot;canMoveItemWithinDrive&quot;: True or False, # Whether the current user can move this item within this drive. Note that a request to change the parent of the item may still fail depending on the new parent that is being added and the parent that is being removed.
1027 &quot;canMoveItemWithinTeamDrive&quot;: True or False, # Deprecated - use canMoveItemWithinDrive instead.
1028 &quot;canMoveTeamDriveItem&quot;: True or False, # Deprecated - use canMoveItemWithinDrive or canMoveItemOutOfDrive instead.
1029 &quot;canReadDrive&quot;: True or False, # Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives.
1030 &quot;canReadRevisions&quot;: 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.
1031 &quot;canReadTeamDrive&quot;: True or False, # Deprecated - use canReadDrive instead.
1032 &quot;canRemoveChildren&quot;: 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.
1033 &quot;canRemoveMyDriveParent&quot;: 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.
1034 &quot;canRename&quot;: True or False, # Whether the current user can rename this file.
1035 &quot;canShare&quot;: True or False, # Whether the current user can modify the sharing settings for this file.
1036 &quot;canTrash&quot;: True or False, # Whether the current user can move this file to trash.
1037 &quot;canTrashChildren&quot;: 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.
1038 &quot;canUntrash&quot;: True or False, # Whether the current user can restore this file from trash.
1039 },
1040 &quot;contentRestrictions&quot;: [ # Restrictions for accessing the content of the file. Only populated if such a restriction exists.
1041 { # A restriction for accessing the content of the file.
1042 &quot;readOnly&quot;: True or False, # Whether the content of the file is read-only. If a file is read-only, a new revision of the file may not be added, comments may not be added or modified, and the title of the file may not be modified.
1043 &quot;reason&quot;: &quot;A String&quot;, # Reason for why the content of the file is restricted. This is only mutable on requests that also set readOnly=true.
1044 &quot;restrictingUser&quot;: { # Information about a Drive user. # The user who set the content restriction. Only populated if readOnly is true.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1045 &quot;displayName&quot;: &quot;A String&quot;, # A plain text displayable name for this user.
1046 &quot;emailAddress&quot;: &quot;A String&quot;, # The email address of the user.
1047 &quot;isAuthenticatedUser&quot;: True or False, # Whether this user is the same as the authenticated user for whom the request was made.
1048 &quot;kind&quot;: &quot;drive#user&quot;, # This is always drive#user.
1049 &quot;permissionId&quot;: &quot;A String&quot;, # The user&#x27;s ID as visible in the permissions collection.
1050 &quot;picture&quot;: { # The user&#x27;s profile picture.
1051 &quot;url&quot;: &quot;A String&quot;, # A URL that points to a profile picture of this user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1052 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1053 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]1054 &quot;restrictionDate&quot;: &quot;A String&quot;, # The time at which the content restriction was set (formatted RFC 3339 timestamp). Only populated if readOnly is true.
1055 &quot;type&quot;: &quot;A String&quot;, # The type of the content restriction. Currently the only possible value is globalContentRestriction.
1056 },
1057 ],
1058 &quot;copyRequiresWriterPermission&quot;: True or False, # Whether the options to copy, print, or download this file, should be disabled for readers and commenters.
1059 &quot;copyable&quot;: True or False, # Deprecated: use capabilities/canCopy.
1060 &quot;createdDate&quot;: &quot;A String&quot;, # Create time for this file (formatted RFC 3339 timestamp).
1061 &quot;defaultOpenWithLink&quot;: &quot;A String&quot;, # A link to open this file with the user&#x27;s default app for this file. Only populated when the drive.apps.readonly scope is used.
1062 &quot;description&quot;: &quot;A String&quot;, # A short description of the file.
1063 &quot;downloadUrl&quot;: &quot;A String&quot;, # Short lived download URL for the file. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.
1064 &quot;driveId&quot;: &quot;A String&quot;, # ID of the shared drive the file resides in. Only populated for items in shared drives.
1065 &quot;editable&quot;: True or False, # Deprecated: use capabilities/canEdit.
1066 &quot;embedLink&quot;: &quot;A String&quot;, # A link for embedding the file.
1067 &quot;etag&quot;: &quot;A String&quot;, # ETag of the file.
1068 &quot;explicitlyTrashed&quot;: True or False, # Whether this file has been explicitly trashed, as opposed to recursively trashed.
1069 &quot;exportLinks&quot;: { # Links for exporting Docs Editors files to specific formats.
1070 &quot;a_key&quot;: &quot;A String&quot;, # A mapping from export format to URL
1071 },
1072 &quot;fileExtension&quot;: &quot;A String&quot;, # The final component of fullFileExtension with trailing text that does not appear to be part of the extension removed. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.
1073 &quot;fileSize&quot;: &quot;A String&quot;, # The size of the file in bytes. This field is populated for files with content stored in Google Drive and for files in Docs Editors; it is not populated for shortcut files.
1074 &quot;folderColorRgb&quot;: &quot;A String&quot;, # 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.
1075 &quot;fullFileExtension&quot;: &quot;A String&quot;, # The full file extension; extracted from the title. May contain multiple concatenated extensions, such as &quot;tar.gz&quot;. Removing an extension from the title does not clear this field; however, changing the extension on the title does update this field. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.
1076 &quot;hasAugmentedPermissions&quot;: True or False, # Whether there are permissions directly on this file. This field is only populated for items in shared drives.
1077 &quot;hasThumbnail&quot;: 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.
1078 &quot;headRevisionId&quot;: &quot;A String&quot;, # The ID of the file&#x27;s head revision. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.
1079 &quot;iconLink&quot;: &quot;A String&quot;, # A link to the file&#x27;s icon.
1080 &quot;id&quot;: &quot;A String&quot;, # The ID of the file.
1081 &quot;imageMediaMetadata&quot;: { # 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.
1082 &quot;aperture&quot;: 3.14, # The aperture used to create the photo (f-number).
1083 &quot;cameraMake&quot;: &quot;A String&quot;, # The make of the camera used to create the photo.
1084 &quot;cameraModel&quot;: &quot;A String&quot;, # The model of the camera used to create the photo.
1085 &quot;colorSpace&quot;: &quot;A String&quot;, # The color space of the photo.
1086 &quot;date&quot;: &quot;A String&quot;, # The date and time the photo was taken (EXIF format timestamp).
1087 &quot;exposureBias&quot;: 3.14, # The exposure bias of the photo (APEX value).
1088 &quot;exposureMode&quot;: &quot;A String&quot;, # The exposure mode used to create the photo.
1089 &quot;exposureTime&quot;: 3.14, # The length of the exposure, in seconds.
1090 &quot;flashUsed&quot;: True or False, # Whether a flash was used to create the photo.
1091 &quot;focalLength&quot;: 3.14, # The focal length used to create the photo, in millimeters.
1092 &quot;height&quot;: 42, # The height of the image in pixels.
1093 &quot;isoSpeed&quot;: 42, # The ISO speed used to create the photo.
1094 &quot;lens&quot;: &quot;A String&quot;, # The lens used to create the photo.
1095 &quot;location&quot;: { # Geographic location information stored in the image.
1096 &quot;altitude&quot;: 3.14, # The altitude stored in the image.
1097 &quot;latitude&quot;: 3.14, # The latitude stored in the image.
1098 &quot;longitude&quot;: 3.14, # The longitude stored in the image.
1099 },
1100 &quot;maxApertureValue&quot;: 3.14, # The smallest f-number of the lens at the focal length used to create the photo (APEX value).
1101 &quot;meteringMode&quot;: &quot;A String&quot;, # The metering mode used to create the photo.
1102 &quot;rotation&quot;: 42, # The number of clockwise 90 degree rotations applied from the image&#x27;s original orientation.
1103 &quot;sensor&quot;: &quot;A String&quot;, # The type of sensor used to create the photo.
1104 &quot;subjectDistance&quot;: 42, # The distance to the subject of the photo, in meters.
1105 &quot;whiteBalance&quot;: &quot;A String&quot;, # The white balance mode used to create the photo.
1106 &quot;width&quot;: 42, # The width of the image in pixels.
1107 },
1108 &quot;indexableText&quot;: { # Indexable text attributes for the file (can only be written)
1109 &quot;text&quot;: &quot;A String&quot;, # The text to be indexed for this file.
1110 },
1111 &quot;isAppAuthorized&quot;: True or False, # Whether the file was created or opened by the requesting app.
1112 &quot;kind&quot;: &quot;drive#file&quot;, # The type of file. This is always drive#file.
1113 &quot;labels&quot;: { # A group of labels for the file.
1114 &quot;hidden&quot;: True or False, # Deprecated.
1115 &quot;modified&quot;: True or False, # Whether the file has been modified by this user.
1116 &quot;restricted&quot;: True or False, # Deprecated - use copyRequiresWriterPermission instead.
1117 &quot;starred&quot;: True or False, # Whether this file is starred by the user.
1118 &quot;trashed&quot;: True or False, # Whether the file has been trashed, either explicitly or from a trashed parent folder. Only the owner may trash a file. The trashed item is excluded from all files.list responses returned for any user who does not own the file. However, all users with access to the file can see the trashed item metadata in an API response. All users with access can copy, download, export, and share the file.
1119 &quot;viewed&quot;: True or False, # Whether this file has been viewed by this user.
1120 },
1121 &quot;lastModifyingUser&quot;: { # Information about a Drive user. # The last user to modify this file.
1122 &quot;displayName&quot;: &quot;A String&quot;, # A plain text displayable name for this user.
1123 &quot;emailAddress&quot;: &quot;A String&quot;, # The email address of the user.
1124 &quot;isAuthenticatedUser&quot;: True or False, # Whether this user is the same as the authenticated user for whom the request was made.
1125 &quot;kind&quot;: &quot;drive#user&quot;, # This is always drive#user.
1126 &quot;permissionId&quot;: &quot;A String&quot;, # The user&#x27;s ID as visible in the permissions collection.
1127 &quot;picture&quot;: { # The user&#x27;s profile picture.
1128 &quot;url&quot;: &quot;A String&quot;, # A URL that points to a profile picture of this user.
1129 },
1130 },
1131 &quot;lastModifyingUserName&quot;: &quot;A String&quot;, # Name of the last user to modify this file.
1132 &quot;lastViewedByMeDate&quot;: &quot;A String&quot;, # Last time this file was viewed by the user (formatted RFC 3339 timestamp).
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700[diff] [blame^]1133 &quot;linkShareMetadata&quot;: { # Contains details about the link URLs that clients are using to refer to this item.
1134 &quot;securityUpdateEligible&quot;: True or False, # Whether the file is eligible for security update.
1135 &quot;securityUpdateEnabled&quot;: True or False, # Whether the security update is enabled for this file.
1136 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]1137 &quot;markedViewedByMeDate&quot;: &quot;A String&quot;, # Deprecated.
1138 &quot;md5Checksum&quot;: &quot;A String&quot;, # An MD5 checksum for the content of this file. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.
1139 &quot;mimeType&quot;: &quot;A String&quot;, # 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&#x27;s MIME type.
1140 &quot;modifiedByMeDate&quot;: &quot;A String&quot;, # 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.
1141 &quot;modifiedDate&quot;: &quot;A String&quot;, # Last time this file was modified by anyone (formatted RFC 3339 timestamp). This is only mutable on update when the setModifiedDate parameter is set.
1142 &quot;openWithLinks&quot;: { # A map of the id of each of the user&#x27;s apps to a link to open this file with that app. Only populated when the drive.apps.readonly scope is used.
1143 &quot;a_key&quot;: &quot;A String&quot;,
1144 },
1145 &quot;originalFilename&quot;: &quot;A String&quot;, # 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.
1146 &quot;ownedByMe&quot;: True or False, # Whether the file is owned by the current user. Not populated for items in shared drives.
1147 &quot;ownerNames&quot;: [ # Name(s) of the owner(s) of this file. Not populated for items in shared drives.
1148 &quot;A String&quot;,
1149 ],
yoshi-code-botab1d6dc2021-05-28 00:42:02 -0700[diff] [blame]1150 &quot;owners&quot;: [ # The owner of this file. Only certain legacy files may have more than one owner. This field isn&#x27;t populated for items in shared drives.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]1151 { # Information about a Drive user.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1152 &quot;displayName&quot;: &quot;A String&quot;, # A plain text displayable name for this user.
1153 &quot;emailAddress&quot;: &quot;A String&quot;, # The email address of the user.
1154 &quot;isAuthenticatedUser&quot;: True or False, # Whether this user is the same as the authenticated user for whom the request was made.
1155 &quot;kind&quot;: &quot;drive#user&quot;, # This is always drive#user.
1156 &quot;permissionId&quot;: &quot;A String&quot;, # The user&#x27;s ID as visible in the permissions collection.
1157 &quot;picture&quot;: { # The user&#x27;s profile picture.
1158 &quot;url&quot;: &quot;A String&quot;, # A URL that points to a profile picture of this user.
1159 },
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]1160 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]1161 ],
1162 &quot;parents&quot;: [ # Collection of parent folders which contain this file.
1163 # If not specified as part of an insert request, the file will be placed directly in the user&#x27;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.
1164 { # A reference to a file&#x27;s parent.
1165 &quot;id&quot;: &quot;A String&quot;, # The ID of the parent.
1166 &quot;isRoot&quot;: True or False, # Whether or not the parent is the root folder.
1167 &quot;kind&quot;: &quot;drive#parentReference&quot;, # This is always drive#parentReference.
1168 &quot;parentLink&quot;: &quot;A String&quot;, # A link to the parent.
1169 &quot;selfLink&quot;: &quot;A String&quot;, # A link back to this reference.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1170 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]1171 ],
1172 &quot;permissionIds&quot;: [ # List of permission IDs for users with access to this file.
1173 &quot;A String&quot;,
1174 ],
1175 &quot;permissions&quot;: [ # The list of permissions for users with access to this file. Not populated for items in shared drives.
1176 { # A permission for a file.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1177 &quot;additionalRoles&quot;: [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future.
1178 &quot;A String&quot;,
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1179 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1180 &quot;authKey&quot;: &quot;A String&quot;, # Deprecated.
1181 &quot;deleted&quot;: True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.
1182 &quot;domain&quot;: &quot;A String&quot;, # 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.
1183 &quot;emailAddress&quot;: &quot;A String&quot;, # 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.
1184 &quot;etag&quot;: &quot;A String&quot;, # The ETag of the permission.
1185 &quot;expirationDate&quot;: &quot;A String&quot;, # 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]1186 # - They cannot be set on shared drive items
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1187 # - They can only be set on user and group permissions
1188 # - The date must be in the future
1189 # - The date cannot be more than a year in the future
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1190 # - The date can only be set on drive.permissions.update or drive.permissions.patch requests
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1191 &quot;id&quot;: &quot;A String&quot;, # 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.
1192 &quot;kind&quot;: &quot;drive#permission&quot;, # This is always drive#permission.
1193 &quot;name&quot;: &quot;A String&quot;, # The name for this permission.
1194 &quot;permissionDetails&quot;: [ # 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.
1195 {
1196 &quot;additionalRoles&quot;: [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future.
1197 &quot;A String&quot;,
1198 ],
1199 &quot;inherited&quot;: True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field.
1200 &quot;inheritedFrom&quot;: &quot;A String&quot;, # The ID of the item from which this permission is inherited. This is an output-only field.
1201 &quot;permissionType&quot;: &quot;A String&quot;, # The permission type for this user. While new values may be added in future, the following are currently possible:
1202 # - file
1203 # - member
1204 &quot;role&quot;: &quot;A String&quot;, # The primary role for this user. While new values may be added in the future, the following are currently possible:
1205 # - organizer
1206 # - fileOrganizer
1207 # - writer
1208 # - reader
1209 },
1210 ],
1211 &quot;photoLink&quot;: &quot;A String&quot;, # A link to the profile photo, if available.
1212 &quot;role&quot;: &quot;A String&quot;, # 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]1213 # - owner
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1214 # - organizer
1215 # - fileOrganizer
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1216 # - writer
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1217 # - reader
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1218 &quot;selfLink&quot;: &quot;A String&quot;, # A link back to this permission.
1219 &quot;teamDrivePermissionDetails&quot;: [ # Deprecated - use permissionDetails instead.
1220 {
1221 &quot;additionalRoles&quot;: [ # Deprecated - use permissionDetails/additionalRoles instead.
1222 &quot;A String&quot;,
1223 ],
1224 &quot;inherited&quot;: True or False, # Deprecated - use permissionDetails/inherited instead.
1225 &quot;inheritedFrom&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/inheritedFrom instead.
1226 &quot;role&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/role instead.
1227 &quot;teamDrivePermissionType&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/permissionType instead.
1228 },
1229 ],
1230 &quot;type&quot;: &quot;A String&quot;, # The account type. Allowed values are:
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1231 # - user
1232 # - group
1233 # - domain
1234 # - anyone
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1235 &quot;value&quot;: &quot;A String&quot;, # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type is anyone, in which case both id and value are ignored.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]1236 &quot;view&quot;: &quot;A String&quot;, # Indicates the view for this permission. Only populated for permissions that belong to a view. published is the only supported value.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1237 &quot;withLink&quot;: True or False, # Whether the link is required for this permission.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1238 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]1239 ],
1240 &quot;properties&quot;: [ # The list of properties.
1241 { # A key-value pair attached to a file that is either public or private to an application.
1242 # The following limits apply to file properties:
1243 # - Maximum of 100 properties total per file
1244 # - Maximum of 30 private properties per app
1245 # - Maximum of 30 public properties
1246 # - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property.
1247 &quot;etag&quot;: &quot;A String&quot;, # ETag of the property.
1248 &quot;key&quot;: &quot;A String&quot;, # The key of this property.
1249 &quot;kind&quot;: &quot;drive#property&quot;, # This is always drive#property.
1250 &quot;selfLink&quot;: &quot;A String&quot;, # The link back to this property.
1251 &quot;value&quot;: &quot;A String&quot;, # The value of this property.
yoshi-code-bot69706592021-03-03 03:54:02 -0800[diff] [blame]1252 &quot;visibility&quot;: &quot;A String&quot;, # The visibility of this property. Allowed values are PRIVATE and PUBLIC. (Default: PRIVATE). Private properties can only be retrieved using an authenticated request. An authenticated request uses an access token obtained with a OAuth 2 client ID. You cannot use an API key to retrieve private properties.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1253 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]1254 ],
1255 &quot;quotaBytesUsed&quot;: &quot;A String&quot;, # The number of quota bytes used by this file.
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700[diff] [blame^]1256 &quot;resourceKey&quot;: &quot;A String&quot;, # A key needed to access the item via a shared link.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]1257 &quot;selfLink&quot;: &quot;A String&quot;, # A link back to this file.
1258 &quot;shareable&quot;: True or False, # Deprecated: use capabilities/canShare.
1259 &quot;shared&quot;: True or False, # Whether the file has been shared. Not populated for items in shared drives.
1260 &quot;sharedWithMeDate&quot;: &quot;A String&quot;, # Time at which this file was shared with the user (formatted RFC 3339 timestamp).
1261 &quot;sharingUser&quot;: { # Information about a Drive user. # User that shared the item with the current user, if available.
1262 &quot;displayName&quot;: &quot;A String&quot;, # A plain text displayable name for this user.
1263 &quot;emailAddress&quot;: &quot;A String&quot;, # The email address of the user.
1264 &quot;isAuthenticatedUser&quot;: True or False, # Whether this user is the same as the authenticated user for whom the request was made.
1265 &quot;kind&quot;: &quot;drive#user&quot;, # This is always drive#user.
1266 &quot;permissionId&quot;: &quot;A String&quot;, # The user&#x27;s ID as visible in the permissions collection.
1267 &quot;picture&quot;: { # The user&#x27;s profile picture.
1268 &quot;url&quot;: &quot;A String&quot;, # A URL that points to a profile picture of this user.
1269 },
1270 },
1271 &quot;shortcutDetails&quot;: { # Shortcut file details. Only populated for shortcut files, which have the mimeType field set to application/vnd.google-apps.shortcut.
1272 &quot;targetId&quot;: &quot;A String&quot;, # The ID of the file that this shortcut points to.
1273 &quot;targetMimeType&quot;: &quot;A String&quot;, # The MIME type of the file that this shortcut points to. The value of this field is a snapshot of the target&#x27;s MIME type, captured when the shortcut is created.
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700[diff] [blame^]1274 &quot;targetResourceKey&quot;: &quot;A String&quot;, # The ResourceKey for the target file.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]1275 },
1276 &quot;spaces&quot;: [ # The list of spaces which contain the file. Supported values are &#x27;drive&#x27;, &#x27;appDataFolder&#x27; and &#x27;photos&#x27;.
1277 &quot;A String&quot;,
1278 ],
1279 &quot;teamDriveId&quot;: &quot;A String&quot;, # Deprecated - use driveId instead.
1280 &quot;thumbnail&quot;: { # A thumbnail for the file. This will only be used if a standard thumbnail cannot be generated.
1281 &quot;image&quot;: &quot;A String&quot;, # The URL-safe Base64 encoded bytes of the thumbnail image. It should conform to RFC 4648 section 5.
1282 &quot;mimeType&quot;: &quot;A String&quot;, # The MIME type of the thumbnail.
1283 },
1284 &quot;thumbnailLink&quot;: &quot;A String&quot;, # A short-lived link to the file&#x27;s thumbnail. Typically lasts on the order of hours. Only populated when the requesting app can access the file&#x27;s content. If the file isn&#x27;t shared publicly, the URL returned in Files.thumbnailLink must be fetched using a credentialed request.
1285 &quot;thumbnailVersion&quot;: &quot;A String&quot;, # The thumbnail version for use in thumbnail cache invalidation.
1286 &quot;title&quot;: &quot;A String&quot;, # 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.
1287 &quot;trashedDate&quot;: &quot;A String&quot;, # The time that the item was trashed (formatted RFC 3339 timestamp). Only populated for items in shared drives.
1288 &quot;trashingUser&quot;: { # Information about a Drive user. # If the file has been explicitly trashed, the user who trashed it. Only populated for items in shared drives.
1289 &quot;displayName&quot;: &quot;A String&quot;, # A plain text displayable name for this user.
1290 &quot;emailAddress&quot;: &quot;A String&quot;, # The email address of the user.
1291 &quot;isAuthenticatedUser&quot;: True or False, # Whether this user is the same as the authenticated user for whom the request was made.
1292 &quot;kind&quot;: &quot;drive#user&quot;, # This is always drive#user.
1293 &quot;permissionId&quot;: &quot;A String&quot;, # The user&#x27;s ID as visible in the permissions collection.
1294 &quot;picture&quot;: { # The user&#x27;s profile picture.
1295 &quot;url&quot;: &quot;A String&quot;, # A URL that points to a profile picture of this user.
1296 },
1297 },
1298 &quot;userPermission&quot;: { # A permission for a file. # The permissions for the authenticated user on this file.
1299 &quot;additionalRoles&quot;: [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future.
1300 &quot;A String&quot;,
1301 ],
1302 &quot;authKey&quot;: &quot;A String&quot;, # Deprecated.
1303 &quot;deleted&quot;: True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.
1304 &quot;domain&quot;: &quot;A String&quot;, # 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.
1305 &quot;emailAddress&quot;: &quot;A String&quot;, # 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.
1306 &quot;etag&quot;: &quot;A String&quot;, # The ETag of the permission.
1307 &quot;expirationDate&quot;: &quot;A String&quot;, # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions:
1308 # - They cannot be set on shared drive items
1309 # - They can only be set on user and group permissions
1310 # - The date must be in the future
1311 # - The date cannot be more than a year in the future
1312 # - The date can only be set on drive.permissions.update or drive.permissions.patch requests
1313 &quot;id&quot;: &quot;A String&quot;, # 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.
1314 &quot;kind&quot;: &quot;drive#permission&quot;, # This is always drive#permission.
1315 &quot;name&quot;: &quot;A String&quot;, # The name for this permission.
1316 &quot;permissionDetails&quot;: [ # 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.
1317 {
1318 &quot;additionalRoles&quot;: [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future.
1319 &quot;A String&quot;,
1320 ],
1321 &quot;inherited&quot;: True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field.
1322 &quot;inheritedFrom&quot;: &quot;A String&quot;, # The ID of the item from which this permission is inherited. This is an output-only field.
1323 &quot;permissionType&quot;: &quot;A String&quot;, # The permission type for this user. While new values may be added in future, the following are currently possible:
1324 # - file
1325 # - member
1326 &quot;role&quot;: &quot;A String&quot;, # The primary role for this user. While new values may be added in the future, the following are currently possible:
1327 # - organizer
1328 # - fileOrganizer
1329 # - writer
1330 # - reader
1331 },
1332 ],
1333 &quot;photoLink&quot;: &quot;A String&quot;, # A link to the profile photo, if available.
1334 &quot;role&quot;: &quot;A String&quot;, # The primary role for this user. While new values may be supported in the future, the following are currently allowed:
1335 # - owner
1336 # - organizer
1337 # - fileOrganizer
1338 # - writer
1339 # - reader
1340 &quot;selfLink&quot;: &quot;A String&quot;, # A link back to this permission.
1341 &quot;teamDrivePermissionDetails&quot;: [ # Deprecated - use permissionDetails instead.
1342 {
1343 &quot;additionalRoles&quot;: [ # Deprecated - use permissionDetails/additionalRoles instead.
1344 &quot;A String&quot;,
1345 ],
1346 &quot;inherited&quot;: True or False, # Deprecated - use permissionDetails/inherited instead.
1347 &quot;inheritedFrom&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/inheritedFrom instead.
1348 &quot;role&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/role instead.
1349 &quot;teamDrivePermissionType&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/permissionType instead.
1350 },
1351 ],
1352 &quot;type&quot;: &quot;A String&quot;, # The account type. Allowed values are:
1353 # - user
1354 # - group
1355 # - domain
1356 # - anyone
1357 &quot;value&quot;: &quot;A String&quot;, # 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.
1358 &quot;view&quot;: &quot;A String&quot;, # Indicates the view for this permission. Only populated for permissions that belong to a view. published is the only supported value.
1359 &quot;withLink&quot;: True or False, # Whether the link is required for this permission.
1360 },
1361 &quot;version&quot;: &quot;A String&quot;, # 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.
1362 &quot;videoMediaMetadata&quot;: { # Metadata about video media. This will only be present for video types.
1363 &quot;durationMillis&quot;: &quot;A String&quot;, # The duration of the video in milliseconds.
1364 &quot;height&quot;: 42, # The height of the video in pixels.
1365 &quot;width&quot;: 42, # The width of the video in pixels.
1366 },
1367 &quot;webContentLink&quot;: &quot;A String&quot;, # 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.
1368 &quot;webViewLink&quot;: &quot;A String&quot;, # A link only available on public folders for viewing their static web assets (HTML, CSS, JS, etc) via Google Drive&#x27;s Website Hosting.
1369 &quot;writersCanShare&quot;: True or False, # Whether writers can share the document with other users. Not populated for items in shared drives.
1370}</pre>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1371</div>
1372
1373<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]1374 <code class="details" id="get_media">get_media(fileId, acknowledgeAbuse=None, includePermissionsForView=None, projection=None, revisionId=None, supportsAllDrives=None, supportsTeamDrives=None, updateViewedDate=None)</code>
yoshi-code-bot3dd15272021-04-21 15:07:48 -0700[diff] [blame]1375 <pre>Gets a file&#x27;s metadata or content by ID.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]1376
1377Args:
1378 fileId: string, The ID for the file in question. (required)
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1379 acknowledgeAbuse: boolean, Whether the user is acknowledging the risk of downloading known malware or other abusive files.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]1380 includePermissionsForView: string, Specifies which additional view&#x27;s permissions to include in the response. Only &#x27;published&#x27; is supported.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]1381 projection: string, This parameter is deprecated and has no function.
1382 Allowed values
1383 BASIC - Deprecated
1384 FULL - Deprecated
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]1385 revisionId: string, Specifies the Revision ID that should be downloaded. Ignored unless alt=media is specified.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]1386 supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1387 supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]1388 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]1389
1390Returns:
1391 The media object as a string.
1392
1393 </pre>
1394</div>
1395
1396<div class="method">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]1397 <code class="details" id="insert">insert(body=None, convert=None, enforceSingleParent=None, includePermissionsForView=None, media_body=None, media_mime_type=None, ocr=None, ocrLanguage=None, pinned=None, supportsAllDrives=None, supportsTeamDrives=None, timedTextLanguage=None, timedTextTrackName=None, useContentAsIndexableText=None, visibility=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1398 <pre>Insert a new file.
1399
1400Args:
1401 body: object, The request body.
1402 The object takes the form of:
1403
1404{ # The metadata for a file.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1405 &quot;alternateLink&quot;: &quot;A String&quot;, # A link for opening the file in a relevant Google editor or viewer.
1406 &quot;appDataContents&quot;: True or False, # Whether this file is in the Application Data folder.
1407 &quot;canComment&quot;: True or False, # Deprecated: use capabilities/canComment.
1408 &quot;canReadRevisions&quot;: True or False, # Deprecated: use capabilities/canReadRevisions.
1409 &quot;capabilities&quot;: { # Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take.
1410 &quot;canAddChildren&quot;: True or False, # Whether the current user can add children to this folder. This is always false when the item is not a folder.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]1411 &quot;canAddFolderFromAnotherDrive&quot;: True or False, # Whether the current user can add a folder from another drive (different shared drive or My Drive) to this folder. This is false when the item is not a folder. Only populated for items in shared drives.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1412 &quot;canAddMyDriveParent&quot;: 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.
1413 &quot;canChangeCopyRequiresWriterPermission&quot;: True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this file.
1414 &quot;canChangeRestrictedDownload&quot;: True or False, # Deprecated
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700[diff] [blame^]1415 &quot;canChangeSecurityUpdateEnabled&quot;: True or False, # Whether the current user can change the securityUpdateEnabled field on link share metadata.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1416 &quot;canComment&quot;: True or False, # Whether the current user can comment on this file.
1417 &quot;canCopy&quot;: 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.
1418 &quot;canDelete&quot;: True or False, # Whether the current user can delete this file.
1419 &quot;canDeleteChildren&quot;: 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.
1420 &quot;canDownload&quot;: True or False, # Whether the current user can download this file.
1421 &quot;canEdit&quot;: 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.
1422 &quot;canListChildren&quot;: 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.
1423 &quot;canModifyContent&quot;: True or False, # Whether the current user can modify the content of this file.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]1424 &quot;canModifyContentRestriction&quot;: True or False, # Whether the current user can modify restrictions on content of this file.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1425 &quot;canMoveChildrenOutOfDrive&quot;: 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.
1426 &quot;canMoveChildrenOutOfTeamDrive&quot;: True or False, # Deprecated - use canMoveChildrenOutOfDrive instead.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]1427 &quot;canMoveChildrenWithinDrive&quot;: True or False, # Whether the current user can move children of this folder within this drive. This is false when the item is not a folder. Note that a request to move the child may still fail depending on the current user&#x27;s access to the child and to the destination folder.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1428 &quot;canMoveChildrenWithinTeamDrive&quot;: True or False, # Deprecated - use canMoveChildrenWithinDrive instead.
1429 &quot;canMoveItemIntoTeamDrive&quot;: True or False, # Deprecated - use canMoveItemOutOfDrive instead.
1430 &quot;canMoveItemOutOfDrive&quot;: 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.
1431 &quot;canMoveItemOutOfTeamDrive&quot;: True or False, # Deprecated - use canMoveItemOutOfDrive instead.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]1432 &quot;canMoveItemWithinDrive&quot;: True or False, # Whether the current user can move this item within this drive. Note that a request to change the parent of the item may still fail depending on the new parent that is being added and the parent that is being removed.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1433 &quot;canMoveItemWithinTeamDrive&quot;: True or False, # Deprecated - use canMoveItemWithinDrive instead.
1434 &quot;canMoveTeamDriveItem&quot;: True or False, # Deprecated - use canMoveItemWithinDrive or canMoveItemOutOfDrive instead.
1435 &quot;canReadDrive&quot;: True or False, # Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives.
1436 &quot;canReadRevisions&quot;: 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.
1437 &quot;canReadTeamDrive&quot;: True or False, # Deprecated - use canReadDrive instead.
1438 &quot;canRemoveChildren&quot;: 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.
1439 &quot;canRemoveMyDriveParent&quot;: 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.
1440 &quot;canRename&quot;: True or False, # Whether the current user can rename this file.
1441 &quot;canShare&quot;: True or False, # Whether the current user can modify the sharing settings for this file.
1442 &quot;canTrash&quot;: True or False, # Whether the current user can move this file to trash.
1443 &quot;canTrashChildren&quot;: 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.
1444 &quot;canUntrash&quot;: True or False, # Whether the current user can restore this file from trash.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1445 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]1446 &quot;contentRestrictions&quot;: [ # Restrictions for accessing the content of the file. Only populated if such a restriction exists.
1447 { # A restriction for accessing the content of the file.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]1448 &quot;readOnly&quot;: True or False, # Whether the content of the file is read-only. If a file is read-only, a new revision of the file may not be added, comments may not be added or modified, and the title of the file may not be modified.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]1449 &quot;reason&quot;: &quot;A String&quot;, # Reason for why the content of the file is restricted. This is only mutable on requests that also set readOnly=true.
1450 &quot;restrictingUser&quot;: { # Information about a Drive user. # The user who set the content restriction. Only populated if readOnly is true.
1451 &quot;displayName&quot;: &quot;A String&quot;, # A plain text displayable name for this user.
1452 &quot;emailAddress&quot;: &quot;A String&quot;, # The email address of the user.
1453 &quot;isAuthenticatedUser&quot;: True or False, # Whether this user is the same as the authenticated user for whom the request was made.
1454 &quot;kind&quot;: &quot;drive#user&quot;, # This is always drive#user.
1455 &quot;permissionId&quot;: &quot;A String&quot;, # The user&#x27;s ID as visible in the permissions collection.
1456 &quot;picture&quot;: { # The user&#x27;s profile picture.
1457 &quot;url&quot;: &quot;A String&quot;, # A URL that points to a profile picture of this user.
1458 },
1459 },
1460 &quot;restrictionDate&quot;: &quot;A String&quot;, # The time at which the content restriction was set (formatted RFC 3339 timestamp). Only populated if readOnly is true.
1461 &quot;type&quot;: &quot;A String&quot;, # The type of the content restriction. Currently the only possible value is globalContentRestriction.
1462 },
1463 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1464 &quot;copyRequiresWriterPermission&quot;: True or False, # Whether the options to copy, print, or download this file, should be disabled for readers and commenters.
1465 &quot;copyable&quot;: True or False, # Deprecated: use capabilities/canCopy.
1466 &quot;createdDate&quot;: &quot;A String&quot;, # Create time for this file (formatted RFC 3339 timestamp).
1467 &quot;defaultOpenWithLink&quot;: &quot;A String&quot;, # A link to open this file with the user&#x27;s default app for this file. Only populated when the drive.apps.readonly scope is used.
1468 &quot;description&quot;: &quot;A String&quot;, # A short description of the file.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]1469 &quot;downloadUrl&quot;: &quot;A String&quot;, # Short lived download URL for the file. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1470 &quot;driveId&quot;: &quot;A String&quot;, # ID of the shared drive the file resides in. Only populated for items in shared drives.
1471 &quot;editable&quot;: True or False, # Deprecated: use capabilities/canEdit.
1472 &quot;embedLink&quot;: &quot;A String&quot;, # A link for embedding the file.
1473 &quot;etag&quot;: &quot;A String&quot;, # ETag of the file.
1474 &quot;explicitlyTrashed&quot;: True or False, # Whether this file has been explicitly trashed, as opposed to recursively trashed.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]1475 &quot;exportLinks&quot;: { # Links for exporting Docs Editors files to specific formats.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1476 &quot;a_key&quot;: &quot;A String&quot;, # A mapping from export format to URL
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1477 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]1478 &quot;fileExtension&quot;: &quot;A String&quot;, # The final component of fullFileExtension with trailing text that does not appear to be part of the extension removed. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.
1479 &quot;fileSize&quot;: &quot;A String&quot;, # The size of the file in bytes. This field is populated for files with content stored in Google Drive and for files in Docs Editors; it is not populated for shortcut files.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1480 &quot;folderColorRgb&quot;: &quot;A String&quot;, # 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.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]1481 &quot;fullFileExtension&quot;: &quot;A String&quot;, # The full file extension; extracted from the title. May contain multiple concatenated extensions, such as &quot;tar.gz&quot;. Removing an extension from the title does not clear this field; however, changing the extension on the title does update this field. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1482 &quot;hasAugmentedPermissions&quot;: True or False, # Whether there are permissions directly on this file. This field is only populated for items in shared drives.
1483 &quot;hasThumbnail&quot;: 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.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]1484 &quot;headRevisionId&quot;: &quot;A String&quot;, # The ID of the file&#x27;s head revision. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1485 &quot;iconLink&quot;: &quot;A String&quot;, # A link to the file&#x27;s icon.
1486 &quot;id&quot;: &quot;A String&quot;, # The ID of the file.
1487 &quot;imageMediaMetadata&quot;: { # 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.
1488 &quot;aperture&quot;: 3.14, # The aperture used to create the photo (f-number).
1489 &quot;cameraMake&quot;: &quot;A String&quot;, # The make of the camera used to create the photo.
1490 &quot;cameraModel&quot;: &quot;A String&quot;, # The model of the camera used to create the photo.
1491 &quot;colorSpace&quot;: &quot;A String&quot;, # The color space of the photo.
1492 &quot;date&quot;: &quot;A String&quot;, # The date and time the photo was taken (EXIF format timestamp).
1493 &quot;exposureBias&quot;: 3.14, # The exposure bias of the photo (APEX value).
1494 &quot;exposureMode&quot;: &quot;A String&quot;, # The exposure mode used to create the photo.
1495 &quot;exposureTime&quot;: 3.14, # The length of the exposure, in seconds.
1496 &quot;flashUsed&quot;: True or False, # Whether a flash was used to create the photo.
1497 &quot;focalLength&quot;: 3.14, # The focal length used to create the photo, in millimeters.
1498 &quot;height&quot;: 42, # The height of the image in pixels.
1499 &quot;isoSpeed&quot;: 42, # The ISO speed used to create the photo.
1500 &quot;lens&quot;: &quot;A String&quot;, # The lens used to create the photo.
1501 &quot;location&quot;: { # Geographic location information stored in the image.
1502 &quot;altitude&quot;: 3.14, # The altitude stored in the image.
1503 &quot;latitude&quot;: 3.14, # The latitude stored in the image.
1504 &quot;longitude&quot;: 3.14, # The longitude stored in the image.
1505 },
1506 &quot;maxApertureValue&quot;: 3.14, # The smallest f-number of the lens at the focal length used to create the photo (APEX value).
1507 &quot;meteringMode&quot;: &quot;A String&quot;, # The metering mode used to create the photo.
1508 &quot;rotation&quot;: 42, # The number of clockwise 90 degree rotations applied from the image&#x27;s original orientation.
1509 &quot;sensor&quot;: &quot;A String&quot;, # The type of sensor used to create the photo.
1510 &quot;subjectDistance&quot;: 42, # The distance to the subject of the photo, in meters.
1511 &quot;whiteBalance&quot;: &quot;A String&quot;, # The white balance mode used to create the photo.
1512 &quot;width&quot;: 42, # The width of the image in pixels.
1513 },
1514 &quot;indexableText&quot;: { # Indexable text attributes for the file (can only be written)
1515 &quot;text&quot;: &quot;A String&quot;, # The text to be indexed for this file.
1516 },
1517 &quot;isAppAuthorized&quot;: True or False, # Whether the file was created or opened by the requesting app.
1518 &quot;kind&quot;: &quot;drive#file&quot;, # The type of file. This is always drive#file.
1519 &quot;labels&quot;: { # A group of labels for the file.
1520 &quot;hidden&quot;: True or False, # Deprecated.
1521 &quot;modified&quot;: True or False, # Whether the file has been modified by this user.
1522 &quot;restricted&quot;: True or False, # Deprecated - use copyRequiresWriterPermission instead.
1523 &quot;starred&quot;: True or False, # Whether this file is starred by the user.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]1524 &quot;trashed&quot;: True or False, # Whether the file has been trashed, either explicitly or from a trashed parent folder. Only the owner may trash a file. The trashed item is excluded from all files.list responses returned for any user who does not own the file. However, all users with access to the file can see the trashed item metadata in an API response. All users with access can copy, download, export, and share the file.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1525 &quot;viewed&quot;: True or False, # Whether this file has been viewed by this user.
1526 },
1527 &quot;lastModifyingUser&quot;: { # Information about a Drive user. # The last user to modify this file.
1528 &quot;displayName&quot;: &quot;A String&quot;, # A plain text displayable name for this user.
1529 &quot;emailAddress&quot;: &quot;A String&quot;, # The email address of the user.
1530 &quot;isAuthenticatedUser&quot;: True or False, # Whether this user is the same as the authenticated user for whom the request was made.
1531 &quot;kind&quot;: &quot;drive#user&quot;, # This is always drive#user.
1532 &quot;permissionId&quot;: &quot;A String&quot;, # The user&#x27;s ID as visible in the permissions collection.
1533 &quot;picture&quot;: { # The user&#x27;s profile picture.
1534 &quot;url&quot;: &quot;A String&quot;, # A URL that points to a profile picture of this user.
1535 },
1536 },
1537 &quot;lastModifyingUserName&quot;: &quot;A String&quot;, # Name of the last user to modify this file.
1538 &quot;lastViewedByMeDate&quot;: &quot;A String&quot;, # Last time this file was viewed by the user (formatted RFC 3339 timestamp).
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700[diff] [blame^]1539 &quot;linkShareMetadata&quot;: { # Contains details about the link URLs that clients are using to refer to this item.
1540 &quot;securityUpdateEligible&quot;: True or False, # Whether the file is eligible for security update.
1541 &quot;securityUpdateEnabled&quot;: True or False, # Whether the security update is enabled for this file.
1542 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1543 &quot;markedViewedByMeDate&quot;: &quot;A String&quot;, # Deprecated.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]1544 &quot;md5Checksum&quot;: &quot;A String&quot;, # An MD5 checksum for the content of this file. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1545 &quot;mimeType&quot;: &quot;A String&quot;, # 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&#x27;s MIME type.
1546 &quot;modifiedByMeDate&quot;: &quot;A String&quot;, # 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.
1547 &quot;modifiedDate&quot;: &quot;A String&quot;, # Last time this file was modified by anyone (formatted RFC 3339 timestamp). This is only mutable on update when the setModifiedDate parameter is set.
1548 &quot;openWithLinks&quot;: { # A map of the id of each of the user&#x27;s apps to a link to open this file with that app. Only populated when the drive.apps.readonly scope is used.
1549 &quot;a_key&quot;: &quot;A String&quot;,
1550 },
1551 &quot;originalFilename&quot;: &quot;A String&quot;, # 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.
1552 &quot;ownedByMe&quot;: True or False, # Whether the file is owned by the current user. Not populated for items in shared drives.
1553 &quot;ownerNames&quot;: [ # Name(s) of the owner(s) of this file. Not populated for items in shared drives.
1554 &quot;A String&quot;,
1555 ],
yoshi-code-botab1d6dc2021-05-28 00:42:02 -0700[diff] [blame]1556 &quot;owners&quot;: [ # The owner of this file. Only certain legacy files may have more than one owner. This field isn&#x27;t populated for items in shared drives.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]1557 { # Information about a Drive user.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1558 &quot;displayName&quot;: &quot;A String&quot;, # A plain text displayable name for this user.
1559 &quot;emailAddress&quot;: &quot;A String&quot;, # The email address of the user.
1560 &quot;isAuthenticatedUser&quot;: True or False, # Whether this user is the same as the authenticated user for whom the request was made.
1561 &quot;kind&quot;: &quot;drive#user&quot;, # This is always drive#user.
1562 &quot;permissionId&quot;: &quot;A String&quot;, # The user&#x27;s ID as visible in the permissions collection.
1563 &quot;picture&quot;: { # The user&#x27;s profile picture.
1564 &quot;url&quot;: &quot;A String&quot;, # A URL that points to a profile picture of this user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1565 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1566 },
1567 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1568 &quot;parents&quot;: [ # Collection of parent folders which contain this file.
1569 # If not specified as part of an insert request, the file will be placed directly in the user&#x27;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.
1570 { # A reference to a file&#x27;s parent.
1571 &quot;id&quot;: &quot;A String&quot;, # The ID of the parent.
1572 &quot;isRoot&quot;: True or False, # Whether or not the parent is the root folder.
1573 &quot;kind&quot;: &quot;drive#parentReference&quot;, # This is always drive#parentReference.
1574 &quot;parentLink&quot;: &quot;A String&quot;, # A link to the parent.
1575 &quot;selfLink&quot;: &quot;A String&quot;, # A link back to this reference.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1576 },
1577 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1578 &quot;permissionIds&quot;: [ # List of permission IDs for users with access to this file.
1579 &quot;A String&quot;,
1580 ],
1581 &quot;permissions&quot;: [ # The list of permissions for users with access to this file. Not populated for items in shared drives.
1582 { # A permission for a file.
1583 &quot;additionalRoles&quot;: [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future.
1584 &quot;A String&quot;,
1585 ],
1586 &quot;authKey&quot;: &quot;A String&quot;, # Deprecated.
1587 &quot;deleted&quot;: True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.
1588 &quot;domain&quot;: &quot;A String&quot;, # 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.
1589 &quot;emailAddress&quot;: &quot;A String&quot;, # 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.
1590 &quot;etag&quot;: &quot;A String&quot;, # The ETag of the permission.
1591 &quot;expirationDate&quot;: &quot;A String&quot;, # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions:
1592 # - They cannot be set on shared drive items
1593 # - They can only be set on user and group permissions
1594 # - The date must be in the future
1595 # - The date cannot be more than a year in the future
1596 # - The date can only be set on drive.permissions.update or drive.permissions.patch requests
1597 &quot;id&quot;: &quot;A String&quot;, # 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.
1598 &quot;kind&quot;: &quot;drive#permission&quot;, # This is always drive#permission.
1599 &quot;name&quot;: &quot;A String&quot;, # The name for this permission.
1600 &quot;permissionDetails&quot;: [ # 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.
1601 {
1602 &quot;additionalRoles&quot;: [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future.
1603 &quot;A String&quot;,
1604 ],
1605 &quot;inherited&quot;: True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field.
1606 &quot;inheritedFrom&quot;: &quot;A String&quot;, # The ID of the item from which this permission is inherited. This is an output-only field.
1607 &quot;permissionType&quot;: &quot;A String&quot;, # The permission type for this user. While new values may be added in future, the following are currently possible:
1608 # - file
1609 # - member
1610 &quot;role&quot;: &quot;A String&quot;, # The primary role for this user. While new values may be added in the future, the following are currently possible:
1611 # - organizer
1612 # - fileOrganizer
1613 # - writer
1614 # - reader
1615 },
1616 ],
1617 &quot;photoLink&quot;: &quot;A String&quot;, # A link to the profile photo, if available.
1618 &quot;role&quot;: &quot;A String&quot;, # The primary role for this user. While new values may be supported in the future, the following are currently allowed:
1619 # - owner
1620 # - organizer
1621 # - fileOrganizer
1622 # - writer
1623 # - reader
1624 &quot;selfLink&quot;: &quot;A String&quot;, # A link back to this permission.
1625 &quot;teamDrivePermissionDetails&quot;: [ # Deprecated - use permissionDetails instead.
1626 {
1627 &quot;additionalRoles&quot;: [ # Deprecated - use permissionDetails/additionalRoles instead.
1628 &quot;A String&quot;,
1629 ],
1630 &quot;inherited&quot;: True or False, # Deprecated - use permissionDetails/inherited instead.
1631 &quot;inheritedFrom&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/inheritedFrom instead.
1632 &quot;role&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/role instead.
1633 &quot;teamDrivePermissionType&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/permissionType instead.
1634 },
1635 ],
1636 &quot;type&quot;: &quot;A String&quot;, # The account type. Allowed values are:
1637 # - user
1638 # - group
1639 # - domain
1640 # - anyone
1641 &quot;value&quot;: &quot;A String&quot;, # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type is anyone, in which case both id and value are ignored.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]1642 &quot;view&quot;: &quot;A String&quot;, # Indicates the view for this permission. Only populated for permissions that belong to a view. published is the only supported value.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1643 &quot;withLink&quot;: True or False, # Whether the link is required for this permission.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1644 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1645 ],
1646 &quot;properties&quot;: [ # The list of properties.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]1647 { # A key-value pair attached to a file that is either public or private to an application.
1648 # The following limits apply to file properties:
1649 # - Maximum of 100 properties total per file
1650 # - Maximum of 30 private properties per app
1651 # - Maximum of 30 public properties
1652 # - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1653 &quot;etag&quot;: &quot;A String&quot;, # ETag of the property.
1654 &quot;key&quot;: &quot;A String&quot;, # The key of this property.
1655 &quot;kind&quot;: &quot;drive#property&quot;, # This is always drive#property.
1656 &quot;selfLink&quot;: &quot;A String&quot;, # The link back to this property.
1657 &quot;value&quot;: &quot;A String&quot;, # The value of this property.
yoshi-code-bot69706592021-03-03 03:54:02 -0800[diff] [blame]1658 &quot;visibility&quot;: &quot;A String&quot;, # The visibility of this property. Allowed values are PRIVATE and PUBLIC. (Default: PRIVATE). Private properties can only be retrieved using an authenticated request. An authenticated request uses an access token obtained with a OAuth 2 client ID. You cannot use an API key to retrieve private properties.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1659 },
1660 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1661 &quot;quotaBytesUsed&quot;: &quot;A String&quot;, # The number of quota bytes used by this file.
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700[diff] [blame^]1662 &quot;resourceKey&quot;: &quot;A String&quot;, # A key needed to access the item via a shared link.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1663 &quot;selfLink&quot;: &quot;A String&quot;, # A link back to this file.
1664 &quot;shareable&quot;: True or False, # Deprecated: use capabilities/canShare.
1665 &quot;shared&quot;: True or False, # Whether the file has been shared. Not populated for items in shared drives.
1666 &quot;sharedWithMeDate&quot;: &quot;A String&quot;, # Time at which this file was shared with the user (formatted RFC 3339 timestamp).
1667 &quot;sharingUser&quot;: { # Information about a Drive user. # User that shared the item with the current user, if available.
1668 &quot;displayName&quot;: &quot;A String&quot;, # A plain text displayable name for this user.
1669 &quot;emailAddress&quot;: &quot;A String&quot;, # The email address of the user.
1670 &quot;isAuthenticatedUser&quot;: True or False, # Whether this user is the same as the authenticated user for whom the request was made.
1671 &quot;kind&quot;: &quot;drive#user&quot;, # This is always drive#user.
1672 &quot;permissionId&quot;: &quot;A String&quot;, # The user&#x27;s ID as visible in the permissions collection.
1673 &quot;picture&quot;: { # The user&#x27;s profile picture.
1674 &quot;url&quot;: &quot;A String&quot;, # A URL that points to a profile picture of this user.
1675 },
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]1676 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1677 &quot;shortcutDetails&quot;: { # Shortcut file details. Only populated for shortcut files, which have the mimeType field set to application/vnd.google-apps.shortcut.
1678 &quot;targetId&quot;: &quot;A String&quot;, # The ID of the file that this shortcut points to.
1679 &quot;targetMimeType&quot;: &quot;A String&quot;, # The MIME type of the file that this shortcut points to. The value of this field is a snapshot of the target&#x27;s MIME type, captured when the shortcut is created.
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700[diff] [blame^]1680 &quot;targetResourceKey&quot;: &quot;A String&quot;, # The ResourceKey for the target file.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1681 },
1682 &quot;spaces&quot;: [ # The list of spaces which contain the file. Supported values are &#x27;drive&#x27;, &#x27;appDataFolder&#x27; and &#x27;photos&#x27;.
1683 &quot;A String&quot;,
1684 ],
1685 &quot;teamDriveId&quot;: &quot;A String&quot;, # Deprecated - use driveId instead.
1686 &quot;thumbnail&quot;: { # A thumbnail for the file. This will only be used if a standard thumbnail cannot be generated.
1687 &quot;image&quot;: &quot;A String&quot;, # The URL-safe Base64 encoded bytes of the thumbnail image. It should conform to RFC 4648 section 5.
1688 &quot;mimeType&quot;: &quot;A String&quot;, # The MIME type of the thumbnail.
1689 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]1690 &quot;thumbnailLink&quot;: &quot;A String&quot;, # A short-lived link to the file&#x27;s thumbnail. Typically lasts on the order of hours. Only populated when the requesting app can access the file&#x27;s content. If the file isn&#x27;t shared publicly, the URL returned in Files.thumbnailLink must be fetched using a credentialed request.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1691 &quot;thumbnailVersion&quot;: &quot;A String&quot;, # The thumbnail version for use in thumbnail cache invalidation.
1692 &quot;title&quot;: &quot;A String&quot;, # 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.
1693 &quot;trashedDate&quot;: &quot;A String&quot;, # The time that the item was trashed (formatted RFC 3339 timestamp). Only populated for items in shared drives.
1694 &quot;trashingUser&quot;: { # Information about a Drive user. # If the file has been explicitly trashed, the user who trashed it. Only populated for items in shared drives.
1695 &quot;displayName&quot;: &quot;A String&quot;, # A plain text displayable name for this user.
1696 &quot;emailAddress&quot;: &quot;A String&quot;, # The email address of the user.
1697 &quot;isAuthenticatedUser&quot;: True or False, # Whether this user is the same as the authenticated user for whom the request was made.
1698 &quot;kind&quot;: &quot;drive#user&quot;, # This is always drive#user.
1699 &quot;permissionId&quot;: &quot;A String&quot;, # The user&#x27;s ID as visible in the permissions collection.
1700 &quot;picture&quot;: { # The user&#x27;s profile picture.
1701 &quot;url&quot;: &quot;A String&quot;, # A URL that points to a profile picture of this user.
1702 },
1703 },
1704 &quot;userPermission&quot;: { # A permission for a file. # The permissions for the authenticated user on this file.
1705 &quot;additionalRoles&quot;: [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future.
1706 &quot;A String&quot;,
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1707 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1708 &quot;authKey&quot;: &quot;A String&quot;, # Deprecated.
1709 &quot;deleted&quot;: True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.
1710 &quot;domain&quot;: &quot;A String&quot;, # 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.
1711 &quot;emailAddress&quot;: &quot;A String&quot;, # 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.
1712 &quot;etag&quot;: &quot;A String&quot;, # The ETag of the permission.
1713 &quot;expirationDate&quot;: &quot;A String&quot;, # 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]1714 # - They cannot be set on shared drive items
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1715 # - They can only be set on user and group permissions
1716 # - The date must be in the future
1717 # - The date cannot be more than a year in the future
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1718 # - The date can only be set on drive.permissions.update or drive.permissions.patch requests
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1719 &quot;id&quot;: &quot;A String&quot;, # 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.
1720 &quot;kind&quot;: &quot;drive#permission&quot;, # This is always drive#permission.
1721 &quot;name&quot;: &quot;A String&quot;, # The name for this permission.
1722 &quot;permissionDetails&quot;: [ # 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.
1723 {
1724 &quot;additionalRoles&quot;: [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future.
1725 &quot;A String&quot;,
1726 ],
1727 &quot;inherited&quot;: True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field.
1728 &quot;inheritedFrom&quot;: &quot;A String&quot;, # The ID of the item from which this permission is inherited. This is an output-only field.
1729 &quot;permissionType&quot;: &quot;A String&quot;, # The permission type for this user. While new values may be added in future, the following are currently possible:
1730 # - file
1731 # - member
1732 &quot;role&quot;: &quot;A String&quot;, # The primary role for this user. While new values may be added in the future, the following are currently possible:
1733 # - organizer
1734 # - fileOrganizer
1735 # - writer
1736 # - reader
1737 },
1738 ],
1739 &quot;photoLink&quot;: &quot;A String&quot;, # A link to the profile photo, if available.
1740 &quot;role&quot;: &quot;A String&quot;, # 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]1741 # - owner
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1742 # - organizer
1743 # - fileOrganizer
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1744 # - writer
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1745 # - reader
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1746 &quot;selfLink&quot;: &quot;A String&quot;, # A link back to this permission.
1747 &quot;teamDrivePermissionDetails&quot;: [ # Deprecated - use permissionDetails instead.
1748 {
1749 &quot;additionalRoles&quot;: [ # Deprecated - use permissionDetails/additionalRoles instead.
1750 &quot;A String&quot;,
1751 ],
1752 &quot;inherited&quot;: True or False, # Deprecated - use permissionDetails/inherited instead.
1753 &quot;inheritedFrom&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/inheritedFrom instead.
1754 &quot;role&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/role instead.
1755 &quot;teamDrivePermissionType&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/permissionType instead.
1756 },
1757 ],
1758 &quot;type&quot;: &quot;A String&quot;, # The account type. Allowed values are:
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1759 # - user
1760 # - group
1761 # - domain
1762 # - anyone
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1763 &quot;value&quot;: &quot;A String&quot;, # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type is anyone, in which case both id and value are ignored.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]1764 &quot;view&quot;: &quot;A String&quot;, # Indicates the view for this permission. Only populated for permissions that belong to a view. published is the only supported value.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1765 &quot;withLink&quot;: True or False, # Whether the link is required for this permission.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1766 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1767 &quot;version&quot;: &quot;A String&quot;, # 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.
1768 &quot;videoMediaMetadata&quot;: { # Metadata about video media. This will only be present for video types.
1769 &quot;durationMillis&quot;: &quot;A String&quot;, # The duration of the video in milliseconds.
1770 &quot;height&quot;: 42, # The height of the video in pixels.
1771 &quot;width&quot;: 42, # The width of the video in pixels.
1772 },
1773 &quot;webContentLink&quot;: &quot;A String&quot;, # 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.
1774 &quot;webViewLink&quot;: &quot;A String&quot;, # A link only available on public folders for viewing their static web assets (HTML, CSS, JS, etc) via Google Drive&#x27;s Website Hosting.
1775 &quot;writersCanShare&quot;: True or False, # Whether writers can share the document with other users. Not populated for items in shared drives.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1776}
1777
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]1778 convert: boolean, Whether to convert this file to the corresponding Docs Editors format.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]1779 enforceSingleParent: boolean, Deprecated. Creating files in multiple folders is no longer supported.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]1780 includePermissionsForView: string, Specifies which additional view&#x27;s permissions to include in the response. Only &#x27;published&#x27; is supported.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]1781 media_body: string, The filename of the media request body, or an instance of a MediaUpload object.
1782 media_mime_type: string, The MIME type of the media request body, or an instance of a MediaUpload object.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1783 ocr: boolean, Whether to attempt OCR on .jpg, .png, .gif, or .pdf uploads.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1784 ocrLanguage: string, If ocr is true, hints at the language to use. Valid values are BCP 47 codes.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1785 pinned: boolean, Whether to pin the head revision of the uploaded file. A file can have a maximum of 200 pinned revisions.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]1786 supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1787 supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead.
1788 timedTextLanguage: string, The language of the timed text.
1789 timedTextTrackName: string, The timed text track name.
1790 useContentAsIndexableText: boolean, Whether to use the content as indexable text.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1791 visibility: string, The visibility of the new file. This parameter is only relevant when convert=false.
1792 Allowed values
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1793 DEFAULT - The visibility of the new file is determined by the user&#x27;s default visibility/sharing policies.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1794 PRIVATE - The new file will be visible to only the owner.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1795
1796Returns:
1797 An object of the form:
1798
1799 { # The metadata for a file.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]1800 &quot;alternateLink&quot;: &quot;A String&quot;, # A link for opening the file in a relevant Google editor or viewer.
1801 &quot;appDataContents&quot;: True or False, # Whether this file is in the Application Data folder.
1802 &quot;canComment&quot;: True or False, # Deprecated: use capabilities/canComment.
1803 &quot;canReadRevisions&quot;: True or False, # Deprecated: use capabilities/canReadRevisions.
1804 &quot;capabilities&quot;: { # Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take.
1805 &quot;canAddChildren&quot;: True or False, # Whether the current user can add children to this folder. This is always false when the item is not a folder.
1806 &quot;canAddFolderFromAnotherDrive&quot;: True or False, # Whether the current user can add a folder from another drive (different shared drive or My Drive) to this folder. This is false when the item is not a folder. Only populated for items in shared drives.
1807 &quot;canAddMyDriveParent&quot;: 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.
1808 &quot;canChangeCopyRequiresWriterPermission&quot;: True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this file.
1809 &quot;canChangeRestrictedDownload&quot;: True or False, # Deprecated
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700[diff] [blame^]1810 &quot;canChangeSecurityUpdateEnabled&quot;: True or False, # Whether the current user can change the securityUpdateEnabled field on link share metadata.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]1811 &quot;canComment&quot;: True or False, # Whether the current user can comment on this file.
1812 &quot;canCopy&quot;: 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.
1813 &quot;canDelete&quot;: True or False, # Whether the current user can delete this file.
1814 &quot;canDeleteChildren&quot;: 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.
1815 &quot;canDownload&quot;: True or False, # Whether the current user can download this file.
1816 &quot;canEdit&quot;: 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.
1817 &quot;canListChildren&quot;: 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.
1818 &quot;canModifyContent&quot;: True or False, # Whether the current user can modify the content of this file.
1819 &quot;canModifyContentRestriction&quot;: True or False, # Whether the current user can modify restrictions on content of this file.
1820 &quot;canMoveChildrenOutOfDrive&quot;: 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.
1821 &quot;canMoveChildrenOutOfTeamDrive&quot;: True or False, # Deprecated - use canMoveChildrenOutOfDrive instead.
1822 &quot;canMoveChildrenWithinDrive&quot;: True or False, # Whether the current user can move children of this folder within this drive. This is false when the item is not a folder. Note that a request to move the child may still fail depending on the current user&#x27;s access to the child and to the destination folder.
1823 &quot;canMoveChildrenWithinTeamDrive&quot;: True or False, # Deprecated - use canMoveChildrenWithinDrive instead.
1824 &quot;canMoveItemIntoTeamDrive&quot;: True or False, # Deprecated - use canMoveItemOutOfDrive instead.
1825 &quot;canMoveItemOutOfDrive&quot;: 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.
1826 &quot;canMoveItemOutOfTeamDrive&quot;: True or False, # Deprecated - use canMoveItemOutOfDrive instead.
1827 &quot;canMoveItemWithinDrive&quot;: True or False, # Whether the current user can move this item within this drive. Note that a request to change the parent of the item may still fail depending on the new parent that is being added and the parent that is being removed.
1828 &quot;canMoveItemWithinTeamDrive&quot;: True or False, # Deprecated - use canMoveItemWithinDrive instead.
1829 &quot;canMoveTeamDriveItem&quot;: True or False, # Deprecated - use canMoveItemWithinDrive or canMoveItemOutOfDrive instead.
1830 &quot;canReadDrive&quot;: True or False, # Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives.
1831 &quot;canReadRevisions&quot;: 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.
1832 &quot;canReadTeamDrive&quot;: True or False, # Deprecated - use canReadDrive instead.
1833 &quot;canRemoveChildren&quot;: 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.
1834 &quot;canRemoveMyDriveParent&quot;: 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.
1835 &quot;canRename&quot;: True or False, # Whether the current user can rename this file.
1836 &quot;canShare&quot;: True or False, # Whether the current user can modify the sharing settings for this file.
1837 &quot;canTrash&quot;: True or False, # Whether the current user can move this file to trash.
1838 &quot;canTrashChildren&quot;: 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.
1839 &quot;canUntrash&quot;: True or False, # Whether the current user can restore this file from trash.
1840 },
1841 &quot;contentRestrictions&quot;: [ # Restrictions for accessing the content of the file. Only populated if such a restriction exists.
1842 { # A restriction for accessing the content of the file.
1843 &quot;readOnly&quot;: True or False, # Whether the content of the file is read-only. If a file is read-only, a new revision of the file may not be added, comments may not be added or modified, and the title of the file may not be modified.
1844 &quot;reason&quot;: &quot;A String&quot;, # Reason for why the content of the file is restricted. This is only mutable on requests that also set readOnly=true.
1845 &quot;restrictingUser&quot;: { # Information about a Drive user. # The user who set the content restriction. Only populated if readOnly is true.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1846 &quot;displayName&quot;: &quot;A String&quot;, # A plain text displayable name for this user.
1847 &quot;emailAddress&quot;: &quot;A String&quot;, # The email address of the user.
1848 &quot;isAuthenticatedUser&quot;: True or False, # Whether this user is the same as the authenticated user for whom the request was made.
1849 &quot;kind&quot;: &quot;drive#user&quot;, # This is always drive#user.
1850 &quot;permissionId&quot;: &quot;A String&quot;, # The user&#x27;s ID as visible in the permissions collection.
1851 &quot;picture&quot;: { # The user&#x27;s profile picture.
1852 &quot;url&quot;: &quot;A String&quot;, # A URL that points to a profile picture of this user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1853 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1854 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]1855 &quot;restrictionDate&quot;: &quot;A String&quot;, # The time at which the content restriction was set (formatted RFC 3339 timestamp). Only populated if readOnly is true.
1856 &quot;type&quot;: &quot;A String&quot;, # The type of the content restriction. Currently the only possible value is globalContentRestriction.
1857 },
1858 ],
1859 &quot;copyRequiresWriterPermission&quot;: True or False, # Whether the options to copy, print, or download this file, should be disabled for readers and commenters.
1860 &quot;copyable&quot;: True or False, # Deprecated: use capabilities/canCopy.
1861 &quot;createdDate&quot;: &quot;A String&quot;, # Create time for this file (formatted RFC 3339 timestamp).
1862 &quot;defaultOpenWithLink&quot;: &quot;A String&quot;, # A link to open this file with the user&#x27;s default app for this file. Only populated when the drive.apps.readonly scope is used.
1863 &quot;description&quot;: &quot;A String&quot;, # A short description of the file.
1864 &quot;downloadUrl&quot;: &quot;A String&quot;, # Short lived download URL for the file. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.
1865 &quot;driveId&quot;: &quot;A String&quot;, # ID of the shared drive the file resides in. Only populated for items in shared drives.
1866 &quot;editable&quot;: True or False, # Deprecated: use capabilities/canEdit.
1867 &quot;embedLink&quot;: &quot;A String&quot;, # A link for embedding the file.
1868 &quot;etag&quot;: &quot;A String&quot;, # ETag of the file.
1869 &quot;explicitlyTrashed&quot;: True or False, # Whether this file has been explicitly trashed, as opposed to recursively trashed.
1870 &quot;exportLinks&quot;: { # Links for exporting Docs Editors files to specific formats.
1871 &quot;a_key&quot;: &quot;A String&quot;, # A mapping from export format to URL
1872 },
1873 &quot;fileExtension&quot;: &quot;A String&quot;, # The final component of fullFileExtension with trailing text that does not appear to be part of the extension removed. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.
1874 &quot;fileSize&quot;: &quot;A String&quot;, # The size of the file in bytes. This field is populated for files with content stored in Google Drive and for files in Docs Editors; it is not populated for shortcut files.
1875 &quot;folderColorRgb&quot;: &quot;A String&quot;, # 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.
1876 &quot;fullFileExtension&quot;: &quot;A String&quot;, # The full file extension; extracted from the title. May contain multiple concatenated extensions, such as &quot;tar.gz&quot;. Removing an extension from the title does not clear this field; however, changing the extension on the title does update this field. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.
1877 &quot;hasAugmentedPermissions&quot;: True or False, # Whether there are permissions directly on this file. This field is only populated for items in shared drives.
1878 &quot;hasThumbnail&quot;: 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.
1879 &quot;headRevisionId&quot;: &quot;A String&quot;, # The ID of the file&#x27;s head revision. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.
1880 &quot;iconLink&quot;: &quot;A String&quot;, # A link to the file&#x27;s icon.
1881 &quot;id&quot;: &quot;A String&quot;, # The ID of the file.
1882 &quot;imageMediaMetadata&quot;: { # 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.
1883 &quot;aperture&quot;: 3.14, # The aperture used to create the photo (f-number).
1884 &quot;cameraMake&quot;: &quot;A String&quot;, # The make of the camera used to create the photo.
1885 &quot;cameraModel&quot;: &quot;A String&quot;, # The model of the camera used to create the photo.
1886 &quot;colorSpace&quot;: &quot;A String&quot;, # The color space of the photo.
1887 &quot;date&quot;: &quot;A String&quot;, # The date and time the photo was taken (EXIF format timestamp).
1888 &quot;exposureBias&quot;: 3.14, # The exposure bias of the photo (APEX value).
1889 &quot;exposureMode&quot;: &quot;A String&quot;, # The exposure mode used to create the photo.
1890 &quot;exposureTime&quot;: 3.14, # The length of the exposure, in seconds.
1891 &quot;flashUsed&quot;: True or False, # Whether a flash was used to create the photo.
1892 &quot;focalLength&quot;: 3.14, # The focal length used to create the photo, in millimeters.
1893 &quot;height&quot;: 42, # The height of the image in pixels.
1894 &quot;isoSpeed&quot;: 42, # The ISO speed used to create the photo.
1895 &quot;lens&quot;: &quot;A String&quot;, # The lens used to create the photo.
1896 &quot;location&quot;: { # Geographic location information stored in the image.
1897 &quot;altitude&quot;: 3.14, # The altitude stored in the image.
1898 &quot;latitude&quot;: 3.14, # The latitude stored in the image.
1899 &quot;longitude&quot;: 3.14, # The longitude stored in the image.
1900 },
1901 &quot;maxApertureValue&quot;: 3.14, # The smallest f-number of the lens at the focal length used to create the photo (APEX value).
1902 &quot;meteringMode&quot;: &quot;A String&quot;, # The metering mode used to create the photo.
1903 &quot;rotation&quot;: 42, # The number of clockwise 90 degree rotations applied from the image&#x27;s original orientation.
1904 &quot;sensor&quot;: &quot;A String&quot;, # The type of sensor used to create the photo.
1905 &quot;subjectDistance&quot;: 42, # The distance to the subject of the photo, in meters.
1906 &quot;whiteBalance&quot;: &quot;A String&quot;, # The white balance mode used to create the photo.
1907 &quot;width&quot;: 42, # The width of the image in pixels.
1908 },
1909 &quot;indexableText&quot;: { # Indexable text attributes for the file (can only be written)
1910 &quot;text&quot;: &quot;A String&quot;, # The text to be indexed for this file.
1911 },
1912 &quot;isAppAuthorized&quot;: True or False, # Whether the file was created or opened by the requesting app.
1913 &quot;kind&quot;: &quot;drive#file&quot;, # The type of file. This is always drive#file.
1914 &quot;labels&quot;: { # A group of labels for the file.
1915 &quot;hidden&quot;: True or False, # Deprecated.
1916 &quot;modified&quot;: True or False, # Whether the file has been modified by this user.
1917 &quot;restricted&quot;: True or False, # Deprecated - use copyRequiresWriterPermission instead.
1918 &quot;starred&quot;: True or False, # Whether this file is starred by the user.
1919 &quot;trashed&quot;: True or False, # Whether the file has been trashed, either explicitly or from a trashed parent folder. Only the owner may trash a file. The trashed item is excluded from all files.list responses returned for any user who does not own the file. However, all users with access to the file can see the trashed item metadata in an API response. All users with access can copy, download, export, and share the file.
1920 &quot;viewed&quot;: True or False, # Whether this file has been viewed by this user.
1921 },
1922 &quot;lastModifyingUser&quot;: { # Information about a Drive user. # The last user to modify this file.
1923 &quot;displayName&quot;: &quot;A String&quot;, # A plain text displayable name for this user.
1924 &quot;emailAddress&quot;: &quot;A String&quot;, # The email address of the user.
1925 &quot;isAuthenticatedUser&quot;: True or False, # Whether this user is the same as the authenticated user for whom the request was made.
1926 &quot;kind&quot;: &quot;drive#user&quot;, # This is always drive#user.
1927 &quot;permissionId&quot;: &quot;A String&quot;, # The user&#x27;s ID as visible in the permissions collection.
1928 &quot;picture&quot;: { # The user&#x27;s profile picture.
1929 &quot;url&quot;: &quot;A String&quot;, # A URL that points to a profile picture of this user.
1930 },
1931 },
1932 &quot;lastModifyingUserName&quot;: &quot;A String&quot;, # Name of the last user to modify this file.
1933 &quot;lastViewedByMeDate&quot;: &quot;A String&quot;, # Last time this file was viewed by the user (formatted RFC 3339 timestamp).
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700[diff] [blame^]1934 &quot;linkShareMetadata&quot;: { # Contains details about the link URLs that clients are using to refer to this item.
1935 &quot;securityUpdateEligible&quot;: True or False, # Whether the file is eligible for security update.
1936 &quot;securityUpdateEnabled&quot;: True or False, # Whether the security update is enabled for this file.
1937 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]1938 &quot;markedViewedByMeDate&quot;: &quot;A String&quot;, # Deprecated.
1939 &quot;md5Checksum&quot;: &quot;A String&quot;, # An MD5 checksum for the content of this file. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.
1940 &quot;mimeType&quot;: &quot;A String&quot;, # 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&#x27;s MIME type.
1941 &quot;modifiedByMeDate&quot;: &quot;A String&quot;, # 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.
1942 &quot;modifiedDate&quot;: &quot;A String&quot;, # Last time this file was modified by anyone (formatted RFC 3339 timestamp). This is only mutable on update when the setModifiedDate parameter is set.
1943 &quot;openWithLinks&quot;: { # A map of the id of each of the user&#x27;s apps to a link to open this file with that app. Only populated when the drive.apps.readonly scope is used.
1944 &quot;a_key&quot;: &quot;A String&quot;,
1945 },
1946 &quot;originalFilename&quot;: &quot;A String&quot;, # 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.
1947 &quot;ownedByMe&quot;: True or False, # Whether the file is owned by the current user. Not populated for items in shared drives.
1948 &quot;ownerNames&quot;: [ # Name(s) of the owner(s) of this file. Not populated for items in shared drives.
1949 &quot;A String&quot;,
1950 ],
yoshi-code-botab1d6dc2021-05-28 00:42:02 -0700[diff] [blame]1951 &quot;owners&quot;: [ # The owner of this file. Only certain legacy files may have more than one owner. This field isn&#x27;t populated for items in shared drives.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]1952 { # Information about a Drive user.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1953 &quot;displayName&quot;: &quot;A String&quot;, # A plain text displayable name for this user.
1954 &quot;emailAddress&quot;: &quot;A String&quot;, # The email address of the user.
1955 &quot;isAuthenticatedUser&quot;: True or False, # Whether this user is the same as the authenticated user for whom the request was made.
1956 &quot;kind&quot;: &quot;drive#user&quot;, # This is always drive#user.
1957 &quot;permissionId&quot;: &quot;A String&quot;, # The user&#x27;s ID as visible in the permissions collection.
1958 &quot;picture&quot;: { # The user&#x27;s profile picture.
1959 &quot;url&quot;: &quot;A String&quot;, # A URL that points to a profile picture of this user.
1960 },
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]1961 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]1962 ],
1963 &quot;parents&quot;: [ # Collection of parent folders which contain this file.
1964 # If not specified as part of an insert request, the file will be placed directly in the user&#x27;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.
1965 { # A reference to a file&#x27;s parent.
1966 &quot;id&quot;: &quot;A String&quot;, # The ID of the parent.
1967 &quot;isRoot&quot;: True or False, # Whether or not the parent is the root folder.
1968 &quot;kind&quot;: &quot;drive#parentReference&quot;, # This is always drive#parentReference.
1969 &quot;parentLink&quot;: &quot;A String&quot;, # A link to the parent.
1970 &quot;selfLink&quot;: &quot;A String&quot;, # A link back to this reference.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1971 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]1972 ],
1973 &quot;permissionIds&quot;: [ # List of permission IDs for users with access to this file.
1974 &quot;A String&quot;,
1975 ],
1976 &quot;permissions&quot;: [ # The list of permissions for users with access to this file. Not populated for items in shared drives.
1977 { # A permission for a file.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1978 &quot;additionalRoles&quot;: [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future.
1979 &quot;A String&quot;,
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1980 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1981 &quot;authKey&quot;: &quot;A String&quot;, # Deprecated.
1982 &quot;deleted&quot;: True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.
1983 &quot;domain&quot;: &quot;A String&quot;, # 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.
1984 &quot;emailAddress&quot;: &quot;A String&quot;, # 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.
1985 &quot;etag&quot;: &quot;A String&quot;, # The ETag of the permission.
1986 &quot;expirationDate&quot;: &quot;A String&quot;, # 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]1987 # - They cannot be set on shared drive items
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1988 # - They can only be set on user and group permissions
1989 # - The date must be in the future
1990 # - The date cannot be more than a year in the future
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1991 # - The date can only be set on drive.permissions.update or drive.permissions.patch requests
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1992 &quot;id&quot;: &quot;A String&quot;, # 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.
1993 &quot;kind&quot;: &quot;drive#permission&quot;, # This is always drive#permission.
1994 &quot;name&quot;: &quot;A String&quot;, # The name for this permission.
1995 &quot;permissionDetails&quot;: [ # 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.
1996 {
1997 &quot;additionalRoles&quot;: [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future.
1998 &quot;A String&quot;,
1999 ],
2000 &quot;inherited&quot;: True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field.
2001 &quot;inheritedFrom&quot;: &quot;A String&quot;, # The ID of the item from which this permission is inherited. This is an output-only field.
2002 &quot;permissionType&quot;: &quot;A String&quot;, # The permission type for this user. While new values may be added in future, the following are currently possible:
2003 # - file
2004 # - member
2005 &quot;role&quot;: &quot;A String&quot;, # The primary role for this user. While new values may be added in the future, the following are currently possible:
2006 # - organizer
2007 # - fileOrganizer
2008 # - writer
2009 # - reader
2010 },
2011 ],
2012 &quot;photoLink&quot;: &quot;A String&quot;, # A link to the profile photo, if available.
2013 &quot;role&quot;: &quot;A String&quot;, # 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]2014 # - owner
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2015 # - organizer
2016 # - fileOrganizer
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]2017 # - writer
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2018 # - reader
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]2019 &quot;selfLink&quot;: &quot;A String&quot;, # A link back to this permission.
2020 &quot;teamDrivePermissionDetails&quot;: [ # Deprecated - use permissionDetails instead.
2021 {
2022 &quot;additionalRoles&quot;: [ # Deprecated - use permissionDetails/additionalRoles instead.
2023 &quot;A String&quot;,
2024 ],
2025 &quot;inherited&quot;: True or False, # Deprecated - use permissionDetails/inherited instead.
2026 &quot;inheritedFrom&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/inheritedFrom instead.
2027 &quot;role&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/role instead.
2028 &quot;teamDrivePermissionType&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/permissionType instead.
2029 },
2030 ],
2031 &quot;type&quot;: &quot;A String&quot;, # The account type. Allowed values are:
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]2032 # - user
2033 # - group
2034 # - domain
2035 # - anyone
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]2036 &quot;value&quot;: &quot;A String&quot;, # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type is anyone, in which case both id and value are ignored.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]2037 &quot;view&quot;: &quot;A String&quot;, # Indicates the view for this permission. Only populated for permissions that belong to a view. published is the only supported value.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]2038 &quot;withLink&quot;: True or False, # Whether the link is required for this permission.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]2039 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]2040 ],
2041 &quot;properties&quot;: [ # The list of properties.
2042 { # A key-value pair attached to a file that is either public or private to an application.
2043 # The following limits apply to file properties:
2044 # - Maximum of 100 properties total per file
2045 # - Maximum of 30 private properties per app
2046 # - Maximum of 30 public properties
2047 # - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property.
2048 &quot;etag&quot;: &quot;A String&quot;, # ETag of the property.
2049 &quot;key&quot;: &quot;A String&quot;, # The key of this property.
2050 &quot;kind&quot;: &quot;drive#property&quot;, # This is always drive#property.
2051 &quot;selfLink&quot;: &quot;A String&quot;, # The link back to this property.
2052 &quot;value&quot;: &quot;A String&quot;, # The value of this property.
yoshi-code-bot69706592021-03-03 03:54:02 -0800[diff] [blame]2053 &quot;visibility&quot;: &quot;A String&quot;, # The visibility of this property. Allowed values are PRIVATE and PUBLIC. (Default: PRIVATE). Private properties can only be retrieved using an authenticated request. An authenticated request uses an access token obtained with a OAuth 2 client ID. You cannot use an API key to retrieve private properties.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]2054 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]2055 ],
2056 &quot;quotaBytesUsed&quot;: &quot;A String&quot;, # The number of quota bytes used by this file.
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700[diff] [blame^]2057 &quot;resourceKey&quot;: &quot;A String&quot;, # A key needed to access the item via a shared link.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]2058 &quot;selfLink&quot;: &quot;A String&quot;, # A link back to this file.
2059 &quot;shareable&quot;: True or False, # Deprecated: use capabilities/canShare.
2060 &quot;shared&quot;: True or False, # Whether the file has been shared. Not populated for items in shared drives.
2061 &quot;sharedWithMeDate&quot;: &quot;A String&quot;, # Time at which this file was shared with the user (formatted RFC 3339 timestamp).
2062 &quot;sharingUser&quot;: { # Information about a Drive user. # User that shared the item with the current user, if available.
2063 &quot;displayName&quot;: &quot;A String&quot;, # A plain text displayable name for this user.
2064 &quot;emailAddress&quot;: &quot;A String&quot;, # The email address of the user.
2065 &quot;isAuthenticatedUser&quot;: True or False, # Whether this user is the same as the authenticated user for whom the request was made.
2066 &quot;kind&quot;: &quot;drive#user&quot;, # This is always drive#user.
2067 &quot;permissionId&quot;: &quot;A String&quot;, # The user&#x27;s ID as visible in the permissions collection.
2068 &quot;picture&quot;: { # The user&#x27;s profile picture.
2069 &quot;url&quot;: &quot;A String&quot;, # A URL that points to a profile picture of this user.
2070 },
2071 },
2072 &quot;shortcutDetails&quot;: { # Shortcut file details. Only populated for shortcut files, which have the mimeType field set to application/vnd.google-apps.shortcut.
2073 &quot;targetId&quot;: &quot;A String&quot;, # The ID of the file that this shortcut points to.
2074 &quot;targetMimeType&quot;: &quot;A String&quot;, # The MIME type of the file that this shortcut points to. The value of this field is a snapshot of the target&#x27;s MIME type, captured when the shortcut is created.
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700[diff] [blame^]2075 &quot;targetResourceKey&quot;: &quot;A String&quot;, # The ResourceKey for the target file.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]2076 },
2077 &quot;spaces&quot;: [ # The list of spaces which contain the file. Supported values are &#x27;drive&#x27;, &#x27;appDataFolder&#x27; and &#x27;photos&#x27;.
2078 &quot;A String&quot;,
2079 ],
2080 &quot;teamDriveId&quot;: &quot;A String&quot;, # Deprecated - use driveId instead.
2081 &quot;thumbnail&quot;: { # A thumbnail for the file. This will only be used if a standard thumbnail cannot be generated.
2082 &quot;image&quot;: &quot;A String&quot;, # The URL-safe Base64 encoded bytes of the thumbnail image. It should conform to RFC 4648 section 5.
2083 &quot;mimeType&quot;: &quot;A String&quot;, # The MIME type of the thumbnail.
2084 },
2085 &quot;thumbnailLink&quot;: &quot;A String&quot;, # A short-lived link to the file&#x27;s thumbnail. Typically lasts on the order of hours. Only populated when the requesting app can access the file&#x27;s content. If the file isn&#x27;t shared publicly, the URL returned in Files.thumbnailLink must be fetched using a credentialed request.
2086 &quot;thumbnailVersion&quot;: &quot;A String&quot;, # The thumbnail version for use in thumbnail cache invalidation.
2087 &quot;title&quot;: &quot;A String&quot;, # 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.
2088 &quot;trashedDate&quot;: &quot;A String&quot;, # The time that the item was trashed (formatted RFC 3339 timestamp). Only populated for items in shared drives.
2089 &quot;trashingUser&quot;: { # Information about a Drive user. # If the file has been explicitly trashed, the user who trashed it. Only populated for items in shared drives.
2090 &quot;displayName&quot;: &quot;A String&quot;, # A plain text displayable name for this user.
2091 &quot;emailAddress&quot;: &quot;A String&quot;, # The email address of the user.
2092 &quot;isAuthenticatedUser&quot;: True or False, # Whether this user is the same as the authenticated user for whom the request was made.
2093 &quot;kind&quot;: &quot;drive#user&quot;, # This is always drive#user.
2094 &quot;permissionId&quot;: &quot;A String&quot;, # The user&#x27;s ID as visible in the permissions collection.
2095 &quot;picture&quot;: { # The user&#x27;s profile picture.
2096 &quot;url&quot;: &quot;A String&quot;, # A URL that points to a profile picture of this user.
2097 },
2098 },
2099 &quot;userPermission&quot;: { # A permission for a file. # The permissions for the authenticated user on this file.
2100 &quot;additionalRoles&quot;: [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future.
2101 &quot;A String&quot;,
2102 ],
2103 &quot;authKey&quot;: &quot;A String&quot;, # Deprecated.
2104 &quot;deleted&quot;: True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.
2105 &quot;domain&quot;: &quot;A String&quot;, # 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.
2106 &quot;emailAddress&quot;: &quot;A String&quot;, # 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.
2107 &quot;etag&quot;: &quot;A String&quot;, # The ETag of the permission.
2108 &quot;expirationDate&quot;: &quot;A String&quot;, # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions:
2109 # - They cannot be set on shared drive items
2110 # - They can only be set on user and group permissions
2111 # - The date must be in the future
2112 # - The date cannot be more than a year in the future
2113 # - The date can only be set on drive.permissions.update or drive.permissions.patch requests
2114 &quot;id&quot;: &quot;A String&quot;, # 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.
2115 &quot;kind&quot;: &quot;drive#permission&quot;, # This is always drive#permission.
2116 &quot;name&quot;: &quot;A String&quot;, # The name for this permission.
2117 &quot;permissionDetails&quot;: [ # 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.
2118 {
2119 &quot;additionalRoles&quot;: [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future.
2120 &quot;A String&quot;,
2121 ],
2122 &quot;inherited&quot;: True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field.
2123 &quot;inheritedFrom&quot;: &quot;A String&quot;, # The ID of the item from which this permission is inherited. This is an output-only field.
2124 &quot;permissionType&quot;: &quot;A String&quot;, # The permission type for this user. While new values may be added in future, the following are currently possible:
2125 # - file
2126 # - member
2127 &quot;role&quot;: &quot;A String&quot;, # The primary role for this user. While new values may be added in the future, the following are currently possible:
2128 # - organizer
2129 # - fileOrganizer
2130 # - writer
2131 # - reader
2132 },
2133 ],
2134 &quot;photoLink&quot;: &quot;A String&quot;, # A link to the profile photo, if available.
2135 &quot;role&quot;: &quot;A String&quot;, # The primary role for this user. While new values may be supported in the future, the following are currently allowed:
2136 # - owner
2137 # - organizer
2138 # - fileOrganizer
2139 # - writer
2140 # - reader
2141 &quot;selfLink&quot;: &quot;A String&quot;, # A link back to this permission.
2142 &quot;teamDrivePermissionDetails&quot;: [ # Deprecated - use permissionDetails instead.
2143 {
2144 &quot;additionalRoles&quot;: [ # Deprecated - use permissionDetails/additionalRoles instead.
2145 &quot;A String&quot;,
2146 ],
2147 &quot;inherited&quot;: True or False, # Deprecated - use permissionDetails/inherited instead.
2148 &quot;inheritedFrom&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/inheritedFrom instead.
2149 &quot;role&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/role instead.
2150 &quot;teamDrivePermissionType&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/permissionType instead.
2151 },
2152 ],
2153 &quot;type&quot;: &quot;A String&quot;, # The account type. Allowed values are:
2154 # - user
2155 # - group
2156 # - domain
2157 # - anyone
2158 &quot;value&quot;: &quot;A String&quot;, # 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.
2159 &quot;view&quot;: &quot;A String&quot;, # Indicates the view for this permission. Only populated for permissions that belong to a view. published is the only supported value.
2160 &quot;withLink&quot;: True or False, # Whether the link is required for this permission.
2161 },
2162 &quot;version&quot;: &quot;A String&quot;, # 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.
2163 &quot;videoMediaMetadata&quot;: { # Metadata about video media. This will only be present for video types.
2164 &quot;durationMillis&quot;: &quot;A String&quot;, # The duration of the video in milliseconds.
2165 &quot;height&quot;: 42, # The height of the video in pixels.
2166 &quot;width&quot;: 42, # The width of the video in pixels.
2167 },
2168 &quot;webContentLink&quot;: &quot;A String&quot;, # 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.
2169 &quot;webViewLink&quot;: &quot;A String&quot;, # A link only available on public folders for viewing their static web assets (HTML, CSS, JS, etc) via Google Drive&#x27;s Website Hosting.
2170 &quot;writersCanShare&quot;: True or False, # Whether writers can share the document with other users. Not populated for items in shared drives.
2171}</pre>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]2172</div>
2173
2174<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]2175 <code class="details" id="list">list(corpora=None, corpus=None, driveId=None, includeItemsFromAllDrives=None, includePermissionsForView=None, includeTeamDriveItems=None, maxResults=None, orderBy=None, pageToken=None, projection=None, q=None, spaces=None, supportsAllDrives=None, supportsTeamDrives=None, teamDriveId=None)</code>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]2176 <pre>Lists the user&#x27;s files.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]2177
2178Args:
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]2179 corpora: string, Groupings of files to which the query applies. Supported groupings are: &#x27;user&#x27; (files created by, opened by, or shared directly with the user), &#x27;drive&#x27; (files in the specified shared drive as indicated by the &#x27;driveId&#x27;), &#x27;domain&#x27; (files shared to the user&#x27;s domain), and &#x27;allDrives&#x27; (A combination of &#x27;user&#x27; and &#x27;drive&#x27; for all drives where the user is a member). When able, use &#x27;user&#x27; or &#x27;drive&#x27;, instead of &#x27;allDrives&#x27;, for efficiency.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]2180 corpus: string, The body of items (files/documents) to which the query applies. Deprecated: use &#x27;corpora&#x27; instead.
2181 Allowed values
2182 DEFAULT - The items that the user has accessed.
2183 DOMAIN - Items shared to the user&#x27;s domain.
2184 driveId: string, ID of the shared drive to search.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]2185 includeItemsFromAllDrives: boolean, Whether both My Drive and shared drive items should be included in results.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]2186 includePermissionsForView: string, Specifies which additional view&#x27;s permissions to include in the response. Only &#x27;published&#x27; is supported.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]2187 includeTeamDriveItems: boolean, Deprecated use includeItemsFromAllDrives instead.
2188 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.
2189 orderBy: string, A comma-separated list of sort keys. Valid keys are &#x27;createdDate&#x27;, &#x27;folder&#x27;, &#x27;lastViewedByMeDate&#x27;, &#x27;modifiedByMeDate&#x27;, &#x27;modifiedDate&#x27;, &#x27;quotaBytesUsed&#x27;, &#x27;recency&#x27;, &#x27;sharedWithMeDate&#x27;, &#x27;starred&#x27;, &#x27;title&#x27;, and &#x27;title_natural&#x27;. Each key sorts ascending by default, but may be reversed with the &#x27;desc&#x27; 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.
2190 pageToken: string, Page token for files.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]2191 projection: string, This parameter is deprecated and has no function.
2192 Allowed values
2193 BASIC - Deprecated
2194 FULL - Deprecated
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2195 q: string, Query string for searching files.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]2196 spaces: string, A comma-separated list of spaces to query. Supported values are &#x27;drive&#x27;, &#x27;appDataFolder&#x27; and &#x27;photos&#x27;.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]2197 supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]2198 supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead.
2199 teamDriveId: string, Deprecated use driveId instead.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]2200
2201Returns:
2202 An object of the form:
2203
2204 { # A list of files.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]2205 &quot;etag&quot;: &quot;A String&quot;, # The ETag of the list.
2206 &quot;incompleteSearch&quot;: 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 &quot;allDrives&quot; 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 &quot;default&quot; or &quot;drive&quot;.
2207 &quot;items&quot;: [ # The list of files. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched.
2208 { # The metadata for a file.
2209 &quot;alternateLink&quot;: &quot;A String&quot;, # A link for opening the file in a relevant Google editor or viewer.
2210 &quot;appDataContents&quot;: True or False, # Whether this file is in the Application Data folder.
2211 &quot;canComment&quot;: True or False, # Deprecated: use capabilities/canComment.
2212 &quot;canReadRevisions&quot;: True or False, # Deprecated: use capabilities/canReadRevisions.
2213 &quot;capabilities&quot;: { # Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take.
2214 &quot;canAddChildren&quot;: True or False, # Whether the current user can add children to this folder. This is always false when the item is not a folder.
2215 &quot;canAddFolderFromAnotherDrive&quot;: True or False, # Whether the current user can add a folder from another drive (different shared drive or My Drive) to this folder. This is false when the item is not a folder. Only populated for items in shared drives.
2216 &quot;canAddMyDriveParent&quot;: 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.
2217 &quot;canChangeCopyRequiresWriterPermission&quot;: True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this file.
2218 &quot;canChangeRestrictedDownload&quot;: True or False, # Deprecated
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700[diff] [blame^]2219 &quot;canChangeSecurityUpdateEnabled&quot;: True or False, # Whether the current user can change the securityUpdateEnabled field on link share metadata.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]2220 &quot;canComment&quot;: True or False, # Whether the current user can comment on this file.
2221 &quot;canCopy&quot;: 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.
2222 &quot;canDelete&quot;: True or False, # Whether the current user can delete this file.
2223 &quot;canDeleteChildren&quot;: 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.
2224 &quot;canDownload&quot;: True or False, # Whether the current user can download this file.
2225 &quot;canEdit&quot;: 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.
2226 &quot;canListChildren&quot;: 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.
2227 &quot;canModifyContent&quot;: True or False, # Whether the current user can modify the content of this file.
2228 &quot;canModifyContentRestriction&quot;: True or False, # Whether the current user can modify restrictions on content of this file.
2229 &quot;canMoveChildrenOutOfDrive&quot;: 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.
2230 &quot;canMoveChildrenOutOfTeamDrive&quot;: True or False, # Deprecated - use canMoveChildrenOutOfDrive instead.
2231 &quot;canMoveChildrenWithinDrive&quot;: True or False, # Whether the current user can move children of this folder within this drive. This is false when the item is not a folder. Note that a request to move the child may still fail depending on the current user&#x27;s access to the child and to the destination folder.
2232 &quot;canMoveChildrenWithinTeamDrive&quot;: True or False, # Deprecated - use canMoveChildrenWithinDrive instead.
2233 &quot;canMoveItemIntoTeamDrive&quot;: True or False, # Deprecated - use canMoveItemOutOfDrive instead.
2234 &quot;canMoveItemOutOfDrive&quot;: 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.
2235 &quot;canMoveItemOutOfTeamDrive&quot;: True or False, # Deprecated - use canMoveItemOutOfDrive instead.
2236 &quot;canMoveItemWithinDrive&quot;: True or False, # Whether the current user can move this item within this drive. Note that a request to change the parent of the item may still fail depending on the new parent that is being added and the parent that is being removed.
2237 &quot;canMoveItemWithinTeamDrive&quot;: True or False, # Deprecated - use canMoveItemWithinDrive instead.
2238 &quot;canMoveTeamDriveItem&quot;: True or False, # Deprecated - use canMoveItemWithinDrive or canMoveItemOutOfDrive instead.
2239 &quot;canReadDrive&quot;: True or False, # Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives.
2240 &quot;canReadRevisions&quot;: 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.
2241 &quot;canReadTeamDrive&quot;: True or False, # Deprecated - use canReadDrive instead.
2242 &quot;canRemoveChildren&quot;: 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.
2243 &quot;canRemoveMyDriveParent&quot;: 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.
2244 &quot;canRename&quot;: True or False, # Whether the current user can rename this file.
2245 &quot;canShare&quot;: True or False, # Whether the current user can modify the sharing settings for this file.
2246 &quot;canTrash&quot;: True or False, # Whether the current user can move this file to trash.
2247 &quot;canTrashChildren&quot;: 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.
2248 &quot;canUntrash&quot;: True or False, # Whether the current user can restore this file from trash.
2249 },
2250 &quot;contentRestrictions&quot;: [ # Restrictions for accessing the content of the file. Only populated if such a restriction exists.
2251 { # A restriction for accessing the content of the file.
2252 &quot;readOnly&quot;: True or False, # Whether the content of the file is read-only. If a file is read-only, a new revision of the file may not be added, comments may not be added or modified, and the title of the file may not be modified.
2253 &quot;reason&quot;: &quot;A String&quot;, # Reason for why the content of the file is restricted. This is only mutable on requests that also set readOnly=true.
2254 &quot;restrictingUser&quot;: { # Information about a Drive user. # The user who set the content restriction. Only populated if readOnly is true.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]2255 &quot;displayName&quot;: &quot;A String&quot;, # A plain text displayable name for this user.
2256 &quot;emailAddress&quot;: &quot;A String&quot;, # The email address of the user.
2257 &quot;isAuthenticatedUser&quot;: True or False, # Whether this user is the same as the authenticated user for whom the request was made.
2258 &quot;kind&quot;: &quot;drive#user&quot;, # This is always drive#user.
2259 &quot;permissionId&quot;: &quot;A String&quot;, # The user&#x27;s ID as visible in the permissions collection.
2260 &quot;picture&quot;: { # The user&#x27;s profile picture.
2261 &quot;url&quot;: &quot;A String&quot;, # A URL that points to a profile picture of this user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]2262 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]2263 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]2264 &quot;restrictionDate&quot;: &quot;A String&quot;, # The time at which the content restriction was set (formatted RFC 3339 timestamp). Only populated if readOnly is true.
2265 &quot;type&quot;: &quot;A String&quot;, # The type of the content restriction. Currently the only possible value is globalContentRestriction.
2266 },
2267 ],
2268 &quot;copyRequiresWriterPermission&quot;: True or False, # Whether the options to copy, print, or download this file, should be disabled for readers and commenters.
2269 &quot;copyable&quot;: True or False, # Deprecated: use capabilities/canCopy.
2270 &quot;createdDate&quot;: &quot;A String&quot;, # Create time for this file (formatted RFC 3339 timestamp).
2271 &quot;defaultOpenWithLink&quot;: &quot;A String&quot;, # A link to open this file with the user&#x27;s default app for this file. Only populated when the drive.apps.readonly scope is used.
2272 &quot;description&quot;: &quot;A String&quot;, # A short description of the file.
2273 &quot;downloadUrl&quot;: &quot;A String&quot;, # Short lived download URL for the file. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.
2274 &quot;driveId&quot;: &quot;A String&quot;, # ID of the shared drive the file resides in. Only populated for items in shared drives.
2275 &quot;editable&quot;: True or False, # Deprecated: use capabilities/canEdit.
2276 &quot;embedLink&quot;: &quot;A String&quot;, # A link for embedding the file.
2277 &quot;etag&quot;: &quot;A String&quot;, # ETag of the file.
2278 &quot;explicitlyTrashed&quot;: True or False, # Whether this file has been explicitly trashed, as opposed to recursively trashed.
2279 &quot;exportLinks&quot;: { # Links for exporting Docs Editors files to specific formats.
2280 &quot;a_key&quot;: &quot;A String&quot;, # A mapping from export format to URL
2281 },
2282 &quot;fileExtension&quot;: &quot;A String&quot;, # The final component of fullFileExtension with trailing text that does not appear to be part of the extension removed. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.
2283 &quot;fileSize&quot;: &quot;A String&quot;, # The size of the file in bytes. This field is populated for files with content stored in Google Drive and for files in Docs Editors; it is not populated for shortcut files.
2284 &quot;folderColorRgb&quot;: &quot;A String&quot;, # 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.
2285 &quot;fullFileExtension&quot;: &quot;A String&quot;, # The full file extension; extracted from the title. May contain multiple concatenated extensions, such as &quot;tar.gz&quot;. Removing an extension from the title does not clear this field; however, changing the extension on the title does update this field. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.
2286 &quot;hasAugmentedPermissions&quot;: True or False, # Whether there are permissions directly on this file. This field is only populated for items in shared drives.
2287 &quot;hasThumbnail&quot;: 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.
2288 &quot;headRevisionId&quot;: &quot;A String&quot;, # The ID of the file&#x27;s head revision. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.
2289 &quot;iconLink&quot;: &quot;A String&quot;, # A link to the file&#x27;s icon.
2290 &quot;id&quot;: &quot;A String&quot;, # The ID of the file.
2291 &quot;imageMediaMetadata&quot;: { # 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.
2292 &quot;aperture&quot;: 3.14, # The aperture used to create the photo (f-number).
2293 &quot;cameraMake&quot;: &quot;A String&quot;, # The make of the camera used to create the photo.
2294 &quot;cameraModel&quot;: &quot;A String&quot;, # The model of the camera used to create the photo.
2295 &quot;colorSpace&quot;: &quot;A String&quot;, # The color space of the photo.
2296 &quot;date&quot;: &quot;A String&quot;, # The date and time the photo was taken (EXIF format timestamp).
2297 &quot;exposureBias&quot;: 3.14, # The exposure bias of the photo (APEX value).
2298 &quot;exposureMode&quot;: &quot;A String&quot;, # The exposure mode used to create the photo.
2299 &quot;exposureTime&quot;: 3.14, # The length of the exposure, in seconds.
2300 &quot;flashUsed&quot;: True or False, # Whether a flash was used to create the photo.
2301 &quot;focalLength&quot;: 3.14, # The focal length used to create the photo, in millimeters.
2302 &quot;height&quot;: 42, # The height of the image in pixels.
2303 &quot;isoSpeed&quot;: 42, # The ISO speed used to create the photo.
2304 &quot;lens&quot;: &quot;A String&quot;, # The lens used to create the photo.
2305 &quot;location&quot;: { # Geographic location information stored in the image.
2306 &quot;altitude&quot;: 3.14, # The altitude stored in the image.
2307 &quot;latitude&quot;: 3.14, # The latitude stored in the image.
2308 &quot;longitude&quot;: 3.14, # The longitude stored in the image.
2309 },
2310 &quot;maxApertureValue&quot;: 3.14, # The smallest f-number of the lens at the focal length used to create the photo (APEX value).
2311 &quot;meteringMode&quot;: &quot;A String&quot;, # The metering mode used to create the photo.
2312 &quot;rotation&quot;: 42, # The number of clockwise 90 degree rotations applied from the image&#x27;s original orientation.
2313 &quot;sensor&quot;: &quot;A String&quot;, # The type of sensor used to create the photo.
2314 &quot;subjectDistance&quot;: 42, # The distance to the subject of the photo, in meters.
2315 &quot;whiteBalance&quot;: &quot;A String&quot;, # The white balance mode used to create the photo.
2316 &quot;width&quot;: 42, # The width of the image in pixels.
2317 },
2318 &quot;indexableText&quot;: { # Indexable text attributes for the file (can only be written)
2319 &quot;text&quot;: &quot;A String&quot;, # The text to be indexed for this file.
2320 },
2321 &quot;isAppAuthorized&quot;: True or False, # Whether the file was created or opened by the requesting app.
2322 &quot;kind&quot;: &quot;drive#file&quot;, # The type of file. This is always drive#file.
2323 &quot;labels&quot;: { # A group of labels for the file.
2324 &quot;hidden&quot;: True or False, # Deprecated.
2325 &quot;modified&quot;: True or False, # Whether the file has been modified by this user.
2326 &quot;restricted&quot;: True or False, # Deprecated - use copyRequiresWriterPermission instead.
2327 &quot;starred&quot;: True or False, # Whether this file is starred by the user.
2328 &quot;trashed&quot;: True or False, # Whether the file has been trashed, either explicitly or from a trashed parent folder. Only the owner may trash a file. The trashed item is excluded from all files.list responses returned for any user who does not own the file. However, all users with access to the file can see the trashed item metadata in an API response. All users with access can copy, download, export, and share the file.
2329 &quot;viewed&quot;: True or False, # Whether this file has been viewed by this user.
2330 },
2331 &quot;lastModifyingUser&quot;: { # Information about a Drive user. # The last user to modify this file.
2332 &quot;displayName&quot;: &quot;A String&quot;, # A plain text displayable name for this user.
2333 &quot;emailAddress&quot;: &quot;A String&quot;, # The email address of the user.
2334 &quot;isAuthenticatedUser&quot;: True or False, # Whether this user is the same as the authenticated user for whom the request was made.
2335 &quot;kind&quot;: &quot;drive#user&quot;, # This is always drive#user.
2336 &quot;permissionId&quot;: &quot;A String&quot;, # The user&#x27;s ID as visible in the permissions collection.
2337 &quot;picture&quot;: { # The user&#x27;s profile picture.
2338 &quot;url&quot;: &quot;A String&quot;, # A URL that points to a profile picture of this user.
2339 },
2340 },
2341 &quot;lastModifyingUserName&quot;: &quot;A String&quot;, # Name of the last user to modify this file.
2342 &quot;lastViewedByMeDate&quot;: &quot;A String&quot;, # Last time this file was viewed by the user (formatted RFC 3339 timestamp).
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700[diff] [blame^]2343 &quot;linkShareMetadata&quot;: { # Contains details about the link URLs that clients are using to refer to this item.
2344 &quot;securityUpdateEligible&quot;: True or False, # Whether the file is eligible for security update.
2345 &quot;securityUpdateEnabled&quot;: True or False, # Whether the security update is enabled for this file.
2346 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]2347 &quot;markedViewedByMeDate&quot;: &quot;A String&quot;, # Deprecated.
2348 &quot;md5Checksum&quot;: &quot;A String&quot;, # An MD5 checksum for the content of this file. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.
2349 &quot;mimeType&quot;: &quot;A String&quot;, # 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&#x27;s MIME type.
2350 &quot;modifiedByMeDate&quot;: &quot;A String&quot;, # 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.
2351 &quot;modifiedDate&quot;: &quot;A String&quot;, # Last time this file was modified by anyone (formatted RFC 3339 timestamp). This is only mutable on update when the setModifiedDate parameter is set.
2352 &quot;openWithLinks&quot;: { # A map of the id of each of the user&#x27;s apps to a link to open this file with that app. Only populated when the drive.apps.readonly scope is used.
2353 &quot;a_key&quot;: &quot;A String&quot;,
2354 },
2355 &quot;originalFilename&quot;: &quot;A String&quot;, # 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.
2356 &quot;ownedByMe&quot;: True or False, # Whether the file is owned by the current user. Not populated for items in shared drives.
2357 &quot;ownerNames&quot;: [ # Name(s) of the owner(s) of this file. Not populated for items in shared drives.
2358 &quot;A String&quot;,
2359 ],
yoshi-code-botab1d6dc2021-05-28 00:42:02 -0700[diff] [blame]2360 &quot;owners&quot;: [ # The owner of this file. Only certain legacy files may have more than one owner. This field isn&#x27;t populated for items in shared drives.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]2361 { # Information about a Drive user.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]2362 &quot;displayName&quot;: &quot;A String&quot;, # A plain text displayable name for this user.
2363 &quot;emailAddress&quot;: &quot;A String&quot;, # The email address of the user.
2364 &quot;isAuthenticatedUser&quot;: True or False, # Whether this user is the same as the authenticated user for whom the request was made.
2365 &quot;kind&quot;: &quot;drive#user&quot;, # This is always drive#user.
2366 &quot;permissionId&quot;: &quot;A String&quot;, # The user&#x27;s ID as visible in the permissions collection.
2367 &quot;picture&quot;: { # The user&#x27;s profile picture.
2368 &quot;url&quot;: &quot;A String&quot;, # A URL that points to a profile picture of this user.
2369 },
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]2370 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]2371 ],
2372 &quot;parents&quot;: [ # Collection of parent folders which contain this file.
2373 # If not specified as part of an insert request, the file will be placed directly in the user&#x27;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.
2374 { # A reference to a file&#x27;s parent.
2375 &quot;id&quot;: &quot;A String&quot;, # The ID of the parent.
2376 &quot;isRoot&quot;: True or False, # Whether or not the parent is the root folder.
2377 &quot;kind&quot;: &quot;drive#parentReference&quot;, # This is always drive#parentReference.
2378 &quot;parentLink&quot;: &quot;A String&quot;, # A link to the parent.
2379 &quot;selfLink&quot;: &quot;A String&quot;, # A link back to this reference.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]2380 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]2381 ],
2382 &quot;permissionIds&quot;: [ # List of permission IDs for users with access to this file.
2383 &quot;A String&quot;,
2384 ],
2385 &quot;permissions&quot;: [ # The list of permissions for users with access to this file. Not populated for items in shared drives.
2386 { # A permission for a file.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]2387 &quot;additionalRoles&quot;: [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future.
2388 &quot;A String&quot;,
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]2389 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]2390 &quot;authKey&quot;: &quot;A String&quot;, # Deprecated.
2391 &quot;deleted&quot;: True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.
2392 &quot;domain&quot;: &quot;A String&quot;, # 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.
2393 &quot;emailAddress&quot;: &quot;A String&quot;, # 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.
2394 &quot;etag&quot;: &quot;A String&quot;, # The ETag of the permission.
2395 &quot;expirationDate&quot;: &quot;A String&quot;, # 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]2396 # - They cannot be set on shared drive items
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]2397 # - They can only be set on user and group permissions
2398 # - The date must be in the future
2399 # - The date cannot be more than a year in the future
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2400 # - The date can only be set on drive.permissions.update or drive.permissions.patch requests
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]2401 &quot;id&quot;: &quot;A String&quot;, # 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.
2402 &quot;kind&quot;: &quot;drive#permission&quot;, # This is always drive#permission.
2403 &quot;name&quot;: &quot;A String&quot;, # The name for this permission.
2404 &quot;permissionDetails&quot;: [ # 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.
2405 {
2406 &quot;additionalRoles&quot;: [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future.
2407 &quot;A String&quot;,
2408 ],
2409 &quot;inherited&quot;: True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field.
2410 &quot;inheritedFrom&quot;: &quot;A String&quot;, # The ID of the item from which this permission is inherited. This is an output-only field.
2411 &quot;permissionType&quot;: &quot;A String&quot;, # The permission type for this user. While new values may be added in future, the following are currently possible:
2412 # - file
2413 # - member
2414 &quot;role&quot;: &quot;A String&quot;, # The primary role for this user. While new values may be added in the future, the following are currently possible:
2415 # - organizer
2416 # - fileOrganizer
2417 # - writer
2418 # - reader
2419 },
2420 ],
2421 &quot;photoLink&quot;: &quot;A String&quot;, # A link to the profile photo, if available.
2422 &quot;role&quot;: &quot;A String&quot;, # 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]2423 # - owner
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2424 # - organizer
2425 # - fileOrganizer
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]2426 # - writer
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2427 # - reader
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]2428 &quot;selfLink&quot;: &quot;A String&quot;, # A link back to this permission.
2429 &quot;teamDrivePermissionDetails&quot;: [ # Deprecated - use permissionDetails instead.
2430 {
2431 &quot;additionalRoles&quot;: [ # Deprecated - use permissionDetails/additionalRoles instead.
2432 &quot;A String&quot;,
2433 ],
2434 &quot;inherited&quot;: True or False, # Deprecated - use permissionDetails/inherited instead.
2435 &quot;inheritedFrom&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/inheritedFrom instead.
2436 &quot;role&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/role instead.
2437 &quot;teamDrivePermissionType&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/permissionType instead.
2438 },
2439 ],
2440 &quot;type&quot;: &quot;A String&quot;, # The account type. Allowed values are:
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]2441 # - user
2442 # - group
2443 # - domain
2444 # - anyone
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]2445 &quot;value&quot;: &quot;A String&quot;, # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type is anyone, in which case both id and value are ignored.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]2446 &quot;view&quot;: &quot;A String&quot;, # Indicates the view for this permission. Only populated for permissions that belong to a view. published is the only supported value.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]2447 &quot;withLink&quot;: True or False, # Whether the link is required for this permission.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]2448 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]2449 ],
2450 &quot;properties&quot;: [ # The list of properties.
2451 { # A key-value pair attached to a file that is either public or private to an application.
2452 # The following limits apply to file properties:
2453 # - Maximum of 100 properties total per file
2454 # - Maximum of 30 private properties per app
2455 # - Maximum of 30 public properties
2456 # - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property.
2457 &quot;etag&quot;: &quot;A String&quot;, # ETag of the property.
2458 &quot;key&quot;: &quot;A String&quot;, # The key of this property.
2459 &quot;kind&quot;: &quot;drive#property&quot;, # This is always drive#property.
2460 &quot;selfLink&quot;: &quot;A String&quot;, # The link back to this property.
2461 &quot;value&quot;: &quot;A String&quot;, # The value of this property.
yoshi-code-bot69706592021-03-03 03:54:02 -0800[diff] [blame]2462 &quot;visibility&quot;: &quot;A String&quot;, # The visibility of this property. Allowed values are PRIVATE and PUBLIC. (Default: PRIVATE). Private properties can only be retrieved using an authenticated request. An authenticated request uses an access token obtained with a OAuth 2 client ID. You cannot use an API key to retrieve private properties.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]2463 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]2464 ],
2465 &quot;quotaBytesUsed&quot;: &quot;A String&quot;, # The number of quota bytes used by this file.
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700[diff] [blame^]2466 &quot;resourceKey&quot;: &quot;A String&quot;, # A key needed to access the item via a shared link.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]2467 &quot;selfLink&quot;: &quot;A String&quot;, # A link back to this file.
2468 &quot;shareable&quot;: True or False, # Deprecated: use capabilities/canShare.
2469 &quot;shared&quot;: True or False, # Whether the file has been shared. Not populated for items in shared drives.
2470 &quot;sharedWithMeDate&quot;: &quot;A String&quot;, # Time at which this file was shared with the user (formatted RFC 3339 timestamp).
2471 &quot;sharingUser&quot;: { # Information about a Drive user. # User that shared the item with the current user, if available.
2472 &quot;displayName&quot;: &quot;A String&quot;, # A plain text displayable name for this user.
2473 &quot;emailAddress&quot;: &quot;A String&quot;, # The email address of the user.
2474 &quot;isAuthenticatedUser&quot;: True or False, # Whether this user is the same as the authenticated user for whom the request was made.
2475 &quot;kind&quot;: &quot;drive#user&quot;, # This is always drive#user.
2476 &quot;permissionId&quot;: &quot;A String&quot;, # The user&#x27;s ID as visible in the permissions collection.
2477 &quot;picture&quot;: { # The user&#x27;s profile picture.
2478 &quot;url&quot;: &quot;A String&quot;, # A URL that points to a profile picture of this user.
2479 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]2480 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]2481 &quot;shortcutDetails&quot;: { # Shortcut file details. Only populated for shortcut files, which have the mimeType field set to application/vnd.google-apps.shortcut.
2482 &quot;targetId&quot;: &quot;A String&quot;, # The ID of the file that this shortcut points to.
2483 &quot;targetMimeType&quot;: &quot;A String&quot;, # The MIME type of the file that this shortcut points to. The value of this field is a snapshot of the target&#x27;s MIME type, captured when the shortcut is created.
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700[diff] [blame^]2484 &quot;targetResourceKey&quot;: &quot;A String&quot;, # The ResourceKey for the target file.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]2485 },
2486 &quot;spaces&quot;: [ # The list of spaces which contain the file. Supported values are &#x27;drive&#x27;, &#x27;appDataFolder&#x27; and &#x27;photos&#x27;.
2487 &quot;A String&quot;,
2488 ],
2489 &quot;teamDriveId&quot;: &quot;A String&quot;, # Deprecated - use driveId instead.
2490 &quot;thumbnail&quot;: { # A thumbnail for the file. This will only be used if a standard thumbnail cannot be generated.
2491 &quot;image&quot;: &quot;A String&quot;, # The URL-safe Base64 encoded bytes of the thumbnail image. It should conform to RFC 4648 section 5.
2492 &quot;mimeType&quot;: &quot;A String&quot;, # The MIME type of the thumbnail.
2493 },
2494 &quot;thumbnailLink&quot;: &quot;A String&quot;, # A short-lived link to the file&#x27;s thumbnail. Typically lasts on the order of hours. Only populated when the requesting app can access the file&#x27;s content. If the file isn&#x27;t shared publicly, the URL returned in Files.thumbnailLink must be fetched using a credentialed request.
2495 &quot;thumbnailVersion&quot;: &quot;A String&quot;, # The thumbnail version for use in thumbnail cache invalidation.
2496 &quot;title&quot;: &quot;A String&quot;, # 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.
2497 &quot;trashedDate&quot;: &quot;A String&quot;, # The time that the item was trashed (formatted RFC 3339 timestamp). Only populated for items in shared drives.
2498 &quot;trashingUser&quot;: { # Information about a Drive user. # If the file has been explicitly trashed, the user who trashed it. Only populated for items in shared drives.
2499 &quot;displayName&quot;: &quot;A String&quot;, # A plain text displayable name for this user.
2500 &quot;emailAddress&quot;: &quot;A String&quot;, # The email address of the user.
2501 &quot;isAuthenticatedUser&quot;: True or False, # Whether this user is the same as the authenticated user for whom the request was made.
2502 &quot;kind&quot;: &quot;drive#user&quot;, # This is always drive#user.
2503 &quot;permissionId&quot;: &quot;A String&quot;, # The user&#x27;s ID as visible in the permissions collection.
2504 &quot;picture&quot;: { # The user&#x27;s profile picture.
2505 &quot;url&quot;: &quot;A String&quot;, # A URL that points to a profile picture of this user.
2506 },
2507 },
2508 &quot;userPermission&quot;: { # A permission for a file. # The permissions for the authenticated user on this file.
2509 &quot;additionalRoles&quot;: [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future.
2510 &quot;A String&quot;,
2511 ],
2512 &quot;authKey&quot;: &quot;A String&quot;, # Deprecated.
2513 &quot;deleted&quot;: True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.
2514 &quot;domain&quot;: &quot;A String&quot;, # 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.
2515 &quot;emailAddress&quot;: &quot;A String&quot;, # 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.
2516 &quot;etag&quot;: &quot;A String&quot;, # The ETag of the permission.
2517 &quot;expirationDate&quot;: &quot;A String&quot;, # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions:
2518 # - They cannot be set on shared drive items
2519 # - They can only be set on user and group permissions
2520 # - The date must be in the future
2521 # - The date cannot be more than a year in the future
2522 # - The date can only be set on drive.permissions.update or drive.permissions.patch requests
2523 &quot;id&quot;: &quot;A String&quot;, # 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.
2524 &quot;kind&quot;: &quot;drive#permission&quot;, # This is always drive#permission.
2525 &quot;name&quot;: &quot;A String&quot;, # The name for this permission.
2526 &quot;permissionDetails&quot;: [ # 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.
2527 {
2528 &quot;additionalRoles&quot;: [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future.
2529 &quot;A String&quot;,
2530 ],
2531 &quot;inherited&quot;: True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field.
2532 &quot;inheritedFrom&quot;: &quot;A String&quot;, # The ID of the item from which this permission is inherited. This is an output-only field.
2533 &quot;permissionType&quot;: &quot;A String&quot;, # The permission type for this user. While new values may be added in future, the following are currently possible:
2534 # - file
2535 # - member
2536 &quot;role&quot;: &quot;A String&quot;, # The primary role for this user. While new values may be added in the future, the following are currently possible:
2537 # - organizer
2538 # - fileOrganizer
2539 # - writer
2540 # - reader
2541 },
2542 ],
2543 &quot;photoLink&quot;: &quot;A String&quot;, # A link to the profile photo, if available.
2544 &quot;role&quot;: &quot;A String&quot;, # The primary role for this user. While new values may be supported in the future, the following are currently allowed:
2545 # - owner
2546 # - organizer
2547 # - fileOrganizer
2548 # - writer
2549 # - reader
2550 &quot;selfLink&quot;: &quot;A String&quot;, # A link back to this permission.
2551 &quot;teamDrivePermissionDetails&quot;: [ # Deprecated - use permissionDetails instead.
2552 {
2553 &quot;additionalRoles&quot;: [ # Deprecated - use permissionDetails/additionalRoles instead.
2554 &quot;A String&quot;,
2555 ],
2556 &quot;inherited&quot;: True or False, # Deprecated - use permissionDetails/inherited instead.
2557 &quot;inheritedFrom&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/inheritedFrom instead.
2558 &quot;role&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/role instead.
2559 &quot;teamDrivePermissionType&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/permissionType instead.
2560 },
2561 ],
2562 &quot;type&quot;: &quot;A String&quot;, # The account type. Allowed values are:
2563 # - user
2564 # - group
2565 # - domain
2566 # - anyone
2567 &quot;value&quot;: &quot;A String&quot;, # 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.
2568 &quot;view&quot;: &quot;A String&quot;, # Indicates the view for this permission. Only populated for permissions that belong to a view. published is the only supported value.
2569 &quot;withLink&quot;: True or False, # Whether the link is required for this permission.
2570 },
2571 &quot;version&quot;: &quot;A String&quot;, # 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.
2572 &quot;videoMediaMetadata&quot;: { # Metadata about video media. This will only be present for video types.
2573 &quot;durationMillis&quot;: &quot;A String&quot;, # The duration of the video in milliseconds.
2574 &quot;height&quot;: 42, # The height of the video in pixels.
2575 &quot;width&quot;: 42, # The width of the video in pixels.
2576 },
2577 &quot;webContentLink&quot;: &quot;A String&quot;, # 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.
2578 &quot;webViewLink&quot;: &quot;A String&quot;, # A link only available on public folders for viewing their static web assets (HTML, CSS, JS, etc) via Google Drive&#x27;s Website Hosting.
2579 &quot;writersCanShare&quot;: True or False, # Whether writers can share the document with other users. Not populated for items in shared drives.
2580 },
2581 ],
2582 &quot;kind&quot;: &quot;drive#fileList&quot;, # This is always drive#fileList.
2583 &quot;nextLink&quot;: &quot;A String&quot;, # A link to the next page of files.
2584 &quot;nextPageToken&quot;: &quot;A String&quot;, # 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.
2585 &quot;selfLink&quot;: &quot;A String&quot;, # A link back to this list.
2586}</pre>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]2587</div>
2588
2589<div class="method">
2590 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
2591 <pre>Retrieves the next page of results.
2592
2593Args:
2594 previous_request: The request for the previous page. (required)
2595 previous_response: The response from the request for the previous page. (required)
2596
2597Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]2598 A request object that you can call &#x27;execute()&#x27; on to request the next
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]2599 page. Returns None if there are no more items in the collection.
2600 </pre>
2601</div>
2602
2603<div class="method">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]2604 <code class="details" id="patch">patch(fileId, addParents=None, body=None, convert=None, enforceSingleParent=None, includePermissionsForView=None, modifiedDateBehavior=None, newRevision=None, ocr=None, ocrLanguage=None, pinned=None, removeParents=None, setModifiedDate=None, supportsAllDrives=None, supportsTeamDrives=None, timedTextLanguage=None, timedTextTrackName=None, updateViewedDate=None, useContentAsIndexableText=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]2605 <pre>Updates file metadata and/or content. This method supports patch semantics.
2606
2607Args:
2608 fileId: string, The ID of the file to update. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]2609 body: object, The request body.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]2610 The object takes the form of:
2611
2612{ # The metadata for a file.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]2613 &quot;alternateLink&quot;: &quot;A String&quot;, # A link for opening the file in a relevant Google editor or viewer.
2614 &quot;appDataContents&quot;: True or False, # Whether this file is in the Application Data folder.
2615 &quot;canComment&quot;: True or False, # Deprecated: use capabilities/canComment.
2616 &quot;canReadRevisions&quot;: True or False, # Deprecated: use capabilities/canReadRevisions.
2617 &quot;capabilities&quot;: { # Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take.
2618 &quot;canAddChildren&quot;: True or False, # Whether the current user can add children to this folder. This is always false when the item is not a folder.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]2619 &quot;canAddFolderFromAnotherDrive&quot;: True or False, # Whether the current user can add a folder from another drive (different shared drive or My Drive) to this folder. This is false when the item is not a folder. Only populated for items in shared drives.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]2620 &quot;canAddMyDriveParent&quot;: 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.
2621 &quot;canChangeCopyRequiresWriterPermission&quot;: True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this file.
2622 &quot;canChangeRestrictedDownload&quot;: True or False, # Deprecated
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700[diff] [blame^]2623 &quot;canChangeSecurityUpdateEnabled&quot;: True or False, # Whether the current user can change the securityUpdateEnabled field on link share metadata.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]2624 &quot;canComment&quot;: True or False, # Whether the current user can comment on this file.
2625 &quot;canCopy&quot;: 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.
2626 &quot;canDelete&quot;: True or False, # Whether the current user can delete this file.
2627 &quot;canDeleteChildren&quot;: 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.
2628 &quot;canDownload&quot;: True or False, # Whether the current user can download this file.
2629 &quot;canEdit&quot;: 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.
2630 &quot;canListChildren&quot;: 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.
2631 &quot;canModifyContent&quot;: True or False, # Whether the current user can modify the content of this file.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]2632 &quot;canModifyContentRestriction&quot;: True or False, # Whether the current user can modify restrictions on content of this file.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]2633 &quot;canMoveChildrenOutOfDrive&quot;: 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.
2634 &quot;canMoveChildrenOutOfTeamDrive&quot;: True or False, # Deprecated - use canMoveChildrenOutOfDrive instead.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]2635 &quot;canMoveChildrenWithinDrive&quot;: True or False, # Whether the current user can move children of this folder within this drive. This is false when the item is not a folder. Note that a request to move the child may still fail depending on the current user&#x27;s access to the child and to the destination folder.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]2636 &quot;canMoveChildrenWithinTeamDrive&quot;: True or False, # Deprecated - use canMoveChildrenWithinDrive instead.
2637 &quot;canMoveItemIntoTeamDrive&quot;: True or False, # Deprecated - use canMoveItemOutOfDrive instead.
2638 &quot;canMoveItemOutOfDrive&quot;: 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.
2639 &quot;canMoveItemOutOfTeamDrive&quot;: True or False, # Deprecated - use canMoveItemOutOfDrive instead.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]2640 &quot;canMoveItemWithinDrive&quot;: True or False, # Whether the current user can move this item within this drive. Note that a request to change the parent of the item may still fail depending on the new parent that is being added and the parent that is being removed.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]2641 &quot;canMoveItemWithinTeamDrive&quot;: True or False, # Deprecated - use canMoveItemWithinDrive instead.
2642 &quot;canMoveTeamDriveItem&quot;: True or False, # Deprecated - use canMoveItemWithinDrive or canMoveItemOutOfDrive instead.
2643 &quot;canReadDrive&quot;: True or False, # Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives.
2644 &quot;canReadRevisions&quot;: 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.
2645 &quot;canReadTeamDrive&quot;: True or False, # Deprecated - use canReadDrive instead.
2646 &quot;canRemoveChildren&quot;: 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.
2647 &quot;canRemoveMyDriveParent&quot;: 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.
2648 &quot;canRename&quot;: True or False, # Whether the current user can rename this file.
2649 &quot;canShare&quot;: True or False, # Whether the current user can modify the sharing settings for this file.
2650 &quot;canTrash&quot;: True or False, # Whether the current user can move this file to trash.
2651 &quot;canTrashChildren&quot;: 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.
2652 &quot;canUntrash&quot;: True or False, # Whether the current user can restore this file from trash.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]2653 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]2654 &quot;contentRestrictions&quot;: [ # Restrictions for accessing the content of the file. Only populated if such a restriction exists.
2655 { # A restriction for accessing the content of the file.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]2656 &quot;readOnly&quot;: True or False, # Whether the content of the file is read-only. If a file is read-only, a new revision of the file may not be added, comments may not be added or modified, and the title of the file may not be modified.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]2657 &quot;reason&quot;: &quot;A String&quot;, # Reason for why the content of the file is restricted. This is only mutable on requests that also set readOnly=true.
2658 &quot;restrictingUser&quot;: { # Information about a Drive user. # The user who set the content restriction. Only populated if readOnly is true.
2659 &quot;displayName&quot;: &quot;A String&quot;, # A plain text displayable name for this user.
2660 &quot;emailAddress&quot;: &quot;A String&quot;, # The email address of the user.
2661 &quot;isAuthenticatedUser&quot;: True or False, # Whether this user is the same as the authenticated user for whom the request was made.
2662 &quot;kind&quot;: &quot;drive#user&quot;, # This is always drive#user.
2663 &quot;permissionId&quot;: &quot;A String&quot;, # The user&#x27;s ID as visible in the permissions collection.
2664 &quot;picture&quot;: { # The user&#x27;s profile picture.
2665 &quot;url&quot;: &quot;A String&quot;, # A URL that points to a profile picture of this user.
2666 },
2667 },
2668 &quot;restrictionDate&quot;: &quot;A String&quot;, # The time at which the content restriction was set (formatted RFC 3339 timestamp). Only populated if readOnly is true.
2669 &quot;type&quot;: &quot;A String&quot;, # The type of the content restriction. Currently the only possible value is globalContentRestriction.
2670 },
2671 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]2672 &quot;copyRequiresWriterPermission&quot;: True or False, # Whether the options to copy, print, or download this file, should be disabled for readers and commenters.
2673 &quot;copyable&quot;: True or False, # Deprecated: use capabilities/canCopy.
2674 &quot;createdDate&quot;: &quot;A String&quot;, # Create time for this file (formatted RFC 3339 timestamp).
2675 &quot;defaultOpenWithLink&quot;: &quot;A String&quot;, # A link to open this file with the user&#x27;s default app for this file. Only populated when the drive.apps.readonly scope is used.
2676 &quot;description&quot;: &quot;A String&quot;, # A short description of the file.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]2677 &quot;downloadUrl&quot;: &quot;A String&quot;, # Short lived download URL for the file. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]2678 &quot;driveId&quot;: &quot;A String&quot;, # ID of the shared drive the file resides in. Only populated for items in shared drives.
2679 &quot;editable&quot;: True or False, # Deprecated: use capabilities/canEdit.
2680 &quot;embedLink&quot;: &quot;A String&quot;, # A link for embedding the file.
2681 &quot;etag&quot;: &quot;A String&quot;, # ETag of the file.
2682 &quot;explicitlyTrashed&quot;: True or False, # Whether this file has been explicitly trashed, as opposed to recursively trashed.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]2683 &quot;exportLinks&quot;: { # Links for exporting Docs Editors files to specific formats.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]2684 &quot;a_key&quot;: &quot;A String&quot;, # A mapping from export format to URL
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]2685 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]2686 &quot;fileExtension&quot;: &quot;A String&quot;, # The final component of fullFileExtension with trailing text that does not appear to be part of the extension removed. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.
2687 &quot;fileSize&quot;: &quot;A String&quot;, # The size of the file in bytes. This field is populated for files with content stored in Google Drive and for files in Docs Editors; it is not populated for shortcut files.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]2688 &quot;folderColorRgb&quot;: &quot;A String&quot;, # 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.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]2689 &quot;fullFileExtension&quot;: &quot;A String&quot;, # The full file extension; extracted from the title. May contain multiple concatenated extensions, such as &quot;tar.gz&quot;. Removing an extension from the title does not clear this field; however, changing the extension on the title does update this field. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]2690 &quot;hasAugmentedPermissions&quot;: True or False, # Whether there are permissions directly on this file. This field is only populated for items in shared drives.
2691 &quot;hasThumbnail&quot;: 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.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]2692 &quot;headRevisionId&quot;: &quot;A String&quot;, # The ID of the file&#x27;s head revision. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]2693 &quot;iconLink&quot;: &quot;A String&quot;, # A link to the file&#x27;s icon.
2694 &quot;id&quot;: &quot;A String&quot;, # The ID of the file.
2695 &quot;imageMediaMetadata&quot;: { # 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.
2696 &quot;aperture&quot;: 3.14, # The aperture used to create the photo (f-number).
2697 &quot;cameraMake&quot;: &quot;A String&quot;, # The make of the camera used to create the photo.
2698 &quot;cameraModel&quot;: &quot;A String&quot;, # The model of the camera used to create the photo.
2699 &quot;colorSpace&quot;: &quot;A String&quot;, # The color space of the photo.
2700 &quot;date&quot;: &quot;A String&quot;, # The date and time the photo was taken (EXIF format timestamp).
2701 &quot;exposureBias&quot;: 3.14, # The exposure bias of the photo (APEX value).
2702 &quot;exposureMode&quot;: &quot;A String&quot;, # The exposure mode used to create the photo.
2703 &quot;exposureTime&quot;: 3.14, # The length of the exposure, in seconds.
2704 &quot;flashUsed&quot;: True or False, # Whether a flash was used to create the photo.
2705 &quot;focalLength&quot;: 3.14, # The focal length used to create the photo, in millimeters.
2706 &quot;height&quot;: 42, # The height of the image in pixels.
2707 &quot;isoSpeed&quot;: 42, # The ISO speed used to create the photo.
2708 &quot;lens&quot;: &quot;A String&quot;, # The lens used to create the photo.
2709 &quot;location&quot;: { # Geographic location information stored in the image.
2710 &quot;altitude&quot;: 3.14, # The altitude stored in the image.
2711 &quot;latitude&quot;: 3.14, # The latitude stored in the image.
2712 &quot;longitude&quot;: 3.14, # The longitude stored in the image.
2713 },
2714 &quot;maxApertureValue&quot;: 3.14, # The smallest f-number of the lens at the focal length used to create the photo (APEX value).
2715 &quot;meteringMode&quot;: &quot;A String&quot;, # The metering mode used to create the photo.
2716 &quot;rotation&quot;: 42, # The number of clockwise 90 degree rotations applied from the image&#x27;s original orientation.
2717 &quot;sensor&quot;: &quot;A String&quot;, # The type of sensor used to create the photo.
2718 &quot;subjectDistance&quot;: 42, # The distance to the subject of the photo, in meters.
2719 &quot;whiteBalance&quot;: &quot;A String&quot;, # The white balance mode used to create the photo.
2720 &quot;width&quot;: 42, # The width of the image in pixels.
2721 },
2722 &quot;indexableText&quot;: { # Indexable text attributes for the file (can only be written)
2723 &quot;text&quot;: &quot;A String&quot;, # The text to be indexed for this file.
2724 },
2725 &quot;isAppAuthorized&quot;: True or False, # Whether the file was created or opened by the requesting app.
2726 &quot;kind&quot;: &quot;drive#file&quot;, # The type of file. This is always drive#file.
2727 &quot;labels&quot;: { # A group of labels for the file.
2728 &quot;hidden&quot;: True or False, # Deprecated.
2729 &quot;modified&quot;: True or False, # Whether the file has been modified by this user.
2730 &quot;restricted&quot;: True or False, # Deprecated - use copyRequiresWriterPermission instead.
2731 &quot;starred&quot;: True or False, # Whether this file is starred by the user.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]2732 &quot;trashed&quot;: True or False, # Whether the file has been trashed, either explicitly or from a trashed parent folder. Only the owner may trash a file. The trashed item is excluded from all files.list responses returned for any user who does not own the file. However, all users with access to the file can see the trashed item metadata in an API response. All users with access can copy, download, export, and share the file.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]2733 &quot;viewed&quot;: True or False, # Whether this file has been viewed by this user.
2734 },
2735 &quot;lastModifyingUser&quot;: { # Information about a Drive user. # The last user to modify this file.
2736 &quot;displayName&quot;: &quot;A String&quot;, # A plain text displayable name for this user.
2737 &quot;emailAddress&quot;: &quot;A String&quot;, # The email address of the user.
2738 &quot;isAuthenticatedUser&quot;: True or False, # Whether this user is the same as the authenticated user for whom the request was made.
2739 &quot;kind&quot;: &quot;drive#user&quot;, # This is always drive#user.
2740 &quot;permissionId&quot;: &quot;A String&quot;, # The user&#x27;s ID as visible in the permissions collection.
2741 &quot;picture&quot;: { # The user&#x27;s profile picture.
2742 &quot;url&quot;: &quot;A String&quot;, # A URL that points to a profile picture of this user.
2743 },
2744 },
2745 &quot;lastModifyingUserName&quot;: &quot;A String&quot;, # Name of the last user to modify this file.
2746 &quot;lastViewedByMeDate&quot;: &quot;A String&quot;, # Last time this file was viewed by the user (formatted RFC 3339 timestamp).
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700[diff] [blame^]2747 &quot;linkShareMetadata&quot;: { # Contains details about the link URLs that clients are using to refer to this item.
2748 &quot;securityUpdateEligible&quot;: True or False, # Whether the file is eligible for security update.
2749 &quot;securityUpdateEnabled&quot;: True or False, # Whether the security update is enabled for this file.
2750 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]2751 &quot;markedViewedByMeDate&quot;: &quot;A String&quot;, # Deprecated.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]2752 &quot;md5Checksum&quot;: &quot;A String&quot;, # An MD5 checksum for the content of this file. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]2753 &quot;mimeType&quot;: &quot;A String&quot;, # 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&#x27;s MIME type.
2754 &quot;modifiedByMeDate&quot;: &quot;A String&quot;, # 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.
2755 &quot;modifiedDate&quot;: &quot;A String&quot;, # Last time this file was modified by anyone (formatted RFC 3339 timestamp). This is only mutable on update when the setModifiedDate parameter is set.
2756 &quot;openWithLinks&quot;: { # A map of the id of each of the user&#x27;s apps to a link to open this file with that app. Only populated when the drive.apps.readonly scope is used.
2757 &quot;a_key&quot;: &quot;A String&quot;,
2758 },
2759 &quot;originalFilename&quot;: &quot;A String&quot;, # 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.
2760 &quot;ownedByMe&quot;: True or False, # Whether the file is owned by the current user. Not populated for items in shared drives.
2761 &quot;ownerNames&quot;: [ # Name(s) of the owner(s) of this file. Not populated for items in shared drives.
2762 &quot;A String&quot;,
2763 ],
yoshi-code-botab1d6dc2021-05-28 00:42:02 -0700[diff] [blame]2764 &quot;owners&quot;: [ # The owner of this file. Only certain legacy files may have more than one owner. This field isn&#x27;t populated for items in shared drives.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]2765 { # Information about a Drive user.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]2766 &quot;displayName&quot;: &quot;A String&quot;, # A plain text displayable name for this user.
2767 &quot;emailAddress&quot;: &quot;A String&quot;, # The email address of the user.
2768 &quot;isAuthenticatedUser&quot;: True or False, # Whether this user is the same as the authenticated user for whom the request was made.
2769 &quot;kind&quot;: &quot;drive#user&quot;, # This is always drive#user.
2770 &quot;permissionId&quot;: &quot;A String&quot;, # The user&#x27;s ID as visible in the permissions collection.
2771 &quot;picture&quot;: { # The user&#x27;s profile picture.
2772 &quot;url&quot;: &quot;A String&quot;, # A URL that points to a profile picture of this user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]2773 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]2774 },
2775 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]2776 &quot;parents&quot;: [ # Collection of parent folders which contain this file.
2777 # If not specified as part of an insert request, the file will be placed directly in the user&#x27;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.
2778 { # A reference to a file&#x27;s parent.
2779 &quot;id&quot;: &quot;A String&quot;, # The ID of the parent.
2780 &quot;isRoot&quot;: True or False, # Whether or not the parent is the root folder.
2781 &quot;kind&quot;: &quot;drive#parentReference&quot;, # This is always drive#parentReference.
2782 &quot;parentLink&quot;: &quot;A String&quot;, # A link to the parent.
2783 &quot;selfLink&quot;: &quot;A String&quot;, # A link back to this reference.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]2784 },
2785 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]2786 &quot;permissionIds&quot;: [ # List of permission IDs for users with access to this file.
2787 &quot;A String&quot;,
2788 ],
2789 &quot;permissions&quot;: [ # The list of permissions for users with access to this file. Not populated for items in shared drives.
2790 { # A permission for a file.
2791 &quot;additionalRoles&quot;: [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future.
2792 &quot;A String&quot;,
2793 ],
2794 &quot;authKey&quot;: &quot;A String&quot;, # Deprecated.
2795 &quot;deleted&quot;: True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.
2796 &quot;domain&quot;: &quot;A String&quot;, # 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.
2797 &quot;emailAddress&quot;: &quot;A String&quot;, # 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.
2798 &quot;etag&quot;: &quot;A String&quot;, # The ETag of the permission.
2799 &quot;expirationDate&quot;: &quot;A String&quot;, # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions:
2800 # - They cannot be set on shared drive items
2801 # - They can only be set on user and group permissions
2802 # - The date must be in the future
2803 # - The date cannot be more than a year in the future
2804 # - The date can only be set on drive.permissions.update or drive.permissions.patch requests
2805 &quot;id&quot;: &quot;A String&quot;, # 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.
2806 &quot;kind&quot;: &quot;drive#permission&quot;, # This is always drive#permission.
2807 &quot;name&quot;: &quot;A String&quot;, # The name for this permission.
2808 &quot;permissionDetails&quot;: [ # 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.
2809 {
2810 &quot;additionalRoles&quot;: [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future.
2811 &quot;A String&quot;,
2812 ],
2813 &quot;inherited&quot;: True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field.
2814 &quot;inheritedFrom&quot;: &quot;A String&quot;, # The ID of the item from which this permission is inherited. This is an output-only field.
2815 &quot;permissionType&quot;: &quot;A String&quot;, # The permission type for this user. While new values may be added in future, the following are currently possible:
2816 # - file
2817 # - member
2818 &quot;role&quot;: &quot;A String&quot;, # The primary role for this user. While new values may be added in the future, the following are currently possible:
2819 # - organizer
2820 # - fileOrganizer
2821 # - writer
2822 # - reader
2823 },
2824 ],
2825 &quot;photoLink&quot;: &quot;A String&quot;, # A link to the profile photo, if available.
2826 &quot;role&quot;: &quot;A String&quot;, # The primary role for this user. While new values may be supported in the future, the following are currently allowed:
2827 # - owner
2828 # - organizer
2829 # - fileOrganizer
2830 # - writer
2831 # - reader
2832 &quot;selfLink&quot;: &quot;A String&quot;, # A link back to this permission.
2833 &quot;teamDrivePermissionDetails&quot;: [ # Deprecated - use permissionDetails instead.
2834 {
2835 &quot;additionalRoles&quot;: [ # Deprecated - use permissionDetails/additionalRoles instead.
2836 &quot;A String&quot;,
2837 ],
2838 &quot;inherited&quot;: True or False, # Deprecated - use permissionDetails/inherited instead.
2839 &quot;inheritedFrom&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/inheritedFrom instead.
2840 &quot;role&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/role instead.
2841 &quot;teamDrivePermissionType&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/permissionType instead.
2842 },
2843 ],
2844 &quot;type&quot;: &quot;A String&quot;, # The account type. Allowed values are:
2845 # - user
2846 # - group
2847 # - domain
2848 # - anyone
2849 &quot;value&quot;: &quot;A String&quot;, # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type is anyone, in which case both id and value are ignored.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]2850 &quot;view&quot;: &quot;A String&quot;, # Indicates the view for this permission. Only populated for permissions that belong to a view. published is the only supported value.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]2851 &quot;withLink&quot;: True or False, # Whether the link is required for this permission.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]2852 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]2853 ],
2854 &quot;properties&quot;: [ # The list of properties.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]2855 { # A key-value pair attached to a file that is either public or private to an application.
2856 # The following limits apply to file properties:
2857 # - Maximum of 100 properties total per file
2858 # - Maximum of 30 private properties per app
2859 # - Maximum of 30 public properties
2860 # - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]2861 &quot;etag&quot;: &quot;A String&quot;, # ETag of the property.
2862 &quot;key&quot;: &quot;A String&quot;, # The key of this property.
2863 &quot;kind&quot;: &quot;drive#property&quot;, # This is always drive#property.
2864 &quot;selfLink&quot;: &quot;A String&quot;, # The link back to this property.
2865 &quot;value&quot;: &quot;A String&quot;, # The value of this property.
yoshi-code-bot69706592021-03-03 03:54:02 -0800[diff] [blame]2866 &quot;visibility&quot;: &quot;A String&quot;, # The visibility of this property. Allowed values are PRIVATE and PUBLIC. (Default: PRIVATE). Private properties can only be retrieved using an authenticated request. An authenticated request uses an access token obtained with a OAuth 2 client ID. You cannot use an API key to retrieve private properties.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]2867 },
2868 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]2869 &quot;quotaBytesUsed&quot;: &quot;A String&quot;, # The number of quota bytes used by this file.
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700[diff] [blame^]2870 &quot;resourceKey&quot;: &quot;A String&quot;, # A key needed to access the item via a shared link.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]2871 &quot;selfLink&quot;: &quot;A String&quot;, # A link back to this file.
2872 &quot;shareable&quot;: True or False, # Deprecated: use capabilities/canShare.
2873 &quot;shared&quot;: True or False, # Whether the file has been shared. Not populated for items in shared drives.
2874 &quot;sharedWithMeDate&quot;: &quot;A String&quot;, # Time at which this file was shared with the user (formatted RFC 3339 timestamp).
2875 &quot;sharingUser&quot;: { # Information about a Drive user. # User that shared the item with the current user, if available.
2876 &quot;displayName&quot;: &quot;A String&quot;, # A plain text displayable name for this user.
2877 &quot;emailAddress&quot;: &quot;A String&quot;, # The email address of the user.
2878 &quot;isAuthenticatedUser&quot;: True or False, # Whether this user is the same as the authenticated user for whom the request was made.
2879 &quot;kind&quot;: &quot;drive#user&quot;, # This is always drive#user.
2880 &quot;permissionId&quot;: &quot;A String&quot;, # The user&#x27;s ID as visible in the permissions collection.
2881 &quot;picture&quot;: { # The user&#x27;s profile picture.
2882 &quot;url&quot;: &quot;A String&quot;, # A URL that points to a profile picture of this user.
2883 },
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]2884 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]2885 &quot;shortcutDetails&quot;: { # Shortcut file details. Only populated for shortcut files, which have the mimeType field set to application/vnd.google-apps.shortcut.
2886 &quot;targetId&quot;: &quot;A String&quot;, # The ID of the file that this shortcut points to.
2887 &quot;targetMimeType&quot;: &quot;A String&quot;, # The MIME type of the file that this shortcut points to. The value of this field is a snapshot of the target&#x27;s MIME type, captured when the shortcut is created.
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700[diff] [blame^]2888 &quot;targetResourceKey&quot;: &quot;A String&quot;, # The ResourceKey for the target file.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]2889 },
2890 &quot;spaces&quot;: [ # The list of spaces which contain the file. Supported values are &#x27;drive&#x27;, &#x27;appDataFolder&#x27; and &#x27;photos&#x27;.
2891 &quot;A String&quot;,
2892 ],
2893 &quot;teamDriveId&quot;: &quot;A String&quot;, # Deprecated - use driveId instead.
2894 &quot;thumbnail&quot;: { # A thumbnail for the file. This will only be used if a standard thumbnail cannot be generated.
2895 &quot;image&quot;: &quot;A String&quot;, # The URL-safe Base64 encoded bytes of the thumbnail image. It should conform to RFC 4648 section 5.
2896 &quot;mimeType&quot;: &quot;A String&quot;, # The MIME type of the thumbnail.
2897 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]2898 &quot;thumbnailLink&quot;: &quot;A String&quot;, # A short-lived link to the file&#x27;s thumbnail. Typically lasts on the order of hours. Only populated when the requesting app can access the file&#x27;s content. If the file isn&#x27;t shared publicly, the URL returned in Files.thumbnailLink must be fetched using a credentialed request.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]2899 &quot;thumbnailVersion&quot;: &quot;A String&quot;, # The thumbnail version for use in thumbnail cache invalidation.
2900 &quot;title&quot;: &quot;A String&quot;, # 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.
2901 &quot;trashedDate&quot;: &quot;A String&quot;, # The time that the item was trashed (formatted RFC 3339 timestamp). Only populated for items in shared drives.
2902 &quot;trashingUser&quot;: { # Information about a Drive user. # If the file has been explicitly trashed, the user who trashed it. Only populated for items in shared drives.
2903 &quot;displayName&quot;: &quot;A String&quot;, # A plain text displayable name for this user.
2904 &quot;emailAddress&quot;: &quot;A String&quot;, # The email address of the user.
2905 &quot;isAuthenticatedUser&quot;: True or False, # Whether this user is the same as the authenticated user for whom the request was made.
2906 &quot;kind&quot;: &quot;drive#user&quot;, # This is always drive#user.
2907 &quot;permissionId&quot;: &quot;A String&quot;, # The user&#x27;s ID as visible in the permissions collection.
2908 &quot;picture&quot;: { # The user&#x27;s profile picture.
2909 &quot;url&quot;: &quot;A String&quot;, # A URL that points to a profile picture of this user.
2910 },
2911 },
2912 &quot;userPermission&quot;: { # A permission for a file. # The permissions for the authenticated user on this file.
2913 &quot;additionalRoles&quot;: [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future.
2914 &quot;A String&quot;,
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]2915 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]2916 &quot;authKey&quot;: &quot;A String&quot;, # Deprecated.
2917 &quot;deleted&quot;: True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.
2918 &quot;domain&quot;: &quot;A String&quot;, # 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.
2919 &quot;emailAddress&quot;: &quot;A String&quot;, # 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.
2920 &quot;etag&quot;: &quot;A String&quot;, # The ETag of the permission.
2921 &quot;expirationDate&quot;: &quot;A String&quot;, # 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]2922 # - They cannot be set on shared drive items
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]2923 # - They can only be set on user and group permissions
2924 # - The date must be in the future
2925 # - The date cannot be more than a year in the future
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2926 # - The date can only be set on drive.permissions.update or drive.permissions.patch requests
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]2927 &quot;id&quot;: &quot;A String&quot;, # 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.
2928 &quot;kind&quot;: &quot;drive#permission&quot;, # This is always drive#permission.
2929 &quot;name&quot;: &quot;A String&quot;, # The name for this permission.
2930 &quot;permissionDetails&quot;: [ # 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.
2931 {
2932 &quot;additionalRoles&quot;: [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future.
2933 &quot;A String&quot;,
2934 ],
2935 &quot;inherited&quot;: True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field.
2936 &quot;inheritedFrom&quot;: &quot;A String&quot;, # The ID of the item from which this permission is inherited. This is an output-only field.
2937 &quot;permissionType&quot;: &quot;A String&quot;, # The permission type for this user. While new values may be added in future, the following are currently possible:
2938 # - file
2939 # - member
2940 &quot;role&quot;: &quot;A String&quot;, # The primary role for this user. While new values may be added in the future, the following are currently possible:
2941 # - organizer
2942 # - fileOrganizer
2943 # - writer
2944 # - reader
2945 },
2946 ],
2947 &quot;photoLink&quot;: &quot;A String&quot;, # A link to the profile photo, if available.
2948 &quot;role&quot;: &quot;A String&quot;, # 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]2949 # - owner
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2950 # - organizer
2951 # - fileOrganizer
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]2952 # - writer
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2953 # - reader
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]2954 &quot;selfLink&quot;: &quot;A String&quot;, # A link back to this permission.
2955 &quot;teamDrivePermissionDetails&quot;: [ # Deprecated - use permissionDetails instead.
2956 {
2957 &quot;additionalRoles&quot;: [ # Deprecated - use permissionDetails/additionalRoles instead.
2958 &quot;A String&quot;,
2959 ],
2960 &quot;inherited&quot;: True or False, # Deprecated - use permissionDetails/inherited instead.
2961 &quot;inheritedFrom&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/inheritedFrom instead.
2962 &quot;role&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/role instead.
2963 &quot;teamDrivePermissionType&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/permissionType instead.
2964 },
2965 ],
2966 &quot;type&quot;: &quot;A String&quot;, # The account type. Allowed values are:
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]2967 # - user
2968 # - group
2969 # - domain
2970 # - anyone
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]2971 &quot;value&quot;: &quot;A String&quot;, # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type is anyone, in which case both id and value are ignored.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]2972 &quot;view&quot;: &quot;A String&quot;, # Indicates the view for this permission. Only populated for permissions that belong to a view. published is the only supported value.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]2973 &quot;withLink&quot;: True or False, # Whether the link is required for this permission.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]2974 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]2975 &quot;version&quot;: &quot;A String&quot;, # 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.
2976 &quot;videoMediaMetadata&quot;: { # Metadata about video media. This will only be present for video types.
2977 &quot;durationMillis&quot;: &quot;A String&quot;, # The duration of the video in milliseconds.
2978 &quot;height&quot;: 42, # The height of the video in pixels.
2979 &quot;width&quot;: 42, # The width of the video in pixels.
2980 },
2981 &quot;webContentLink&quot;: &quot;A String&quot;, # 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.
2982 &quot;webViewLink&quot;: &quot;A String&quot;, # A link only available on public folders for viewing their static web assets (HTML, CSS, JS, etc) via Google Drive&#x27;s Website Hosting.
2983 &quot;writersCanShare&quot;: True or False, # Whether writers can share the document with other users. Not populated for items in shared drives.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]2984}
2985
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]2986 addParents: string, Comma-separated list of parent IDs to add.
2987 convert: boolean, This parameter is deprecated and has no function.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]2988 enforceSingleParent: boolean, Deprecated. Adding files to multiple folders is no longer supported. Use shortcuts instead.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]2989 includePermissionsForView: string, Specifies which additional view&#x27;s permissions to include in the response. Only &#x27;published&#x27; is supported.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]2990 modifiedDateBehavior: string, Determines the behavior in which modifiedDate is updated. This overrides setModifiedDate.
2991 Allowed values
2992 fromBody - Set modifiedDate to the value provided in the body of the request. No change if no value was provided.
2993 fromBodyIfNeeded - Set modifiedDate to the value provided in the body of the request depending on other contents of the update.
2994 fromBodyOrNow - Set modifiedDate to the value provided in the body of the request, or to the current time if no value was provided.
2995 noChange - Maintain the previous value of modifiedDate.
2996 now - Set modifiedDate to the current time.
2997 nowIfNeeded - Set modifiedDate to the current time depending on contents of the update.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]2998 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. Note that this field is ignored if there is no payload in the request.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]2999 ocr: boolean, Whether to attempt OCR on .jpg, .png, .gif, or .pdf uploads.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]3000 ocrLanguage: string, If ocr is true, hints at the language to use. Valid values are BCP 47 codes.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]3001 pinned: boolean, Whether to pin the new revision. A file can have a maximum of 200 pinned revisions. Note that this field is ignored if there is no payload in the request.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]3002 removeParents: string, Comma-separated list of parent IDs to remove.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3003 setModifiedDate: boolean, Whether to set the modified date using the value supplied in the request body. Setting this field to true is equivalent to modifiedDateBehavior=fromBodyOrNow, and false is equivalent to modifiedDateBehavior=now. To prevent any changes to the modified date set modifiedDateBehavior=noChange.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]3004 supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]3005 supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]3006 timedTextLanguage: string, The language of the timed text.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]3007 timedTextTrackName: string, The timed text track name.
3008 updateViewedDate: boolean, Whether to update the view date after successfully updating the file.
3009 useContentAsIndexableText: boolean, Whether to use the content as indexable text.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]3010
3011Returns:
3012 An object of the form:
3013
3014 { # The metadata for a file.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]3015 &quot;alternateLink&quot;: &quot;A String&quot;, # A link for opening the file in a relevant Google editor or viewer.
3016 &quot;appDataContents&quot;: True or False, # Whether this file is in the Application Data folder.
3017 &quot;canComment&quot;: True or False, # Deprecated: use capabilities/canComment.
3018 &quot;canReadRevisions&quot;: True or False, # Deprecated: use capabilities/canReadRevisions.
3019 &quot;capabilities&quot;: { # Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take.
3020 &quot;canAddChildren&quot;: True or False, # Whether the current user can add children to this folder. This is always false when the item is not a folder.
3021 &quot;canAddFolderFromAnotherDrive&quot;: True or False, # Whether the current user can add a folder from another drive (different shared drive or My Drive) to this folder. This is false when the item is not a folder. Only populated for items in shared drives.
3022 &quot;canAddMyDriveParent&quot;: 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.
3023 &quot;canChangeCopyRequiresWriterPermission&quot;: True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this file.
3024 &quot;canChangeRestrictedDownload&quot;: True or False, # Deprecated
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700[diff] [blame^]3025 &quot;canChangeSecurityUpdateEnabled&quot;: True or False, # Whether the current user can change the securityUpdateEnabled field on link share metadata.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]3026 &quot;canComment&quot;: True or False, # Whether the current user can comment on this file.
3027 &quot;canCopy&quot;: 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.
3028 &quot;canDelete&quot;: True or False, # Whether the current user can delete this file.
3029 &quot;canDeleteChildren&quot;: 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.
3030 &quot;canDownload&quot;: True or False, # Whether the current user can download this file.
3031 &quot;canEdit&quot;: 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.
3032 &quot;canListChildren&quot;: 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.
3033 &quot;canModifyContent&quot;: True or False, # Whether the current user can modify the content of this file.
3034 &quot;canModifyContentRestriction&quot;: True or False, # Whether the current user can modify restrictions on content of this file.
3035 &quot;canMoveChildrenOutOfDrive&quot;: 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.
3036 &quot;canMoveChildrenOutOfTeamDrive&quot;: True or False, # Deprecated - use canMoveChildrenOutOfDrive instead.
3037 &quot;canMoveChildrenWithinDrive&quot;: True or False, # Whether the current user can move children of this folder within this drive. This is false when the item is not a folder. Note that a request to move the child may still fail depending on the current user&#x27;s access to the child and to the destination folder.
3038 &quot;canMoveChildrenWithinTeamDrive&quot;: True or False, # Deprecated - use canMoveChildrenWithinDrive instead.
3039 &quot;canMoveItemIntoTeamDrive&quot;: True or False, # Deprecated - use canMoveItemOutOfDrive instead.
3040 &quot;canMoveItemOutOfDrive&quot;: 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.
3041 &quot;canMoveItemOutOfTeamDrive&quot;: True or False, # Deprecated - use canMoveItemOutOfDrive instead.
3042 &quot;canMoveItemWithinDrive&quot;: True or False, # Whether the current user can move this item within this drive. Note that a request to change the parent of the item may still fail depending on the new parent that is being added and the parent that is being removed.
3043 &quot;canMoveItemWithinTeamDrive&quot;: True or False, # Deprecated - use canMoveItemWithinDrive instead.
3044 &quot;canMoveTeamDriveItem&quot;: True or False, # Deprecated - use canMoveItemWithinDrive or canMoveItemOutOfDrive instead.
3045 &quot;canReadDrive&quot;: True or False, # Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives.
3046 &quot;canReadRevisions&quot;: 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.
3047 &quot;canReadTeamDrive&quot;: True or False, # Deprecated - use canReadDrive instead.
3048 &quot;canRemoveChildren&quot;: 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.
3049 &quot;canRemoveMyDriveParent&quot;: 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.
3050 &quot;canRename&quot;: True or False, # Whether the current user can rename this file.
3051 &quot;canShare&quot;: True or False, # Whether the current user can modify the sharing settings for this file.
3052 &quot;canTrash&quot;: True or False, # Whether the current user can move this file to trash.
3053 &quot;canTrashChildren&quot;: 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.
3054 &quot;canUntrash&quot;: True or False, # Whether the current user can restore this file from trash.
3055 },
3056 &quot;contentRestrictions&quot;: [ # Restrictions for accessing the content of the file. Only populated if such a restriction exists.
3057 { # A restriction for accessing the content of the file.
3058 &quot;readOnly&quot;: True or False, # Whether the content of the file is read-only. If a file is read-only, a new revision of the file may not be added, comments may not be added or modified, and the title of the file may not be modified.
3059 &quot;reason&quot;: &quot;A String&quot;, # Reason for why the content of the file is restricted. This is only mutable on requests that also set readOnly=true.
3060 &quot;restrictingUser&quot;: { # Information about a Drive user. # The user who set the content restriction. Only populated if readOnly is true.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]3061 &quot;displayName&quot;: &quot;A String&quot;, # A plain text displayable name for this user.
3062 &quot;emailAddress&quot;: &quot;A String&quot;, # The email address of the user.
3063 &quot;isAuthenticatedUser&quot;: True or False, # Whether this user is the same as the authenticated user for whom the request was made.
3064 &quot;kind&quot;: &quot;drive#user&quot;, # This is always drive#user.
3065 &quot;permissionId&quot;: &quot;A String&quot;, # The user&#x27;s ID as visible in the permissions collection.
3066 &quot;picture&quot;: { # The user&#x27;s profile picture.
3067 &quot;url&quot;: &quot;A String&quot;, # A URL that points to a profile picture of this user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]3068 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]3069 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]3070 &quot;restrictionDate&quot;: &quot;A String&quot;, # The time at which the content restriction was set (formatted RFC 3339 timestamp). Only populated if readOnly is true.
3071 &quot;type&quot;: &quot;A String&quot;, # The type of the content restriction. Currently the only possible value is globalContentRestriction.
3072 },
3073 ],
3074 &quot;copyRequiresWriterPermission&quot;: True or False, # Whether the options to copy, print, or download this file, should be disabled for readers and commenters.
3075 &quot;copyable&quot;: True or False, # Deprecated: use capabilities/canCopy.
3076 &quot;createdDate&quot;: &quot;A String&quot;, # Create time for this file (formatted RFC 3339 timestamp).
3077 &quot;defaultOpenWithLink&quot;: &quot;A String&quot;, # A link to open this file with the user&#x27;s default app for this file. Only populated when the drive.apps.readonly scope is used.
3078 &quot;description&quot;: &quot;A String&quot;, # A short description of the file.
3079 &quot;downloadUrl&quot;: &quot;A String&quot;, # Short lived download URL for the file. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.
3080 &quot;driveId&quot;: &quot;A String&quot;, # ID of the shared drive the file resides in. Only populated for items in shared drives.
3081 &quot;editable&quot;: True or False, # Deprecated: use capabilities/canEdit.
3082 &quot;embedLink&quot;: &quot;A String&quot;, # A link for embedding the file.
3083 &quot;etag&quot;: &quot;A String&quot;, # ETag of the file.
3084 &quot;explicitlyTrashed&quot;: True or False, # Whether this file has been explicitly trashed, as opposed to recursively trashed.
3085 &quot;exportLinks&quot;: { # Links for exporting Docs Editors files to specific formats.
3086 &quot;a_key&quot;: &quot;A String&quot;, # A mapping from export format to URL
3087 },
3088 &quot;fileExtension&quot;: &quot;A String&quot;, # The final component of fullFileExtension with trailing text that does not appear to be part of the extension removed. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.
3089 &quot;fileSize&quot;: &quot;A String&quot;, # The size of the file in bytes. This field is populated for files with content stored in Google Drive and for files in Docs Editors; it is not populated for shortcut files.
3090 &quot;folderColorRgb&quot;: &quot;A String&quot;, # 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.
3091 &quot;fullFileExtension&quot;: &quot;A String&quot;, # The full file extension; extracted from the title. May contain multiple concatenated extensions, such as &quot;tar.gz&quot;. Removing an extension from the title does not clear this field; however, changing the extension on the title does update this field. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.
3092 &quot;hasAugmentedPermissions&quot;: True or False, # Whether there are permissions directly on this file. This field is only populated for items in shared drives.
3093 &quot;hasThumbnail&quot;: 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.
3094 &quot;headRevisionId&quot;: &quot;A String&quot;, # The ID of the file&#x27;s head revision. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.
3095 &quot;iconLink&quot;: &quot;A String&quot;, # A link to the file&#x27;s icon.
3096 &quot;id&quot;: &quot;A String&quot;, # The ID of the file.
3097 &quot;imageMediaMetadata&quot;: { # 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.
3098 &quot;aperture&quot;: 3.14, # The aperture used to create the photo (f-number).
3099 &quot;cameraMake&quot;: &quot;A String&quot;, # The make of the camera used to create the photo.
3100 &quot;cameraModel&quot;: &quot;A String&quot;, # The model of the camera used to create the photo.
3101 &quot;colorSpace&quot;: &quot;A String&quot;, # The color space of the photo.
3102 &quot;date&quot;: &quot;A String&quot;, # The date and time the photo was taken (EXIF format timestamp).
3103 &quot;exposureBias&quot;: 3.14, # The exposure bias of the photo (APEX value).
3104 &quot;exposureMode&quot;: &quot;A String&quot;, # The exposure mode used to create the photo.
3105 &quot;exposureTime&quot;: 3.14, # The length of the exposure, in seconds.
3106 &quot;flashUsed&quot;: True or False, # Whether a flash was used to create the photo.
3107 &quot;focalLength&quot;: 3.14, # The focal length used to create the photo, in millimeters.
3108 &quot;height&quot;: 42, # The height of the image in pixels.
3109 &quot;isoSpeed&quot;: 42, # The ISO speed used to create the photo.
3110 &quot;lens&quot;: &quot;A String&quot;, # The lens used to create the photo.
3111 &quot;location&quot;: { # Geographic location information stored in the image.
3112 &quot;altitude&quot;: 3.14, # The altitude stored in the image.
3113 &quot;latitude&quot;: 3.14, # The latitude stored in the image.
3114 &quot;longitude&quot;: 3.14, # The longitude stored in the image.
3115 },
3116 &quot;maxApertureValue&quot;: 3.14, # The smallest f-number of the lens at the focal length used to create the photo (APEX value).
3117 &quot;meteringMode&quot;: &quot;A String&quot;, # The metering mode used to create the photo.
3118 &quot;rotation&quot;: 42, # The number of clockwise 90 degree rotations applied from the image&#x27;s original orientation.
3119 &quot;sensor&quot;: &quot;A String&quot;, # The type of sensor used to create the photo.
3120 &quot;subjectDistance&quot;: 42, # The distance to the subject of the photo, in meters.
3121 &quot;whiteBalance&quot;: &quot;A String&quot;, # The white balance mode used to create the photo.
3122 &quot;width&quot;: 42, # The width of the image in pixels.
3123 },
3124 &quot;indexableText&quot;: { # Indexable text attributes for the file (can only be written)
3125 &quot;text&quot;: &quot;A String&quot;, # The text to be indexed for this file.
3126 },
3127 &quot;isAppAuthorized&quot;: True or False, # Whether the file was created or opened by the requesting app.
3128 &quot;kind&quot;: &quot;drive#file&quot;, # The type of file. This is always drive#file.
3129 &quot;labels&quot;: { # A group of labels for the file.
3130 &quot;hidden&quot;: True or False, # Deprecated.
3131 &quot;modified&quot;: True or False, # Whether the file has been modified by this user.
3132 &quot;restricted&quot;: True or False, # Deprecated - use copyRequiresWriterPermission instead.
3133 &quot;starred&quot;: True or False, # Whether this file is starred by the user.
3134 &quot;trashed&quot;: True or False, # Whether the file has been trashed, either explicitly or from a trashed parent folder. Only the owner may trash a file. The trashed item is excluded from all files.list responses returned for any user who does not own the file. However, all users with access to the file can see the trashed item metadata in an API response. All users with access can copy, download, export, and share the file.
3135 &quot;viewed&quot;: True or False, # Whether this file has been viewed by this user.
3136 },
3137 &quot;lastModifyingUser&quot;: { # Information about a Drive user. # The last user to modify this file.
3138 &quot;displayName&quot;: &quot;A String&quot;, # A plain text displayable name for this user.
3139 &quot;emailAddress&quot;: &quot;A String&quot;, # The email address of the user.
3140 &quot;isAuthenticatedUser&quot;: True or False, # Whether this user is the same as the authenticated user for whom the request was made.
3141 &quot;kind&quot;: &quot;drive#user&quot;, # This is always drive#user.
3142 &quot;permissionId&quot;: &quot;A String&quot;, # The user&#x27;s ID as visible in the permissions collection.
3143 &quot;picture&quot;: { # The user&#x27;s profile picture.
3144 &quot;url&quot;: &quot;A String&quot;, # A URL that points to a profile picture of this user.
3145 },
3146 },
3147 &quot;lastModifyingUserName&quot;: &quot;A String&quot;, # Name of the last user to modify this file.
3148 &quot;lastViewedByMeDate&quot;: &quot;A String&quot;, # Last time this file was viewed by the user (formatted RFC 3339 timestamp).
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700[diff] [blame^]3149 &quot;linkShareMetadata&quot;: { # Contains details about the link URLs that clients are using to refer to this item.
3150 &quot;securityUpdateEligible&quot;: True or False, # Whether the file is eligible for security update.
3151 &quot;securityUpdateEnabled&quot;: True or False, # Whether the security update is enabled for this file.
3152 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]3153 &quot;markedViewedByMeDate&quot;: &quot;A String&quot;, # Deprecated.
3154 &quot;md5Checksum&quot;: &quot;A String&quot;, # An MD5 checksum for the content of this file. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.
3155 &quot;mimeType&quot;: &quot;A String&quot;, # 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&#x27;s MIME type.
3156 &quot;modifiedByMeDate&quot;: &quot;A String&quot;, # 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.
3157 &quot;modifiedDate&quot;: &quot;A String&quot;, # Last time this file was modified by anyone (formatted RFC 3339 timestamp). This is only mutable on update when the setModifiedDate parameter is set.
3158 &quot;openWithLinks&quot;: { # A map of the id of each of the user&#x27;s apps to a link to open this file with that app. Only populated when the drive.apps.readonly scope is used.
3159 &quot;a_key&quot;: &quot;A String&quot;,
3160 },
3161 &quot;originalFilename&quot;: &quot;A String&quot;, # 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.
3162 &quot;ownedByMe&quot;: True or False, # Whether the file is owned by the current user. Not populated for items in shared drives.
3163 &quot;ownerNames&quot;: [ # Name(s) of the owner(s) of this file. Not populated for items in shared drives.
3164 &quot;A String&quot;,
3165 ],
yoshi-code-botab1d6dc2021-05-28 00:42:02 -0700[diff] [blame]3166 &quot;owners&quot;: [ # The owner of this file. Only certain legacy files may have more than one owner. This field isn&#x27;t populated for items in shared drives.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]3167 { # Information about a Drive user.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]3168 &quot;displayName&quot;: &quot;A String&quot;, # A plain text displayable name for this user.
3169 &quot;emailAddress&quot;: &quot;A String&quot;, # The email address of the user.
3170 &quot;isAuthenticatedUser&quot;: True or False, # Whether this user is the same as the authenticated user for whom the request was made.
3171 &quot;kind&quot;: &quot;drive#user&quot;, # This is always drive#user.
3172 &quot;permissionId&quot;: &quot;A String&quot;, # The user&#x27;s ID as visible in the permissions collection.
3173 &quot;picture&quot;: { # The user&#x27;s profile picture.
3174 &quot;url&quot;: &quot;A String&quot;, # A URL that points to a profile picture of this user.
3175 },
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]3176 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]3177 ],
3178 &quot;parents&quot;: [ # Collection of parent folders which contain this file.
3179 # If not specified as part of an insert request, the file will be placed directly in the user&#x27;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.
3180 { # A reference to a file&#x27;s parent.
3181 &quot;id&quot;: &quot;A String&quot;, # The ID of the parent.
3182 &quot;isRoot&quot;: True or False, # Whether or not the parent is the root folder.
3183 &quot;kind&quot;: &quot;drive#parentReference&quot;, # This is always drive#parentReference.
3184 &quot;parentLink&quot;: &quot;A String&quot;, # A link to the parent.
3185 &quot;selfLink&quot;: &quot;A String&quot;, # A link back to this reference.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]3186 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]3187 ],
3188 &quot;permissionIds&quot;: [ # List of permission IDs for users with access to this file.
3189 &quot;A String&quot;,
3190 ],
3191 &quot;permissions&quot;: [ # The list of permissions for users with access to this file. Not populated for items in shared drives.
3192 { # A permission for a file.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]3193 &quot;additionalRoles&quot;: [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future.
3194 &quot;A String&quot;,
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]3195 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]3196 &quot;authKey&quot;: &quot;A String&quot;, # Deprecated.
3197 &quot;deleted&quot;: True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.
3198 &quot;domain&quot;: &quot;A String&quot;, # 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.
3199 &quot;emailAddress&quot;: &quot;A String&quot;, # 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.
3200 &quot;etag&quot;: &quot;A String&quot;, # The ETag of the permission.
3201 &quot;expirationDate&quot;: &quot;A String&quot;, # 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]3202 # - They cannot be set on shared drive items
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]3203 # - They can only be set on user and group permissions
3204 # - The date must be in the future
3205 # - The date cannot be more than a year in the future
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3206 # - The date can only be set on drive.permissions.update or drive.permissions.patch requests
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]3207 &quot;id&quot;: &quot;A String&quot;, # 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.
3208 &quot;kind&quot;: &quot;drive#permission&quot;, # This is always drive#permission.
3209 &quot;name&quot;: &quot;A String&quot;, # The name for this permission.
3210 &quot;permissionDetails&quot;: [ # 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.
3211 {
3212 &quot;additionalRoles&quot;: [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future.
3213 &quot;A String&quot;,
3214 ],
3215 &quot;inherited&quot;: True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field.
3216 &quot;inheritedFrom&quot;: &quot;A String&quot;, # The ID of the item from which this permission is inherited. This is an output-only field.
3217 &quot;permissionType&quot;: &quot;A String&quot;, # The permission type for this user. While new values may be added in future, the following are currently possible:
3218 # - file
3219 # - member
3220 &quot;role&quot;: &quot;A String&quot;, # The primary role for this user. While new values may be added in the future, the following are currently possible:
3221 # - organizer
3222 # - fileOrganizer
3223 # - writer
3224 # - reader
3225 },
3226 ],
3227 &quot;photoLink&quot;: &quot;A String&quot;, # A link to the profile photo, if available.
3228 &quot;role&quot;: &quot;A String&quot;, # 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]3229 # - owner
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3230 # - organizer
3231 # - fileOrganizer
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]3232 # - writer
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3233 # - reader
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]3234 &quot;selfLink&quot;: &quot;A String&quot;, # A link back to this permission.
3235 &quot;teamDrivePermissionDetails&quot;: [ # Deprecated - use permissionDetails instead.
3236 {
3237 &quot;additionalRoles&quot;: [ # Deprecated - use permissionDetails/additionalRoles instead.
3238 &quot;A String&quot;,
3239 ],
3240 &quot;inherited&quot;: True or False, # Deprecated - use permissionDetails/inherited instead.
3241 &quot;inheritedFrom&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/inheritedFrom instead.
3242 &quot;role&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/role instead.
3243 &quot;teamDrivePermissionType&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/permissionType instead.
3244 },
3245 ],
3246 &quot;type&quot;: &quot;A String&quot;, # The account type. Allowed values are:
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]3247 # - user
3248 # - group
3249 # - domain
3250 # - anyone
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]3251 &quot;value&quot;: &quot;A String&quot;, # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type is anyone, in which case both id and value are ignored.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]3252 &quot;view&quot;: &quot;A String&quot;, # Indicates the view for this permission. Only populated for permissions that belong to a view. published is the only supported value.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]3253 &quot;withLink&quot;: True or False, # Whether the link is required for this permission.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]3254 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]3255 ],
3256 &quot;properties&quot;: [ # The list of properties.
3257 { # A key-value pair attached to a file that is either public or private to an application.
3258 # The following limits apply to file properties:
3259 # - Maximum of 100 properties total per file
3260 # - Maximum of 30 private properties per app
3261 # - Maximum of 30 public properties
3262 # - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property.
3263 &quot;etag&quot;: &quot;A String&quot;, # ETag of the property.
3264 &quot;key&quot;: &quot;A String&quot;, # The key of this property.
3265 &quot;kind&quot;: &quot;drive#property&quot;, # This is always drive#property.
3266 &quot;selfLink&quot;: &quot;A String&quot;, # The link back to this property.
3267 &quot;value&quot;: &quot;A String&quot;, # The value of this property.
yoshi-code-bot69706592021-03-03 03:54:02 -0800[diff] [blame]3268 &quot;visibility&quot;: &quot;A String&quot;, # The visibility of this property. Allowed values are PRIVATE and PUBLIC. (Default: PRIVATE). Private properties can only be retrieved using an authenticated request. An authenticated request uses an access token obtained with a OAuth 2 client ID. You cannot use an API key to retrieve private properties.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]3269 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]3270 ],
3271 &quot;quotaBytesUsed&quot;: &quot;A String&quot;, # The number of quota bytes used by this file.
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700[diff] [blame^]3272 &quot;resourceKey&quot;: &quot;A String&quot;, # A key needed to access the item via a shared link.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]3273 &quot;selfLink&quot;: &quot;A String&quot;, # A link back to this file.
3274 &quot;shareable&quot;: True or False, # Deprecated: use capabilities/canShare.
3275 &quot;shared&quot;: True or False, # Whether the file has been shared. Not populated for items in shared drives.
3276 &quot;sharedWithMeDate&quot;: &quot;A String&quot;, # Time at which this file was shared with the user (formatted RFC 3339 timestamp).
3277 &quot;sharingUser&quot;: { # Information about a Drive user. # User that shared the item with the current user, if available.
3278 &quot;displayName&quot;: &quot;A String&quot;, # A plain text displayable name for this user.
3279 &quot;emailAddress&quot;: &quot;A String&quot;, # The email address of the user.
3280 &quot;isAuthenticatedUser&quot;: True or False, # Whether this user is the same as the authenticated user for whom the request was made.
3281 &quot;kind&quot;: &quot;drive#user&quot;, # This is always drive#user.
3282 &quot;permissionId&quot;: &quot;A String&quot;, # The user&#x27;s ID as visible in the permissions collection.
3283 &quot;picture&quot;: { # The user&#x27;s profile picture.
3284 &quot;url&quot;: &quot;A String&quot;, # A URL that points to a profile picture of this user.
3285 },
3286 },
3287 &quot;shortcutDetails&quot;: { # Shortcut file details. Only populated for shortcut files, which have the mimeType field set to application/vnd.google-apps.shortcut.
3288 &quot;targetId&quot;: &quot;A String&quot;, # The ID of the file that this shortcut points to.
3289 &quot;targetMimeType&quot;: &quot;A String&quot;, # The MIME type of the file that this shortcut points to. The value of this field is a snapshot of the target&#x27;s MIME type, captured when the shortcut is created.
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700[diff] [blame^]3290 &quot;targetResourceKey&quot;: &quot;A String&quot;, # The ResourceKey for the target file.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]3291 },
3292 &quot;spaces&quot;: [ # The list of spaces which contain the file. Supported values are &#x27;drive&#x27;, &#x27;appDataFolder&#x27; and &#x27;photos&#x27;.
3293 &quot;A String&quot;,
3294 ],
3295 &quot;teamDriveId&quot;: &quot;A String&quot;, # Deprecated - use driveId instead.
3296 &quot;thumbnail&quot;: { # A thumbnail for the file. This will only be used if a standard thumbnail cannot be generated.
3297 &quot;image&quot;: &quot;A String&quot;, # The URL-safe Base64 encoded bytes of the thumbnail image. It should conform to RFC 4648 section 5.
3298 &quot;mimeType&quot;: &quot;A String&quot;, # The MIME type of the thumbnail.
3299 },
3300 &quot;thumbnailLink&quot;: &quot;A String&quot;, # A short-lived link to the file&#x27;s thumbnail. Typically lasts on the order of hours. Only populated when the requesting app can access the file&#x27;s content. If the file isn&#x27;t shared publicly, the URL returned in Files.thumbnailLink must be fetched using a credentialed request.
3301 &quot;thumbnailVersion&quot;: &quot;A String&quot;, # The thumbnail version for use in thumbnail cache invalidation.
3302 &quot;title&quot;: &quot;A String&quot;, # 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.
3303 &quot;trashedDate&quot;: &quot;A String&quot;, # The time that the item was trashed (formatted RFC 3339 timestamp). Only populated for items in shared drives.
3304 &quot;trashingUser&quot;: { # Information about a Drive user. # If the file has been explicitly trashed, the user who trashed it. Only populated for items in shared drives.
3305 &quot;displayName&quot;: &quot;A String&quot;, # A plain text displayable name for this user.
3306 &quot;emailAddress&quot;: &quot;A String&quot;, # The email address of the user.
3307 &quot;isAuthenticatedUser&quot;: True or False, # Whether this user is the same as the authenticated user for whom the request was made.
3308 &quot;kind&quot;: &quot;drive#user&quot;, # This is always drive#user.
3309 &quot;permissionId&quot;: &quot;A String&quot;, # The user&#x27;s ID as visible in the permissions collection.
3310 &quot;picture&quot;: { # The user&#x27;s profile picture.
3311 &quot;url&quot;: &quot;A String&quot;, # A URL that points to a profile picture of this user.
3312 },
3313 },
3314 &quot;userPermission&quot;: { # A permission for a file. # The permissions for the authenticated user on this file.
3315 &quot;additionalRoles&quot;: [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future.
3316 &quot;A String&quot;,
3317 ],
3318 &quot;authKey&quot;: &quot;A String&quot;, # Deprecated.
3319 &quot;deleted&quot;: True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.
3320 &quot;domain&quot;: &quot;A String&quot;, # 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.
3321 &quot;emailAddress&quot;: &quot;A String&quot;, # 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.
3322 &quot;etag&quot;: &quot;A String&quot;, # The ETag of the permission.
3323 &quot;expirationDate&quot;: &quot;A String&quot;, # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions:
3324 # - They cannot be set on shared drive items
3325 # - They can only be set on user and group permissions
3326 # - The date must be in the future
3327 # - The date cannot be more than a year in the future
3328 # - The date can only be set on drive.permissions.update or drive.permissions.patch requests
3329 &quot;id&quot;: &quot;A String&quot;, # 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.
3330 &quot;kind&quot;: &quot;drive#permission&quot;, # This is always drive#permission.
3331 &quot;name&quot;: &quot;A String&quot;, # The name for this permission.
3332 &quot;permissionDetails&quot;: [ # 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.
3333 {
3334 &quot;additionalRoles&quot;: [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future.
3335 &quot;A String&quot;,
3336 ],
3337 &quot;inherited&quot;: True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field.
3338 &quot;inheritedFrom&quot;: &quot;A String&quot;, # The ID of the item from which this permission is inherited. This is an output-only field.
3339 &quot;permissionType&quot;: &quot;A String&quot;, # The permission type for this user. While new values may be added in future, the following are currently possible:
3340 # - file
3341 # - member
3342 &quot;role&quot;: &quot;A String&quot;, # The primary role for this user. While new values may be added in the future, the following are currently possible:
3343 # - organizer
3344 # - fileOrganizer
3345 # - writer
3346 # - reader
3347 },
3348 ],
3349 &quot;photoLink&quot;: &quot;A String&quot;, # A link to the profile photo, if available.
3350 &quot;role&quot;: &quot;A String&quot;, # The primary role for this user. While new values may be supported in the future, the following are currently allowed:
3351 # - owner
3352 # - organizer
3353 # - fileOrganizer
3354 # - writer
3355 # - reader
3356 &quot;selfLink&quot;: &quot;A String&quot;, # A link back to this permission.
3357 &quot;teamDrivePermissionDetails&quot;: [ # Deprecated - use permissionDetails instead.
3358 {
3359 &quot;additionalRoles&quot;: [ # Deprecated - use permissionDetails/additionalRoles instead.
3360 &quot;A String&quot;,
3361 ],
3362 &quot;inherited&quot;: True or False, # Deprecated - use permissionDetails/inherited instead.
3363 &quot;inheritedFrom&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/inheritedFrom instead.
3364 &quot;role&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/role instead.
3365 &quot;teamDrivePermissionType&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/permissionType instead.
3366 },
3367 ],
3368 &quot;type&quot;: &quot;A String&quot;, # The account type. Allowed values are:
3369 # - user
3370 # - group
3371 # - domain
3372 # - anyone
3373 &quot;value&quot;: &quot;A String&quot;, # 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.
3374 &quot;view&quot;: &quot;A String&quot;, # Indicates the view for this permission. Only populated for permissions that belong to a view. published is the only supported value.
3375 &quot;withLink&quot;: True or False, # Whether the link is required for this permission.
3376 },
3377 &quot;version&quot;: &quot;A String&quot;, # 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.
3378 &quot;videoMediaMetadata&quot;: { # Metadata about video media. This will only be present for video types.
3379 &quot;durationMillis&quot;: &quot;A String&quot;, # The duration of the video in milliseconds.
3380 &quot;height&quot;: 42, # The height of the video in pixels.
3381 &quot;width&quot;: 42, # The width of the video in pixels.
3382 },
3383 &quot;webContentLink&quot;: &quot;A String&quot;, # 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.
3384 &quot;webViewLink&quot;: &quot;A String&quot;, # A link only available on public folders for viewing their static web assets (HTML, CSS, JS, etc) via Google Drive&#x27;s Website Hosting.
3385 &quot;writersCanShare&quot;: True or False, # Whether writers can share the document with other users. Not populated for items in shared drives.
3386}</pre>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]3387</div>
3388
3389<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]3390 <code class="details" id="touch">touch(fileId, includePermissionsForView=None, supportsAllDrives=None, supportsTeamDrives=None)</code>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]3391 <pre>Set the file&#x27;s updated time to the current server time.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]3392
3393Args:
3394 fileId: string, The ID of the file to update. (required)
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]3395 includePermissionsForView: string, Specifies which additional view&#x27;s permissions to include in the response. Only &#x27;published&#x27; is supported.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]3396 supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]3397 supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]3398
3399Returns:
3400 An object of the form:
3401
3402 { # The metadata for a file.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]3403 &quot;alternateLink&quot;: &quot;A String&quot;, # A link for opening the file in a relevant Google editor or viewer.
3404 &quot;appDataContents&quot;: True or False, # Whether this file is in the Application Data folder.
3405 &quot;canComment&quot;: True or False, # Deprecated: use capabilities/canComment.
3406 &quot;canReadRevisions&quot;: True or False, # Deprecated: use capabilities/canReadRevisions.
3407 &quot;capabilities&quot;: { # Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take.
3408 &quot;canAddChildren&quot;: True or False, # Whether the current user can add children to this folder. This is always false when the item is not a folder.
3409 &quot;canAddFolderFromAnotherDrive&quot;: True or False, # Whether the current user can add a folder from another drive (different shared drive or My Drive) to this folder. This is false when the item is not a folder. Only populated for items in shared drives.
3410 &quot;canAddMyDriveParent&quot;: 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.
3411 &quot;canChangeCopyRequiresWriterPermission&quot;: True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this file.
3412 &quot;canChangeRestrictedDownload&quot;: True or False, # Deprecated
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700[diff] [blame^]3413 &quot;canChangeSecurityUpdateEnabled&quot;: True or False, # Whether the current user can change the securityUpdateEnabled field on link share metadata.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]3414 &quot;canComment&quot;: True or False, # Whether the current user can comment on this file.
3415 &quot;canCopy&quot;: 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.
3416 &quot;canDelete&quot;: True or False, # Whether the current user can delete this file.
3417 &quot;canDeleteChildren&quot;: 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.
3418 &quot;canDownload&quot;: True or False, # Whether the current user can download this file.
3419 &quot;canEdit&quot;: 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.
3420 &quot;canListChildren&quot;: 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.
3421 &quot;canModifyContent&quot;: True or False, # Whether the current user can modify the content of this file.
3422 &quot;canModifyContentRestriction&quot;: True or False, # Whether the current user can modify restrictions on content of this file.
3423 &quot;canMoveChildrenOutOfDrive&quot;: 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.
3424 &quot;canMoveChildrenOutOfTeamDrive&quot;: True or False, # Deprecated - use canMoveChildrenOutOfDrive instead.
3425 &quot;canMoveChildrenWithinDrive&quot;: True or False, # Whether the current user can move children of this folder within this drive. This is false when the item is not a folder. Note that a request to move the child may still fail depending on the current user&#x27;s access to the child and to the destination folder.
3426 &quot;canMoveChildrenWithinTeamDrive&quot;: True or False, # Deprecated - use canMoveChildrenWithinDrive instead.
3427 &quot;canMoveItemIntoTeamDrive&quot;: True or False, # Deprecated - use canMoveItemOutOfDrive instead.
3428 &quot;canMoveItemOutOfDrive&quot;: 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.
3429 &quot;canMoveItemOutOfTeamDrive&quot;: True or False, # Deprecated - use canMoveItemOutOfDrive instead.
3430 &quot;canMoveItemWithinDrive&quot;: True or False, # Whether the current user can move this item within this drive. Note that a request to change the parent of the item may still fail depending on the new parent that is being added and the parent that is being removed.
3431 &quot;canMoveItemWithinTeamDrive&quot;: True or False, # Deprecated - use canMoveItemWithinDrive instead.
3432 &quot;canMoveTeamDriveItem&quot;: True or False, # Deprecated - use canMoveItemWithinDrive or canMoveItemOutOfDrive instead.
3433 &quot;canReadDrive&quot;: True or False, # Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives.
3434 &quot;canReadRevisions&quot;: 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.
3435 &quot;canReadTeamDrive&quot;: True or False, # Deprecated - use canReadDrive instead.
3436 &quot;canRemoveChildren&quot;: 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.
3437 &quot;canRemoveMyDriveParent&quot;: 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.
3438 &quot;canRename&quot;: True or False, # Whether the current user can rename this file.
3439 &quot;canShare&quot;: True or False, # Whether the current user can modify the sharing settings for this file.
3440 &quot;canTrash&quot;: True or False, # Whether the current user can move this file to trash.
3441 &quot;canTrashChildren&quot;: 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.
3442 &quot;canUntrash&quot;: True or False, # Whether the current user can restore this file from trash.
3443 },
3444 &quot;contentRestrictions&quot;: [ # Restrictions for accessing the content of the file. Only populated if such a restriction exists.
3445 { # A restriction for accessing the content of the file.
3446 &quot;readOnly&quot;: True or False, # Whether the content of the file is read-only. If a file is read-only, a new revision of the file may not be added, comments may not be added or modified, and the title of the file may not be modified.
3447 &quot;reason&quot;: &quot;A String&quot;, # Reason for why the content of the file is restricted. This is only mutable on requests that also set readOnly=true.
3448 &quot;restrictingUser&quot;: { # Information about a Drive user. # The user who set the content restriction. Only populated if readOnly is true.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]3449 &quot;displayName&quot;: &quot;A String&quot;, # A plain text displayable name for this user.
3450 &quot;emailAddress&quot;: &quot;A String&quot;, # The email address of the user.
3451 &quot;isAuthenticatedUser&quot;: True or False, # Whether this user is the same as the authenticated user for whom the request was made.
3452 &quot;kind&quot;: &quot;drive#user&quot;, # This is always drive#user.
3453 &quot;permissionId&quot;: &quot;A String&quot;, # The user&#x27;s ID as visible in the permissions collection.
3454 &quot;picture&quot;: { # The user&#x27;s profile picture.
3455 &quot;url&quot;: &quot;A String&quot;, # A URL that points to a profile picture of this user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]3456 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]3457 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]3458 &quot;restrictionDate&quot;: &quot;A String&quot;, # The time at which the content restriction was set (formatted RFC 3339 timestamp). Only populated if readOnly is true.
3459 &quot;type&quot;: &quot;A String&quot;, # The type of the content restriction. Currently the only possible value is globalContentRestriction.
3460 },
3461 ],
3462 &quot;copyRequiresWriterPermission&quot;: True or False, # Whether the options to copy, print, or download this file, should be disabled for readers and commenters.
3463 &quot;copyable&quot;: True or False, # Deprecated: use capabilities/canCopy.
3464 &quot;createdDate&quot;: &quot;A String&quot;, # Create time for this file (formatted RFC 3339 timestamp).
3465 &quot;defaultOpenWithLink&quot;: &quot;A String&quot;, # A link to open this file with the user&#x27;s default app for this file. Only populated when the drive.apps.readonly scope is used.
3466 &quot;description&quot;: &quot;A String&quot;, # A short description of the file.
3467 &quot;downloadUrl&quot;: &quot;A String&quot;, # Short lived download URL for the file. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.
3468 &quot;driveId&quot;: &quot;A String&quot;, # ID of the shared drive the file resides in. Only populated for items in shared drives.
3469 &quot;editable&quot;: True or False, # Deprecated: use capabilities/canEdit.
3470 &quot;embedLink&quot;: &quot;A String&quot;, # A link for embedding the file.
3471 &quot;etag&quot;: &quot;A String&quot;, # ETag of the file.
3472 &quot;explicitlyTrashed&quot;: True or False, # Whether this file has been explicitly trashed, as opposed to recursively trashed.
3473 &quot;exportLinks&quot;: { # Links for exporting Docs Editors files to specific formats.
3474 &quot;a_key&quot;: &quot;A String&quot;, # A mapping from export format to URL
3475 },
3476 &quot;fileExtension&quot;: &quot;A String&quot;, # The final component of fullFileExtension with trailing text that does not appear to be part of the extension removed. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.
3477 &quot;fileSize&quot;: &quot;A String&quot;, # The size of the file in bytes. This field is populated for files with content stored in Google Drive and for files in Docs Editors; it is not populated for shortcut files.
3478 &quot;folderColorRgb&quot;: &quot;A String&quot;, # 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.
3479 &quot;fullFileExtension&quot;: &quot;A String&quot;, # The full file extension; extracted from the title. May contain multiple concatenated extensions, such as &quot;tar.gz&quot;. Removing an extension from the title does not clear this field; however, changing the extension on the title does update this field. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.
3480 &quot;hasAugmentedPermissions&quot;: True or False, # Whether there are permissions directly on this file. This field is only populated for items in shared drives.
3481 &quot;hasThumbnail&quot;: 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.
3482 &quot;headRevisionId&quot;: &quot;A String&quot;, # The ID of the file&#x27;s head revision. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.
3483 &quot;iconLink&quot;: &quot;A String&quot;, # A link to the file&#x27;s icon.
3484 &quot;id&quot;: &quot;A String&quot;, # The ID of the file.
3485 &quot;imageMediaMetadata&quot;: { # 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.
3486 &quot;aperture&quot;: 3.14, # The aperture used to create the photo (f-number).
3487 &quot;cameraMake&quot;: &quot;A String&quot;, # The make of the camera used to create the photo.
3488 &quot;cameraModel&quot;: &quot;A String&quot;, # The model of the camera used to create the photo.
3489 &quot;colorSpace&quot;: &quot;A String&quot;, # The color space of the photo.
3490 &quot;date&quot;: &quot;A String&quot;, # The date and time the photo was taken (EXIF format timestamp).
3491 &quot;exposureBias&quot;: 3.14, # The exposure bias of the photo (APEX value).
3492 &quot;exposureMode&quot;: &quot;A String&quot;, # The exposure mode used to create the photo.
3493 &quot;exposureTime&quot;: 3.14, # The length of the exposure, in seconds.
3494 &quot;flashUsed&quot;: True or False, # Whether a flash was used to create the photo.
3495 &quot;focalLength&quot;: 3.14, # The focal length used to create the photo, in millimeters.
3496 &quot;height&quot;: 42, # The height of the image in pixels.
3497 &quot;isoSpeed&quot;: 42, # The ISO speed used to create the photo.
3498 &quot;lens&quot;: &quot;A String&quot;, # The lens used to create the photo.
3499 &quot;location&quot;: { # Geographic location information stored in the image.
3500 &quot;altitude&quot;: 3.14, # The altitude stored in the image.
3501 &quot;latitude&quot;: 3.14, # The latitude stored in the image.
3502 &quot;longitude&quot;: 3.14, # The longitude stored in the image.
3503 },
3504 &quot;maxApertureValue&quot;: 3.14, # The smallest f-number of the lens at the focal length used to create the photo (APEX value).
3505 &quot;meteringMode&quot;: &quot;A String&quot;, # The metering mode used to create the photo.
3506 &quot;rotation&quot;: 42, # The number of clockwise 90 degree rotations applied from the image&#x27;s original orientation.
3507 &quot;sensor&quot;: &quot;A String&quot;, # The type of sensor used to create the photo.
3508 &quot;subjectDistance&quot;: 42, # The distance to the subject of the photo, in meters.
3509 &quot;whiteBalance&quot;: &quot;A String&quot;, # The white balance mode used to create the photo.
3510 &quot;width&quot;: 42, # The width of the image in pixels.
3511 },
3512 &quot;indexableText&quot;: { # Indexable text attributes for the file (can only be written)
3513 &quot;text&quot;: &quot;A String&quot;, # The text to be indexed for this file.
3514 },
3515 &quot;isAppAuthorized&quot;: True or False, # Whether the file was created or opened by the requesting app.
3516 &quot;kind&quot;: &quot;drive#file&quot;, # The type of file. This is always drive#file.
3517 &quot;labels&quot;: { # A group of labels for the file.
3518 &quot;hidden&quot;: True or False, # Deprecated.
3519 &quot;modified&quot;: True or False, # Whether the file has been modified by this user.
3520 &quot;restricted&quot;: True or False, # Deprecated - use copyRequiresWriterPermission instead.
3521 &quot;starred&quot;: True or False, # Whether this file is starred by the user.
3522 &quot;trashed&quot;: True or False, # Whether the file has been trashed, either explicitly or from a trashed parent folder. Only the owner may trash a file. The trashed item is excluded from all files.list responses returned for any user who does not own the file. However, all users with access to the file can see the trashed item metadata in an API response. All users with access can copy, download, export, and share the file.
3523 &quot;viewed&quot;: True or False, # Whether this file has been viewed by this user.
3524 },
3525 &quot;lastModifyingUser&quot;: { # Information about a Drive user. # The last user to modify this file.
3526 &quot;displayName&quot;: &quot;A String&quot;, # A plain text displayable name for this user.
3527 &quot;emailAddress&quot;: &quot;A String&quot;, # The email address of the user.
3528 &quot;isAuthenticatedUser&quot;: True or False, # Whether this user is the same as the authenticated user for whom the request was made.
3529 &quot;kind&quot;: &quot;drive#user&quot;, # This is always drive#user.
3530 &quot;permissionId&quot;: &quot;A String&quot;, # The user&#x27;s ID as visible in the permissions collection.
3531 &quot;picture&quot;: { # The user&#x27;s profile picture.
3532 &quot;url&quot;: &quot;A String&quot;, # A URL that points to a profile picture of this user.
3533 },
3534 },
3535 &quot;lastModifyingUserName&quot;: &quot;A String&quot;, # Name of the last user to modify this file.
3536 &quot;lastViewedByMeDate&quot;: &quot;A String&quot;, # Last time this file was viewed by the user (formatted RFC 3339 timestamp).
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700[diff] [blame^]3537 &quot;linkShareMetadata&quot;: { # Contains details about the link URLs that clients are using to refer to this item.
3538 &quot;securityUpdateEligible&quot;: True or False, # Whether the file is eligible for security update.
3539 &quot;securityUpdateEnabled&quot;: True or False, # Whether the security update is enabled for this file.
3540 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]3541 &quot;markedViewedByMeDate&quot;: &quot;A String&quot;, # Deprecated.
3542 &quot;md5Checksum&quot;: &quot;A String&quot;, # An MD5 checksum for the content of this file. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.
3543 &quot;mimeType&quot;: &quot;A String&quot;, # 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&#x27;s MIME type.
3544 &quot;modifiedByMeDate&quot;: &quot;A String&quot;, # 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.
3545 &quot;modifiedDate&quot;: &quot;A String&quot;, # Last time this file was modified by anyone (formatted RFC 3339 timestamp). This is only mutable on update when the setModifiedDate parameter is set.
3546 &quot;openWithLinks&quot;: { # A map of the id of each of the user&#x27;s apps to a link to open this file with that app. Only populated when the drive.apps.readonly scope is used.
3547 &quot;a_key&quot;: &quot;A String&quot;,
3548 },
3549 &quot;originalFilename&quot;: &quot;A String&quot;, # 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.
3550 &quot;ownedByMe&quot;: True or False, # Whether the file is owned by the current user. Not populated for items in shared drives.
3551 &quot;ownerNames&quot;: [ # Name(s) of the owner(s) of this file. Not populated for items in shared drives.
3552 &quot;A String&quot;,
3553 ],
yoshi-code-botab1d6dc2021-05-28 00:42:02 -0700[diff] [blame]3554 &quot;owners&quot;: [ # The owner of this file. Only certain legacy files may have more than one owner. This field isn&#x27;t populated for items in shared drives.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]3555 { # Information about a Drive user.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]3556 &quot;displayName&quot;: &quot;A String&quot;, # A plain text displayable name for this user.
3557 &quot;emailAddress&quot;: &quot;A String&quot;, # The email address of the user.
3558 &quot;isAuthenticatedUser&quot;: True or False, # Whether this user is the same as the authenticated user for whom the request was made.
3559 &quot;kind&quot;: &quot;drive#user&quot;, # This is always drive#user.
3560 &quot;permissionId&quot;: &quot;A String&quot;, # The user&#x27;s ID as visible in the permissions collection.
3561 &quot;picture&quot;: { # The user&#x27;s profile picture.
3562 &quot;url&quot;: &quot;A String&quot;, # A URL that points to a profile picture of this user.
3563 },
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]3564 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]3565 ],
3566 &quot;parents&quot;: [ # Collection of parent folders which contain this file.
3567 # If not specified as part of an insert request, the file will be placed directly in the user&#x27;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.
3568 { # A reference to a file&#x27;s parent.
3569 &quot;id&quot;: &quot;A String&quot;, # The ID of the parent.
3570 &quot;isRoot&quot;: True or False, # Whether or not the parent is the root folder.
3571 &quot;kind&quot;: &quot;drive#parentReference&quot;, # This is always drive#parentReference.
3572 &quot;parentLink&quot;: &quot;A String&quot;, # A link to the parent.
3573 &quot;selfLink&quot;: &quot;A String&quot;, # A link back to this reference.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]3574 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]3575 ],
3576 &quot;permissionIds&quot;: [ # List of permission IDs for users with access to this file.
3577 &quot;A String&quot;,
3578 ],
3579 &quot;permissions&quot;: [ # The list of permissions for users with access to this file. Not populated for items in shared drives.
3580 { # A permission for a file.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]3581 &quot;additionalRoles&quot;: [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future.
3582 &quot;A String&quot;,
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]3583 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]3584 &quot;authKey&quot;: &quot;A String&quot;, # Deprecated.
3585 &quot;deleted&quot;: True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.
3586 &quot;domain&quot;: &quot;A String&quot;, # 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.
3587 &quot;emailAddress&quot;: &quot;A String&quot;, # 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.
3588 &quot;etag&quot;: &quot;A String&quot;, # The ETag of the permission.
3589 &quot;expirationDate&quot;: &quot;A String&quot;, # 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]3590 # - They cannot be set on shared drive items
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]3591 # - They can only be set on user and group permissions
3592 # - The date must be in the future
3593 # - The date cannot be more than a year in the future
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3594 # - The date can only be set on drive.permissions.update or drive.permissions.patch requests
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]3595 &quot;id&quot;: &quot;A String&quot;, # 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.
3596 &quot;kind&quot;: &quot;drive#permission&quot;, # This is always drive#permission.
3597 &quot;name&quot;: &quot;A String&quot;, # The name for this permission.
3598 &quot;permissionDetails&quot;: [ # 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.
3599 {
3600 &quot;additionalRoles&quot;: [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future.
3601 &quot;A String&quot;,
3602 ],
3603 &quot;inherited&quot;: True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field.
3604 &quot;inheritedFrom&quot;: &quot;A String&quot;, # The ID of the item from which this permission is inherited. This is an output-only field.
3605 &quot;permissionType&quot;: &quot;A String&quot;, # The permission type for this user. While new values may be added in future, the following are currently possible:
3606 # - file
3607 # - member
3608 &quot;role&quot;: &quot;A String&quot;, # The primary role for this user. While new values may be added in the future, the following are currently possible:
3609 # - organizer
3610 # - fileOrganizer
3611 # - writer
3612 # - reader
3613 },
3614 ],
3615 &quot;photoLink&quot;: &quot;A String&quot;, # A link to the profile photo, if available.
3616 &quot;role&quot;: &quot;A String&quot;, # 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]3617 # - owner
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3618 # - organizer
3619 # - fileOrganizer
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]3620 # - writer
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3621 # - reader
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]3622 &quot;selfLink&quot;: &quot;A String&quot;, # A link back to this permission.
3623 &quot;teamDrivePermissionDetails&quot;: [ # Deprecated - use permissionDetails instead.
3624 {
3625 &quot;additionalRoles&quot;: [ # Deprecated - use permissionDetails/additionalRoles instead.
3626 &quot;A String&quot;,
3627 ],
3628 &quot;inherited&quot;: True or False, # Deprecated - use permissionDetails/inherited instead.
3629 &quot;inheritedFrom&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/inheritedFrom instead.
3630 &quot;role&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/role instead.
3631 &quot;teamDrivePermissionType&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/permissionType instead.
3632 },
3633 ],
3634 &quot;type&quot;: &quot;A String&quot;, # The account type. Allowed values are:
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]3635 # - user
3636 # - group
3637 # - domain
3638 # - anyone
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]3639 &quot;value&quot;: &quot;A String&quot;, # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type is anyone, in which case both id and value are ignored.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]3640 &quot;view&quot;: &quot;A String&quot;, # Indicates the view for this permission. Only populated for permissions that belong to a view. published is the only supported value.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]3641 &quot;withLink&quot;: True or False, # Whether the link is required for this permission.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]3642 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]3643 ],
3644 &quot;properties&quot;: [ # The list of properties.
3645 { # A key-value pair attached to a file that is either public or private to an application.
3646 # The following limits apply to file properties:
3647 # - Maximum of 100 properties total per file
3648 # - Maximum of 30 private properties per app
3649 # - Maximum of 30 public properties
3650 # - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property.
3651 &quot;etag&quot;: &quot;A String&quot;, # ETag of the property.
3652 &quot;key&quot;: &quot;A String&quot;, # The key of this property.
3653 &quot;kind&quot;: &quot;drive#property&quot;, # This is always drive#property.
3654 &quot;selfLink&quot;: &quot;A String&quot;, # The link back to this property.
3655 &quot;value&quot;: &quot;A String&quot;, # The value of this property.
yoshi-code-bot69706592021-03-03 03:54:02 -0800[diff] [blame]3656 &quot;visibility&quot;: &quot;A String&quot;, # The visibility of this property. Allowed values are PRIVATE and PUBLIC. (Default: PRIVATE). Private properties can only be retrieved using an authenticated request. An authenticated request uses an access token obtained with a OAuth 2 client ID. You cannot use an API key to retrieve private properties.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]3657 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]3658 ],
3659 &quot;quotaBytesUsed&quot;: &quot;A String&quot;, # The number of quota bytes used by this file.
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700[diff] [blame^]3660 &quot;resourceKey&quot;: &quot;A String&quot;, # A key needed to access the item via a shared link.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]3661 &quot;selfLink&quot;: &quot;A String&quot;, # A link back to this file.
3662 &quot;shareable&quot;: True or False, # Deprecated: use capabilities/canShare.
3663 &quot;shared&quot;: True or False, # Whether the file has been shared. Not populated for items in shared drives.
3664 &quot;sharedWithMeDate&quot;: &quot;A String&quot;, # Time at which this file was shared with the user (formatted RFC 3339 timestamp).
3665 &quot;sharingUser&quot;: { # Information about a Drive user. # User that shared the item with the current user, if available.
3666 &quot;displayName&quot;: &quot;A String&quot;, # A plain text displayable name for this user.
3667 &quot;emailAddress&quot;: &quot;A String&quot;, # The email address of the user.
3668 &quot;isAuthenticatedUser&quot;: True or False, # Whether this user is the same as the authenticated user for whom the request was made.
3669 &quot;kind&quot;: &quot;drive#user&quot;, # This is always drive#user.
3670 &quot;permissionId&quot;: &quot;A String&quot;, # The user&#x27;s ID as visible in the permissions collection.
3671 &quot;picture&quot;: { # The user&#x27;s profile picture.
3672 &quot;url&quot;: &quot;A String&quot;, # A URL that points to a profile picture of this user.
3673 },
3674 },
3675 &quot;shortcutDetails&quot;: { # Shortcut file details. Only populated for shortcut files, which have the mimeType field set to application/vnd.google-apps.shortcut.
3676 &quot;targetId&quot;: &quot;A String&quot;, # The ID of the file that this shortcut points to.
3677 &quot;targetMimeType&quot;: &quot;A String&quot;, # The MIME type of the file that this shortcut points to. The value of this field is a snapshot of the target&#x27;s MIME type, captured when the shortcut is created.
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700[diff] [blame^]3678 &quot;targetResourceKey&quot;: &quot;A String&quot;, # The ResourceKey for the target file.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]3679 },
3680 &quot;spaces&quot;: [ # The list of spaces which contain the file. Supported values are &#x27;drive&#x27;, &#x27;appDataFolder&#x27; and &#x27;photos&#x27;.
3681 &quot;A String&quot;,
3682 ],
3683 &quot;teamDriveId&quot;: &quot;A String&quot;, # Deprecated - use driveId instead.
3684 &quot;thumbnail&quot;: { # A thumbnail for the file. This will only be used if a standard thumbnail cannot be generated.
3685 &quot;image&quot;: &quot;A String&quot;, # The URL-safe Base64 encoded bytes of the thumbnail image. It should conform to RFC 4648 section 5.
3686 &quot;mimeType&quot;: &quot;A String&quot;, # The MIME type of the thumbnail.
3687 },
3688 &quot;thumbnailLink&quot;: &quot;A String&quot;, # A short-lived link to the file&#x27;s thumbnail. Typically lasts on the order of hours. Only populated when the requesting app can access the file&#x27;s content. If the file isn&#x27;t shared publicly, the URL returned in Files.thumbnailLink must be fetched using a credentialed request.
3689 &quot;thumbnailVersion&quot;: &quot;A String&quot;, # The thumbnail version for use in thumbnail cache invalidation.
3690 &quot;title&quot;: &quot;A String&quot;, # 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.
3691 &quot;trashedDate&quot;: &quot;A String&quot;, # The time that the item was trashed (formatted RFC 3339 timestamp). Only populated for items in shared drives.
3692 &quot;trashingUser&quot;: { # Information about a Drive user. # If the file has been explicitly trashed, the user who trashed it. Only populated for items in shared drives.
3693 &quot;displayName&quot;: &quot;A String&quot;, # A plain text displayable name for this user.
3694 &quot;emailAddress&quot;: &quot;A String&quot;, # The email address of the user.
3695 &quot;isAuthenticatedUser&quot;: True or False, # Whether this user is the same as the authenticated user for whom the request was made.
3696 &quot;kind&quot;: &quot;drive#user&quot;, # This is always drive#user.
3697 &quot;permissionId&quot;: &quot;A String&quot;, # The user&#x27;s ID as visible in the permissions collection.
3698 &quot;picture&quot;: { # The user&#x27;s profile picture.
3699 &quot;url&quot;: &quot;A String&quot;, # A URL that points to a profile picture of this user.
3700 },
3701 },
3702 &quot;userPermission&quot;: { # A permission for a file. # The permissions for the authenticated user on this file.
3703 &quot;additionalRoles&quot;: [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future.
3704 &quot;A String&quot;,
3705 ],
3706 &quot;authKey&quot;: &quot;A String&quot;, # Deprecated.
3707 &quot;deleted&quot;: True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.
3708 &quot;domain&quot;: &quot;A String&quot;, # 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.
3709 &quot;emailAddress&quot;: &quot;A String&quot;, # 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.
3710 &quot;etag&quot;: &quot;A String&quot;, # The ETag of the permission.
3711 &quot;expirationDate&quot;: &quot;A String&quot;, # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions:
3712 # - They cannot be set on shared drive items
3713 # - They can only be set on user and group permissions
3714 # - The date must be in the future
3715 # - The date cannot be more than a year in the future
3716 # - The date can only be set on drive.permissions.update or drive.permissions.patch requests
3717 &quot;id&quot;: &quot;A String&quot;, # 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.
3718 &quot;kind&quot;: &quot;drive#permission&quot;, # This is always drive#permission.
3719 &quot;name&quot;: &quot;A String&quot;, # The name for this permission.
3720 &quot;permissionDetails&quot;: [ # 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.
3721 {
3722 &quot;additionalRoles&quot;: [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future.
3723 &quot;A String&quot;,
3724 ],
3725 &quot;inherited&quot;: True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field.
3726 &quot;inheritedFrom&quot;: &quot;A String&quot;, # The ID of the item from which this permission is inherited. This is an output-only field.
3727 &quot;permissionType&quot;: &quot;A String&quot;, # The permission type for this user. While new values may be added in future, the following are currently possible:
3728 # - file
3729 # - member
3730 &quot;role&quot;: &quot;A String&quot;, # The primary role for this user. While new values may be added in the future, the following are currently possible:
3731 # - organizer
3732 # - fileOrganizer
3733 # - writer
3734 # - reader
3735 },
3736 ],
3737 &quot;photoLink&quot;: &quot;A String&quot;, # A link to the profile photo, if available.
3738 &quot;role&quot;: &quot;A String&quot;, # The primary role for this user. While new values may be supported in the future, the following are currently allowed:
3739 # - owner
3740 # - organizer
3741 # - fileOrganizer
3742 # - writer
3743 # - reader
3744 &quot;selfLink&quot;: &quot;A String&quot;, # A link back to this permission.
3745 &quot;teamDrivePermissionDetails&quot;: [ # Deprecated - use permissionDetails instead.
3746 {
3747 &quot;additionalRoles&quot;: [ # Deprecated - use permissionDetails/additionalRoles instead.
3748 &quot;A String&quot;,
3749 ],
3750 &quot;inherited&quot;: True or False, # Deprecated - use permissionDetails/inherited instead.
3751 &quot;inheritedFrom&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/inheritedFrom instead.
3752 &quot;role&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/role instead.
3753 &quot;teamDrivePermissionType&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/permissionType instead.
3754 },
3755 ],
3756 &quot;type&quot;: &quot;A String&quot;, # The account type. Allowed values are:
3757 # - user
3758 # - group
3759 # - domain
3760 # - anyone
3761 &quot;value&quot;: &quot;A String&quot;, # 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.
3762 &quot;view&quot;: &quot;A String&quot;, # Indicates the view for this permission. Only populated for permissions that belong to a view. published is the only supported value.
3763 &quot;withLink&quot;: True or False, # Whether the link is required for this permission.
3764 },
3765 &quot;version&quot;: &quot;A String&quot;, # 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.
3766 &quot;videoMediaMetadata&quot;: { # Metadata about video media. This will only be present for video types.
3767 &quot;durationMillis&quot;: &quot;A String&quot;, # The duration of the video in milliseconds.
3768 &quot;height&quot;: 42, # The height of the video in pixels.
3769 &quot;width&quot;: 42, # The width of the video in pixels.
3770 },
3771 &quot;webContentLink&quot;: &quot;A String&quot;, # 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.
3772 &quot;webViewLink&quot;: &quot;A String&quot;, # A link only available on public folders for viewing their static web assets (HTML, CSS, JS, etc) via Google Drive&#x27;s Website Hosting.
3773 &quot;writersCanShare&quot;: True or False, # Whether writers can share the document with other users. Not populated for items in shared drives.
3774}</pre>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]3775</div>
3776
3777<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]3778 <code class="details" id="trash">trash(fileId, includePermissionsForView=None, supportsAllDrives=None, supportsTeamDrives=None)</code>
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]3779 <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. Only the owner may trash a file. The trashed item is excluded from all files.list responses returned for any user who does not own the file. However, all users with access to the file can see the trashed item metadata in an API response. All users with access can copy, download, export, and share the file.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]3780
3781Args:
3782 fileId: string, The ID of the file to trash. (required)
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]3783 includePermissionsForView: string, Specifies which additional view&#x27;s permissions to include in the response. Only &#x27;published&#x27; is supported.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]3784 supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]3785 supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]3786
3787Returns:
3788 An object of the form:
3789
3790 { # The metadata for a file.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]3791 &quot;alternateLink&quot;: &quot;A String&quot;, # A link for opening the file in a relevant Google editor or viewer.
3792 &quot;appDataContents&quot;: True or False, # Whether this file is in the Application Data folder.
3793 &quot;canComment&quot;: True or False, # Deprecated: use capabilities/canComment.
3794 &quot;canReadRevisions&quot;: True or False, # Deprecated: use capabilities/canReadRevisions.
3795 &quot;capabilities&quot;: { # Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take.
3796 &quot;canAddChildren&quot;: True or False, # Whether the current user can add children to this folder. This is always false when the item is not a folder.
3797 &quot;canAddFolderFromAnotherDrive&quot;: True or False, # Whether the current user can add a folder from another drive (different shared drive or My Drive) to this folder. This is false when the item is not a folder. Only populated for items in shared drives.
3798 &quot;canAddMyDriveParent&quot;: 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.
3799 &quot;canChangeCopyRequiresWriterPermission&quot;: True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this file.
3800 &quot;canChangeRestrictedDownload&quot;: True or False, # Deprecated
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700[diff] [blame^]3801 &quot;canChangeSecurityUpdateEnabled&quot;: True or False, # Whether the current user can change the securityUpdateEnabled field on link share metadata.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]3802 &quot;canComment&quot;: True or False, # Whether the current user can comment on this file.
3803 &quot;canCopy&quot;: 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.
3804 &quot;canDelete&quot;: True or False, # Whether the current user can delete this file.
3805 &quot;canDeleteChildren&quot;: 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.
3806 &quot;canDownload&quot;: True or False, # Whether the current user can download this file.
3807 &quot;canEdit&quot;: 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.
3808 &quot;canListChildren&quot;: 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.
3809 &quot;canModifyContent&quot;: True or False, # Whether the current user can modify the content of this file.
3810 &quot;canModifyContentRestriction&quot;: True or False, # Whether the current user can modify restrictions on content of this file.
3811 &quot;canMoveChildrenOutOfDrive&quot;: 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.
3812 &quot;canMoveChildrenOutOfTeamDrive&quot;: True or False, # Deprecated - use canMoveChildrenOutOfDrive instead.
3813 &quot;canMoveChildrenWithinDrive&quot;: True or False, # Whether the current user can move children of this folder within this drive. This is false when the item is not a folder. Note that a request to move the child may still fail depending on the current user&#x27;s access to the child and to the destination folder.
3814 &quot;canMoveChildrenWithinTeamDrive&quot;: True or False, # Deprecated - use canMoveChildrenWithinDrive instead.
3815 &quot;canMoveItemIntoTeamDrive&quot;: True or False, # Deprecated - use canMoveItemOutOfDrive instead.
3816 &quot;canMoveItemOutOfDrive&quot;: 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.
3817 &quot;canMoveItemOutOfTeamDrive&quot;: True or False, # Deprecated - use canMoveItemOutOfDrive instead.
3818 &quot;canMoveItemWithinDrive&quot;: True or False, # Whether the current user can move this item within this drive. Note that a request to change the parent of the item may still fail depending on the new parent that is being added and the parent that is being removed.
3819 &quot;canMoveItemWithinTeamDrive&quot;: True or False, # Deprecated - use canMoveItemWithinDrive instead.
3820 &quot;canMoveTeamDriveItem&quot;: True or False, # Deprecated - use canMoveItemWithinDrive or canMoveItemOutOfDrive instead.
3821 &quot;canReadDrive&quot;: True or False, # Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives.
3822 &quot;canReadRevisions&quot;: 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.
3823 &quot;canReadTeamDrive&quot;: True or False, # Deprecated - use canReadDrive instead.
3824 &quot;canRemoveChildren&quot;: 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.
3825 &quot;canRemoveMyDriveParent&quot;: 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.
3826 &quot;canRename&quot;: True or False, # Whether the current user can rename this file.
3827 &quot;canShare&quot;: True or False, # Whether the current user can modify the sharing settings for this file.
3828 &quot;canTrash&quot;: True or False, # Whether the current user can move this file to trash.
3829 &quot;canTrashChildren&quot;: 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.
3830 &quot;canUntrash&quot;: True or False, # Whether the current user can restore this file from trash.
3831 },
3832 &quot;contentRestrictions&quot;: [ # Restrictions for accessing the content of the file. Only populated if such a restriction exists.
3833 { # A restriction for accessing the content of the file.
3834 &quot;readOnly&quot;: True or False, # Whether the content of the file is read-only. If a file is read-only, a new revision of the file may not be added, comments may not be added or modified, and the title of the file may not be modified.
3835 &quot;reason&quot;: &quot;A String&quot;, # Reason for why the content of the file is restricted. This is only mutable on requests that also set readOnly=true.
3836 &quot;restrictingUser&quot;: { # Information about a Drive user. # The user who set the content restriction. Only populated if readOnly is true.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]3837 &quot;displayName&quot;: &quot;A String&quot;, # A plain text displayable name for this user.
3838 &quot;emailAddress&quot;: &quot;A String&quot;, # The email address of the user.
3839 &quot;isAuthenticatedUser&quot;: True or False, # Whether this user is the same as the authenticated user for whom the request was made.
3840 &quot;kind&quot;: &quot;drive#user&quot;, # This is always drive#user.
3841 &quot;permissionId&quot;: &quot;A String&quot;, # The user&#x27;s ID as visible in the permissions collection.
3842 &quot;picture&quot;: { # The user&#x27;s profile picture.
3843 &quot;url&quot;: &quot;A String&quot;, # A URL that points to a profile picture of this user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]3844 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]3845 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]3846 &quot;restrictionDate&quot;: &quot;A String&quot;, # The time at which the content restriction was set (formatted RFC 3339 timestamp). Only populated if readOnly is true.
3847 &quot;type&quot;: &quot;A String&quot;, # The type of the content restriction. Currently the only possible value is globalContentRestriction.
3848 },
3849 ],
3850 &quot;copyRequiresWriterPermission&quot;: True or False, # Whether the options to copy, print, or download this file, should be disabled for readers and commenters.
3851 &quot;copyable&quot;: True or False, # Deprecated: use capabilities/canCopy.
3852 &quot;createdDate&quot;: &quot;A String&quot;, # Create time for this file (formatted RFC 3339 timestamp).
3853 &quot;defaultOpenWithLink&quot;: &quot;A String&quot;, # A link to open this file with the user&#x27;s default app for this file. Only populated when the drive.apps.readonly scope is used.
3854 &quot;description&quot;: &quot;A String&quot;, # A short description of the file.
3855 &quot;downloadUrl&quot;: &quot;A String&quot;, # Short lived download URL for the file. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.
3856 &quot;driveId&quot;: &quot;A String&quot;, # ID of the shared drive the file resides in. Only populated for items in shared drives.
3857 &quot;editable&quot;: True or False, # Deprecated: use capabilities/canEdit.
3858 &quot;embedLink&quot;: &quot;A String&quot;, # A link for embedding the file.
3859 &quot;etag&quot;: &quot;A String&quot;, # ETag of the file.
3860 &quot;explicitlyTrashed&quot;: True or False, # Whether this file has been explicitly trashed, as opposed to recursively trashed.
3861 &quot;exportLinks&quot;: { # Links for exporting Docs Editors files to specific formats.
3862 &quot;a_key&quot;: &quot;A String&quot;, # A mapping from export format to URL
3863 },
3864 &quot;fileExtension&quot;: &quot;A String&quot;, # The final component of fullFileExtension with trailing text that does not appear to be part of the extension removed. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.
3865 &quot;fileSize&quot;: &quot;A String&quot;, # The size of the file in bytes. This field is populated for files with content stored in Google Drive and for files in Docs Editors; it is not populated for shortcut files.
3866 &quot;folderColorRgb&quot;: &quot;A String&quot;, # 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.
3867 &quot;fullFileExtension&quot;: &quot;A String&quot;, # The full file extension; extracted from the title. May contain multiple concatenated extensions, such as &quot;tar.gz&quot;. Removing an extension from the title does not clear this field; however, changing the extension on the title does update this field. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.
3868 &quot;hasAugmentedPermissions&quot;: True or False, # Whether there are permissions directly on this file. This field is only populated for items in shared drives.
3869 &quot;hasThumbnail&quot;: 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.
3870 &quot;headRevisionId&quot;: &quot;A String&quot;, # The ID of the file&#x27;s head revision. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.
3871 &quot;iconLink&quot;: &quot;A String&quot;, # A link to the file&#x27;s icon.
3872 &quot;id&quot;: &quot;A String&quot;, # The ID of the file.
3873 &quot;imageMediaMetadata&quot;: { # 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.
3874 &quot;aperture&quot;: 3.14, # The aperture used to create the photo (f-number).
3875 &quot;cameraMake&quot;: &quot;A String&quot;, # The make of the camera used to create the photo.
3876 &quot;cameraModel&quot;: &quot;A String&quot;, # The model of the camera used to create the photo.
3877 &quot;colorSpace&quot;: &quot;A String&quot;, # The color space of the photo.
3878 &quot;date&quot;: &quot;A String&quot;, # The date and time the photo was taken (EXIF format timestamp).
3879 &quot;exposureBias&quot;: 3.14, # The exposure bias of the photo (APEX value).
3880 &quot;exposureMode&quot;: &quot;A String&quot;, # The exposure mode used to create the photo.
3881 &quot;exposureTime&quot;: 3.14, # The length of the exposure, in seconds.
3882 &quot;flashUsed&quot;: True or False, # Whether a flash was used to create the photo.
3883 &quot;focalLength&quot;: 3.14, # The focal length used to create the photo, in millimeters.
3884 &quot;height&quot;: 42, # The height of the image in pixels.
3885 &quot;isoSpeed&quot;: 42, # The ISO speed used to create the photo.
3886 &quot;lens&quot;: &quot;A String&quot;, # The lens used to create the photo.
3887 &quot;location&quot;: { # Geographic location information stored in the image.
3888 &quot;altitude&quot;: 3.14, # The altitude stored in the image.
3889 &quot;latitude&quot;: 3.14, # The latitude stored in the image.
3890 &quot;longitude&quot;: 3.14, # The longitude stored in the image.
3891 },
3892 &quot;maxApertureValue&quot;: 3.14, # The smallest f-number of the lens at the focal length used to create the photo (APEX value).
3893 &quot;meteringMode&quot;: &quot;A String&quot;, # The metering mode used to create the photo.
3894 &quot;rotation&quot;: 42, # The number of clockwise 90 degree rotations applied from the image&#x27;s original orientation.
3895 &quot;sensor&quot;: &quot;A String&quot;, # The type of sensor used to create the photo.
3896 &quot;subjectDistance&quot;: 42, # The distance to the subject of the photo, in meters.
3897 &quot;whiteBalance&quot;: &quot;A String&quot;, # The white balance mode used to create the photo.
3898 &quot;width&quot;: 42, # The width of the image in pixels.
3899 },
3900 &quot;indexableText&quot;: { # Indexable text attributes for the file (can only be written)
3901 &quot;text&quot;: &quot;A String&quot;, # The text to be indexed for this file.
3902 },
3903 &quot;isAppAuthorized&quot;: True or False, # Whether the file was created or opened by the requesting app.
3904 &quot;kind&quot;: &quot;drive#file&quot;, # The type of file. This is always drive#file.
3905 &quot;labels&quot;: { # A group of labels for the file.
3906 &quot;hidden&quot;: True or False, # Deprecated.
3907 &quot;modified&quot;: True or False, # Whether the file has been modified by this user.
3908 &quot;restricted&quot;: True or False, # Deprecated - use copyRequiresWriterPermission instead.
3909 &quot;starred&quot;: True or False, # Whether this file is starred by the user.
3910 &quot;trashed&quot;: True or False, # Whether the file has been trashed, either explicitly or from a trashed parent folder. Only the owner may trash a file. The trashed item is excluded from all files.list responses returned for any user who does not own the file. However, all users with access to the file can see the trashed item metadata in an API response. All users with access can copy, download, export, and share the file.
3911 &quot;viewed&quot;: True or False, # Whether this file has been viewed by this user.
3912 },
3913 &quot;lastModifyingUser&quot;: { # Information about a Drive user. # The last user to modify this file.
3914 &quot;displayName&quot;: &quot;A String&quot;, # A plain text displayable name for this user.
3915 &quot;emailAddress&quot;: &quot;A String&quot;, # The email address of the user.
3916 &quot;isAuthenticatedUser&quot;: True or False, # Whether this user is the same as the authenticated user for whom the request was made.
3917 &quot;kind&quot;: &quot;drive#user&quot;, # This is always drive#user.
3918 &quot;permissionId&quot;: &quot;A String&quot;, # The user&#x27;s ID as visible in the permissions collection.
3919 &quot;picture&quot;: { # The user&#x27;s profile picture.
3920 &quot;url&quot;: &quot;A String&quot;, # A URL that points to a profile picture of this user.
3921 },
3922 },
3923 &quot;lastModifyingUserName&quot;: &quot;A String&quot;, # Name of the last user to modify this file.
3924 &quot;lastViewedByMeDate&quot;: &quot;A String&quot;, # Last time this file was viewed by the user (formatted RFC 3339 timestamp).
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700[diff] [blame^]3925 &quot;linkShareMetadata&quot;: { # Contains details about the link URLs that clients are using to refer to this item.
3926 &quot;securityUpdateEligible&quot;: True or False, # Whether the file is eligible for security update.
3927 &quot;securityUpdateEnabled&quot;: True or False, # Whether the security update is enabled for this file.
3928 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]3929 &quot;markedViewedByMeDate&quot;: &quot;A String&quot;, # Deprecated.
3930 &quot;md5Checksum&quot;: &quot;A String&quot;, # An MD5 checksum for the content of this file. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.
3931 &quot;mimeType&quot;: &quot;A String&quot;, # 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&#x27;s MIME type.
3932 &quot;modifiedByMeDate&quot;: &quot;A String&quot;, # 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.
3933 &quot;modifiedDate&quot;: &quot;A String&quot;, # Last time this file was modified by anyone (formatted RFC 3339 timestamp). This is only mutable on update when the setModifiedDate parameter is set.
3934 &quot;openWithLinks&quot;: { # A map of the id of each of the user&#x27;s apps to a link to open this file with that app. Only populated when the drive.apps.readonly scope is used.
3935 &quot;a_key&quot;: &quot;A String&quot;,
3936 },
3937 &quot;originalFilename&quot;: &quot;A String&quot;, # 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.
3938 &quot;ownedByMe&quot;: True or False, # Whether the file is owned by the current user. Not populated for items in shared drives.
3939 &quot;ownerNames&quot;: [ # Name(s) of the owner(s) of this file. Not populated for items in shared drives.
3940 &quot;A String&quot;,
3941 ],
yoshi-code-botab1d6dc2021-05-28 00:42:02 -0700[diff] [blame]3942 &quot;owners&quot;: [ # The owner of this file. Only certain legacy files may have more than one owner. This field isn&#x27;t populated for items in shared drives.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]3943 { # Information about a Drive user.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]3944 &quot;displayName&quot;: &quot;A String&quot;, # A plain text displayable name for this user.
3945 &quot;emailAddress&quot;: &quot;A String&quot;, # The email address of the user.
3946 &quot;isAuthenticatedUser&quot;: True or False, # Whether this user is the same as the authenticated user for whom the request was made.
3947 &quot;kind&quot;: &quot;drive#user&quot;, # This is always drive#user.
3948 &quot;permissionId&quot;: &quot;A String&quot;, # The user&#x27;s ID as visible in the permissions collection.
3949 &quot;picture&quot;: { # The user&#x27;s profile picture.
3950 &quot;url&quot;: &quot;A String&quot;, # A URL that points to a profile picture of this user.
3951 },
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]3952 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]3953 ],
3954 &quot;parents&quot;: [ # Collection of parent folders which contain this file.
3955 # If not specified as part of an insert request, the file will be placed directly in the user&#x27;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.
3956 { # A reference to a file&#x27;s parent.
3957 &quot;id&quot;: &quot;A String&quot;, # The ID of the parent.
3958 &quot;isRoot&quot;: True or False, # Whether or not the parent is the root folder.
3959 &quot;kind&quot;: &quot;drive#parentReference&quot;, # This is always drive#parentReference.
3960 &quot;parentLink&quot;: &quot;A String&quot;, # A link to the parent.
3961 &quot;selfLink&quot;: &quot;A String&quot;, # A link back to this reference.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]3962 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]3963 ],
3964 &quot;permissionIds&quot;: [ # List of permission IDs for users with access to this file.
3965 &quot;A String&quot;,
3966 ],
3967 &quot;permissions&quot;: [ # The list of permissions for users with access to this file. Not populated for items in shared drives.
3968 { # A permission for a file.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]3969 &quot;additionalRoles&quot;: [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future.
3970 &quot;A String&quot;,
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]3971 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]3972 &quot;authKey&quot;: &quot;A String&quot;, # Deprecated.
3973 &quot;deleted&quot;: True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.
3974 &quot;domain&quot;: &quot;A String&quot;, # 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.
3975 &quot;emailAddress&quot;: &quot;A String&quot;, # 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.
3976 &quot;etag&quot;: &quot;A String&quot;, # The ETag of the permission.
3977 &quot;expirationDate&quot;: &quot;A String&quot;, # 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]3978 # - They cannot be set on shared drive items
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]3979 # - They can only be set on user and group permissions
3980 # - The date must be in the future
3981 # - The date cannot be more than a year in the future
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3982 # - The date can only be set on drive.permissions.update or drive.permissions.patch requests
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]3983 &quot;id&quot;: &quot;A String&quot;, # 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.
3984 &quot;kind&quot;: &quot;drive#permission&quot;, # This is always drive#permission.
3985 &quot;name&quot;: &quot;A String&quot;, # The name for this permission.
3986 &quot;permissionDetails&quot;: [ # 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.
3987 {
3988 &quot;additionalRoles&quot;: [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future.
3989 &quot;A String&quot;,
3990 ],
3991 &quot;inherited&quot;: True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field.
3992 &quot;inheritedFrom&quot;: &quot;A String&quot;, # The ID of the item from which this permission is inherited. This is an output-only field.
3993 &quot;permissionType&quot;: &quot;A String&quot;, # The permission type for this user. While new values may be added in future, the following are currently possible:
3994 # - file
3995 # - member
3996 &quot;role&quot;: &quot;A String&quot;, # The primary role for this user. While new values may be added in the future, the following are currently possible:
3997 # - organizer
3998 # - fileOrganizer
3999 # - writer
4000 # - reader
4001 },
4002 ],
4003 &quot;photoLink&quot;: &quot;A String&quot;, # A link to the profile photo, if available.
4004 &quot;role&quot;: &quot;A String&quot;, # 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]4005 # - owner
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4006 # - organizer
4007 # - fileOrganizer
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]4008 # - writer
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4009 # - reader
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]4010 &quot;selfLink&quot;: &quot;A String&quot;, # A link back to this permission.
4011 &quot;teamDrivePermissionDetails&quot;: [ # Deprecated - use permissionDetails instead.
4012 {
4013 &quot;additionalRoles&quot;: [ # Deprecated - use permissionDetails/additionalRoles instead.
4014 &quot;A String&quot;,
4015 ],
4016 &quot;inherited&quot;: True or False, # Deprecated - use permissionDetails/inherited instead.
4017 &quot;inheritedFrom&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/inheritedFrom instead.
4018 &quot;role&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/role instead.
4019 &quot;teamDrivePermissionType&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/permissionType instead.
4020 },
4021 ],
4022 &quot;type&quot;: &quot;A String&quot;, # The account type. Allowed values are:
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]4023 # - user
4024 # - group
4025 # - domain
4026 # - anyone
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]4027 &quot;value&quot;: &quot;A String&quot;, # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type is anyone, in which case both id and value are ignored.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]4028 &quot;view&quot;: &quot;A String&quot;, # Indicates the view for this permission. Only populated for permissions that belong to a view. published is the only supported value.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]4029 &quot;withLink&quot;: True or False, # Whether the link is required for this permission.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]4030 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]4031 ],
4032 &quot;properties&quot;: [ # The list of properties.
4033 { # A key-value pair attached to a file that is either public or private to an application.
4034 # The following limits apply to file properties:
4035 # - Maximum of 100 properties total per file
4036 # - Maximum of 30 private properties per app
4037 # - Maximum of 30 public properties
4038 # - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property.
4039 &quot;etag&quot;: &quot;A String&quot;, # ETag of the property.
4040 &quot;key&quot;: &quot;A String&quot;, # The key of this property.
4041 &quot;kind&quot;: &quot;drive#property&quot;, # This is always drive#property.
4042 &quot;selfLink&quot;: &quot;A String&quot;, # The link back to this property.
4043 &quot;value&quot;: &quot;A String&quot;, # The value of this property.
yoshi-code-bot69706592021-03-03 03:54:02 -0800[diff] [blame]4044 &quot;visibility&quot;: &quot;A String&quot;, # The visibility of this property. Allowed values are PRIVATE and PUBLIC. (Default: PRIVATE). Private properties can only be retrieved using an authenticated request. An authenticated request uses an access token obtained with a OAuth 2 client ID. You cannot use an API key to retrieve private properties.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]4045 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]4046 ],
4047 &quot;quotaBytesUsed&quot;: &quot;A String&quot;, # The number of quota bytes used by this file.
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700[diff] [blame^]4048 &quot;resourceKey&quot;: &quot;A String&quot;, # A key needed to access the item via a shared link.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]4049 &quot;selfLink&quot;: &quot;A String&quot;, # A link back to this file.
4050 &quot;shareable&quot;: True or False, # Deprecated: use capabilities/canShare.
4051 &quot;shared&quot;: True or False, # Whether the file has been shared. Not populated for items in shared drives.
4052 &quot;sharedWithMeDate&quot;: &quot;A String&quot;, # Time at which this file was shared with the user (formatted RFC 3339 timestamp).
4053 &quot;sharingUser&quot;: { # Information about a Drive user. # User that shared the item with the current user, if available.
4054 &quot;displayName&quot;: &quot;A String&quot;, # A plain text displayable name for this user.
4055 &quot;emailAddress&quot;: &quot;A String&quot;, # The email address of the user.
4056 &quot;isAuthenticatedUser&quot;: True or False, # Whether this user is the same as the authenticated user for whom the request was made.
4057 &quot;kind&quot;: &quot;drive#user&quot;, # This is always drive#user.
4058 &quot;permissionId&quot;: &quot;A String&quot;, # The user&#x27;s ID as visible in the permissions collection.
4059 &quot;picture&quot;: { # The user&#x27;s profile picture.
4060 &quot;url&quot;: &quot;A String&quot;, # A URL that points to a profile picture of this user.
4061 },
4062 },
4063 &quot;shortcutDetails&quot;: { # Shortcut file details. Only populated for shortcut files, which have the mimeType field set to application/vnd.google-apps.shortcut.
4064 &quot;targetId&quot;: &quot;A String&quot;, # The ID of the file that this shortcut points to.
4065 &quot;targetMimeType&quot;: &quot;A String&quot;, # The MIME type of the file that this shortcut points to. The value of this field is a snapshot of the target&#x27;s MIME type, captured when the shortcut is created.
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700[diff] [blame^]4066 &quot;targetResourceKey&quot;: &quot;A String&quot;, # The ResourceKey for the target file.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]4067 },
4068 &quot;spaces&quot;: [ # The list of spaces which contain the file. Supported values are &#x27;drive&#x27;, &#x27;appDataFolder&#x27; and &#x27;photos&#x27;.
4069 &quot;A String&quot;,
4070 ],
4071 &quot;teamDriveId&quot;: &quot;A String&quot;, # Deprecated - use driveId instead.
4072 &quot;thumbnail&quot;: { # A thumbnail for the file. This will only be used if a standard thumbnail cannot be generated.
4073 &quot;image&quot;: &quot;A String&quot;, # The URL-safe Base64 encoded bytes of the thumbnail image. It should conform to RFC 4648 section 5.
4074 &quot;mimeType&quot;: &quot;A String&quot;, # The MIME type of the thumbnail.
4075 },
4076 &quot;thumbnailLink&quot;: &quot;A String&quot;, # A short-lived link to the file&#x27;s thumbnail. Typically lasts on the order of hours. Only populated when the requesting app can access the file&#x27;s content. If the file isn&#x27;t shared publicly, the URL returned in Files.thumbnailLink must be fetched using a credentialed request.
4077 &quot;thumbnailVersion&quot;: &quot;A String&quot;, # The thumbnail version for use in thumbnail cache invalidation.
4078 &quot;title&quot;: &quot;A String&quot;, # 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.
4079 &quot;trashedDate&quot;: &quot;A String&quot;, # The time that the item was trashed (formatted RFC 3339 timestamp). Only populated for items in shared drives.
4080 &quot;trashingUser&quot;: { # Information about a Drive user. # If the file has been explicitly trashed, the user who trashed it. Only populated for items in shared drives.
4081 &quot;displayName&quot;: &quot;A String&quot;, # A plain text displayable name for this user.
4082 &quot;emailAddress&quot;: &quot;A String&quot;, # The email address of the user.
4083 &quot;isAuthenticatedUser&quot;: True or False, # Whether this user is the same as the authenticated user for whom the request was made.
4084 &quot;kind&quot;: &quot;drive#user&quot;, # This is always drive#user.
4085 &quot;permissionId&quot;: &quot;A String&quot;, # The user&#x27;s ID as visible in the permissions collection.
4086 &quot;picture&quot;: { # The user&#x27;s profile picture.
4087 &quot;url&quot;: &quot;A String&quot;, # A URL that points to a profile picture of this user.
4088 },
4089 },
4090 &quot;userPermission&quot;: { # A permission for a file. # The permissions for the authenticated user on this file.
4091 &quot;additionalRoles&quot;: [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future.
4092 &quot;A String&quot;,
4093 ],
4094 &quot;authKey&quot;: &quot;A String&quot;, # Deprecated.
4095 &quot;deleted&quot;: True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.
4096 &quot;domain&quot;: &quot;A String&quot;, # 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.
4097 &quot;emailAddress&quot;: &quot;A String&quot;, # 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.
4098 &quot;etag&quot;: &quot;A String&quot;, # The ETag of the permission.
4099 &quot;expirationDate&quot;: &quot;A String&quot;, # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions:
4100 # - They cannot be set on shared drive items
4101 # - They can only be set on user and group permissions
4102 # - The date must be in the future
4103 # - The date cannot be more than a year in the future
4104 # - The date can only be set on drive.permissions.update or drive.permissions.patch requests
4105 &quot;id&quot;: &quot;A String&quot;, # 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.
4106 &quot;kind&quot;: &quot;drive#permission&quot;, # This is always drive#permission.
4107 &quot;name&quot;: &quot;A String&quot;, # The name for this permission.
4108 &quot;permissionDetails&quot;: [ # 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.
4109 {
4110 &quot;additionalRoles&quot;: [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future.
4111 &quot;A String&quot;,
4112 ],
4113 &quot;inherited&quot;: True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field.
4114 &quot;inheritedFrom&quot;: &quot;A String&quot;, # The ID of the item from which this permission is inherited. This is an output-only field.
4115 &quot;permissionType&quot;: &quot;A String&quot;, # The permission type for this user. While new values may be added in future, the following are currently possible:
4116 # - file
4117 # - member
4118 &quot;role&quot;: &quot;A String&quot;, # The primary role for this user. While new values may be added in the future, the following are currently possible:
4119 # - organizer
4120 # - fileOrganizer
4121 # - writer
4122 # - reader
4123 },
4124 ],
4125 &quot;photoLink&quot;: &quot;A String&quot;, # A link to the profile photo, if available.
4126 &quot;role&quot;: &quot;A String&quot;, # The primary role for this user. While new values may be supported in the future, the following are currently allowed:
4127 # - owner
4128 # - organizer
4129 # - fileOrganizer
4130 # - writer
4131 # - reader
4132 &quot;selfLink&quot;: &quot;A String&quot;, # A link back to this permission.
4133 &quot;teamDrivePermissionDetails&quot;: [ # Deprecated - use permissionDetails instead.
4134 {
4135 &quot;additionalRoles&quot;: [ # Deprecated - use permissionDetails/additionalRoles instead.
4136 &quot;A String&quot;,
4137 ],
4138 &quot;inherited&quot;: True or False, # Deprecated - use permissionDetails/inherited instead.
4139 &quot;inheritedFrom&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/inheritedFrom instead.
4140 &quot;role&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/role instead.
4141 &quot;teamDrivePermissionType&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/permissionType instead.
4142 },
4143 ],
4144 &quot;type&quot;: &quot;A String&quot;, # The account type. Allowed values are:
4145 # - user
4146 # - group
4147 # - domain
4148 # - anyone
4149 &quot;value&quot;: &quot;A String&quot;, # 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.
4150 &quot;view&quot;: &quot;A String&quot;, # Indicates the view for this permission. Only populated for permissions that belong to a view. published is the only supported value.
4151 &quot;withLink&quot;: True or False, # Whether the link is required for this permission.
4152 },
4153 &quot;version&quot;: &quot;A String&quot;, # 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.
4154 &quot;videoMediaMetadata&quot;: { # Metadata about video media. This will only be present for video types.
4155 &quot;durationMillis&quot;: &quot;A String&quot;, # The duration of the video in milliseconds.
4156 &quot;height&quot;: 42, # The height of the video in pixels.
4157 &quot;width&quot;: 42, # The width of the video in pixels.
4158 },
4159 &quot;webContentLink&quot;: &quot;A String&quot;, # 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.
4160 &quot;webViewLink&quot;: &quot;A String&quot;, # A link only available on public folders for viewing their static web assets (HTML, CSS, JS, etc) via Google Drive&#x27;s Website Hosting.
4161 &quot;writersCanShare&quot;: True or False, # Whether writers can share the document with other users. Not populated for items in shared drives.
4162}</pre>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]4163</div>
4164
4165<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]4166 <code class="details" id="untrash">untrash(fileId, includePermissionsForView=None, supportsAllDrives=None, supportsTeamDrives=None)</code>
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]4167 <pre>Restores a file from the trash. The currently authenticated user must own the file or be at least a fileOrganizer on the parent for shared drive files. Only the owner may untrash a file.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]4168
4169Args:
4170 fileId: string, The ID of the file to untrash. (required)
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]4171 includePermissionsForView: string, Specifies which additional view&#x27;s permissions to include in the response. Only &#x27;published&#x27; is supported.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]4172 supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]4173 supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]4174
4175Returns:
4176 An object of the form:
4177
4178 { # The metadata for a file.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]4179 &quot;alternateLink&quot;: &quot;A String&quot;, # A link for opening the file in a relevant Google editor or viewer.
4180 &quot;appDataContents&quot;: True or False, # Whether this file is in the Application Data folder.
4181 &quot;canComment&quot;: True or False, # Deprecated: use capabilities/canComment.
4182 &quot;canReadRevisions&quot;: True or False, # Deprecated: use capabilities/canReadRevisions.
4183 &quot;capabilities&quot;: { # Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take.
4184 &quot;canAddChildren&quot;: True or False, # Whether the current user can add children to this folder. This is always false when the item is not a folder.
4185 &quot;canAddFolderFromAnotherDrive&quot;: True or False, # Whether the current user can add a folder from another drive (different shared drive or My Drive) to this folder. This is false when the item is not a folder. Only populated for items in shared drives.
4186 &quot;canAddMyDriveParent&quot;: 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.
4187 &quot;canChangeCopyRequiresWriterPermission&quot;: True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this file.
4188 &quot;canChangeRestrictedDownload&quot;: True or False, # Deprecated
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700[diff] [blame^]4189 &quot;canChangeSecurityUpdateEnabled&quot;: True or False, # Whether the current user can change the securityUpdateEnabled field on link share metadata.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]4190 &quot;canComment&quot;: True or False, # Whether the current user can comment on this file.
4191 &quot;canCopy&quot;: 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.
4192 &quot;canDelete&quot;: True or False, # Whether the current user can delete this file.
4193 &quot;canDeleteChildren&quot;: 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.
4194 &quot;canDownload&quot;: True or False, # Whether the current user can download this file.
4195 &quot;canEdit&quot;: 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.
4196 &quot;canListChildren&quot;: 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.
4197 &quot;canModifyContent&quot;: True or False, # Whether the current user can modify the content of this file.
4198 &quot;canModifyContentRestriction&quot;: True or False, # Whether the current user can modify restrictions on content of this file.
4199 &quot;canMoveChildrenOutOfDrive&quot;: 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.
4200 &quot;canMoveChildrenOutOfTeamDrive&quot;: True or False, # Deprecated - use canMoveChildrenOutOfDrive instead.
4201 &quot;canMoveChildrenWithinDrive&quot;: True or False, # Whether the current user can move children of this folder within this drive. This is false when the item is not a folder. Note that a request to move the child may still fail depending on the current user&#x27;s access to the child and to the destination folder.
4202 &quot;canMoveChildrenWithinTeamDrive&quot;: True or False, # Deprecated - use canMoveChildrenWithinDrive instead.
4203 &quot;canMoveItemIntoTeamDrive&quot;: True or False, # Deprecated - use canMoveItemOutOfDrive instead.
4204 &quot;canMoveItemOutOfDrive&quot;: 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.
4205 &quot;canMoveItemOutOfTeamDrive&quot;: True or False, # Deprecated - use canMoveItemOutOfDrive instead.
4206 &quot;canMoveItemWithinDrive&quot;: True or False, # Whether the current user can move this item within this drive. Note that a request to change the parent of the item may still fail depending on the new parent that is being added and the parent that is being removed.
4207 &quot;canMoveItemWithinTeamDrive&quot;: True or False, # Deprecated - use canMoveItemWithinDrive instead.
4208 &quot;canMoveTeamDriveItem&quot;: True or False, # Deprecated - use canMoveItemWithinDrive or canMoveItemOutOfDrive instead.
4209 &quot;canReadDrive&quot;: True or False, # Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives.
4210 &quot;canReadRevisions&quot;: 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.
4211 &quot;canReadTeamDrive&quot;: True or False, # Deprecated - use canReadDrive instead.
4212 &quot;canRemoveChildren&quot;: 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.
4213 &quot;canRemoveMyDriveParent&quot;: 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.
4214 &quot;canRename&quot;: True or False, # Whether the current user can rename this file.
4215 &quot;canShare&quot;: True or False, # Whether the current user can modify the sharing settings for this file.
4216 &quot;canTrash&quot;: True or False, # Whether the current user can move this file to trash.
4217 &quot;canTrashChildren&quot;: 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.
4218 &quot;canUntrash&quot;: True or False, # Whether the current user can restore this file from trash.
4219 },
4220 &quot;contentRestrictions&quot;: [ # Restrictions for accessing the content of the file. Only populated if such a restriction exists.
4221 { # A restriction for accessing the content of the file.
4222 &quot;readOnly&quot;: True or False, # Whether the content of the file is read-only. If a file is read-only, a new revision of the file may not be added, comments may not be added or modified, and the title of the file may not be modified.
4223 &quot;reason&quot;: &quot;A String&quot;, # Reason for why the content of the file is restricted. This is only mutable on requests that also set readOnly=true.
4224 &quot;restrictingUser&quot;: { # Information about a Drive user. # The user who set the content restriction. Only populated if readOnly is true.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]4225 &quot;displayName&quot;: &quot;A String&quot;, # A plain text displayable name for this user.
4226 &quot;emailAddress&quot;: &quot;A String&quot;, # The email address of the user.
4227 &quot;isAuthenticatedUser&quot;: True or False, # Whether this user is the same as the authenticated user for whom the request was made.
4228 &quot;kind&quot;: &quot;drive#user&quot;, # This is always drive#user.
4229 &quot;permissionId&quot;: &quot;A String&quot;, # The user&#x27;s ID as visible in the permissions collection.
4230 &quot;picture&quot;: { # The user&#x27;s profile picture.
4231 &quot;url&quot;: &quot;A String&quot;, # A URL that points to a profile picture of this user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]4232 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]4233 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]4234 &quot;restrictionDate&quot;: &quot;A String&quot;, # The time at which the content restriction was set (formatted RFC 3339 timestamp). Only populated if readOnly is true.
4235 &quot;type&quot;: &quot;A String&quot;, # The type of the content restriction. Currently the only possible value is globalContentRestriction.
4236 },
4237 ],
4238 &quot;copyRequiresWriterPermission&quot;: True or False, # Whether the options to copy, print, or download this file, should be disabled for readers and commenters.
4239 &quot;copyable&quot;: True or False, # Deprecated: use capabilities/canCopy.
4240 &quot;createdDate&quot;: &quot;A String&quot;, # Create time for this file (formatted RFC 3339 timestamp).
4241 &quot;defaultOpenWithLink&quot;: &quot;A String&quot;, # A link to open this file with the user&#x27;s default app for this file. Only populated when the drive.apps.readonly scope is used.
4242 &quot;description&quot;: &quot;A String&quot;, # A short description of the file.
4243 &quot;downloadUrl&quot;: &quot;A String&quot;, # Short lived download URL for the file. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.
4244 &quot;driveId&quot;: &quot;A String&quot;, # ID of the shared drive the file resides in. Only populated for items in shared drives.
4245 &quot;editable&quot;: True or False, # Deprecated: use capabilities/canEdit.
4246 &quot;embedLink&quot;: &quot;A String&quot;, # A link for embedding the file.
4247 &quot;etag&quot;: &quot;A String&quot;, # ETag of the file.
4248 &quot;explicitlyTrashed&quot;: True or False, # Whether this file has been explicitly trashed, as opposed to recursively trashed.
4249 &quot;exportLinks&quot;: { # Links for exporting Docs Editors files to specific formats.
4250 &quot;a_key&quot;: &quot;A String&quot;, # A mapping from export format to URL
4251 },
4252 &quot;fileExtension&quot;: &quot;A String&quot;, # The final component of fullFileExtension with trailing text that does not appear to be part of the extension removed. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.
4253 &quot;fileSize&quot;: &quot;A String&quot;, # The size of the file in bytes. This field is populated for files with content stored in Google Drive and for files in Docs Editors; it is not populated for shortcut files.
4254 &quot;folderColorRgb&quot;: &quot;A String&quot;, # 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.
4255 &quot;fullFileExtension&quot;: &quot;A String&quot;, # The full file extension; extracted from the title. May contain multiple concatenated extensions, such as &quot;tar.gz&quot;. Removing an extension from the title does not clear this field; however, changing the extension on the title does update this field. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.
4256 &quot;hasAugmentedPermissions&quot;: True or False, # Whether there are permissions directly on this file. This field is only populated for items in shared drives.
4257 &quot;hasThumbnail&quot;: 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.
4258 &quot;headRevisionId&quot;: &quot;A String&quot;, # The ID of the file&#x27;s head revision. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.
4259 &quot;iconLink&quot;: &quot;A String&quot;, # A link to the file&#x27;s icon.
4260 &quot;id&quot;: &quot;A String&quot;, # The ID of the file.
4261 &quot;imageMediaMetadata&quot;: { # 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.
4262 &quot;aperture&quot;: 3.14, # The aperture used to create the photo (f-number).
4263 &quot;cameraMake&quot;: &quot;A String&quot;, # The make of the camera used to create the photo.
4264 &quot;cameraModel&quot;: &quot;A String&quot;, # The model of the camera used to create the photo.
4265 &quot;colorSpace&quot;: &quot;A String&quot;, # The color space of the photo.
4266 &quot;date&quot;: &quot;A String&quot;, # The date and time the photo was taken (EXIF format timestamp).
4267 &quot;exposureBias&quot;: 3.14, # The exposure bias of the photo (APEX value).
4268 &quot;exposureMode&quot;: &quot;A String&quot;, # The exposure mode used to create the photo.
4269 &quot;exposureTime&quot;: 3.14, # The length of the exposure, in seconds.
4270 &quot;flashUsed&quot;: True or False, # Whether a flash was used to create the photo.
4271 &quot;focalLength&quot;: 3.14, # The focal length used to create the photo, in millimeters.
4272 &quot;height&quot;: 42, # The height of the image in pixels.
4273 &quot;isoSpeed&quot;: 42, # The ISO speed used to create the photo.
4274 &quot;lens&quot;: &quot;A String&quot;, # The lens used to create the photo.
4275 &quot;location&quot;: { # Geographic location information stored in the image.
4276 &quot;altitude&quot;: 3.14, # The altitude stored in the image.
4277 &quot;latitude&quot;: 3.14, # The latitude stored in the image.
4278 &quot;longitude&quot;: 3.14, # The longitude stored in the image.
4279 },
4280 &quot;maxApertureValue&quot;: 3.14, # The smallest f-number of the lens at the focal length used to create the photo (APEX value).
4281 &quot;meteringMode&quot;: &quot;A String&quot;, # The metering mode used to create the photo.
4282 &quot;rotation&quot;: 42, # The number of clockwise 90 degree rotations applied from the image&#x27;s original orientation.
4283 &quot;sensor&quot;: &quot;A String&quot;, # The type of sensor used to create the photo.
4284 &quot;subjectDistance&quot;: 42, # The distance to the subject of the photo, in meters.
4285 &quot;whiteBalance&quot;: &quot;A String&quot;, # The white balance mode used to create the photo.
4286 &quot;width&quot;: 42, # The width of the image in pixels.
4287 },
4288 &quot;indexableText&quot;: { # Indexable text attributes for the file (can only be written)
4289 &quot;text&quot;: &quot;A String&quot;, # The text to be indexed for this file.
4290 },
4291 &quot;isAppAuthorized&quot;: True or False, # Whether the file was created or opened by the requesting app.
4292 &quot;kind&quot;: &quot;drive#file&quot;, # The type of file. This is always drive#file.
4293 &quot;labels&quot;: { # A group of labels for the file.
4294 &quot;hidden&quot;: True or False, # Deprecated.
4295 &quot;modified&quot;: True or False, # Whether the file has been modified by this user.
4296 &quot;restricted&quot;: True or False, # Deprecated - use copyRequiresWriterPermission instead.
4297 &quot;starred&quot;: True or False, # Whether this file is starred by the user.
4298 &quot;trashed&quot;: True or False, # Whether the file has been trashed, either explicitly or from a trashed parent folder. Only the owner may trash a file. The trashed item is excluded from all files.list responses returned for any user who does not own the file. However, all users with access to the file can see the trashed item metadata in an API response. All users with access can copy, download, export, and share the file.
4299 &quot;viewed&quot;: True or False, # Whether this file has been viewed by this user.
4300 },
4301 &quot;lastModifyingUser&quot;: { # Information about a Drive user. # The last user to modify this file.
4302 &quot;displayName&quot;: &quot;A String&quot;, # A plain text displayable name for this user.
4303 &quot;emailAddress&quot;: &quot;A String&quot;, # The email address of the user.
4304 &quot;isAuthenticatedUser&quot;: True or False, # Whether this user is the same as the authenticated user for whom the request was made.
4305 &quot;kind&quot;: &quot;drive#user&quot;, # This is always drive#user.
4306 &quot;permissionId&quot;: &quot;A String&quot;, # The user&#x27;s ID as visible in the permissions collection.
4307 &quot;picture&quot;: { # The user&#x27;s profile picture.
4308 &quot;url&quot;: &quot;A String&quot;, # A URL that points to a profile picture of this user.
4309 },
4310 },
4311 &quot;lastModifyingUserName&quot;: &quot;A String&quot;, # Name of the last user to modify this file.
4312 &quot;lastViewedByMeDate&quot;: &quot;A String&quot;, # Last time this file was viewed by the user (formatted RFC 3339 timestamp).
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700[diff] [blame^]4313 &quot;linkShareMetadata&quot;: { # Contains details about the link URLs that clients are using to refer to this item.
4314 &quot;securityUpdateEligible&quot;: True or False, # Whether the file is eligible for security update.
4315 &quot;securityUpdateEnabled&quot;: True or False, # Whether the security update is enabled for this file.
4316 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]4317 &quot;markedViewedByMeDate&quot;: &quot;A String&quot;, # Deprecated.
4318 &quot;md5Checksum&quot;: &quot;A String&quot;, # An MD5 checksum for the content of this file. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.
4319 &quot;mimeType&quot;: &quot;A String&quot;, # 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&#x27;s MIME type.
4320 &quot;modifiedByMeDate&quot;: &quot;A String&quot;, # 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.
4321 &quot;modifiedDate&quot;: &quot;A String&quot;, # Last time this file was modified by anyone (formatted RFC 3339 timestamp). This is only mutable on update when the setModifiedDate parameter is set.
4322 &quot;openWithLinks&quot;: { # A map of the id of each of the user&#x27;s apps to a link to open this file with that app. Only populated when the drive.apps.readonly scope is used.
4323 &quot;a_key&quot;: &quot;A String&quot;,
4324 },
4325 &quot;originalFilename&quot;: &quot;A String&quot;, # 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.
4326 &quot;ownedByMe&quot;: True or False, # Whether the file is owned by the current user. Not populated for items in shared drives.
4327 &quot;ownerNames&quot;: [ # Name(s) of the owner(s) of this file. Not populated for items in shared drives.
4328 &quot;A String&quot;,
4329 ],
yoshi-code-botab1d6dc2021-05-28 00:42:02 -0700[diff] [blame]4330 &quot;owners&quot;: [ # The owner of this file. Only certain legacy files may have more than one owner. This field isn&#x27;t populated for items in shared drives.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]4331 { # Information about a Drive user.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]4332 &quot;displayName&quot;: &quot;A String&quot;, # A plain text displayable name for this user.
4333 &quot;emailAddress&quot;: &quot;A String&quot;, # The email address of the user.
4334 &quot;isAuthenticatedUser&quot;: True or False, # Whether this user is the same as the authenticated user for whom the request was made.
4335 &quot;kind&quot;: &quot;drive#user&quot;, # This is always drive#user.
4336 &quot;permissionId&quot;: &quot;A String&quot;, # The user&#x27;s ID as visible in the permissions collection.
4337 &quot;picture&quot;: { # The user&#x27;s profile picture.
4338 &quot;url&quot;: &quot;A String&quot;, # A URL that points to a profile picture of this user.
4339 },
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]4340 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]4341 ],
4342 &quot;parents&quot;: [ # Collection of parent folders which contain this file.
4343 # If not specified as part of an insert request, the file will be placed directly in the user&#x27;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.
4344 { # A reference to a file&#x27;s parent.
4345 &quot;id&quot;: &quot;A String&quot;, # The ID of the parent.
4346 &quot;isRoot&quot;: True or False, # Whether or not the parent is the root folder.
4347 &quot;kind&quot;: &quot;drive#parentReference&quot;, # This is always drive#parentReference.
4348 &quot;parentLink&quot;: &quot;A String&quot;, # A link to the parent.
4349 &quot;selfLink&quot;: &quot;A String&quot;, # A link back to this reference.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]4350 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]4351 ],
4352 &quot;permissionIds&quot;: [ # List of permission IDs for users with access to this file.
4353 &quot;A String&quot;,
4354 ],
4355 &quot;permissions&quot;: [ # The list of permissions for users with access to this file. Not populated for items in shared drives.
4356 { # A permission for a file.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]4357 &quot;additionalRoles&quot;: [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future.
4358 &quot;A String&quot;,
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]4359 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]4360 &quot;authKey&quot;: &quot;A String&quot;, # Deprecated.
4361 &quot;deleted&quot;: True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.
4362 &quot;domain&quot;: &quot;A String&quot;, # 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.
4363 &quot;emailAddress&quot;: &quot;A String&quot;, # 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.
4364 &quot;etag&quot;: &quot;A String&quot;, # The ETag of the permission.
4365 &quot;expirationDate&quot;: &quot;A String&quot;, # 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]4366 # - They cannot be set on shared drive items
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]4367 # - They can only be set on user and group permissions
4368 # - The date must be in the future
4369 # - The date cannot be more than a year in the future
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4370 # - The date can only be set on drive.permissions.update or drive.permissions.patch requests
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]4371 &quot;id&quot;: &quot;A String&quot;, # 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.
4372 &quot;kind&quot;: &quot;drive#permission&quot;, # This is always drive#permission.
4373 &quot;name&quot;: &quot;A String&quot;, # The name for this permission.
4374 &quot;permissionDetails&quot;: [ # 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.
4375 {
4376 &quot;additionalRoles&quot;: [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future.
4377 &quot;A String&quot;,
4378 ],
4379 &quot;inherited&quot;: True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field.
4380 &quot;inheritedFrom&quot;: &quot;A String&quot;, # The ID of the item from which this permission is inherited. This is an output-only field.
4381 &quot;permissionType&quot;: &quot;A String&quot;, # The permission type for this user. While new values may be added in future, the following are currently possible:
4382 # - file
4383 # - member
4384 &quot;role&quot;: &quot;A String&quot;, # The primary role for this user. While new values may be added in the future, the following are currently possible:
4385 # - organizer
4386 # - fileOrganizer
4387 # - writer
4388 # - reader
4389 },
4390 ],
4391 &quot;photoLink&quot;: &quot;A String&quot;, # A link to the profile photo, if available.
4392 &quot;role&quot;: &quot;A String&quot;, # 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]4393 # - owner
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4394 # - organizer
4395 # - fileOrganizer
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]4396 # - writer
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4397 # - reader
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]4398 &quot;selfLink&quot;: &quot;A String&quot;, # A link back to this permission.
4399 &quot;teamDrivePermissionDetails&quot;: [ # Deprecated - use permissionDetails instead.
4400 {
4401 &quot;additionalRoles&quot;: [ # Deprecated - use permissionDetails/additionalRoles instead.
4402 &quot;A String&quot;,
4403 ],
4404 &quot;inherited&quot;: True or False, # Deprecated - use permissionDetails/inherited instead.
4405 &quot;inheritedFrom&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/inheritedFrom instead.
4406 &quot;role&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/role instead.
4407 &quot;teamDrivePermissionType&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/permissionType instead.
4408 },
4409 ],
4410 &quot;type&quot;: &quot;A String&quot;, # The account type. Allowed values are:
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]4411 # - user
4412 # - group
4413 # - domain
4414 # - anyone
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]4415 &quot;value&quot;: &quot;A String&quot;, # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type is anyone, in which case both id and value are ignored.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]4416 &quot;view&quot;: &quot;A String&quot;, # Indicates the view for this permission. Only populated for permissions that belong to a view. published is the only supported value.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]4417 &quot;withLink&quot;: True or False, # Whether the link is required for this permission.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]4418 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]4419 ],
4420 &quot;properties&quot;: [ # The list of properties.
4421 { # A key-value pair attached to a file that is either public or private to an application.
4422 # The following limits apply to file properties:
4423 # - Maximum of 100 properties total per file
4424 # - Maximum of 30 private properties per app
4425 # - Maximum of 30 public properties
4426 # - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property.
4427 &quot;etag&quot;: &quot;A String&quot;, # ETag of the property.
4428 &quot;key&quot;: &quot;A String&quot;, # The key of this property.
4429 &quot;kind&quot;: &quot;drive#property&quot;, # This is always drive#property.
4430 &quot;selfLink&quot;: &quot;A String&quot;, # The link back to this property.
4431 &quot;value&quot;: &quot;A String&quot;, # The value of this property.
yoshi-code-bot69706592021-03-03 03:54:02 -0800[diff] [blame]4432 &quot;visibility&quot;: &quot;A String&quot;, # The visibility of this property. Allowed values are PRIVATE and PUBLIC. (Default: PRIVATE). Private properties can only be retrieved using an authenticated request. An authenticated request uses an access token obtained with a OAuth 2 client ID. You cannot use an API key to retrieve private properties.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]4433 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]4434 ],
4435 &quot;quotaBytesUsed&quot;: &quot;A String&quot;, # The number of quota bytes used by this file.
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700[diff] [blame^]4436 &quot;resourceKey&quot;: &quot;A String&quot;, # A key needed to access the item via a shared link.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]4437 &quot;selfLink&quot;: &quot;A String&quot;, # A link back to this file.
4438 &quot;shareable&quot;: True or False, # Deprecated: use capabilities/canShare.
4439 &quot;shared&quot;: True or False, # Whether the file has been shared. Not populated for items in shared drives.
4440 &quot;sharedWithMeDate&quot;: &quot;A String&quot;, # Time at which this file was shared with the user (formatted RFC 3339 timestamp).
4441 &quot;sharingUser&quot;: { # Information about a Drive user. # User that shared the item with the current user, if available.
4442 &quot;displayName&quot;: &quot;A String&quot;, # A plain text displayable name for this user.
4443 &quot;emailAddress&quot;: &quot;A String&quot;, # The email address of the user.
4444 &quot;isAuthenticatedUser&quot;: True or False, # Whether this user is the same as the authenticated user for whom the request was made.
4445 &quot;kind&quot;: &quot;drive#user&quot;, # This is always drive#user.
4446 &quot;permissionId&quot;: &quot;A String&quot;, # The user&#x27;s ID as visible in the permissions collection.
4447 &quot;picture&quot;: { # The user&#x27;s profile picture.
4448 &quot;url&quot;: &quot;A String&quot;, # A URL that points to a profile picture of this user.
4449 },
4450 },
4451 &quot;shortcutDetails&quot;: { # Shortcut file details. Only populated for shortcut files, which have the mimeType field set to application/vnd.google-apps.shortcut.
4452 &quot;targetId&quot;: &quot;A String&quot;, # The ID of the file that this shortcut points to.
4453 &quot;targetMimeType&quot;: &quot;A String&quot;, # The MIME type of the file that this shortcut points to. The value of this field is a snapshot of the target&#x27;s MIME type, captured when the shortcut is created.
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700[diff] [blame^]4454 &quot;targetResourceKey&quot;: &quot;A String&quot;, # The ResourceKey for the target file.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]4455 },
4456 &quot;spaces&quot;: [ # The list of spaces which contain the file. Supported values are &#x27;drive&#x27;, &#x27;appDataFolder&#x27; and &#x27;photos&#x27;.
4457 &quot;A String&quot;,
4458 ],
4459 &quot;teamDriveId&quot;: &quot;A String&quot;, # Deprecated - use driveId instead.
4460 &quot;thumbnail&quot;: { # A thumbnail for the file. This will only be used if a standard thumbnail cannot be generated.
4461 &quot;image&quot;: &quot;A String&quot;, # The URL-safe Base64 encoded bytes of the thumbnail image. It should conform to RFC 4648 section 5.
4462 &quot;mimeType&quot;: &quot;A String&quot;, # The MIME type of the thumbnail.
4463 },
4464 &quot;thumbnailLink&quot;: &quot;A String&quot;, # A short-lived link to the file&#x27;s thumbnail. Typically lasts on the order of hours. Only populated when the requesting app can access the file&#x27;s content. If the file isn&#x27;t shared publicly, the URL returned in Files.thumbnailLink must be fetched using a credentialed request.
4465 &quot;thumbnailVersion&quot;: &quot;A String&quot;, # The thumbnail version for use in thumbnail cache invalidation.
4466 &quot;title&quot;: &quot;A String&quot;, # 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.
4467 &quot;trashedDate&quot;: &quot;A String&quot;, # The time that the item was trashed (formatted RFC 3339 timestamp). Only populated for items in shared drives.
4468 &quot;trashingUser&quot;: { # Information about a Drive user. # If the file has been explicitly trashed, the user who trashed it. Only populated for items in shared drives.
4469 &quot;displayName&quot;: &quot;A String&quot;, # A plain text displayable name for this user.
4470 &quot;emailAddress&quot;: &quot;A String&quot;, # The email address of the user.
4471 &quot;isAuthenticatedUser&quot;: True or False, # Whether this user is the same as the authenticated user for whom the request was made.
4472 &quot;kind&quot;: &quot;drive#user&quot;, # This is always drive#user.
4473 &quot;permissionId&quot;: &quot;A String&quot;, # The user&#x27;s ID as visible in the permissions collection.
4474 &quot;picture&quot;: { # The user&#x27;s profile picture.
4475 &quot;url&quot;: &quot;A String&quot;, # A URL that points to a profile picture of this user.
4476 },
4477 },
4478 &quot;userPermission&quot;: { # A permission for a file. # The permissions for the authenticated user on this file.
4479 &quot;additionalRoles&quot;: [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future.
4480 &quot;A String&quot;,
4481 ],
4482 &quot;authKey&quot;: &quot;A String&quot;, # Deprecated.
4483 &quot;deleted&quot;: True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.
4484 &quot;domain&quot;: &quot;A String&quot;, # 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.
4485 &quot;emailAddress&quot;: &quot;A String&quot;, # 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.
4486 &quot;etag&quot;: &quot;A String&quot;, # The ETag of the permission.
4487 &quot;expirationDate&quot;: &quot;A String&quot;, # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions:
4488 # - They cannot be set on shared drive items
4489 # - They can only be set on user and group permissions
4490 # - The date must be in the future
4491 # - The date cannot be more than a year in the future
4492 # - The date can only be set on drive.permissions.update or drive.permissions.patch requests
4493 &quot;id&quot;: &quot;A String&quot;, # 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.
4494 &quot;kind&quot;: &quot;drive#permission&quot;, # This is always drive#permission.
4495 &quot;name&quot;: &quot;A String&quot;, # The name for this permission.
4496 &quot;permissionDetails&quot;: [ # 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.
4497 {
4498 &quot;additionalRoles&quot;: [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future.
4499 &quot;A String&quot;,
4500 ],
4501 &quot;inherited&quot;: True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field.
4502 &quot;inheritedFrom&quot;: &quot;A String&quot;, # The ID of the item from which this permission is inherited. This is an output-only field.
4503 &quot;permissionType&quot;: &quot;A String&quot;, # The permission type for this user. While new values may be added in future, the following are currently possible:
4504 # - file
4505 # - member
4506 &quot;role&quot;: &quot;A String&quot;, # The primary role for this user. While new values may be added in the future, the following are currently possible:
4507 # - organizer
4508 # - fileOrganizer
4509 # - writer
4510 # - reader
4511 },
4512 ],
4513 &quot;photoLink&quot;: &quot;A String&quot;, # A link to the profile photo, if available.
4514 &quot;role&quot;: &quot;A String&quot;, # The primary role for this user. While new values may be supported in the future, the following are currently allowed:
4515 # - owner
4516 # - organizer
4517 # - fileOrganizer
4518 # - writer
4519 # - reader
4520 &quot;selfLink&quot;: &quot;A String&quot;, # A link back to this permission.
4521 &quot;teamDrivePermissionDetails&quot;: [ # Deprecated - use permissionDetails instead.
4522 {
4523 &quot;additionalRoles&quot;: [ # Deprecated - use permissionDetails/additionalRoles instead.
4524 &quot;A String&quot;,
4525 ],
4526 &quot;inherited&quot;: True or False, # Deprecated - use permissionDetails/inherited instead.
4527 &quot;inheritedFrom&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/inheritedFrom instead.
4528 &quot;role&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/role instead.
4529 &quot;teamDrivePermissionType&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/permissionType instead.
4530 },
4531 ],
4532 &quot;type&quot;: &quot;A String&quot;, # The account type. Allowed values are:
4533 # - user
4534 # - group
4535 # - domain
4536 # - anyone
4537 &quot;value&quot;: &quot;A String&quot;, # 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.
4538 &quot;view&quot;: &quot;A String&quot;, # Indicates the view for this permission. Only populated for permissions that belong to a view. published is the only supported value.
4539 &quot;withLink&quot;: True or False, # Whether the link is required for this permission.
4540 },
4541 &quot;version&quot;: &quot;A String&quot;, # 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.
4542 &quot;videoMediaMetadata&quot;: { # Metadata about video media. This will only be present for video types.
4543 &quot;durationMillis&quot;: &quot;A String&quot;, # The duration of the video in milliseconds.
4544 &quot;height&quot;: 42, # The height of the video in pixels.
4545 &quot;width&quot;: 42, # The width of the video in pixels.
4546 },
4547 &quot;webContentLink&quot;: &quot;A String&quot;, # 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.
4548 &quot;webViewLink&quot;: &quot;A String&quot;, # A link only available on public folders for viewing their static web assets (HTML, CSS, JS, etc) via Google Drive&#x27;s Website Hosting.
4549 &quot;writersCanShare&quot;: True or False, # Whether writers can share the document with other users. Not populated for items in shared drives.
4550}</pre>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]4551</div>
4552
4553<div class="method">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]4554 <code class="details" id="update">update(fileId, addParents=None, body=None, convert=None, enforceSingleParent=None, includePermissionsForView=None, media_body=None, media_mime_type=None, modifiedDateBehavior=None, newRevision=None, ocr=None, ocrLanguage=None, pinned=None, removeParents=None, setModifiedDate=None, supportsAllDrives=None, supportsTeamDrives=None, timedTextLanguage=None, timedTextTrackName=None, updateViewedDate=None, useContentAsIndexableText=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]4555 <pre>Updates file metadata and/or content.
4556
4557Args:
4558 fileId: string, The ID of the file to update. (required)
4559 body: object, The request body.
4560 The object takes the form of:
4561
4562{ # The metadata for a file.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]4563 &quot;alternateLink&quot;: &quot;A String&quot;, # A link for opening the file in a relevant Google editor or viewer.
4564 &quot;appDataContents&quot;: True or False, # Whether this file is in the Application Data folder.
4565 &quot;canComment&quot;: True or False, # Deprecated: use capabilities/canComment.
4566 &quot;canReadRevisions&quot;: True or False, # Deprecated: use capabilities/canReadRevisions.
4567 &quot;capabilities&quot;: { # Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take.
4568 &quot;canAddChildren&quot;: True or False, # Whether the current user can add children to this folder. This is always false when the item is not a folder.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]4569 &quot;canAddFolderFromAnotherDrive&quot;: True or False, # Whether the current user can add a folder from another drive (different shared drive or My Drive) to this folder. This is false when the item is not a folder. Only populated for items in shared drives.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]4570 &quot;canAddMyDriveParent&quot;: 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.
4571 &quot;canChangeCopyRequiresWriterPermission&quot;: True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this file.
4572 &quot;canChangeRestrictedDownload&quot;: True or False, # Deprecated
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700[diff] [blame^]4573 &quot;canChangeSecurityUpdateEnabled&quot;: True or False, # Whether the current user can change the securityUpdateEnabled field on link share metadata.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]4574 &quot;canComment&quot;: True or False, # Whether the current user can comment on this file.
4575 &quot;canCopy&quot;: 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.
4576 &quot;canDelete&quot;: True or False, # Whether the current user can delete this file.
4577 &quot;canDeleteChildren&quot;: 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.
4578 &quot;canDownload&quot;: True or False, # Whether the current user can download this file.
4579 &quot;canEdit&quot;: 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.
4580 &quot;canListChildren&quot;: 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.
4581 &quot;canModifyContent&quot;: True or False, # Whether the current user can modify the content of this file.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]4582 &quot;canModifyContentRestriction&quot;: True or False, # Whether the current user can modify restrictions on content of this file.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]4583 &quot;canMoveChildrenOutOfDrive&quot;: 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.
4584 &quot;canMoveChildrenOutOfTeamDrive&quot;: True or False, # Deprecated - use canMoveChildrenOutOfDrive instead.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]4585 &quot;canMoveChildrenWithinDrive&quot;: True or False, # Whether the current user can move children of this folder within this drive. This is false when the item is not a folder. Note that a request to move the child may still fail depending on the current user&#x27;s access to the child and to the destination folder.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]4586 &quot;canMoveChildrenWithinTeamDrive&quot;: True or False, # Deprecated - use canMoveChildrenWithinDrive instead.
4587 &quot;canMoveItemIntoTeamDrive&quot;: True or False, # Deprecated - use canMoveItemOutOfDrive instead.
4588 &quot;canMoveItemOutOfDrive&quot;: 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.
4589 &quot;canMoveItemOutOfTeamDrive&quot;: True or False, # Deprecated - use canMoveItemOutOfDrive instead.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]4590 &quot;canMoveItemWithinDrive&quot;: True or False, # Whether the current user can move this item within this drive. Note that a request to change the parent of the item may still fail depending on the new parent that is being added and the parent that is being removed.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]4591 &quot;canMoveItemWithinTeamDrive&quot;: True or False, # Deprecated - use canMoveItemWithinDrive instead.
4592 &quot;canMoveTeamDriveItem&quot;: True or False, # Deprecated - use canMoveItemWithinDrive or canMoveItemOutOfDrive instead.
4593 &quot;canReadDrive&quot;: True or False, # Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives.
4594 &quot;canReadRevisions&quot;: 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.
4595 &quot;canReadTeamDrive&quot;: True or False, # Deprecated - use canReadDrive instead.
4596 &quot;canRemoveChildren&quot;: 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.
4597 &quot;canRemoveMyDriveParent&quot;: 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.
4598 &quot;canRename&quot;: True or False, # Whether the current user can rename this file.
4599 &quot;canShare&quot;: True or False, # Whether the current user can modify the sharing settings for this file.
4600 &quot;canTrash&quot;: True or False, # Whether the current user can move this file to trash.
4601 &quot;canTrashChildren&quot;: 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.
4602 &quot;canUntrash&quot;: True or False, # Whether the current user can restore this file from trash.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]4603 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]4604 &quot;contentRestrictions&quot;: [ # Restrictions for accessing the content of the file. Only populated if such a restriction exists.
4605 { # A restriction for accessing the content of the file.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]4606 &quot;readOnly&quot;: True or False, # Whether the content of the file is read-only. If a file is read-only, a new revision of the file may not be added, comments may not be added or modified, and the title of the file may not be modified.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]4607 &quot;reason&quot;: &quot;A String&quot;, # Reason for why the content of the file is restricted. This is only mutable on requests that also set readOnly=true.
4608 &quot;restrictingUser&quot;: { # Information about a Drive user. # The user who set the content restriction. Only populated if readOnly is true.
4609 &quot;displayName&quot;: &quot;A String&quot;, # A plain text displayable name for this user.
4610 &quot;emailAddress&quot;: &quot;A String&quot;, # The email address of the user.
4611 &quot;isAuthenticatedUser&quot;: True or False, # Whether this user is the same as the authenticated user for whom the request was made.
4612 &quot;kind&quot;: &quot;drive#user&quot;, # This is always drive#user.
4613 &quot;permissionId&quot;: &quot;A String&quot;, # The user&#x27;s ID as visible in the permissions collection.
4614 &quot;picture&quot;: { # The user&#x27;s profile picture.
4615 &quot;url&quot;: &quot;A String&quot;, # A URL that points to a profile picture of this user.
4616 },
4617 },
4618 &quot;restrictionDate&quot;: &quot;A String&quot;, # The time at which the content restriction was set (formatted RFC 3339 timestamp). Only populated if readOnly is true.
4619 &quot;type&quot;: &quot;A String&quot;, # The type of the content restriction. Currently the only possible value is globalContentRestriction.
4620 },
4621 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]4622 &quot;copyRequiresWriterPermission&quot;: True or False, # Whether the options to copy, print, or download this file, should be disabled for readers and commenters.
4623 &quot;copyable&quot;: True or False, # Deprecated: use capabilities/canCopy.
4624 &quot;createdDate&quot;: &quot;A String&quot;, # Create time for this file (formatted RFC 3339 timestamp).
4625 &quot;defaultOpenWithLink&quot;: &quot;A String&quot;, # A link to open this file with the user&#x27;s default app for this file. Only populated when the drive.apps.readonly scope is used.
4626 &quot;description&quot;: &quot;A String&quot;, # A short description of the file.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]4627 &quot;downloadUrl&quot;: &quot;A String&quot;, # Short lived download URL for the file. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]4628 &quot;driveId&quot;: &quot;A String&quot;, # ID of the shared drive the file resides in. Only populated for items in shared drives.
4629 &quot;editable&quot;: True or False, # Deprecated: use capabilities/canEdit.
4630 &quot;embedLink&quot;: &quot;A String&quot;, # A link for embedding the file.
4631 &quot;etag&quot;: &quot;A String&quot;, # ETag of the file.
4632 &quot;explicitlyTrashed&quot;: True or False, # Whether this file has been explicitly trashed, as opposed to recursively trashed.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]4633 &quot;exportLinks&quot;: { # Links for exporting Docs Editors files to specific formats.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]4634 &quot;a_key&quot;: &quot;A String&quot;, # A mapping from export format to URL
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]4635 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]4636 &quot;fileExtension&quot;: &quot;A String&quot;, # The final component of fullFileExtension with trailing text that does not appear to be part of the extension removed. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.
4637 &quot;fileSize&quot;: &quot;A String&quot;, # The size of the file in bytes. This field is populated for files with content stored in Google Drive and for files in Docs Editors; it is not populated for shortcut files.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]4638 &quot;folderColorRgb&quot;: &quot;A String&quot;, # 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.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]4639 &quot;fullFileExtension&quot;: &quot;A String&quot;, # The full file extension; extracted from the title. May contain multiple concatenated extensions, such as &quot;tar.gz&quot;. Removing an extension from the title does not clear this field; however, changing the extension on the title does update this field. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]4640 &quot;hasAugmentedPermissions&quot;: True or False, # Whether there are permissions directly on this file. This field is only populated for items in shared drives.
4641 &quot;hasThumbnail&quot;: 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.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]4642 &quot;headRevisionId&quot;: &quot;A String&quot;, # The ID of the file&#x27;s head revision. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]4643 &quot;iconLink&quot;: &quot;A String&quot;, # A link to the file&#x27;s icon.
4644 &quot;id&quot;: &quot;A String&quot;, # The ID of the file.
4645 &quot;imageMediaMetadata&quot;: { # 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.
4646 &quot;aperture&quot;: 3.14, # The aperture used to create the photo (f-number).
4647 &quot;cameraMake&quot;: &quot;A String&quot;, # The make of the camera used to create the photo.
4648 &quot;cameraModel&quot;: &quot;A String&quot;, # The model of the camera used to create the photo.
4649 &quot;colorSpace&quot;: &quot;A String&quot;, # The color space of the photo.
4650 &quot;date&quot;: &quot;A String&quot;, # The date and time the photo was taken (EXIF format timestamp).
4651 &quot;exposureBias&quot;: 3.14, # The exposure bias of the photo (APEX value).
4652 &quot;exposureMode&quot;: &quot;A String&quot;, # The exposure mode used to create the photo.
4653 &quot;exposureTime&quot;: 3.14, # The length of the exposure, in seconds.
4654 &quot;flashUsed&quot;: True or False, # Whether a flash was used to create the photo.
4655 &quot;focalLength&quot;: 3.14, # The focal length used to create the photo, in millimeters.
4656 &quot;height&quot;: 42, # The height of the image in pixels.
4657 &quot;isoSpeed&quot;: 42, # The ISO speed used to create the photo.
4658 &quot;lens&quot;: &quot;A String&quot;, # The lens used to create the photo.
4659 &quot;location&quot;: { # Geographic location information stored in the image.
4660 &quot;altitude&quot;: 3.14, # The altitude stored in the image.
4661 &quot;latitude&quot;: 3.14, # The latitude stored in the image.
4662 &quot;longitude&quot;: 3.14, # The longitude stored in the image.
4663 },
4664 &quot;maxApertureValue&quot;: 3.14, # The smallest f-number of the lens at the focal length used to create the photo (APEX value).
4665 &quot;meteringMode&quot;: &quot;A String&quot;, # The metering mode used to create the photo.
4666 &quot;rotation&quot;: 42, # The number of clockwise 90 degree rotations applied from the image&#x27;s original orientation.
4667 &quot;sensor&quot;: &quot;A String&quot;, # The type of sensor used to create the photo.
4668 &quot;subjectDistance&quot;: 42, # The distance to the subject of the photo, in meters.
4669 &quot;whiteBalance&quot;: &quot;A String&quot;, # The white balance mode used to create the photo.
4670 &quot;width&quot;: 42, # The width of the image in pixels.
4671 },
4672 &quot;indexableText&quot;: { # Indexable text attributes for the file (can only be written)
4673 &quot;text&quot;: &quot;A String&quot;, # The text to be indexed for this file.
4674 },
4675 &quot;isAppAuthorized&quot;: True or False, # Whether the file was created or opened by the requesting app.
4676 &quot;kind&quot;: &quot;drive#file&quot;, # The type of file. This is always drive#file.
4677 &quot;labels&quot;: { # A group of labels for the file.
4678 &quot;hidden&quot;: True or False, # Deprecated.
4679 &quot;modified&quot;: True or False, # Whether the file has been modified by this user.
4680 &quot;restricted&quot;: True or False, # Deprecated - use copyRequiresWriterPermission instead.
4681 &quot;starred&quot;: True or False, # Whether this file is starred by the user.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]4682 &quot;trashed&quot;: True or False, # Whether the file has been trashed, either explicitly or from a trashed parent folder. Only the owner may trash a file. The trashed item is excluded from all files.list responses returned for any user who does not own the file. However, all users with access to the file can see the trashed item metadata in an API response. All users with access can copy, download, export, and share the file.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]4683 &quot;viewed&quot;: True or False, # Whether this file has been viewed by this user.
4684 },
4685 &quot;lastModifyingUser&quot;: { # Information about a Drive user. # The last user to modify this file.
4686 &quot;displayName&quot;: &quot;A String&quot;, # A plain text displayable name for this user.
4687 &quot;emailAddress&quot;: &quot;A String&quot;, # The email address of the user.
4688 &quot;isAuthenticatedUser&quot;: True or False, # Whether this user is the same as the authenticated user for whom the request was made.
4689 &quot;kind&quot;: &quot;drive#user&quot;, # This is always drive#user.
4690 &quot;permissionId&quot;: &quot;A String&quot;, # The user&#x27;s ID as visible in the permissions collection.
4691 &quot;picture&quot;: { # The user&#x27;s profile picture.
4692 &quot;url&quot;: &quot;A String&quot;, # A URL that points to a profile picture of this user.
4693 },
4694 },
4695 &quot;lastModifyingUserName&quot;: &quot;A String&quot;, # Name of the last user to modify this file.
4696 &quot;lastViewedByMeDate&quot;: &quot;A String&quot;, # Last time this file was viewed by the user (formatted RFC 3339 timestamp).
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700[diff] [blame^]4697 &quot;linkShareMetadata&quot;: { # Contains details about the link URLs that clients are using to refer to this item.
4698 &quot;securityUpdateEligible&quot;: True or False, # Whether the file is eligible for security update.
4699 &quot;securityUpdateEnabled&quot;: True or False, # Whether the security update is enabled for this file.
4700 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]4701 &quot;markedViewedByMeDate&quot;: &quot;A String&quot;, # Deprecated.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]4702 &quot;md5Checksum&quot;: &quot;A String&quot;, # An MD5 checksum for the content of this file. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]4703 &quot;mimeType&quot;: &quot;A String&quot;, # 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&#x27;s MIME type.
4704 &quot;modifiedByMeDate&quot;: &quot;A String&quot;, # 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.
4705 &quot;modifiedDate&quot;: &quot;A String&quot;, # Last time this file was modified by anyone (formatted RFC 3339 timestamp). This is only mutable on update when the setModifiedDate parameter is set.
4706 &quot;openWithLinks&quot;: { # A map of the id of each of the user&#x27;s apps to a link to open this file with that app. Only populated when the drive.apps.readonly scope is used.
4707 &quot;a_key&quot;: &quot;A String&quot;,
4708 },
4709 &quot;originalFilename&quot;: &quot;A String&quot;, # 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.
4710 &quot;ownedByMe&quot;: True or False, # Whether the file is owned by the current user. Not populated for items in shared drives.
4711 &quot;ownerNames&quot;: [ # Name(s) of the owner(s) of this file. Not populated for items in shared drives.
4712 &quot;A String&quot;,
4713 ],
yoshi-code-botab1d6dc2021-05-28 00:42:02 -0700[diff] [blame]4714 &quot;owners&quot;: [ # The owner of this file. Only certain legacy files may have more than one owner. This field isn&#x27;t populated for items in shared drives.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]4715 { # Information about a Drive user.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]4716 &quot;displayName&quot;: &quot;A String&quot;, # A plain text displayable name for this user.
4717 &quot;emailAddress&quot;: &quot;A String&quot;, # The email address of the user.
4718 &quot;isAuthenticatedUser&quot;: True or False, # Whether this user is the same as the authenticated user for whom the request was made.
4719 &quot;kind&quot;: &quot;drive#user&quot;, # This is always drive#user.
4720 &quot;permissionId&quot;: &quot;A String&quot;, # The user&#x27;s ID as visible in the permissions collection.
4721 &quot;picture&quot;: { # The user&#x27;s profile picture.
4722 &quot;url&quot;: &quot;A String&quot;, # A URL that points to a profile picture of this user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]4723 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]4724 },
4725 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]4726 &quot;parents&quot;: [ # Collection of parent folders which contain this file.
4727 # If not specified as part of an insert request, the file will be placed directly in the user&#x27;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.
4728 { # A reference to a file&#x27;s parent.
4729 &quot;id&quot;: &quot;A String&quot;, # The ID of the parent.
4730 &quot;isRoot&quot;: True or False, # Whether or not the parent is the root folder.
4731 &quot;kind&quot;: &quot;drive#parentReference&quot;, # This is always drive#parentReference.
4732 &quot;parentLink&quot;: &quot;A String&quot;, # A link to the parent.
4733 &quot;selfLink&quot;: &quot;A String&quot;, # A link back to this reference.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]4734 },
4735 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]4736 &quot;permissionIds&quot;: [ # List of permission IDs for users with access to this file.
4737 &quot;A String&quot;,
4738 ],
4739 &quot;permissions&quot;: [ # The list of permissions for users with access to this file. Not populated for items in shared drives.
4740 { # A permission for a file.
4741 &quot;additionalRoles&quot;: [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future.
4742 &quot;A String&quot;,
4743 ],
4744 &quot;authKey&quot;: &quot;A String&quot;, # Deprecated.
4745 &quot;deleted&quot;: True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.
4746 &quot;domain&quot;: &quot;A String&quot;, # 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.
4747 &quot;emailAddress&quot;: &quot;A String&quot;, # 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.
4748 &quot;etag&quot;: &quot;A String&quot;, # The ETag of the permission.
4749 &quot;expirationDate&quot;: &quot;A String&quot;, # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions:
4750 # - They cannot be set on shared drive items
4751 # - They can only be set on user and group permissions
4752 # - The date must be in the future
4753 # - The date cannot be more than a year in the future
4754 # - The date can only be set on drive.permissions.update or drive.permissions.patch requests
4755 &quot;id&quot;: &quot;A String&quot;, # 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.
4756 &quot;kind&quot;: &quot;drive#permission&quot;, # This is always drive#permission.
4757 &quot;name&quot;: &quot;A String&quot;, # The name for this permission.
4758 &quot;permissionDetails&quot;: [ # 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.
4759 {
4760 &quot;additionalRoles&quot;: [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future.
4761 &quot;A String&quot;,
4762 ],
4763 &quot;inherited&quot;: True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field.
4764 &quot;inheritedFrom&quot;: &quot;A String&quot;, # The ID of the item from which this permission is inherited. This is an output-only field.
4765 &quot;permissionType&quot;: &quot;A String&quot;, # The permission type for this user. While new values may be added in future, the following are currently possible:
4766 # - file
4767 # - member
4768 &quot;role&quot;: &quot;A String&quot;, # The primary role for this user. While new values may be added in the future, the following are currently possible:
4769 # - organizer
4770 # - fileOrganizer
4771 # - writer
4772 # - reader
4773 },
4774 ],
4775 &quot;photoLink&quot;: &quot;A String&quot;, # A link to the profile photo, if available.
4776 &quot;role&quot;: &quot;A String&quot;, # The primary role for this user. While new values may be supported in the future, the following are currently allowed:
4777 # - owner
4778 # - organizer
4779 # - fileOrganizer
4780 # - writer
4781 # - reader
4782 &quot;selfLink&quot;: &quot;A String&quot;, # A link back to this permission.
4783 &quot;teamDrivePermissionDetails&quot;: [ # Deprecated - use permissionDetails instead.
4784 {
4785 &quot;additionalRoles&quot;: [ # Deprecated - use permissionDetails/additionalRoles instead.
4786 &quot;A String&quot;,
4787 ],
4788 &quot;inherited&quot;: True or False, # Deprecated - use permissionDetails/inherited instead.
4789 &quot;inheritedFrom&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/inheritedFrom instead.
4790 &quot;role&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/role instead.
4791 &quot;teamDrivePermissionType&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/permissionType instead.
4792 },
4793 ],
4794 &quot;type&quot;: &quot;A String&quot;, # The account type. Allowed values are:
4795 # - user
4796 # - group
4797 # - domain
4798 # - anyone
4799 &quot;value&quot;: &quot;A String&quot;, # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type is anyone, in which case both id and value are ignored.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]4800 &quot;view&quot;: &quot;A String&quot;, # Indicates the view for this permission. Only populated for permissions that belong to a view. published is the only supported value.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]4801 &quot;withLink&quot;: True or False, # Whether the link is required for this permission.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]4802 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]4803 ],
4804 &quot;properties&quot;: [ # The list of properties.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]4805 { # A key-value pair attached to a file that is either public or private to an application.
4806 # The following limits apply to file properties:
4807 # - Maximum of 100 properties total per file
4808 # - Maximum of 30 private properties per app
4809 # - Maximum of 30 public properties
4810 # - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]4811 &quot;etag&quot;: &quot;A String&quot;, # ETag of the property.
4812 &quot;key&quot;: &quot;A String&quot;, # The key of this property.
4813 &quot;kind&quot;: &quot;drive#property&quot;, # This is always drive#property.
4814 &quot;selfLink&quot;: &quot;A String&quot;, # The link back to this property.
4815 &quot;value&quot;: &quot;A String&quot;, # The value of this property.
yoshi-code-bot69706592021-03-03 03:54:02 -0800[diff] [blame]4816 &quot;visibility&quot;: &quot;A String&quot;, # The visibility of this property. Allowed values are PRIVATE and PUBLIC. (Default: PRIVATE). Private properties can only be retrieved using an authenticated request. An authenticated request uses an access token obtained with a OAuth 2 client ID. You cannot use an API key to retrieve private properties.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]4817 },
4818 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]4819 &quot;quotaBytesUsed&quot;: &quot;A String&quot;, # The number of quota bytes used by this file.
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700[diff] [blame^]4820 &quot;resourceKey&quot;: &quot;A String&quot;, # A key needed to access the item via a shared link.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]4821 &quot;selfLink&quot;: &quot;A String&quot;, # A link back to this file.
4822 &quot;shareable&quot;: True or False, # Deprecated: use capabilities/canShare.
4823 &quot;shared&quot;: True or False, # Whether the file has been shared. Not populated for items in shared drives.
4824 &quot;sharedWithMeDate&quot;: &quot;A String&quot;, # Time at which this file was shared with the user (formatted RFC 3339 timestamp).
4825 &quot;sharingUser&quot;: { # Information about a Drive user. # User that shared the item with the current user, if available.
4826 &quot;displayName&quot;: &quot;A String&quot;, # A plain text displayable name for this user.
4827 &quot;emailAddress&quot;: &quot;A String&quot;, # The email address of the user.
4828 &quot;isAuthenticatedUser&quot;: True or False, # Whether this user is the same as the authenticated user for whom the request was made.
4829 &quot;kind&quot;: &quot;drive#user&quot;, # This is always drive#user.
4830 &quot;permissionId&quot;: &quot;A String&quot;, # The user&#x27;s ID as visible in the permissions collection.
4831 &quot;picture&quot;: { # The user&#x27;s profile picture.
4832 &quot;url&quot;: &quot;A String&quot;, # A URL that points to a profile picture of this user.
4833 },
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]4834 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]4835 &quot;shortcutDetails&quot;: { # Shortcut file details. Only populated for shortcut files, which have the mimeType field set to application/vnd.google-apps.shortcut.
4836 &quot;targetId&quot;: &quot;A String&quot;, # The ID of the file that this shortcut points to.
4837 &quot;targetMimeType&quot;: &quot;A String&quot;, # The MIME type of the file that this shortcut points to. The value of this field is a snapshot of the target&#x27;s MIME type, captured when the shortcut is created.
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700[diff] [blame^]4838 &quot;targetResourceKey&quot;: &quot;A String&quot;, # The ResourceKey for the target file.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]4839 },
4840 &quot;spaces&quot;: [ # The list of spaces which contain the file. Supported values are &#x27;drive&#x27;, &#x27;appDataFolder&#x27; and &#x27;photos&#x27;.
4841 &quot;A String&quot;,
4842 ],
4843 &quot;teamDriveId&quot;: &quot;A String&quot;, # Deprecated - use driveId instead.
4844 &quot;thumbnail&quot;: { # A thumbnail for the file. This will only be used if a standard thumbnail cannot be generated.
4845 &quot;image&quot;: &quot;A String&quot;, # The URL-safe Base64 encoded bytes of the thumbnail image. It should conform to RFC 4648 section 5.
4846 &quot;mimeType&quot;: &quot;A String&quot;, # The MIME type of the thumbnail.
4847 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]4848 &quot;thumbnailLink&quot;: &quot;A String&quot;, # A short-lived link to the file&#x27;s thumbnail. Typically lasts on the order of hours. Only populated when the requesting app can access the file&#x27;s content. If the file isn&#x27;t shared publicly, the URL returned in Files.thumbnailLink must be fetched using a credentialed request.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]4849 &quot;thumbnailVersion&quot;: &quot;A String&quot;, # The thumbnail version for use in thumbnail cache invalidation.
4850 &quot;title&quot;: &quot;A String&quot;, # 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.
4851 &quot;trashedDate&quot;: &quot;A String&quot;, # The time that the item was trashed (formatted RFC 3339 timestamp). Only populated for items in shared drives.
4852 &quot;trashingUser&quot;: { # Information about a Drive user. # If the file has been explicitly trashed, the user who trashed it. Only populated for items in shared drives.
4853 &quot;displayName&quot;: &quot;A String&quot;, # A plain text displayable name for this user.
4854 &quot;emailAddress&quot;: &quot;A String&quot;, # The email address of the user.
4855 &quot;isAuthenticatedUser&quot;: True or False, # Whether this user is the same as the authenticated user for whom the request was made.
4856 &quot;kind&quot;: &quot;drive#user&quot;, # This is always drive#user.
4857 &quot;permissionId&quot;: &quot;A String&quot;, # The user&#x27;s ID as visible in the permissions collection.
4858 &quot;picture&quot;: { # The user&#x27;s profile picture.
4859 &quot;url&quot;: &quot;A String&quot;, # A URL that points to a profile picture of this user.
4860 },
4861 },
4862 &quot;userPermission&quot;: { # A permission for a file. # The permissions for the authenticated user on this file.
4863 &quot;additionalRoles&quot;: [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future.
4864 &quot;A String&quot;,
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]4865 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]4866 &quot;authKey&quot;: &quot;A String&quot;, # Deprecated.
4867 &quot;deleted&quot;: True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.
4868 &quot;domain&quot;: &quot;A String&quot;, # 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.
4869 &quot;emailAddress&quot;: &quot;A String&quot;, # 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.
4870 &quot;etag&quot;: &quot;A String&quot;, # The ETag of the permission.
4871 &quot;expirationDate&quot;: &quot;A String&quot;, # 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]4872 # - They cannot be set on shared drive items
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]4873 # - They can only be set on user and group permissions
4874 # - The date must be in the future
4875 # - The date cannot be more than a year in the future
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4876 # - The date can only be set on drive.permissions.update or drive.permissions.patch requests
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]4877 &quot;id&quot;: &quot;A String&quot;, # 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.
4878 &quot;kind&quot;: &quot;drive#permission&quot;, # This is always drive#permission.
4879 &quot;name&quot;: &quot;A String&quot;, # The name for this permission.
4880 &quot;permissionDetails&quot;: [ # 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.
4881 {
4882 &quot;additionalRoles&quot;: [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future.
4883 &quot;A String&quot;,
4884 ],
4885 &quot;inherited&quot;: True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field.
4886 &quot;inheritedFrom&quot;: &quot;A String&quot;, # The ID of the item from which this permission is inherited. This is an output-only field.
4887 &quot;permissionType&quot;: &quot;A String&quot;, # The permission type for this user. While new values may be added in future, the following are currently possible:
4888 # - file
4889 # - member
4890 &quot;role&quot;: &quot;A String&quot;, # The primary role for this user. While new values may be added in the future, the following are currently possible:
4891 # - organizer
4892 # - fileOrganizer
4893 # - writer
4894 # - reader
4895 },
4896 ],
4897 &quot;photoLink&quot;: &quot;A String&quot;, # A link to the profile photo, if available.
4898 &quot;role&quot;: &quot;A String&quot;, # 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]4899 # - owner
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4900 # - organizer
4901 # - fileOrganizer
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]4902 # - writer
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4903 # - reader
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]4904 &quot;selfLink&quot;: &quot;A String&quot;, # A link back to this permission.
4905 &quot;teamDrivePermissionDetails&quot;: [ # Deprecated - use permissionDetails instead.
4906 {
4907 &quot;additionalRoles&quot;: [ # Deprecated - use permissionDetails/additionalRoles instead.
4908 &quot;A String&quot;,
4909 ],
4910 &quot;inherited&quot;: True or False, # Deprecated - use permissionDetails/inherited instead.
4911 &quot;inheritedFrom&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/inheritedFrom instead.
4912 &quot;role&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/role instead.
4913 &quot;teamDrivePermissionType&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/permissionType instead.
4914 },
4915 ],
4916 &quot;type&quot;: &quot;A String&quot;, # The account type. Allowed values are:
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]4917 # - user
4918 # - group
4919 # - domain
4920 # - anyone
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]4921 &quot;value&quot;: &quot;A String&quot;, # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type is anyone, in which case both id and value are ignored.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]4922 &quot;view&quot;: &quot;A String&quot;, # Indicates the view for this permission. Only populated for permissions that belong to a view. published is the only supported value.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]4923 &quot;withLink&quot;: True or False, # Whether the link is required for this permission.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]4924 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]4925 &quot;version&quot;: &quot;A String&quot;, # 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.
4926 &quot;videoMediaMetadata&quot;: { # Metadata about video media. This will only be present for video types.
4927 &quot;durationMillis&quot;: &quot;A String&quot;, # The duration of the video in milliseconds.
4928 &quot;height&quot;: 42, # The height of the video in pixels.
4929 &quot;width&quot;: 42, # The width of the video in pixels.
4930 },
4931 &quot;webContentLink&quot;: &quot;A String&quot;, # 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.
4932 &quot;webViewLink&quot;: &quot;A String&quot;, # A link only available on public folders for viewing their static web assets (HTML, CSS, JS, etc) via Google Drive&#x27;s Website Hosting.
4933 &quot;writersCanShare&quot;: True or False, # Whether writers can share the document with other users. Not populated for items in shared drives.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]4934}
4935
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]4936 addParents: string, Comma-separated list of parent IDs to add.
4937 convert: boolean, This parameter is deprecated and has no function.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]4938 enforceSingleParent: boolean, Deprecated. Adding files to multiple folders is no longer supported. Use shortcuts instead.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]4939 includePermissionsForView: string, Specifies which additional view&#x27;s permissions to include in the response. Only &#x27;published&#x27; is supported.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]4940 media_body: string, The filename of the media request body, or an instance of a MediaUpload object.
4941 media_mime_type: string, The MIME type of the media request body, or an instance of a MediaUpload object.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]4942 modifiedDateBehavior: string, Determines the behavior in which modifiedDate is updated. This overrides setModifiedDate.
4943 Allowed values
4944 fromBody - Set modifiedDate to the value provided in the body of the request. No change if no value was provided.
4945 fromBodyIfNeeded - Set modifiedDate to the value provided in the body of the request depending on other contents of the update.
4946 fromBodyOrNow - Set modifiedDate to the value provided in the body of the request, or to the current time if no value was provided.
4947 noChange - Maintain the previous value of modifiedDate.
4948 now - Set modifiedDate to the current time.
4949 nowIfNeeded - Set modifiedDate to the current time depending on contents of the update.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]4950 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. Note that this field is ignored if there is no payload in the request.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]4951 ocr: boolean, Whether to attempt OCR on .jpg, .png, .gif, or .pdf uploads.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]4952 ocrLanguage: string, If ocr is true, hints at the language to use. Valid values are BCP 47 codes.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]4953 pinned: boolean, Whether to pin the new revision. A file can have a maximum of 200 pinned revisions. Note that this field is ignored if there is no payload in the request.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]4954 removeParents: string, Comma-separated list of parent IDs to remove.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4955 setModifiedDate: boolean, Whether to set the modified date using the value supplied in the request body. Setting this field to true is equivalent to modifiedDateBehavior=fromBodyOrNow, and false is equivalent to modifiedDateBehavior=now. To prevent any changes to the modified date set modifiedDateBehavior=noChange.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]4956 supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]4957 supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]4958 timedTextLanguage: string, The language of the timed text.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]4959 timedTextTrackName: string, The timed text track name.
4960 updateViewedDate: boolean, Whether to update the view date after successfully updating the file.
4961 useContentAsIndexableText: boolean, Whether to use the content as indexable text.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]4962
4963Returns:
4964 An object of the form:
4965
4966 { # The metadata for a file.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]4967 &quot;alternateLink&quot;: &quot;A String&quot;, # A link for opening the file in a relevant Google editor or viewer.
4968 &quot;appDataContents&quot;: True or False, # Whether this file is in the Application Data folder.
4969 &quot;canComment&quot;: True or False, # Deprecated: use capabilities/canComment.
4970 &quot;canReadRevisions&quot;: True or False, # Deprecated: use capabilities/canReadRevisions.
4971 &quot;capabilities&quot;: { # Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take.
4972 &quot;canAddChildren&quot;: True or False, # Whether the current user can add children to this folder. This is always false when the item is not a folder.
4973 &quot;canAddFolderFromAnotherDrive&quot;: True or False, # Whether the current user can add a folder from another drive (different shared drive or My Drive) to this folder. This is false when the item is not a folder. Only populated for items in shared drives.
4974 &quot;canAddMyDriveParent&quot;: 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.
4975 &quot;canChangeCopyRequiresWriterPermission&quot;: True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this file.
4976 &quot;canChangeRestrictedDownload&quot;: True or False, # Deprecated
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700[diff] [blame^]4977 &quot;canChangeSecurityUpdateEnabled&quot;: True or False, # Whether the current user can change the securityUpdateEnabled field on link share metadata.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]4978 &quot;canComment&quot;: True or False, # Whether the current user can comment on this file.
4979 &quot;canCopy&quot;: 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.
4980 &quot;canDelete&quot;: True or False, # Whether the current user can delete this file.
4981 &quot;canDeleteChildren&quot;: 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.
4982 &quot;canDownload&quot;: True or False, # Whether the current user can download this file.
4983 &quot;canEdit&quot;: 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.
4984 &quot;canListChildren&quot;: 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.
4985 &quot;canModifyContent&quot;: True or False, # Whether the current user can modify the content of this file.
4986 &quot;canModifyContentRestriction&quot;: True or False, # Whether the current user can modify restrictions on content of this file.
4987 &quot;canMoveChildrenOutOfDrive&quot;: 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.
4988 &quot;canMoveChildrenOutOfTeamDrive&quot;: True or False, # Deprecated - use canMoveChildrenOutOfDrive instead.
4989 &quot;canMoveChildrenWithinDrive&quot;: True or False, # Whether the current user can move children of this folder within this drive. This is false when the item is not a folder. Note that a request to move the child may still fail depending on the current user&#x27;s access to the child and to the destination folder.
4990 &quot;canMoveChildrenWithinTeamDrive&quot;: True or False, # Deprecated - use canMoveChildrenWithinDrive instead.
4991 &quot;canMoveItemIntoTeamDrive&quot;: True or False, # Deprecated - use canMoveItemOutOfDrive instead.
4992 &quot;canMoveItemOutOfDrive&quot;: 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.
4993 &quot;canMoveItemOutOfTeamDrive&quot;: True or False, # Deprecated - use canMoveItemOutOfDrive instead.
4994 &quot;canMoveItemWithinDrive&quot;: True or False, # Whether the current user can move this item within this drive. Note that a request to change the parent of the item may still fail depending on the new parent that is being added and the parent that is being removed.
4995 &quot;canMoveItemWithinTeamDrive&quot;: True or False, # Deprecated - use canMoveItemWithinDrive instead.
4996 &quot;canMoveTeamDriveItem&quot;: True or False, # Deprecated - use canMoveItemWithinDrive or canMoveItemOutOfDrive instead.
4997 &quot;canReadDrive&quot;: True or False, # Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives.
4998 &quot;canReadRevisions&quot;: 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.
4999 &quot;canReadTeamDrive&quot;: True or False, # Deprecated - use canReadDrive instead.
5000 &quot;canRemoveChildren&quot;: 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.
5001 &quot;canRemoveMyDriveParent&quot;: 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.
5002 &quot;canRename&quot;: True or False, # Whether the current user can rename this file.
5003 &quot;canShare&quot;: True or False, # Whether the current user can modify the sharing settings for this file.
5004 &quot;canTrash&quot;: True or False, # Whether the current user can move this file to trash.
5005 &quot;canTrashChildren&quot;: 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.
5006 &quot;canUntrash&quot;: True or False, # Whether the current user can restore this file from trash.
5007 },
5008 &quot;contentRestrictions&quot;: [ # Restrictions for accessing the content of the file. Only populated if such a restriction exists.
5009 { # A restriction for accessing the content of the file.
5010 &quot;readOnly&quot;: True or False, # Whether the content of the file is read-only. If a file is read-only, a new revision of the file may not be added, comments may not be added or modified, and the title of the file may not be modified.
5011 &quot;reason&quot;: &quot;A String&quot;, # Reason for why the content of the file is restricted. This is only mutable on requests that also set readOnly=true.
5012 &quot;restrictingUser&quot;: { # Information about a Drive user. # The user who set the content restriction. Only populated if readOnly is true.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]5013 &quot;displayName&quot;: &quot;A String&quot;, # A plain text displayable name for this user.
5014 &quot;emailAddress&quot;: &quot;A String&quot;, # The email address of the user.
5015 &quot;isAuthenticatedUser&quot;: True or False, # Whether this user is the same as the authenticated user for whom the request was made.
5016 &quot;kind&quot;: &quot;drive#user&quot;, # This is always drive#user.
5017 &quot;permissionId&quot;: &quot;A String&quot;, # The user&#x27;s ID as visible in the permissions collection.
5018 &quot;picture&quot;: { # The user&#x27;s profile picture.
5019 &quot;url&quot;: &quot;A String&quot;, # A URL that points to a profile picture of this user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]5020 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]5021 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]5022 &quot;restrictionDate&quot;: &quot;A String&quot;, # The time at which the content restriction was set (formatted RFC 3339 timestamp). Only populated if readOnly is true.
5023 &quot;type&quot;: &quot;A String&quot;, # The type of the content restriction. Currently the only possible value is globalContentRestriction.
5024 },
5025 ],
5026 &quot;copyRequiresWriterPermission&quot;: True or False, # Whether the options to copy, print, or download this file, should be disabled for readers and commenters.
5027 &quot;copyable&quot;: True or False, # Deprecated: use capabilities/canCopy.
5028 &quot;createdDate&quot;: &quot;A String&quot;, # Create time for this file (formatted RFC 3339 timestamp).
5029 &quot;defaultOpenWithLink&quot;: &quot;A String&quot;, # A link to open this file with the user&#x27;s default app for this file. Only populated when the drive.apps.readonly scope is used.
5030 &quot;description&quot;: &quot;A String&quot;, # A short description of the file.
5031 &quot;downloadUrl&quot;: &quot;A String&quot;, # Short lived download URL for the file. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.
5032 &quot;driveId&quot;: &quot;A String&quot;, # ID of the shared drive the file resides in. Only populated for items in shared drives.
5033 &quot;editable&quot;: True or False, # Deprecated: use capabilities/canEdit.
5034 &quot;embedLink&quot;: &quot;A String&quot;, # A link for embedding the file.
5035 &quot;etag&quot;: &quot;A String&quot;, # ETag of the file.
5036 &quot;explicitlyTrashed&quot;: True or False, # Whether this file has been explicitly trashed, as opposed to recursively trashed.
5037 &quot;exportLinks&quot;: { # Links for exporting Docs Editors files to specific formats.
5038 &quot;a_key&quot;: &quot;A String&quot;, # A mapping from export format to URL
5039 },
5040 &quot;fileExtension&quot;: &quot;A String&quot;, # The final component of fullFileExtension with trailing text that does not appear to be part of the extension removed. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.
5041 &quot;fileSize&quot;: &quot;A String&quot;, # The size of the file in bytes. This field is populated for files with content stored in Google Drive and for files in Docs Editors; it is not populated for shortcut files.
5042 &quot;folderColorRgb&quot;: &quot;A String&quot;, # 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.
5043 &quot;fullFileExtension&quot;: &quot;A String&quot;, # The full file extension; extracted from the title. May contain multiple concatenated extensions, such as &quot;tar.gz&quot;. Removing an extension from the title does not clear this field; however, changing the extension on the title does update this field. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.
5044 &quot;hasAugmentedPermissions&quot;: True or False, # Whether there are permissions directly on this file. This field is only populated for items in shared drives.
5045 &quot;hasThumbnail&quot;: 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.
5046 &quot;headRevisionId&quot;: &quot;A String&quot;, # The ID of the file&#x27;s head revision. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.
5047 &quot;iconLink&quot;: &quot;A String&quot;, # A link to the file&#x27;s icon.
5048 &quot;id&quot;: &quot;A String&quot;, # The ID of the file.
5049 &quot;imageMediaMetadata&quot;: { # 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.
5050 &quot;aperture&quot;: 3.14, # The aperture used to create the photo (f-number).
5051 &quot;cameraMake&quot;: &quot;A String&quot;, # The make of the camera used to create the photo.
5052 &quot;cameraModel&quot;: &quot;A String&quot;, # The model of the camera used to create the photo.
5053 &quot;colorSpace&quot;: &quot;A String&quot;, # The color space of the photo.
5054 &quot;date&quot;: &quot;A String&quot;, # The date and time the photo was taken (EXIF format timestamp).
5055 &quot;exposureBias&quot;: 3.14, # The exposure bias of the photo (APEX value).
5056 &quot;exposureMode&quot;: &quot;A String&quot;, # The exposure mode used to create the photo.
5057 &quot;exposureTime&quot;: 3.14, # The length of the exposure, in seconds.
5058 &quot;flashUsed&quot;: True or False, # Whether a flash was used to create the photo.
5059 &quot;focalLength&quot;: 3.14, # The focal length used to create the photo, in millimeters.
5060 &quot;height&quot;: 42, # The height of the image in pixels.
5061 &quot;isoSpeed&quot;: 42, # The ISO speed used to create the photo.
5062 &quot;lens&quot;: &quot;A String&quot;, # The lens used to create the photo.
5063 &quot;location&quot;: { # Geographic location information stored in the image.
5064 &quot;altitude&quot;: 3.14, # The altitude stored in the image.
5065 &quot;latitude&quot;: 3.14, # The latitude stored in the image.
5066 &quot;longitude&quot;: 3.14, # The longitude stored in the image.
5067 },
5068 &quot;maxApertureValue&quot;: 3.14, # The smallest f-number of the lens at the focal length used to create the photo (APEX value).
5069 &quot;meteringMode&quot;: &quot;A String&quot;, # The metering mode used to create the photo.
5070 &quot;rotation&quot;: 42, # The number of clockwise 90 degree rotations applied from the image&#x27;s original orientation.
5071 &quot;sensor&quot;: &quot;A String&quot;, # The type of sensor used to create the photo.
5072 &quot;subjectDistance&quot;: 42, # The distance to the subject of the photo, in meters.
5073 &quot;whiteBalance&quot;: &quot;A String&quot;, # The white balance mode used to create the photo.
5074 &quot;width&quot;: 42, # The width of the image in pixels.
5075 },
5076 &quot;indexableText&quot;: { # Indexable text attributes for the file (can only be written)
5077 &quot;text&quot;: &quot;A String&quot;, # The text to be indexed for this file.
5078 },
5079 &quot;isAppAuthorized&quot;: True or False, # Whether the file was created or opened by the requesting app.
5080 &quot;kind&quot;: &quot;drive#file&quot;, # The type of file. This is always drive#file.
5081 &quot;labels&quot;: { # A group of labels for the file.
5082 &quot;hidden&quot;: True or False, # Deprecated.
5083 &quot;modified&quot;: True or False, # Whether the file has been modified by this user.
5084 &quot;restricted&quot;: True or False, # Deprecated - use copyRequiresWriterPermission instead.
5085 &quot;starred&quot;: True or False, # Whether this file is starred by the user.
5086 &quot;trashed&quot;: True or False, # Whether the file has been trashed, either explicitly or from a trashed parent folder. Only the owner may trash a file. The trashed item is excluded from all files.list responses returned for any user who does not own the file. However, all users with access to the file can see the trashed item metadata in an API response. All users with access can copy, download, export, and share the file.
5087 &quot;viewed&quot;: True or False, # Whether this file has been viewed by this user.
5088 },
5089 &quot;lastModifyingUser&quot;: { # Information about a Drive user. # The last user to modify this file.
5090 &quot;displayName&quot;: &quot;A String&quot;, # A plain text displayable name for this user.
5091 &quot;emailAddress&quot;: &quot;A String&quot;, # The email address of the user.
5092 &quot;isAuthenticatedUser&quot;: True or False, # Whether this user is the same as the authenticated user for whom the request was made.
5093 &quot;kind&quot;: &quot;drive#user&quot;, # This is always drive#user.
5094 &quot;permissionId&quot;: &quot;A String&quot;, # The user&#x27;s ID as visible in the permissions collection.
5095 &quot;picture&quot;: { # The user&#x27;s profile picture.
5096 &quot;url&quot;: &quot;A String&quot;, # A URL that points to a profile picture of this user.
5097 },
5098 },
5099 &quot;lastModifyingUserName&quot;: &quot;A String&quot;, # Name of the last user to modify this file.
5100 &quot;lastViewedByMeDate&quot;: &quot;A String&quot;, # Last time this file was viewed by the user (formatted RFC 3339 timestamp).
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700[diff] [blame^]5101 &quot;linkShareMetadata&quot;: { # Contains details about the link URLs that clients are using to refer to this item.
5102 &quot;securityUpdateEligible&quot;: True or False, # Whether the file is eligible for security update.
5103 &quot;securityUpdateEnabled&quot;: True or False, # Whether the security update is enabled for this file.
5104 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]5105 &quot;markedViewedByMeDate&quot;: &quot;A String&quot;, # Deprecated.
5106 &quot;md5Checksum&quot;: &quot;A String&quot;, # An MD5 checksum for the content of this file. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.
5107 &quot;mimeType&quot;: &quot;A String&quot;, # 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&#x27;s MIME type.
5108 &quot;modifiedByMeDate&quot;: &quot;A String&quot;, # 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.
5109 &quot;modifiedDate&quot;: &quot;A String&quot;, # Last time this file was modified by anyone (formatted RFC 3339 timestamp). This is only mutable on update when the setModifiedDate parameter is set.
5110 &quot;openWithLinks&quot;: { # A map of the id of each of the user&#x27;s apps to a link to open this file with that app. Only populated when the drive.apps.readonly scope is used.
5111 &quot;a_key&quot;: &quot;A String&quot;,
5112 },
5113 &quot;originalFilename&quot;: &quot;A String&quot;, # 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.
5114 &quot;ownedByMe&quot;: True or False, # Whether the file is owned by the current user. Not populated for items in shared drives.
5115 &quot;ownerNames&quot;: [ # Name(s) of the owner(s) of this file. Not populated for items in shared drives.
5116 &quot;A String&quot;,
5117 ],
yoshi-code-botab1d6dc2021-05-28 00:42:02 -0700[diff] [blame]5118 &quot;owners&quot;: [ # The owner of this file. Only certain legacy files may have more than one owner. This field isn&#x27;t populated for items in shared drives.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]5119 { # Information about a Drive user.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]5120 &quot;displayName&quot;: &quot;A String&quot;, # A plain text displayable name for this user.
5121 &quot;emailAddress&quot;: &quot;A String&quot;, # The email address of the user.
5122 &quot;isAuthenticatedUser&quot;: True or False, # Whether this user is the same as the authenticated user for whom the request was made.
5123 &quot;kind&quot;: &quot;drive#user&quot;, # This is always drive#user.
5124 &quot;permissionId&quot;: &quot;A String&quot;, # The user&#x27;s ID as visible in the permissions collection.
5125 &quot;picture&quot;: { # The user&#x27;s profile picture.
5126 &quot;url&quot;: &quot;A String&quot;, # A URL that points to a profile picture of this user.
5127 },
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]5128 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]5129 ],
5130 &quot;parents&quot;: [ # Collection of parent folders which contain this file.
5131 # If not specified as part of an insert request, the file will be placed directly in the user&#x27;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.
5132 { # A reference to a file&#x27;s parent.
5133 &quot;id&quot;: &quot;A String&quot;, # The ID of the parent.
5134 &quot;isRoot&quot;: True or False, # Whether or not the parent is the root folder.
5135 &quot;kind&quot;: &quot;drive#parentReference&quot;, # This is always drive#parentReference.
5136 &quot;parentLink&quot;: &quot;A String&quot;, # A link to the parent.
5137 &quot;selfLink&quot;: &quot;A String&quot;, # A link back to this reference.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]5138 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]5139 ],
5140 &quot;permissionIds&quot;: [ # List of permission IDs for users with access to this file.
5141 &quot;A String&quot;,
5142 ],
5143 &quot;permissions&quot;: [ # The list of permissions for users with access to this file. Not populated for items in shared drives.
5144 { # A permission for a file.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]5145 &quot;additionalRoles&quot;: [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future.
5146 &quot;A String&quot;,
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]5147 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]5148 &quot;authKey&quot;: &quot;A String&quot;, # Deprecated.
5149 &quot;deleted&quot;: True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.
5150 &quot;domain&quot;: &quot;A String&quot;, # 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.
5151 &quot;emailAddress&quot;: &quot;A String&quot;, # 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.
5152 &quot;etag&quot;: &quot;A String&quot;, # The ETag of the permission.
5153 &quot;expirationDate&quot;: &quot;A String&quot;, # 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]5154 # - They cannot be set on shared drive items
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]5155 # - They can only be set on user and group permissions
5156 # - The date must be in the future
5157 # - The date cannot be more than a year in the future
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5158 # - The date can only be set on drive.permissions.update or drive.permissions.patch requests
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]5159 &quot;id&quot;: &quot;A String&quot;, # 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.
5160 &quot;kind&quot;: &quot;drive#permission&quot;, # This is always drive#permission.
5161 &quot;name&quot;: &quot;A String&quot;, # The name for this permission.
5162 &quot;permissionDetails&quot;: [ # 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.
5163 {
5164 &quot;additionalRoles&quot;: [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future.
5165 &quot;A String&quot;,
5166 ],
5167 &quot;inherited&quot;: True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field.
5168 &quot;inheritedFrom&quot;: &quot;A String&quot;, # The ID of the item from which this permission is inherited. This is an output-only field.
5169 &quot;permissionType&quot;: &quot;A String&quot;, # The permission type for this user. While new values may be added in future, the following are currently possible:
5170 # - file
5171 # - member
5172 &quot;role&quot;: &quot;A String&quot;, # The primary role for this user. While new values may be added in the future, the following are currently possible:
5173 # - organizer
5174 # - fileOrganizer
5175 # - writer
5176 # - reader
5177 },
5178 ],
5179 &quot;photoLink&quot;: &quot;A String&quot;, # A link to the profile photo, if available.
5180 &quot;role&quot;: &quot;A String&quot;, # 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]5181 # - owner
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5182 # - organizer
5183 # - fileOrganizer
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]5184 # - writer
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5185 # - reader
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]5186 &quot;selfLink&quot;: &quot;A String&quot;, # A link back to this permission.
5187 &quot;teamDrivePermissionDetails&quot;: [ # Deprecated - use permissionDetails instead.
5188 {
5189 &quot;additionalRoles&quot;: [ # Deprecated - use permissionDetails/additionalRoles instead.
5190 &quot;A String&quot;,
5191 ],
5192 &quot;inherited&quot;: True or False, # Deprecated - use permissionDetails/inherited instead.
5193 &quot;inheritedFrom&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/inheritedFrom instead.
5194 &quot;role&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/role instead.
5195 &quot;teamDrivePermissionType&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/permissionType instead.
5196 },
5197 ],
5198 &quot;type&quot;: &quot;A String&quot;, # The account type. Allowed values are:
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]5199 # - user
5200 # - group
5201 # - domain
5202 # - anyone
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]5203 &quot;value&quot;: &quot;A String&quot;, # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type is anyone, in which case both id and value are ignored.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]5204 &quot;view&quot;: &quot;A String&quot;, # Indicates the view for this permission. Only populated for permissions that belong to a view. published is the only supported value.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]5205 &quot;withLink&quot;: True or False, # Whether the link is required for this permission.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]5206 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]5207 ],
5208 &quot;properties&quot;: [ # The list of properties.
5209 { # A key-value pair attached to a file that is either public or private to an application.
5210 # The following limits apply to file properties:
5211 # - Maximum of 100 properties total per file
5212 # - Maximum of 30 private properties per app
5213 # - Maximum of 30 public properties
5214 # - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property.
5215 &quot;etag&quot;: &quot;A String&quot;, # ETag of the property.
5216 &quot;key&quot;: &quot;A String&quot;, # The key of this property.
5217 &quot;kind&quot;: &quot;drive#property&quot;, # This is always drive#property.
5218 &quot;selfLink&quot;: &quot;A String&quot;, # The link back to this property.
5219 &quot;value&quot;: &quot;A String&quot;, # The value of this property.
yoshi-code-bot69706592021-03-03 03:54:02 -0800[diff] [blame]5220 &quot;visibility&quot;: &quot;A String&quot;, # The visibility of this property. Allowed values are PRIVATE and PUBLIC. (Default: PRIVATE). Private properties can only be retrieved using an authenticated request. An authenticated request uses an access token obtained with a OAuth 2 client ID. You cannot use an API key to retrieve private properties.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]5221 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]5222 ],
5223 &quot;quotaBytesUsed&quot;: &quot;A String&quot;, # The number of quota bytes used by this file.
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700[diff] [blame^]5224 &quot;resourceKey&quot;: &quot;A String&quot;, # A key needed to access the item via a shared link.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]5225 &quot;selfLink&quot;: &quot;A String&quot;, # A link back to this file.
5226 &quot;shareable&quot;: True or False, # Deprecated: use capabilities/canShare.
5227 &quot;shared&quot;: True or False, # Whether the file has been shared. Not populated for items in shared drives.
5228 &quot;sharedWithMeDate&quot;: &quot;A String&quot;, # Time at which this file was shared with the user (formatted RFC 3339 timestamp).
5229 &quot;sharingUser&quot;: { # Information about a Drive user. # User that shared the item with the current user, if available.
5230 &quot;displayName&quot;: &quot;A String&quot;, # A plain text displayable name for this user.
5231 &quot;emailAddress&quot;: &quot;A String&quot;, # The email address of the user.
5232 &quot;isAuthenticatedUser&quot;: True or False, # Whether this user is the same as the authenticated user for whom the request was made.
5233 &quot;kind&quot;: &quot;drive#user&quot;, # This is always drive#user.
5234 &quot;permissionId&quot;: &quot;A String&quot;, # The user&#x27;s ID as visible in the permissions collection.
5235 &quot;picture&quot;: { # The user&#x27;s profile picture.
5236 &quot;url&quot;: &quot;A String&quot;, # A URL that points to a profile picture of this user.
5237 },
5238 },
5239 &quot;shortcutDetails&quot;: { # Shortcut file details. Only populated for shortcut files, which have the mimeType field set to application/vnd.google-apps.shortcut.
5240 &quot;targetId&quot;: &quot;A String&quot;, # The ID of the file that this shortcut points to.
5241 &quot;targetMimeType&quot;: &quot;A String&quot;, # The MIME type of the file that this shortcut points to. The value of this field is a snapshot of the target&#x27;s MIME type, captured when the shortcut is created.
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700[diff] [blame^]5242 &quot;targetResourceKey&quot;: &quot;A String&quot;, # The ResourceKey for the target file.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]5243 },
5244 &quot;spaces&quot;: [ # The list of spaces which contain the file. Supported values are &#x27;drive&#x27;, &#x27;appDataFolder&#x27; and &#x27;photos&#x27;.
5245 &quot;A String&quot;,
5246 ],
5247 &quot;teamDriveId&quot;: &quot;A String&quot;, # Deprecated - use driveId instead.
5248 &quot;thumbnail&quot;: { # A thumbnail for the file. This will only be used if a standard thumbnail cannot be generated.
5249 &quot;image&quot;: &quot;A String&quot;, # The URL-safe Base64 encoded bytes of the thumbnail image. It should conform to RFC 4648 section 5.
5250 &quot;mimeType&quot;: &quot;A String&quot;, # The MIME type of the thumbnail.
5251 },
5252 &quot;thumbnailLink&quot;: &quot;A String&quot;, # A short-lived link to the file&#x27;s thumbnail. Typically lasts on the order of hours. Only populated when the requesting app can access the file&#x27;s content. If the file isn&#x27;t shared publicly, the URL returned in Files.thumbnailLink must be fetched using a credentialed request.
5253 &quot;thumbnailVersion&quot;: &quot;A String&quot;, # The thumbnail version for use in thumbnail cache invalidation.
5254 &quot;title&quot;: &quot;A String&quot;, # 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.
5255 &quot;trashedDate&quot;: &quot;A String&quot;, # The time that the item was trashed (formatted RFC 3339 timestamp). Only populated for items in shared drives.
5256 &quot;trashingUser&quot;: { # Information about a Drive user. # If the file has been explicitly trashed, the user who trashed it. Only populated for items in shared drives.
5257 &quot;displayName&quot;: &quot;A String&quot;, # A plain text displayable name for this user.
5258 &quot;emailAddress&quot;: &quot;A String&quot;, # The email address of the user.
5259 &quot;isAuthenticatedUser&quot;: True or False, # Whether this user is the same as the authenticated user for whom the request was made.
5260 &quot;kind&quot;: &quot;drive#user&quot;, # This is always drive#user.
5261 &quot;permissionId&quot;: &quot;A String&quot;, # The user&#x27;s ID as visible in the permissions collection.
5262 &quot;picture&quot;: { # The user&#x27;s profile picture.
5263 &quot;url&quot;: &quot;A String&quot;, # A URL that points to a profile picture of this user.
5264 },
5265 },
5266 &quot;userPermission&quot;: { # A permission for a file. # The permissions for the authenticated user on this file.
5267 &quot;additionalRoles&quot;: [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future.
5268 &quot;A String&quot;,
5269 ],
5270 &quot;authKey&quot;: &quot;A String&quot;, # Deprecated.
5271 &quot;deleted&quot;: True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.
5272 &quot;domain&quot;: &quot;A String&quot;, # 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.
5273 &quot;emailAddress&quot;: &quot;A String&quot;, # 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.
5274 &quot;etag&quot;: &quot;A String&quot;, # The ETag of the permission.
5275 &quot;expirationDate&quot;: &quot;A String&quot;, # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions:
5276 # - They cannot be set on shared drive items
5277 # - They can only be set on user and group permissions
5278 # - The date must be in the future
5279 # - The date cannot be more than a year in the future
5280 # - The date can only be set on drive.permissions.update or drive.permissions.patch requests
5281 &quot;id&quot;: &quot;A String&quot;, # 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.
5282 &quot;kind&quot;: &quot;drive#permission&quot;, # This is always drive#permission.
5283 &quot;name&quot;: &quot;A String&quot;, # The name for this permission.
5284 &quot;permissionDetails&quot;: [ # 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.
5285 {
5286 &quot;additionalRoles&quot;: [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future.
5287 &quot;A String&quot;,
5288 ],
5289 &quot;inherited&quot;: True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field.
5290 &quot;inheritedFrom&quot;: &quot;A String&quot;, # The ID of the item from which this permission is inherited. This is an output-only field.
5291 &quot;permissionType&quot;: &quot;A String&quot;, # The permission type for this user. While new values may be added in future, the following are currently possible:
5292 # - file
5293 # - member
5294 &quot;role&quot;: &quot;A String&quot;, # The primary role for this user. While new values may be added in the future, the following are currently possible:
5295 # - organizer
5296 # - fileOrganizer
5297 # - writer
5298 # - reader
5299 },
5300 ],
5301 &quot;photoLink&quot;: &quot;A String&quot;, # A link to the profile photo, if available.
5302 &quot;role&quot;: &quot;A String&quot;, # The primary role for this user. While new values may be supported in the future, the following are currently allowed:
5303 # - owner
5304 # - organizer
5305 # - fileOrganizer
5306 # - writer
5307 # - reader
5308 &quot;selfLink&quot;: &quot;A String&quot;, # A link back to this permission.
5309 &quot;teamDrivePermissionDetails&quot;: [ # Deprecated - use permissionDetails instead.
5310 {
5311 &quot;additionalRoles&quot;: [ # Deprecated - use permissionDetails/additionalRoles instead.
5312 &quot;A String&quot;,
5313 ],
5314 &quot;inherited&quot;: True or False, # Deprecated - use permissionDetails/inherited instead.
5315 &quot;inheritedFrom&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/inheritedFrom instead.
5316 &quot;role&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/role instead.
5317 &quot;teamDrivePermissionType&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/permissionType instead.
5318 },
5319 ],
5320 &quot;type&quot;: &quot;A String&quot;, # The account type. Allowed values are:
5321 # - user
5322 # - group
5323 # - domain
5324 # - anyone
5325 &quot;value&quot;: &quot;A String&quot;, # 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.
5326 &quot;view&quot;: &quot;A String&quot;, # Indicates the view for this permission. Only populated for permissions that belong to a view. published is the only supported value.
5327 &quot;withLink&quot;: True or False, # Whether the link is required for this permission.
5328 },
5329 &quot;version&quot;: &quot;A String&quot;, # 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.
5330 &quot;videoMediaMetadata&quot;: { # Metadata about video media. This will only be present for video types.
5331 &quot;durationMillis&quot;: &quot;A String&quot;, # The duration of the video in milliseconds.
5332 &quot;height&quot;: 42, # The height of the video in pixels.
5333 &quot;width&quot;: 42, # The width of the video in pixels.
5334 },
5335 &quot;webContentLink&quot;: &quot;A String&quot;, # 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.
5336 &quot;webViewLink&quot;: &quot;A String&quot;, # A link only available on public folders for viewing their static web assets (HTML, CSS, JS, etc) via Google Drive&#x27;s Website Hosting.
5337 &quot;writersCanShare&quot;: True or False, # Whether writers can share the document with other users. Not populated for items in shared drives.
5338}</pre>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]5339</div>
5340
5341<div class="method">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]5342 <code class="details" id="watch">watch(fileId, acknowledgeAbuse=None, body=None, includePermissionsForView=None, projection=None, revisionId=None, supportsAllDrives=None, supportsTeamDrives=None, updateViewedDate=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]5343 <pre>Subscribe to changes on a file
5344
5345Args:
5346 fileId: string, The ID for the file in question. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]5347 body: object, The request body.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]5348 The object takes the form of:
5349
5350{ # An notification channel used to watch for resource changes.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]5351 &quot;address&quot;: &quot;A String&quot;, # The address where notifications are delivered for this channel.
5352 &quot;expiration&quot;: &quot;A String&quot;, # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.
5353 &quot;id&quot;: &quot;A String&quot;, # A UUID or similar unique string that identifies this channel.
5354 &quot;kind&quot;: &quot;api#channel&quot;, # Identifies this as a notification channel used to watch for changes to a resource, which is &quot;api#channel&quot;.
5355 &quot;params&quot;: { # Additional parameters controlling delivery channel behavior. Optional.
5356 &quot;a_key&quot;: &quot;A String&quot;, # Declares a new parameter by name.
5357 },
5358 &quot;payload&quot;: True or False, # A Boolean value to indicate whether payload is wanted. Optional.
5359 &quot;resourceId&quot;: &quot;A String&quot;, # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.
5360 &quot;resourceUri&quot;: &quot;A String&quot;, # A version-specific identifier for the watched resource.
5361 &quot;token&quot;: &quot;A String&quot;, # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700[diff] [blame]5362 &quot;type&quot;: &quot;A String&quot;, # The type of delivery mechanism used for this channel. Valid values are &quot;web_hook&quot; (or &quot;webhook&quot;). Both values refer to a channel where Http requests are used to deliver messages.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]5363}
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]5364
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]5365 acknowledgeAbuse: boolean, Whether the user is acknowledging the risk of downloading known malware or other abusive files.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]5366 includePermissionsForView: string, Specifies which additional view&#x27;s permissions to include in the response. Only &#x27;published&#x27; is supported.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]5367 projection: string, This parameter is deprecated and has no function.
5368 Allowed values
5369 BASIC - Deprecated
5370 FULL - Deprecated
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]5371 revisionId: string, Specifies the Revision ID that should be downloaded. Ignored unless alt=media is specified.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]5372 supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]5373 supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]5374 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]5375
5376Returns:
5377 An object of the form:
5378
5379 { # An notification channel used to watch for resource changes.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]5380 &quot;address&quot;: &quot;A String&quot;, # The address where notifications are delivered for this channel.
5381 &quot;expiration&quot;: &quot;A String&quot;, # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.
5382 &quot;id&quot;: &quot;A String&quot;, # A UUID or similar unique string that identifies this channel.
5383 &quot;kind&quot;: &quot;api#channel&quot;, # Identifies this as a notification channel used to watch for changes to a resource, which is &quot;api#channel&quot;.
5384 &quot;params&quot;: { # Additional parameters controlling delivery channel behavior. Optional.
5385 &quot;a_key&quot;: &quot;A String&quot;, # Declares a new parameter by name.
5386 },
5387 &quot;payload&quot;: True or False, # A Boolean value to indicate whether payload is wanted. Optional.
5388 &quot;resourceId&quot;: &quot;A String&quot;, # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.
5389 &quot;resourceUri&quot;: &quot;A String&quot;, # A version-specific identifier for the watched resource.
5390 &quot;token&quot;: &quot;A String&quot;, # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700[diff] [blame]5391 &quot;type&quot;: &quot;A String&quot;, # The type of delivery mechanism used for this channel. Valid values are &quot;web_hook&quot; (or &quot;webhook&quot;). Both values refer to a channel where Http requests are used to deliver messages.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]5392}</pre>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]5393</div>
5394
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]5395<div class="method">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]5396 <code class="details" id="watch_media">watch_media(fileId, acknowledgeAbuse=None, body=None, includePermissionsForView=None, projection=None, revisionId=None, supportsAllDrives=None, supportsTeamDrives=None, updateViewedDate=None)</code>
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]5397 <pre>Subscribe to changes on a file
5398
5399Args:
5400 fileId: string, The ID for the file in question. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]5401 body: object, The request body.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]5402 The object takes the form of:
5403
5404{ # An notification channel used to watch for resource changes.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]5405 &quot;address&quot;: &quot;A String&quot;, # The address where notifications are delivered for this channel.
5406 &quot;expiration&quot;: &quot;A String&quot;, # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.
5407 &quot;id&quot;: &quot;A String&quot;, # A UUID or similar unique string that identifies this channel.
5408 &quot;kind&quot;: &quot;api#channel&quot;, # Identifies this as a notification channel used to watch for changes to a resource, which is &quot;api#channel&quot;.
5409 &quot;params&quot;: { # Additional parameters controlling delivery channel behavior. Optional.
5410 &quot;a_key&quot;: &quot;A String&quot;, # Declares a new parameter by name.
5411 },
5412 &quot;payload&quot;: True or False, # A Boolean value to indicate whether payload is wanted. Optional.
5413 &quot;resourceId&quot;: &quot;A String&quot;, # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.
5414 &quot;resourceUri&quot;: &quot;A String&quot;, # A version-specific identifier for the watched resource.
5415 &quot;token&quot;: &quot;A String&quot;, # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700[diff] [blame]5416 &quot;type&quot;: &quot;A String&quot;, # The type of delivery mechanism used for this channel. Valid values are &quot;web_hook&quot; (or &quot;webhook&quot;). Both values refer to a channel where Http requests are used to deliver messages.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]5417}
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]5418
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]5419 acknowledgeAbuse: boolean, Whether the user is acknowledging the risk of downloading known malware or other abusive files.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]5420 includePermissionsForView: string, Specifies which additional view&#x27;s permissions to include in the response. Only &#x27;published&#x27; is supported.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]5421 projection: string, This parameter is deprecated and has no function.
5422 Allowed values
5423 BASIC - Deprecated
5424 FULL - Deprecated
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]5425 revisionId: string, Specifies the Revision ID that should be downloaded. Ignored unless alt=media is specified.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]5426 supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]5427 supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]5428 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]5429
5430Returns:
5431 The media object as a string.
5432
5433 </pre>
5434</div>
5435
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]5436</body></html>