Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 7578da5dc1ea87d1992fda18898270eb8253a2c6 / . / docs / dyn / drive_v2.changes.html
blob: 609d385fdf8b8fa0ea28424290c37c89b1b6d8b7 [file] [log] [blame]
Joe Gregorio075572b2012-07-09 16:53:09 -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<h3>Method Details</h3>
87<div class="method">
88 <code class="details" id="get">get(changeId)</code>
89 <pre>Gets a specific change.
90
91Args:
92 changeId: string, The ID of the change. (required)
93
94Returns:
95 An object of the form:
96
97 { # Representation of a change to a file.
98 "kind": "drive#change", # This is always drive#change.
99 "deleted": True or False, # Whether the file has been deleted.
100 "file": { # The metadata for a file. # The updated state of the file. Present if the file has not been deleted.
Joe Gregorioad8013f2012-08-03 08:44:02 -0400[diff] [blame]101 "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.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]102 "thumbnailLink": "A String", # A link to the file's thumbnail.
103 "labels": { # A group of labels for the file.
104 "restricted": True or False, # Whether viewers are prevented from downloading this file.
105 "hidden": True or False, # Whether this file is hidden from the user.
106 "viewed": True or False, # Whether this file has been viewed by this user.
107 "starred": True or False, # Whether this file is starred by the user.
108 "trashed": True or False, # Whether this file has been trashed.
109 },
110 "indexableText": { # Indexable text attributes for the file (can only be written)
111 "text": "A String", # The text to be indexed for this file
112 },
Joe Gregorioad8013f2012-08-03 08:44:02 -0400[diff] [blame]113 "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.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]114 "etag": "A String", # ETag of the file.
115 "lastModifyingUserName": "A String", # Name of the last user to modify this file. This will only be populated if a user has edited this file.
116 "writersCanShare": True or False, # Whether writers can share the document with other users.
117 "id": "A String", # The id of the file.
118 "title": "A String", # The title of this file.
119 "ownerNames": [ # Name(s) of the owner(s) of this file.
120 "A String",
121 ],
122 "sharedWithMeDate": "A String", # Time at which this file was shared with the user (formatted RFC 3339 timestamp).
123 "lastViewedByMeDate": "A String", # Last time this file was viewed by the user (formatted RFC 3339 timestamp).
124 "parents": [ # Collection of parent folders which contain this file.
Joe Gregorioe7a0c472012-07-12 11:46:04 -0400[diff] [blame]125 # 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.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]126 { # A reference to a file's parent.
127 "selfLink": "A String", # A link back to this reference.
128 "kind": "drive#parentReference", # This is always drive#parentReference.
129 "id": "A String", # The ID of the parent.
130 "isRoot": True or False, # Whether or not the parent is the root folder.
131 "parentLink": "A String", # A link to the parent.
132 },
133 ],
134 "exportLinks": { # Links for exporting Google Docs to specific formats.
Joe Gregoriofa08c2e2012-07-23 16:52:03 -0400[diff] [blame]135 "a_key": "A String", # A mapping from export format to URL
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]136 },
Joe Gregorioad8013f2012-08-03 08:44:02 -0400[diff] [blame]137 "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.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]138 "description": "A String", # A short description of the file.
Joe Gregorioad8013f2012-08-03 08:44:02 -0400[diff] [blame]139 "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.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]140 "editable": True or False, # Whether the file can be edited by the current user.
141 "kind": "drive#file", # The type of file. This is always drive#file.
142 "quotaBytesUsed": "A String", # The number of quota bytes used by this file.
143 "fileSize": "A String", # The size of the file in bytes. This will only be populated on files with content stored in Drive.
144 "createdDate": "A String", # Create time for this file (formatted ISO8601 timestamp).
145 "md5Checksum": "A String", # An MD5 checksum for the content of this file. This will only be populated on files with content stored in Drive.
Joe Gregorioad8013f2012-08-03 08:44:02 -0400[diff] [blame]146 "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.
147 "width": 42, # The width of the image in pixels.
148 "rotation": 42, # The rotation in clockwise degrees from the image's original orientation.
149 "location": { # Geographic location information stored in the image.
150 "latitude": 3.14, # The latitude stored in the image.
151 "altitude": 3.14, # The altitude stored in the image.
152 "longitude": 3.14, # The longitude stored in the image.
153 },
154 "height": 42, # The height of the image in pixels.
155 },
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]156 "embedLink": "A String", # A link for embedding the file.
Joe Gregorioad8013f2012-08-03 08:44:02 -0400[diff] [blame]157 "alternateLink": "A String", # A link for opening the file in using a relevant Google editor or viewer.
158 "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.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]159 "downloadUrl": "A String", # Short term download URL for the file. This will only be populated on files with content stored in Drive.
160 "userPermission": { # A single permission for a file. # The permissions for the authenticated user on this file.
161 "withLink": True or False, # Whether the link is required for this permission.
162 "kind": "drive#permission", # This is always drive#permission.
163 "name": "A String", # The name for this permission.
164 "value": "A String", # The email address or domain name for the entity. This is not populated in responses.
165 "id": "A String", # The ID of the permission.
166 "authKey": "A String", # The authkey parameter required for this permission.
167 "etag": "A String", # The ETag of the permission.
168 "role": "A String", # The primary role for this user. Allowed values are:
169 # - owner
170 # - reader
171 # - writer
172 "photoLink": "A String", # A link to the profile photo, if available.
173 "type": "A String", # The account type. Allowed values are:
174 # - user
175 # - group
176 # - domain
177 # - anyone
178 "additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed.
179 "A String",
180 ],
181 "selfLink": "A String", # A link back to this permission.
182 },
Joe Gregorioad8013f2012-08-03 08:44:02 -0400[diff] [blame]183 "fileExtension": "A String", # The file extension used when downloading this file. This field is set from the title when inserting or uploading new content. This will only be populated on files with content stored in Drive.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]184 "selfLink": "A String", # A link back to this file.
Joe Gregorioad8013f2012-08-03 08:44:02 -0400[diff] [blame]185 "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.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]186 },
187 "id": "A String", # The ID of the change.
188 "selfLink": "A String", # A link back to this change.
189 "fileId": "A String", # The ID of the file associated with this change.
190 }</pre>
191</div>
192
193<div class="method">
194 <code class="details" id="list">list(includeSubscribed=None, includeDeleted=None, pageToken=None, maxResults=None, startChangeId=None)</code>
195 <pre>Lists the changes for a user.
196
197Args:
198 includeSubscribed: boolean, Whether to include subscribed items.
199 includeDeleted: boolean, Whether to include deleted items.
200 pageToken: string, Page token for changes.
201 maxResults: integer, Maximum number of changes to return.
202 startChangeId: string, Change ID to start listing changes from.
203
204Returns:
205 An object of the form:
206
207 { # A list of changes for a user.
208 "nextPageToken": "A String", # The page token for the next page of changes.
209 "kind": "drive#changeList", # This is always drive#changeList.
210 "items": [ # The actual list of changes.
211 { # Representation of a change to a file.
212 "kind": "drive#change", # This is always drive#change.
213 "deleted": True or False, # Whether the file has been deleted.
214 "file": { # The metadata for a file. # The updated state of the file. Present if the file has not been deleted.
Joe Gregorioad8013f2012-08-03 08:44:02 -0400[diff] [blame]215 "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.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]216 "thumbnailLink": "A String", # A link to the file's thumbnail.
217 "labels": { # A group of labels for the file.
218 "restricted": True or False, # Whether viewers are prevented from downloading this file.
219 "hidden": True or False, # Whether this file is hidden from the user.
220 "viewed": True or False, # Whether this file has been viewed by this user.
221 "starred": True or False, # Whether this file is starred by the user.
222 "trashed": True or False, # Whether this file has been trashed.
223 },
224 "indexableText": { # Indexable text attributes for the file (can only be written)
225 "text": "A String", # The text to be indexed for this file
226 },
Joe Gregorioad8013f2012-08-03 08:44:02 -0400[diff] [blame]227 "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.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]228 "etag": "A String", # ETag of the file.
229 "lastModifyingUserName": "A String", # Name of the last user to modify this file. This will only be populated if a user has edited this file.
230 "writersCanShare": True or False, # Whether writers can share the document with other users.
231 "id": "A String", # The id of the file.
232 "title": "A String", # The title of this file.
233 "ownerNames": [ # Name(s) of the owner(s) of this file.
234 "A String",
235 ],
236 "sharedWithMeDate": "A String", # Time at which this file was shared with the user (formatted RFC 3339 timestamp).
237 "lastViewedByMeDate": "A String", # Last time this file was viewed by the user (formatted RFC 3339 timestamp).
238 "parents": [ # Collection of parent folders which contain this file.
Joe Gregorioe7a0c472012-07-12 11:46:04 -0400[diff] [blame]239 # 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.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]240 { # A reference to a file's parent.
241 "selfLink": "A String", # A link back to this reference.
242 "kind": "drive#parentReference", # This is always drive#parentReference.
243 "id": "A String", # The ID of the parent.
244 "isRoot": True or False, # Whether or not the parent is the root folder.
245 "parentLink": "A String", # A link to the parent.
246 },
247 ],
248 "exportLinks": { # Links for exporting Google Docs to specific formats.
Joe Gregoriofa08c2e2012-07-23 16:52:03 -0400[diff] [blame]249 "a_key": "A String", # A mapping from export format to URL
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]250 },
Joe Gregorioad8013f2012-08-03 08:44:02 -0400[diff] [blame]251 "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.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]252 "description": "A String", # A short description of the file.
Joe Gregorioad8013f2012-08-03 08:44:02 -0400[diff] [blame]253 "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.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]254 "editable": True or False, # Whether the file can be edited by the current user.
255 "kind": "drive#file", # The type of file. This is always drive#file.
256 "quotaBytesUsed": "A String", # The number of quota bytes used by this file.
257 "fileSize": "A String", # The size of the file in bytes. This will only be populated on files with content stored in Drive.
258 "createdDate": "A String", # Create time for this file (formatted ISO8601 timestamp).
259 "md5Checksum": "A String", # An MD5 checksum for the content of this file. This will only be populated on files with content stored in Drive.
Joe Gregorioad8013f2012-08-03 08:44:02 -0400[diff] [blame]260 "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.
261 "width": 42, # The width of the image in pixels.
262 "rotation": 42, # The rotation in clockwise degrees from the image's original orientation.
263 "location": { # Geographic location information stored in the image.
264 "latitude": 3.14, # The latitude stored in the image.
265 "altitude": 3.14, # The altitude stored in the image.
266 "longitude": 3.14, # The longitude stored in the image.
267 },
268 "height": 42, # The height of the image in pixels.
269 },
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]270 "embedLink": "A String", # A link for embedding the file.
Joe Gregorioad8013f2012-08-03 08:44:02 -0400[diff] [blame]271 "alternateLink": "A String", # A link for opening the file in using a relevant Google editor or viewer.
272 "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.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]273 "downloadUrl": "A String", # Short term download URL for the file. This will only be populated on files with content stored in Drive.
274 "userPermission": { # A single permission for a file. # The permissions for the authenticated user on this file.
275 "withLink": True or False, # Whether the link is required for this permission.
276 "kind": "drive#permission", # This is always drive#permission.
277 "name": "A String", # The name for this permission.
278 "value": "A String", # The email address or domain name for the entity. This is not populated in responses.
279 "id": "A String", # The ID of the permission.
280 "authKey": "A String", # The authkey parameter required for this permission.
281 "etag": "A String", # The ETag of the permission.
282 "role": "A String", # The primary role for this user. Allowed values are:
283 # - owner
284 # - reader
285 # - writer
286 "photoLink": "A String", # A link to the profile photo, if available.
287 "type": "A String", # The account type. Allowed values are:
288 # - user
289 # - group
290 # - domain
291 # - anyone
292 "additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed.
293 "A String",
294 ],
295 "selfLink": "A String", # A link back to this permission.
296 },
Joe Gregorioad8013f2012-08-03 08:44:02 -0400[diff] [blame]297 "fileExtension": "A String", # The file extension used when downloading this file. This field is set from the title when inserting or uploading new content. This will only be populated on files with content stored in Drive.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]298 "selfLink": "A String", # A link back to this file.
Joe Gregorioad8013f2012-08-03 08:44:02 -0400[diff] [blame]299 "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.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]300 },
301 "id": "A String", # The ID of the change.
302 "selfLink": "A String", # A link back to this change.
303 "fileId": "A String", # The ID of the file associated with this change.
304 },
305 ],
306 "nextLink": "A String", # A link to the next page of changes.
307 "etag": "A String", # The ETag of the list.
308 "largestChangeId": "A String", # The current largest change ID.
309 "selfLink": "A String", # A link back to this list.
310 }</pre>
311</div>
312
313<div class="method">
314 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
315 <pre>Retrieves the next page of results.
316
317Args:
318 previous_request: The request for the previous page. (required)
319 previous_response: The response from the request for the previous page. (required)
320
321Returns:
322 A request object that you can call 'execute()' on to request the next
323 page. Returns None if there are no more items in the collection.
324 </pre>
325</div>
326
327</body></html>