1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="drive_v2.html">Drive API</a> . <a href="drive_v2.revisions.html">revisions</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#delete">delete(fileId, revisionId)</a></code></p>
<p class="firstline">Permanently deletes a file version. You can only delete revisions for files with binary content, like images or videos. Revisions for other files, like Google Docs or Sheets, and the last remaining file version can't be deleted.</p>
<p class="toc_element">
<code><a href="#get">get(fileId, revisionId)</a></code></p>
<p class="firstline">Gets a specific revision.</p>
<p class="toc_element">
<code><a href="#list">list(fileId, pageToken=None, maxResults=None)</a></code></p>
<p class="firstline">Lists a file's revisions.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#patch">patch(fileId, revisionId, body)</a></code></p>
<p class="firstline">Updates a revision. This method supports patch semantics.</p>
<p class="toc_element">
<code><a href="#update">update(fileId, revisionId, body)</a></code></p>
<p class="firstline">Updates a revision.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="delete">delete(fileId, revisionId)</code>
<pre>Permanently deletes a file version. You can only delete revisions for files with binary content, like images or videos. Revisions for other files, like Google Docs or Sheets, and the last remaining file version can't be deleted.
Args:
fileId: string, The ID of the file. (required)
revisionId: string, The ID of the revision. (required)
</pre>
</div>
<div class="method">
<code class="details" id="get">get(fileId, revisionId)</code>
<pre>Gets a specific revision.
Args:
fileId: string, The ID of the file. (required)
revisionId: string, The ID of the revision. (required)
Returns:
An object of the form:
{ # A revision of a file.
"mimeType": "A String", # The MIME type of the revision.
"pinned": True or False, # Whether this revision is pinned to prevent automatic purging. This will only be populated and can only be modified on files with content stored in Drive which are not Google Docs. Revisions can also be pinned when they are created through the drive.files.insert/update/copy by using the pinned query parameter.
"kind": "drive#revision", # This is always drive#revision.
"publishedLink": "A String", # A link to the published revision.
"publishedOutsideDomain": True or False, # Whether this revision is published outside the domain. This is only populated and can only be modified for Google Docs.
"lastModifyingUser": { # Information about a Drive user. # The last user to modify this revision.
"picture": { # The user's profile picture.
"url": "A String", # A URL that points to a profile picture of this user.
},
"kind": "drive#user", # This is always drive#user.
"displayName": "A String", # A plain text displayable name for this user.
"permissionId": "A String", # The user's ID as visible in the permissions collection.
"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
"emailAddress": "A String", # The email address of the user.
},
"publishAuto": True or False, # Whether subsequent revisions will be automatically republished. This is only populated and can only be modified for Google Docs.
"published": True or False, # Whether this revision is published. This is only populated and can only be modified for Google Docs.
"downloadUrl": "A String", # Short term download URL for the file. This will only be populated on files with content stored in Drive.
"selfLink": "A String", # A link back to this revision.
"etag": "A String", # The ETag of the revision.
"fileSize": "A String", # The size of the revision in bytes. This will only be populated on files with content stored in Drive.
"exportLinks": { # Links for exporting Google Docs to specific formats.
"a_key": "A String", # A mapping from export format to URL
},
"lastModifyingUserName": "A String", # Name of the last user to modify this revision.
"originalFilename": "A String", # The original filename when this revision was created. This will only be populated on files with content stored in Drive.
"id": "A String", # The ID of the revision.
"md5Checksum": "A String", # An MD5 checksum for the content of this revision. This will only be populated on files with content stored in Drive.
"modifiedDate": "A String", # Last time this revision was modified (formatted RFC 3339 timestamp).
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(fileId, pageToken=None, maxResults=None)</code>
<pre>Lists a file's revisions.
Args:
fileId: string, The ID of the file. (required)
pageToken: string, Page token for revisions. To get the next page of results, set this parameter to the value of "nextPageToken" from the previous response.
maxResults: integer, Maximum number of revisions to return.
Returns:
An object of the form:
{ # A list of revisions of a file.
"nextPageToken": "A String", # The page token for the next page of revisions. This field will be absent if the end of the revisions 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.
"items": [ # The list of revisions. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched.
{ # A revision of a file.
"mimeType": "A String", # The MIME type of the revision.
"pinned": True or False, # Whether this revision is pinned to prevent automatic purging. This will only be populated and can only be modified on files with content stored in Drive which are not Google Docs. Revisions can also be pinned when they are created through the drive.files.insert/update/copy by using the pinned query parameter.
"kind": "drive#revision", # This is always drive#revision.
"publishedLink": "A String", # A link to the published revision.
"publishedOutsideDomain": True or False, # Whether this revision is published outside the domain. This is only populated and can only be modified for Google Docs.
"lastModifyingUser": { # Information about a Drive user. # The last user to modify this revision.
"picture": { # The user's profile picture.
"url": "A String", # A URL that points to a profile picture of this user.
},
"kind": "drive#user", # This is always drive#user.
"displayName": "A String", # A plain text displayable name for this user.
"permissionId": "A String", # The user's ID as visible in the permissions collection.
"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
"emailAddress": "A String", # The email address of the user.
},
"publishAuto": True or False, # Whether subsequent revisions will be automatically republished. This is only populated and can only be modified for Google Docs.
"published": True or False, # Whether this revision is published. This is only populated and can only be modified for Google Docs.
"downloadUrl": "A String", # Short term download URL for the file. This will only be populated on files with content stored in Drive.
"selfLink": "A String", # A link back to this revision.
"etag": "A String", # The ETag of the revision.
"fileSize": "A String", # The size of the revision in bytes. This will only be populated on files with content stored in Drive.
"exportLinks": { # Links for exporting Google Docs to specific formats.
"a_key": "A String", # A mapping from export format to URL
},
"lastModifyingUserName": "A String", # Name of the last user to modify this revision.
"originalFilename": "A String", # The original filename when this revision was created. This will only be populated on files with content stored in Drive.
"id": "A String", # The ID of the revision.
"md5Checksum": "A String", # An MD5 checksum for the content of this revision. This will only be populated on files with content stored in Drive.
"modifiedDate": "A String", # Last time this revision was modified (formatted RFC 3339 timestamp).
},
],
"kind": "drive#revisionList", # This is always drive#revisionList.
"etag": "A String", # The ETag of the list.
"selfLink": "A String", # A link back to this list.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
<div class="method">
<code class="details" id="patch">patch(fileId, revisionId, body)</code>
<pre>Updates a revision. This method supports patch semantics.
Args:
fileId: string, The ID for the file. (required)
revisionId: string, The ID for the revision. (required)
body: object, The request body. (required)
The object takes the form of:
{ # A revision of a file.
"mimeType": "A String", # The MIME type of the revision.
"pinned": True or False, # Whether this revision is pinned to prevent automatic purging. This will only be populated and can only be modified on files with content stored in Drive which are not Google Docs. Revisions can also be pinned when they are created through the drive.files.insert/update/copy by using the pinned query parameter.
"kind": "drive#revision", # This is always drive#revision.
"publishedLink": "A String", # A link to the published revision.
"publishedOutsideDomain": True or False, # Whether this revision is published outside the domain. This is only populated and can only be modified for Google Docs.
"lastModifyingUser": { # Information about a Drive user. # The last user to modify this revision.
"picture": { # The user's profile picture.
"url": "A String", # A URL that points to a profile picture of this user.
},
"kind": "drive#user", # This is always drive#user.
"displayName": "A String", # A plain text displayable name for this user.
"permissionId": "A String", # The user's ID as visible in the permissions collection.
"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
"emailAddress": "A String", # The email address of the user.
},
"publishAuto": True or False, # Whether subsequent revisions will be automatically republished. This is only populated and can only be modified for Google Docs.
"published": True or False, # Whether this revision is published. This is only populated and can only be modified for Google Docs.
"downloadUrl": "A String", # Short term download URL for the file. This will only be populated on files with content stored in Drive.
"selfLink": "A String", # A link back to this revision.
"etag": "A String", # The ETag of the revision.
"fileSize": "A String", # The size of the revision in bytes. This will only be populated on files with content stored in Drive.
"exportLinks": { # Links for exporting Google Docs to specific formats.
"a_key": "A String", # A mapping from export format to URL
},
"lastModifyingUserName": "A String", # Name of the last user to modify this revision.
"originalFilename": "A String", # The original filename when this revision was created. This will only be populated on files with content stored in Drive.
"id": "A String", # The ID of the revision.
"md5Checksum": "A String", # An MD5 checksum for the content of this revision. This will only be populated on files with content stored in Drive.
"modifiedDate": "A String", # Last time this revision was modified (formatted RFC 3339 timestamp).
}
Returns:
An object of the form:
{ # A revision of a file.
"mimeType": "A String", # The MIME type of the revision.
"pinned": True or False, # Whether this revision is pinned to prevent automatic purging. This will only be populated and can only be modified on files with content stored in Drive which are not Google Docs. Revisions can also be pinned when they are created through the drive.files.insert/update/copy by using the pinned query parameter.
"kind": "drive#revision", # This is always drive#revision.
"publishedLink": "A String", # A link to the published revision.
"publishedOutsideDomain": True or False, # Whether this revision is published outside the domain. This is only populated and can only be modified for Google Docs.
"lastModifyingUser": { # Information about a Drive user. # The last user to modify this revision.
"picture": { # The user's profile picture.
"url": "A String", # A URL that points to a profile picture of this user.
},
"kind": "drive#user", # This is always drive#user.
"displayName": "A String", # A plain text displayable name for this user.
"permissionId": "A String", # The user's ID as visible in the permissions collection.
"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
"emailAddress": "A String", # The email address of the user.
},
"publishAuto": True or False, # Whether subsequent revisions will be automatically republished. This is only populated and can only be modified for Google Docs.
"published": True or False, # Whether this revision is published. This is only populated and can only be modified for Google Docs.
"downloadUrl": "A String", # Short term download URL for the file. This will only be populated on files with content stored in Drive.
"selfLink": "A String", # A link back to this revision.
"etag": "A String", # The ETag of the revision.
"fileSize": "A String", # The size of the revision in bytes. This will only be populated on files with content stored in Drive.
"exportLinks": { # Links for exporting Google Docs to specific formats.
"a_key": "A String", # A mapping from export format to URL
},
"lastModifyingUserName": "A String", # Name of the last user to modify this revision.
"originalFilename": "A String", # The original filename when this revision was created. This will only be populated on files with content stored in Drive.
"id": "A String", # The ID of the revision.
"md5Checksum": "A String", # An MD5 checksum for the content of this revision. This will only be populated on files with content stored in Drive.
"modifiedDate": "A String", # Last time this revision was modified (formatted RFC 3339 timestamp).
}</pre>
</div>
<div class="method">
<code class="details" id="update">update(fileId, revisionId, body)</code>
<pre>Updates a revision.
Args:
fileId: string, The ID for the file. (required)
revisionId: string, The ID for the revision. (required)
body: object, The request body. (required)
The object takes the form of:
{ # A revision of a file.
"mimeType": "A String", # The MIME type of the revision.
"pinned": True or False, # Whether this revision is pinned to prevent automatic purging. This will only be populated and can only be modified on files with content stored in Drive which are not Google Docs. Revisions can also be pinned when they are created through the drive.files.insert/update/copy by using the pinned query parameter.
"kind": "drive#revision", # This is always drive#revision.
"publishedLink": "A String", # A link to the published revision.
"publishedOutsideDomain": True or False, # Whether this revision is published outside the domain. This is only populated and can only be modified for Google Docs.
"lastModifyingUser": { # Information about a Drive user. # The last user to modify this revision.
"picture": { # The user's profile picture.
"url": "A String", # A URL that points to a profile picture of this user.
},
"kind": "drive#user", # This is always drive#user.
"displayName": "A String", # A plain text displayable name for this user.
"permissionId": "A String", # The user's ID as visible in the permissions collection.
"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
"emailAddress": "A String", # The email address of the user.
},
"publishAuto": True or False, # Whether subsequent revisions will be automatically republished. This is only populated and can only be modified for Google Docs.
"published": True or False, # Whether this revision is published. This is only populated and can only be modified for Google Docs.
"downloadUrl": "A String", # Short term download URL for the file. This will only be populated on files with content stored in Drive.
"selfLink": "A String", # A link back to this revision.
"etag": "A String", # The ETag of the revision.
"fileSize": "A String", # The size of the revision in bytes. This will only be populated on files with content stored in Drive.
"exportLinks": { # Links for exporting Google Docs to specific formats.
"a_key": "A String", # A mapping from export format to URL
},
"lastModifyingUserName": "A String", # Name of the last user to modify this revision.
"originalFilename": "A String", # The original filename when this revision was created. This will only be populated on files with content stored in Drive.
"id": "A String", # The ID of the revision.
"md5Checksum": "A String", # An MD5 checksum for the content of this revision. This will only be populated on files with content stored in Drive.
"modifiedDate": "A String", # Last time this revision was modified (formatted RFC 3339 timestamp).
}
Returns:
An object of the form:
{ # A revision of a file.
"mimeType": "A String", # The MIME type of the revision.
"pinned": True or False, # Whether this revision is pinned to prevent automatic purging. This will only be populated and can only be modified on files with content stored in Drive which are not Google Docs. Revisions can also be pinned when they are created through the drive.files.insert/update/copy by using the pinned query parameter.
"kind": "drive#revision", # This is always drive#revision.
"publishedLink": "A String", # A link to the published revision.
"publishedOutsideDomain": True or False, # Whether this revision is published outside the domain. This is only populated and can only be modified for Google Docs.
"lastModifyingUser": { # Information about a Drive user. # The last user to modify this revision.
"picture": { # The user's profile picture.
"url": "A String", # A URL that points to a profile picture of this user.
},
"kind": "drive#user", # This is always drive#user.
"displayName": "A String", # A plain text displayable name for this user.
"permissionId": "A String", # The user's ID as visible in the permissions collection.
"isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
"emailAddress": "A String", # The email address of the user.
},
"publishAuto": True or False, # Whether subsequent revisions will be automatically republished. This is only populated and can only be modified for Google Docs.
"published": True or False, # Whether this revision is published. This is only populated and can only be modified for Google Docs.
"downloadUrl": "A String", # Short term download URL for the file. This will only be populated on files with content stored in Drive.
"selfLink": "A String", # A link back to this revision.
"etag": "A String", # The ETag of the revision.
"fileSize": "A String", # The size of the revision in bytes. This will only be populated on files with content stored in Drive.
"exportLinks": { # Links for exporting Google Docs to specific formats.
"a_key": "A String", # A mapping from export format to URL
},
"lastModifyingUserName": "A String", # Name of the last user to modify this revision.
"originalFilename": "A String", # The original filename when this revision was created. This will only be populated on files with content stored in Drive.
"id": "A String", # The ID of the revision.
"md5Checksum": "A String", # An MD5 checksum for the content of this revision. This will only be populated on files with content stored in Drive.
"modifiedDate": "A String", # Last time this revision was modified (formatted RFC 3339 timestamp).
}</pre>
</div>
</body></html>
|
