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
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
|
<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.permissions.html">permissions</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#delete">delete(fileId, permissionId)</a></code></p>
<p class="firstline">Deletes a permission from a file.</p>
<p class="toc_element">
<code><a href="#get">get(fileId, permissionId)</a></code></p>
<p class="firstline">Gets a permission by ID.</p>
<p class="toc_element">
<code><a href="#getIdForEmail">getIdForEmail(email)</a></code></p>
<p class="firstline">Returns the permission ID for an email address.</p>
<p class="toc_element">
<code><a href="#insert">insert(fileId, body, sendNotificationEmails=None, emailMessage=None)</a></code></p>
<p class="firstline">Inserts a permission for a file.</p>
<p class="toc_element">
<code><a href="#list">list(fileId)</a></code></p>
<p class="firstline">Lists a file's permissions.</p>
<p class="toc_element">
<code><a href="#patch">patch(fileId, permissionId, body, removeExpiration=None, transferOwnership=None)</a></code></p>
<p class="firstline">Updates a permission using patch semantics.</p>
<p class="toc_element">
<code><a href="#update">update(fileId, permissionId, body, removeExpiration=None, transferOwnership=None)</a></code></p>
<p class="firstline">Updates a permission.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="delete">delete(fileId, permissionId)</code>
<pre>Deletes a permission from a file.
Args:
fileId: string, The ID for the file. (required)
permissionId: string, The ID for the permission. (required)
</pre>
</div>
<div class="method">
<code class="details" id="get">get(fileId, permissionId)</code>
<pre>Gets a permission by ID.
Args:
fileId: string, The ID for the file. (required)
permissionId: string, The ID for the permission. (required)
Returns:
An object of the form:
{ # A permission for a file.
"withLink": True or False, # Whether the link is required for this permission.
"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.
"name": "A String", # The name for this permission.
"kind": "drive#permission", # This is always drive#permission.
"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 unless the permission type anyone, in which case both id and value are ignored.
"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 unless the permission type anyone, in which case both id and value are ignored.
"authKey": "A String", # The authkey parameter required for this permission.
"etag": "A String", # The ETag of the permission.
"emailAddress": "A String", # The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is user or group.
"expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time).
"role": "A String", # The primary role for this user. Allowed values are:
# - owner
# - reader
# - writer
"type": "A String", # The account type. Allowed values are:
# - user
# - group
# - domain
# - anyone
"additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed.
"A String",
],
"selfLink": "A String", # A link back to this permission.
"photoLink": "A String", # A link to the profile photo, if available.
}</pre>
</div>
<div class="method">
<code class="details" id="getIdForEmail">getIdForEmail(email)</code>
<pre>Returns the permission ID for an email address.
Args:
email: string, The email address for which to return a permission ID (required)
Returns:
An object of the form:
{ # An ID for a user or group as seen in Permission items.
"kind": "drive#permissionId", # This is always drive#permissionId.
"id": "A String", # The permission ID.
}</pre>
</div>
<div class="method">
<code class="details" id="insert">insert(fileId, body, sendNotificationEmails=None, emailMessage=None)</code>
<pre>Inserts a permission for a file.
Args:
fileId: string, The ID for the file. (required)
body: object, The request body. (required)
The object takes the form of:
{ # A permission for a file.
"withLink": True or False, # Whether the link is required for this permission.
"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.
"name": "A String", # The name for this permission.
"kind": "drive#permission", # This is always drive#permission.
"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 unless the permission type anyone, in which case both id and value are ignored.
"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 unless the permission type anyone, in which case both id and value are ignored.
"authKey": "A String", # The authkey parameter required for this permission.
"etag": "A String", # The ETag of the permission.
"emailAddress": "A String", # The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is user or group.
"expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time).
"role": "A String", # The primary role for this user. Allowed values are:
# - owner
# - reader
# - writer
"type": "A String", # The account type. Allowed values are:
# - user
# - group
# - domain
# - anyone
"additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed.
"A String",
],
"selfLink": "A String", # A link back to this permission.
"photoLink": "A String", # A link to the profile photo, if available.
}
sendNotificationEmails: boolean, Whether to send notification emails when sharing to users or groups. This parameter is ignored and an email is sent if the role is owner.
emailMessage: string, A custom message to include in notification emails.
Returns:
An object of the form:
{ # A permission for a file.
"withLink": True or False, # Whether the link is required for this permission.
"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.
"name": "A String", # The name for this permission.
"kind": "drive#permission", # This is always drive#permission.
"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 unless the permission type anyone, in which case both id and value are ignored.
"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 unless the permission type anyone, in which case both id and value are ignored.
"authKey": "A String", # The authkey parameter required for this permission.
"etag": "A String", # The ETag of the permission.
"emailAddress": "A String", # The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is user or group.
"expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time).
"role": "A String", # The primary role for this user. Allowed values are:
# - owner
# - reader
# - writer
"type": "A String", # The account type. Allowed values are:
# - user
# - group
# - domain
# - anyone
"additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed.
"A String",
],
"selfLink": "A String", # A link back to this permission.
"photoLink": "A String", # A link to the profile photo, if available.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(fileId)</code>
<pre>Lists a file's permissions.
Args:
fileId: string, The ID for the file. (required)
Returns:
An object of the form:
{ # A list of permissions associated with a file.
"items": [ # The actual list of permissions.
{ # A permission for a file.
"withLink": True or False, # Whether the link is required for this permission.
"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.
"name": "A String", # The name for this permission.
"kind": "drive#permission", # This is always drive#permission.
"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 unless the permission type anyone, in which case both id and value are ignored.
"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 unless the permission type anyone, in which case both id and value are ignored.
"authKey": "A String", # The authkey parameter required for this permission.
"etag": "A String", # The ETag of the permission.
"emailAddress": "A String", # The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is user or group.
"expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time).
"role": "A String", # The primary role for this user. Allowed values are:
# - owner
# - reader
# - writer
"type": "A String", # The account type. Allowed values are:
# - user
# - group
# - domain
# - anyone
"additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed.
"A String",
],
"selfLink": "A String", # A link back to this permission.
"photoLink": "A String", # A link to the profile photo, if available.
},
],
"kind": "drive#permissionList", # This is always drive#permissionList.
"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="patch">patch(fileId, permissionId, body, removeExpiration=None, transferOwnership=None)</code>
<pre>Updates a permission using patch semantics.
Args:
fileId: string, The ID for the file. (required)
permissionId: string, The ID for the permission. (required)
body: object, The request body. (required)
The object takes the form of:
{ # A permission for a file.
"withLink": True or False, # Whether the link is required for this permission.
"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.
"name": "A String", # The name for this permission.
"kind": "drive#permission", # This is always drive#permission.
"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 unless the permission type anyone, in which case both id and value are ignored.
"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 unless the permission type anyone, in which case both id and value are ignored.
"authKey": "A String", # The authkey parameter required for this permission.
"etag": "A String", # The ETag of the permission.
"emailAddress": "A String", # The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is user or group.
"expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time).
"role": "A String", # The primary role for this user. Allowed values are:
# - owner
# - reader
# - writer
"type": "A String", # The account type. Allowed values are:
# - user
# - group
# - domain
# - anyone
"additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed.
"A String",
],
"selfLink": "A String", # A link back to this permission.
"photoLink": "A String", # A link to the profile photo, if available.
}
removeExpiration: boolean, Whether to remove the expiration date.
transferOwnership: boolean, Whether changing a role to 'owner' downgrades the current owners to writers. Does nothing if the specified role is not 'owner'.
Returns:
An object of the form:
{ # A permission for a file.
"withLink": True or False, # Whether the link is required for this permission.
"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.
"name": "A String", # The name for this permission.
"kind": "drive#permission", # This is always drive#permission.
"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 unless the permission type anyone, in which case both id and value are ignored.
"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 unless the permission type anyone, in which case both id and value are ignored.
"authKey": "A String", # The authkey parameter required for this permission.
"etag": "A String", # The ETag of the permission.
"emailAddress": "A String", # The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is user or group.
"expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time).
"role": "A String", # The primary role for this user. Allowed values are:
# - owner
# - reader
# - writer
"type": "A String", # The account type. Allowed values are:
# - user
# - group
# - domain
# - anyone
"additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed.
"A String",
],
"selfLink": "A String", # A link back to this permission.
"photoLink": "A String", # A link to the profile photo, if available.
}</pre>
</div>
<div class="method">
<code class="details" id="update">update(fileId, permissionId, body, removeExpiration=None, transferOwnership=None)</code>
<pre>Updates a permission.
Args:
fileId: string, The ID for the file. (required)
permissionId: string, The ID for the permission. (required)
body: object, The request body. (required)
The object takes the form of:
{ # A permission for a file.
"withLink": True or False, # Whether the link is required for this permission.
"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.
"name": "A String", # The name for this permission.
"kind": "drive#permission", # This is always drive#permission.
"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 unless the permission type anyone, in which case both id and value are ignored.
"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 unless the permission type anyone, in which case both id and value are ignored.
"authKey": "A String", # The authkey parameter required for this permission.
"etag": "A String", # The ETag of the permission.
"emailAddress": "A String", # The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is user or group.
"expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time).
"role": "A String", # The primary role for this user. Allowed values are:
# - owner
# - reader
# - writer
"type": "A String", # The account type. Allowed values are:
# - user
# - group
# - domain
# - anyone
"additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed.
"A String",
],
"selfLink": "A String", # A link back to this permission.
"photoLink": "A String", # A link to the profile photo, if available.
}
removeExpiration: boolean, Whether to remove the expiration date.
transferOwnership: boolean, Whether changing a role to 'owner' downgrades the current owners to writers. Does nothing if the specified role is not 'owner'.
Returns:
An object of the form:
{ # A permission for a file.
"withLink": True or False, # Whether the link is required for this permission.
"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.
"name": "A String", # The name for this permission.
"kind": "drive#permission", # This is always drive#permission.
"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 unless the permission type anyone, in which case both id and value are ignored.
"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 unless the permission type anyone, in which case both id and value are ignored.
"authKey": "A String", # The authkey parameter required for this permission.
"etag": "A String", # The ETag of the permission.
"emailAddress": "A String", # The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is user or group.
"expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time).
"role": "A String", # The primary role for this user. Allowed values are:
# - owner
# - reader
# - writer
"type": "A String", # The account type. Allowed values are:
# - user
# - group
# - domain
# - anyone
"additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed.
"A String",
],
"selfLink": "A String", # A link back to this permission.
"photoLink": "A String", # A link to the profile photo, if available.
}</pre>
</div>
</body></html>
|
