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
|
<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_v3.html">Google Drive API</a> . <a href="drive_v3.revisions.html">revisions</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#delete">delete(fileId, revisionId, x__xgafv=None)</a></code></p>
<p class="firstline">Permanently deletes a file version. You can only delete revisions for files with binary content in Google Drive, like images or videos. Revisions for other files, like Google Docs or Sheets, and the last remaining file version can't be deleted. For more information, see [Manage file revisions](https://developers.google.com/drive/api/guides/manage-revisions).</p>
<p class="toc_element">
<code><a href="#get">get(fileId, revisionId, acknowledgeAbuse=None, x__xgafv=None)</a></code></p>
<p class="firstline">Gets a revision's metadata or content by ID. For more information, see [Manage file revisions](https://developers.google.com/workspace/drive/api/guides/manage-revisions).</p>
<p class="toc_element">
<code><a href="#get_media">get_media(fileId, revisionId, acknowledgeAbuse=None, x__xgafv=None)</a></code></p>
<p class="firstline">Gets a revision's metadata or content by ID. For more information, see [Manage file revisions](https://developers.google.com/workspace/drive/api/guides/manage-revisions).</p>
<p class="toc_element">
<code><a href="#list">list(fileId, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists a file's revisions. For more information, see [Manage file revisions](https://developers.google.com/workspace/drive/api/guides/manage-revisions).</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#update">update(fileId, revisionId, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates a revision with patch semantics. For more information, see [Manage file revisions](https://developers.google.com/workspace/drive/api/guides/manage-revisions).</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(fileId, revisionId, x__xgafv=None)</code>
<pre>Permanently deletes a file version. You can only delete revisions for files with binary content in Google Drive, like images or videos. Revisions for other files, like Google Docs or Sheets, and the last remaining file version can't be deleted. For more information, see [Manage file revisions](https://developers.google.com/drive/api/guides/manage-revisions).
Args:
fileId: string, The ID of the file. (required)
revisionId: string, The ID of the revision. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
</pre>
</div>
<div class="method">
<code class="details" id="get">get(fileId, revisionId, acknowledgeAbuse=None, x__xgafv=None)</code>
<pre>Gets a revision's metadata or content by ID. For more information, see [Manage file revisions](https://developers.google.com/workspace/drive/api/guides/manage-revisions).
Args:
fileId: string, The ID of the file. (required)
revisionId: string, The ID of the revision. (required)
acknowledgeAbuse: boolean, Whether the user is acknowledging the risk of downloading known malware or other abusive files. This is only applicable when the `alt` parameter is set to `media` and the user is the owner of the file or an organizer of the shared drive in which the file resides.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The metadata for a revision to a file. Some resource methods (such as `revisions.update`) require a `revisionId`. Use the `revisions.list` method to retrieve the ID for a revision.
"exportLinks": { # Output only. Links for exporting Docs Editors files to specific formats.
"a_key": "A String",
},
"id": "A String", # Output only. The ID of the revision.
"keepForever": True or False, # Whether to keep this revision forever, even if it is no longer the head revision. If not set, the revision will be automatically purged 30 days after newer content is uploaded. This can be set on a maximum of 200 revisions for a file. This field is only applicable to files with binary content in Drive.
"kind": "drive#revision", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#revision"`.
"lastModifyingUser": { # Information about a Drive user. # Output only. The last user to modify this revision. This field is only populated when the last modification was performed by a signed-in user.
"displayName": "A String", # Output only. A plain text displayable name for this user.
"emailAddress": "A String", # Output only. The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
"kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `drive#user`.
"me": True or False, # Output only. Whether this user is the requesting user.
"permissionId": "A String", # Output only. The user's ID as visible in Permission resources.
"photoLink": "A String", # Output only. A link to the user's profile photo, if available.
},
"md5Checksum": "A String", # Output only. The MD5 checksum of the revision's content. This is only applicable to files with binary content in Drive.
"mimeType": "A String", # Output only. The MIME type of the revision.
"modifiedTime": "A String", # The last time the revision was modified (RFC 3339 date-time).
"originalFilename": "A String", # Output only. The original filename used to create this revision. This is only applicable to files with binary content in Drive.
"publishAuto": True or False, # Whether subsequent revisions will be automatically republished. This is only applicable to Docs Editors files.
"published": True or False, # Whether this revision is published. This is only applicable to Docs Editors files.
"publishedLink": "A String", # Output only. A link to the published revision. This is only populated for Docs Editors files.
"publishedOutsideDomain": True or False, # Whether this revision is published outside the domain. This is only applicable to Docs Editors files.
"size": "A String", # Output only. The size of the revision's content in bytes. This is only applicable to files with binary content in Drive.
}</pre>
</div>
<div class="method">
<code class="details" id="get_media">get_media(fileId, revisionId, acknowledgeAbuse=None, x__xgafv=None)</code>
<pre>Gets a revision's metadata or content by ID. For more information, see [Manage file revisions](https://developers.google.com/workspace/drive/api/guides/manage-revisions).
Args:
fileId: string, The ID of the file. (required)
revisionId: string, The ID of the revision. (required)
acknowledgeAbuse: boolean, Whether the user is acknowledging the risk of downloading known malware or other abusive files. This is only applicable when the `alt` parameter is set to `media` and the user is the owner of the file or an organizer of the shared drive in which the file resides.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
The media object as a string.
</pre>
</div>
<div class="method">
<code class="details" id="list">list(fileId, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists a file's revisions. For more information, see [Manage file revisions](https://developers.google.com/workspace/drive/api/guides/manage-revisions).
Args:
fileId: string, The ID of the file. (required)
pageSize: integer, The maximum number of revisions to return per page.
pageToken: string, The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A list of revisions of a file.
"kind": "drive#revisionList", # Identifies what kind of resource this is. Value: the fixed string `"drive#revisionList"`.
"nextPageToken": "A String", # The page token for the next page of revisions. This 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. The page token is typically valid for several hours. However, if new items are added or removed, your expected results might differ.
"revisions": [ # The list of revisions. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched.
{ # The metadata for a revision to a file. Some resource methods (such as `revisions.update`) require a `revisionId`. Use the `revisions.list` method to retrieve the ID for a revision.
"exportLinks": { # Output only. Links for exporting Docs Editors files to specific formats.
"a_key": "A String",
},
"id": "A String", # Output only. The ID of the revision.
"keepForever": True or False, # Whether to keep this revision forever, even if it is no longer the head revision. If not set, the revision will be automatically purged 30 days after newer content is uploaded. This can be set on a maximum of 200 revisions for a file. This field is only applicable to files with binary content in Drive.
"kind": "drive#revision", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#revision"`.
"lastModifyingUser": { # Information about a Drive user. # Output only. The last user to modify this revision. This field is only populated when the last modification was performed by a signed-in user.
"displayName": "A String", # Output only. A plain text displayable name for this user.
"emailAddress": "A String", # Output only. The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
"kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `drive#user`.
"me": True or False, # Output only. Whether this user is the requesting user.
"permissionId": "A String", # Output only. The user's ID as visible in Permission resources.
"photoLink": "A String", # Output only. A link to the user's profile photo, if available.
},
"md5Checksum": "A String", # Output only. The MD5 checksum of the revision's content. This is only applicable to files with binary content in Drive.
"mimeType": "A String", # Output only. The MIME type of the revision.
"modifiedTime": "A String", # The last time the revision was modified (RFC 3339 date-time).
"originalFilename": "A String", # Output only. The original filename used to create this revision. This is only applicable to files with binary content in Drive.
"publishAuto": True or False, # Whether subsequent revisions will be automatically republished. This is only applicable to Docs Editors files.
"published": True or False, # Whether this revision is published. This is only applicable to Docs Editors files.
"publishedLink": "A String", # Output only. A link to the published revision. This is only populated for Docs Editors files.
"publishedOutsideDomain": True or False, # Whether this revision is published outside the domain. This is only applicable to Docs Editors files.
"size": "A String", # Output only. The size of the revision's content in bytes. This is only applicable to files with binary content in Drive.
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</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="update">update(fileId, revisionId, body=None, x__xgafv=None)</code>
<pre>Updates a revision with patch semantics. For more information, see [Manage file revisions](https://developers.google.com/workspace/drive/api/guides/manage-revisions).
Args:
fileId: string, The ID of the file. (required)
revisionId: string, The ID of the revision. (required)
body: object, The request body.
The object takes the form of:
{ # The metadata for a revision to a file. Some resource methods (such as `revisions.update`) require a `revisionId`. Use the `revisions.list` method to retrieve the ID for a revision.
"exportLinks": { # Output only. Links for exporting Docs Editors files to specific formats.
"a_key": "A String",
},
"id": "A String", # Output only. The ID of the revision.
"keepForever": True or False, # Whether to keep this revision forever, even if it is no longer the head revision. If not set, the revision will be automatically purged 30 days after newer content is uploaded. This can be set on a maximum of 200 revisions for a file. This field is only applicable to files with binary content in Drive.
"kind": "drive#revision", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#revision"`.
"lastModifyingUser": { # Information about a Drive user. # Output only. The last user to modify this revision. This field is only populated when the last modification was performed by a signed-in user.
"displayName": "A String", # Output only. A plain text displayable name for this user.
"emailAddress": "A String", # Output only. The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
"kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `drive#user`.
"me": True or False, # Output only. Whether this user is the requesting user.
"permissionId": "A String", # Output only. The user's ID as visible in Permission resources.
"photoLink": "A String", # Output only. A link to the user's profile photo, if available.
},
"md5Checksum": "A String", # Output only. The MD5 checksum of the revision's content. This is only applicable to files with binary content in Drive.
"mimeType": "A String", # Output only. The MIME type of the revision.
"modifiedTime": "A String", # The last time the revision was modified (RFC 3339 date-time).
"originalFilename": "A String", # Output only. The original filename used to create this revision. This is only applicable to files with binary content in Drive.
"publishAuto": True or False, # Whether subsequent revisions will be automatically republished. This is only applicable to Docs Editors files.
"published": True or False, # Whether this revision is published. This is only applicable to Docs Editors files.
"publishedLink": "A String", # Output only. A link to the published revision. This is only populated for Docs Editors files.
"publishedOutsideDomain": True or False, # Whether this revision is published outside the domain. This is only applicable to Docs Editors files.
"size": "A String", # Output only. The size of the revision's content in bytes. This is only applicable to files with binary content in Drive.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The metadata for a revision to a file. Some resource methods (such as `revisions.update`) require a `revisionId`. Use the `revisions.list` method to retrieve the ID for a revision.
"exportLinks": { # Output only. Links for exporting Docs Editors files to specific formats.
"a_key": "A String",
},
"id": "A String", # Output only. The ID of the revision.
"keepForever": True or False, # Whether to keep this revision forever, even if it is no longer the head revision. If not set, the revision will be automatically purged 30 days after newer content is uploaded. This can be set on a maximum of 200 revisions for a file. This field is only applicable to files with binary content in Drive.
"kind": "drive#revision", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#revision"`.
"lastModifyingUser": { # Information about a Drive user. # Output only. The last user to modify this revision. This field is only populated when the last modification was performed by a signed-in user.
"displayName": "A String", # Output only. A plain text displayable name for this user.
"emailAddress": "A String", # Output only. The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
"kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `drive#user`.
"me": True or False, # Output only. Whether this user is the requesting user.
"permissionId": "A String", # Output only. The user's ID as visible in Permission resources.
"photoLink": "A String", # Output only. A link to the user's profile photo, if available.
},
"md5Checksum": "A String", # Output only. The MD5 checksum of the revision's content. This is only applicable to files with binary content in Drive.
"mimeType": "A String", # Output only. The MIME type of the revision.
"modifiedTime": "A String", # The last time the revision was modified (RFC 3339 date-time).
"originalFilename": "A String", # Output only. The original filename used to create this revision. This is only applicable to files with binary content in Drive.
"publishAuto": True or False, # Whether subsequent revisions will be automatically republished. This is only applicable to Docs Editors files.
"published": True or False, # Whether this revision is published. This is only applicable to Docs Editors files.
"publishedLink": "A String", # Output only. A link to the published revision. This is only populated for Docs Editors files.
"publishedOutsideDomain": True or False, # Whether this revision is published outside the domain. This is only applicable to Docs Editors files.
"size": "A String", # Output only. The size of the revision's content in bytes. This is only applicable to files with binary content in Drive.
}</pre>
</div>
</body></html>
|
