Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / d01e4f8f529704bac8b593b0484397ef9ae8dd20 / . / docs / dyn / drive_v2.files.html
blob: 9300de13bdc0285cf0ebf3e43423a2c5e841a891 [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>
yoshi-code-bot12d387c2021-10-26 00:24:32 -0700[diff] [blame]91<p class="firstline">Exports a Google Workspace document to the requested MIME type and returns exported byte content. 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>
yoshi-code-bot12d387c2021-10-26 00:24:32 -0700[diff] [blame]94<p class="firstline">Exports a Google Workspace document to the requested MIME type and returns exported byte content. 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>
yoshi-code-bot278a4902021-12-14 03:32:50 -0800[diff] [blame]115<p class="firstline">Updates a file's metadata and/or content. When calling this method, only populate fields in the request that you want to modify. When updating fields, some fields might change automatically, such as modifiedDate. This method supports patch semantics.</p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]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>
yoshi-code-botad81f3d2021-09-28 00:22:30 -0700[diff] [blame]127<p class="firstline">Updates a file's metadata and/or content. When calling this method, only populate fields in the request that you want to modify. When updating fields, some fields might be changed automatically, such as modifiedDate. This method supports patch semantics.</p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]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.
yoshi-code-bot815c1ac2021-11-15 23:24:17 -0800[diff] [blame]155 &quot;canAcceptOwnership&quot;: True or False, # Whether the current user is the pending owner of the file. Not populated for shared drive files.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]156 &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]157 &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]158 &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.
159 &quot;canChangeCopyRequiresWriterPermission&quot;: True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this file.
160 &quot;canChangeRestrictedDownload&quot;: True or False, # Deprecated
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700[diff] [blame]161 &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]162 &quot;canComment&quot;: True or False, # Whether the current user can comment on this file.
163 &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.
164 &quot;canDelete&quot;: True or False, # Whether the current user can delete this file.
165 &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.
166 &quot;canDownload&quot;: True or False, # Whether the current user can download this file.
167 &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.
168 &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.
169 &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]170 &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]171 &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.
172 &quot;canMoveChildrenOutOfTeamDrive&quot;: True or False, # Deprecated - use canMoveChildrenOutOfDrive instead.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]173 &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]174 &quot;canMoveChildrenWithinTeamDrive&quot;: True or False, # Deprecated - use canMoveChildrenWithinDrive instead.
175 &quot;canMoveItemIntoTeamDrive&quot;: True or False, # Deprecated - use canMoveItemOutOfDrive instead.
176 &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.
177 &quot;canMoveItemOutOfTeamDrive&quot;: True or False, # Deprecated - use canMoveItemOutOfDrive instead.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]178 &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]179 &quot;canMoveItemWithinTeamDrive&quot;: True or False, # Deprecated - use canMoveItemWithinDrive instead.
180 &quot;canMoveTeamDriveItem&quot;: True or False, # Deprecated - use canMoveItemWithinDrive or canMoveItemOutOfDrive instead.
181 &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.
182 &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.
183 &quot;canReadTeamDrive&quot;: True or False, # Deprecated - use canReadDrive instead.
184 &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.
185 &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.
186 &quot;canRename&quot;: True or False, # Whether the current user can rename this file.
187 &quot;canShare&quot;: True or False, # Whether the current user can modify the sharing settings for this file.
188 &quot;canTrash&quot;: True or False, # Whether the current user can move this file to trash.
189 &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.
190 &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]191 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]192 &quot;contentRestrictions&quot;: [ # Restrictions for accessing the content of the file. Only populated if such a restriction exists.
193 { # A restriction for accessing the content of the file.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]194 &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]195 &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.
196 &quot;restrictingUser&quot;: { # Information about a Drive user. # The user who set the content restriction. Only populated if readOnly is true.
197 &quot;displayName&quot;: &quot;A String&quot;, # A plain text displayable name for this user.
198 &quot;emailAddress&quot;: &quot;A String&quot;, # The email address of the user.
199 &quot;isAuthenticatedUser&quot;: True or False, # Whether this user is the same as the authenticated user for whom the request was made.
200 &quot;kind&quot;: &quot;drive#user&quot;, # This is always drive#user.
201 &quot;permissionId&quot;: &quot;A String&quot;, # The user&#x27;s ID as visible in the permissions collection.
202 &quot;picture&quot;: { # The user&#x27;s profile picture.
203 &quot;url&quot;: &quot;A String&quot;, # A URL that points to a profile picture of this user.
204 },
205 },
206 &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.
207 &quot;type&quot;: &quot;A String&quot;, # The type of the content restriction. Currently the only possible value is globalContentRestriction.
208 },
209 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]210 &quot;copyRequiresWriterPermission&quot;: True or False, # Whether the options to copy, print, or download this file, should be disabled for readers and commenters.
211 &quot;copyable&quot;: True or False, # Deprecated: use capabilities/canCopy.
212 &quot;createdDate&quot;: &quot;A String&quot;, # Create time for this file (formatted RFC 3339 timestamp).
213 &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.
214 &quot;description&quot;: &quot;A String&quot;, # A short description of the file.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]215 &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]216 &quot;driveId&quot;: &quot;A String&quot;, # ID of the shared drive the file resides in. Only populated for items in shared drives.
217 &quot;editable&quot;: True or False, # Deprecated: use capabilities/canEdit.
218 &quot;embedLink&quot;: &quot;A String&quot;, # A link for embedding the file.
219 &quot;etag&quot;: &quot;A String&quot;, # ETag of the file.
220 &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]221 &quot;exportLinks&quot;: { # Links for exporting Docs Editors files to specific formats.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]222 &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]223 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]224 &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.
225 &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.
yoshi-code-botb539cc42021-08-03 00:20:27 -0700[diff] [blame]226 &quot;folderColorRgb&quot;: &quot;A String&quot;, # Folder color as an RGB hex string if the file is a folder or a shortcut to 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.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]227 &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]228 &quot;hasAugmentedPermissions&quot;: True or False, # Whether there are permissions directly on this file. This field is only populated for items in shared drives.
229 &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]230 &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]231 &quot;iconLink&quot;: &quot;A String&quot;, # A link to the file&#x27;s icon.
232 &quot;id&quot;: &quot;A String&quot;, # The ID of the file.
233 &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.
234 &quot;aperture&quot;: 3.14, # The aperture used to create the photo (f-number).
235 &quot;cameraMake&quot;: &quot;A String&quot;, # The make of the camera used to create the photo.
236 &quot;cameraModel&quot;: &quot;A String&quot;, # The model of the camera used to create the photo.
237 &quot;colorSpace&quot;: &quot;A String&quot;, # The color space of the photo.
238 &quot;date&quot;: &quot;A String&quot;, # The date and time the photo was taken (EXIF format timestamp).
239 &quot;exposureBias&quot;: 3.14, # The exposure bias of the photo (APEX value).
240 &quot;exposureMode&quot;: &quot;A String&quot;, # The exposure mode used to create the photo.
241 &quot;exposureTime&quot;: 3.14, # The length of the exposure, in seconds.
242 &quot;flashUsed&quot;: True or False, # Whether a flash was used to create the photo.
243 &quot;focalLength&quot;: 3.14, # The focal length used to create the photo, in millimeters.
244 &quot;height&quot;: 42, # The height of the image in pixels.
245 &quot;isoSpeed&quot;: 42, # The ISO speed used to create the photo.
246 &quot;lens&quot;: &quot;A String&quot;, # The lens used to create the photo.
247 &quot;location&quot;: { # Geographic location information stored in the image.
248 &quot;altitude&quot;: 3.14, # The altitude stored in the image.
249 &quot;latitude&quot;: 3.14, # The latitude stored in the image.
250 &quot;longitude&quot;: 3.14, # The longitude stored in the image.
251 },
252 &quot;maxApertureValue&quot;: 3.14, # The smallest f-number of the lens at the focal length used to create the photo (APEX value).
253 &quot;meteringMode&quot;: &quot;A String&quot;, # The metering mode used to create the photo.
254 &quot;rotation&quot;: 42, # The number of clockwise 90 degree rotations applied from the image&#x27;s original orientation.
255 &quot;sensor&quot;: &quot;A String&quot;, # The type of sensor used to create the photo.
256 &quot;subjectDistance&quot;: 42, # The distance to the subject of the photo, in meters.
257 &quot;whiteBalance&quot;: &quot;A String&quot;, # The white balance mode used to create the photo.
258 &quot;width&quot;: 42, # The width of the image in pixels.
259 },
260 &quot;indexableText&quot;: { # Indexable text attributes for the file (can only be written)
261 &quot;text&quot;: &quot;A String&quot;, # The text to be indexed for this file.
262 },
263 &quot;isAppAuthorized&quot;: True or False, # Whether the file was created or opened by the requesting app.
264 &quot;kind&quot;: &quot;drive#file&quot;, # The type of file. This is always drive#file.
265 &quot;labels&quot;: { # A group of labels for the file.
266 &quot;hidden&quot;: True or False, # Deprecated.
267 &quot;modified&quot;: True or False, # Whether the file has been modified by this user.
268 &quot;restricted&quot;: True or False, # Deprecated - use copyRequiresWriterPermission instead.
269 &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]270 &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]271 &quot;viewed&quot;: True or False, # Whether this file has been viewed by this user.
272 },
273 &quot;lastModifyingUser&quot;: { # Information about a Drive user. # The last user to modify this file.
274 &quot;displayName&quot;: &quot;A String&quot;, # A plain text displayable name for this user.
275 &quot;emailAddress&quot;: &quot;A String&quot;, # The email address of the user.
276 &quot;isAuthenticatedUser&quot;: True or False, # Whether this user is the same as the authenticated user for whom the request was made.
277 &quot;kind&quot;: &quot;drive#user&quot;, # This is always drive#user.
278 &quot;permissionId&quot;: &quot;A String&quot;, # The user&#x27;s ID as visible in the permissions collection.
279 &quot;picture&quot;: { # The user&#x27;s profile picture.
280 &quot;url&quot;: &quot;A String&quot;, # A URL that points to a profile picture of this user.
281 },
282 },
283 &quot;lastModifyingUserName&quot;: &quot;A String&quot;, # Name of the last user to modify this file.
284 &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]285 &quot;linkShareMetadata&quot;: { # Contains details about the link URLs that clients are using to refer to this item.
286 &quot;securityUpdateEligible&quot;: True or False, # Whether the file is eligible for security update.
287 &quot;securityUpdateEnabled&quot;: True or False, # Whether the security update is enabled for this file.
288 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]289 &quot;markedViewedByMeDate&quot;: &quot;A String&quot;, # Deprecated.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]290 &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]291 &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.
292 &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.
293 &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.
294 &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.
295 &quot;a_key&quot;: &quot;A String&quot;,
296 },
297 &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.
298 &quot;ownedByMe&quot;: True or False, # Whether the file is owned by the current user. Not populated for items in shared drives.
299 &quot;ownerNames&quot;: [ # Name(s) of the owner(s) of this file. Not populated for items in shared drives.
300 &quot;A String&quot;,
301 ],
yoshi-code-botab1d6dc2021-05-28 00:42:02 -0700[diff] [blame]302 &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]303 { # Information about a Drive user.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]304 &quot;displayName&quot;: &quot;A String&quot;, # A plain text displayable name for this user.
305 &quot;emailAddress&quot;: &quot;A String&quot;, # The email address of the user.
306 &quot;isAuthenticatedUser&quot;: True or False, # Whether this user is the same as the authenticated user for whom the request was made.
307 &quot;kind&quot;: &quot;drive#user&quot;, # This is always drive#user.
308 &quot;permissionId&quot;: &quot;A String&quot;, # The user&#x27;s ID as visible in the permissions collection.
309 &quot;picture&quot;: { # The user&#x27;s profile picture.
310 &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]311 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]312 },
313 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]314 &quot;parents&quot;: [ # Collection of parent folders which contain this file.
315 # 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.
316 { # A reference to a file&#x27;s parent.
317 &quot;id&quot;: &quot;A String&quot;, # The ID of the parent.
318 &quot;isRoot&quot;: True or False, # Whether or not the parent is the root folder.
319 &quot;kind&quot;: &quot;drive#parentReference&quot;, # This is always drive#parentReference.
320 &quot;parentLink&quot;: &quot;A String&quot;, # A link to the parent.
321 &quot;selfLink&quot;: &quot;A String&quot;, # A link back to this reference.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]322 },
323 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]324 &quot;permissionIds&quot;: [ # List of permission IDs for users with access to this file.
325 &quot;A String&quot;,
326 ],
327 &quot;permissions&quot;: [ # The list of permissions for users with access to this file. Not populated for items in shared drives.
328 { # A permission for a file.
329 &quot;additionalRoles&quot;: [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future.
330 &quot;A String&quot;,
331 ],
332 &quot;authKey&quot;: &quot;A String&quot;, # Deprecated.
333 &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.
334 &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.
335 &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.
336 &quot;etag&quot;: &quot;A String&quot;, # The ETag of the permission.
337 &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:
338 # - They cannot be set on shared drive items
339 # - They can only be set on user and group permissions
340 # - The date must be in the future
341 # - The date cannot be more than a year in the future
342 # - The date can only be set on drive.permissions.update or drive.permissions.patch requests
343 &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.
344 &quot;kind&quot;: &quot;drive#permission&quot;, # This is always drive#permission.
345 &quot;name&quot;: &quot;A String&quot;, # The name for this permission.
yoshi-code-bot815c1ac2021-11-15 23:24:17 -0800[diff] [blame]346 &quot;pendingOwner&quot;: True or False, # Whether the account associated with this permission is a pending owner. Only populated for user type permissions for files that are not in a shared drive.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]347 &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.
348 {
349 &quot;additionalRoles&quot;: [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future.
350 &quot;A String&quot;,
351 ],
352 &quot;inherited&quot;: True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field.
353 &quot;inheritedFrom&quot;: &quot;A String&quot;, # The ID of the item from which this permission is inherited. This is an output-only field.
354 &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:
355 # - file
356 # - member
357 &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:
358 # - organizer
359 # - fileOrganizer
360 # - writer
361 # - reader
362 },
363 ],
364 &quot;photoLink&quot;: &quot;A String&quot;, # A link to the profile photo, if available.
365 &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:
366 # - owner
367 # - organizer
368 # - fileOrganizer
369 # - writer
370 # - reader
371 &quot;selfLink&quot;: &quot;A String&quot;, # A link back to this permission.
372 &quot;teamDrivePermissionDetails&quot;: [ # Deprecated - use permissionDetails instead.
373 {
374 &quot;additionalRoles&quot;: [ # Deprecated - use permissionDetails/additionalRoles instead.
375 &quot;A String&quot;,
376 ],
377 &quot;inherited&quot;: True or False, # Deprecated - use permissionDetails/inherited instead.
378 &quot;inheritedFrom&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/inheritedFrom instead.
379 &quot;role&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/role instead.
380 &quot;teamDrivePermissionType&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/permissionType instead.
381 },
382 ],
383 &quot;type&quot;: &quot;A String&quot;, # The account type. Allowed values are:
384 # - user
385 # - group
386 # - domain
387 # - anyone
388 &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]389 &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]390 &quot;withLink&quot;: True or False, # Whether the link is required for this permission.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]391 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]392 ],
393 &quot;properties&quot;: [ # The list of properties.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]394 { # A key-value pair attached to a file that is either public or private to an application.
395 # The following limits apply to file properties:
396 # - Maximum of 100 properties total per file
397 # - Maximum of 30 private properties per app
398 # - Maximum of 30 public properties
399 # - 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]400 &quot;etag&quot;: &quot;A String&quot;, # ETag of the property.
401 &quot;key&quot;: &quot;A String&quot;, # The key of this property.
402 &quot;kind&quot;: &quot;drive#property&quot;, # This is always drive#property.
403 &quot;selfLink&quot;: &quot;A String&quot;, # The link back to this property.
404 &quot;value&quot;: &quot;A String&quot;, # The value of this property.
yoshi-code-bot69706592021-03-03 03:54:02 -0800[diff] [blame]405 &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]406 },
407 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]408 &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]409 &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]410 &quot;selfLink&quot;: &quot;A String&quot;, # A link back to this file.
411 &quot;shareable&quot;: True or False, # Deprecated: use capabilities/canShare.
412 &quot;shared&quot;: True or False, # Whether the file has been shared. Not populated for items in shared drives.
413 &quot;sharedWithMeDate&quot;: &quot;A String&quot;, # Time at which this file was shared with the user (formatted RFC 3339 timestamp).
414 &quot;sharingUser&quot;: { # Information about a Drive user. # User that shared the item with the current user, if available.
415 &quot;displayName&quot;: &quot;A String&quot;, # A plain text displayable name for this user.
416 &quot;emailAddress&quot;: &quot;A String&quot;, # The email address of the user.
417 &quot;isAuthenticatedUser&quot;: True or False, # Whether this user is the same as the authenticated user for whom the request was made.
418 &quot;kind&quot;: &quot;drive#user&quot;, # This is always drive#user.
419 &quot;permissionId&quot;: &quot;A String&quot;, # The user&#x27;s ID as visible in the permissions collection.
420 &quot;picture&quot;: { # The user&#x27;s profile picture.
421 &quot;url&quot;: &quot;A String&quot;, # A URL that points to a profile picture of this user.
422 },
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]423 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]424 &quot;shortcutDetails&quot;: { # Shortcut file details. Only populated for shortcut files, which have the mimeType field set to application/vnd.google-apps.shortcut.
425 &quot;targetId&quot;: &quot;A String&quot;, # The ID of the file that this shortcut points to.
426 &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]427 &quot;targetResourceKey&quot;: &quot;A String&quot;, # The ResourceKey for the target file.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]428 },
429 &quot;spaces&quot;: [ # The list of spaces which contain the file. Supported values are &#x27;drive&#x27;, &#x27;appDataFolder&#x27; and &#x27;photos&#x27;.
430 &quot;A String&quot;,
431 ],
432 &quot;teamDriveId&quot;: &quot;A String&quot;, # Deprecated - use driveId instead.
433 &quot;thumbnail&quot;: { # A thumbnail for the file. This will only be used if a standard thumbnail cannot be generated.
434 &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.
435 &quot;mimeType&quot;: &quot;A String&quot;, # The MIME type of the thumbnail.
436 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]437 &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]438 &quot;thumbnailVersion&quot;: &quot;A String&quot;, # The thumbnail version for use in thumbnail cache invalidation.
439 &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.
440 &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.
441 &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.
442 &quot;displayName&quot;: &quot;A String&quot;, # A plain text displayable name for this user.
443 &quot;emailAddress&quot;: &quot;A String&quot;, # The email address of the user.
444 &quot;isAuthenticatedUser&quot;: True or False, # Whether this user is the same as the authenticated user for whom the request was made.
445 &quot;kind&quot;: &quot;drive#user&quot;, # This is always drive#user.
446 &quot;permissionId&quot;: &quot;A String&quot;, # The user&#x27;s ID as visible in the permissions collection.
447 &quot;picture&quot;: { # The user&#x27;s profile picture.
448 &quot;url&quot;: &quot;A String&quot;, # A URL that points to a profile picture of this user.
449 },
450 },
451 &quot;userPermission&quot;: { # A permission for a file. # The permissions for the authenticated user on this file.
452 &quot;additionalRoles&quot;: [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future.
453 &quot;A String&quot;,
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]454 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]455 &quot;authKey&quot;: &quot;A String&quot;, # Deprecated.
456 &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.
457 &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.
458 &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.
459 &quot;etag&quot;: &quot;A String&quot;, # The ETag of the permission.
460 &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]461 # - They cannot be set on shared drive items
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]462 # - They can only be set on user and group permissions
463 # - The date must be in the future
464 # - The date cannot be more than a year in the future
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]465 # - 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]466 &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.
467 &quot;kind&quot;: &quot;drive#permission&quot;, # This is always drive#permission.
468 &quot;name&quot;: &quot;A String&quot;, # The name for this permission.
yoshi-code-bot815c1ac2021-11-15 23:24:17 -0800[diff] [blame]469 &quot;pendingOwner&quot;: True or False, # Whether the account associated with this permission is a pending owner. Only populated for user type permissions for files that are not in a shared drive.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]470 &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.
471 {
472 &quot;additionalRoles&quot;: [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future.
473 &quot;A String&quot;,
474 ],
475 &quot;inherited&quot;: True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field.
476 &quot;inheritedFrom&quot;: &quot;A String&quot;, # The ID of the item from which this permission is inherited. This is an output-only field.
477 &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:
478 # - file
479 # - member
480 &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:
481 # - organizer
482 # - fileOrganizer
483 # - writer
484 # - reader
485 },
486 ],
487 &quot;photoLink&quot;: &quot;A String&quot;, # A link to the profile photo, if available.
488 &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]489 # - owner
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]490 # - organizer
491 # - fileOrganizer
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]492 # - writer
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]493 # - reader
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]494 &quot;selfLink&quot;: &quot;A String&quot;, # A link back to this permission.
495 &quot;teamDrivePermissionDetails&quot;: [ # Deprecated - use permissionDetails instead.
496 {
497 &quot;additionalRoles&quot;: [ # Deprecated - use permissionDetails/additionalRoles instead.
498 &quot;A String&quot;,
499 ],
500 &quot;inherited&quot;: True or False, # Deprecated - use permissionDetails/inherited instead.
501 &quot;inheritedFrom&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/inheritedFrom instead.
502 &quot;role&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/role instead.
503 &quot;teamDrivePermissionType&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/permissionType instead.
504 },
505 ],
506 &quot;type&quot;: &quot;A String&quot;, # The account type. Allowed values are:
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]507 # - user
508 # - group
509 # - domain
510 # - anyone
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]511 &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]512 &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]513 &quot;withLink&quot;: True or False, # Whether the link is required for this permission.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]514 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]515 &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.
516 &quot;videoMediaMetadata&quot;: { # Metadata about video media. This will only be present for video types.
517 &quot;durationMillis&quot;: &quot;A String&quot;, # The duration of the video in milliseconds.
518 &quot;height&quot;: 42, # The height of the video in pixels.
519 &quot;width&quot;: 42, # The width of the video in pixels.
520 },
521 &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.
522 &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.
523 &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]524}
525
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]526 convert: boolean, Whether to convert this file to the corresponding Docs Editors format.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]527 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]528 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]529 ocr: boolean, Whether to attempt OCR on .jpg, .png, .gif, or .pdf uploads.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]530 ocrLanguage: string, If ocr is true, hints at the language to use. Valid values are BCP 47 codes.
531 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]532 supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]533 supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead.
534 timedTextLanguage: string, The language of the timed text.
535 timedTextTrackName: string, The timed text track name.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]536 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.
537 Allowed values
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]538 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]539 PRIVATE - The new file will be visible to only the owner.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]540
541Returns:
542 An object of the form:
543
544 { # The metadata for a file.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]545 &quot;alternateLink&quot;: &quot;A String&quot;, # A link for opening the file in a relevant Google editor or viewer.
546 &quot;appDataContents&quot;: True or False, # Whether this file is in the Application Data folder.
547 &quot;canComment&quot;: True or False, # Deprecated: use capabilities/canComment.
548 &quot;canReadRevisions&quot;: True or False, # Deprecated: use capabilities/canReadRevisions.
549 &quot;capabilities&quot;: { # Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take.
yoshi-code-bot815c1ac2021-11-15 23:24:17 -0800[diff] [blame]550 &quot;canAcceptOwnership&quot;: True or False, # Whether the current user is the pending owner of the file. Not populated for shared drive files.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]551 &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.
552 &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.
553 &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.
554 &quot;canChangeCopyRequiresWriterPermission&quot;: True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this file.
555 &quot;canChangeRestrictedDownload&quot;: True or False, # Deprecated
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700[diff] [blame]556 &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]557 &quot;canComment&quot;: True or False, # Whether the current user can comment on this file.
558 &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.
559 &quot;canDelete&quot;: True or False, # Whether the current user can delete this file.
560 &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.
561 &quot;canDownload&quot;: True or False, # Whether the current user can download this file.
562 &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.
563 &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.
564 &quot;canModifyContent&quot;: True or False, # Whether the current user can modify the content of this file.
565 &quot;canModifyContentRestriction&quot;: True or False, # Whether the current user can modify restrictions on content of this file.
566 &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.
567 &quot;canMoveChildrenOutOfTeamDrive&quot;: True or False, # Deprecated - use canMoveChildrenOutOfDrive instead.
568 &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.
569 &quot;canMoveChildrenWithinTeamDrive&quot;: True or False, # Deprecated - use canMoveChildrenWithinDrive instead.
570 &quot;canMoveItemIntoTeamDrive&quot;: True or False, # Deprecated - use canMoveItemOutOfDrive instead.
571 &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.
572 &quot;canMoveItemOutOfTeamDrive&quot;: True or False, # Deprecated - use canMoveItemOutOfDrive instead.
573 &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.
574 &quot;canMoveItemWithinTeamDrive&quot;: True or False, # Deprecated - use canMoveItemWithinDrive instead.
575 &quot;canMoveTeamDriveItem&quot;: True or False, # Deprecated - use canMoveItemWithinDrive or canMoveItemOutOfDrive instead.
576 &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.
577 &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.
578 &quot;canReadTeamDrive&quot;: True or False, # Deprecated - use canReadDrive instead.
579 &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.
580 &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.
581 &quot;canRename&quot;: True or False, # Whether the current user can rename this file.
582 &quot;canShare&quot;: True or False, # Whether the current user can modify the sharing settings for this file.
583 &quot;canTrash&quot;: True or False, # Whether the current user can move this file to trash.
584 &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.
585 &quot;canUntrash&quot;: True or False, # Whether the current user can restore this file from trash.
586 },
587 &quot;contentRestrictions&quot;: [ # Restrictions for accessing the content of the file. Only populated if such a restriction exists.
588 { # A restriction for accessing the content of the file.
589 &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.
590 &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.
591 &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]592 &quot;displayName&quot;: &quot;A String&quot;, # A plain text displayable name for this user.
593 &quot;emailAddress&quot;: &quot;A String&quot;, # The email address of the user.
594 &quot;isAuthenticatedUser&quot;: True or False, # Whether this user is the same as the authenticated user for whom the request was made.
595 &quot;kind&quot;: &quot;drive#user&quot;, # This is always drive#user.
596 &quot;permissionId&quot;: &quot;A String&quot;, # The user&#x27;s ID as visible in the permissions collection.
597 &quot;picture&quot;: { # The user&#x27;s profile picture.
598 &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]599 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]600 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]601 &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.
602 &quot;type&quot;: &quot;A String&quot;, # The type of the content restriction. Currently the only possible value is globalContentRestriction.
603 },
604 ],
605 &quot;copyRequiresWriterPermission&quot;: True or False, # Whether the options to copy, print, or download this file, should be disabled for readers and commenters.
606 &quot;copyable&quot;: True or False, # Deprecated: use capabilities/canCopy.
607 &quot;createdDate&quot;: &quot;A String&quot;, # Create time for this file (formatted RFC 3339 timestamp).
608 &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.
609 &quot;description&quot;: &quot;A String&quot;, # A short description of the file.
610 &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.
611 &quot;driveId&quot;: &quot;A String&quot;, # ID of the shared drive the file resides in. Only populated for items in shared drives.
612 &quot;editable&quot;: True or False, # Deprecated: use capabilities/canEdit.
613 &quot;embedLink&quot;: &quot;A String&quot;, # A link for embedding the file.
614 &quot;etag&quot;: &quot;A String&quot;, # ETag of the file.
615 &quot;explicitlyTrashed&quot;: True or False, # Whether this file has been explicitly trashed, as opposed to recursively trashed.
616 &quot;exportLinks&quot;: { # Links for exporting Docs Editors files to specific formats.
617 &quot;a_key&quot;: &quot;A String&quot;, # A mapping from export format to URL
618 },
619 &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.
620 &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.
yoshi-code-botb539cc42021-08-03 00:20:27 -0700[diff] [blame]621 &quot;folderColorRgb&quot;: &quot;A String&quot;, # Folder color as an RGB hex string if the file is a folder or a shortcut to 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.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]622 &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.
623 &quot;hasAugmentedPermissions&quot;: True or False, # Whether there are permissions directly on this file. This field is only populated for items in shared drives.
624 &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.
625 &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.
626 &quot;iconLink&quot;: &quot;A String&quot;, # A link to the file&#x27;s icon.
627 &quot;id&quot;: &quot;A String&quot;, # The ID of the file.
628 &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.
629 &quot;aperture&quot;: 3.14, # The aperture used to create the photo (f-number).
630 &quot;cameraMake&quot;: &quot;A String&quot;, # The make of the camera used to create the photo.
631 &quot;cameraModel&quot;: &quot;A String&quot;, # The model of the camera used to create the photo.
632 &quot;colorSpace&quot;: &quot;A String&quot;, # The color space of the photo.
633 &quot;date&quot;: &quot;A String&quot;, # The date and time the photo was taken (EXIF format timestamp).
634 &quot;exposureBias&quot;: 3.14, # The exposure bias of the photo (APEX value).
635 &quot;exposureMode&quot;: &quot;A String&quot;, # The exposure mode used to create the photo.
636 &quot;exposureTime&quot;: 3.14, # The length of the exposure, in seconds.
637 &quot;flashUsed&quot;: True or False, # Whether a flash was used to create the photo.
638 &quot;focalLength&quot;: 3.14, # The focal length used to create the photo, in millimeters.
639 &quot;height&quot;: 42, # The height of the image in pixels.
640 &quot;isoSpeed&quot;: 42, # The ISO speed used to create the photo.
641 &quot;lens&quot;: &quot;A String&quot;, # The lens used to create the photo.
642 &quot;location&quot;: { # Geographic location information stored in the image.
643 &quot;altitude&quot;: 3.14, # The altitude stored in the image.
644 &quot;latitude&quot;: 3.14, # The latitude stored in the image.
645 &quot;longitude&quot;: 3.14, # The longitude stored in the image.
646 },
647 &quot;maxApertureValue&quot;: 3.14, # The smallest f-number of the lens at the focal length used to create the photo (APEX value).
648 &quot;meteringMode&quot;: &quot;A String&quot;, # The metering mode used to create the photo.
649 &quot;rotation&quot;: 42, # The number of clockwise 90 degree rotations applied from the image&#x27;s original orientation.
650 &quot;sensor&quot;: &quot;A String&quot;, # The type of sensor used to create the photo.
651 &quot;subjectDistance&quot;: 42, # The distance to the subject of the photo, in meters.
652 &quot;whiteBalance&quot;: &quot;A String&quot;, # The white balance mode used to create the photo.
653 &quot;width&quot;: 42, # The width of the image in pixels.
654 },
655 &quot;indexableText&quot;: { # Indexable text attributes for the file (can only be written)
656 &quot;text&quot;: &quot;A String&quot;, # The text to be indexed for this file.
657 },
658 &quot;isAppAuthorized&quot;: True or False, # Whether the file was created or opened by the requesting app.
659 &quot;kind&quot;: &quot;drive#file&quot;, # The type of file. This is always drive#file.
660 &quot;labels&quot;: { # A group of labels for the file.
661 &quot;hidden&quot;: True or False, # Deprecated.
662 &quot;modified&quot;: True or False, # Whether the file has been modified by this user.
663 &quot;restricted&quot;: True or False, # Deprecated - use copyRequiresWriterPermission instead.
664 &quot;starred&quot;: True or False, # Whether this file is starred by the user.
665 &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.
666 &quot;viewed&quot;: True or False, # Whether this file has been viewed by this user.
667 },
668 &quot;lastModifyingUser&quot;: { # Information about a Drive user. # The last user to modify this file.
669 &quot;displayName&quot;: &quot;A String&quot;, # A plain text displayable name for this user.
670 &quot;emailAddress&quot;: &quot;A String&quot;, # The email address of the user.
671 &quot;isAuthenticatedUser&quot;: True or False, # Whether this user is the same as the authenticated user for whom the request was made.
672 &quot;kind&quot;: &quot;drive#user&quot;, # This is always drive#user.
673 &quot;permissionId&quot;: &quot;A String&quot;, # The user&#x27;s ID as visible in the permissions collection.
674 &quot;picture&quot;: { # The user&#x27;s profile picture.
675 &quot;url&quot;: &quot;A String&quot;, # A URL that points to a profile picture of this user.
676 },
677 },
678 &quot;lastModifyingUserName&quot;: &quot;A String&quot;, # Name of the last user to modify this file.
679 &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]680 &quot;linkShareMetadata&quot;: { # Contains details about the link URLs that clients are using to refer to this item.
681 &quot;securityUpdateEligible&quot;: True or False, # Whether the file is eligible for security update.
682 &quot;securityUpdateEnabled&quot;: True or False, # Whether the security update is enabled for this file.
683 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]684 &quot;markedViewedByMeDate&quot;: &quot;A String&quot;, # Deprecated.
685 &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.
686 &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.
687 &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.
688 &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.
689 &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.
690 &quot;a_key&quot;: &quot;A String&quot;,
691 },
692 &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.
693 &quot;ownedByMe&quot;: True or False, # Whether the file is owned by the current user. Not populated for items in shared drives.
694 &quot;ownerNames&quot;: [ # Name(s) of the owner(s) of this file. Not populated for items in shared drives.
695 &quot;A String&quot;,
696 ],
yoshi-code-botab1d6dc2021-05-28 00:42:02 -0700[diff] [blame]697 &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]698 { # Information about a Drive user.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]699 &quot;displayName&quot;: &quot;A String&quot;, # A plain text displayable name for this user.
700 &quot;emailAddress&quot;: &quot;A String&quot;, # The email address of the user.
701 &quot;isAuthenticatedUser&quot;: True or False, # Whether this user is the same as the authenticated user for whom the request was made.
702 &quot;kind&quot;: &quot;drive#user&quot;, # This is always drive#user.
703 &quot;permissionId&quot;: &quot;A String&quot;, # The user&#x27;s ID as visible in the permissions collection.
704 &quot;picture&quot;: { # The user&#x27;s profile picture.
705 &quot;url&quot;: &quot;A String&quot;, # A URL that points to a profile picture of this user.
706 },
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]707 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]708 ],
709 &quot;parents&quot;: [ # Collection of parent folders which contain this file.
710 # 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.
711 { # A reference to a file&#x27;s parent.
712 &quot;id&quot;: &quot;A String&quot;, # The ID of the parent.
713 &quot;isRoot&quot;: True or False, # Whether or not the parent is the root folder.
714 &quot;kind&quot;: &quot;drive#parentReference&quot;, # This is always drive#parentReference.
715 &quot;parentLink&quot;: &quot;A String&quot;, # A link to the parent.
716 &quot;selfLink&quot;: &quot;A String&quot;, # A link back to this reference.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]717 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]718 ],
719 &quot;permissionIds&quot;: [ # List of permission IDs for users with access to this file.
720 &quot;A String&quot;,
721 ],
722 &quot;permissions&quot;: [ # The list of permissions for users with access to this file. Not populated for items in shared drives.
723 { # A permission for a file.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]724 &quot;additionalRoles&quot;: [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future.
725 &quot;A String&quot;,
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]726 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]727 &quot;authKey&quot;: &quot;A String&quot;, # Deprecated.
728 &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.
729 &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.
730 &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.
731 &quot;etag&quot;: &quot;A String&quot;, # The ETag of the permission.
732 &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]733 # - They cannot be set on shared drive items
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]734 # - They can only be set on user and group permissions
735 # - The date must be in the future
736 # - The date cannot be more than a year in the future
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]737 # - 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]738 &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.
739 &quot;kind&quot;: &quot;drive#permission&quot;, # This is always drive#permission.
740 &quot;name&quot;: &quot;A String&quot;, # The name for this permission.
yoshi-code-bot815c1ac2021-11-15 23:24:17 -0800[diff] [blame]741 &quot;pendingOwner&quot;: True or False, # Whether the account associated with this permission is a pending owner. Only populated for user type permissions for files that are not in a shared drive.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]742 &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.
743 {
744 &quot;additionalRoles&quot;: [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future.
745 &quot;A String&quot;,
746 ],
747 &quot;inherited&quot;: True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field.
748 &quot;inheritedFrom&quot;: &quot;A String&quot;, # The ID of the item from which this permission is inherited. This is an output-only field.
749 &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:
750 # - file
751 # - member
752 &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:
753 # - organizer
754 # - fileOrganizer
755 # - writer
756 # - reader
757 },
758 ],
759 &quot;photoLink&quot;: &quot;A String&quot;, # A link to the profile photo, if available.
760 &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]761 # - owner
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]762 # - organizer
763 # - fileOrganizer
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]764 # - writer
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]765 # - reader
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]766 &quot;selfLink&quot;: &quot;A String&quot;, # A link back to this permission.
767 &quot;teamDrivePermissionDetails&quot;: [ # Deprecated - use permissionDetails instead.
768 {
769 &quot;additionalRoles&quot;: [ # Deprecated - use permissionDetails/additionalRoles instead.
770 &quot;A String&quot;,
771 ],
772 &quot;inherited&quot;: True or False, # Deprecated - use permissionDetails/inherited instead.
773 &quot;inheritedFrom&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/inheritedFrom instead.
774 &quot;role&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/role instead.
775 &quot;teamDrivePermissionType&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/permissionType instead.
776 },
777 ],
778 &quot;type&quot;: &quot;A String&quot;, # The account type. Allowed values are:
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]779 # - user
780 # - group
781 # - domain
782 # - anyone
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]783 &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]784 &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]785 &quot;withLink&quot;: True or False, # Whether the link is required for this permission.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]786 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]787 ],
788 &quot;properties&quot;: [ # The list of properties.
789 { # A key-value pair attached to a file that is either public or private to an application.
790 # The following limits apply to file properties:
791 # - Maximum of 100 properties total per file
792 # - Maximum of 30 private properties per app
793 # - Maximum of 30 public properties
794 # - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property.
795 &quot;etag&quot;: &quot;A String&quot;, # ETag of the property.
796 &quot;key&quot;: &quot;A String&quot;, # The key of this property.
797 &quot;kind&quot;: &quot;drive#property&quot;, # This is always drive#property.
798 &quot;selfLink&quot;: &quot;A String&quot;, # The link back to this property.
799 &quot;value&quot;: &quot;A String&quot;, # The value of this property.
yoshi-code-bot69706592021-03-03 03:54:02 -0800[diff] [blame]800 &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]801 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]802 ],
803 &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]804 &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]805 &quot;selfLink&quot;: &quot;A String&quot;, # A link back to this file.
806 &quot;shareable&quot;: True or False, # Deprecated: use capabilities/canShare.
807 &quot;shared&quot;: True or False, # Whether the file has been shared. Not populated for items in shared drives.
808 &quot;sharedWithMeDate&quot;: &quot;A String&quot;, # Time at which this file was shared with the user (formatted RFC 3339 timestamp).
809 &quot;sharingUser&quot;: { # Information about a Drive user. # User that shared the item with the current user, if available.
810 &quot;displayName&quot;: &quot;A String&quot;, # A plain text displayable name for this user.
811 &quot;emailAddress&quot;: &quot;A String&quot;, # The email address of the user.
812 &quot;isAuthenticatedUser&quot;: True or False, # Whether this user is the same as the authenticated user for whom the request was made.
813 &quot;kind&quot;: &quot;drive#user&quot;, # This is always drive#user.
814 &quot;permissionId&quot;: &quot;A String&quot;, # The user&#x27;s ID as visible in the permissions collection.
815 &quot;picture&quot;: { # The user&#x27;s profile picture.
816 &quot;url&quot;: &quot;A String&quot;, # A URL that points to a profile picture of this user.
817 },
818 },
819 &quot;shortcutDetails&quot;: { # Shortcut file details. Only populated for shortcut files, which have the mimeType field set to application/vnd.google-apps.shortcut.
820 &quot;targetId&quot;: &quot;A String&quot;, # The ID of the file that this shortcut points to.
821 &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]822 &quot;targetResourceKey&quot;: &quot;A String&quot;, # The ResourceKey for the target file.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]823 },
824 &quot;spaces&quot;: [ # The list of spaces which contain the file. Supported values are &#x27;drive&#x27;, &#x27;appDataFolder&#x27; and &#x27;photos&#x27;.
825 &quot;A String&quot;,
826 ],
827 &quot;teamDriveId&quot;: &quot;A String&quot;, # Deprecated - use driveId instead.
828 &quot;thumbnail&quot;: { # A thumbnail for the file. This will only be used if a standard thumbnail cannot be generated.
829 &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.
830 &quot;mimeType&quot;: &quot;A String&quot;, # The MIME type of the thumbnail.
831 },
832 &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.
833 &quot;thumbnailVersion&quot;: &quot;A String&quot;, # The thumbnail version for use in thumbnail cache invalidation.
834 &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.
835 &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.
836 &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.
837 &quot;displayName&quot;: &quot;A String&quot;, # A plain text displayable name for this user.
838 &quot;emailAddress&quot;: &quot;A String&quot;, # The email address of the user.
839 &quot;isAuthenticatedUser&quot;: True or False, # Whether this user is the same as the authenticated user for whom the request was made.
840 &quot;kind&quot;: &quot;drive#user&quot;, # This is always drive#user.
841 &quot;permissionId&quot;: &quot;A String&quot;, # The user&#x27;s ID as visible in the permissions collection.
842 &quot;picture&quot;: { # The user&#x27;s profile picture.
843 &quot;url&quot;: &quot;A String&quot;, # A URL that points to a profile picture of this user.
844 },
845 },
846 &quot;userPermission&quot;: { # A permission for a file. # The permissions for the authenticated user on this file.
847 &quot;additionalRoles&quot;: [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future.
848 &quot;A String&quot;,
849 ],
850 &quot;authKey&quot;: &quot;A String&quot;, # Deprecated.
851 &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.
852 &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.
853 &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.
854 &quot;etag&quot;: &quot;A String&quot;, # The ETag of the permission.
855 &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:
856 # - They cannot be set on shared drive items
857 # - They can only be set on user and group permissions
858 # - The date must be in the future
859 # - The date cannot be more than a year in the future
860 # - The date can only be set on drive.permissions.update or drive.permissions.patch requests
861 &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.
862 &quot;kind&quot;: &quot;drive#permission&quot;, # This is always drive#permission.
863 &quot;name&quot;: &quot;A String&quot;, # The name for this permission.
yoshi-code-bot815c1ac2021-11-15 23:24:17 -0800[diff] [blame]864 &quot;pendingOwner&quot;: True or False, # Whether the account associated with this permission is a pending owner. Only populated for user type permissions for files that are not in a shared drive.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]865 &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.
866 {
867 &quot;additionalRoles&quot;: [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future.
868 &quot;A String&quot;,
869 ],
870 &quot;inherited&quot;: True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field.
871 &quot;inheritedFrom&quot;: &quot;A String&quot;, # The ID of the item from which this permission is inherited. This is an output-only field.
872 &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:
873 # - file
874 # - member
875 &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:
876 # - organizer
877 # - fileOrganizer
878 # - writer
879 # - reader
880 },
881 ],
882 &quot;photoLink&quot;: &quot;A String&quot;, # A link to the profile photo, if available.
883 &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:
884 # - owner
885 # - organizer
886 # - fileOrganizer
887 # - writer
888 # - reader
889 &quot;selfLink&quot;: &quot;A String&quot;, # A link back to this permission.
890 &quot;teamDrivePermissionDetails&quot;: [ # Deprecated - use permissionDetails instead.
891 {
892 &quot;additionalRoles&quot;: [ # Deprecated - use permissionDetails/additionalRoles instead.
893 &quot;A String&quot;,
894 ],
895 &quot;inherited&quot;: True or False, # Deprecated - use permissionDetails/inherited instead.
896 &quot;inheritedFrom&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/inheritedFrom instead.
897 &quot;role&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/role instead.
898 &quot;teamDrivePermissionType&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/permissionType instead.
899 },
900 ],
901 &quot;type&quot;: &quot;A String&quot;, # The account type. Allowed values are:
902 # - user
903 # - group
904 # - domain
905 # - anyone
906 &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.
907 &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.
908 &quot;withLink&quot;: True or False, # Whether the link is required for this permission.
909 },
910 &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.
911 &quot;videoMediaMetadata&quot;: { # Metadata about video media. This will only be present for video types.
912 &quot;durationMillis&quot;: &quot;A String&quot;, # The duration of the video in milliseconds.
913 &quot;height&quot;: 42, # The height of the video in pixels.
914 &quot;width&quot;: 42, # The width of the video in pixels.
915 },
916 &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.
917 &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.
918 &quot;writersCanShare&quot;: True or False, # Whether writers can share the document with other users. Not populated for items in shared drives.
919}</pre>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]920</div>
921
922<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]923 <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]924 <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]925
926Args:
927 fileId: string, The ID of the file to delete. (required)
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]928 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]929 supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]930 supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]931</pre>
932</div>
933
934<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]935 <code class="details" id="emptyTrash">emptyTrash(enforceSingleParent=None)</code>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]936 <pre>Permanently deletes all of the user&#x27;s trashed files.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]937
938Args:
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]939 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]940</pre>
941</div>
942
943<div class="method">
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]944 <code class="details" id="export">export(fileId, mimeType)</code>
yoshi-code-bot12d387c2021-10-26 00:24:32 -0700[diff] [blame]945 <pre>Exports a Google Workspace document to the requested MIME type and returns exported byte content. Note that the exported content is limited to 10MB.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]946
947Args:
948 fileId: string, The ID of the file. (required)
949 mimeType: string, The MIME type of the format requested for this export. (required)
950</pre>
951</div>
952
953<div class="method">
954 <code class="details" id="export_media">export_media(fileId, mimeType)</code>
yoshi-code-bot12d387c2021-10-26 00:24:32 -0700[diff] [blame]955 <pre>Exports a Google Workspace document to the requested MIME type and returns exported byte content. Note that the exported content is limited to 10MB.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]956
957Args:
958 fileId: string, The ID of the file. (required)
959 mimeType: string, The MIME type of the format requested for this export. (required)
960</pre>
961</div>
962
963<div class="method">
yoshi-code-botc2cd3262021-05-16 02:16:04 -0700[diff] [blame]964 <code class="details" id="generateIds">generateIds(maxResults=None, space=None, type=None)</code>
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]965 <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]966
967Args:
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]968 maxResults: integer, Maximum number of IDs to return.
yoshi-code-botc2cd3262021-05-16 02:16:04 -0700[diff] [blame]969 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;)
970 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]971
972Returns:
973 An object of the form:
974
975 { # A list of generated IDs which can be provided in insert requests
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]976 &quot;ids&quot;: [ # The IDs generated for the requesting user in the specified space.
977 &quot;A String&quot;,
978 ],
979 &quot;kind&quot;: &quot;drive#generatedIds&quot;, # This is always drive#generatedIds
980 &quot;space&quot;: &quot;A String&quot;, # The type of file that can be created with these IDs.
981}</pre>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]982</div>
983
984<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]985 <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]986 <pre>Gets a file&#x27;s metadata or content by ID.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]987
988Args:
989 fileId: string, The ID for the file in question. (required)
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]990 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]991 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]992 projection: string, This parameter is deprecated and has no function.
993 Allowed values
994 BASIC - Deprecated
995 FULL - Deprecated
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]996 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]997 supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]998 supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]999 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]1000
1001Returns:
1002 An object of the form:
1003
1004 { # The metadata for a file.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]1005 &quot;alternateLink&quot;: &quot;A String&quot;, # A link for opening the file in a relevant Google editor or viewer.
1006 &quot;appDataContents&quot;: True or False, # Whether this file is in the Application Data folder.
1007 &quot;canComment&quot;: True or False, # Deprecated: use capabilities/canComment.
1008 &quot;canReadRevisions&quot;: True or False, # Deprecated: use capabilities/canReadRevisions.
1009 &quot;capabilities&quot;: { # Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take.
yoshi-code-bot815c1ac2021-11-15 23:24:17 -0800[diff] [blame]1010 &quot;canAcceptOwnership&quot;: True or False, # Whether the current user is the pending owner of the file. Not populated for shared drive files.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]1011 &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.
1012 &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.
1013 &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.
1014 &quot;canChangeCopyRequiresWriterPermission&quot;: True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this file.
1015 &quot;canChangeRestrictedDownload&quot;: True or False, # Deprecated
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700[diff] [blame]1016 &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]1017 &quot;canComment&quot;: True or False, # Whether the current user can comment on this file.
1018 &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.
1019 &quot;canDelete&quot;: True or False, # Whether the current user can delete this file.
1020 &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.
1021 &quot;canDownload&quot;: True or False, # Whether the current user can download this file.
1022 &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.
1023 &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.
1024 &quot;canModifyContent&quot;: True or False, # Whether the current user can modify the content of this file.
1025 &quot;canModifyContentRestriction&quot;: True or False, # Whether the current user can modify restrictions on content of this file.
1026 &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.
1027 &quot;canMoveChildrenOutOfTeamDrive&quot;: True or False, # Deprecated - use canMoveChildrenOutOfDrive instead.
1028 &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.
1029 &quot;canMoveChildrenWithinTeamDrive&quot;: True or False, # Deprecated - use canMoveChildrenWithinDrive instead.
1030 &quot;canMoveItemIntoTeamDrive&quot;: True or False, # Deprecated - use canMoveItemOutOfDrive instead.
1031 &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.
1032 &quot;canMoveItemOutOfTeamDrive&quot;: True or False, # Deprecated - use canMoveItemOutOfDrive instead.
1033 &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.
1034 &quot;canMoveItemWithinTeamDrive&quot;: True or False, # Deprecated - use canMoveItemWithinDrive instead.
1035 &quot;canMoveTeamDriveItem&quot;: True or False, # Deprecated - use canMoveItemWithinDrive or canMoveItemOutOfDrive instead.
1036 &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.
1037 &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.
1038 &quot;canReadTeamDrive&quot;: True or False, # Deprecated - use canReadDrive instead.
1039 &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.
1040 &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.
1041 &quot;canRename&quot;: True or False, # Whether the current user can rename this file.
1042 &quot;canShare&quot;: True or False, # Whether the current user can modify the sharing settings for this file.
1043 &quot;canTrash&quot;: True or False, # Whether the current user can move this file to trash.
1044 &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.
1045 &quot;canUntrash&quot;: True or False, # Whether the current user can restore this file from trash.
1046 },
1047 &quot;contentRestrictions&quot;: [ # Restrictions for accessing the content of the file. Only populated if such a restriction exists.
1048 { # A restriction for accessing the content of the file.
1049 &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.
1050 &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.
1051 &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]1052 &quot;displayName&quot;: &quot;A String&quot;, # A plain text displayable name for this user.
1053 &quot;emailAddress&quot;: &quot;A String&quot;, # The email address of the user.
1054 &quot;isAuthenticatedUser&quot;: True or False, # Whether this user is the same as the authenticated user for whom the request was made.
1055 &quot;kind&quot;: &quot;drive#user&quot;, # This is always drive#user.
1056 &quot;permissionId&quot;: &quot;A String&quot;, # The user&#x27;s ID as visible in the permissions collection.
1057 &quot;picture&quot;: { # The user&#x27;s profile picture.
1058 &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]1059 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1060 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]1061 &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.
1062 &quot;type&quot;: &quot;A String&quot;, # The type of the content restriction. Currently the only possible value is globalContentRestriction.
1063 },
1064 ],
1065 &quot;copyRequiresWriterPermission&quot;: True or False, # Whether the options to copy, print, or download this file, should be disabled for readers and commenters.
1066 &quot;copyable&quot;: True or False, # Deprecated: use capabilities/canCopy.
1067 &quot;createdDate&quot;: &quot;A String&quot;, # Create time for this file (formatted RFC 3339 timestamp).
1068 &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.
1069 &quot;description&quot;: &quot;A String&quot;, # A short description of the file.
1070 &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.
1071 &quot;driveId&quot;: &quot;A String&quot;, # ID of the shared drive the file resides in. Only populated for items in shared drives.
1072 &quot;editable&quot;: True or False, # Deprecated: use capabilities/canEdit.
1073 &quot;embedLink&quot;: &quot;A String&quot;, # A link for embedding the file.
1074 &quot;etag&quot;: &quot;A String&quot;, # ETag of the file.
1075 &quot;explicitlyTrashed&quot;: True or False, # Whether this file has been explicitly trashed, as opposed to recursively trashed.
1076 &quot;exportLinks&quot;: { # Links for exporting Docs Editors files to specific formats.
1077 &quot;a_key&quot;: &quot;A String&quot;, # A mapping from export format to URL
1078 },
1079 &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.
1080 &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.
yoshi-code-botb539cc42021-08-03 00:20:27 -0700[diff] [blame]1081 &quot;folderColorRgb&quot;: &quot;A String&quot;, # Folder color as an RGB hex string if the file is a folder or a shortcut to 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.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]1082 &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.
1083 &quot;hasAugmentedPermissions&quot;: True or False, # Whether there are permissions directly on this file. This field is only populated for items in shared drives.
1084 &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.
1085 &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.
1086 &quot;iconLink&quot;: &quot;A String&quot;, # A link to the file&#x27;s icon.
1087 &quot;id&quot;: &quot;A String&quot;, # The ID of the file.
1088 &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.
1089 &quot;aperture&quot;: 3.14, # The aperture used to create the photo (f-number).
1090 &quot;cameraMake&quot;: &quot;A String&quot;, # The make of the camera used to create the photo.
1091 &quot;cameraModel&quot;: &quot;A String&quot;, # The model of the camera used to create the photo.
1092 &quot;colorSpace&quot;: &quot;A String&quot;, # The color space of the photo.
1093 &quot;date&quot;: &quot;A String&quot;, # The date and time the photo was taken (EXIF format timestamp).
1094 &quot;exposureBias&quot;: 3.14, # The exposure bias of the photo (APEX value).
1095 &quot;exposureMode&quot;: &quot;A String&quot;, # The exposure mode used to create the photo.
1096 &quot;exposureTime&quot;: 3.14, # The length of the exposure, in seconds.
1097 &quot;flashUsed&quot;: True or False, # Whether a flash was used to create the photo.
1098 &quot;focalLength&quot;: 3.14, # The focal length used to create the photo, in millimeters.
1099 &quot;height&quot;: 42, # The height of the image in pixels.
1100 &quot;isoSpeed&quot;: 42, # The ISO speed used to create the photo.
1101 &quot;lens&quot;: &quot;A String&quot;, # The lens used to create the photo.
1102 &quot;location&quot;: { # Geographic location information stored in the image.
1103 &quot;altitude&quot;: 3.14, # The altitude stored in the image.
1104 &quot;latitude&quot;: 3.14, # The latitude stored in the image.
1105 &quot;longitude&quot;: 3.14, # The longitude stored in the image.
1106 },
1107 &quot;maxApertureValue&quot;: 3.14, # The smallest f-number of the lens at the focal length used to create the photo (APEX value).
1108 &quot;meteringMode&quot;: &quot;A String&quot;, # The metering mode used to create the photo.
1109 &quot;rotation&quot;: 42, # The number of clockwise 90 degree rotations applied from the image&#x27;s original orientation.
1110 &quot;sensor&quot;: &quot;A String&quot;, # The type of sensor used to create the photo.
1111 &quot;subjectDistance&quot;: 42, # The distance to the subject of the photo, in meters.
1112 &quot;whiteBalance&quot;: &quot;A String&quot;, # The white balance mode used to create the photo.
1113 &quot;width&quot;: 42, # The width of the image in pixels.
1114 },
1115 &quot;indexableText&quot;: { # Indexable text attributes for the file (can only be written)
1116 &quot;text&quot;: &quot;A String&quot;, # The text to be indexed for this file.
1117 },
1118 &quot;isAppAuthorized&quot;: True or False, # Whether the file was created or opened by the requesting app.
1119 &quot;kind&quot;: &quot;drive#file&quot;, # The type of file. This is always drive#file.
1120 &quot;labels&quot;: { # A group of labels for the file.
1121 &quot;hidden&quot;: True or False, # Deprecated.
1122 &quot;modified&quot;: True or False, # Whether the file has been modified by this user.
1123 &quot;restricted&quot;: True or False, # Deprecated - use copyRequiresWriterPermission instead.
1124 &quot;starred&quot;: True or False, # Whether this file is starred by the user.
1125 &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.
1126 &quot;viewed&quot;: True or False, # Whether this file has been viewed by this user.
1127 },
1128 &quot;lastModifyingUser&quot;: { # Information about a Drive user. # The last user to modify this file.
1129 &quot;displayName&quot;: &quot;A String&quot;, # A plain text displayable name for this user.
1130 &quot;emailAddress&quot;: &quot;A String&quot;, # The email address of the user.
1131 &quot;isAuthenticatedUser&quot;: True or False, # Whether this user is the same as the authenticated user for whom the request was made.
1132 &quot;kind&quot;: &quot;drive#user&quot;, # This is always drive#user.
1133 &quot;permissionId&quot;: &quot;A String&quot;, # The user&#x27;s ID as visible in the permissions collection.
1134 &quot;picture&quot;: { # The user&#x27;s profile picture.
1135 &quot;url&quot;: &quot;A String&quot;, # A URL that points to a profile picture of this user.
1136 },
1137 },
1138 &quot;lastModifyingUserName&quot;: &quot;A String&quot;, # Name of the last user to modify this file.
1139 &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]1140 &quot;linkShareMetadata&quot;: { # Contains details about the link URLs that clients are using to refer to this item.
1141 &quot;securityUpdateEligible&quot;: True or False, # Whether the file is eligible for security update.
1142 &quot;securityUpdateEnabled&quot;: True or False, # Whether the security update is enabled for this file.
1143 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]1144 &quot;markedViewedByMeDate&quot;: &quot;A String&quot;, # Deprecated.
1145 &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.
1146 &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.
1147 &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.
1148 &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.
1149 &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.
1150 &quot;a_key&quot;: &quot;A String&quot;,
1151 },
1152 &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.
1153 &quot;ownedByMe&quot;: True or False, # Whether the file is owned by the current user. Not populated for items in shared drives.
1154 &quot;ownerNames&quot;: [ # Name(s) of the owner(s) of this file. Not populated for items in shared drives.
1155 &quot;A String&quot;,
1156 ],
yoshi-code-botab1d6dc2021-05-28 00:42:02 -0700[diff] [blame]1157 &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]1158 { # Information about a Drive user.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1159 &quot;displayName&quot;: &quot;A String&quot;, # A plain text displayable name for this user.
1160 &quot;emailAddress&quot;: &quot;A String&quot;, # The email address of the user.
1161 &quot;isAuthenticatedUser&quot;: True or False, # Whether this user is the same as the authenticated user for whom the request was made.
1162 &quot;kind&quot;: &quot;drive#user&quot;, # This is always drive#user.
1163 &quot;permissionId&quot;: &quot;A String&quot;, # The user&#x27;s ID as visible in the permissions collection.
1164 &quot;picture&quot;: { # The user&#x27;s profile picture.
1165 &quot;url&quot;: &quot;A String&quot;, # A URL that points to a profile picture of this user.
1166 },
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]1167 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]1168 ],
1169 &quot;parents&quot;: [ # Collection of parent folders which contain this file.
1170 # 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.
1171 { # A reference to a file&#x27;s parent.
1172 &quot;id&quot;: &quot;A String&quot;, # The ID of the parent.
1173 &quot;isRoot&quot;: True or False, # Whether or not the parent is the root folder.
1174 &quot;kind&quot;: &quot;drive#parentReference&quot;, # This is always drive#parentReference.
1175 &quot;parentLink&quot;: &quot;A String&quot;, # A link to the parent.
1176 &quot;selfLink&quot;: &quot;A String&quot;, # A link back to this reference.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1177 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]1178 ],
1179 &quot;permissionIds&quot;: [ # List of permission IDs for users with access to this file.
1180 &quot;A String&quot;,
1181 ],
1182 &quot;permissions&quot;: [ # The list of permissions for users with access to this file. Not populated for items in shared drives.
1183 { # A permission for a file.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1184 &quot;additionalRoles&quot;: [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future.
1185 &quot;A String&quot;,
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1186 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1187 &quot;authKey&quot;: &quot;A String&quot;, # Deprecated.
1188 &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.
1189 &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.
1190 &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.
1191 &quot;etag&quot;: &quot;A String&quot;, # The ETag of the permission.
1192 &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]1193 # - They cannot be set on shared drive items
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1194 # - They can only be set on user and group permissions
1195 # - The date must be in the future
1196 # - The date cannot be more than a year in the future
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1197 # - 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]1198 &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.
1199 &quot;kind&quot;: &quot;drive#permission&quot;, # This is always drive#permission.
1200 &quot;name&quot;: &quot;A String&quot;, # The name for this permission.
yoshi-code-bot815c1ac2021-11-15 23:24:17 -0800[diff] [blame]1201 &quot;pendingOwner&quot;: True or False, # Whether the account associated with this permission is a pending owner. Only populated for user type permissions for files that are not in a shared drive.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1202 &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.
1203 {
1204 &quot;additionalRoles&quot;: [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future.
1205 &quot;A String&quot;,
1206 ],
1207 &quot;inherited&quot;: True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field.
1208 &quot;inheritedFrom&quot;: &quot;A String&quot;, # The ID of the item from which this permission is inherited. This is an output-only field.
1209 &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:
1210 # - file
1211 # - member
1212 &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:
1213 # - organizer
1214 # - fileOrganizer
1215 # - writer
1216 # - reader
1217 },
1218 ],
1219 &quot;photoLink&quot;: &quot;A String&quot;, # A link to the profile photo, if available.
1220 &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]1221 # - owner
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1222 # - organizer
1223 # - fileOrganizer
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1224 # - writer
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1225 # - reader
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1226 &quot;selfLink&quot;: &quot;A String&quot;, # A link back to this permission.
1227 &quot;teamDrivePermissionDetails&quot;: [ # Deprecated - use permissionDetails instead.
1228 {
1229 &quot;additionalRoles&quot;: [ # Deprecated - use permissionDetails/additionalRoles instead.
1230 &quot;A String&quot;,
1231 ],
1232 &quot;inherited&quot;: True or False, # Deprecated - use permissionDetails/inherited instead.
1233 &quot;inheritedFrom&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/inheritedFrom instead.
1234 &quot;role&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/role instead.
1235 &quot;teamDrivePermissionType&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/permissionType instead.
1236 },
1237 ],
1238 &quot;type&quot;: &quot;A String&quot;, # The account type. Allowed values are:
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1239 # - user
1240 # - group
1241 # - domain
1242 # - anyone
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1243 &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]1244 &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]1245 &quot;withLink&quot;: True or False, # Whether the link is required for this permission.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1246 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]1247 ],
1248 &quot;properties&quot;: [ # The list of properties.
1249 { # A key-value pair attached to a file that is either public or private to an application.
1250 # The following limits apply to file properties:
1251 # - Maximum of 100 properties total per file
1252 # - Maximum of 30 private properties per app
1253 # - Maximum of 30 public properties
1254 # - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property.
1255 &quot;etag&quot;: &quot;A String&quot;, # ETag of the property.
1256 &quot;key&quot;: &quot;A String&quot;, # The key of this property.
1257 &quot;kind&quot;: &quot;drive#property&quot;, # This is always drive#property.
1258 &quot;selfLink&quot;: &quot;A String&quot;, # The link back to this property.
1259 &quot;value&quot;: &quot;A String&quot;, # The value of this property.
yoshi-code-bot69706592021-03-03 03:54:02 -0800[diff] [blame]1260 &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]1261 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]1262 ],
1263 &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]1264 &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]1265 &quot;selfLink&quot;: &quot;A String&quot;, # A link back to this file.
1266 &quot;shareable&quot;: True or False, # Deprecated: use capabilities/canShare.
1267 &quot;shared&quot;: True or False, # Whether the file has been shared. Not populated for items in shared drives.
1268 &quot;sharedWithMeDate&quot;: &quot;A String&quot;, # Time at which this file was shared with the user (formatted RFC 3339 timestamp).
1269 &quot;sharingUser&quot;: { # Information about a Drive user. # User that shared the item with the current user, if available.
1270 &quot;displayName&quot;: &quot;A String&quot;, # A plain text displayable name for this user.
1271 &quot;emailAddress&quot;: &quot;A String&quot;, # The email address of the user.
1272 &quot;isAuthenticatedUser&quot;: True or False, # Whether this user is the same as the authenticated user for whom the request was made.
1273 &quot;kind&quot;: &quot;drive#user&quot;, # This is always drive#user.
1274 &quot;permissionId&quot;: &quot;A String&quot;, # The user&#x27;s ID as visible in the permissions collection.
1275 &quot;picture&quot;: { # The user&#x27;s profile picture.
1276 &quot;url&quot;: &quot;A String&quot;, # A URL that points to a profile picture of this user.
1277 },
1278 },
1279 &quot;shortcutDetails&quot;: { # Shortcut file details. Only populated for shortcut files, which have the mimeType field set to application/vnd.google-apps.shortcut.
1280 &quot;targetId&quot;: &quot;A String&quot;, # The ID of the file that this shortcut points to.
1281 &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]1282 &quot;targetResourceKey&quot;: &quot;A String&quot;, # The ResourceKey for the target file.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]1283 },
1284 &quot;spaces&quot;: [ # The list of spaces which contain the file. Supported values are &#x27;drive&#x27;, &#x27;appDataFolder&#x27; and &#x27;photos&#x27;.
1285 &quot;A String&quot;,
1286 ],
1287 &quot;teamDriveId&quot;: &quot;A String&quot;, # Deprecated - use driveId instead.
1288 &quot;thumbnail&quot;: { # A thumbnail for the file. This will only be used if a standard thumbnail cannot be generated.
1289 &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.
1290 &quot;mimeType&quot;: &quot;A String&quot;, # The MIME type of the thumbnail.
1291 },
1292 &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.
1293 &quot;thumbnailVersion&quot;: &quot;A String&quot;, # The thumbnail version for use in thumbnail cache invalidation.
1294 &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.
1295 &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.
1296 &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.
1297 &quot;displayName&quot;: &quot;A String&quot;, # A plain text displayable name for this user.
1298 &quot;emailAddress&quot;: &quot;A String&quot;, # The email address of the user.
1299 &quot;isAuthenticatedUser&quot;: True or False, # Whether this user is the same as the authenticated user for whom the request was made.
1300 &quot;kind&quot;: &quot;drive#user&quot;, # This is always drive#user.
1301 &quot;permissionId&quot;: &quot;A String&quot;, # The user&#x27;s ID as visible in the permissions collection.
1302 &quot;picture&quot;: { # The user&#x27;s profile picture.
1303 &quot;url&quot;: &quot;A String&quot;, # A URL that points to a profile picture of this user.
1304 },
1305 },
1306 &quot;userPermission&quot;: { # A permission for a file. # The permissions for the authenticated user on this file.
1307 &quot;additionalRoles&quot;: [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future.
1308 &quot;A String&quot;,
1309 ],
1310 &quot;authKey&quot;: &quot;A String&quot;, # Deprecated.
1311 &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.
1312 &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.
1313 &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.
1314 &quot;etag&quot;: &quot;A String&quot;, # The ETag of the permission.
1315 &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:
1316 # - They cannot be set on shared drive items
1317 # - They can only be set on user and group permissions
1318 # - The date must be in the future
1319 # - The date cannot be more than a year in the future
1320 # - The date can only be set on drive.permissions.update or drive.permissions.patch requests
1321 &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.
1322 &quot;kind&quot;: &quot;drive#permission&quot;, # This is always drive#permission.
1323 &quot;name&quot;: &quot;A String&quot;, # The name for this permission.
yoshi-code-bot815c1ac2021-11-15 23:24:17 -0800[diff] [blame]1324 &quot;pendingOwner&quot;: True or False, # Whether the account associated with this permission is a pending owner. Only populated for user type permissions for files that are not in a shared drive.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]1325 &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.
1326 {
1327 &quot;additionalRoles&quot;: [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future.
1328 &quot;A String&quot;,
1329 ],
1330 &quot;inherited&quot;: True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field.
1331 &quot;inheritedFrom&quot;: &quot;A String&quot;, # The ID of the item from which this permission is inherited. This is an output-only field.
1332 &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:
1333 # - file
1334 # - member
1335 &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:
1336 # - organizer
1337 # - fileOrganizer
1338 # - writer
1339 # - reader
1340 },
1341 ],
1342 &quot;photoLink&quot;: &quot;A String&quot;, # A link to the profile photo, if available.
1343 &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:
1344 # - owner
1345 # - organizer
1346 # - fileOrganizer
1347 # - writer
1348 # - reader
1349 &quot;selfLink&quot;: &quot;A String&quot;, # A link back to this permission.
1350 &quot;teamDrivePermissionDetails&quot;: [ # Deprecated - use permissionDetails instead.
1351 {
1352 &quot;additionalRoles&quot;: [ # Deprecated - use permissionDetails/additionalRoles instead.
1353 &quot;A String&quot;,
1354 ],
1355 &quot;inherited&quot;: True or False, # Deprecated - use permissionDetails/inherited instead.
1356 &quot;inheritedFrom&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/inheritedFrom instead.
1357 &quot;role&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/role instead.
1358 &quot;teamDrivePermissionType&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/permissionType instead.
1359 },
1360 ],
1361 &quot;type&quot;: &quot;A String&quot;, # The account type. Allowed values are:
1362 # - user
1363 # - group
1364 # - domain
1365 # - anyone
1366 &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.
1367 &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.
1368 &quot;withLink&quot;: True or False, # Whether the link is required for this permission.
1369 },
1370 &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.
1371 &quot;videoMediaMetadata&quot;: { # Metadata about video media. This will only be present for video types.
1372 &quot;durationMillis&quot;: &quot;A String&quot;, # The duration of the video in milliseconds.
1373 &quot;height&quot;: 42, # The height of the video in pixels.
1374 &quot;width&quot;: 42, # The width of the video in pixels.
1375 },
1376 &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.
1377 &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.
1378 &quot;writersCanShare&quot;: True or False, # Whether writers can share the document with other users. Not populated for items in shared drives.
1379}</pre>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1380</div>
1381
1382<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]1383 <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]1384 <pre>Gets a file&#x27;s metadata or content by ID.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]1385
1386Args:
1387 fileId: string, The ID for the file in question. (required)
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1388 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]1389 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]1390 projection: string, This parameter is deprecated and has no function.
1391 Allowed values
1392 BASIC - Deprecated
1393 FULL - Deprecated
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]1394 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]1395 supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1396 supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]1397 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]1398
1399Returns:
1400 The media object as a string.
1401
1402 </pre>
1403</div>
1404
1405<div class="method">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]1406 <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]1407 <pre>Insert a new file.
1408
1409Args:
1410 body: object, The request body.
1411 The object takes the form of:
1412
1413{ # The metadata for a file.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1414 &quot;alternateLink&quot;: &quot;A String&quot;, # A link for opening the file in a relevant Google editor or viewer.
1415 &quot;appDataContents&quot;: True or False, # Whether this file is in the Application Data folder.
1416 &quot;canComment&quot;: True or False, # Deprecated: use capabilities/canComment.
1417 &quot;canReadRevisions&quot;: True or False, # Deprecated: use capabilities/canReadRevisions.
1418 &quot;capabilities&quot;: { # Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take.
yoshi-code-bot815c1ac2021-11-15 23:24:17 -0800[diff] [blame]1419 &quot;canAcceptOwnership&quot;: True or False, # Whether the current user is the pending owner of the file. Not populated for shared drive files.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1420 &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]1421 &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]1422 &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.
1423 &quot;canChangeCopyRequiresWriterPermission&quot;: True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this file.
1424 &quot;canChangeRestrictedDownload&quot;: True or False, # Deprecated
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700[diff] [blame]1425 &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]1426 &quot;canComment&quot;: True or False, # Whether the current user can comment on this file.
1427 &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.
1428 &quot;canDelete&quot;: True or False, # Whether the current user can delete this file.
1429 &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.
1430 &quot;canDownload&quot;: True or False, # Whether the current user can download this file.
1431 &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.
1432 &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.
1433 &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]1434 &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]1435 &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.
1436 &quot;canMoveChildrenOutOfTeamDrive&quot;: True or False, # Deprecated - use canMoveChildrenOutOfDrive instead.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]1437 &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]1438 &quot;canMoveChildrenWithinTeamDrive&quot;: True or False, # Deprecated - use canMoveChildrenWithinDrive instead.
1439 &quot;canMoveItemIntoTeamDrive&quot;: True or False, # Deprecated - use canMoveItemOutOfDrive instead.
1440 &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.
1441 &quot;canMoveItemOutOfTeamDrive&quot;: True or False, # Deprecated - use canMoveItemOutOfDrive instead.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]1442 &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]1443 &quot;canMoveItemWithinTeamDrive&quot;: True or False, # Deprecated - use canMoveItemWithinDrive instead.
1444 &quot;canMoveTeamDriveItem&quot;: True or False, # Deprecated - use canMoveItemWithinDrive or canMoveItemOutOfDrive instead.
1445 &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.
1446 &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.
1447 &quot;canReadTeamDrive&quot;: True or False, # Deprecated - use canReadDrive instead.
1448 &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.
1449 &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.
1450 &quot;canRename&quot;: True or False, # Whether the current user can rename this file.
1451 &quot;canShare&quot;: True or False, # Whether the current user can modify the sharing settings for this file.
1452 &quot;canTrash&quot;: True or False, # Whether the current user can move this file to trash.
1453 &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.
1454 &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]1455 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]1456 &quot;contentRestrictions&quot;: [ # Restrictions for accessing the content of the file. Only populated if such a restriction exists.
1457 { # A restriction for accessing the content of the file.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]1458 &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]1459 &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.
1460 &quot;restrictingUser&quot;: { # Information about a Drive user. # The user who set the content restriction. Only populated if readOnly is true.
1461 &quot;displayName&quot;: &quot;A String&quot;, # A plain text displayable name for this user.
1462 &quot;emailAddress&quot;: &quot;A String&quot;, # The email address of the user.
1463 &quot;isAuthenticatedUser&quot;: True or False, # Whether this user is the same as the authenticated user for whom the request was made.
1464 &quot;kind&quot;: &quot;drive#user&quot;, # This is always drive#user.
1465 &quot;permissionId&quot;: &quot;A String&quot;, # The user&#x27;s ID as visible in the permissions collection.
1466 &quot;picture&quot;: { # The user&#x27;s profile picture.
1467 &quot;url&quot;: &quot;A String&quot;, # A URL that points to a profile picture of this user.
1468 },
1469 },
1470 &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.
1471 &quot;type&quot;: &quot;A String&quot;, # The type of the content restriction. Currently the only possible value is globalContentRestriction.
1472 },
1473 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1474 &quot;copyRequiresWriterPermission&quot;: True or False, # Whether the options to copy, print, or download this file, should be disabled for readers and commenters.
1475 &quot;copyable&quot;: True or False, # Deprecated: use capabilities/canCopy.
1476 &quot;createdDate&quot;: &quot;A String&quot;, # Create time for this file (formatted RFC 3339 timestamp).
1477 &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.
1478 &quot;description&quot;: &quot;A String&quot;, # A short description of the file.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]1479 &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]1480 &quot;driveId&quot;: &quot;A String&quot;, # ID of the shared drive the file resides in. Only populated for items in shared drives.
1481 &quot;editable&quot;: True or False, # Deprecated: use capabilities/canEdit.
1482 &quot;embedLink&quot;: &quot;A String&quot;, # A link for embedding the file.
1483 &quot;etag&quot;: &quot;A String&quot;, # ETag of the file.
1484 &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]1485 &quot;exportLinks&quot;: { # Links for exporting Docs Editors files to specific formats.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1486 &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]1487 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]1488 &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.
1489 &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.
yoshi-code-botb539cc42021-08-03 00:20:27 -0700[diff] [blame]1490 &quot;folderColorRgb&quot;: &quot;A String&quot;, # Folder color as an RGB hex string if the file is a folder or a shortcut to 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.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]1491 &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]1492 &quot;hasAugmentedPermissions&quot;: True or False, # Whether there are permissions directly on this file. This field is only populated for items in shared drives.
1493 &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]1494 &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]1495 &quot;iconLink&quot;: &quot;A String&quot;, # A link to the file&#x27;s icon.
1496 &quot;id&quot;: &quot;A String&quot;, # The ID of the file.
1497 &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.
1498 &quot;aperture&quot;: 3.14, # The aperture used to create the photo (f-number).
1499 &quot;cameraMake&quot;: &quot;A String&quot;, # The make of the camera used to create the photo.
1500 &quot;cameraModel&quot;: &quot;A String&quot;, # The model of the camera used to create the photo.
1501 &quot;colorSpace&quot;: &quot;A String&quot;, # The color space of the photo.
1502 &quot;date&quot;: &quot;A String&quot;, # The date and time the photo was taken (EXIF format timestamp).
1503 &quot;exposureBias&quot;: 3.14, # The exposure bias of the photo (APEX value).
1504 &quot;exposureMode&quot;: &quot;A String&quot;, # The exposure mode used to create the photo.
1505 &quot;exposureTime&quot;: 3.14, # The length of the exposure, in seconds.
1506 &quot;flashUsed&quot;: True or False, # Whether a flash was used to create the photo.
1507 &quot;focalLength&quot;: 3.14, # The focal length used to create the photo, in millimeters.
1508 &quot;height&quot;: 42, # The height of the image in pixels.
1509 &quot;isoSpeed&quot;: 42, # The ISO speed used to create the photo.
1510 &quot;lens&quot;: &quot;A String&quot;, # The lens used to create the photo.
1511 &quot;location&quot;: { # Geographic location information stored in the image.
1512 &quot;altitude&quot;: 3.14, # The altitude stored in the image.
1513 &quot;latitude&quot;: 3.14, # The latitude stored in the image.
1514 &quot;longitude&quot;: 3.14, # The longitude stored in the image.
1515 },
1516 &quot;maxApertureValue&quot;: 3.14, # The smallest f-number of the lens at the focal length used to create the photo (APEX value).
1517 &quot;meteringMode&quot;: &quot;A String&quot;, # The metering mode used to create the photo.
1518 &quot;rotation&quot;: 42, # The number of clockwise 90 degree rotations applied from the image&#x27;s original orientation.
1519 &quot;sensor&quot;: &quot;A String&quot;, # The type of sensor used to create the photo.
1520 &quot;subjectDistance&quot;: 42, # The distance to the subject of the photo, in meters.
1521 &quot;whiteBalance&quot;: &quot;A String&quot;, # The white balance mode used to create the photo.
1522 &quot;width&quot;: 42, # The width of the image in pixels.
1523 },
1524 &quot;indexableText&quot;: { # Indexable text attributes for the file (can only be written)
1525 &quot;text&quot;: &quot;A String&quot;, # The text to be indexed for this file.
1526 },
1527 &quot;isAppAuthorized&quot;: True or False, # Whether the file was created or opened by the requesting app.
1528 &quot;kind&quot;: &quot;drive#file&quot;, # The type of file. This is always drive#file.
1529 &quot;labels&quot;: { # A group of labels for the file.
1530 &quot;hidden&quot;: True or False, # Deprecated.
1531 &quot;modified&quot;: True or False, # Whether the file has been modified by this user.
1532 &quot;restricted&quot;: True or False, # Deprecated - use copyRequiresWriterPermission instead.
1533 &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]1534 &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]1535 &quot;viewed&quot;: True or False, # Whether this file has been viewed by this user.
1536 },
1537 &quot;lastModifyingUser&quot;: { # Information about a Drive user. # The last user to modify this file.
1538 &quot;displayName&quot;: &quot;A String&quot;, # A plain text displayable name for this user.
1539 &quot;emailAddress&quot;: &quot;A String&quot;, # The email address of the user.
1540 &quot;isAuthenticatedUser&quot;: True or False, # Whether this user is the same as the authenticated user for whom the request was made.
1541 &quot;kind&quot;: &quot;drive#user&quot;, # This is always drive#user.
1542 &quot;permissionId&quot;: &quot;A String&quot;, # The user&#x27;s ID as visible in the permissions collection.
1543 &quot;picture&quot;: { # The user&#x27;s profile picture.
1544 &quot;url&quot;: &quot;A String&quot;, # A URL that points to a profile picture of this user.
1545 },
1546 },
1547 &quot;lastModifyingUserName&quot;: &quot;A String&quot;, # Name of the last user to modify this file.
1548 &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]1549 &quot;linkShareMetadata&quot;: { # Contains details about the link URLs that clients are using to refer to this item.
1550 &quot;securityUpdateEligible&quot;: True or False, # Whether the file is eligible for security update.
1551 &quot;securityUpdateEnabled&quot;: True or False, # Whether the security update is enabled for this file.
1552 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1553 &quot;markedViewedByMeDate&quot;: &quot;A String&quot;, # Deprecated.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]1554 &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]1555 &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.
1556 &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.
1557 &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.
1558 &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.
1559 &quot;a_key&quot;: &quot;A String&quot;,
1560 },
1561 &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.
1562 &quot;ownedByMe&quot;: True or False, # Whether the file is owned by the current user. Not populated for items in shared drives.
1563 &quot;ownerNames&quot;: [ # Name(s) of the owner(s) of this file. Not populated for items in shared drives.
1564 &quot;A String&quot;,
1565 ],
yoshi-code-botab1d6dc2021-05-28 00:42:02 -0700[diff] [blame]1566 &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]1567 { # Information about a Drive user.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1568 &quot;displayName&quot;: &quot;A String&quot;, # A plain text displayable name for this user.
1569 &quot;emailAddress&quot;: &quot;A String&quot;, # The email address of the user.
1570 &quot;isAuthenticatedUser&quot;: True or False, # Whether this user is the same as the authenticated user for whom the request was made.
1571 &quot;kind&quot;: &quot;drive#user&quot;, # This is always drive#user.
1572 &quot;permissionId&quot;: &quot;A String&quot;, # The user&#x27;s ID as visible in the permissions collection.
1573 &quot;picture&quot;: { # The user&#x27;s profile picture.
1574 &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]1575 },
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;parents&quot;: [ # Collection of parent folders which contain this file.
1579 # 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.
1580 { # A reference to a file&#x27;s parent.
1581 &quot;id&quot;: &quot;A String&quot;, # The ID of the parent.
1582 &quot;isRoot&quot;: True or False, # Whether or not the parent is the root folder.
1583 &quot;kind&quot;: &quot;drive#parentReference&quot;, # This is always drive#parentReference.
1584 &quot;parentLink&quot;: &quot;A String&quot;, # A link to the parent.
1585 &quot;selfLink&quot;: &quot;A String&quot;, # A link back to this reference.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1586 },
1587 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1588 &quot;permissionIds&quot;: [ # List of permission IDs for users with access to this file.
1589 &quot;A String&quot;,
1590 ],
1591 &quot;permissions&quot;: [ # The list of permissions for users with access to this file. Not populated for items in shared drives.
1592 { # A permission for a file.
1593 &quot;additionalRoles&quot;: [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future.
1594 &quot;A String&quot;,
1595 ],
1596 &quot;authKey&quot;: &quot;A String&quot;, # Deprecated.
1597 &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.
1598 &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.
1599 &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.
1600 &quot;etag&quot;: &quot;A String&quot;, # The ETag of the permission.
1601 &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:
1602 # - They cannot be set on shared drive items
1603 # - They can only be set on user and group permissions
1604 # - The date must be in the future
1605 # - The date cannot be more than a year in the future
1606 # - The date can only be set on drive.permissions.update or drive.permissions.patch requests
1607 &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.
1608 &quot;kind&quot;: &quot;drive#permission&quot;, # This is always drive#permission.
1609 &quot;name&quot;: &quot;A String&quot;, # The name for this permission.
yoshi-code-bot815c1ac2021-11-15 23:24:17 -0800[diff] [blame]1610 &quot;pendingOwner&quot;: True or False, # Whether the account associated with this permission is a pending owner. Only populated for user type permissions for files that are not in a shared drive.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1611 &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.
1612 {
1613 &quot;additionalRoles&quot;: [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future.
1614 &quot;A String&quot;,
1615 ],
1616 &quot;inherited&quot;: True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field.
1617 &quot;inheritedFrom&quot;: &quot;A String&quot;, # The ID of the item from which this permission is inherited. This is an output-only field.
1618 &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:
1619 # - file
1620 # - member
1621 &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:
1622 # - organizer
1623 # - fileOrganizer
1624 # - writer
1625 # - reader
1626 },
1627 ],
1628 &quot;photoLink&quot;: &quot;A String&quot;, # A link to the profile photo, if available.
1629 &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:
1630 # - owner
1631 # - organizer
1632 # - fileOrganizer
1633 # - writer
1634 # - reader
1635 &quot;selfLink&quot;: &quot;A String&quot;, # A link back to this permission.
1636 &quot;teamDrivePermissionDetails&quot;: [ # Deprecated - use permissionDetails instead.
1637 {
1638 &quot;additionalRoles&quot;: [ # Deprecated - use permissionDetails/additionalRoles instead.
1639 &quot;A String&quot;,
1640 ],
1641 &quot;inherited&quot;: True or False, # Deprecated - use permissionDetails/inherited instead.
1642 &quot;inheritedFrom&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/inheritedFrom instead.
1643 &quot;role&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/role instead.
1644 &quot;teamDrivePermissionType&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/permissionType instead.
1645 },
1646 ],
1647 &quot;type&quot;: &quot;A String&quot;, # The account type. Allowed values are:
1648 # - user
1649 # - group
1650 # - domain
1651 # - anyone
1652 &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]1653 &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]1654 &quot;withLink&quot;: True or False, # Whether the link is required for this permission.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1655 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1656 ],
1657 &quot;properties&quot;: [ # The list of properties.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]1658 { # A key-value pair attached to a file that is either public or private to an application.
1659 # The following limits apply to file properties:
1660 # - Maximum of 100 properties total per file
1661 # - Maximum of 30 private properties per app
1662 # - Maximum of 30 public properties
1663 # - 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]1664 &quot;etag&quot;: &quot;A String&quot;, # ETag of the property.
1665 &quot;key&quot;: &quot;A String&quot;, # The key of this property.
1666 &quot;kind&quot;: &quot;drive#property&quot;, # This is always drive#property.
1667 &quot;selfLink&quot;: &quot;A String&quot;, # The link back to this property.
1668 &quot;value&quot;: &quot;A String&quot;, # The value of this property.
yoshi-code-bot69706592021-03-03 03:54:02 -0800[diff] [blame]1669 &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]1670 },
1671 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1672 &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]1673 &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]1674 &quot;selfLink&quot;: &quot;A String&quot;, # A link back to this file.
1675 &quot;shareable&quot;: True or False, # Deprecated: use capabilities/canShare.
1676 &quot;shared&quot;: True or False, # Whether the file has been shared. Not populated for items in shared drives.
1677 &quot;sharedWithMeDate&quot;: &quot;A String&quot;, # Time at which this file was shared with the user (formatted RFC 3339 timestamp).
1678 &quot;sharingUser&quot;: { # Information about a Drive user. # User that shared the item with the current user, if available.
1679 &quot;displayName&quot;: &quot;A String&quot;, # A plain text displayable name for this user.
1680 &quot;emailAddress&quot;: &quot;A String&quot;, # The email address of the user.
1681 &quot;isAuthenticatedUser&quot;: True or False, # Whether this user is the same as the authenticated user for whom the request was made.
1682 &quot;kind&quot;: &quot;drive#user&quot;, # This is always drive#user.
1683 &quot;permissionId&quot;: &quot;A String&quot;, # The user&#x27;s ID as visible in the permissions collection.
1684 &quot;picture&quot;: { # The user&#x27;s profile picture.
1685 &quot;url&quot;: &quot;A String&quot;, # A URL that points to a profile picture of this user.
1686 },
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]1687 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1688 &quot;shortcutDetails&quot;: { # Shortcut file details. Only populated for shortcut files, which have the mimeType field set to application/vnd.google-apps.shortcut.
1689 &quot;targetId&quot;: &quot;A String&quot;, # The ID of the file that this shortcut points to.
1690 &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]1691 &quot;targetResourceKey&quot;: &quot;A String&quot;, # The ResourceKey for the target file.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1692 },
1693 &quot;spaces&quot;: [ # The list of spaces which contain the file. Supported values are &#x27;drive&#x27;, &#x27;appDataFolder&#x27; and &#x27;photos&#x27;.
1694 &quot;A String&quot;,
1695 ],
1696 &quot;teamDriveId&quot;: &quot;A String&quot;, # Deprecated - use driveId instead.
1697 &quot;thumbnail&quot;: { # A thumbnail for the file. This will only be used if a standard thumbnail cannot be generated.
1698 &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.
1699 &quot;mimeType&quot;: &quot;A String&quot;, # The MIME type of the thumbnail.
1700 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]1701 &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]1702 &quot;thumbnailVersion&quot;: &quot;A String&quot;, # The thumbnail version for use in thumbnail cache invalidation.
1703 &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.
1704 &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.
1705 &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.
1706 &quot;displayName&quot;: &quot;A String&quot;, # A plain text displayable name for this user.
1707 &quot;emailAddress&quot;: &quot;A String&quot;, # The email address of the user.
1708 &quot;isAuthenticatedUser&quot;: True or False, # Whether this user is the same as the authenticated user for whom the request was made.
1709 &quot;kind&quot;: &quot;drive#user&quot;, # This is always drive#user.
1710 &quot;permissionId&quot;: &quot;A String&quot;, # The user&#x27;s ID as visible in the permissions collection.
1711 &quot;picture&quot;: { # The user&#x27;s profile picture.
1712 &quot;url&quot;: &quot;A String&quot;, # A URL that points to a profile picture of this user.
1713 },
1714 },
1715 &quot;userPermission&quot;: { # A permission for a file. # The permissions for the authenticated user on this file.
1716 &quot;additionalRoles&quot;: [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future.
1717 &quot;A String&quot;,
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1718 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1719 &quot;authKey&quot;: &quot;A String&quot;, # Deprecated.
1720 &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.
1721 &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.
1722 &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.
1723 &quot;etag&quot;: &quot;A String&quot;, # The ETag of the permission.
1724 &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]1725 # - They cannot be set on shared drive items
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1726 # - They can only be set on user and group permissions
1727 # - The date must be in the future
1728 # - The date cannot be more than a year in the future
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1729 # - 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]1730 &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.
1731 &quot;kind&quot;: &quot;drive#permission&quot;, # This is always drive#permission.
1732 &quot;name&quot;: &quot;A String&quot;, # The name for this permission.
yoshi-code-bot815c1ac2021-11-15 23:24:17 -0800[diff] [blame]1733 &quot;pendingOwner&quot;: True or False, # Whether the account associated with this permission is a pending owner. Only populated for user type permissions for files that are not in a shared drive.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1734 &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.
1735 {
1736 &quot;additionalRoles&quot;: [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future.
1737 &quot;A String&quot;,
1738 ],
1739 &quot;inherited&quot;: True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field.
1740 &quot;inheritedFrom&quot;: &quot;A String&quot;, # The ID of the item from which this permission is inherited. This is an output-only field.
1741 &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:
1742 # - file
1743 # - member
1744 &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:
1745 # - organizer
1746 # - fileOrganizer
1747 # - writer
1748 # - reader
1749 },
1750 ],
1751 &quot;photoLink&quot;: &quot;A String&quot;, # A link to the profile photo, if available.
1752 &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]1753 # - owner
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1754 # - organizer
1755 # - fileOrganizer
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1756 # - writer
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1757 # - reader
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1758 &quot;selfLink&quot;: &quot;A String&quot;, # A link back to this permission.
1759 &quot;teamDrivePermissionDetails&quot;: [ # Deprecated - use permissionDetails instead.
1760 {
1761 &quot;additionalRoles&quot;: [ # Deprecated - use permissionDetails/additionalRoles instead.
1762 &quot;A String&quot;,
1763 ],
1764 &quot;inherited&quot;: True or False, # Deprecated - use permissionDetails/inherited instead.
1765 &quot;inheritedFrom&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/inheritedFrom instead.
1766 &quot;role&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/role instead.
1767 &quot;teamDrivePermissionType&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/permissionType instead.
1768 },
1769 ],
1770 &quot;type&quot;: &quot;A String&quot;, # The account type. Allowed values are:
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1771 # - user
1772 # - group
1773 # - domain
1774 # - anyone
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1775 &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]1776 &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]1777 &quot;withLink&quot;: True or False, # Whether the link is required for this permission.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1778 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1779 &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.
1780 &quot;videoMediaMetadata&quot;: { # Metadata about video media. This will only be present for video types.
1781 &quot;durationMillis&quot;: &quot;A String&quot;, # The duration of the video in milliseconds.
1782 &quot;height&quot;: 42, # The height of the video in pixels.
1783 &quot;width&quot;: 42, # The width of the video in pixels.
1784 },
1785 &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.
1786 &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.
1787 &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]1788}
1789
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]1790 convert: boolean, Whether to convert this file to the corresponding Docs Editors format.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]1791 enforceSingleParent: boolean, Deprecated. Creating files in multiple folders is no longer supported.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]1792 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]1793 media_body: string, The filename of the media request body, or an instance of a MediaUpload object.
1794 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]1795 ocr: boolean, Whether to attempt OCR on .jpg, .png, .gif, or .pdf uploads.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1796 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]1797 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]1798 supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1799 supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead.
1800 timedTextLanguage: string, The language of the timed text.
1801 timedTextTrackName: string, The timed text track name.
1802 useContentAsIndexableText: boolean, Whether to use the content as indexable text.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1803 visibility: string, The visibility of the new file. This parameter is only relevant when convert=false.
1804 Allowed values
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1805 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]1806 PRIVATE - The new file will be visible to only the owner.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1807
1808Returns:
1809 An object of the form:
1810
1811 { # The metadata for a file.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]1812 &quot;alternateLink&quot;: &quot;A String&quot;, # A link for opening the file in a relevant Google editor or viewer.
1813 &quot;appDataContents&quot;: True or False, # Whether this file is in the Application Data folder.
1814 &quot;canComment&quot;: True or False, # Deprecated: use capabilities/canComment.
1815 &quot;canReadRevisions&quot;: True or False, # Deprecated: use capabilities/canReadRevisions.
1816 &quot;capabilities&quot;: { # Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take.
yoshi-code-bot815c1ac2021-11-15 23:24:17 -0800[diff] [blame]1817 &quot;canAcceptOwnership&quot;: True or False, # Whether the current user is the pending owner of the file. Not populated for shared drive files.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]1818 &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.
1819 &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.
1820 &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.
1821 &quot;canChangeCopyRequiresWriterPermission&quot;: True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this file.
1822 &quot;canChangeRestrictedDownload&quot;: True or False, # Deprecated
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700[diff] [blame]1823 &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]1824 &quot;canComment&quot;: True or False, # Whether the current user can comment on this file.
1825 &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.
1826 &quot;canDelete&quot;: True or False, # Whether the current user can delete this file.
1827 &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.
1828 &quot;canDownload&quot;: True or False, # Whether the current user can download this file.
1829 &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.
1830 &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.
1831 &quot;canModifyContent&quot;: True or False, # Whether the current user can modify the content of this file.
1832 &quot;canModifyContentRestriction&quot;: True or False, # Whether the current user can modify restrictions on content of this file.
1833 &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.
1834 &quot;canMoveChildrenOutOfTeamDrive&quot;: True or False, # Deprecated - use canMoveChildrenOutOfDrive instead.
1835 &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.
1836 &quot;canMoveChildrenWithinTeamDrive&quot;: True or False, # Deprecated - use canMoveChildrenWithinDrive instead.
1837 &quot;canMoveItemIntoTeamDrive&quot;: True or False, # Deprecated - use canMoveItemOutOfDrive instead.
1838 &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.
1839 &quot;canMoveItemOutOfTeamDrive&quot;: True or False, # Deprecated - use canMoveItemOutOfDrive instead.
1840 &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.
1841 &quot;canMoveItemWithinTeamDrive&quot;: True or False, # Deprecated - use canMoveItemWithinDrive instead.
1842 &quot;canMoveTeamDriveItem&quot;: True or False, # Deprecated - use canMoveItemWithinDrive or canMoveItemOutOfDrive instead.
1843 &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.
1844 &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.
1845 &quot;canReadTeamDrive&quot;: True or False, # Deprecated - use canReadDrive instead.
1846 &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.
1847 &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.
1848 &quot;canRename&quot;: True or False, # Whether the current user can rename this file.
1849 &quot;canShare&quot;: True or False, # Whether the current user can modify the sharing settings for this file.
1850 &quot;canTrash&quot;: True or False, # Whether the current user can move this file to trash.
1851 &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.
1852 &quot;canUntrash&quot;: True or False, # Whether the current user can restore this file from trash.
1853 },
1854 &quot;contentRestrictions&quot;: [ # Restrictions for accessing the content of the file. Only populated if such a restriction exists.
1855 { # A restriction for accessing the content of the file.
1856 &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.
1857 &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.
1858 &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]1859 &quot;displayName&quot;: &quot;A String&quot;, # A plain text displayable name for this user.
1860 &quot;emailAddress&quot;: &quot;A String&quot;, # The email address of the user.
1861 &quot;isAuthenticatedUser&quot;: True or False, # Whether this user is the same as the authenticated user for whom the request was made.
1862 &quot;kind&quot;: &quot;drive#user&quot;, # This is always drive#user.
1863 &quot;permissionId&quot;: &quot;A String&quot;, # The user&#x27;s ID as visible in the permissions collection.
1864 &quot;picture&quot;: { # The user&#x27;s profile picture.
1865 &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]1866 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1867 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]1868 &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.
1869 &quot;type&quot;: &quot;A String&quot;, # The type of the content restriction. Currently the only possible value is globalContentRestriction.
1870 },
1871 ],
1872 &quot;copyRequiresWriterPermission&quot;: True or False, # Whether the options to copy, print, or download this file, should be disabled for readers and commenters.
1873 &quot;copyable&quot;: True or False, # Deprecated: use capabilities/canCopy.
1874 &quot;createdDate&quot;: &quot;A String&quot;, # Create time for this file (formatted RFC 3339 timestamp).
1875 &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.
1876 &quot;description&quot;: &quot;A String&quot;, # A short description of the file.
1877 &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.
1878 &quot;driveId&quot;: &quot;A String&quot;, # ID of the shared drive the file resides in. Only populated for items in shared drives.
1879 &quot;editable&quot;: True or False, # Deprecated: use capabilities/canEdit.
1880 &quot;embedLink&quot;: &quot;A String&quot;, # A link for embedding the file.
1881 &quot;etag&quot;: &quot;A String&quot;, # ETag of the file.
1882 &quot;explicitlyTrashed&quot;: True or False, # Whether this file has been explicitly trashed, as opposed to recursively trashed.
1883 &quot;exportLinks&quot;: { # Links for exporting Docs Editors files to specific formats.
1884 &quot;a_key&quot;: &quot;A String&quot;, # A mapping from export format to URL
1885 },
1886 &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.
1887 &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.
yoshi-code-botb539cc42021-08-03 00:20:27 -0700[diff] [blame]1888 &quot;folderColorRgb&quot;: &quot;A String&quot;, # Folder color as an RGB hex string if the file is a folder or a shortcut to 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.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]1889 &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.
1890 &quot;hasAugmentedPermissions&quot;: True or False, # Whether there are permissions directly on this file. This field is only populated for items in shared drives.
1891 &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.
1892 &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.
1893 &quot;iconLink&quot;: &quot;A String&quot;, # A link to the file&#x27;s icon.
1894 &quot;id&quot;: &quot;A String&quot;, # The ID of the file.
1895 &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.
1896 &quot;aperture&quot;: 3.14, # The aperture used to create the photo (f-number).
1897 &quot;cameraMake&quot;: &quot;A String&quot;, # The make of the camera used to create the photo.
1898 &quot;cameraModel&quot;: &quot;A String&quot;, # The model of the camera used to create the photo.
1899 &quot;colorSpace&quot;: &quot;A String&quot;, # The color space of the photo.
1900 &quot;date&quot;: &quot;A String&quot;, # The date and time the photo was taken (EXIF format timestamp).
1901 &quot;exposureBias&quot;: 3.14, # The exposure bias of the photo (APEX value).
1902 &quot;exposureMode&quot;: &quot;A String&quot;, # The exposure mode used to create the photo.
1903 &quot;exposureTime&quot;: 3.14, # The length of the exposure, in seconds.
1904 &quot;flashUsed&quot;: True or False, # Whether a flash was used to create the photo.
1905 &quot;focalLength&quot;: 3.14, # The focal length used to create the photo, in millimeters.
1906 &quot;height&quot;: 42, # The height of the image in pixels.
1907 &quot;isoSpeed&quot;: 42, # The ISO speed used to create the photo.
1908 &quot;lens&quot;: &quot;A String&quot;, # The lens used to create the photo.
1909 &quot;location&quot;: { # Geographic location information stored in the image.
1910 &quot;altitude&quot;: 3.14, # The altitude stored in the image.
1911 &quot;latitude&quot;: 3.14, # The latitude stored in the image.
1912 &quot;longitude&quot;: 3.14, # The longitude stored in the image.
1913 },
1914 &quot;maxApertureValue&quot;: 3.14, # The smallest f-number of the lens at the focal length used to create the photo (APEX value).
1915 &quot;meteringMode&quot;: &quot;A String&quot;, # The metering mode used to create the photo.
1916 &quot;rotation&quot;: 42, # The number of clockwise 90 degree rotations applied from the image&#x27;s original orientation.
1917 &quot;sensor&quot;: &quot;A String&quot;, # The type of sensor used to create the photo.
1918 &quot;subjectDistance&quot;: 42, # The distance to the subject of the photo, in meters.
1919 &quot;whiteBalance&quot;: &quot;A String&quot;, # The white balance mode used to create the photo.
1920 &quot;width&quot;: 42, # The width of the image in pixels.
1921 },
1922 &quot;indexableText&quot;: { # Indexable text attributes for the file (can only be written)
1923 &quot;text&quot;: &quot;A String&quot;, # The text to be indexed for this file.
1924 },
1925 &quot;isAppAuthorized&quot;: True or False, # Whether the file was created or opened by the requesting app.
1926 &quot;kind&quot;: &quot;drive#file&quot;, # The type of file. This is always drive#file.
1927 &quot;labels&quot;: { # A group of labels for the file.
1928 &quot;hidden&quot;: True or False, # Deprecated.
1929 &quot;modified&quot;: True or False, # Whether the file has been modified by this user.
1930 &quot;restricted&quot;: True or False, # Deprecated - use copyRequiresWriterPermission instead.
1931 &quot;starred&quot;: True or False, # Whether this file is starred by the user.
1932 &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.
1933 &quot;viewed&quot;: True or False, # Whether this file has been viewed by this user.
1934 },
1935 &quot;lastModifyingUser&quot;: { # Information about a Drive user. # The last user to modify this file.
1936 &quot;displayName&quot;: &quot;A String&quot;, # A plain text displayable name for this user.
1937 &quot;emailAddress&quot;: &quot;A String&quot;, # The email address of the user.
1938 &quot;isAuthenticatedUser&quot;: True or False, # Whether this user is the same as the authenticated user for whom the request was made.
1939 &quot;kind&quot;: &quot;drive#user&quot;, # This is always drive#user.
1940 &quot;permissionId&quot;: &quot;A String&quot;, # The user&#x27;s ID as visible in the permissions collection.
1941 &quot;picture&quot;: { # The user&#x27;s profile picture.
1942 &quot;url&quot;: &quot;A String&quot;, # A URL that points to a profile picture of this user.
1943 },
1944 },
1945 &quot;lastModifyingUserName&quot;: &quot;A String&quot;, # Name of the last user to modify this file.
1946 &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]1947 &quot;linkShareMetadata&quot;: { # Contains details about the link URLs that clients are using to refer to this item.
1948 &quot;securityUpdateEligible&quot;: True or False, # Whether the file is eligible for security update.
1949 &quot;securityUpdateEnabled&quot;: True or False, # Whether the security update is enabled for this file.
1950 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]1951 &quot;markedViewedByMeDate&quot;: &quot;A String&quot;, # Deprecated.
1952 &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.
1953 &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.
1954 &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.
1955 &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.
1956 &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.
1957 &quot;a_key&quot;: &quot;A String&quot;,
1958 },
1959 &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.
1960 &quot;ownedByMe&quot;: True or False, # Whether the file is owned by the current user. Not populated for items in shared drives.
1961 &quot;ownerNames&quot;: [ # Name(s) of the owner(s) of this file. Not populated for items in shared drives.
1962 &quot;A String&quot;,
1963 ],
yoshi-code-botab1d6dc2021-05-28 00:42:02 -0700[diff] [blame]1964 &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]1965 { # Information about a Drive user.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1966 &quot;displayName&quot;: &quot;A String&quot;, # A plain text displayable name for this user.
1967 &quot;emailAddress&quot;: &quot;A String&quot;, # The email address of the user.
1968 &quot;isAuthenticatedUser&quot;: True or False, # Whether this user is the same as the authenticated user for whom the request was made.
1969 &quot;kind&quot;: &quot;drive#user&quot;, # This is always drive#user.
1970 &quot;permissionId&quot;: &quot;A String&quot;, # The user&#x27;s ID as visible in the permissions collection.
1971 &quot;picture&quot;: { # The user&#x27;s profile picture.
1972 &quot;url&quot;: &quot;A String&quot;, # A URL that points to a profile picture of this user.
1973 },
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]1974 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]1975 ],
1976 &quot;parents&quot;: [ # Collection of parent folders which contain this file.
1977 # 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.
1978 { # A reference to a file&#x27;s parent.
1979 &quot;id&quot;: &quot;A String&quot;, # The ID of the parent.
1980 &quot;isRoot&quot;: True or False, # Whether or not the parent is the root folder.
1981 &quot;kind&quot;: &quot;drive#parentReference&quot;, # This is always drive#parentReference.
1982 &quot;parentLink&quot;: &quot;A String&quot;, # A link to the parent.
1983 &quot;selfLink&quot;: &quot;A String&quot;, # A link back to this reference.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1984 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]1985 ],
1986 &quot;permissionIds&quot;: [ # List of permission IDs for users with access to this file.
1987 &quot;A String&quot;,
1988 ],
1989 &quot;permissions&quot;: [ # The list of permissions for users with access to this file. Not populated for items in shared drives.
1990 { # A permission for a file.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1991 &quot;additionalRoles&quot;: [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future.
1992 &quot;A String&quot;,
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1993 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1994 &quot;authKey&quot;: &quot;A String&quot;, # Deprecated.
1995 &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.
1996 &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.
1997 &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.
1998 &quot;etag&quot;: &quot;A String&quot;, # The ETag of the permission.
1999 &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]2000 # - They cannot be set on shared drive items
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]2001 # - They can only be set on user and group permissions
2002 # - The date must be in the future
2003 # - The date cannot be more than a year in the future
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2004 # - 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]2005 &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.
2006 &quot;kind&quot;: &quot;drive#permission&quot;, # This is always drive#permission.
2007 &quot;name&quot;: &quot;A String&quot;, # The name for this permission.
yoshi-code-bot815c1ac2021-11-15 23:24:17 -0800[diff] [blame]2008 &quot;pendingOwner&quot;: True or False, # Whether the account associated with this permission is a pending owner. Only populated for user type permissions for files that are not in a shared drive.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]2009 &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.
2010 {
2011 &quot;additionalRoles&quot;: [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future.
2012 &quot;A String&quot;,
2013 ],
2014 &quot;inherited&quot;: True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field.
2015 &quot;inheritedFrom&quot;: &quot;A String&quot;, # The ID of the item from which this permission is inherited. This is an output-only field.
2016 &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:
2017 # - file
2018 # - member
2019 &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:
2020 # - organizer
2021 # - fileOrganizer
2022 # - writer
2023 # - reader
2024 },
2025 ],
2026 &quot;photoLink&quot;: &quot;A String&quot;, # A link to the profile photo, if available.
2027 &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]2028 # - owner
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2029 # - organizer
2030 # - fileOrganizer
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]2031 # - writer
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2032 # - reader
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]2033 &quot;selfLink&quot;: &quot;A String&quot;, # A link back to this permission.
2034 &quot;teamDrivePermissionDetails&quot;: [ # Deprecated - use permissionDetails instead.
2035 {
2036 &quot;additionalRoles&quot;: [ # Deprecated - use permissionDetails/additionalRoles instead.
2037 &quot;A String&quot;,
2038 ],
2039 &quot;inherited&quot;: True or False, # Deprecated - use permissionDetails/inherited instead.
2040 &quot;inheritedFrom&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/inheritedFrom instead.
2041 &quot;role&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/role instead.
2042 &quot;teamDrivePermissionType&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/permissionType instead.
2043 },
2044 ],
2045 &quot;type&quot;: &quot;A String&quot;, # The account type. Allowed values are:
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]2046 # - user
2047 # - group
2048 # - domain
2049 # - anyone
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]2050 &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]2051 &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]2052 &quot;withLink&quot;: True or False, # Whether the link is required for this permission.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]2053 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]2054 ],
2055 &quot;properties&quot;: [ # The list of properties.
2056 { # A key-value pair attached to a file that is either public or private to an application.
2057 # The following limits apply to file properties:
2058 # - Maximum of 100 properties total per file
2059 # - Maximum of 30 private properties per app
2060 # - Maximum of 30 public properties
2061 # - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property.
2062 &quot;etag&quot;: &quot;A String&quot;, # ETag of the property.
2063 &quot;key&quot;: &quot;A String&quot;, # The key of this property.
2064 &quot;kind&quot;: &quot;drive#property&quot;, # This is always drive#property.
2065 &quot;selfLink&quot;: &quot;A String&quot;, # The link back to this property.
2066 &quot;value&quot;: &quot;A String&quot;, # The value of this property.
yoshi-code-bot69706592021-03-03 03:54:02 -0800[diff] [blame]2067 &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]2068 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]2069 ],
2070 &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]2071 &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]2072 &quot;selfLink&quot;: &quot;A String&quot;, # A link back to this file.
2073 &quot;shareable&quot;: True or False, # Deprecated: use capabilities/canShare.
2074 &quot;shared&quot;: True or False, # Whether the file has been shared. Not populated for items in shared drives.
2075 &quot;sharedWithMeDate&quot;: &quot;A String&quot;, # Time at which this file was shared with the user (formatted RFC 3339 timestamp).
2076 &quot;sharingUser&quot;: { # Information about a Drive user. # User that shared the item with the current user, if available.
2077 &quot;displayName&quot;: &quot;A String&quot;, # A plain text displayable name for this user.
2078 &quot;emailAddress&quot;: &quot;A String&quot;, # The email address of the user.
2079 &quot;isAuthenticatedUser&quot;: True or False, # Whether this user is the same as the authenticated user for whom the request was made.
2080 &quot;kind&quot;: &quot;drive#user&quot;, # This is always drive#user.
2081 &quot;permissionId&quot;: &quot;A String&quot;, # The user&#x27;s ID as visible in the permissions collection.
2082 &quot;picture&quot;: { # The user&#x27;s profile picture.
2083 &quot;url&quot;: &quot;A String&quot;, # A URL that points to a profile picture of this user.
2084 },
2085 },
2086 &quot;shortcutDetails&quot;: { # Shortcut file details. Only populated for shortcut files, which have the mimeType field set to application/vnd.google-apps.shortcut.
2087 &quot;targetId&quot;: &quot;A String&quot;, # The ID of the file that this shortcut points to.
2088 &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]2089 &quot;targetResourceKey&quot;: &quot;A String&quot;, # The ResourceKey for the target file.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]2090 },
2091 &quot;spaces&quot;: [ # The list of spaces which contain the file. Supported values are &#x27;drive&#x27;, &#x27;appDataFolder&#x27; and &#x27;photos&#x27;.
2092 &quot;A String&quot;,
2093 ],
2094 &quot;teamDriveId&quot;: &quot;A String&quot;, # Deprecated - use driveId instead.
2095 &quot;thumbnail&quot;: { # A thumbnail for the file. This will only be used if a standard thumbnail cannot be generated.
2096 &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.
2097 &quot;mimeType&quot;: &quot;A String&quot;, # The MIME type of the thumbnail.
2098 },
2099 &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.
2100 &quot;thumbnailVersion&quot;: &quot;A String&quot;, # The thumbnail version for use in thumbnail cache invalidation.
2101 &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.
2102 &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.
2103 &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.
2104 &quot;displayName&quot;: &quot;A String&quot;, # A plain text displayable name for this user.
2105 &quot;emailAddress&quot;: &quot;A String&quot;, # The email address of the user.
2106 &quot;isAuthenticatedUser&quot;: True or False, # Whether this user is the same as the authenticated user for whom the request was made.
2107 &quot;kind&quot;: &quot;drive#user&quot;, # This is always drive#user.
2108 &quot;permissionId&quot;: &quot;A String&quot;, # The user&#x27;s ID as visible in the permissions collection.
2109 &quot;picture&quot;: { # The user&#x27;s profile picture.
2110 &quot;url&quot;: &quot;A String&quot;, # A URL that points to a profile picture of this user.
2111 },
2112 },
2113 &quot;userPermission&quot;: { # A permission for a file. # The permissions for the authenticated user on this file.
2114 &quot;additionalRoles&quot;: [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future.
2115 &quot;A String&quot;,
2116 ],
2117 &quot;authKey&quot;: &quot;A String&quot;, # Deprecated.
2118 &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.
2119 &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.
2120 &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.
2121 &quot;etag&quot;: &quot;A String&quot;, # The ETag of the permission.
2122 &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:
2123 # - They cannot be set on shared drive items
2124 # - They can only be set on user and group permissions
2125 # - The date must be in the future
2126 # - The date cannot be more than a year in the future
2127 # - The date can only be set on drive.permissions.update or drive.permissions.patch requests
2128 &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.
2129 &quot;kind&quot;: &quot;drive#permission&quot;, # This is always drive#permission.
2130 &quot;name&quot;: &quot;A String&quot;, # The name for this permission.
yoshi-code-bot815c1ac2021-11-15 23:24:17 -0800[diff] [blame]2131 &quot;pendingOwner&quot;: True or False, # Whether the account associated with this permission is a pending owner. Only populated for user type permissions for files that are not in a shared drive.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]2132 &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.
2133 {
2134 &quot;additionalRoles&quot;: [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future.
2135 &quot;A String&quot;,
2136 ],
2137 &quot;inherited&quot;: True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field.
2138 &quot;inheritedFrom&quot;: &quot;A String&quot;, # The ID of the item from which this permission is inherited. This is an output-only field.
2139 &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:
2140 # - file
2141 # - member
2142 &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:
2143 # - organizer
2144 # - fileOrganizer
2145 # - writer
2146 # - reader
2147 },
2148 ],
2149 &quot;photoLink&quot;: &quot;A String&quot;, # A link to the profile photo, if available.
2150 &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:
2151 # - owner
2152 # - organizer
2153 # - fileOrganizer
2154 # - writer
2155 # - reader
2156 &quot;selfLink&quot;: &quot;A String&quot;, # A link back to this permission.
2157 &quot;teamDrivePermissionDetails&quot;: [ # Deprecated - use permissionDetails instead.
2158 {
2159 &quot;additionalRoles&quot;: [ # Deprecated - use permissionDetails/additionalRoles instead.
2160 &quot;A String&quot;,
2161 ],
2162 &quot;inherited&quot;: True or False, # Deprecated - use permissionDetails/inherited instead.
2163 &quot;inheritedFrom&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/inheritedFrom instead.
2164 &quot;role&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/role instead.
2165 &quot;teamDrivePermissionType&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/permissionType instead.
2166 },
2167 ],
2168 &quot;type&quot;: &quot;A String&quot;, # The account type. Allowed values are:
2169 # - user
2170 # - group
2171 # - domain
2172 # - anyone
2173 &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.
2174 &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.
2175 &quot;withLink&quot;: True or False, # Whether the link is required for this permission.
2176 },
2177 &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.
2178 &quot;videoMediaMetadata&quot;: { # Metadata about video media. This will only be present for video types.
2179 &quot;durationMillis&quot;: &quot;A String&quot;, # The duration of the video in milliseconds.
2180 &quot;height&quot;: 42, # The height of the video in pixels.
2181 &quot;width&quot;: 42, # The width of the video in pixels.
2182 },
2183 &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.
2184 &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.
2185 &quot;writersCanShare&quot;: True or False, # Whether writers can share the document with other users. Not populated for items in shared drives.
2186}</pre>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]2187</div>
2188
2189<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]2190 <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]2191 <pre>Lists the user&#x27;s files.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]2192
2193Args:
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]2194 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]2195 corpus: string, The body of items (files/documents) to which the query applies. Deprecated: use &#x27;corpora&#x27; instead.
2196 Allowed values
2197 DEFAULT - The items that the user has accessed.
2198 DOMAIN - Items shared to the user&#x27;s domain.
2199 driveId: string, ID of the shared drive to search.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]2200 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]2201 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]2202 includeTeamDriveItems: boolean, Deprecated use includeItemsFromAllDrives instead.
2203 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.
2204 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.
2205 pageToken: string, Page token for files.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]2206 projection: string, This parameter is deprecated and has no function.
2207 Allowed values
2208 BASIC - Deprecated
2209 FULL - Deprecated
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2210 q: string, Query string for searching files.
yoshi-code-botb539cc42021-08-03 00:20:27 -0700[diff] [blame]2211 spaces: string, A comma-separated list of spaces to query. Supported values are &#x27;drive&#x27; and &#x27;appDataFolder&#x27;.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]2212 supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]2213 supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead.
2214 teamDriveId: string, Deprecated use driveId instead.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]2215
2216Returns:
2217 An object of the form:
2218
2219 { # A list of files.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]2220 &quot;etag&quot;: &quot;A String&quot;, # The ETag of the list.
2221 &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;.
2222 &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.
2223 { # The metadata for a file.
2224 &quot;alternateLink&quot;: &quot;A String&quot;, # A link for opening the file in a relevant Google editor or viewer.
2225 &quot;appDataContents&quot;: True or False, # Whether this file is in the Application Data folder.
2226 &quot;canComment&quot;: True or False, # Deprecated: use capabilities/canComment.
2227 &quot;canReadRevisions&quot;: True or False, # Deprecated: use capabilities/canReadRevisions.
2228 &quot;capabilities&quot;: { # Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take.
yoshi-code-bot815c1ac2021-11-15 23:24:17 -0800[diff] [blame]2229 &quot;canAcceptOwnership&quot;: True or False, # Whether the current user is the pending owner of the file. Not populated for shared drive files.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]2230 &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.
2231 &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.
2232 &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.
2233 &quot;canChangeCopyRequiresWriterPermission&quot;: True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this file.
2234 &quot;canChangeRestrictedDownload&quot;: True or False, # Deprecated
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700[diff] [blame]2235 &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]2236 &quot;canComment&quot;: True or False, # Whether the current user can comment on this file.
2237 &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.
2238 &quot;canDelete&quot;: True or False, # Whether the current user can delete this file.
2239 &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.
2240 &quot;canDownload&quot;: True or False, # Whether the current user can download this file.
2241 &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.
2242 &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.
2243 &quot;canModifyContent&quot;: True or False, # Whether the current user can modify the content of this file.
2244 &quot;canModifyContentRestriction&quot;: True or False, # Whether the current user can modify restrictions on content of this file.
2245 &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.
2246 &quot;canMoveChildrenOutOfTeamDrive&quot;: True or False, # Deprecated - use canMoveChildrenOutOfDrive instead.
2247 &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.
2248 &quot;canMoveChildrenWithinTeamDrive&quot;: True or False, # Deprecated - use canMoveChildrenWithinDrive instead.
2249 &quot;canMoveItemIntoTeamDrive&quot;: True or False, # Deprecated - use canMoveItemOutOfDrive instead.
2250 &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.
2251 &quot;canMoveItemOutOfTeamDrive&quot;: True or False, # Deprecated - use canMoveItemOutOfDrive instead.
2252 &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.
2253 &quot;canMoveItemWithinTeamDrive&quot;: True or False, # Deprecated - use canMoveItemWithinDrive instead.
2254 &quot;canMoveTeamDriveItem&quot;: True or False, # Deprecated - use canMoveItemWithinDrive or canMoveItemOutOfDrive instead.
2255 &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.
2256 &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.
2257 &quot;canReadTeamDrive&quot;: True or False, # Deprecated - use canReadDrive instead.
2258 &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.
2259 &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.
2260 &quot;canRename&quot;: True or False, # Whether the current user can rename this file.
2261 &quot;canShare&quot;: True or False, # Whether the current user can modify the sharing settings for this file.
2262 &quot;canTrash&quot;: True or False, # Whether the current user can move this file to trash.
2263 &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.
2264 &quot;canUntrash&quot;: True or False, # Whether the current user can restore this file from trash.
2265 },
2266 &quot;contentRestrictions&quot;: [ # Restrictions for accessing the content of the file. Only populated if such a restriction exists.
2267 { # A restriction for accessing the content of the file.
2268 &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.
2269 &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.
2270 &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]2271 &quot;displayName&quot;: &quot;A String&quot;, # A plain text displayable name for this user.
2272 &quot;emailAddress&quot;: &quot;A String&quot;, # The email address of the user.
2273 &quot;isAuthenticatedUser&quot;: True or False, # Whether this user is the same as the authenticated user for whom the request was made.
2274 &quot;kind&quot;: &quot;drive#user&quot;, # This is always drive#user.
2275 &quot;permissionId&quot;: &quot;A String&quot;, # The user&#x27;s ID as visible in the permissions collection.
2276 &quot;picture&quot;: { # The user&#x27;s profile picture.
2277 &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]2278 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]2279 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]2280 &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.
2281 &quot;type&quot;: &quot;A String&quot;, # The type of the content restriction. Currently the only possible value is globalContentRestriction.
2282 },
2283 ],
2284 &quot;copyRequiresWriterPermission&quot;: True or False, # Whether the options to copy, print, or download this file, should be disabled for readers and commenters.
2285 &quot;copyable&quot;: True or False, # Deprecated: use capabilities/canCopy.
2286 &quot;createdDate&quot;: &quot;A String&quot;, # Create time for this file (formatted RFC 3339 timestamp).
2287 &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.
2288 &quot;description&quot;: &quot;A String&quot;, # A short description of the file.
2289 &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.
2290 &quot;driveId&quot;: &quot;A String&quot;, # ID of the shared drive the file resides in. Only populated for items in shared drives.
2291 &quot;editable&quot;: True or False, # Deprecated: use capabilities/canEdit.
2292 &quot;embedLink&quot;: &quot;A String&quot;, # A link for embedding the file.
2293 &quot;etag&quot;: &quot;A String&quot;, # ETag of the file.
2294 &quot;explicitlyTrashed&quot;: True or False, # Whether this file has been explicitly trashed, as opposed to recursively trashed.
2295 &quot;exportLinks&quot;: { # Links for exporting Docs Editors files to specific formats.
2296 &quot;a_key&quot;: &quot;A String&quot;, # A mapping from export format to URL
2297 },
2298 &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.
2299 &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.
yoshi-code-botb539cc42021-08-03 00:20:27 -0700[diff] [blame]2300 &quot;folderColorRgb&quot;: &quot;A String&quot;, # Folder color as an RGB hex string if the file is a folder or a shortcut to 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.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]2301 &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.
2302 &quot;hasAugmentedPermissions&quot;: True or False, # Whether there are permissions directly on this file. This field is only populated for items in shared drives.
2303 &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.
2304 &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.
2305 &quot;iconLink&quot;: &quot;A String&quot;, # A link to the file&#x27;s icon.
2306 &quot;id&quot;: &quot;A String&quot;, # The ID of the file.
2307 &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.
2308 &quot;aperture&quot;: 3.14, # The aperture used to create the photo (f-number).
2309 &quot;cameraMake&quot;: &quot;A String&quot;, # The make of the camera used to create the photo.
2310 &quot;cameraModel&quot;: &quot;A String&quot;, # The model of the camera used to create the photo.
2311 &quot;colorSpace&quot;: &quot;A String&quot;, # The color space of the photo.
2312 &quot;date&quot;: &quot;A String&quot;, # The date and time the photo was taken (EXIF format timestamp).
2313 &quot;exposureBias&quot;: 3.14, # The exposure bias of the photo (APEX value).
2314 &quot;exposureMode&quot;: &quot;A String&quot;, # The exposure mode used to create the photo.
2315 &quot;exposureTime&quot;: 3.14, # The length of the exposure, in seconds.
2316 &quot;flashUsed&quot;: True or False, # Whether a flash was used to create the photo.
2317 &quot;focalLength&quot;: 3.14, # The focal length used to create the photo, in millimeters.
2318 &quot;height&quot;: 42, # The height of the image in pixels.
2319 &quot;isoSpeed&quot;: 42, # The ISO speed used to create the photo.
2320 &quot;lens&quot;: &quot;A String&quot;, # The lens used to create the photo.
2321 &quot;location&quot;: { # Geographic location information stored in the image.
2322 &quot;altitude&quot;: 3.14, # The altitude stored in the image.
2323 &quot;latitude&quot;: 3.14, # The latitude stored in the image.
2324 &quot;longitude&quot;: 3.14, # The longitude stored in the image.
2325 },
2326 &quot;maxApertureValue&quot;: 3.14, # The smallest f-number of the lens at the focal length used to create the photo (APEX value).
2327 &quot;meteringMode&quot;: &quot;A String&quot;, # The metering mode used to create the photo.
2328 &quot;rotation&quot;: 42, # The number of clockwise 90 degree rotations applied from the image&#x27;s original orientation.
2329 &quot;sensor&quot;: &quot;A String&quot;, # The type of sensor used to create the photo.
2330 &quot;subjectDistance&quot;: 42, # The distance to the subject of the photo, in meters.
2331 &quot;whiteBalance&quot;: &quot;A String&quot;, # The white balance mode used to create the photo.
2332 &quot;width&quot;: 42, # The width of the image in pixels.
2333 },
2334 &quot;indexableText&quot;: { # Indexable text attributes for the file (can only be written)
2335 &quot;text&quot;: &quot;A String&quot;, # The text to be indexed for this file.
2336 },
2337 &quot;isAppAuthorized&quot;: True or False, # Whether the file was created or opened by the requesting app.
2338 &quot;kind&quot;: &quot;drive#file&quot;, # The type of file. This is always drive#file.
2339 &quot;labels&quot;: { # A group of labels for the file.
2340 &quot;hidden&quot;: True or False, # Deprecated.
2341 &quot;modified&quot;: True or False, # Whether the file has been modified by this user.
2342 &quot;restricted&quot;: True or False, # Deprecated - use copyRequiresWriterPermission instead.
2343 &quot;starred&quot;: True or False, # Whether this file is starred by the user.
2344 &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.
2345 &quot;viewed&quot;: True or False, # Whether this file has been viewed by this user.
2346 },
2347 &quot;lastModifyingUser&quot;: { # Information about a Drive user. # The last user to modify this file.
2348 &quot;displayName&quot;: &quot;A String&quot;, # A plain text displayable name for this user.
2349 &quot;emailAddress&quot;: &quot;A String&quot;, # The email address of the user.
2350 &quot;isAuthenticatedUser&quot;: True or False, # Whether this user is the same as the authenticated user for whom the request was made.
2351 &quot;kind&quot;: &quot;drive#user&quot;, # This is always drive#user.
2352 &quot;permissionId&quot;: &quot;A String&quot;, # The user&#x27;s ID as visible in the permissions collection.
2353 &quot;picture&quot;: { # The user&#x27;s profile picture.
2354 &quot;url&quot;: &quot;A String&quot;, # A URL that points to a profile picture of this user.
2355 },
2356 },
2357 &quot;lastModifyingUserName&quot;: &quot;A String&quot;, # Name of the last user to modify this file.
2358 &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]2359 &quot;linkShareMetadata&quot;: { # Contains details about the link URLs that clients are using to refer to this item.
2360 &quot;securityUpdateEligible&quot;: True or False, # Whether the file is eligible for security update.
2361 &quot;securityUpdateEnabled&quot;: True or False, # Whether the security update is enabled for this file.
2362 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]2363 &quot;markedViewedByMeDate&quot;: &quot;A String&quot;, # Deprecated.
2364 &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.
2365 &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.
2366 &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.
2367 &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.
2368 &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.
2369 &quot;a_key&quot;: &quot;A String&quot;,
2370 },
2371 &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.
2372 &quot;ownedByMe&quot;: True or False, # Whether the file is owned by the current user. Not populated for items in shared drives.
2373 &quot;ownerNames&quot;: [ # Name(s) of the owner(s) of this file. Not populated for items in shared drives.
2374 &quot;A String&quot;,
2375 ],
yoshi-code-botab1d6dc2021-05-28 00:42:02 -0700[diff] [blame]2376 &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]2377 { # Information about a Drive user.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]2378 &quot;displayName&quot;: &quot;A String&quot;, # A plain text displayable name for this user.
2379 &quot;emailAddress&quot;: &quot;A String&quot;, # The email address of the user.
2380 &quot;isAuthenticatedUser&quot;: True or False, # Whether this user is the same as the authenticated user for whom the request was made.
2381 &quot;kind&quot;: &quot;drive#user&quot;, # This is always drive#user.
2382 &quot;permissionId&quot;: &quot;A String&quot;, # The user&#x27;s ID as visible in the permissions collection.
2383 &quot;picture&quot;: { # The user&#x27;s profile picture.
2384 &quot;url&quot;: &quot;A String&quot;, # A URL that points to a profile picture of this user.
2385 },
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]2386 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]2387 ],
2388 &quot;parents&quot;: [ # Collection of parent folders which contain this file.
2389 # 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.
2390 { # A reference to a file&#x27;s parent.
2391 &quot;id&quot;: &quot;A String&quot;, # The ID of the parent.
2392 &quot;isRoot&quot;: True or False, # Whether or not the parent is the root folder.
2393 &quot;kind&quot;: &quot;drive#parentReference&quot;, # This is always drive#parentReference.
2394 &quot;parentLink&quot;: &quot;A String&quot;, # A link to the parent.
2395 &quot;selfLink&quot;: &quot;A String&quot;, # A link back to this reference.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]2396 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]2397 ],
2398 &quot;permissionIds&quot;: [ # List of permission IDs for users with access to this file.
2399 &quot;A String&quot;,
2400 ],
2401 &quot;permissions&quot;: [ # The list of permissions for users with access to this file. Not populated for items in shared drives.
2402 { # A permission for a file.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]2403 &quot;additionalRoles&quot;: [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future.
2404 &quot;A String&quot;,
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]2405 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]2406 &quot;authKey&quot;: &quot;A String&quot;, # Deprecated.
2407 &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.
2408 &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.
2409 &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.
2410 &quot;etag&quot;: &quot;A String&quot;, # The ETag of the permission.
2411 &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]2412 # - They cannot be set on shared drive items
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]2413 # - They can only be set on user and group permissions
2414 # - The date must be in the future
2415 # - The date cannot be more than a year in the future
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2416 # - 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]2417 &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.
2418 &quot;kind&quot;: &quot;drive#permission&quot;, # This is always drive#permission.
2419 &quot;name&quot;: &quot;A String&quot;, # The name for this permission.
yoshi-code-bot815c1ac2021-11-15 23:24:17 -0800[diff] [blame]2420 &quot;pendingOwner&quot;: True or False, # Whether the account associated with this permission is a pending owner. Only populated for user type permissions for files that are not in a shared drive.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]2421 &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.
2422 {
2423 &quot;additionalRoles&quot;: [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future.
2424 &quot;A String&quot;,
2425 ],
2426 &quot;inherited&quot;: True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field.
2427 &quot;inheritedFrom&quot;: &quot;A String&quot;, # The ID of the item from which this permission is inherited. This is an output-only field.
2428 &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:
2429 # - file
2430 # - member
2431 &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:
2432 # - organizer
2433 # - fileOrganizer
2434 # - writer
2435 # - reader
2436 },
2437 ],
2438 &quot;photoLink&quot;: &quot;A String&quot;, # A link to the profile photo, if available.
2439 &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]2440 # - owner
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2441 # - organizer
2442 # - fileOrganizer
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]2443 # - writer
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2444 # - reader
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]2445 &quot;selfLink&quot;: &quot;A String&quot;, # A link back to this permission.
2446 &quot;teamDrivePermissionDetails&quot;: [ # Deprecated - use permissionDetails instead.
2447 {
2448 &quot;additionalRoles&quot;: [ # Deprecated - use permissionDetails/additionalRoles instead.
2449 &quot;A String&quot;,
2450 ],
2451 &quot;inherited&quot;: True or False, # Deprecated - use permissionDetails/inherited instead.
2452 &quot;inheritedFrom&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/inheritedFrom instead.
2453 &quot;role&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/role instead.
2454 &quot;teamDrivePermissionType&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/permissionType instead.
2455 },
2456 ],
2457 &quot;type&quot;: &quot;A String&quot;, # The account type. Allowed values are:
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]2458 # - user
2459 # - group
2460 # - domain
2461 # - anyone
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]2462 &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]2463 &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]2464 &quot;withLink&quot;: True or False, # Whether the link is required for this permission.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]2465 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]2466 ],
2467 &quot;properties&quot;: [ # The list of properties.
2468 { # A key-value pair attached to a file that is either public or private to an application.
2469 # The following limits apply to file properties:
2470 # - Maximum of 100 properties total per file
2471 # - Maximum of 30 private properties per app
2472 # - Maximum of 30 public properties
2473 # - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property.
2474 &quot;etag&quot;: &quot;A String&quot;, # ETag of the property.
2475 &quot;key&quot;: &quot;A String&quot;, # The key of this property.
2476 &quot;kind&quot;: &quot;drive#property&quot;, # This is always drive#property.
2477 &quot;selfLink&quot;: &quot;A String&quot;, # The link back to this property.
2478 &quot;value&quot;: &quot;A String&quot;, # The value of this property.
yoshi-code-bot69706592021-03-03 03:54:02 -0800[diff] [blame]2479 &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]2480 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]2481 ],
2482 &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]2483 &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]2484 &quot;selfLink&quot;: &quot;A String&quot;, # A link back to this file.
2485 &quot;shareable&quot;: True or False, # Deprecated: use capabilities/canShare.
2486 &quot;shared&quot;: True or False, # Whether the file has been shared. Not populated for items in shared drives.
2487 &quot;sharedWithMeDate&quot;: &quot;A String&quot;, # Time at which this file was shared with the user (formatted RFC 3339 timestamp).
2488 &quot;sharingUser&quot;: { # Information about a Drive user. # User that shared the item with the current user, if available.
2489 &quot;displayName&quot;: &quot;A String&quot;, # A plain text displayable name for this user.
2490 &quot;emailAddress&quot;: &quot;A String&quot;, # The email address of the user.
2491 &quot;isAuthenticatedUser&quot;: True or False, # Whether this user is the same as the authenticated user for whom the request was made.
2492 &quot;kind&quot;: &quot;drive#user&quot;, # This is always drive#user.
2493 &quot;permissionId&quot;: &quot;A String&quot;, # The user&#x27;s ID as visible in the permissions collection.
2494 &quot;picture&quot;: { # The user&#x27;s profile picture.
2495 &quot;url&quot;: &quot;A String&quot;, # A URL that points to a profile picture of this user.
2496 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]2497 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]2498 &quot;shortcutDetails&quot;: { # Shortcut file details. Only populated for shortcut files, which have the mimeType field set to application/vnd.google-apps.shortcut.
2499 &quot;targetId&quot;: &quot;A String&quot;, # The ID of the file that this shortcut points to.
2500 &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]2501 &quot;targetResourceKey&quot;: &quot;A String&quot;, # The ResourceKey for the target file.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]2502 },
2503 &quot;spaces&quot;: [ # The list of spaces which contain the file. Supported values are &#x27;drive&#x27;, &#x27;appDataFolder&#x27; and &#x27;photos&#x27;.
2504 &quot;A String&quot;,
2505 ],
2506 &quot;teamDriveId&quot;: &quot;A String&quot;, # Deprecated - use driveId instead.
2507 &quot;thumbnail&quot;: { # A thumbnail for the file. This will only be used if a standard thumbnail cannot be generated.
2508 &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.
2509 &quot;mimeType&quot;: &quot;A String&quot;, # The MIME type of the thumbnail.
2510 },
2511 &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.
2512 &quot;thumbnailVersion&quot;: &quot;A String&quot;, # The thumbnail version for use in thumbnail cache invalidation.
2513 &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.
2514 &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.
2515 &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.
2516 &quot;displayName&quot;: &quot;A String&quot;, # A plain text displayable name for this user.
2517 &quot;emailAddress&quot;: &quot;A String&quot;, # The email address of the user.
2518 &quot;isAuthenticatedUser&quot;: True or False, # Whether this user is the same as the authenticated user for whom the request was made.
2519 &quot;kind&quot;: &quot;drive#user&quot;, # This is always drive#user.
2520 &quot;permissionId&quot;: &quot;A String&quot;, # The user&#x27;s ID as visible in the permissions collection.
2521 &quot;picture&quot;: { # The user&#x27;s profile picture.
2522 &quot;url&quot;: &quot;A String&quot;, # A URL that points to a profile picture of this user.
2523 },
2524 },
2525 &quot;userPermission&quot;: { # A permission for a file. # The permissions for the authenticated user on this file.
2526 &quot;additionalRoles&quot;: [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future.
2527 &quot;A String&quot;,
2528 ],
2529 &quot;authKey&quot;: &quot;A String&quot;, # Deprecated.
2530 &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.
2531 &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.
2532 &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.
2533 &quot;etag&quot;: &quot;A String&quot;, # The ETag of the permission.
2534 &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:
2535 # - They cannot be set on shared drive items
2536 # - They can only be set on user and group permissions
2537 # - The date must be in the future
2538 # - The date cannot be more than a year in the future
2539 # - The date can only be set on drive.permissions.update or drive.permissions.patch requests
2540 &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.
2541 &quot;kind&quot;: &quot;drive#permission&quot;, # This is always drive#permission.
2542 &quot;name&quot;: &quot;A String&quot;, # The name for this permission.
yoshi-code-bot815c1ac2021-11-15 23:24:17 -0800[diff] [blame]2543 &quot;pendingOwner&quot;: True or False, # Whether the account associated with this permission is a pending owner. Only populated for user type permissions for files that are not in a shared drive.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]2544 &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.
2545 {
2546 &quot;additionalRoles&quot;: [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future.
2547 &quot;A String&quot;,
2548 ],
2549 &quot;inherited&quot;: True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field.
2550 &quot;inheritedFrom&quot;: &quot;A String&quot;, # The ID of the item from which this permission is inherited. This is an output-only field.
2551 &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:
2552 # - file
2553 # - member
2554 &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:
2555 # - organizer
2556 # - fileOrganizer
2557 # - writer
2558 # - reader
2559 },
2560 ],
2561 &quot;photoLink&quot;: &quot;A String&quot;, # A link to the profile photo, if available.
2562 &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:
2563 # - owner
2564 # - organizer
2565 # - fileOrganizer
2566 # - writer
2567 # - reader
2568 &quot;selfLink&quot;: &quot;A String&quot;, # A link back to this permission.
2569 &quot;teamDrivePermissionDetails&quot;: [ # Deprecated - use permissionDetails instead.
2570 {
2571 &quot;additionalRoles&quot;: [ # Deprecated - use permissionDetails/additionalRoles instead.
2572 &quot;A String&quot;,
2573 ],
2574 &quot;inherited&quot;: True or False, # Deprecated - use permissionDetails/inherited instead.
2575 &quot;inheritedFrom&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/inheritedFrom instead.
2576 &quot;role&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/role instead.
2577 &quot;teamDrivePermissionType&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/permissionType instead.
2578 },
2579 ],
2580 &quot;type&quot;: &quot;A String&quot;, # The account type. Allowed values are:
2581 # - user
2582 # - group
2583 # - domain
2584 # - anyone
2585 &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.
2586 &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.
2587 &quot;withLink&quot;: True or False, # Whether the link is required for this permission.
2588 },
2589 &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.
2590 &quot;videoMediaMetadata&quot;: { # Metadata about video media. This will only be present for video types.
2591 &quot;durationMillis&quot;: &quot;A String&quot;, # The duration of the video in milliseconds.
2592 &quot;height&quot;: 42, # The height of the video in pixels.
2593 &quot;width&quot;: 42, # The width of the video in pixels.
2594 },
2595 &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.
2596 &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.
2597 &quot;writersCanShare&quot;: True or False, # Whether writers can share the document with other users. Not populated for items in shared drives.
2598 },
2599 ],
2600 &quot;kind&quot;: &quot;drive#fileList&quot;, # This is always drive#fileList.
2601 &quot;nextLink&quot;: &quot;A String&quot;, # A link to the next page of files.
2602 &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.
2603 &quot;selfLink&quot;: &quot;A String&quot;, # A link back to this list.
2604}</pre>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]2605</div>
2606
2607<div class="method">
2608 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
2609 <pre>Retrieves the next page of results.
2610
2611Args:
2612 previous_request: The request for the previous page. (required)
2613 previous_response: The response from the request for the previous page. (required)
2614
2615Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]2616 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]2617 page. Returns None if there are no more items in the collection.
2618 </pre>
2619</div>
2620
2621<div class="method">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]2622 <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>
yoshi-code-bot278a4902021-12-14 03:32:50 -0800[diff] [blame]2623 <pre>Updates a file&#x27;s metadata and/or content. When calling this method, only populate fields in the request that you want to modify. When updating fields, some fields might change automatically, such as modifiedDate. This method supports patch semantics.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]2624
2625Args:
2626 fileId: string, The ID of the file to update. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]2627 body: object, The request body.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]2628 The object takes the form of:
2629
2630{ # The metadata for a file.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]2631 &quot;alternateLink&quot;: &quot;A String&quot;, # A link for opening the file in a relevant Google editor or viewer.
2632 &quot;appDataContents&quot;: True or False, # Whether this file is in the Application Data folder.
2633 &quot;canComment&quot;: True or False, # Deprecated: use capabilities/canComment.
2634 &quot;canReadRevisions&quot;: True or False, # Deprecated: use capabilities/canReadRevisions.
2635 &quot;capabilities&quot;: { # Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take.
yoshi-code-bot815c1ac2021-11-15 23:24:17 -0800[diff] [blame]2636 &quot;canAcceptOwnership&quot;: True or False, # Whether the current user is the pending owner of the file. Not populated for shared drive files.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]2637 &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]2638 &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]2639 &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.
2640 &quot;canChangeCopyRequiresWriterPermission&quot;: True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this file.
2641 &quot;canChangeRestrictedDownload&quot;: True or False, # Deprecated
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700[diff] [blame]2642 &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]2643 &quot;canComment&quot;: True or False, # Whether the current user can comment on this file.
2644 &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.
2645 &quot;canDelete&quot;: True or False, # Whether the current user can delete this file.
2646 &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.
2647 &quot;canDownload&quot;: True or False, # Whether the current user can download this file.
2648 &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.
2649 &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.
2650 &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]2651 &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]2652 &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.
2653 &quot;canMoveChildrenOutOfTeamDrive&quot;: True or False, # Deprecated - use canMoveChildrenOutOfDrive instead.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]2654 &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]2655 &quot;canMoveChildrenWithinTeamDrive&quot;: True or False, # Deprecated - use canMoveChildrenWithinDrive instead.
2656 &quot;canMoveItemIntoTeamDrive&quot;: True or False, # Deprecated - use canMoveItemOutOfDrive instead.
2657 &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.
2658 &quot;canMoveItemOutOfTeamDrive&quot;: True or False, # Deprecated - use canMoveItemOutOfDrive instead.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]2659 &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]2660 &quot;canMoveItemWithinTeamDrive&quot;: True or False, # Deprecated - use canMoveItemWithinDrive instead.
2661 &quot;canMoveTeamDriveItem&quot;: True or False, # Deprecated - use canMoveItemWithinDrive or canMoveItemOutOfDrive instead.
2662 &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.
2663 &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.
2664 &quot;canReadTeamDrive&quot;: True or False, # Deprecated - use canReadDrive instead.
2665 &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.
2666 &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.
2667 &quot;canRename&quot;: True or False, # Whether the current user can rename this file.
2668 &quot;canShare&quot;: True or False, # Whether the current user can modify the sharing settings for this file.
2669 &quot;canTrash&quot;: True or False, # Whether the current user can move this file to trash.
2670 &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.
2671 &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]2672 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]2673 &quot;contentRestrictions&quot;: [ # Restrictions for accessing the content of the file. Only populated if such a restriction exists.
2674 { # A restriction for accessing the content of the file.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]2675 &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]2676 &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.
2677 &quot;restrictingUser&quot;: { # Information about a Drive user. # The user who set the content restriction. Only populated if readOnly is true.
2678 &quot;displayName&quot;: &quot;A String&quot;, # A plain text displayable name for this user.
2679 &quot;emailAddress&quot;: &quot;A String&quot;, # The email address of the user.
2680 &quot;isAuthenticatedUser&quot;: True or False, # Whether this user is the same as the authenticated user for whom the request was made.
2681 &quot;kind&quot;: &quot;drive#user&quot;, # This is always drive#user.
2682 &quot;permissionId&quot;: &quot;A String&quot;, # The user&#x27;s ID as visible in the permissions collection.
2683 &quot;picture&quot;: { # The user&#x27;s profile picture.
2684 &quot;url&quot;: &quot;A String&quot;, # A URL that points to a profile picture of this user.
2685 },
2686 },
2687 &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.
2688 &quot;type&quot;: &quot;A String&quot;, # The type of the content restriction. Currently the only possible value is globalContentRestriction.
2689 },
2690 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]2691 &quot;copyRequiresWriterPermission&quot;: True or False, # Whether the options to copy, print, or download this file, should be disabled for readers and commenters.
2692 &quot;copyable&quot;: True or False, # Deprecated: use capabilities/canCopy.
2693 &quot;createdDate&quot;: &quot;A String&quot;, # Create time for this file (formatted RFC 3339 timestamp).
2694 &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.
2695 &quot;description&quot;: &quot;A String&quot;, # A short description of the file.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]2696 &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]2697 &quot;driveId&quot;: &quot;A String&quot;, # ID of the shared drive the file resides in. Only populated for items in shared drives.
2698 &quot;editable&quot;: True or False, # Deprecated: use capabilities/canEdit.
2699 &quot;embedLink&quot;: &quot;A String&quot;, # A link for embedding the file.
2700 &quot;etag&quot;: &quot;A String&quot;, # ETag of the file.
2701 &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]2702 &quot;exportLinks&quot;: { # Links for exporting Docs Editors files to specific formats.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]2703 &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]2704 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]2705 &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.
2706 &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.
yoshi-code-botb539cc42021-08-03 00:20:27 -0700[diff] [blame]2707 &quot;folderColorRgb&quot;: &quot;A String&quot;, # Folder color as an RGB hex string if the file is a folder or a shortcut to 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.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]2708 &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]2709 &quot;hasAugmentedPermissions&quot;: True or False, # Whether there are permissions directly on this file. This field is only populated for items in shared drives.
2710 &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]2711 &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]2712 &quot;iconLink&quot;: &quot;A String&quot;, # A link to the file&#x27;s icon.
2713 &quot;id&quot;: &quot;A String&quot;, # The ID of the file.
2714 &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.
2715 &quot;aperture&quot;: 3.14, # The aperture used to create the photo (f-number).
2716 &quot;cameraMake&quot;: &quot;A String&quot;, # The make of the camera used to create the photo.
2717 &quot;cameraModel&quot;: &quot;A String&quot;, # The model of the camera used to create the photo.
2718 &quot;colorSpace&quot;: &quot;A String&quot;, # The color space of the photo.
2719 &quot;date&quot;: &quot;A String&quot;, # The date and time the photo was taken (EXIF format timestamp).
2720 &quot;exposureBias&quot;: 3.14, # The exposure bias of the photo (APEX value).
2721 &quot;exposureMode&quot;: &quot;A String&quot;, # The exposure mode used to create the photo.
2722 &quot;exposureTime&quot;: 3.14, # The length of the exposure, in seconds.
2723 &quot;flashUsed&quot;: True or False, # Whether a flash was used to create the photo.
2724 &quot;focalLength&quot;: 3.14, # The focal length used to create the photo, in millimeters.
2725 &quot;height&quot;: 42, # The height of the image in pixels.
2726 &quot;isoSpeed&quot;: 42, # The ISO speed used to create the photo.
2727 &quot;lens&quot;: &quot;A String&quot;, # The lens used to create the photo.
2728 &quot;location&quot;: { # Geographic location information stored in the image.
2729 &quot;altitude&quot;: 3.14, # The altitude stored in the image.
2730 &quot;latitude&quot;: 3.14, # The latitude stored in the image.
2731 &quot;longitude&quot;: 3.14, # The longitude stored in the image.
2732 },
2733 &quot;maxApertureValue&quot;: 3.14, # The smallest f-number of the lens at the focal length used to create the photo (APEX value).
2734 &quot;meteringMode&quot;: &quot;A String&quot;, # The metering mode used to create the photo.
2735 &quot;rotation&quot;: 42, # The number of clockwise 90 degree rotations applied from the image&#x27;s original orientation.
2736 &quot;sensor&quot;: &quot;A String&quot;, # The type of sensor used to create the photo.
2737 &quot;subjectDistance&quot;: 42, # The distance to the subject of the photo, in meters.
2738 &quot;whiteBalance&quot;: &quot;A String&quot;, # The white balance mode used to create the photo.
2739 &quot;width&quot;: 42, # The width of the image in pixels.
2740 },
2741 &quot;indexableText&quot;: { # Indexable text attributes for the file (can only be written)
2742 &quot;text&quot;: &quot;A String&quot;, # The text to be indexed for this file.
2743 },
2744 &quot;isAppAuthorized&quot;: True or False, # Whether the file was created or opened by the requesting app.
2745 &quot;kind&quot;: &quot;drive#file&quot;, # The type of file. This is always drive#file.
2746 &quot;labels&quot;: { # A group of labels for the file.
2747 &quot;hidden&quot;: True or False, # Deprecated.
2748 &quot;modified&quot;: True or False, # Whether the file has been modified by this user.
2749 &quot;restricted&quot;: True or False, # Deprecated - use copyRequiresWriterPermission instead.
2750 &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]2751 &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]2752 &quot;viewed&quot;: True or False, # Whether this file has been viewed by this user.
2753 },
2754 &quot;lastModifyingUser&quot;: { # Information about a Drive user. # The last user to modify this file.
2755 &quot;displayName&quot;: &quot;A String&quot;, # A plain text displayable name for this user.
2756 &quot;emailAddress&quot;: &quot;A String&quot;, # The email address of the user.
2757 &quot;isAuthenticatedUser&quot;: True or False, # Whether this user is the same as the authenticated user for whom the request was made.
2758 &quot;kind&quot;: &quot;drive#user&quot;, # This is always drive#user.
2759 &quot;permissionId&quot;: &quot;A String&quot;, # The user&#x27;s ID as visible in the permissions collection.
2760 &quot;picture&quot;: { # The user&#x27;s profile picture.
2761 &quot;url&quot;: &quot;A String&quot;, # A URL that points to a profile picture of this user.
2762 },
2763 },
2764 &quot;lastModifyingUserName&quot;: &quot;A String&quot;, # Name of the last user to modify this file.
2765 &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]2766 &quot;linkShareMetadata&quot;: { # Contains details about the link URLs that clients are using to refer to this item.
2767 &quot;securityUpdateEligible&quot;: True or False, # Whether the file is eligible for security update.
2768 &quot;securityUpdateEnabled&quot;: True or False, # Whether the security update is enabled for this file.
2769 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]2770 &quot;markedViewedByMeDate&quot;: &quot;A String&quot;, # Deprecated.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]2771 &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]2772 &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.
2773 &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.
2774 &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.
2775 &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.
2776 &quot;a_key&quot;: &quot;A String&quot;,
2777 },
2778 &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.
2779 &quot;ownedByMe&quot;: True or False, # Whether the file is owned by the current user. Not populated for items in shared drives.
2780 &quot;ownerNames&quot;: [ # Name(s) of the owner(s) of this file. Not populated for items in shared drives.
2781 &quot;A String&quot;,
2782 ],
yoshi-code-botab1d6dc2021-05-28 00:42:02 -0700[diff] [blame]2783 &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]2784 { # Information about a Drive user.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]2785 &quot;displayName&quot;: &quot;A String&quot;, # A plain text displayable name for this user.
2786 &quot;emailAddress&quot;: &quot;A String&quot;, # The email address of the user.
2787 &quot;isAuthenticatedUser&quot;: True or False, # Whether this user is the same as the authenticated user for whom the request was made.
2788 &quot;kind&quot;: &quot;drive#user&quot;, # This is always drive#user.
2789 &quot;permissionId&quot;: &quot;A String&quot;, # The user&#x27;s ID as visible in the permissions collection.
2790 &quot;picture&quot;: { # The user&#x27;s profile picture.
2791 &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]2792 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]2793 },
2794 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]2795 &quot;parents&quot;: [ # Collection of parent folders which contain this file.
2796 # 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.
2797 { # A reference to a file&#x27;s parent.
2798 &quot;id&quot;: &quot;A String&quot;, # The ID of the parent.
2799 &quot;isRoot&quot;: True or False, # Whether or not the parent is the root folder.
2800 &quot;kind&quot;: &quot;drive#parentReference&quot;, # This is always drive#parentReference.
2801 &quot;parentLink&quot;: &quot;A String&quot;, # A link to the parent.
2802 &quot;selfLink&quot;: &quot;A String&quot;, # A link back to this reference.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]2803 },
2804 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]2805 &quot;permissionIds&quot;: [ # List of permission IDs for users with access to this file.
2806 &quot;A String&quot;,
2807 ],
2808 &quot;permissions&quot;: [ # The list of permissions for users with access to this file. Not populated for items in shared drives.
2809 { # A permission for a file.
2810 &quot;additionalRoles&quot;: [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future.
2811 &quot;A String&quot;,
2812 ],
2813 &quot;authKey&quot;: &quot;A String&quot;, # Deprecated.
2814 &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.
2815 &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.
2816 &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.
2817 &quot;etag&quot;: &quot;A String&quot;, # The ETag of the permission.
2818 &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:
2819 # - They cannot be set on shared drive items
2820 # - They can only be set on user and group permissions
2821 # - The date must be in the future
2822 # - The date cannot be more than a year in the future
2823 # - The date can only be set on drive.permissions.update or drive.permissions.patch requests
2824 &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.
2825 &quot;kind&quot;: &quot;drive#permission&quot;, # This is always drive#permission.
2826 &quot;name&quot;: &quot;A String&quot;, # The name for this permission.
yoshi-code-bot815c1ac2021-11-15 23:24:17 -0800[diff] [blame]2827 &quot;pendingOwner&quot;: True or False, # Whether the account associated with this permission is a pending owner. Only populated for user type permissions for files that are not in a shared drive.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]2828 &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.
2829 {
2830 &quot;additionalRoles&quot;: [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future.
2831 &quot;A String&quot;,
2832 ],
2833 &quot;inherited&quot;: True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field.
2834 &quot;inheritedFrom&quot;: &quot;A String&quot;, # The ID of the item from which this permission is inherited. This is an output-only field.
2835 &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:
2836 # - file
2837 # - member
2838 &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:
2839 # - organizer
2840 # - fileOrganizer
2841 # - writer
2842 # - reader
2843 },
2844 ],
2845 &quot;photoLink&quot;: &quot;A String&quot;, # A link to the profile photo, if available.
2846 &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:
2847 # - owner
2848 # - organizer
2849 # - fileOrganizer
2850 # - writer
2851 # - reader
2852 &quot;selfLink&quot;: &quot;A String&quot;, # A link back to this permission.
2853 &quot;teamDrivePermissionDetails&quot;: [ # Deprecated - use permissionDetails instead.
2854 {
2855 &quot;additionalRoles&quot;: [ # Deprecated - use permissionDetails/additionalRoles instead.
2856 &quot;A String&quot;,
2857 ],
2858 &quot;inherited&quot;: True or False, # Deprecated - use permissionDetails/inherited instead.
2859 &quot;inheritedFrom&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/inheritedFrom instead.
2860 &quot;role&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/role instead.
2861 &quot;teamDrivePermissionType&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/permissionType instead.
2862 },
2863 ],
2864 &quot;type&quot;: &quot;A String&quot;, # The account type. Allowed values are:
2865 # - user
2866 # - group
2867 # - domain
2868 # - anyone
2869 &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]2870 &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]2871 &quot;withLink&quot;: True or False, # Whether the link is required for this permission.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]2872 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]2873 ],
2874 &quot;properties&quot;: [ # The list of properties.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]2875 { # A key-value pair attached to a file that is either public or private to an application.
2876 # The following limits apply to file properties:
2877 # - Maximum of 100 properties total per file
2878 # - Maximum of 30 private properties per app
2879 # - Maximum of 30 public properties
2880 # - 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]2881 &quot;etag&quot;: &quot;A String&quot;, # ETag of the property.
2882 &quot;key&quot;: &quot;A String&quot;, # The key of this property.
2883 &quot;kind&quot;: &quot;drive#property&quot;, # This is always drive#property.
2884 &quot;selfLink&quot;: &quot;A String&quot;, # The link back to this property.
2885 &quot;value&quot;: &quot;A String&quot;, # The value of this property.
yoshi-code-bot69706592021-03-03 03:54:02 -0800[diff] [blame]2886 &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]2887 },
2888 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]2889 &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]2890 &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]2891 &quot;selfLink&quot;: &quot;A String&quot;, # A link back to this file.
2892 &quot;shareable&quot;: True or False, # Deprecated: use capabilities/canShare.
2893 &quot;shared&quot;: True or False, # Whether the file has been shared. Not populated for items in shared drives.
2894 &quot;sharedWithMeDate&quot;: &quot;A String&quot;, # Time at which this file was shared with the user (formatted RFC 3339 timestamp).
2895 &quot;sharingUser&quot;: { # Information about a Drive user. # User that shared the item with the current user, if available.
2896 &quot;displayName&quot;: &quot;A String&quot;, # A plain text displayable name for this user.
2897 &quot;emailAddress&quot;: &quot;A String&quot;, # The email address of the user.
2898 &quot;isAuthenticatedUser&quot;: True or False, # Whether this user is the same as the authenticated user for whom the request was made.
2899 &quot;kind&quot;: &quot;drive#user&quot;, # This is always drive#user.
2900 &quot;permissionId&quot;: &quot;A String&quot;, # The user&#x27;s ID as visible in the permissions collection.
2901 &quot;picture&quot;: { # The user&#x27;s profile picture.
2902 &quot;url&quot;: &quot;A String&quot;, # A URL that points to a profile picture of this user.
2903 },
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]2904 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]2905 &quot;shortcutDetails&quot;: { # Shortcut file details. Only populated for shortcut files, which have the mimeType field set to application/vnd.google-apps.shortcut.
2906 &quot;targetId&quot;: &quot;A String&quot;, # The ID of the file that this shortcut points to.
2907 &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]2908 &quot;targetResourceKey&quot;: &quot;A String&quot;, # The ResourceKey for the target file.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]2909 },
2910 &quot;spaces&quot;: [ # The list of spaces which contain the file. Supported values are &#x27;drive&#x27;, &#x27;appDataFolder&#x27; and &#x27;photos&#x27;.
2911 &quot;A String&quot;,
2912 ],
2913 &quot;teamDriveId&quot;: &quot;A String&quot;, # Deprecated - use driveId instead.
2914 &quot;thumbnail&quot;: { # A thumbnail for the file. This will only be used if a standard thumbnail cannot be generated.
2915 &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.
2916 &quot;mimeType&quot;: &quot;A String&quot;, # The MIME type of the thumbnail.
2917 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]2918 &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]2919 &quot;thumbnailVersion&quot;: &quot;A String&quot;, # The thumbnail version for use in thumbnail cache invalidation.
2920 &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.
2921 &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.
2922 &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.
2923 &quot;displayName&quot;: &quot;A String&quot;, # A plain text displayable name for this user.
2924 &quot;emailAddress&quot;: &quot;A String&quot;, # The email address of the user.
2925 &quot;isAuthenticatedUser&quot;: True or False, # Whether this user is the same as the authenticated user for whom the request was made.
2926 &quot;kind&quot;: &quot;drive#user&quot;, # This is always drive#user.
2927 &quot;permissionId&quot;: &quot;A String&quot;, # The user&#x27;s ID as visible in the permissions collection.
2928 &quot;picture&quot;: { # The user&#x27;s profile picture.
2929 &quot;url&quot;: &quot;A String&quot;, # A URL that points to a profile picture of this user.
2930 },
2931 },
2932 &quot;userPermission&quot;: { # A permission for a file. # The permissions for the authenticated user on this file.
2933 &quot;additionalRoles&quot;: [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future.
2934 &quot;A String&quot;,
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]2935 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]2936 &quot;authKey&quot;: &quot;A String&quot;, # Deprecated.
2937 &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.
2938 &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.
2939 &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.
2940 &quot;etag&quot;: &quot;A String&quot;, # The ETag of the permission.
2941 &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]2942 # - They cannot be set on shared drive items
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]2943 # - They can only be set on user and group permissions
2944 # - The date must be in the future
2945 # - The date cannot be more than a year in the future
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2946 # - 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]2947 &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.
2948 &quot;kind&quot;: &quot;drive#permission&quot;, # This is always drive#permission.
2949 &quot;name&quot;: &quot;A String&quot;, # The name for this permission.
yoshi-code-bot815c1ac2021-11-15 23:24:17 -0800[diff] [blame]2950 &quot;pendingOwner&quot;: True or False, # Whether the account associated with this permission is a pending owner. Only populated for user type permissions for files that are not in a shared drive.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]2951 &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.
2952 {
2953 &quot;additionalRoles&quot;: [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future.
2954 &quot;A String&quot;,
2955 ],
2956 &quot;inherited&quot;: True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field.
2957 &quot;inheritedFrom&quot;: &quot;A String&quot;, # The ID of the item from which this permission is inherited. This is an output-only field.
2958 &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:
2959 # - file
2960 # - member
2961 &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:
2962 # - organizer
2963 # - fileOrganizer
2964 # - writer
2965 # - reader
2966 },
2967 ],
2968 &quot;photoLink&quot;: &quot;A String&quot;, # A link to the profile photo, if available.
2969 &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]2970 # - owner
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2971 # - organizer
2972 # - fileOrganizer
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]2973 # - writer
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2974 # - reader
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]2975 &quot;selfLink&quot;: &quot;A String&quot;, # A link back to this permission.
2976 &quot;teamDrivePermissionDetails&quot;: [ # Deprecated - use permissionDetails instead.
2977 {
2978 &quot;additionalRoles&quot;: [ # Deprecated - use permissionDetails/additionalRoles instead.
2979 &quot;A String&quot;,
2980 ],
2981 &quot;inherited&quot;: True or False, # Deprecated - use permissionDetails/inherited instead.
2982 &quot;inheritedFrom&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/inheritedFrom instead.
2983 &quot;role&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/role instead.
2984 &quot;teamDrivePermissionType&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/permissionType instead.
2985 },
2986 ],
2987 &quot;type&quot;: &quot;A String&quot;, # The account type. Allowed values are:
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]2988 # - user
2989 # - group
2990 # - domain
2991 # - anyone
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]2992 &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]2993 &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]2994 &quot;withLink&quot;: True or False, # Whether the link is required for this permission.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]2995 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]2996 &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.
2997 &quot;videoMediaMetadata&quot;: { # Metadata about video media. This will only be present for video types.
2998 &quot;durationMillis&quot;: &quot;A String&quot;, # The duration of the video in milliseconds.
2999 &quot;height&quot;: 42, # The height of the video in pixels.
3000 &quot;width&quot;: 42, # The width of the video in pixels.
3001 },
3002 &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.
3003 &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.
3004 &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]3005}
3006
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]3007 addParents: string, Comma-separated list of parent IDs to add.
3008 convert: boolean, This parameter is deprecated and has no function.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]3009 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]3010 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]3011 modifiedDateBehavior: string, Determines the behavior in which modifiedDate is updated. This overrides setModifiedDate.
3012 Allowed values
3013 fromBody - Set modifiedDate to the value provided in the body of the request. No change if no value was provided.
3014 fromBodyIfNeeded - Set modifiedDate to the value provided in the body of the request depending on other contents of the update.
3015 fromBodyOrNow - Set modifiedDate to the value provided in the body of the request, or to the current time if no value was provided.
3016 noChange - Maintain the previous value of modifiedDate.
3017 now - Set modifiedDate to the current time.
3018 nowIfNeeded - Set modifiedDate to the current time depending on contents of the update.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]3019 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]3020 ocr: boolean, Whether to attempt OCR on .jpg, .png, .gif, or .pdf uploads.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]3021 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]3022 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]3023 removeParents: string, Comma-separated list of parent IDs to remove.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3024 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]3025 supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]3026 supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]3027 timedTextLanguage: string, The language of the timed text.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]3028 timedTextTrackName: string, The timed text track name.
3029 updateViewedDate: boolean, Whether to update the view date after successfully updating the file.
3030 useContentAsIndexableText: boolean, Whether to use the content as indexable text.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]3031
3032Returns:
3033 An object of the form:
3034
3035 { # The metadata for a file.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]3036 &quot;alternateLink&quot;: &quot;A String&quot;, # A link for opening the file in a relevant Google editor or viewer.
3037 &quot;appDataContents&quot;: True or False, # Whether this file is in the Application Data folder.
3038 &quot;canComment&quot;: True or False, # Deprecated: use capabilities/canComment.
3039 &quot;canReadRevisions&quot;: True or False, # Deprecated: use capabilities/canReadRevisions.
3040 &quot;capabilities&quot;: { # Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take.
yoshi-code-bot815c1ac2021-11-15 23:24:17 -0800[diff] [blame]3041 &quot;canAcceptOwnership&quot;: True or False, # Whether the current user is the pending owner of the file. Not populated for shared drive files.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]3042 &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.
3043 &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.
3044 &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.
3045 &quot;canChangeCopyRequiresWriterPermission&quot;: True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this file.
3046 &quot;canChangeRestrictedDownload&quot;: True or False, # Deprecated
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700[diff] [blame]3047 &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]3048 &quot;canComment&quot;: True or False, # Whether the current user can comment on this file.
3049 &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.
3050 &quot;canDelete&quot;: True or False, # Whether the current user can delete this file.
3051 &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.
3052 &quot;canDownload&quot;: True or False, # Whether the current user can download this file.
3053 &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.
3054 &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.
3055 &quot;canModifyContent&quot;: True or False, # Whether the current user can modify the content of this file.
3056 &quot;canModifyContentRestriction&quot;: True or False, # Whether the current user can modify restrictions on content of this file.
3057 &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.
3058 &quot;canMoveChildrenOutOfTeamDrive&quot;: True or False, # Deprecated - use canMoveChildrenOutOfDrive instead.
3059 &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.
3060 &quot;canMoveChildrenWithinTeamDrive&quot;: True or False, # Deprecated - use canMoveChildrenWithinDrive instead.
3061 &quot;canMoveItemIntoTeamDrive&quot;: True or False, # Deprecated - use canMoveItemOutOfDrive instead.
3062 &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.
3063 &quot;canMoveItemOutOfTeamDrive&quot;: True or False, # Deprecated - use canMoveItemOutOfDrive instead.
3064 &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.
3065 &quot;canMoveItemWithinTeamDrive&quot;: True or False, # Deprecated - use canMoveItemWithinDrive instead.
3066 &quot;canMoveTeamDriveItem&quot;: True or False, # Deprecated - use canMoveItemWithinDrive or canMoveItemOutOfDrive instead.
3067 &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.
3068 &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.
3069 &quot;canReadTeamDrive&quot;: True or False, # Deprecated - use canReadDrive instead.
3070 &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.
3071 &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.
3072 &quot;canRename&quot;: True or False, # Whether the current user can rename this file.
3073 &quot;canShare&quot;: True or False, # Whether the current user can modify the sharing settings for this file.
3074 &quot;canTrash&quot;: True or False, # Whether the current user can move this file to trash.
3075 &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.
3076 &quot;canUntrash&quot;: True or False, # Whether the current user can restore this file from trash.
3077 },
3078 &quot;contentRestrictions&quot;: [ # Restrictions for accessing the content of the file. Only populated if such a restriction exists.
3079 { # A restriction for accessing the content of the file.
3080 &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.
3081 &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.
3082 &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]3083 &quot;displayName&quot;: &quot;A String&quot;, # A plain text displayable name for this user.
3084 &quot;emailAddress&quot;: &quot;A String&quot;, # The email address of the user.
3085 &quot;isAuthenticatedUser&quot;: True or False, # Whether this user is the same as the authenticated user for whom the request was made.
3086 &quot;kind&quot;: &quot;drive#user&quot;, # This is always drive#user.
3087 &quot;permissionId&quot;: &quot;A String&quot;, # The user&#x27;s ID as visible in the permissions collection.
3088 &quot;picture&quot;: { # The user&#x27;s profile picture.
3089 &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]3090 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]3091 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]3092 &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.
3093 &quot;type&quot;: &quot;A String&quot;, # The type of the content restriction. Currently the only possible value is globalContentRestriction.
3094 },
3095 ],
3096 &quot;copyRequiresWriterPermission&quot;: True or False, # Whether the options to copy, print, or download this file, should be disabled for readers and commenters.
3097 &quot;copyable&quot;: True or False, # Deprecated: use capabilities/canCopy.
3098 &quot;createdDate&quot;: &quot;A String&quot;, # Create time for this file (formatted RFC 3339 timestamp).
3099 &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.
3100 &quot;description&quot;: &quot;A String&quot;, # A short description of the file.
3101 &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.
3102 &quot;driveId&quot;: &quot;A String&quot;, # ID of the shared drive the file resides in. Only populated for items in shared drives.
3103 &quot;editable&quot;: True or False, # Deprecated: use capabilities/canEdit.
3104 &quot;embedLink&quot;: &quot;A String&quot;, # A link for embedding the file.
3105 &quot;etag&quot;: &quot;A String&quot;, # ETag of the file.
3106 &quot;explicitlyTrashed&quot;: True or False, # Whether this file has been explicitly trashed, as opposed to recursively trashed.
3107 &quot;exportLinks&quot;: { # Links for exporting Docs Editors files to specific formats.
3108 &quot;a_key&quot;: &quot;A String&quot;, # A mapping from export format to URL
3109 },
3110 &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.
3111 &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.
yoshi-code-botb539cc42021-08-03 00:20:27 -0700[diff] [blame]3112 &quot;folderColorRgb&quot;: &quot;A String&quot;, # Folder color as an RGB hex string if the file is a folder or a shortcut to 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.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]3113 &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.
3114 &quot;hasAugmentedPermissions&quot;: True or False, # Whether there are permissions directly on this file. This field is only populated for items in shared drives.
3115 &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.
3116 &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.
3117 &quot;iconLink&quot;: &quot;A String&quot;, # A link to the file&#x27;s icon.
3118 &quot;id&quot;: &quot;A String&quot;, # The ID of the file.
3119 &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.
3120 &quot;aperture&quot;: 3.14, # The aperture used to create the photo (f-number).
3121 &quot;cameraMake&quot;: &quot;A String&quot;, # The make of the camera used to create the photo.
3122 &quot;cameraModel&quot;: &quot;A String&quot;, # The model of the camera used to create the photo.
3123 &quot;colorSpace&quot;: &quot;A String&quot;, # The color space of the photo.
3124 &quot;date&quot;: &quot;A String&quot;, # The date and time the photo was taken (EXIF format timestamp).
3125 &quot;exposureBias&quot;: 3.14, # The exposure bias of the photo (APEX value).
3126 &quot;exposureMode&quot;: &quot;A String&quot;, # The exposure mode used to create the photo.
3127 &quot;exposureTime&quot;: 3.14, # The length of the exposure, in seconds.
3128 &quot;flashUsed&quot;: True or False, # Whether a flash was used to create the photo.
3129 &quot;focalLength&quot;: 3.14, # The focal length used to create the photo, in millimeters.
3130 &quot;height&quot;: 42, # The height of the image in pixels.
3131 &quot;isoSpeed&quot;: 42, # The ISO speed used to create the photo.
3132 &quot;lens&quot;: &quot;A String&quot;, # The lens used to create the photo.
3133 &quot;location&quot;: { # Geographic location information stored in the image.
3134 &quot;altitude&quot;: 3.14, # The altitude stored in the image.
3135 &quot;latitude&quot;: 3.14, # The latitude stored in the image.
3136 &quot;longitude&quot;: 3.14, # The longitude stored in the image.
3137 },
3138 &quot;maxApertureValue&quot;: 3.14, # The smallest f-number of the lens at the focal length used to create the photo (APEX value).
3139 &quot;meteringMode&quot;: &quot;A String&quot;, # The metering mode used to create the photo.
3140 &quot;rotation&quot;: 42, # The number of clockwise 90 degree rotations applied from the image&#x27;s original orientation.
3141 &quot;sensor&quot;: &quot;A String&quot;, # The type of sensor used to create the photo.
3142 &quot;subjectDistance&quot;: 42, # The distance to the subject of the photo, in meters.
3143 &quot;whiteBalance&quot;: &quot;A String&quot;, # The white balance mode used to create the photo.
3144 &quot;width&quot;: 42, # The width of the image in pixels.
3145 },
3146 &quot;indexableText&quot;: { # Indexable text attributes for the file (can only be written)
3147 &quot;text&quot;: &quot;A String&quot;, # The text to be indexed for this file.
3148 },
3149 &quot;isAppAuthorized&quot;: True or False, # Whether the file was created or opened by the requesting app.
3150 &quot;kind&quot;: &quot;drive#file&quot;, # The type of file. This is always drive#file.
3151 &quot;labels&quot;: { # A group of labels for the file.
3152 &quot;hidden&quot;: True or False, # Deprecated.
3153 &quot;modified&quot;: True or False, # Whether the file has been modified by this user.
3154 &quot;restricted&quot;: True or False, # Deprecated - use copyRequiresWriterPermission instead.
3155 &quot;starred&quot;: True or False, # Whether this file is starred by the user.
3156 &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.
3157 &quot;viewed&quot;: True or False, # Whether this file has been viewed by this user.
3158 },
3159 &quot;lastModifyingUser&quot;: { # Information about a Drive user. # The last user to modify this file.
3160 &quot;displayName&quot;: &quot;A String&quot;, # A plain text displayable name for this user.
3161 &quot;emailAddress&quot;: &quot;A String&quot;, # The email address of the user.
3162 &quot;isAuthenticatedUser&quot;: True or False, # Whether this user is the same as the authenticated user for whom the request was made.
3163 &quot;kind&quot;: &quot;drive#user&quot;, # This is always drive#user.
3164 &quot;permissionId&quot;: &quot;A String&quot;, # The user&#x27;s ID as visible in the permissions collection.
3165 &quot;picture&quot;: { # The user&#x27;s profile picture.
3166 &quot;url&quot;: &quot;A String&quot;, # A URL that points to a profile picture of this user.
3167 },
3168 },
3169 &quot;lastModifyingUserName&quot;: &quot;A String&quot;, # Name of the last user to modify this file.
3170 &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]3171 &quot;linkShareMetadata&quot;: { # Contains details about the link URLs that clients are using to refer to this item.
3172 &quot;securityUpdateEligible&quot;: True or False, # Whether the file is eligible for security update.
3173 &quot;securityUpdateEnabled&quot;: True or False, # Whether the security update is enabled for this file.
3174 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]3175 &quot;markedViewedByMeDate&quot;: &quot;A String&quot;, # Deprecated.
3176 &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.
3177 &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.
3178 &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.
3179 &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.
3180 &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.
3181 &quot;a_key&quot;: &quot;A String&quot;,
3182 },
3183 &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.
3184 &quot;ownedByMe&quot;: True or False, # Whether the file is owned by the current user. Not populated for items in shared drives.
3185 &quot;ownerNames&quot;: [ # Name(s) of the owner(s) of this file. Not populated for items in shared drives.
3186 &quot;A String&quot;,
3187 ],
yoshi-code-botab1d6dc2021-05-28 00:42:02 -0700[diff] [blame]3188 &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]3189 { # Information about a Drive user.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]3190 &quot;displayName&quot;: &quot;A String&quot;, # A plain text displayable name for this user.
3191 &quot;emailAddress&quot;: &quot;A String&quot;, # The email address of the user.
3192 &quot;isAuthenticatedUser&quot;: True or False, # Whether this user is the same as the authenticated user for whom the request was made.
3193 &quot;kind&quot;: &quot;drive#user&quot;, # This is always drive#user.
3194 &quot;permissionId&quot;: &quot;A String&quot;, # The user&#x27;s ID as visible in the permissions collection.
3195 &quot;picture&quot;: { # The user&#x27;s profile picture.
3196 &quot;url&quot;: &quot;A String&quot;, # A URL that points to a profile picture of this user.
3197 },
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]3198 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]3199 ],
3200 &quot;parents&quot;: [ # Collection of parent folders which contain this file.
3201 # 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.
3202 { # A reference to a file&#x27;s parent.
3203 &quot;id&quot;: &quot;A String&quot;, # The ID of the parent.
3204 &quot;isRoot&quot;: True or False, # Whether or not the parent is the root folder.
3205 &quot;kind&quot;: &quot;drive#parentReference&quot;, # This is always drive#parentReference.
3206 &quot;parentLink&quot;: &quot;A String&quot;, # A link to the parent.
3207 &quot;selfLink&quot;: &quot;A String&quot;, # A link back to this reference.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]3208 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]3209 ],
3210 &quot;permissionIds&quot;: [ # List of permission IDs for users with access to this file.
3211 &quot;A String&quot;,
3212 ],
3213 &quot;permissions&quot;: [ # The list of permissions for users with access to this file. Not populated for items in shared drives.
3214 { # A permission for a file.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]3215 &quot;additionalRoles&quot;: [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future.
3216 &quot;A String&quot;,
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]3217 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]3218 &quot;authKey&quot;: &quot;A String&quot;, # Deprecated.
3219 &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.
3220 &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.
3221 &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.
3222 &quot;etag&quot;: &quot;A String&quot;, # The ETag of the permission.
3223 &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]3224 # - They cannot be set on shared drive items
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]3225 # - They can only be set on user and group permissions
3226 # - The date must be in the future
3227 # - The date cannot be more than a year in the future
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3228 # - 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]3229 &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.
3230 &quot;kind&quot;: &quot;drive#permission&quot;, # This is always drive#permission.
3231 &quot;name&quot;: &quot;A String&quot;, # The name for this permission.
yoshi-code-bot815c1ac2021-11-15 23:24:17 -0800[diff] [blame]3232 &quot;pendingOwner&quot;: True or False, # Whether the account associated with this permission is a pending owner. Only populated for user type permissions for files that are not in a shared drive.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]3233 &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.
3234 {
3235 &quot;additionalRoles&quot;: [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future.
3236 &quot;A String&quot;,
3237 ],
3238 &quot;inherited&quot;: True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field.
3239 &quot;inheritedFrom&quot;: &quot;A String&quot;, # The ID of the item from which this permission is inherited. This is an output-only field.
3240 &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:
3241 # - file
3242 # - member
3243 &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:
3244 # - organizer
3245 # - fileOrganizer
3246 # - writer
3247 # - reader
3248 },
3249 ],
3250 &quot;photoLink&quot;: &quot;A String&quot;, # A link to the profile photo, if available.
3251 &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]3252 # - owner
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3253 # - organizer
3254 # - fileOrganizer
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]3255 # - writer
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3256 # - reader
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]3257 &quot;selfLink&quot;: &quot;A String&quot;, # A link back to this permission.
3258 &quot;teamDrivePermissionDetails&quot;: [ # Deprecated - use permissionDetails instead.
3259 {
3260 &quot;additionalRoles&quot;: [ # Deprecated - use permissionDetails/additionalRoles instead.
3261 &quot;A String&quot;,
3262 ],
3263 &quot;inherited&quot;: True or False, # Deprecated - use permissionDetails/inherited instead.
3264 &quot;inheritedFrom&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/inheritedFrom instead.
3265 &quot;role&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/role instead.
3266 &quot;teamDrivePermissionType&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/permissionType instead.
3267 },
3268 ],
3269 &quot;type&quot;: &quot;A String&quot;, # The account type. Allowed values are:
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]3270 # - user
3271 # - group
3272 # - domain
3273 # - anyone
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]3274 &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]3275 &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]3276 &quot;withLink&quot;: True or False, # Whether the link is required for this permission.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]3277 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]3278 ],
3279 &quot;properties&quot;: [ # The list of properties.
3280 { # A key-value pair attached to a file that is either public or private to an application.
3281 # The following limits apply to file properties:
3282 # - Maximum of 100 properties total per file
3283 # - Maximum of 30 private properties per app
3284 # - Maximum of 30 public properties
3285 # - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property.
3286 &quot;etag&quot;: &quot;A String&quot;, # ETag of the property.
3287 &quot;key&quot;: &quot;A String&quot;, # The key of this property.
3288 &quot;kind&quot;: &quot;drive#property&quot;, # This is always drive#property.
3289 &quot;selfLink&quot;: &quot;A String&quot;, # The link back to this property.
3290 &quot;value&quot;: &quot;A String&quot;, # The value of this property.
yoshi-code-bot69706592021-03-03 03:54:02 -0800[diff] [blame]3291 &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]3292 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]3293 ],
3294 &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]3295 &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]3296 &quot;selfLink&quot;: &quot;A String&quot;, # A link back to this file.
3297 &quot;shareable&quot;: True or False, # Deprecated: use capabilities/canShare.
3298 &quot;shared&quot;: True or False, # Whether the file has been shared. Not populated for items in shared drives.
3299 &quot;sharedWithMeDate&quot;: &quot;A String&quot;, # Time at which this file was shared with the user (formatted RFC 3339 timestamp).
3300 &quot;sharingUser&quot;: { # Information about a Drive user. # User that shared the item with the current user, if available.
3301 &quot;displayName&quot;: &quot;A String&quot;, # A plain text displayable name for this user.
3302 &quot;emailAddress&quot;: &quot;A String&quot;, # The email address of the user.
3303 &quot;isAuthenticatedUser&quot;: True or False, # Whether this user is the same as the authenticated user for whom the request was made.
3304 &quot;kind&quot;: &quot;drive#user&quot;, # This is always drive#user.
3305 &quot;permissionId&quot;: &quot;A String&quot;, # The user&#x27;s ID as visible in the permissions collection.
3306 &quot;picture&quot;: { # The user&#x27;s profile picture.
3307 &quot;url&quot;: &quot;A String&quot;, # A URL that points to a profile picture of this user.
3308 },
3309 },
3310 &quot;shortcutDetails&quot;: { # Shortcut file details. Only populated for shortcut files, which have the mimeType field set to application/vnd.google-apps.shortcut.
3311 &quot;targetId&quot;: &quot;A String&quot;, # The ID of the file that this shortcut points to.
3312 &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]3313 &quot;targetResourceKey&quot;: &quot;A String&quot;, # The ResourceKey for the target file.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]3314 },
3315 &quot;spaces&quot;: [ # The list of spaces which contain the file. Supported values are &#x27;drive&#x27;, &#x27;appDataFolder&#x27; and &#x27;photos&#x27;.
3316 &quot;A String&quot;,
3317 ],
3318 &quot;teamDriveId&quot;: &quot;A String&quot;, # Deprecated - use driveId instead.
3319 &quot;thumbnail&quot;: { # A thumbnail for the file. This will only be used if a standard thumbnail cannot be generated.
3320 &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.
3321 &quot;mimeType&quot;: &quot;A String&quot;, # The MIME type of the thumbnail.
3322 },
3323 &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.
3324 &quot;thumbnailVersion&quot;: &quot;A String&quot;, # The thumbnail version for use in thumbnail cache invalidation.
3325 &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.
3326 &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.
3327 &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.
3328 &quot;displayName&quot;: &quot;A String&quot;, # A plain text displayable name for this user.
3329 &quot;emailAddress&quot;: &quot;A String&quot;, # The email address of the user.
3330 &quot;isAuthenticatedUser&quot;: True or False, # Whether this user is the same as the authenticated user for whom the request was made.
3331 &quot;kind&quot;: &quot;drive#user&quot;, # This is always drive#user.
3332 &quot;permissionId&quot;: &quot;A String&quot;, # The user&#x27;s ID as visible in the permissions collection.
3333 &quot;picture&quot;: { # The user&#x27;s profile picture.
3334 &quot;url&quot;: &quot;A String&quot;, # A URL that points to a profile picture of this user.
3335 },
3336 },
3337 &quot;userPermission&quot;: { # A permission for a file. # The permissions for the authenticated user on this file.
3338 &quot;additionalRoles&quot;: [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future.
3339 &quot;A String&quot;,
3340 ],
3341 &quot;authKey&quot;: &quot;A String&quot;, # Deprecated.
3342 &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.
3343 &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.
3344 &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.
3345 &quot;etag&quot;: &quot;A String&quot;, # The ETag of the permission.
3346 &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:
3347 # - They cannot be set on shared drive items
3348 # - They can only be set on user and group permissions
3349 # - The date must be in the future
3350 # - The date cannot be more than a year in the future
3351 # - The date can only be set on drive.permissions.update or drive.permissions.patch requests
3352 &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.
3353 &quot;kind&quot;: &quot;drive#permission&quot;, # This is always drive#permission.
3354 &quot;name&quot;: &quot;A String&quot;, # The name for this permission.
yoshi-code-bot815c1ac2021-11-15 23:24:17 -0800[diff] [blame]3355 &quot;pendingOwner&quot;: True or False, # Whether the account associated with this permission is a pending owner. Only populated for user type permissions for files that are not in a shared drive.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]3356 &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.
3357 {
3358 &quot;additionalRoles&quot;: [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future.
3359 &quot;A String&quot;,
3360 ],
3361 &quot;inherited&quot;: True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field.
3362 &quot;inheritedFrom&quot;: &quot;A String&quot;, # The ID of the item from which this permission is inherited. This is an output-only field.
3363 &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:
3364 # - file
3365 # - member
3366 &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:
3367 # - organizer
3368 # - fileOrganizer
3369 # - writer
3370 # - reader
3371 },
3372 ],
3373 &quot;photoLink&quot;: &quot;A String&quot;, # A link to the profile photo, if available.
3374 &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:
3375 # - owner
3376 # - organizer
3377 # - fileOrganizer
3378 # - writer
3379 # - reader
3380 &quot;selfLink&quot;: &quot;A String&quot;, # A link back to this permission.
3381 &quot;teamDrivePermissionDetails&quot;: [ # Deprecated - use permissionDetails instead.
3382 {
3383 &quot;additionalRoles&quot;: [ # Deprecated - use permissionDetails/additionalRoles instead.
3384 &quot;A String&quot;,
3385 ],
3386 &quot;inherited&quot;: True or False, # Deprecated - use permissionDetails/inherited instead.
3387 &quot;inheritedFrom&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/inheritedFrom instead.
3388 &quot;role&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/role instead.
3389 &quot;teamDrivePermissionType&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/permissionType instead.
3390 },
3391 ],
3392 &quot;type&quot;: &quot;A String&quot;, # The account type. Allowed values are:
3393 # - user
3394 # - group
3395 # - domain
3396 # - anyone
3397 &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.
3398 &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.
3399 &quot;withLink&quot;: True or False, # Whether the link is required for this permission.
3400 },
3401 &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.
3402 &quot;videoMediaMetadata&quot;: { # Metadata about video media. This will only be present for video types.
3403 &quot;durationMillis&quot;: &quot;A String&quot;, # The duration of the video in milliseconds.
3404 &quot;height&quot;: 42, # The height of the video in pixels.
3405 &quot;width&quot;: 42, # The width of the video in pixels.
3406 },
3407 &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.
3408 &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.
3409 &quot;writersCanShare&quot;: True or False, # Whether writers can share the document with other users. Not populated for items in shared drives.
3410}</pre>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]3411</div>
3412
3413<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]3414 <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]3415 <pre>Set the file&#x27;s updated time to the current server time.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]3416
3417Args:
3418 fileId: string, The ID of the file to update. (required)
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]3419 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]3420 supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]3421 supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]3422
3423Returns:
3424 An object of the form:
3425
3426 { # The metadata for a file.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]3427 &quot;alternateLink&quot;: &quot;A String&quot;, # A link for opening the file in a relevant Google editor or viewer.
3428 &quot;appDataContents&quot;: True or False, # Whether this file is in the Application Data folder.
3429 &quot;canComment&quot;: True or False, # Deprecated: use capabilities/canComment.
3430 &quot;canReadRevisions&quot;: True or False, # Deprecated: use capabilities/canReadRevisions.
3431 &quot;capabilities&quot;: { # Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take.
yoshi-code-bot815c1ac2021-11-15 23:24:17 -0800[diff] [blame]3432 &quot;canAcceptOwnership&quot;: True or False, # Whether the current user is the pending owner of the file. Not populated for shared drive files.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]3433 &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.
3434 &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.
3435 &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.
3436 &quot;canChangeCopyRequiresWriterPermission&quot;: True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this file.
3437 &quot;canChangeRestrictedDownload&quot;: True or False, # Deprecated
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700[diff] [blame]3438 &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]3439 &quot;canComment&quot;: True or False, # Whether the current user can comment on this file.
3440 &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.
3441 &quot;canDelete&quot;: True or False, # Whether the current user can delete this file.
3442 &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.
3443 &quot;canDownload&quot;: True or False, # Whether the current user can download this file.
3444 &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.
3445 &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.
3446 &quot;canModifyContent&quot;: True or False, # Whether the current user can modify the content of this file.
3447 &quot;canModifyContentRestriction&quot;: True or False, # Whether the current user can modify restrictions on content of this file.
3448 &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.
3449 &quot;canMoveChildrenOutOfTeamDrive&quot;: True or False, # Deprecated - use canMoveChildrenOutOfDrive instead.
3450 &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.
3451 &quot;canMoveChildrenWithinTeamDrive&quot;: True or False, # Deprecated - use canMoveChildrenWithinDrive instead.
3452 &quot;canMoveItemIntoTeamDrive&quot;: True or False, # Deprecated - use canMoveItemOutOfDrive instead.
3453 &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.
3454 &quot;canMoveItemOutOfTeamDrive&quot;: True or False, # Deprecated - use canMoveItemOutOfDrive instead.
3455 &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.
3456 &quot;canMoveItemWithinTeamDrive&quot;: True or False, # Deprecated - use canMoveItemWithinDrive instead.
3457 &quot;canMoveTeamDriveItem&quot;: True or False, # Deprecated - use canMoveItemWithinDrive or canMoveItemOutOfDrive instead.
3458 &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.
3459 &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.
3460 &quot;canReadTeamDrive&quot;: True or False, # Deprecated - use canReadDrive instead.
3461 &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.
3462 &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.
3463 &quot;canRename&quot;: True or False, # Whether the current user can rename this file.
3464 &quot;canShare&quot;: True or False, # Whether the current user can modify the sharing settings for this file.
3465 &quot;canTrash&quot;: True or False, # Whether the current user can move this file to trash.
3466 &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.
3467 &quot;canUntrash&quot;: True or False, # Whether the current user can restore this file from trash.
3468 },
3469 &quot;contentRestrictions&quot;: [ # Restrictions for accessing the content of the file. Only populated if such a restriction exists.
3470 { # A restriction for accessing the content of the file.
3471 &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.
3472 &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.
3473 &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]3474 &quot;displayName&quot;: &quot;A String&quot;, # A plain text displayable name for this user.
3475 &quot;emailAddress&quot;: &quot;A String&quot;, # The email address of the user.
3476 &quot;isAuthenticatedUser&quot;: True or False, # Whether this user is the same as the authenticated user for whom the request was made.
3477 &quot;kind&quot;: &quot;drive#user&quot;, # This is always drive#user.
3478 &quot;permissionId&quot;: &quot;A String&quot;, # The user&#x27;s ID as visible in the permissions collection.
3479 &quot;picture&quot;: { # The user&#x27;s profile picture.
3480 &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]3481 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]3482 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]3483 &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.
3484 &quot;type&quot;: &quot;A String&quot;, # The type of the content restriction. Currently the only possible value is globalContentRestriction.
3485 },
3486 ],
3487 &quot;copyRequiresWriterPermission&quot;: True or False, # Whether the options to copy, print, or download this file, should be disabled for readers and commenters.
3488 &quot;copyable&quot;: True or False, # Deprecated: use capabilities/canCopy.
3489 &quot;createdDate&quot;: &quot;A String&quot;, # Create time for this file (formatted RFC 3339 timestamp).
3490 &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.
3491 &quot;description&quot;: &quot;A String&quot;, # A short description of the file.
3492 &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.
3493 &quot;driveId&quot;: &quot;A String&quot;, # ID of the shared drive the file resides in. Only populated for items in shared drives.
3494 &quot;editable&quot;: True or False, # Deprecated: use capabilities/canEdit.
3495 &quot;embedLink&quot;: &quot;A String&quot;, # A link for embedding the file.
3496 &quot;etag&quot;: &quot;A String&quot;, # ETag of the file.
3497 &quot;explicitlyTrashed&quot;: True or False, # Whether this file has been explicitly trashed, as opposed to recursively trashed.
3498 &quot;exportLinks&quot;: { # Links for exporting Docs Editors files to specific formats.
3499 &quot;a_key&quot;: &quot;A String&quot;, # A mapping from export format to URL
3500 },
3501 &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.
3502 &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.
yoshi-code-botb539cc42021-08-03 00:20:27 -0700[diff] [blame]3503 &quot;folderColorRgb&quot;: &quot;A String&quot;, # Folder color as an RGB hex string if the file is a folder or a shortcut to 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.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]3504 &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.
3505 &quot;hasAugmentedPermissions&quot;: True or False, # Whether there are permissions directly on this file. This field is only populated for items in shared drives.
3506 &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.
3507 &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.
3508 &quot;iconLink&quot;: &quot;A String&quot;, # A link to the file&#x27;s icon.
3509 &quot;id&quot;: &quot;A String&quot;, # The ID of the file.
3510 &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.
3511 &quot;aperture&quot;: 3.14, # The aperture used to create the photo (f-number).
3512 &quot;cameraMake&quot;: &quot;A String&quot;, # The make of the camera used to create the photo.
3513 &quot;cameraModel&quot;: &quot;A String&quot;, # The model of the camera used to create the photo.
3514 &quot;colorSpace&quot;: &quot;A String&quot;, # The color space of the photo.
3515 &quot;date&quot;: &quot;A String&quot;, # The date and time the photo was taken (EXIF format timestamp).
3516 &quot;exposureBias&quot;: 3.14, # The exposure bias of the photo (APEX value).
3517 &quot;exposureMode&quot;: &quot;A String&quot;, # The exposure mode used to create the photo.
3518 &quot;exposureTime&quot;: 3.14, # The length of the exposure, in seconds.
3519 &quot;flashUsed&quot;: True or False, # Whether a flash was used to create the photo.
3520 &quot;focalLength&quot;: 3.14, # The focal length used to create the photo, in millimeters.
3521 &quot;height&quot;: 42, # The height of the image in pixels.
3522 &quot;isoSpeed&quot;: 42, # The ISO speed used to create the photo.
3523 &quot;lens&quot;: &quot;A String&quot;, # The lens used to create the photo.
3524 &quot;location&quot;: { # Geographic location information stored in the image.
3525 &quot;altitude&quot;: 3.14, # The altitude stored in the image.
3526 &quot;latitude&quot;: 3.14, # The latitude stored in the image.
3527 &quot;longitude&quot;: 3.14, # The longitude stored in the image.
3528 },
3529 &quot;maxApertureValue&quot;: 3.14, # The smallest f-number of the lens at the focal length used to create the photo (APEX value).
3530 &quot;meteringMode&quot;: &quot;A String&quot;, # The metering mode used to create the photo.
3531 &quot;rotation&quot;: 42, # The number of clockwise 90 degree rotations applied from the image&#x27;s original orientation.
3532 &quot;sensor&quot;: &quot;A String&quot;, # The type of sensor used to create the photo.
3533 &quot;subjectDistance&quot;: 42, # The distance to the subject of the photo, in meters.
3534 &quot;whiteBalance&quot;: &quot;A String&quot;, # The white balance mode used to create the photo.
3535 &quot;width&quot;: 42, # The width of the image in pixels.
3536 },
3537 &quot;indexableText&quot;: { # Indexable text attributes for the file (can only be written)
3538 &quot;text&quot;: &quot;A String&quot;, # The text to be indexed for this file.
3539 },
3540 &quot;isAppAuthorized&quot;: True or False, # Whether the file was created or opened by the requesting app.
3541 &quot;kind&quot;: &quot;drive#file&quot;, # The type of file. This is always drive#file.
3542 &quot;labels&quot;: { # A group of labels for the file.
3543 &quot;hidden&quot;: True or False, # Deprecated.
3544 &quot;modified&quot;: True or False, # Whether the file has been modified by this user.
3545 &quot;restricted&quot;: True or False, # Deprecated - use copyRequiresWriterPermission instead.
3546 &quot;starred&quot;: True or False, # Whether this file is starred by the user.
3547 &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.
3548 &quot;viewed&quot;: True or False, # Whether this file has been viewed by this user.
3549 },
3550 &quot;lastModifyingUser&quot;: { # Information about a Drive user. # The last user to modify this file.
3551 &quot;displayName&quot;: &quot;A String&quot;, # A plain text displayable name for this user.
3552 &quot;emailAddress&quot;: &quot;A String&quot;, # The email address of the user.
3553 &quot;isAuthenticatedUser&quot;: True or False, # Whether this user is the same as the authenticated user for whom the request was made.
3554 &quot;kind&quot;: &quot;drive#user&quot;, # This is always drive#user.
3555 &quot;permissionId&quot;: &quot;A String&quot;, # The user&#x27;s ID as visible in the permissions collection.
3556 &quot;picture&quot;: { # The user&#x27;s profile picture.
3557 &quot;url&quot;: &quot;A String&quot;, # A URL that points to a profile picture of this user.
3558 },
3559 },
3560 &quot;lastModifyingUserName&quot;: &quot;A String&quot;, # Name of the last user to modify this file.
3561 &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]3562 &quot;linkShareMetadata&quot;: { # Contains details about the link URLs that clients are using to refer to this item.
3563 &quot;securityUpdateEligible&quot;: True or False, # Whether the file is eligible for security update.
3564 &quot;securityUpdateEnabled&quot;: True or False, # Whether the security update is enabled for this file.
3565 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]3566 &quot;markedViewedByMeDate&quot;: &quot;A String&quot;, # Deprecated.
3567 &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.
3568 &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.
3569 &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.
3570 &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.
3571 &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.
3572 &quot;a_key&quot;: &quot;A String&quot;,
3573 },
3574 &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.
3575 &quot;ownedByMe&quot;: True or False, # Whether the file is owned by the current user. Not populated for items in shared drives.
3576 &quot;ownerNames&quot;: [ # Name(s) of the owner(s) of this file. Not populated for items in shared drives.
3577 &quot;A String&quot;,
3578 ],
yoshi-code-botab1d6dc2021-05-28 00:42:02 -0700[diff] [blame]3579 &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]3580 { # Information about a Drive user.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]3581 &quot;displayName&quot;: &quot;A String&quot;, # A plain text displayable name for this user.
3582 &quot;emailAddress&quot;: &quot;A String&quot;, # The email address of the user.
3583 &quot;isAuthenticatedUser&quot;: True or False, # Whether this user is the same as the authenticated user for whom the request was made.
3584 &quot;kind&quot;: &quot;drive#user&quot;, # This is always drive#user.
3585 &quot;permissionId&quot;: &quot;A String&quot;, # The user&#x27;s ID as visible in the permissions collection.
3586 &quot;picture&quot;: { # The user&#x27;s profile picture.
3587 &quot;url&quot;: &quot;A String&quot;, # A URL that points to a profile picture of this user.
3588 },
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]3589 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]3590 ],
3591 &quot;parents&quot;: [ # Collection of parent folders which contain this file.
3592 # 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.
3593 { # A reference to a file&#x27;s parent.
3594 &quot;id&quot;: &quot;A String&quot;, # The ID of the parent.
3595 &quot;isRoot&quot;: True or False, # Whether or not the parent is the root folder.
3596 &quot;kind&quot;: &quot;drive#parentReference&quot;, # This is always drive#parentReference.
3597 &quot;parentLink&quot;: &quot;A String&quot;, # A link to the parent.
3598 &quot;selfLink&quot;: &quot;A String&quot;, # A link back to this reference.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]3599 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]3600 ],
3601 &quot;permissionIds&quot;: [ # List of permission IDs for users with access to this file.
3602 &quot;A String&quot;,
3603 ],
3604 &quot;permissions&quot;: [ # The list of permissions for users with access to this file. Not populated for items in shared drives.
3605 { # A permission for a file.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]3606 &quot;additionalRoles&quot;: [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future.
3607 &quot;A String&quot;,
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]3608 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]3609 &quot;authKey&quot;: &quot;A String&quot;, # Deprecated.
3610 &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.
3611 &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.
3612 &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.
3613 &quot;etag&quot;: &quot;A String&quot;, # The ETag of the permission.
3614 &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]3615 # - They cannot be set on shared drive items
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]3616 # - They can only be set on user and group permissions
3617 # - The date must be in the future
3618 # - The date cannot be more than a year in the future
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3619 # - 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]3620 &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.
3621 &quot;kind&quot;: &quot;drive#permission&quot;, # This is always drive#permission.
3622 &quot;name&quot;: &quot;A String&quot;, # The name for this permission.
yoshi-code-bot815c1ac2021-11-15 23:24:17 -0800[diff] [blame]3623 &quot;pendingOwner&quot;: True or False, # Whether the account associated with this permission is a pending owner. Only populated for user type permissions for files that are not in a shared drive.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]3624 &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.
3625 {
3626 &quot;additionalRoles&quot;: [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future.
3627 &quot;A String&quot;,
3628 ],
3629 &quot;inherited&quot;: True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field.
3630 &quot;inheritedFrom&quot;: &quot;A String&quot;, # The ID of the item from which this permission is inherited. This is an output-only field.
3631 &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:
3632 # - file
3633 # - member
3634 &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:
3635 # - organizer
3636 # - fileOrganizer
3637 # - writer
3638 # - reader
3639 },
3640 ],
3641 &quot;photoLink&quot;: &quot;A String&quot;, # A link to the profile photo, if available.
3642 &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]3643 # - owner
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3644 # - organizer
3645 # - fileOrganizer
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]3646 # - writer
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3647 # - reader
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]3648 &quot;selfLink&quot;: &quot;A String&quot;, # A link back to this permission.
3649 &quot;teamDrivePermissionDetails&quot;: [ # Deprecated - use permissionDetails instead.
3650 {
3651 &quot;additionalRoles&quot;: [ # Deprecated - use permissionDetails/additionalRoles instead.
3652 &quot;A String&quot;,
3653 ],
3654 &quot;inherited&quot;: True or False, # Deprecated - use permissionDetails/inherited instead.
3655 &quot;inheritedFrom&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/inheritedFrom instead.
3656 &quot;role&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/role instead.
3657 &quot;teamDrivePermissionType&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/permissionType instead.
3658 },
3659 ],
3660 &quot;type&quot;: &quot;A String&quot;, # The account type. Allowed values are:
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]3661 # - user
3662 # - group
3663 # - domain
3664 # - anyone
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]3665 &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]3666 &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]3667 &quot;withLink&quot;: True or False, # Whether the link is required for this permission.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]3668 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]3669 ],
3670 &quot;properties&quot;: [ # The list of properties.
3671 { # A key-value pair attached to a file that is either public or private to an application.
3672 # The following limits apply to file properties:
3673 # - Maximum of 100 properties total per file
3674 # - Maximum of 30 private properties per app
3675 # - Maximum of 30 public properties
3676 # - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property.
3677 &quot;etag&quot;: &quot;A String&quot;, # ETag of the property.
3678 &quot;key&quot;: &quot;A String&quot;, # The key of this property.
3679 &quot;kind&quot;: &quot;drive#property&quot;, # This is always drive#property.
3680 &quot;selfLink&quot;: &quot;A String&quot;, # The link back to this property.
3681 &quot;value&quot;: &quot;A String&quot;, # The value of this property.
yoshi-code-bot69706592021-03-03 03:54:02 -0800[diff] [blame]3682 &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]3683 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]3684 ],
3685 &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]3686 &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]3687 &quot;selfLink&quot;: &quot;A String&quot;, # A link back to this file.
3688 &quot;shareable&quot;: True or False, # Deprecated: use capabilities/canShare.
3689 &quot;shared&quot;: True or False, # Whether the file has been shared. Not populated for items in shared drives.
3690 &quot;sharedWithMeDate&quot;: &quot;A String&quot;, # Time at which this file was shared with the user (formatted RFC 3339 timestamp).
3691 &quot;sharingUser&quot;: { # Information about a Drive user. # User that shared the item with the current user, if available.
3692 &quot;displayName&quot;: &quot;A String&quot;, # A plain text displayable name for this user.
3693 &quot;emailAddress&quot;: &quot;A String&quot;, # The email address of the user.
3694 &quot;isAuthenticatedUser&quot;: True or False, # Whether this user is the same as the authenticated user for whom the request was made.
3695 &quot;kind&quot;: &quot;drive#user&quot;, # This is always drive#user.
3696 &quot;permissionId&quot;: &quot;A String&quot;, # The user&#x27;s ID as visible in the permissions collection.
3697 &quot;picture&quot;: { # The user&#x27;s profile picture.
3698 &quot;url&quot;: &quot;A String&quot;, # A URL that points to a profile picture of this user.
3699 },
3700 },
3701 &quot;shortcutDetails&quot;: { # Shortcut file details. Only populated for shortcut files, which have the mimeType field set to application/vnd.google-apps.shortcut.
3702 &quot;targetId&quot;: &quot;A String&quot;, # The ID of the file that this shortcut points to.
3703 &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]3704 &quot;targetResourceKey&quot;: &quot;A String&quot;, # The ResourceKey for the target file.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]3705 },
3706 &quot;spaces&quot;: [ # The list of spaces which contain the file. Supported values are &#x27;drive&#x27;, &#x27;appDataFolder&#x27; and &#x27;photos&#x27;.
3707 &quot;A String&quot;,
3708 ],
3709 &quot;teamDriveId&quot;: &quot;A String&quot;, # Deprecated - use driveId instead.
3710 &quot;thumbnail&quot;: { # A thumbnail for the file. This will only be used if a standard thumbnail cannot be generated.
3711 &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.
3712 &quot;mimeType&quot;: &quot;A String&quot;, # The MIME type of the thumbnail.
3713 },
3714 &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.
3715 &quot;thumbnailVersion&quot;: &quot;A String&quot;, # The thumbnail version for use in thumbnail cache invalidation.
3716 &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.
3717 &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.
3718 &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.
3719 &quot;displayName&quot;: &quot;A String&quot;, # A plain text displayable name for this user.
3720 &quot;emailAddress&quot;: &quot;A String&quot;, # The email address of the user.
3721 &quot;isAuthenticatedUser&quot;: True or False, # Whether this user is the same as the authenticated user for whom the request was made.
3722 &quot;kind&quot;: &quot;drive#user&quot;, # This is always drive#user.
3723 &quot;permissionId&quot;: &quot;A String&quot;, # The user&#x27;s ID as visible in the permissions collection.
3724 &quot;picture&quot;: { # The user&#x27;s profile picture.
3725 &quot;url&quot;: &quot;A String&quot;, # A URL that points to a profile picture of this user.
3726 },
3727 },
3728 &quot;userPermission&quot;: { # A permission for a file. # The permissions for the authenticated user on this file.
3729 &quot;additionalRoles&quot;: [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future.
3730 &quot;A String&quot;,
3731 ],
3732 &quot;authKey&quot;: &quot;A String&quot;, # Deprecated.
3733 &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.
3734 &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.
3735 &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.
3736 &quot;etag&quot;: &quot;A String&quot;, # The ETag of the permission.
3737 &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:
3738 # - They cannot be set on shared drive items
3739 # - They can only be set on user and group permissions
3740 # - The date must be in the future
3741 # - The date cannot be more than a year in the future
3742 # - The date can only be set on drive.permissions.update or drive.permissions.patch requests
3743 &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.
3744 &quot;kind&quot;: &quot;drive#permission&quot;, # This is always drive#permission.
3745 &quot;name&quot;: &quot;A String&quot;, # The name for this permission.
yoshi-code-bot815c1ac2021-11-15 23:24:17 -0800[diff] [blame]3746 &quot;pendingOwner&quot;: True or False, # Whether the account associated with this permission is a pending owner. Only populated for user type permissions for files that are not in a shared drive.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]3747 &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.
3748 {
3749 &quot;additionalRoles&quot;: [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future.
3750 &quot;A String&quot;,
3751 ],
3752 &quot;inherited&quot;: True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field.
3753 &quot;inheritedFrom&quot;: &quot;A String&quot;, # The ID of the item from which this permission is inherited. This is an output-only field.
3754 &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:
3755 # - file
3756 # - member
3757 &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:
3758 # - organizer
3759 # - fileOrganizer
3760 # - writer
3761 # - reader
3762 },
3763 ],
3764 &quot;photoLink&quot;: &quot;A String&quot;, # A link to the profile photo, if available.
3765 &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:
3766 # - owner
3767 # - organizer
3768 # - fileOrganizer
3769 # - writer
3770 # - reader
3771 &quot;selfLink&quot;: &quot;A String&quot;, # A link back to this permission.
3772 &quot;teamDrivePermissionDetails&quot;: [ # Deprecated - use permissionDetails instead.
3773 {
3774 &quot;additionalRoles&quot;: [ # Deprecated - use permissionDetails/additionalRoles instead.
3775 &quot;A String&quot;,
3776 ],
3777 &quot;inherited&quot;: True or False, # Deprecated - use permissionDetails/inherited instead.
3778 &quot;inheritedFrom&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/inheritedFrom instead.
3779 &quot;role&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/role instead.
3780 &quot;teamDrivePermissionType&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/permissionType instead.
3781 },
3782 ],
3783 &quot;type&quot;: &quot;A String&quot;, # The account type. Allowed values are:
3784 # - user
3785 # - group
3786 # - domain
3787 # - anyone
3788 &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.
3789 &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.
3790 &quot;withLink&quot;: True or False, # Whether the link is required for this permission.
3791 },
3792 &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.
3793 &quot;videoMediaMetadata&quot;: { # Metadata about video media. This will only be present for video types.
3794 &quot;durationMillis&quot;: &quot;A String&quot;, # The duration of the video in milliseconds.
3795 &quot;height&quot;: 42, # The height of the video in pixels.
3796 &quot;width&quot;: 42, # The width of the video in pixels.
3797 },
3798 &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.
3799 &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.
3800 &quot;writersCanShare&quot;: True or False, # Whether writers can share the document with other users. Not populated for items in shared drives.
3801}</pre>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]3802</div>
3803
3804<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]3805 <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]3806 <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]3807
3808Args:
3809 fileId: string, The ID of the file to trash. (required)
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]3810 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]3811 supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]3812 supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]3813
3814Returns:
3815 An object of the form:
3816
3817 { # The metadata for a file.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]3818 &quot;alternateLink&quot;: &quot;A String&quot;, # A link for opening the file in a relevant Google editor or viewer.
3819 &quot;appDataContents&quot;: True or False, # Whether this file is in the Application Data folder.
3820 &quot;canComment&quot;: True or False, # Deprecated: use capabilities/canComment.
3821 &quot;canReadRevisions&quot;: True or False, # Deprecated: use capabilities/canReadRevisions.
3822 &quot;capabilities&quot;: { # Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take.
yoshi-code-bot815c1ac2021-11-15 23:24:17 -0800[diff] [blame]3823 &quot;canAcceptOwnership&quot;: True or False, # Whether the current user is the pending owner of the file. Not populated for shared drive files.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]3824 &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.
3825 &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.
3826 &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.
3827 &quot;canChangeCopyRequiresWriterPermission&quot;: True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this file.
3828 &quot;canChangeRestrictedDownload&quot;: True or False, # Deprecated
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700[diff] [blame]3829 &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]3830 &quot;canComment&quot;: True or False, # Whether the current user can comment on this file.
3831 &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.
3832 &quot;canDelete&quot;: True or False, # Whether the current user can delete this file.
3833 &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.
3834 &quot;canDownload&quot;: True or False, # Whether the current user can download this file.
3835 &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.
3836 &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.
3837 &quot;canModifyContent&quot;: True or False, # Whether the current user can modify the content of this file.
3838 &quot;canModifyContentRestriction&quot;: True or False, # Whether the current user can modify restrictions on content of this file.
3839 &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.
3840 &quot;canMoveChildrenOutOfTeamDrive&quot;: True or False, # Deprecated - use canMoveChildrenOutOfDrive instead.
3841 &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.
3842 &quot;canMoveChildrenWithinTeamDrive&quot;: True or False, # Deprecated - use canMoveChildrenWithinDrive instead.
3843 &quot;canMoveItemIntoTeamDrive&quot;: True or False, # Deprecated - use canMoveItemOutOfDrive instead.
3844 &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.
3845 &quot;canMoveItemOutOfTeamDrive&quot;: True or False, # Deprecated - use canMoveItemOutOfDrive instead.
3846 &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.
3847 &quot;canMoveItemWithinTeamDrive&quot;: True or False, # Deprecated - use canMoveItemWithinDrive instead.
3848 &quot;canMoveTeamDriveItem&quot;: True or False, # Deprecated - use canMoveItemWithinDrive or canMoveItemOutOfDrive instead.
3849 &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.
3850 &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.
3851 &quot;canReadTeamDrive&quot;: True or False, # Deprecated - use canReadDrive instead.
3852 &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.
3853 &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.
3854 &quot;canRename&quot;: True or False, # Whether the current user can rename this file.
3855 &quot;canShare&quot;: True or False, # Whether the current user can modify the sharing settings for this file.
3856 &quot;canTrash&quot;: True or False, # Whether the current user can move this file to trash.
3857 &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.
3858 &quot;canUntrash&quot;: True or False, # Whether the current user can restore this file from trash.
3859 },
3860 &quot;contentRestrictions&quot;: [ # Restrictions for accessing the content of the file. Only populated if such a restriction exists.
3861 { # A restriction for accessing the content of the file.
3862 &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.
3863 &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.
3864 &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]3865 &quot;displayName&quot;: &quot;A String&quot;, # A plain text displayable name for this user.
3866 &quot;emailAddress&quot;: &quot;A String&quot;, # The email address of the user.
3867 &quot;isAuthenticatedUser&quot;: True or False, # Whether this user is the same as the authenticated user for whom the request was made.
3868 &quot;kind&quot;: &quot;drive#user&quot;, # This is always drive#user.
3869 &quot;permissionId&quot;: &quot;A String&quot;, # The user&#x27;s ID as visible in the permissions collection.
3870 &quot;picture&quot;: { # The user&#x27;s profile picture.
3871 &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]3872 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]3873 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]3874 &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.
3875 &quot;type&quot;: &quot;A String&quot;, # The type of the content restriction. Currently the only possible value is globalContentRestriction.
3876 },
3877 ],
3878 &quot;copyRequiresWriterPermission&quot;: True or False, # Whether the options to copy, print, or download this file, should be disabled for readers and commenters.
3879 &quot;copyable&quot;: True or False, # Deprecated: use capabilities/canCopy.
3880 &quot;createdDate&quot;: &quot;A String&quot;, # Create time for this file (formatted RFC 3339 timestamp).
3881 &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.
3882 &quot;description&quot;: &quot;A String&quot;, # A short description of the file.
3883 &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.
3884 &quot;driveId&quot;: &quot;A String&quot;, # ID of the shared drive the file resides in. Only populated for items in shared drives.
3885 &quot;editable&quot;: True or False, # Deprecated: use capabilities/canEdit.
3886 &quot;embedLink&quot;: &quot;A String&quot;, # A link for embedding the file.
3887 &quot;etag&quot;: &quot;A String&quot;, # ETag of the file.
3888 &quot;explicitlyTrashed&quot;: True or False, # Whether this file has been explicitly trashed, as opposed to recursively trashed.
3889 &quot;exportLinks&quot;: { # Links for exporting Docs Editors files to specific formats.
3890 &quot;a_key&quot;: &quot;A String&quot;, # A mapping from export format to URL
3891 },
3892 &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.
3893 &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.
yoshi-code-botb539cc42021-08-03 00:20:27 -0700[diff] [blame]3894 &quot;folderColorRgb&quot;: &quot;A String&quot;, # Folder color as an RGB hex string if the file is a folder or a shortcut to 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.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]3895 &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.
3896 &quot;hasAugmentedPermissions&quot;: True or False, # Whether there are permissions directly on this file. This field is only populated for items in shared drives.
3897 &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.
3898 &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.
3899 &quot;iconLink&quot;: &quot;A String&quot;, # A link to the file&#x27;s icon.
3900 &quot;id&quot;: &quot;A String&quot;, # The ID of the file.
3901 &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.
3902 &quot;aperture&quot;: 3.14, # The aperture used to create the photo (f-number).
3903 &quot;cameraMake&quot;: &quot;A String&quot;, # The make of the camera used to create the photo.
3904 &quot;cameraModel&quot;: &quot;A String&quot;, # The model of the camera used to create the photo.
3905 &quot;colorSpace&quot;: &quot;A String&quot;, # The color space of the photo.
3906 &quot;date&quot;: &quot;A String&quot;, # The date and time the photo was taken (EXIF format timestamp).
3907 &quot;exposureBias&quot;: 3.14, # The exposure bias of the photo (APEX value).
3908 &quot;exposureMode&quot;: &quot;A String&quot;, # The exposure mode used to create the photo.
3909 &quot;exposureTime&quot;: 3.14, # The length of the exposure, in seconds.
3910 &quot;flashUsed&quot;: True or False, # Whether a flash was used to create the photo.
3911 &quot;focalLength&quot;: 3.14, # The focal length used to create the photo, in millimeters.
3912 &quot;height&quot;: 42, # The height of the image in pixels.
3913 &quot;isoSpeed&quot;: 42, # The ISO speed used to create the photo.
3914 &quot;lens&quot;: &quot;A String&quot;, # The lens used to create the photo.
3915 &quot;location&quot;: { # Geographic location information stored in the image.
3916 &quot;altitude&quot;: 3.14, # The altitude stored in the image.
3917 &quot;latitude&quot;: 3.14, # The latitude stored in the image.
3918 &quot;longitude&quot;: 3.14, # The longitude stored in the image.
3919 },
3920 &quot;maxApertureValue&quot;: 3.14, # The smallest f-number of the lens at the focal length used to create the photo (APEX value).
3921 &quot;meteringMode&quot;: &quot;A String&quot;, # The metering mode used to create the photo.
3922 &quot;rotation&quot;: 42, # The number of clockwise 90 degree rotations applied from the image&#x27;s original orientation.
3923 &quot;sensor&quot;: &quot;A String&quot;, # The type of sensor used to create the photo.
3924 &quot;subjectDistance&quot;: 42, # The distance to the subject of the photo, in meters.
3925 &quot;whiteBalance&quot;: &quot;A String&quot;, # The white balance mode used to create the photo.
3926 &quot;width&quot;: 42, # The width of the image in pixels.
3927 },
3928 &quot;indexableText&quot;: { # Indexable text attributes for the file (can only be written)
3929 &quot;text&quot;: &quot;A String&quot;, # The text to be indexed for this file.
3930 },
3931 &quot;isAppAuthorized&quot;: True or False, # Whether the file was created or opened by the requesting app.
3932 &quot;kind&quot;: &quot;drive#file&quot;, # The type of file. This is always drive#file.
3933 &quot;labels&quot;: { # A group of labels for the file.
3934 &quot;hidden&quot;: True or False, # Deprecated.
3935 &quot;modified&quot;: True or False, # Whether the file has been modified by this user.
3936 &quot;restricted&quot;: True or False, # Deprecated - use copyRequiresWriterPermission instead.
3937 &quot;starred&quot;: True or False, # Whether this file is starred by the user.
3938 &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.
3939 &quot;viewed&quot;: True or False, # Whether this file has been viewed by this user.
3940 },
3941 &quot;lastModifyingUser&quot;: { # Information about a Drive user. # The last user to modify this file.
3942 &quot;displayName&quot;: &quot;A String&quot;, # A plain text displayable name for this user.
3943 &quot;emailAddress&quot;: &quot;A String&quot;, # The email address of the user.
3944 &quot;isAuthenticatedUser&quot;: True or False, # Whether this user is the same as the authenticated user for whom the request was made.
3945 &quot;kind&quot;: &quot;drive#user&quot;, # This is always drive#user.
3946 &quot;permissionId&quot;: &quot;A String&quot;, # The user&#x27;s ID as visible in the permissions collection.
3947 &quot;picture&quot;: { # The user&#x27;s profile picture.
3948 &quot;url&quot;: &quot;A String&quot;, # A URL that points to a profile picture of this user.
3949 },
3950 },
3951 &quot;lastModifyingUserName&quot;: &quot;A String&quot;, # Name of the last user to modify this file.
3952 &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]3953 &quot;linkShareMetadata&quot;: { # Contains details about the link URLs that clients are using to refer to this item.
3954 &quot;securityUpdateEligible&quot;: True or False, # Whether the file is eligible for security update.
3955 &quot;securityUpdateEnabled&quot;: True or False, # Whether the security update is enabled for this file.
3956 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]3957 &quot;markedViewedByMeDate&quot;: &quot;A String&quot;, # Deprecated.
3958 &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.
3959 &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.
3960 &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.
3961 &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.
3962 &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.
3963 &quot;a_key&quot;: &quot;A String&quot;,
3964 },
3965 &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.
3966 &quot;ownedByMe&quot;: True or False, # Whether the file is owned by the current user. Not populated for items in shared drives.
3967 &quot;ownerNames&quot;: [ # Name(s) of the owner(s) of this file. Not populated for items in shared drives.
3968 &quot;A String&quot;,
3969 ],
yoshi-code-botab1d6dc2021-05-28 00:42:02 -0700[diff] [blame]3970 &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]3971 { # Information about a Drive user.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]3972 &quot;displayName&quot;: &quot;A String&quot;, # A plain text displayable name for this user.
3973 &quot;emailAddress&quot;: &quot;A String&quot;, # The email address of the user.
3974 &quot;isAuthenticatedUser&quot;: True or False, # Whether this user is the same as the authenticated user for whom the request was made.
3975 &quot;kind&quot;: &quot;drive#user&quot;, # This is always drive#user.
3976 &quot;permissionId&quot;: &quot;A String&quot;, # The user&#x27;s ID as visible in the permissions collection.
3977 &quot;picture&quot;: { # The user&#x27;s profile picture.
3978 &quot;url&quot;: &quot;A String&quot;, # A URL that points to a profile picture of this user.
3979 },
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]3980 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]3981 ],
3982 &quot;parents&quot;: [ # Collection of parent folders which contain this file.
3983 # 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.
3984 { # A reference to a file&#x27;s parent.
3985 &quot;id&quot;: &quot;A String&quot;, # The ID of the parent.
3986 &quot;isRoot&quot;: True or False, # Whether or not the parent is the root folder.
3987 &quot;kind&quot;: &quot;drive#parentReference&quot;, # This is always drive#parentReference.
3988 &quot;parentLink&quot;: &quot;A String&quot;, # A link to the parent.
3989 &quot;selfLink&quot;: &quot;A String&quot;, # A link back to this reference.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]3990 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]3991 ],
3992 &quot;permissionIds&quot;: [ # List of permission IDs for users with access to this file.
3993 &quot;A String&quot;,
3994 ],
3995 &quot;permissions&quot;: [ # The list of permissions for users with access to this file. Not populated for items in shared drives.
3996 { # A permission for a file.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]3997 &quot;additionalRoles&quot;: [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future.
3998 &quot;A String&quot;,
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]3999 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]4000 &quot;authKey&quot;: &quot;A String&quot;, # Deprecated.
4001 &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.
4002 &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.
4003 &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.
4004 &quot;etag&quot;: &quot;A String&quot;, # The ETag of the permission.
4005 &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]4006 # - They cannot be set on shared drive items
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]4007 # - They can only be set on user and group permissions
4008 # - The date must be in the future
4009 # - The date cannot be more than a year in the future
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4010 # - 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]4011 &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.
4012 &quot;kind&quot;: &quot;drive#permission&quot;, # This is always drive#permission.
4013 &quot;name&quot;: &quot;A String&quot;, # The name for this permission.
yoshi-code-bot815c1ac2021-11-15 23:24:17 -0800[diff] [blame]4014 &quot;pendingOwner&quot;: True or False, # Whether the account associated with this permission is a pending owner. Only populated for user type permissions for files that are not in a shared drive.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]4015 &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.
4016 {
4017 &quot;additionalRoles&quot;: [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future.
4018 &quot;A String&quot;,
4019 ],
4020 &quot;inherited&quot;: True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field.
4021 &quot;inheritedFrom&quot;: &quot;A String&quot;, # The ID of the item from which this permission is inherited. This is an output-only field.
4022 &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:
4023 # - file
4024 # - member
4025 &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:
4026 # - organizer
4027 # - fileOrganizer
4028 # - writer
4029 # - reader
4030 },
4031 ],
4032 &quot;photoLink&quot;: &quot;A String&quot;, # A link to the profile photo, if available.
4033 &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]4034 # - owner
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4035 # - organizer
4036 # - fileOrganizer
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]4037 # - writer
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4038 # - reader
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]4039 &quot;selfLink&quot;: &quot;A String&quot;, # A link back to this permission.
4040 &quot;teamDrivePermissionDetails&quot;: [ # Deprecated - use permissionDetails instead.
4041 {
4042 &quot;additionalRoles&quot;: [ # Deprecated - use permissionDetails/additionalRoles instead.
4043 &quot;A String&quot;,
4044 ],
4045 &quot;inherited&quot;: True or False, # Deprecated - use permissionDetails/inherited instead.
4046 &quot;inheritedFrom&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/inheritedFrom instead.
4047 &quot;role&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/role instead.
4048 &quot;teamDrivePermissionType&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/permissionType instead.
4049 },
4050 ],
4051 &quot;type&quot;: &quot;A String&quot;, # The account type. Allowed values are:
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]4052 # - user
4053 # - group
4054 # - domain
4055 # - anyone
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]4056 &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]4057 &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]4058 &quot;withLink&quot;: True or False, # Whether the link is required for this permission.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]4059 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]4060 ],
4061 &quot;properties&quot;: [ # The list of properties.
4062 { # A key-value pair attached to a file that is either public or private to an application.
4063 # The following limits apply to file properties:
4064 # - Maximum of 100 properties total per file
4065 # - Maximum of 30 private properties per app
4066 # - Maximum of 30 public properties
4067 # - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property.
4068 &quot;etag&quot;: &quot;A String&quot;, # ETag of the property.
4069 &quot;key&quot;: &quot;A String&quot;, # The key of this property.
4070 &quot;kind&quot;: &quot;drive#property&quot;, # This is always drive#property.
4071 &quot;selfLink&quot;: &quot;A String&quot;, # The link back to this property.
4072 &quot;value&quot;: &quot;A String&quot;, # The value of this property.
yoshi-code-bot69706592021-03-03 03:54:02 -0800[diff] [blame]4073 &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]4074 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]4075 ],
4076 &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]4077 &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]4078 &quot;selfLink&quot;: &quot;A String&quot;, # A link back to this file.
4079 &quot;shareable&quot;: True or False, # Deprecated: use capabilities/canShare.
4080 &quot;shared&quot;: True or False, # Whether the file has been shared. Not populated for items in shared drives.
4081 &quot;sharedWithMeDate&quot;: &quot;A String&quot;, # Time at which this file was shared with the user (formatted RFC 3339 timestamp).
4082 &quot;sharingUser&quot;: { # Information about a Drive user. # User that shared the item with the current user, if available.
4083 &quot;displayName&quot;: &quot;A String&quot;, # A plain text displayable name for this user.
4084 &quot;emailAddress&quot;: &quot;A String&quot;, # The email address of the user.
4085 &quot;isAuthenticatedUser&quot;: True or False, # Whether this user is the same as the authenticated user for whom the request was made.
4086 &quot;kind&quot;: &quot;drive#user&quot;, # This is always drive#user.
4087 &quot;permissionId&quot;: &quot;A String&quot;, # The user&#x27;s ID as visible in the permissions collection.
4088 &quot;picture&quot;: { # The user&#x27;s profile picture.
4089 &quot;url&quot;: &quot;A String&quot;, # A URL that points to a profile picture of this user.
4090 },
4091 },
4092 &quot;shortcutDetails&quot;: { # Shortcut file details. Only populated for shortcut files, which have the mimeType field set to application/vnd.google-apps.shortcut.
4093 &quot;targetId&quot;: &quot;A String&quot;, # The ID of the file that this shortcut points to.
4094 &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]4095 &quot;targetResourceKey&quot;: &quot;A String&quot;, # The ResourceKey for the target file.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]4096 },
4097 &quot;spaces&quot;: [ # The list of spaces which contain the file. Supported values are &#x27;drive&#x27;, &#x27;appDataFolder&#x27; and &#x27;photos&#x27;.
4098 &quot;A String&quot;,
4099 ],
4100 &quot;teamDriveId&quot;: &quot;A String&quot;, # Deprecated - use driveId instead.
4101 &quot;thumbnail&quot;: { # A thumbnail for the file. This will only be used if a standard thumbnail cannot be generated.
4102 &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.
4103 &quot;mimeType&quot;: &quot;A String&quot;, # The MIME type of the thumbnail.
4104 },
4105 &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.
4106 &quot;thumbnailVersion&quot;: &quot;A String&quot;, # The thumbnail version for use in thumbnail cache invalidation.
4107 &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.
4108 &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.
4109 &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.
4110 &quot;displayName&quot;: &quot;A String&quot;, # A plain text displayable name for this user.
4111 &quot;emailAddress&quot;: &quot;A String&quot;, # The email address of the user.
4112 &quot;isAuthenticatedUser&quot;: True or False, # Whether this user is the same as the authenticated user for whom the request was made.
4113 &quot;kind&quot;: &quot;drive#user&quot;, # This is always drive#user.
4114 &quot;permissionId&quot;: &quot;A String&quot;, # The user&#x27;s ID as visible in the permissions collection.
4115 &quot;picture&quot;: { # The user&#x27;s profile picture.
4116 &quot;url&quot;: &quot;A String&quot;, # A URL that points to a profile picture of this user.
4117 },
4118 },
4119 &quot;userPermission&quot;: { # A permission for a file. # The permissions for the authenticated user on this file.
4120 &quot;additionalRoles&quot;: [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future.
4121 &quot;A String&quot;,
4122 ],
4123 &quot;authKey&quot;: &quot;A String&quot;, # Deprecated.
4124 &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.
4125 &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.
4126 &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.
4127 &quot;etag&quot;: &quot;A String&quot;, # The ETag of the permission.
4128 &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:
4129 # - They cannot be set on shared drive items
4130 # - They can only be set on user and group permissions
4131 # - The date must be in the future
4132 # - The date cannot be more than a year in the future
4133 # - The date can only be set on drive.permissions.update or drive.permissions.patch requests
4134 &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.
4135 &quot;kind&quot;: &quot;drive#permission&quot;, # This is always drive#permission.
4136 &quot;name&quot;: &quot;A String&quot;, # The name for this permission.
yoshi-code-bot815c1ac2021-11-15 23:24:17 -0800[diff] [blame]4137 &quot;pendingOwner&quot;: True or False, # Whether the account associated with this permission is a pending owner. Only populated for user type permissions for files that are not in a shared drive.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]4138 &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.
4139 {
4140 &quot;additionalRoles&quot;: [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future.
4141 &quot;A String&quot;,
4142 ],
4143 &quot;inherited&quot;: True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field.
4144 &quot;inheritedFrom&quot;: &quot;A String&quot;, # The ID of the item from which this permission is inherited. This is an output-only field.
4145 &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:
4146 # - file
4147 # - member
4148 &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:
4149 # - organizer
4150 # - fileOrganizer
4151 # - writer
4152 # - reader
4153 },
4154 ],
4155 &quot;photoLink&quot;: &quot;A String&quot;, # A link to the profile photo, if available.
4156 &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:
4157 # - owner
4158 # - organizer
4159 # - fileOrganizer
4160 # - writer
4161 # - reader
4162 &quot;selfLink&quot;: &quot;A String&quot;, # A link back to this permission.
4163 &quot;teamDrivePermissionDetails&quot;: [ # Deprecated - use permissionDetails instead.
4164 {
4165 &quot;additionalRoles&quot;: [ # Deprecated - use permissionDetails/additionalRoles instead.
4166 &quot;A String&quot;,
4167 ],
4168 &quot;inherited&quot;: True or False, # Deprecated - use permissionDetails/inherited instead.
4169 &quot;inheritedFrom&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/inheritedFrom instead.
4170 &quot;role&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/role instead.
4171 &quot;teamDrivePermissionType&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/permissionType instead.
4172 },
4173 ],
4174 &quot;type&quot;: &quot;A String&quot;, # The account type. Allowed values are:
4175 # - user
4176 # - group
4177 # - domain
4178 # - anyone
4179 &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.
4180 &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.
4181 &quot;withLink&quot;: True or False, # Whether the link is required for this permission.
4182 },
4183 &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.
4184 &quot;videoMediaMetadata&quot;: { # Metadata about video media. This will only be present for video types.
4185 &quot;durationMillis&quot;: &quot;A String&quot;, # The duration of the video in milliseconds.
4186 &quot;height&quot;: 42, # The height of the video in pixels.
4187 &quot;width&quot;: 42, # The width of the video in pixels.
4188 },
4189 &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.
4190 &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.
4191 &quot;writersCanShare&quot;: True or False, # Whether writers can share the document with other users. Not populated for items in shared drives.
4192}</pre>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]4193</div>
4194
4195<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]4196 <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]4197 <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]4198
4199Args:
4200 fileId: string, The ID of the file to untrash. (required)
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]4201 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]4202 supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]4203 supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]4204
4205Returns:
4206 An object of the form:
4207
4208 { # The metadata for a file.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]4209 &quot;alternateLink&quot;: &quot;A String&quot;, # A link for opening the file in a relevant Google editor or viewer.
4210 &quot;appDataContents&quot;: True or False, # Whether this file is in the Application Data folder.
4211 &quot;canComment&quot;: True or False, # Deprecated: use capabilities/canComment.
4212 &quot;canReadRevisions&quot;: True or False, # Deprecated: use capabilities/canReadRevisions.
4213 &quot;capabilities&quot;: { # Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take.
yoshi-code-bot815c1ac2021-11-15 23:24:17 -0800[diff] [blame]4214 &quot;canAcceptOwnership&quot;: True or False, # Whether the current user is the pending owner of the file. Not populated for shared drive files.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]4215 &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.
4216 &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.
4217 &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.
4218 &quot;canChangeCopyRequiresWriterPermission&quot;: True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this file.
4219 &quot;canChangeRestrictedDownload&quot;: True or False, # Deprecated
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700[diff] [blame]4220 &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]4221 &quot;canComment&quot;: True or False, # Whether the current user can comment on this file.
4222 &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.
4223 &quot;canDelete&quot;: True or False, # Whether the current user can delete this file.
4224 &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.
4225 &quot;canDownload&quot;: True or False, # Whether the current user can download this file.
4226 &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.
4227 &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.
4228 &quot;canModifyContent&quot;: True or False, # Whether the current user can modify the content of this file.
4229 &quot;canModifyContentRestriction&quot;: True or False, # Whether the current user can modify restrictions on content of this file.
4230 &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.
4231 &quot;canMoveChildrenOutOfTeamDrive&quot;: True or False, # Deprecated - use canMoveChildrenOutOfDrive instead.
4232 &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.
4233 &quot;canMoveChildrenWithinTeamDrive&quot;: True or False, # Deprecated - use canMoveChildrenWithinDrive instead.
4234 &quot;canMoveItemIntoTeamDrive&quot;: True or False, # Deprecated - use canMoveItemOutOfDrive instead.
4235 &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.
4236 &quot;canMoveItemOutOfTeamDrive&quot;: True or False, # Deprecated - use canMoveItemOutOfDrive instead.
4237 &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.
4238 &quot;canMoveItemWithinTeamDrive&quot;: True or False, # Deprecated - use canMoveItemWithinDrive instead.
4239 &quot;canMoveTeamDriveItem&quot;: True or False, # Deprecated - use canMoveItemWithinDrive or canMoveItemOutOfDrive instead.
4240 &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.
4241 &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.
4242 &quot;canReadTeamDrive&quot;: True or False, # Deprecated - use canReadDrive instead.
4243 &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.
4244 &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.
4245 &quot;canRename&quot;: True or False, # Whether the current user can rename this file.
4246 &quot;canShare&quot;: True or False, # Whether the current user can modify the sharing settings for this file.
4247 &quot;canTrash&quot;: True or False, # Whether the current user can move this file to trash.
4248 &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.
4249 &quot;canUntrash&quot;: True or False, # Whether the current user can restore this file from trash.
4250 },
4251 &quot;contentRestrictions&quot;: [ # Restrictions for accessing the content of the file. Only populated if such a restriction exists.
4252 { # A restriction for accessing the content of the file.
4253 &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.
4254 &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.
4255 &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]4256 &quot;displayName&quot;: &quot;A String&quot;, # A plain text displayable name for this user.
4257 &quot;emailAddress&quot;: &quot;A String&quot;, # The email address of the user.
4258 &quot;isAuthenticatedUser&quot;: True or False, # Whether this user is the same as the authenticated user for whom the request was made.
4259 &quot;kind&quot;: &quot;drive#user&quot;, # This is always drive#user.
4260 &quot;permissionId&quot;: &quot;A String&quot;, # The user&#x27;s ID as visible in the permissions collection.
4261 &quot;picture&quot;: { # The user&#x27;s profile picture.
4262 &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]4263 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]4264 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]4265 &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.
4266 &quot;type&quot;: &quot;A String&quot;, # The type of the content restriction. Currently the only possible value is globalContentRestriction.
4267 },
4268 ],
4269 &quot;copyRequiresWriterPermission&quot;: True or False, # Whether the options to copy, print, or download this file, should be disabled for readers and commenters.
4270 &quot;copyable&quot;: True or False, # Deprecated: use capabilities/canCopy.
4271 &quot;createdDate&quot;: &quot;A String&quot;, # Create time for this file (formatted RFC 3339 timestamp).
4272 &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.
4273 &quot;description&quot;: &quot;A String&quot;, # A short description of the file.
4274 &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.
4275 &quot;driveId&quot;: &quot;A String&quot;, # ID of the shared drive the file resides in. Only populated for items in shared drives.
4276 &quot;editable&quot;: True or False, # Deprecated: use capabilities/canEdit.
4277 &quot;embedLink&quot;: &quot;A String&quot;, # A link for embedding the file.
4278 &quot;etag&quot;: &quot;A String&quot;, # ETag of the file.
4279 &quot;explicitlyTrashed&quot;: True or False, # Whether this file has been explicitly trashed, as opposed to recursively trashed.
4280 &quot;exportLinks&quot;: { # Links for exporting Docs Editors files to specific formats.
4281 &quot;a_key&quot;: &quot;A String&quot;, # A mapping from export format to URL
4282 },
4283 &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.
4284 &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.
yoshi-code-botb539cc42021-08-03 00:20:27 -0700[diff] [blame]4285 &quot;folderColorRgb&quot;: &quot;A String&quot;, # Folder color as an RGB hex string if the file is a folder or a shortcut to 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.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]4286 &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.
4287 &quot;hasAugmentedPermissions&quot;: True or False, # Whether there are permissions directly on this file. This field is only populated for items in shared drives.
4288 &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.
4289 &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.
4290 &quot;iconLink&quot;: &quot;A String&quot;, # A link to the file&#x27;s icon.
4291 &quot;id&quot;: &quot;A String&quot;, # The ID of the file.
4292 &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.
4293 &quot;aperture&quot;: 3.14, # The aperture used to create the photo (f-number).
4294 &quot;cameraMake&quot;: &quot;A String&quot;, # The make of the camera used to create the photo.
4295 &quot;cameraModel&quot;: &quot;A String&quot;, # The model of the camera used to create the photo.
4296 &quot;colorSpace&quot;: &quot;A String&quot;, # The color space of the photo.
4297 &quot;date&quot;: &quot;A String&quot;, # The date and time the photo was taken (EXIF format timestamp).
4298 &quot;exposureBias&quot;: 3.14, # The exposure bias of the photo (APEX value).
4299 &quot;exposureMode&quot;: &quot;A String&quot;, # The exposure mode used to create the photo.
4300 &quot;exposureTime&quot;: 3.14, # The length of the exposure, in seconds.
4301 &quot;flashUsed&quot;: True or False, # Whether a flash was used to create the photo.
4302 &quot;focalLength&quot;: 3.14, # The focal length used to create the photo, in millimeters.
4303 &quot;height&quot;: 42, # The height of the image in pixels.
4304 &quot;isoSpeed&quot;: 42, # The ISO speed used to create the photo.
4305 &quot;lens&quot;: &quot;A String&quot;, # The lens used to create the photo.
4306 &quot;location&quot;: { # Geographic location information stored in the image.
4307 &quot;altitude&quot;: 3.14, # The altitude stored in the image.
4308 &quot;latitude&quot;: 3.14, # The latitude stored in the image.
4309 &quot;longitude&quot;: 3.14, # The longitude stored in the image.
4310 },
4311 &quot;maxApertureValue&quot;: 3.14, # The smallest f-number of the lens at the focal length used to create the photo (APEX value).
4312 &quot;meteringMode&quot;: &quot;A String&quot;, # The metering mode used to create the photo.
4313 &quot;rotation&quot;: 42, # The number of clockwise 90 degree rotations applied from the image&#x27;s original orientation.
4314 &quot;sensor&quot;: &quot;A String&quot;, # The type of sensor used to create the photo.
4315 &quot;subjectDistance&quot;: 42, # The distance to the subject of the photo, in meters.
4316 &quot;whiteBalance&quot;: &quot;A String&quot;, # The white balance mode used to create the photo.
4317 &quot;width&quot;: 42, # The width of the image in pixels.
4318 },
4319 &quot;indexableText&quot;: { # Indexable text attributes for the file (can only be written)
4320 &quot;text&quot;: &quot;A String&quot;, # The text to be indexed for this file.
4321 },
4322 &quot;isAppAuthorized&quot;: True or False, # Whether the file was created or opened by the requesting app.
4323 &quot;kind&quot;: &quot;drive#file&quot;, # The type of file. This is always drive#file.
4324 &quot;labels&quot;: { # A group of labels for the file.
4325 &quot;hidden&quot;: True or False, # Deprecated.
4326 &quot;modified&quot;: True or False, # Whether the file has been modified by this user.
4327 &quot;restricted&quot;: True or False, # Deprecated - use copyRequiresWriterPermission instead.
4328 &quot;starred&quot;: True or False, # Whether this file is starred by the user.
4329 &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.
4330 &quot;viewed&quot;: True or False, # Whether this file has been viewed by this user.
4331 },
4332 &quot;lastModifyingUser&quot;: { # Information about a Drive user. # The last user to modify this file.
4333 &quot;displayName&quot;: &quot;A String&quot;, # A plain text displayable name for this user.
4334 &quot;emailAddress&quot;: &quot;A String&quot;, # The email address of the user.
4335 &quot;isAuthenticatedUser&quot;: True or False, # Whether this user is the same as the authenticated user for whom the request was made.
4336 &quot;kind&quot;: &quot;drive#user&quot;, # This is always drive#user.
4337 &quot;permissionId&quot;: &quot;A String&quot;, # The user&#x27;s ID as visible in the permissions collection.
4338 &quot;picture&quot;: { # The user&#x27;s profile picture.
4339 &quot;url&quot;: &quot;A String&quot;, # A URL that points to a profile picture of this user.
4340 },
4341 },
4342 &quot;lastModifyingUserName&quot;: &quot;A String&quot;, # Name of the last user to modify this file.
4343 &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]4344 &quot;linkShareMetadata&quot;: { # Contains details about the link URLs that clients are using to refer to this item.
4345 &quot;securityUpdateEligible&quot;: True or False, # Whether the file is eligible for security update.
4346 &quot;securityUpdateEnabled&quot;: True or False, # Whether the security update is enabled for this file.
4347 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]4348 &quot;markedViewedByMeDate&quot;: &quot;A String&quot;, # Deprecated.
4349 &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.
4350 &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.
4351 &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.
4352 &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.
4353 &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.
4354 &quot;a_key&quot;: &quot;A String&quot;,
4355 },
4356 &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.
4357 &quot;ownedByMe&quot;: True or False, # Whether the file is owned by the current user. Not populated for items in shared drives.
4358 &quot;ownerNames&quot;: [ # Name(s) of the owner(s) of this file. Not populated for items in shared drives.
4359 &quot;A String&quot;,
4360 ],
yoshi-code-botab1d6dc2021-05-28 00:42:02 -0700[diff] [blame]4361 &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]4362 { # Information about a Drive user.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]4363 &quot;displayName&quot;: &quot;A String&quot;, # A plain text displayable name for this user.
4364 &quot;emailAddress&quot;: &quot;A String&quot;, # The email address of the user.
4365 &quot;isAuthenticatedUser&quot;: True or False, # Whether this user is the same as the authenticated user for whom the request was made.
4366 &quot;kind&quot;: &quot;drive#user&quot;, # This is always drive#user.
4367 &quot;permissionId&quot;: &quot;A String&quot;, # The user&#x27;s ID as visible in the permissions collection.
4368 &quot;picture&quot;: { # The user&#x27;s profile picture.
4369 &quot;url&quot;: &quot;A String&quot;, # A URL that points to a profile picture of this user.
4370 },
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]4371 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]4372 ],
4373 &quot;parents&quot;: [ # Collection of parent folders which contain this file.
4374 # 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.
4375 { # A reference to a file&#x27;s parent.
4376 &quot;id&quot;: &quot;A String&quot;, # The ID of the parent.
4377 &quot;isRoot&quot;: True or False, # Whether or not the parent is the root folder.
4378 &quot;kind&quot;: &quot;drive#parentReference&quot;, # This is always drive#parentReference.
4379 &quot;parentLink&quot;: &quot;A String&quot;, # A link to the parent.
4380 &quot;selfLink&quot;: &quot;A String&quot;, # A link back to this reference.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]4381 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]4382 ],
4383 &quot;permissionIds&quot;: [ # List of permission IDs for users with access to this file.
4384 &quot;A String&quot;,
4385 ],
4386 &quot;permissions&quot;: [ # The list of permissions for users with access to this file. Not populated for items in shared drives.
4387 { # A permission for a file.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]4388 &quot;additionalRoles&quot;: [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future.
4389 &quot;A String&quot;,
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]4390 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]4391 &quot;authKey&quot;: &quot;A String&quot;, # Deprecated.
4392 &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.
4393 &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.
4394 &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.
4395 &quot;etag&quot;: &quot;A String&quot;, # The ETag of the permission.
4396 &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]4397 # - They cannot be set on shared drive items
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]4398 # - They can only be set on user and group permissions
4399 # - The date must be in the future
4400 # - The date cannot be more than a year in the future
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4401 # - 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]4402 &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.
4403 &quot;kind&quot;: &quot;drive#permission&quot;, # This is always drive#permission.
4404 &quot;name&quot;: &quot;A String&quot;, # The name for this permission.
yoshi-code-bot815c1ac2021-11-15 23:24:17 -0800[diff] [blame]4405 &quot;pendingOwner&quot;: True or False, # Whether the account associated with this permission is a pending owner. Only populated for user type permissions for files that are not in a shared drive.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]4406 &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.
4407 {
4408 &quot;additionalRoles&quot;: [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future.
4409 &quot;A String&quot;,
4410 ],
4411 &quot;inherited&quot;: True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field.
4412 &quot;inheritedFrom&quot;: &quot;A String&quot;, # The ID of the item from which this permission is inherited. This is an output-only field.
4413 &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:
4414 # - file
4415 # - member
4416 &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:
4417 # - organizer
4418 # - fileOrganizer
4419 # - writer
4420 # - reader
4421 },
4422 ],
4423 &quot;photoLink&quot;: &quot;A String&quot;, # A link to the profile photo, if available.
4424 &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]4425 # - owner
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4426 # - organizer
4427 # - fileOrganizer
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]4428 # - writer
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4429 # - reader
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]4430 &quot;selfLink&quot;: &quot;A String&quot;, # A link back to this permission.
4431 &quot;teamDrivePermissionDetails&quot;: [ # Deprecated - use permissionDetails instead.
4432 {
4433 &quot;additionalRoles&quot;: [ # Deprecated - use permissionDetails/additionalRoles instead.
4434 &quot;A String&quot;,
4435 ],
4436 &quot;inherited&quot;: True or False, # Deprecated - use permissionDetails/inherited instead.
4437 &quot;inheritedFrom&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/inheritedFrom instead.
4438 &quot;role&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/role instead.
4439 &quot;teamDrivePermissionType&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/permissionType instead.
4440 },
4441 ],
4442 &quot;type&quot;: &quot;A String&quot;, # The account type. Allowed values are:
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]4443 # - user
4444 # - group
4445 # - domain
4446 # - anyone
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]4447 &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]4448 &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]4449 &quot;withLink&quot;: True or False, # Whether the link is required for this permission.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]4450 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]4451 ],
4452 &quot;properties&quot;: [ # The list of properties.
4453 { # A key-value pair attached to a file that is either public or private to an application.
4454 # The following limits apply to file properties:
4455 # - Maximum of 100 properties total per file
4456 # - Maximum of 30 private properties per app
4457 # - Maximum of 30 public properties
4458 # - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property.
4459 &quot;etag&quot;: &quot;A String&quot;, # ETag of the property.
4460 &quot;key&quot;: &quot;A String&quot;, # The key of this property.
4461 &quot;kind&quot;: &quot;drive#property&quot;, # This is always drive#property.
4462 &quot;selfLink&quot;: &quot;A String&quot;, # The link back to this property.
4463 &quot;value&quot;: &quot;A String&quot;, # The value of this property.
yoshi-code-bot69706592021-03-03 03:54:02 -0800[diff] [blame]4464 &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]4465 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]4466 ],
4467 &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]4468 &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]4469 &quot;selfLink&quot;: &quot;A String&quot;, # A link back to this file.
4470 &quot;shareable&quot;: True or False, # Deprecated: use capabilities/canShare.
4471 &quot;shared&quot;: True or False, # Whether the file has been shared. Not populated for items in shared drives.
4472 &quot;sharedWithMeDate&quot;: &quot;A String&quot;, # Time at which this file was shared with the user (formatted RFC 3339 timestamp).
4473 &quot;sharingUser&quot;: { # Information about a Drive user. # User that shared the item with the current user, if available.
4474 &quot;displayName&quot;: &quot;A String&quot;, # A plain text displayable name for this user.
4475 &quot;emailAddress&quot;: &quot;A String&quot;, # The email address of the user.
4476 &quot;isAuthenticatedUser&quot;: True or False, # Whether this user is the same as the authenticated user for whom the request was made.
4477 &quot;kind&quot;: &quot;drive#user&quot;, # This is always drive#user.
4478 &quot;permissionId&quot;: &quot;A String&quot;, # The user&#x27;s ID as visible in the permissions collection.
4479 &quot;picture&quot;: { # The user&#x27;s profile picture.
4480 &quot;url&quot;: &quot;A String&quot;, # A URL that points to a profile picture of this user.
4481 },
4482 },
4483 &quot;shortcutDetails&quot;: { # Shortcut file details. Only populated for shortcut files, which have the mimeType field set to application/vnd.google-apps.shortcut.
4484 &quot;targetId&quot;: &quot;A String&quot;, # The ID of the file that this shortcut points to.
4485 &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]4486 &quot;targetResourceKey&quot;: &quot;A String&quot;, # The ResourceKey for the target file.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]4487 },
4488 &quot;spaces&quot;: [ # The list of spaces which contain the file. Supported values are &#x27;drive&#x27;, &#x27;appDataFolder&#x27; and &#x27;photos&#x27;.
4489 &quot;A String&quot;,
4490 ],
4491 &quot;teamDriveId&quot;: &quot;A String&quot;, # Deprecated - use driveId instead.
4492 &quot;thumbnail&quot;: { # A thumbnail for the file. This will only be used if a standard thumbnail cannot be generated.
4493 &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.
4494 &quot;mimeType&quot;: &quot;A String&quot;, # The MIME type of the thumbnail.
4495 },
4496 &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.
4497 &quot;thumbnailVersion&quot;: &quot;A String&quot;, # The thumbnail version for use in thumbnail cache invalidation.
4498 &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.
4499 &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.
4500 &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.
4501 &quot;displayName&quot;: &quot;A String&quot;, # A plain text displayable name for this user.
4502 &quot;emailAddress&quot;: &quot;A String&quot;, # The email address of the user.
4503 &quot;isAuthenticatedUser&quot;: True or False, # Whether this user is the same as the authenticated user for whom the request was made.
4504 &quot;kind&quot;: &quot;drive#user&quot;, # This is always drive#user.
4505 &quot;permissionId&quot;: &quot;A String&quot;, # The user&#x27;s ID as visible in the permissions collection.
4506 &quot;picture&quot;: { # The user&#x27;s profile picture.
4507 &quot;url&quot;: &quot;A String&quot;, # A URL that points to a profile picture of this user.
4508 },
4509 },
4510 &quot;userPermission&quot;: { # A permission for a file. # The permissions for the authenticated user on this file.
4511 &quot;additionalRoles&quot;: [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future.
4512 &quot;A String&quot;,
4513 ],
4514 &quot;authKey&quot;: &quot;A String&quot;, # Deprecated.
4515 &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.
4516 &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.
4517 &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.
4518 &quot;etag&quot;: &quot;A String&quot;, # The ETag of the permission.
4519 &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:
4520 # - They cannot be set on shared drive items
4521 # - They can only be set on user and group permissions
4522 # - The date must be in the future
4523 # - The date cannot be more than a year in the future
4524 # - The date can only be set on drive.permissions.update or drive.permissions.patch requests
4525 &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.
4526 &quot;kind&quot;: &quot;drive#permission&quot;, # This is always drive#permission.
4527 &quot;name&quot;: &quot;A String&quot;, # The name for this permission.
yoshi-code-bot815c1ac2021-11-15 23:24:17 -0800[diff] [blame]4528 &quot;pendingOwner&quot;: True or False, # Whether the account associated with this permission is a pending owner. Only populated for user type permissions for files that are not in a shared drive.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]4529 &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.
4530 {
4531 &quot;additionalRoles&quot;: [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future.
4532 &quot;A String&quot;,
4533 ],
4534 &quot;inherited&quot;: True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field.
4535 &quot;inheritedFrom&quot;: &quot;A String&quot;, # The ID of the item from which this permission is inherited. This is an output-only field.
4536 &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:
4537 # - file
4538 # - member
4539 &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:
4540 # - organizer
4541 # - fileOrganizer
4542 # - writer
4543 # - reader
4544 },
4545 ],
4546 &quot;photoLink&quot;: &quot;A String&quot;, # A link to the profile photo, if available.
4547 &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:
4548 # - owner
4549 # - organizer
4550 # - fileOrganizer
4551 # - writer
4552 # - reader
4553 &quot;selfLink&quot;: &quot;A String&quot;, # A link back to this permission.
4554 &quot;teamDrivePermissionDetails&quot;: [ # Deprecated - use permissionDetails instead.
4555 {
4556 &quot;additionalRoles&quot;: [ # Deprecated - use permissionDetails/additionalRoles instead.
4557 &quot;A String&quot;,
4558 ],
4559 &quot;inherited&quot;: True or False, # Deprecated - use permissionDetails/inherited instead.
4560 &quot;inheritedFrom&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/inheritedFrom instead.
4561 &quot;role&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/role instead.
4562 &quot;teamDrivePermissionType&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/permissionType instead.
4563 },
4564 ],
4565 &quot;type&quot;: &quot;A String&quot;, # The account type. Allowed values are:
4566 # - user
4567 # - group
4568 # - domain
4569 # - anyone
4570 &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.
4571 &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.
4572 &quot;withLink&quot;: True or False, # Whether the link is required for this permission.
4573 },
4574 &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.
4575 &quot;videoMediaMetadata&quot;: { # Metadata about video media. This will only be present for video types.
4576 &quot;durationMillis&quot;: &quot;A String&quot;, # The duration of the video in milliseconds.
4577 &quot;height&quot;: 42, # The height of the video in pixels.
4578 &quot;width&quot;: 42, # The width of the video in pixels.
4579 },
4580 &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.
4581 &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.
4582 &quot;writersCanShare&quot;: True or False, # Whether writers can share the document with other users. Not populated for items in shared drives.
4583}</pre>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]4584</div>
4585
4586<div class="method">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]4587 <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>
yoshi-code-botad81f3d2021-09-28 00:22:30 -0700[diff] [blame]4588 <pre>Updates a file&#x27;s metadata and/or content. When calling this method, only populate fields in the request that you want to modify. When updating fields, some fields might be changed automatically, such as modifiedDate. This method supports patch semantics.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]4589
4590Args:
4591 fileId: string, The ID of the file to update. (required)
4592 body: object, The request body.
4593 The object takes the form of:
4594
4595{ # The metadata for a file.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]4596 &quot;alternateLink&quot;: &quot;A String&quot;, # A link for opening the file in a relevant Google editor or viewer.
4597 &quot;appDataContents&quot;: True or False, # Whether this file is in the Application Data folder.
4598 &quot;canComment&quot;: True or False, # Deprecated: use capabilities/canComment.
4599 &quot;canReadRevisions&quot;: True or False, # Deprecated: use capabilities/canReadRevisions.
4600 &quot;capabilities&quot;: { # Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take.
yoshi-code-bot815c1ac2021-11-15 23:24:17 -0800[diff] [blame]4601 &quot;canAcceptOwnership&quot;: True or False, # Whether the current user is the pending owner of the file. Not populated for shared drive files.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]4602 &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]4603 &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]4604 &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.
4605 &quot;canChangeCopyRequiresWriterPermission&quot;: True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this file.
4606 &quot;canChangeRestrictedDownload&quot;: True or False, # Deprecated
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700[diff] [blame]4607 &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]4608 &quot;canComment&quot;: True or False, # Whether the current user can comment on this file.
4609 &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.
4610 &quot;canDelete&quot;: True or False, # Whether the current user can delete this file.
4611 &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.
4612 &quot;canDownload&quot;: True or False, # Whether the current user can download this file.
4613 &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.
4614 &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.
4615 &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]4616 &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]4617 &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.
4618 &quot;canMoveChildrenOutOfTeamDrive&quot;: True or False, # Deprecated - use canMoveChildrenOutOfDrive instead.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]4619 &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]4620 &quot;canMoveChildrenWithinTeamDrive&quot;: True or False, # Deprecated - use canMoveChildrenWithinDrive instead.
4621 &quot;canMoveItemIntoTeamDrive&quot;: True or False, # Deprecated - use canMoveItemOutOfDrive instead.
4622 &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.
4623 &quot;canMoveItemOutOfTeamDrive&quot;: True or False, # Deprecated - use canMoveItemOutOfDrive instead.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]4624 &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]4625 &quot;canMoveItemWithinTeamDrive&quot;: True or False, # Deprecated - use canMoveItemWithinDrive instead.
4626 &quot;canMoveTeamDriveItem&quot;: True or False, # Deprecated - use canMoveItemWithinDrive or canMoveItemOutOfDrive instead.
4627 &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.
4628 &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.
4629 &quot;canReadTeamDrive&quot;: True or False, # Deprecated - use canReadDrive instead.
4630 &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.
4631 &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.
4632 &quot;canRename&quot;: True or False, # Whether the current user can rename this file.
4633 &quot;canShare&quot;: True or False, # Whether the current user can modify the sharing settings for this file.
4634 &quot;canTrash&quot;: True or False, # Whether the current user can move this file to trash.
4635 &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.
4636 &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]4637 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]4638 &quot;contentRestrictions&quot;: [ # Restrictions for accessing the content of the file. Only populated if such a restriction exists.
4639 { # A restriction for accessing the content of the file.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]4640 &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]4641 &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.
4642 &quot;restrictingUser&quot;: { # Information about a Drive user. # The user who set the content restriction. Only populated if readOnly is true.
4643 &quot;displayName&quot;: &quot;A String&quot;, # A plain text displayable name for this user.
4644 &quot;emailAddress&quot;: &quot;A String&quot;, # The email address of the user.
4645 &quot;isAuthenticatedUser&quot;: True or False, # Whether this user is the same as the authenticated user for whom the request was made.
4646 &quot;kind&quot;: &quot;drive#user&quot;, # This is always drive#user.
4647 &quot;permissionId&quot;: &quot;A String&quot;, # The user&#x27;s ID as visible in the permissions collection.
4648 &quot;picture&quot;: { # The user&#x27;s profile picture.
4649 &quot;url&quot;: &quot;A String&quot;, # A URL that points to a profile picture of this user.
4650 },
4651 },
4652 &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.
4653 &quot;type&quot;: &quot;A String&quot;, # The type of the content restriction. Currently the only possible value is globalContentRestriction.
4654 },
4655 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]4656 &quot;copyRequiresWriterPermission&quot;: True or False, # Whether the options to copy, print, or download this file, should be disabled for readers and commenters.
4657 &quot;copyable&quot;: True or False, # Deprecated: use capabilities/canCopy.
4658 &quot;createdDate&quot;: &quot;A String&quot;, # Create time for this file (formatted RFC 3339 timestamp).
4659 &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.
4660 &quot;description&quot;: &quot;A String&quot;, # A short description of the file.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]4661 &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]4662 &quot;driveId&quot;: &quot;A String&quot;, # ID of the shared drive the file resides in. Only populated for items in shared drives.
4663 &quot;editable&quot;: True or False, # Deprecated: use capabilities/canEdit.
4664 &quot;embedLink&quot;: &quot;A String&quot;, # A link for embedding the file.
4665 &quot;etag&quot;: &quot;A String&quot;, # ETag of the file.
4666 &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]4667 &quot;exportLinks&quot;: { # Links for exporting Docs Editors files to specific formats.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]4668 &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]4669 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]4670 &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.
4671 &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.
yoshi-code-botb539cc42021-08-03 00:20:27 -0700[diff] [blame]4672 &quot;folderColorRgb&quot;: &quot;A String&quot;, # Folder color as an RGB hex string if the file is a folder or a shortcut to 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.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]4673 &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]4674 &quot;hasAugmentedPermissions&quot;: True or False, # Whether there are permissions directly on this file. This field is only populated for items in shared drives.
4675 &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]4676 &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]4677 &quot;iconLink&quot;: &quot;A String&quot;, # A link to the file&#x27;s icon.
4678 &quot;id&quot;: &quot;A String&quot;, # The ID of the file.
4679 &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.
4680 &quot;aperture&quot;: 3.14, # The aperture used to create the photo (f-number).
4681 &quot;cameraMake&quot;: &quot;A String&quot;, # The make of the camera used to create the photo.
4682 &quot;cameraModel&quot;: &quot;A String&quot;, # The model of the camera used to create the photo.
4683 &quot;colorSpace&quot;: &quot;A String&quot;, # The color space of the photo.
4684 &quot;date&quot;: &quot;A String&quot;, # The date and time the photo was taken (EXIF format timestamp).
4685 &quot;exposureBias&quot;: 3.14, # The exposure bias of the photo (APEX value).
4686 &quot;exposureMode&quot;: &quot;A String&quot;, # The exposure mode used to create the photo.
4687 &quot;exposureTime&quot;: 3.14, # The length of the exposure, in seconds.
4688 &quot;flashUsed&quot;: True or False, # Whether a flash was used to create the photo.
4689 &quot;focalLength&quot;: 3.14, # The focal length used to create the photo, in millimeters.
4690 &quot;height&quot;: 42, # The height of the image in pixels.
4691 &quot;isoSpeed&quot;: 42, # The ISO speed used to create the photo.
4692 &quot;lens&quot;: &quot;A String&quot;, # The lens used to create the photo.
4693 &quot;location&quot;: { # Geographic location information stored in the image.
4694 &quot;altitude&quot;: 3.14, # The altitude stored in the image.
4695 &quot;latitude&quot;: 3.14, # The latitude stored in the image.
4696 &quot;longitude&quot;: 3.14, # The longitude stored in the image.
4697 },
4698 &quot;maxApertureValue&quot;: 3.14, # The smallest f-number of the lens at the focal length used to create the photo (APEX value).
4699 &quot;meteringMode&quot;: &quot;A String&quot;, # The metering mode used to create the photo.
4700 &quot;rotation&quot;: 42, # The number of clockwise 90 degree rotations applied from the image&#x27;s original orientation.
4701 &quot;sensor&quot;: &quot;A String&quot;, # The type of sensor used to create the photo.
4702 &quot;subjectDistance&quot;: 42, # The distance to the subject of the photo, in meters.
4703 &quot;whiteBalance&quot;: &quot;A String&quot;, # The white balance mode used to create the photo.
4704 &quot;width&quot;: 42, # The width of the image in pixels.
4705 },
4706 &quot;indexableText&quot;: { # Indexable text attributes for the file (can only be written)
4707 &quot;text&quot;: &quot;A String&quot;, # The text to be indexed for this file.
4708 },
4709 &quot;isAppAuthorized&quot;: True or False, # Whether the file was created or opened by the requesting app.
4710 &quot;kind&quot;: &quot;drive#file&quot;, # The type of file. This is always drive#file.
4711 &quot;labels&quot;: { # A group of labels for the file.
4712 &quot;hidden&quot;: True or False, # Deprecated.
4713 &quot;modified&quot;: True or False, # Whether the file has been modified by this user.
4714 &quot;restricted&quot;: True or False, # Deprecated - use copyRequiresWriterPermission instead.
4715 &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]4716 &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]4717 &quot;viewed&quot;: True or False, # Whether this file has been viewed by this user.
4718 },
4719 &quot;lastModifyingUser&quot;: { # Information about a Drive user. # The last user to modify this file.
4720 &quot;displayName&quot;: &quot;A String&quot;, # A plain text displayable name for this user.
4721 &quot;emailAddress&quot;: &quot;A String&quot;, # The email address of the user.
4722 &quot;isAuthenticatedUser&quot;: True or False, # Whether this user is the same as the authenticated user for whom the request was made.
4723 &quot;kind&quot;: &quot;drive#user&quot;, # This is always drive#user.
4724 &quot;permissionId&quot;: &quot;A String&quot;, # The user&#x27;s ID as visible in the permissions collection.
4725 &quot;picture&quot;: { # The user&#x27;s profile picture.
4726 &quot;url&quot;: &quot;A String&quot;, # A URL that points to a profile picture of this user.
4727 },
4728 },
4729 &quot;lastModifyingUserName&quot;: &quot;A String&quot;, # Name of the last user to modify this file.
4730 &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]4731 &quot;linkShareMetadata&quot;: { # Contains details about the link URLs that clients are using to refer to this item.
4732 &quot;securityUpdateEligible&quot;: True or False, # Whether the file is eligible for security update.
4733 &quot;securityUpdateEnabled&quot;: True or False, # Whether the security update is enabled for this file.
4734 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]4735 &quot;markedViewedByMeDate&quot;: &quot;A String&quot;, # Deprecated.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]4736 &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]4737 &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.
4738 &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.
4739 &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.
4740 &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.
4741 &quot;a_key&quot;: &quot;A String&quot;,
4742 },
4743 &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.
4744 &quot;ownedByMe&quot;: True or False, # Whether the file is owned by the current user. Not populated for items in shared drives.
4745 &quot;ownerNames&quot;: [ # Name(s) of the owner(s) of this file. Not populated for items in shared drives.
4746 &quot;A String&quot;,
4747 ],
yoshi-code-botab1d6dc2021-05-28 00:42:02 -0700[diff] [blame]4748 &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]4749 { # Information about a Drive user.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]4750 &quot;displayName&quot;: &quot;A String&quot;, # A plain text displayable name for this user.
4751 &quot;emailAddress&quot;: &quot;A String&quot;, # The email address of the user.
4752 &quot;isAuthenticatedUser&quot;: True or False, # Whether this user is the same as the authenticated user for whom the request was made.
4753 &quot;kind&quot;: &quot;drive#user&quot;, # This is always drive#user.
4754 &quot;permissionId&quot;: &quot;A String&quot;, # The user&#x27;s ID as visible in the permissions collection.
4755 &quot;picture&quot;: { # The user&#x27;s profile picture.
4756 &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]4757 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]4758 },
4759 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]4760 &quot;parents&quot;: [ # Collection of parent folders which contain this file.
4761 # 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.
4762 { # A reference to a file&#x27;s parent.
4763 &quot;id&quot;: &quot;A String&quot;, # The ID of the parent.
4764 &quot;isRoot&quot;: True or False, # Whether or not the parent is the root folder.
4765 &quot;kind&quot;: &quot;drive#parentReference&quot;, # This is always drive#parentReference.
4766 &quot;parentLink&quot;: &quot;A String&quot;, # A link to the parent.
4767 &quot;selfLink&quot;: &quot;A String&quot;, # A link back to this reference.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]4768 },
4769 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]4770 &quot;permissionIds&quot;: [ # List of permission IDs for users with access to this file.
4771 &quot;A String&quot;,
4772 ],
4773 &quot;permissions&quot;: [ # The list of permissions for users with access to this file. Not populated for items in shared drives.
4774 { # A permission for a file.
4775 &quot;additionalRoles&quot;: [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future.
4776 &quot;A String&quot;,
4777 ],
4778 &quot;authKey&quot;: &quot;A String&quot;, # Deprecated.
4779 &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.
4780 &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.
4781 &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.
4782 &quot;etag&quot;: &quot;A String&quot;, # The ETag of the permission.
4783 &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:
4784 # - They cannot be set on shared drive items
4785 # - They can only be set on user and group permissions
4786 # - The date must be in the future
4787 # - The date cannot be more than a year in the future
4788 # - The date can only be set on drive.permissions.update or drive.permissions.patch requests
4789 &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.
4790 &quot;kind&quot;: &quot;drive#permission&quot;, # This is always drive#permission.
4791 &quot;name&quot;: &quot;A String&quot;, # The name for this permission.
yoshi-code-bot815c1ac2021-11-15 23:24:17 -0800[diff] [blame]4792 &quot;pendingOwner&quot;: True or False, # Whether the account associated with this permission is a pending owner. Only populated for user type permissions for files that are not in a shared drive.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]4793 &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.
4794 {
4795 &quot;additionalRoles&quot;: [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future.
4796 &quot;A String&quot;,
4797 ],
4798 &quot;inherited&quot;: True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field.
4799 &quot;inheritedFrom&quot;: &quot;A String&quot;, # The ID of the item from which this permission is inherited. This is an output-only field.
4800 &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:
4801 # - file
4802 # - member
4803 &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:
4804 # - organizer
4805 # - fileOrganizer
4806 # - writer
4807 # - reader
4808 },
4809 ],
4810 &quot;photoLink&quot;: &quot;A String&quot;, # A link to the profile photo, if available.
4811 &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:
4812 # - owner
4813 # - organizer
4814 # - fileOrganizer
4815 # - writer
4816 # - reader
4817 &quot;selfLink&quot;: &quot;A String&quot;, # A link back to this permission.
4818 &quot;teamDrivePermissionDetails&quot;: [ # Deprecated - use permissionDetails instead.
4819 {
4820 &quot;additionalRoles&quot;: [ # Deprecated - use permissionDetails/additionalRoles instead.
4821 &quot;A String&quot;,
4822 ],
4823 &quot;inherited&quot;: True or False, # Deprecated - use permissionDetails/inherited instead.
4824 &quot;inheritedFrom&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/inheritedFrom instead.
4825 &quot;role&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/role instead.
4826 &quot;teamDrivePermissionType&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/permissionType instead.
4827 },
4828 ],
4829 &quot;type&quot;: &quot;A String&quot;, # The account type. Allowed values are:
4830 # - user
4831 # - group
4832 # - domain
4833 # - anyone
4834 &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]4835 &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]4836 &quot;withLink&quot;: True or False, # Whether the link is required for this permission.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]4837 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]4838 ],
4839 &quot;properties&quot;: [ # The list of properties.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]4840 { # A key-value pair attached to a file that is either public or private to an application.
4841 # The following limits apply to file properties:
4842 # - Maximum of 100 properties total per file
4843 # - Maximum of 30 private properties per app
4844 # - Maximum of 30 public properties
4845 # - 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]4846 &quot;etag&quot;: &quot;A String&quot;, # ETag of the property.
4847 &quot;key&quot;: &quot;A String&quot;, # The key of this property.
4848 &quot;kind&quot;: &quot;drive#property&quot;, # This is always drive#property.
4849 &quot;selfLink&quot;: &quot;A String&quot;, # The link back to this property.
4850 &quot;value&quot;: &quot;A String&quot;, # The value of this property.
yoshi-code-bot69706592021-03-03 03:54:02 -0800[diff] [blame]4851 &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]4852 },
4853 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]4854 &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]4855 &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]4856 &quot;selfLink&quot;: &quot;A String&quot;, # A link back to this file.
4857 &quot;shareable&quot;: True or False, # Deprecated: use capabilities/canShare.
4858 &quot;shared&quot;: True or False, # Whether the file has been shared. Not populated for items in shared drives.
4859 &quot;sharedWithMeDate&quot;: &quot;A String&quot;, # Time at which this file was shared with the user (formatted RFC 3339 timestamp).
4860 &quot;sharingUser&quot;: { # Information about a Drive user. # User that shared the item with the current user, if available.
4861 &quot;displayName&quot;: &quot;A String&quot;, # A plain text displayable name for this user.
4862 &quot;emailAddress&quot;: &quot;A String&quot;, # The email address of the user.
4863 &quot;isAuthenticatedUser&quot;: True or False, # Whether this user is the same as the authenticated user for whom the request was made.
4864 &quot;kind&quot;: &quot;drive#user&quot;, # This is always drive#user.
4865 &quot;permissionId&quot;: &quot;A String&quot;, # The user&#x27;s ID as visible in the permissions collection.
4866 &quot;picture&quot;: { # The user&#x27;s profile picture.
4867 &quot;url&quot;: &quot;A String&quot;, # A URL that points to a profile picture of this user.
4868 },
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]4869 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]4870 &quot;shortcutDetails&quot;: { # Shortcut file details. Only populated for shortcut files, which have the mimeType field set to application/vnd.google-apps.shortcut.
4871 &quot;targetId&quot;: &quot;A String&quot;, # The ID of the file that this shortcut points to.
4872 &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]4873 &quot;targetResourceKey&quot;: &quot;A String&quot;, # The ResourceKey for the target file.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]4874 },
4875 &quot;spaces&quot;: [ # The list of spaces which contain the file. Supported values are &#x27;drive&#x27;, &#x27;appDataFolder&#x27; and &#x27;photos&#x27;.
4876 &quot;A String&quot;,
4877 ],
4878 &quot;teamDriveId&quot;: &quot;A String&quot;, # Deprecated - use driveId instead.
4879 &quot;thumbnail&quot;: { # A thumbnail for the file. This will only be used if a standard thumbnail cannot be generated.
4880 &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.
4881 &quot;mimeType&quot;: &quot;A String&quot;, # The MIME type of the thumbnail.
4882 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]4883 &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]4884 &quot;thumbnailVersion&quot;: &quot;A String&quot;, # The thumbnail version for use in thumbnail cache invalidation.
4885 &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.
4886 &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.
4887 &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.
4888 &quot;displayName&quot;: &quot;A String&quot;, # A plain text displayable name for this user.
4889 &quot;emailAddress&quot;: &quot;A String&quot;, # The email address of the user.
4890 &quot;isAuthenticatedUser&quot;: True or False, # Whether this user is the same as the authenticated user for whom the request was made.
4891 &quot;kind&quot;: &quot;drive#user&quot;, # This is always drive#user.
4892 &quot;permissionId&quot;: &quot;A String&quot;, # The user&#x27;s ID as visible in the permissions collection.
4893 &quot;picture&quot;: { # The user&#x27;s profile picture.
4894 &quot;url&quot;: &quot;A String&quot;, # A URL that points to a profile picture of this user.
4895 },
4896 },
4897 &quot;userPermission&quot;: { # A permission for a file. # The permissions for the authenticated user on this file.
4898 &quot;additionalRoles&quot;: [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future.
4899 &quot;A String&quot;,
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]4900 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]4901 &quot;authKey&quot;: &quot;A String&quot;, # Deprecated.
4902 &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.
4903 &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.
4904 &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.
4905 &quot;etag&quot;: &quot;A String&quot;, # The ETag of the permission.
4906 &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]4907 # - They cannot be set on shared drive items
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]4908 # - They can only be set on user and group permissions
4909 # - The date must be in the future
4910 # - The date cannot be more than a year in the future
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4911 # - 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]4912 &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.
4913 &quot;kind&quot;: &quot;drive#permission&quot;, # This is always drive#permission.
4914 &quot;name&quot;: &quot;A String&quot;, # The name for this permission.
yoshi-code-bot815c1ac2021-11-15 23:24:17 -0800[diff] [blame]4915 &quot;pendingOwner&quot;: True or False, # Whether the account associated with this permission is a pending owner. Only populated for user type permissions for files that are not in a shared drive.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]4916 &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.
4917 {
4918 &quot;additionalRoles&quot;: [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future.
4919 &quot;A String&quot;,
4920 ],
4921 &quot;inherited&quot;: True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field.
4922 &quot;inheritedFrom&quot;: &quot;A String&quot;, # The ID of the item from which this permission is inherited. This is an output-only field.
4923 &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:
4924 # - file
4925 # - member
4926 &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:
4927 # - organizer
4928 # - fileOrganizer
4929 # - writer
4930 # - reader
4931 },
4932 ],
4933 &quot;photoLink&quot;: &quot;A String&quot;, # A link to the profile photo, if available.
4934 &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]4935 # - owner
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4936 # - organizer
4937 # - fileOrganizer
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]4938 # - writer
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4939 # - reader
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]4940 &quot;selfLink&quot;: &quot;A String&quot;, # A link back to this permission.
4941 &quot;teamDrivePermissionDetails&quot;: [ # Deprecated - use permissionDetails instead.
4942 {
4943 &quot;additionalRoles&quot;: [ # Deprecated - use permissionDetails/additionalRoles instead.
4944 &quot;A String&quot;,
4945 ],
4946 &quot;inherited&quot;: True or False, # Deprecated - use permissionDetails/inherited instead.
4947 &quot;inheritedFrom&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/inheritedFrom instead.
4948 &quot;role&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/role instead.
4949 &quot;teamDrivePermissionType&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/permissionType instead.
4950 },
4951 ],
4952 &quot;type&quot;: &quot;A String&quot;, # The account type. Allowed values are:
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]4953 # - user
4954 # - group
4955 # - domain
4956 # - anyone
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]4957 &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]4958 &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]4959 &quot;withLink&quot;: True or False, # Whether the link is required for this permission.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]4960 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]4961 &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.
4962 &quot;videoMediaMetadata&quot;: { # Metadata about video media. This will only be present for video types.
4963 &quot;durationMillis&quot;: &quot;A String&quot;, # The duration of the video in milliseconds.
4964 &quot;height&quot;: 42, # The height of the video in pixels.
4965 &quot;width&quot;: 42, # The width of the video in pixels.
4966 },
4967 &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.
4968 &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.
4969 &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]4970}
4971
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]4972 addParents: string, Comma-separated list of parent IDs to add.
4973 convert: boolean, This parameter is deprecated and has no function.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]4974 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]4975 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]4976 media_body: string, The filename of the media request body, or an instance of a MediaUpload object.
4977 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]4978 modifiedDateBehavior: string, Determines the behavior in which modifiedDate is updated. This overrides setModifiedDate.
4979 Allowed values
4980 fromBody - Set modifiedDate to the value provided in the body of the request. No change if no value was provided.
4981 fromBodyIfNeeded - Set modifiedDate to the value provided in the body of the request depending on other contents of the update.
4982 fromBodyOrNow - Set modifiedDate to the value provided in the body of the request, or to the current time if no value was provided.
4983 noChange - Maintain the previous value of modifiedDate.
4984 now - Set modifiedDate to the current time.
4985 nowIfNeeded - Set modifiedDate to the current time depending on contents of the update.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]4986 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]4987 ocr: boolean, Whether to attempt OCR on .jpg, .png, .gif, or .pdf uploads.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]4988 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]4989 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]4990 removeParents: string, Comma-separated list of parent IDs to remove.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4991 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]4992 supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]4993 supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]4994 timedTextLanguage: string, The language of the timed text.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]4995 timedTextTrackName: string, The timed text track name.
4996 updateViewedDate: boolean, Whether to update the view date after successfully updating the file.
4997 useContentAsIndexableText: boolean, Whether to use the content as indexable text.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]4998
4999Returns:
5000 An object of the form:
5001
5002 { # The metadata for a file.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]5003 &quot;alternateLink&quot;: &quot;A String&quot;, # A link for opening the file in a relevant Google editor or viewer.
5004 &quot;appDataContents&quot;: True or False, # Whether this file is in the Application Data folder.
5005 &quot;canComment&quot;: True or False, # Deprecated: use capabilities/canComment.
5006 &quot;canReadRevisions&quot;: True or False, # Deprecated: use capabilities/canReadRevisions.
5007 &quot;capabilities&quot;: { # Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take.
yoshi-code-bot815c1ac2021-11-15 23:24:17 -0800[diff] [blame]5008 &quot;canAcceptOwnership&quot;: True or False, # Whether the current user is the pending owner of the file. Not populated for shared drive files.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]5009 &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.
5010 &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.
5011 &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.
5012 &quot;canChangeCopyRequiresWriterPermission&quot;: True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this file.
5013 &quot;canChangeRestrictedDownload&quot;: True or False, # Deprecated
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700[diff] [blame]5014 &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]5015 &quot;canComment&quot;: True or False, # Whether the current user can comment on this file.
5016 &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.
5017 &quot;canDelete&quot;: True or False, # Whether the current user can delete this file.
5018 &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.
5019 &quot;canDownload&quot;: True or False, # Whether the current user can download this file.
5020 &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.
5021 &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.
5022 &quot;canModifyContent&quot;: True or False, # Whether the current user can modify the content of this file.
5023 &quot;canModifyContentRestriction&quot;: True or False, # Whether the current user can modify restrictions on content of this file.
5024 &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.
5025 &quot;canMoveChildrenOutOfTeamDrive&quot;: True or False, # Deprecated - use canMoveChildrenOutOfDrive instead.
5026 &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.
5027 &quot;canMoveChildrenWithinTeamDrive&quot;: True or False, # Deprecated - use canMoveChildrenWithinDrive instead.
5028 &quot;canMoveItemIntoTeamDrive&quot;: True or False, # Deprecated - use canMoveItemOutOfDrive instead.
5029 &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.
5030 &quot;canMoveItemOutOfTeamDrive&quot;: True or False, # Deprecated - use canMoveItemOutOfDrive instead.
5031 &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.
5032 &quot;canMoveItemWithinTeamDrive&quot;: True or False, # Deprecated - use canMoveItemWithinDrive instead.
5033 &quot;canMoveTeamDriveItem&quot;: True or False, # Deprecated - use canMoveItemWithinDrive or canMoveItemOutOfDrive instead.
5034 &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.
5035 &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.
5036 &quot;canReadTeamDrive&quot;: True or False, # Deprecated - use canReadDrive instead.
5037 &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.
5038 &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.
5039 &quot;canRename&quot;: True or False, # Whether the current user can rename this file.
5040 &quot;canShare&quot;: True or False, # Whether the current user can modify the sharing settings for this file.
5041 &quot;canTrash&quot;: True or False, # Whether the current user can move this file to trash.
5042 &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.
5043 &quot;canUntrash&quot;: True or False, # Whether the current user can restore this file from trash.
5044 },
5045 &quot;contentRestrictions&quot;: [ # Restrictions for accessing the content of the file. Only populated if such a restriction exists.
5046 { # A restriction for accessing the content of the file.
5047 &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.
5048 &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.
5049 &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]5050 &quot;displayName&quot;: &quot;A String&quot;, # A plain text displayable name for this user.
5051 &quot;emailAddress&quot;: &quot;A String&quot;, # The email address of the user.
5052 &quot;isAuthenticatedUser&quot;: True or False, # Whether this user is the same as the authenticated user for whom the request was made.
5053 &quot;kind&quot;: &quot;drive#user&quot;, # This is always drive#user.
5054 &quot;permissionId&quot;: &quot;A String&quot;, # The user&#x27;s ID as visible in the permissions collection.
5055 &quot;picture&quot;: { # The user&#x27;s profile picture.
5056 &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]5057 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]5058 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]5059 &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.
5060 &quot;type&quot;: &quot;A String&quot;, # The type of the content restriction. Currently the only possible value is globalContentRestriction.
5061 },
5062 ],
5063 &quot;copyRequiresWriterPermission&quot;: True or False, # Whether the options to copy, print, or download this file, should be disabled for readers and commenters.
5064 &quot;copyable&quot;: True or False, # Deprecated: use capabilities/canCopy.
5065 &quot;createdDate&quot;: &quot;A String&quot;, # Create time for this file (formatted RFC 3339 timestamp).
5066 &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.
5067 &quot;description&quot;: &quot;A String&quot;, # A short description of the file.
5068 &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.
5069 &quot;driveId&quot;: &quot;A String&quot;, # ID of the shared drive the file resides in. Only populated for items in shared drives.
5070 &quot;editable&quot;: True or False, # Deprecated: use capabilities/canEdit.
5071 &quot;embedLink&quot;: &quot;A String&quot;, # A link for embedding the file.
5072 &quot;etag&quot;: &quot;A String&quot;, # ETag of the file.
5073 &quot;explicitlyTrashed&quot;: True or False, # Whether this file has been explicitly trashed, as opposed to recursively trashed.
5074 &quot;exportLinks&quot;: { # Links for exporting Docs Editors files to specific formats.
5075 &quot;a_key&quot;: &quot;A String&quot;, # A mapping from export format to URL
5076 },
5077 &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.
5078 &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.
yoshi-code-botb539cc42021-08-03 00:20:27 -0700[diff] [blame]5079 &quot;folderColorRgb&quot;: &quot;A String&quot;, # Folder color as an RGB hex string if the file is a folder or a shortcut to 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.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]5080 &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.
5081 &quot;hasAugmentedPermissions&quot;: True or False, # Whether there are permissions directly on this file. This field is only populated for items in shared drives.
5082 &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.
5083 &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.
5084 &quot;iconLink&quot;: &quot;A String&quot;, # A link to the file&#x27;s icon.
5085 &quot;id&quot;: &quot;A String&quot;, # The ID of the file.
5086 &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.
5087 &quot;aperture&quot;: 3.14, # The aperture used to create the photo (f-number).
5088 &quot;cameraMake&quot;: &quot;A String&quot;, # The make of the camera used to create the photo.
5089 &quot;cameraModel&quot;: &quot;A String&quot;, # The model of the camera used to create the photo.
5090 &quot;colorSpace&quot;: &quot;A String&quot;, # The color space of the photo.
5091 &quot;date&quot;: &quot;A String&quot;, # The date and time the photo was taken (EXIF format timestamp).
5092 &quot;exposureBias&quot;: 3.14, # The exposure bias of the photo (APEX value).
5093 &quot;exposureMode&quot;: &quot;A String&quot;, # The exposure mode used to create the photo.
5094 &quot;exposureTime&quot;: 3.14, # The length of the exposure, in seconds.
5095 &quot;flashUsed&quot;: True or False, # Whether a flash was used to create the photo.
5096 &quot;focalLength&quot;: 3.14, # The focal length used to create the photo, in millimeters.
5097 &quot;height&quot;: 42, # The height of the image in pixels.
5098 &quot;isoSpeed&quot;: 42, # The ISO speed used to create the photo.
5099 &quot;lens&quot;: &quot;A String&quot;, # The lens used to create the photo.
5100 &quot;location&quot;: { # Geographic location information stored in the image.
5101 &quot;altitude&quot;: 3.14, # The altitude stored in the image.
5102 &quot;latitude&quot;: 3.14, # The latitude stored in the image.
5103 &quot;longitude&quot;: 3.14, # The longitude stored in the image.
5104 },
5105 &quot;maxApertureValue&quot;: 3.14, # The smallest f-number of the lens at the focal length used to create the photo (APEX value).
5106 &quot;meteringMode&quot;: &quot;A String&quot;, # The metering mode used to create the photo.
5107 &quot;rotation&quot;: 42, # The number of clockwise 90 degree rotations applied from the image&#x27;s original orientation.
5108 &quot;sensor&quot;: &quot;A String&quot;, # The type of sensor used to create the photo.
5109 &quot;subjectDistance&quot;: 42, # The distance to the subject of the photo, in meters.
5110 &quot;whiteBalance&quot;: &quot;A String&quot;, # The white balance mode used to create the photo.
5111 &quot;width&quot;: 42, # The width of the image in pixels.
5112 },
5113 &quot;indexableText&quot;: { # Indexable text attributes for the file (can only be written)
5114 &quot;text&quot;: &quot;A String&quot;, # The text to be indexed for this file.
5115 },
5116 &quot;isAppAuthorized&quot;: True or False, # Whether the file was created or opened by the requesting app.
5117 &quot;kind&quot;: &quot;drive#file&quot;, # The type of file. This is always drive#file.
5118 &quot;labels&quot;: { # A group of labels for the file.
5119 &quot;hidden&quot;: True or False, # Deprecated.
5120 &quot;modified&quot;: True or False, # Whether the file has been modified by this user.
5121 &quot;restricted&quot;: True or False, # Deprecated - use copyRequiresWriterPermission instead.
5122 &quot;starred&quot;: True or False, # Whether this file is starred by the user.
5123 &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.
5124 &quot;viewed&quot;: True or False, # Whether this file has been viewed by this user.
5125 },
5126 &quot;lastModifyingUser&quot;: { # Information about a Drive user. # The last user to modify this file.
5127 &quot;displayName&quot;: &quot;A String&quot;, # A plain text displayable name for this user.
5128 &quot;emailAddress&quot;: &quot;A String&quot;, # The email address of the user.
5129 &quot;isAuthenticatedUser&quot;: True or False, # Whether this user is the same as the authenticated user for whom the request was made.
5130 &quot;kind&quot;: &quot;drive#user&quot;, # This is always drive#user.
5131 &quot;permissionId&quot;: &quot;A String&quot;, # The user&#x27;s ID as visible in the permissions collection.
5132 &quot;picture&quot;: { # The user&#x27;s profile picture.
5133 &quot;url&quot;: &quot;A String&quot;, # A URL that points to a profile picture of this user.
5134 },
5135 },
5136 &quot;lastModifyingUserName&quot;: &quot;A String&quot;, # Name of the last user to modify this file.
5137 &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]5138 &quot;linkShareMetadata&quot;: { # Contains details about the link URLs that clients are using to refer to this item.
5139 &quot;securityUpdateEligible&quot;: True or False, # Whether the file is eligible for security update.
5140 &quot;securityUpdateEnabled&quot;: True or False, # Whether the security update is enabled for this file.
5141 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]5142 &quot;markedViewedByMeDate&quot;: &quot;A String&quot;, # Deprecated.
5143 &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.
5144 &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.
5145 &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.
5146 &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.
5147 &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.
5148 &quot;a_key&quot;: &quot;A String&quot;,
5149 },
5150 &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.
5151 &quot;ownedByMe&quot;: True or False, # Whether the file is owned by the current user. Not populated for items in shared drives.
5152 &quot;ownerNames&quot;: [ # Name(s) of the owner(s) of this file. Not populated for items in shared drives.
5153 &quot;A String&quot;,
5154 ],
yoshi-code-botab1d6dc2021-05-28 00:42:02 -0700[diff] [blame]5155 &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]5156 { # Information about a Drive user.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]5157 &quot;displayName&quot;: &quot;A String&quot;, # A plain text displayable name for this user.
5158 &quot;emailAddress&quot;: &quot;A String&quot;, # The email address of the user.
5159 &quot;isAuthenticatedUser&quot;: True or False, # Whether this user is the same as the authenticated user for whom the request was made.
5160 &quot;kind&quot;: &quot;drive#user&quot;, # This is always drive#user.
5161 &quot;permissionId&quot;: &quot;A String&quot;, # The user&#x27;s ID as visible in the permissions collection.
5162 &quot;picture&quot;: { # The user&#x27;s profile picture.
5163 &quot;url&quot;: &quot;A String&quot;, # A URL that points to a profile picture of this user.
5164 },
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]5165 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]5166 ],
5167 &quot;parents&quot;: [ # Collection of parent folders which contain this file.
5168 # 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.
5169 { # A reference to a file&#x27;s parent.
5170 &quot;id&quot;: &quot;A String&quot;, # The ID of the parent.
5171 &quot;isRoot&quot;: True or False, # Whether or not the parent is the root folder.
5172 &quot;kind&quot;: &quot;drive#parentReference&quot;, # This is always drive#parentReference.
5173 &quot;parentLink&quot;: &quot;A String&quot;, # A link to the parent.
5174 &quot;selfLink&quot;: &quot;A String&quot;, # A link back to this reference.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]5175 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]5176 ],
5177 &quot;permissionIds&quot;: [ # List of permission IDs for users with access to this file.
5178 &quot;A String&quot;,
5179 ],
5180 &quot;permissions&quot;: [ # The list of permissions for users with access to this file. Not populated for items in shared drives.
5181 { # A permission for a file.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]5182 &quot;additionalRoles&quot;: [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future.
5183 &quot;A String&quot;,
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]5184 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]5185 &quot;authKey&quot;: &quot;A String&quot;, # Deprecated.
5186 &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.
5187 &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.
5188 &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.
5189 &quot;etag&quot;: &quot;A String&quot;, # The ETag of the permission.
5190 &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]5191 # - They cannot be set on shared drive items
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]5192 # - They can only be set on user and group permissions
5193 # - The date must be in the future
5194 # - The date cannot be more than a year in the future
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5195 # - 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]5196 &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.
5197 &quot;kind&quot;: &quot;drive#permission&quot;, # This is always drive#permission.
5198 &quot;name&quot;: &quot;A String&quot;, # The name for this permission.
yoshi-code-bot815c1ac2021-11-15 23:24:17 -0800[diff] [blame]5199 &quot;pendingOwner&quot;: True or False, # Whether the account associated with this permission is a pending owner. Only populated for user type permissions for files that are not in a shared drive.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]5200 &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.
5201 {
5202 &quot;additionalRoles&quot;: [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future.
5203 &quot;A String&quot;,
5204 ],
5205 &quot;inherited&quot;: True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field.
5206 &quot;inheritedFrom&quot;: &quot;A String&quot;, # The ID of the item from which this permission is inherited. This is an output-only field.
5207 &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:
5208 # - file
5209 # - member
5210 &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:
5211 # - organizer
5212 # - fileOrganizer
5213 # - writer
5214 # - reader
5215 },
5216 ],
5217 &quot;photoLink&quot;: &quot;A String&quot;, # A link to the profile photo, if available.
5218 &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]5219 # - owner
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5220 # - organizer
5221 # - fileOrganizer
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]5222 # - writer
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5223 # - reader
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]5224 &quot;selfLink&quot;: &quot;A String&quot;, # A link back to this permission.
5225 &quot;teamDrivePermissionDetails&quot;: [ # Deprecated - use permissionDetails instead.
5226 {
5227 &quot;additionalRoles&quot;: [ # Deprecated - use permissionDetails/additionalRoles instead.
5228 &quot;A String&quot;,
5229 ],
5230 &quot;inherited&quot;: True or False, # Deprecated - use permissionDetails/inherited instead.
5231 &quot;inheritedFrom&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/inheritedFrom instead.
5232 &quot;role&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/role instead.
5233 &quot;teamDrivePermissionType&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/permissionType instead.
5234 },
5235 ],
5236 &quot;type&quot;: &quot;A String&quot;, # The account type. Allowed values are:
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]5237 # - user
5238 # - group
5239 # - domain
5240 # - anyone
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]5241 &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]5242 &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]5243 &quot;withLink&quot;: True or False, # Whether the link is required for this permission.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]5244 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]5245 ],
5246 &quot;properties&quot;: [ # The list of properties.
5247 { # A key-value pair attached to a file that is either public or private to an application.
5248 # The following limits apply to file properties:
5249 # - Maximum of 100 properties total per file
5250 # - Maximum of 30 private properties per app
5251 # - Maximum of 30 public properties
5252 # - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property.
5253 &quot;etag&quot;: &quot;A String&quot;, # ETag of the property.
5254 &quot;key&quot;: &quot;A String&quot;, # The key of this property.
5255 &quot;kind&quot;: &quot;drive#property&quot;, # This is always drive#property.
5256 &quot;selfLink&quot;: &quot;A String&quot;, # The link back to this property.
5257 &quot;value&quot;: &quot;A String&quot;, # The value of this property.
yoshi-code-bot69706592021-03-03 03:54:02 -0800[diff] [blame]5258 &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]5259 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]5260 ],
5261 &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]5262 &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]5263 &quot;selfLink&quot;: &quot;A String&quot;, # A link back to this file.
5264 &quot;shareable&quot;: True or False, # Deprecated: use capabilities/canShare.
5265 &quot;shared&quot;: True or False, # Whether the file has been shared. Not populated for items in shared drives.
5266 &quot;sharedWithMeDate&quot;: &quot;A String&quot;, # Time at which this file was shared with the user (formatted RFC 3339 timestamp).
5267 &quot;sharingUser&quot;: { # Information about a Drive user. # User that shared the item with the current user, if available.
5268 &quot;displayName&quot;: &quot;A String&quot;, # A plain text displayable name for this user.
5269 &quot;emailAddress&quot;: &quot;A String&quot;, # The email address of the user.
5270 &quot;isAuthenticatedUser&quot;: True or False, # Whether this user is the same as the authenticated user for whom the request was made.
5271 &quot;kind&quot;: &quot;drive#user&quot;, # This is always drive#user.
5272 &quot;permissionId&quot;: &quot;A String&quot;, # The user&#x27;s ID as visible in the permissions collection.
5273 &quot;picture&quot;: { # The user&#x27;s profile picture.
5274 &quot;url&quot;: &quot;A String&quot;, # A URL that points to a profile picture of this user.
5275 },
5276 },
5277 &quot;shortcutDetails&quot;: { # Shortcut file details. Only populated for shortcut files, which have the mimeType field set to application/vnd.google-apps.shortcut.
5278 &quot;targetId&quot;: &quot;A String&quot;, # The ID of the file that this shortcut points to.
5279 &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]5280 &quot;targetResourceKey&quot;: &quot;A String&quot;, # The ResourceKey for the target file.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]5281 },
5282 &quot;spaces&quot;: [ # The list of spaces which contain the file. Supported values are &#x27;drive&#x27;, &#x27;appDataFolder&#x27; and &#x27;photos&#x27;.
5283 &quot;A String&quot;,
5284 ],
5285 &quot;teamDriveId&quot;: &quot;A String&quot;, # Deprecated - use driveId instead.
5286 &quot;thumbnail&quot;: { # A thumbnail for the file. This will only be used if a standard thumbnail cannot be generated.
5287 &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.
5288 &quot;mimeType&quot;: &quot;A String&quot;, # The MIME type of the thumbnail.
5289 },
5290 &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.
5291 &quot;thumbnailVersion&quot;: &quot;A String&quot;, # The thumbnail version for use in thumbnail cache invalidation.
5292 &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.
5293 &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.
5294 &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.
5295 &quot;displayName&quot;: &quot;A String&quot;, # A plain text displayable name for this user.
5296 &quot;emailAddress&quot;: &quot;A String&quot;, # The email address of the user.
5297 &quot;isAuthenticatedUser&quot;: True or False, # Whether this user is the same as the authenticated user for whom the request was made.
5298 &quot;kind&quot;: &quot;drive#user&quot;, # This is always drive#user.
5299 &quot;permissionId&quot;: &quot;A String&quot;, # The user&#x27;s ID as visible in the permissions collection.
5300 &quot;picture&quot;: { # The user&#x27;s profile picture.
5301 &quot;url&quot;: &quot;A String&quot;, # A URL that points to a profile picture of this user.
5302 },
5303 },
5304 &quot;userPermission&quot;: { # A permission for a file. # The permissions for the authenticated user on this file.
5305 &quot;additionalRoles&quot;: [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future.
5306 &quot;A String&quot;,
5307 ],
5308 &quot;authKey&quot;: &quot;A String&quot;, # Deprecated.
5309 &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.
5310 &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.
5311 &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.
5312 &quot;etag&quot;: &quot;A String&quot;, # The ETag of the permission.
5313 &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:
5314 # - They cannot be set on shared drive items
5315 # - They can only be set on user and group permissions
5316 # - The date must be in the future
5317 # - The date cannot be more than a year in the future
5318 # - The date can only be set on drive.permissions.update or drive.permissions.patch requests
5319 &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.
5320 &quot;kind&quot;: &quot;drive#permission&quot;, # This is always drive#permission.
5321 &quot;name&quot;: &quot;A String&quot;, # The name for this permission.
yoshi-code-bot815c1ac2021-11-15 23:24:17 -0800[diff] [blame]5322 &quot;pendingOwner&quot;: True or False, # Whether the account associated with this permission is a pending owner. Only populated for user type permissions for files that are not in a shared drive.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]5323 &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.
5324 {
5325 &quot;additionalRoles&quot;: [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future.
5326 &quot;A String&quot;,
5327 ],
5328 &quot;inherited&quot;: True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field.
5329 &quot;inheritedFrom&quot;: &quot;A String&quot;, # The ID of the item from which this permission is inherited. This is an output-only field.
5330 &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:
5331 # - file
5332 # - member
5333 &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:
5334 # - organizer
5335 # - fileOrganizer
5336 # - writer
5337 # - reader
5338 },
5339 ],
5340 &quot;photoLink&quot;: &quot;A String&quot;, # A link to the profile photo, if available.
5341 &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:
5342 # - owner
5343 # - organizer
5344 # - fileOrganizer
5345 # - writer
5346 # - reader
5347 &quot;selfLink&quot;: &quot;A String&quot;, # A link back to this permission.
5348 &quot;teamDrivePermissionDetails&quot;: [ # Deprecated - use permissionDetails instead.
5349 {
5350 &quot;additionalRoles&quot;: [ # Deprecated - use permissionDetails/additionalRoles instead.
5351 &quot;A String&quot;,
5352 ],
5353 &quot;inherited&quot;: True or False, # Deprecated - use permissionDetails/inherited instead.
5354 &quot;inheritedFrom&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/inheritedFrom instead.
5355 &quot;role&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/role instead.
5356 &quot;teamDrivePermissionType&quot;: &quot;A String&quot;, # Deprecated - use permissionDetails/permissionType instead.
5357 },
5358 ],
5359 &quot;type&quot;: &quot;A String&quot;, # The account type. Allowed values are:
5360 # - user
5361 # - group
5362 # - domain
5363 # - anyone
5364 &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.
5365 &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.
5366 &quot;withLink&quot;: True or False, # Whether the link is required for this permission.
5367 },
5368 &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.
5369 &quot;videoMediaMetadata&quot;: { # Metadata about video media. This will only be present for video types.
5370 &quot;durationMillis&quot;: &quot;A String&quot;, # The duration of the video in milliseconds.
5371 &quot;height&quot;: 42, # The height of the video in pixels.
5372 &quot;width&quot;: 42, # The width of the video in pixels.
5373 },
5374 &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.
5375 &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.
5376 &quot;writersCanShare&quot;: True or False, # Whether writers can share the document with other users. Not populated for items in shared drives.
5377}</pre>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]5378</div>
5379
5380<div class="method">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]5381 <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]5382 <pre>Subscribe to changes on a file
5383
5384Args:
5385 fileId: string, The ID for the file in question. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]5386 body: object, The request body.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]5387 The object takes the form of:
5388
5389{ # An notification channel used to watch for resource changes.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]5390 &quot;address&quot;: &quot;A String&quot;, # The address where notifications are delivered for this channel.
5391 &quot;expiration&quot;: &quot;A String&quot;, # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.
5392 &quot;id&quot;: &quot;A String&quot;, # A UUID or similar unique string that identifies this channel.
5393 &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;.
5394 &quot;params&quot;: { # Additional parameters controlling delivery channel behavior. Optional.
5395 &quot;a_key&quot;: &quot;A String&quot;, # Declares a new parameter by name.
5396 },
5397 &quot;payload&quot;: True or False, # A Boolean value to indicate whether payload is wanted. Optional.
5398 &quot;resourceId&quot;: &quot;A String&quot;, # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.
5399 &quot;resourceUri&quot;: &quot;A String&quot;, # A version-specific identifier for the watched resource.
5400 &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]5401 &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]5402}
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]5403
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]5404 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]5405 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]5406 projection: string, This parameter is deprecated and has no function.
5407 Allowed values
5408 BASIC - Deprecated
5409 FULL - Deprecated
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]5410 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]5411 supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]5412 supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]5413 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]5414
5415Returns:
5416 An object of the form:
5417
5418 { # An notification channel used to watch for resource changes.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]5419 &quot;address&quot;: &quot;A String&quot;, # The address where notifications are delivered for this channel.
5420 &quot;expiration&quot;: &quot;A String&quot;, # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.
5421 &quot;id&quot;: &quot;A String&quot;, # A UUID or similar unique string that identifies this channel.
5422 &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;.
5423 &quot;params&quot;: { # Additional parameters controlling delivery channel behavior. Optional.
5424 &quot;a_key&quot;: &quot;A String&quot;, # Declares a new parameter by name.
5425 },
5426 &quot;payload&quot;: True or False, # A Boolean value to indicate whether payload is wanted. Optional.
5427 &quot;resourceId&quot;: &quot;A String&quot;, # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.
5428 &quot;resourceUri&quot;: &quot;A String&quot;, # A version-specific identifier for the watched resource.
5429 &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]5430 &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]5431}</pre>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]5432</div>
5433
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]5434<div class="method">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]5435 <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]5436 <pre>Subscribe to changes on a file
5437
5438Args:
5439 fileId: string, The ID for the file in question. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]5440 body: object, The request body.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]5441 The object takes the form of:
5442
5443{ # An notification channel used to watch for resource changes.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]5444 &quot;address&quot;: &quot;A String&quot;, # The address where notifications are delivered for this channel.
5445 &quot;expiration&quot;: &quot;A String&quot;, # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.
5446 &quot;id&quot;: &quot;A String&quot;, # A UUID or similar unique string that identifies this channel.
5447 &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;.
5448 &quot;params&quot;: { # Additional parameters controlling delivery channel behavior. Optional.
5449 &quot;a_key&quot;: &quot;A String&quot;, # Declares a new parameter by name.
5450 },
5451 &quot;payload&quot;: True or False, # A Boolean value to indicate whether payload is wanted. Optional.
5452 &quot;resourceId&quot;: &quot;A String&quot;, # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.
5453 &quot;resourceUri&quot;: &quot;A String&quot;, # A version-specific identifier for the watched resource.
5454 &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]5455 &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]5456}
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]5457
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]5458 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]5459 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]5460 projection: string, This parameter is deprecated and has no function.
5461 Allowed values
5462 BASIC - Deprecated
5463 FULL - Deprecated
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]5464 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]5465 supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]5466 supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]5467 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]5468
5469Returns:
5470 The media object as a string.
5471
5472 </pre>
5473</div>
5474
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]5475</body></html>