Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 065b5307fe180bfdd4a5d9af134b1c9a0a1d2aba / . / docs / dyn / drive_v2.changes.html
blob: e197484dc638cd14f9134c616c6e16bb467a4ead [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.changes.html">changes</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#get">get(changeId)</a></code></p>
79<p class="firstline">Gets a specific change.</p>
80<p class="toc_element">
81 <code><a href="#list">list(includeSubscribed=None, includeDeleted=None, pageToken=None, maxResults=None, startChangeId=None)</a></code></p>
82<p class="firstline">Lists the changes for a user.</p>
83<p class="toc_element">
84 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
85<p class="firstline">Retrieves the next page of results.</p>
86<p class="toc_element">
87 <code><a href="#watch">watch(body, includeSubscribed=None, includeDeleted=None, pageToken=None, maxResults=None, startChangeId=None)</a></code></p>
88<p class="firstline">Subscribe to changes for a user.</p>
89<h3>Method Details</h3>
90<div class="method">
91 <code class="details" id="get">get(changeId)</code>
92 <pre>Gets a specific change.
93
94Args:
95 changeId: string, The ID of the change. (required)
96
97Returns:
98 An object of the form:
99
100 { # Representation of a change to a file.
101 "kind": "drive#change", # This is always drive#change.
102 "deleted": True or False, # Whether the file has been deleted.
103 "file": { # The metadata for a file. # The updated state of the file. Present if the file has not been deleted.
104 "mimeType": "A String", # The MIME type of the file. This is only mutable on update when uploading new content. This field can be left blank, and the mimetype will be determined from the uploaded content's MIME type.
105 "lastViewedByMeDate": "A String", # Last time this file was viewed by the user (formatted RFC 3339 timestamp).
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame^]106 "version": "A String", # A monotonically increasing version number for the file. This reflects every change made to the file on the server, even those not visible to the requesting user.
107 "appDataContents": True or False, # Whether this file is in the Application Data folder.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]108 "thumbnailLink": "A String", # A link to the file's thumbnail.
109 "labels": { # A group of labels for the file.
110 "restricted": True or False, # Whether viewers are prevented from downloading this file.
111 "hidden": True or False, # Deprecated.
112 "viewed": True or False, # Whether this file has been viewed by this user.
113 "starred": True or False, # Whether this file is starred by the user.
114 "trashed": True or False, # Whether this file has been trashed.
115 },
116 "indexableText": { # Indexable text attributes for the file (can only be written)
117 "text": "A String", # The text to be indexed for this file.
118 },
119 "explicitlyTrashed": True or False, # Whether this file has been explicitly trashed, as opposed to recursively trashed. This will only be populated if the file is trashed.
120 "lastModifyingUserName": "A String", # Name of the last user to modify this file.
121 "writersCanShare": True or False, # Whether writers can share the document with other users.
122 "owners": [ # The owner(s) of this file.
123 { # The JSON template for a user.
124 "picture": { # The user's profile picture.
125 "url": "A String", # A URL that points to a profile picture of this user.
126 },
127 "kind": "drive#user", # This is always drive#user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]128 "displayName": "A String", # A plain text displayable name for this user.
129 "permissionId": "A String", # The user's ID as visible in the permissions collection.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame^]130 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
131 "emailAddress": "A String", # The email address of the user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]132 },
133 ],
134 "id": "A String", # The ID of the file.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame^]135 "sharingUser": { # The JSON template for a user. # User that shared the item with the current user, if available.
136 "picture": { # The user's profile picture.
137 "url": "A String", # A URL that points to a profile picture of this user.
138 },
139 "kind": "drive#user", # This is always drive#user.
140 "displayName": "A String", # A plain text displayable name for this user.
141 "permissionId": "A String", # The user's ID as visible in the permissions collection.
142 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
143 "emailAddress": "A String", # The email address of the user.
144 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]145 "lastModifyingUser": { # The JSON template for a user. # The last user to modify this file.
146 "picture": { # The user's profile picture.
147 "url": "A String", # A URL that points to a profile picture of this user.
148 },
149 "kind": "drive#user", # This is always drive#user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]150 "displayName": "A String", # A plain text displayable name for this user.
151 "permissionId": "A String", # The user's ID as visible in the permissions collection.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame^]152 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
153 "emailAddress": "A String", # The email address of the user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]154 },
155 "copyable": True or False, # Whether the file can be copied by the current user.
156 "ownerNames": [ # Name(s) of the owner(s) of this file.
157 "A String",
158 ],
159 "sharedWithMeDate": "A String", # Time at which this file was shared with the user (formatted RFC 3339 timestamp).
160 "webViewLink": "A String", # A link only available on public folders for viewing their static web assets (HTML, CSS, JS, etc) via Google Drive's Website Hosting.
161 "etag": "A String", # ETag of the file.
162 "parents": [ # Collection of parent folders which contain this file.
163 # Setting this field will put the file in all of the provided folders. On insert, if no folders are provided, the file will be placed in the default root folder.
164 { # A reference to a file's parent.
165 "selfLink": "A String", # A link back to this reference.
166 "kind": "drive#parentReference", # This is always drive#parentReference.
167 "id": "A String", # The ID of the parent.
168 "isRoot": True or False, # Whether or not the parent is the root folder.
169 "parentLink": "A String", # A link to the parent.
170 },
171 ],
172 "exportLinks": { # Links for exporting Google Docs to specific formats.
173 "a_key": "A String", # A mapping from export format to URL
174 },
175 "shared": True or False, # Whether the file has been shared.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame^]176 "permissions": [ # The list of permissions for users with access to this file.
177 { # A permission for a file.
178 "withLink": True or False, # Whether the link is required for this permission.
179 "domain": "A String", # The domain name of the entity this permission refers to. This is an output-only field which is present when the permission type is user, group or domain.
180 "name": "A String", # The name for this permission.
181 "kind": "drive#permission", # This is always drive#permission.
182 "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified.
183 "id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified.
184 "authKey": "A String", # The authkey parameter required for this permission.
185 "etag": "A String", # The ETag of the permission.
186 "emailAddress": "A String", # The email address of the user this permission refers to. This is an output-only field which is present when the permission type is user and the given user's Google+ profile privacy settings allow exposing their email address.
187 "photoLink": "A String", # A link to the profile photo, if available.
188 "role": "A String", # The primary role for this user. Allowed values are:
189 # - owner
190 # - reader
191 # - writer
192 "type": "A String", # The account type. Allowed values are:
193 # - user
194 # - group
195 # - domain
196 # - anyone
197 "additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed.
198 "A String",
199 ],
200 "selfLink": "A String", # A link back to this permission.
201 },
202 ],
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]203 "thumbnail": { # Thumbnail for the file. Only accepted on upload and for files that are not already thumbnailed by Google.
204 "mimeType": "A String", # The MIME type of the thumbnail.
205 "image": "A String", # The URL-safe Base64 encoded bytes of the thumbnail image.
206 },
207 "openWithLinks": { # A map of the id of each of the user's apps to a link to open this file with that app. Only populated when the drive.apps.readonly scope is used.
208 "a_key": "A String",
209 },
210 "imageMediaMetadata": { # Metadata about image media. This will only be present for image types, and its contents will depend on what can be parsed from the image content.
211 "exposureBias": 3.14, # The exposure bias of the photo (APEX value).
212 "exposureTime": 3.14, # The length of the exposure, in seconds.
213 "cameraMake": "A String", # The make of the camera used to create the photo.
214 "maxApertureValue": 3.14, # The smallest f-number of the lens at the focal length used to create the photo (APEX value).
215 "isoSpeed": 42, # The ISO speed used to create the photo.
216 "focalLength": 3.14, # The focal length used to create the photo, in millimeters.
217 "exposureMode": "A String", # The exposure mode used to create the photo.
218 "colorSpace": "A String", # The color space of the photo.
219 "location": { # Geographic location information stored in the image.
220 "latitude": 3.14, # The latitude stored in the image.
221 "altitude": 3.14, # The altitude stored in the image.
222 "longitude": 3.14, # The longitude stored in the image.
223 },
224 "subjectDistance": 42, # The distance to the subject of the photo, in meters.
225 "height": 42, # The height of the image in pixels.
226 "lens": "A String", # The lens used to create the photo.
227 "date": "A String", # The date and time the photo was taken (EXIF format timestamp).
228 "width": 42, # The width of the image in pixels.
229 "meteringMode": "A String", # The metering mode used to create the photo.
230 "flashUsed": True or False, # Whether a flash was used to create the photo.
231 "aperture": 3.14, # The aperture used to create the photo (f-number).
232 "rotation": 42, # The rotation in clockwise degrees from the image's original orientation.
233 "sensor": "A String", # The type of sensor used to create the photo.
234 "whiteBalance": "A String", # The white balance mode used to create the photo.
235 "cameraModel": "A String", # The model of the camera used to create the photo.
236 },
237 "description": "A String", # A short description of the file.
238 "webContentLink": "A String", # A link for downloading the content of the file in a browser using cookie based authentication. In cases where the content is shared publicly, the content can be downloaded without any credentials.
239 "editable": True or False, # Whether the file can be edited by the current user.
240 "kind": "drive#file", # The type of file. This is always drive#file.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame^]241 "markedViewedByMeDate": "A String", # Time this file was explicitly marked viewed by the user (formatted RFC 3339 timestamp).
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]242 "quotaBytesUsed": "A String", # The number of quota bytes used by this file.
243 "fileSize": "A String", # The size of the file in bytes. This is only populated for files with content stored in Drive.
244 "createdDate": "A String", # Create time for this file (formatted ISO8601 timestamp).
245 "properties": [ # The list of properties.
246 { # A key-value pair that is either public or private to an application.
247 "kind": "drive#property", # This is always drive#property.
248 "value": "A String", # The value of this property.
249 "etag": "A String", # ETag of the property.
250 "visibility": "A String", # The visibility of this property.
251 "key": "A String", # The key of this property.
252 "selfLink": "A String", # The link back to this property.
253 },
254 ],
255 "md5Checksum": "A String", # An MD5 checksum for the content of this file. This is populated only for files with content stored in Drive.
256 "iconLink": "A String", # A link to the file's icon.
257 "defaultOpenWithLink": "A String", # A link to open this file with the user's default app for this file. Only populated when the drive.apps.readonly scope is used.
258 "embedLink": "A String", # A link for embedding the file.
259 "alternateLink": "A String", # A link for opening the file in using a relevant Google editor or viewer.
260 "title": "A String", # The title of this file.
261 "modifiedByMeDate": "A String", # Last time this file was modified by the user (formatted RFC 3339 timestamp). Note that setting modifiedDate will also update the modifiedByMe date for the user which set the date.
262 "downloadUrl": "A String", # Short lived download URL for the file. This is only populated for files with content stored in Drive.
263 "userPermission": { # A permission for a file. # The permissions for the authenticated user on this file.
264 "withLink": True or False, # Whether the link is required for this permission.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame^]265 "domain": "A String", # The domain name of the entity this permission refers to. This is an output-only field which is present when the permission type is user, group or domain.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]266 "name": "A String", # The name for this permission.
267 "kind": "drive#permission", # This is always drive#permission.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame^]268 "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified.
269 "id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]270 "authKey": "A String", # The authkey parameter required for this permission.
271 "etag": "A String", # The ETag of the permission.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame^]272 "emailAddress": "A String", # The email address of the user this permission refers to. This is an output-only field which is present when the permission type is user and the given user's Google+ profile privacy settings allow exposing their email address.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]273 "photoLink": "A String", # A link to the profile photo, if available.
274 "role": "A String", # The primary role for this user. Allowed values are:
275 # - owner
276 # - reader
277 # - writer
278 "type": "A String", # The account type. Allowed values are:
279 # - user
280 # - group
281 # - domain
282 # - anyone
283 "additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed.
284 "A String",
285 ],
286 "selfLink": "A String", # A link back to this permission.
287 },
288 "originalFilename": "A String", # The original filename if the file was uploaded manually, or the original title if the file was inserted through the API. Note that renames of the title will not change the original filename. This will only be populated on files with content stored in Drive.
289 "fileExtension": "A String", # The file extension used when downloading this file. This field is read only. To set the extension, include it in the title when creating the file. This is only populated for files with content stored in Drive.
290 "headRevisionId": "A String", # The ID of the file's head revision. This will only be populated for files with content stored in Drive.
291 "selfLink": "A String", # A link back to this file.
292 "modifiedDate": "A String", # Last time this file was modified by anyone (formatted RFC 3339 timestamp). This is only mutable on update when the setModifiedDate parameter is set.
293 },
294 "modificationDate": "A String", # The time of this modification.
295 "id": "A String", # The ID of the change.
296 "selfLink": "A String", # A link back to this change.
297 "fileId": "A String", # The ID of the file associated with this change.
298 }</pre>
299</div>
300
301<div class="method">
302 <code class="details" id="list">list(includeSubscribed=None, includeDeleted=None, pageToken=None, maxResults=None, startChangeId=None)</code>
303 <pre>Lists the changes for a user.
304
305Args:
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame^]306 includeSubscribed: boolean, Whether to include public files the user has opened and shared files. When set to false, the list only includes owned files plus any shared or public files the user has explicitly added to a folder they own.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]307 includeDeleted: boolean, Whether to include deleted items.
308 pageToken: string, Page token for changes.
309 maxResults: integer, Maximum number of changes to return.
310 startChangeId: string, Change ID to start listing changes from.
311
312Returns:
313 An object of the form:
314
315 { # A list of changes for a user.
316 "nextPageToken": "A String", # The page token for the next page of changes.
317 "kind": "drive#changeList", # This is always drive#changeList.
318 "items": [ # The actual list of changes.
319 { # Representation of a change to a file.
320 "kind": "drive#change", # This is always drive#change.
321 "deleted": True or False, # Whether the file has been deleted.
322 "file": { # The metadata for a file. # The updated state of the file. Present if the file has not been deleted.
323 "mimeType": "A String", # The MIME type of the file. This is only mutable on update when uploading new content. This field can be left blank, and the mimetype will be determined from the uploaded content's MIME type.
324 "lastViewedByMeDate": "A String", # Last time this file was viewed by the user (formatted RFC 3339 timestamp).
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame^]325 "version": "A String", # A monotonically increasing version number for the file. This reflects every change made to the file on the server, even those not visible to the requesting user.
326 "appDataContents": True or False, # Whether this file is in the Application Data folder.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]327 "thumbnailLink": "A String", # A link to the file's thumbnail.
328 "labels": { # A group of labels for the file.
329 "restricted": True or False, # Whether viewers are prevented from downloading this file.
330 "hidden": True or False, # Deprecated.
331 "viewed": True or False, # Whether this file has been viewed by this user.
332 "starred": True or False, # Whether this file is starred by the user.
333 "trashed": True or False, # Whether this file has been trashed.
334 },
335 "indexableText": { # Indexable text attributes for the file (can only be written)
336 "text": "A String", # The text to be indexed for this file.
337 },
338 "explicitlyTrashed": True or False, # Whether this file has been explicitly trashed, as opposed to recursively trashed. This will only be populated if the file is trashed.
339 "lastModifyingUserName": "A String", # Name of the last user to modify this file.
340 "writersCanShare": True or False, # Whether writers can share the document with other users.
341 "owners": [ # The owner(s) of this file.
342 { # The JSON template for a user.
343 "picture": { # The user's profile picture.
344 "url": "A String", # A URL that points to a profile picture of this user.
345 },
346 "kind": "drive#user", # This is always drive#user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]347 "displayName": "A String", # A plain text displayable name for this user.
348 "permissionId": "A String", # The user's ID as visible in the permissions collection.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame^]349 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
350 "emailAddress": "A String", # The email address of the user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]351 },
352 ],
353 "id": "A String", # The ID of the file.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame^]354 "sharingUser": { # The JSON template for a user. # User that shared the item with the current user, if available.
355 "picture": { # The user's profile picture.
356 "url": "A String", # A URL that points to a profile picture of this user.
357 },
358 "kind": "drive#user", # This is always drive#user.
359 "displayName": "A String", # A plain text displayable name for this user.
360 "permissionId": "A String", # The user's ID as visible in the permissions collection.
361 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
362 "emailAddress": "A String", # The email address of the user.
363 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]364 "lastModifyingUser": { # The JSON template for a user. # The last user to modify this file.
365 "picture": { # The user's profile picture.
366 "url": "A String", # A URL that points to a profile picture of this user.
367 },
368 "kind": "drive#user", # This is always drive#user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]369 "displayName": "A String", # A plain text displayable name for this user.
370 "permissionId": "A String", # The user's ID as visible in the permissions collection.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame^]371 "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
372 "emailAddress": "A String", # The email address of the user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]373 },
374 "copyable": True or False, # Whether the file can be copied by the current user.
375 "ownerNames": [ # Name(s) of the owner(s) of this file.
376 "A String",
377 ],
378 "sharedWithMeDate": "A String", # Time at which this file was shared with the user (formatted RFC 3339 timestamp).
379 "webViewLink": "A String", # A link only available on public folders for viewing their static web assets (HTML, CSS, JS, etc) via Google Drive's Website Hosting.
380 "etag": "A String", # ETag of the file.
381 "parents": [ # Collection of parent folders which contain this file.
382 # Setting this field will put the file in all of the provided folders. On insert, if no folders are provided, the file will be placed in the default root folder.
383 { # A reference to a file's parent.
384 "selfLink": "A String", # A link back to this reference.
385 "kind": "drive#parentReference", # This is always drive#parentReference.
386 "id": "A String", # The ID of the parent.
387 "isRoot": True or False, # Whether or not the parent is the root folder.
388 "parentLink": "A String", # A link to the parent.
389 },
390 ],
391 "exportLinks": { # Links for exporting Google Docs to specific formats.
392 "a_key": "A String", # A mapping from export format to URL
393 },
394 "shared": True or False, # Whether the file has been shared.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame^]395 "permissions": [ # The list of permissions for users with access to this file.
396 { # A permission for a file.
397 "withLink": True or False, # Whether the link is required for this permission.
398 "domain": "A String", # The domain name of the entity this permission refers to. This is an output-only field which is present when the permission type is user, group or domain.
399 "name": "A String", # The name for this permission.
400 "kind": "drive#permission", # This is always drive#permission.
401 "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified.
402 "id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified.
403 "authKey": "A String", # The authkey parameter required for this permission.
404 "etag": "A String", # The ETag of the permission.
405 "emailAddress": "A String", # The email address of the user this permission refers to. This is an output-only field which is present when the permission type is user and the given user's Google+ profile privacy settings allow exposing their email address.
406 "photoLink": "A String", # A link to the profile photo, if available.
407 "role": "A String", # The primary role for this user. Allowed values are:
408 # - owner
409 # - reader
410 # - writer
411 "type": "A String", # The account type. Allowed values are:
412 # - user
413 # - group
414 # - domain
415 # - anyone
416 "additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed.
417 "A String",
418 ],
419 "selfLink": "A String", # A link back to this permission.
420 },
421 ],
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]422 "thumbnail": { # Thumbnail for the file. Only accepted on upload and for files that are not already thumbnailed by Google.
423 "mimeType": "A String", # The MIME type of the thumbnail.
424 "image": "A String", # The URL-safe Base64 encoded bytes of the thumbnail image.
425 },
426 "openWithLinks": { # A map of the id of each of the user's apps to a link to open this file with that app. Only populated when the drive.apps.readonly scope is used.
427 "a_key": "A String",
428 },
429 "imageMediaMetadata": { # Metadata about image media. This will only be present for image types, and its contents will depend on what can be parsed from the image content.
430 "exposureBias": 3.14, # The exposure bias of the photo (APEX value).
431 "exposureTime": 3.14, # The length of the exposure, in seconds.
432 "cameraMake": "A String", # The make of the camera used to create the photo.
433 "maxApertureValue": 3.14, # The smallest f-number of the lens at the focal length used to create the photo (APEX value).
434 "isoSpeed": 42, # The ISO speed used to create the photo.
435 "focalLength": 3.14, # The focal length used to create the photo, in millimeters.
436 "exposureMode": "A String", # The exposure mode used to create the photo.
437 "colorSpace": "A String", # The color space of the photo.
438 "location": { # Geographic location information stored in the image.
439 "latitude": 3.14, # The latitude stored in the image.
440 "altitude": 3.14, # The altitude stored in the image.
441 "longitude": 3.14, # The longitude stored in the image.
442 },
443 "subjectDistance": 42, # The distance to the subject of the photo, in meters.
444 "height": 42, # The height of the image in pixels.
445 "lens": "A String", # The lens used to create the photo.
446 "date": "A String", # The date and time the photo was taken (EXIF format timestamp).
447 "width": 42, # The width of the image in pixels.
448 "meteringMode": "A String", # The metering mode used to create the photo.
449 "flashUsed": True or False, # Whether a flash was used to create the photo.
450 "aperture": 3.14, # The aperture used to create the photo (f-number).
451 "rotation": 42, # The rotation in clockwise degrees from the image's original orientation.
452 "sensor": "A String", # The type of sensor used to create the photo.
453 "whiteBalance": "A String", # The white balance mode used to create the photo.
454 "cameraModel": "A String", # The model of the camera used to create the photo.
455 },
456 "description": "A String", # A short description of the file.
457 "webContentLink": "A String", # A link for downloading the content of the file in a browser using cookie based authentication. In cases where the content is shared publicly, the content can be downloaded without any credentials.
458 "editable": True or False, # Whether the file can be edited by the current user.
459 "kind": "drive#file", # The type of file. This is always drive#file.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame^]460 "markedViewedByMeDate": "A String", # Time this file was explicitly marked viewed by the user (formatted RFC 3339 timestamp).
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]461 "quotaBytesUsed": "A String", # The number of quota bytes used by this file.
462 "fileSize": "A String", # The size of the file in bytes. This is only populated for files with content stored in Drive.
463 "createdDate": "A String", # Create time for this file (formatted ISO8601 timestamp).
464 "properties": [ # The list of properties.
465 { # A key-value pair that is either public or private to an application.
466 "kind": "drive#property", # This is always drive#property.
467 "value": "A String", # The value of this property.
468 "etag": "A String", # ETag of the property.
469 "visibility": "A String", # The visibility of this property.
470 "key": "A String", # The key of this property.
471 "selfLink": "A String", # The link back to this property.
472 },
473 ],
474 "md5Checksum": "A String", # An MD5 checksum for the content of this file. This is populated only for files with content stored in Drive.
475 "iconLink": "A String", # A link to the file's icon.
476 "defaultOpenWithLink": "A String", # A link to open this file with the user's default app for this file. Only populated when the drive.apps.readonly scope is used.
477 "embedLink": "A String", # A link for embedding the file.
478 "alternateLink": "A String", # A link for opening the file in using a relevant Google editor or viewer.
479 "title": "A String", # The title of this file.
480 "modifiedByMeDate": "A String", # Last time this file was modified by the user (formatted RFC 3339 timestamp). Note that setting modifiedDate will also update the modifiedByMe date for the user which set the date.
481 "downloadUrl": "A String", # Short lived download URL for the file. This is only populated for files with content stored in Drive.
482 "userPermission": { # A permission for a file. # The permissions for the authenticated user on this file.
483 "withLink": True or False, # Whether the link is required for this permission.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame^]484 "domain": "A String", # The domain name of the entity this permission refers to. This is an output-only field which is present when the permission type is user, group or domain.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]485 "name": "A String", # The name for this permission.
486 "kind": "drive#permission", # This is always drive#permission.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame^]487 "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified.
488 "id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]489 "authKey": "A String", # The authkey parameter required for this permission.
490 "etag": "A String", # The ETag of the permission.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame^]491 "emailAddress": "A String", # The email address of the user this permission refers to. This is an output-only field which is present when the permission type is user and the given user's Google+ profile privacy settings allow exposing their email address.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]492 "photoLink": "A String", # A link to the profile photo, if available.
493 "role": "A String", # The primary role for this user. Allowed values are:
494 # - owner
495 # - reader
496 # - writer
497 "type": "A String", # The account type. Allowed values are:
498 # - user
499 # - group
500 # - domain
501 # - anyone
502 "additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed.
503 "A String",
504 ],
505 "selfLink": "A String", # A link back to this permission.
506 },
507 "originalFilename": "A String", # The original filename if the file was uploaded manually, or the original title if the file was inserted through the API. Note that renames of the title will not change the original filename. This will only be populated on files with content stored in Drive.
508 "fileExtension": "A String", # The file extension used when downloading this file. This field is read only. To set the extension, include it in the title when creating the file. This is only populated for files with content stored in Drive.
509 "headRevisionId": "A String", # The ID of the file's head revision. This will only be populated for files with content stored in Drive.
510 "selfLink": "A String", # A link back to this file.
511 "modifiedDate": "A String", # Last time this file was modified by anyone (formatted RFC 3339 timestamp). This is only mutable on update when the setModifiedDate parameter is set.
512 },
513 "modificationDate": "A String", # The time of this modification.
514 "id": "A String", # The ID of the change.
515 "selfLink": "A String", # A link back to this change.
516 "fileId": "A String", # The ID of the file associated with this change.
517 },
518 ],
519 "nextLink": "A String", # A link to the next page of changes.
520 "etag": "A String", # The ETag of the list.
521 "largestChangeId": "A String", # The current largest change ID.
522 "selfLink": "A String", # A link back to this list.
523 }</pre>
524</div>
525
526<div class="method">
527 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
528 <pre>Retrieves the next page of results.
529
530Args:
531 previous_request: The request for the previous page. (required)
532 previous_response: The response from the request for the previous page. (required)
533
534Returns:
535 A request object that you can call 'execute()' on to request the next
536 page. Returns None if there are no more items in the collection.
537 </pre>
538</div>
539
540<div class="method">
541 <code class="details" id="watch">watch(body, includeSubscribed=None, includeDeleted=None, pageToken=None, maxResults=None, startChangeId=None)</code>
542 <pre>Subscribe to changes for a user.
543
544Args:
545 body: object, The request body. (required)
546 The object takes the form of:
547
548{ # An notification channel used to watch for resource changes.
549 "resourceUri": "A String", # A version-specific identifier for the watched resource.
550 "kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource. Value: the fixed string "api#channel".
551 "resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.
552 "payload": True or False, # A Boolean value to indicate whether payload is wanted. Optional.
553 "token": "A String", # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.
554 "params": { # Additional parameters controlling delivery channel behavior. Optional.
555 "a_key": "A String", # Declares a new parameter by name.
556 },
557 "expiration": "A String", # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.
558 "address": "A String", # The address where notifications are delivered for this channel.
559 "type": "A String", # The type of delivery mechanism used for this channel.
560 "id": "A String", # A UUID or similar unique string that identifies this channel.
561 }
562
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame^]563 includeSubscribed: boolean, Whether to include public files the user has opened and shared files. When set to false, the list only includes owned files plus any shared or public files the user has explicitly added to a folder they own.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]564 includeDeleted: boolean, Whether to include deleted items.
565 pageToken: string, Page token for changes.
566 maxResults: integer, Maximum number of changes to return.
567 startChangeId: string, Change ID to start listing changes from.
568
569Returns:
570 An object of the form:
571
572 { # An notification channel used to watch for resource changes.
573 "resourceUri": "A String", # A version-specific identifier for the watched resource.
574 "kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource. Value: the fixed string "api#channel".
575 "resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.
576 "payload": True or False, # A Boolean value to indicate whether payload is wanted. Optional.
577 "token": "A String", # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.
578 "params": { # Additional parameters controlling delivery channel behavior. Optional.
579 "a_key": "A String", # Declares a new parameter by name.
580 },
581 "expiration": "A String", # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.
582 "address": "A String", # The address where notifications are delivered for this channel.
583 "type": "A String", # The type of delivery mechanism used for this channel.
584 "id": "A String", # A UUID or similar unique string that identifies this channel.
585 }</pre>
586</div>
587
588</body></html>