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
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
|
<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.drives.html">drives</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="#create">create(requestId, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a shared drive. For more information, see [Manage shared drives](https://developers.google.com/workspace/drive/api/guides/manage-shareddrives).</p>
<p class="toc_element">
<code><a href="#delete">delete(driveId, allowItemDeletion=None, useDomainAdminAccess=None, x__xgafv=None)</a></code></p>
<p class="firstline">Permanently deletes a shared drive for which the user is an `organizer`. The shared drive cannot contain any untrashed items. For more information, see [Manage shared drives](https://developers.google.com/workspace/drive/api/guides/manage-shareddrives).</p>
<p class="toc_element">
<code><a href="#get">get(driveId, useDomainAdminAccess=None, x__xgafv=None)</a></code></p>
<p class="firstline">Gets a shared drive's metadata by ID. For more information, see [Manage shared drives](https://developers.google.com/workspace/drive/api/guides/manage-shareddrives).</p>
<p class="toc_element">
<code><a href="#hide">hide(driveId, x__xgafv=None)</a></code></p>
<p class="firstline">Hides a shared drive from the default view. For more information, see [Manage shared drives](https://developers.google.com/workspace/drive/api/guides/manage-shareddrives).</p>
<p class="toc_element">
<code><a href="#list">list(pageSize=None, pageToken=None, q=None, useDomainAdminAccess=None, x__xgafv=None)</a></code></p>
<p class="firstline"> Lists the user's shared drives. This method accepts the `q` parameter, which is a search query combining one or more search terms. For more information, see the [Search for shared drives](/workspace/drive/api/guides/search-shareddrives) guide.</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="#unhide">unhide(driveId, x__xgafv=None)</a></code></p>
<p class="firstline">Restores a shared drive to the default view. For more information, see [Manage shared drives](https://developers.google.com/workspace/drive/api/guides/manage-shareddrives).</p>
<p class="toc_element">
<code><a href="#update">update(driveId, body=None, useDomainAdminAccess=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates the metadata for a shared drive. For more information, see [Manage shared drives](https://developers.google.com/workspace/drive/api/guides/manage-shareddrives).</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="create">create(requestId, body=None, x__xgafv=None)</code>
<pre>Creates a shared drive. For more information, see [Manage shared drives](https://developers.google.com/workspace/drive/api/guides/manage-shareddrives).
Args:
requestId: string, Required. An ID, such as a random UUID, which uniquely identifies this user's request for idempotent creation of a shared drive. A repeated request by the same user and with the same request ID will avoid creating duplicates by attempting to create the same shared drive. If the shared drive already exists a 409 error will be returned. (required)
body: object, The request body.
The object takes the form of:
{ # Representation of a shared drive. Some resource methods (such as `drives.update`) require a `driveId`. Use the `drives.list` method to retrieve the ID for a shared drive.
"backgroundImageFile": { # An image file and cropping parameters from which a background image for this shared drive is set. This is a write only field; it can only be set on `drive.drives.update` requests that don't set `themeId`. When specified, all fields of the `backgroundImageFile` must be set.
"id": "A String", # The ID of an image file in Google Drive to use for the background image.
"width": 3.14, # The width of the cropped image in the closed range of 0 to 1. This value represents the width of the cropped image divided by the width of the entire image. The height is computed by applying a width to height aspect ratio of 80 to 9. The resulting image must be at least 1280 pixels wide and 144 pixels high.
"xCoordinate": 3.14, # The X coordinate of the upper left corner of the cropping area in the background image. This is a value in the closed range of 0 to 1. This value represents the horizontal distance from the left side of the entire image to the left side of the cropping area divided by the width of the entire image.
"yCoordinate": 3.14, # The Y coordinate of the upper left corner of the cropping area in the background image. This is a value in the closed range of 0 to 1. This value represents the vertical distance from the top side of the entire image to the top side of the cropping area divided by the height of the entire image.
},
"backgroundImageLink": "A String", # Output only. A short-lived link to this shared drive's background image.
"capabilities": { # Output only. Capabilities the current user has on this shared drive.
"canAddChildren": True or False, # Output only. Whether the current user can add children to folders in this shared drive.
"canChangeCopyRequiresWriterPermissionRestriction": True or False, # Output only. Whether the current user can change the `copyRequiresWriterPermission` restriction of this shared drive.
"canChangeDomainUsersOnlyRestriction": True or False, # Output only. Whether the current user can change the `domainUsersOnly` restriction of this shared drive.
"canChangeDownloadRestriction": True or False, # Output only. Whether the current user can change organizer-applied download restrictions of this shared drive.
"canChangeDriveBackground": True or False, # Output only. Whether the current user can change the background of this shared drive.
"canChangeDriveMembersOnlyRestriction": True or False, # Output only. Whether the current user can change the `driveMembersOnly` restriction of this shared drive.
"canChangeSharingFoldersRequiresOrganizerPermissionRestriction": True or False, # Output only. Whether the current user can change the `sharingFoldersRequiresOrganizerPermission` restriction of this shared drive.
"canComment": True or False, # Output only. Whether the current user can comment on files in this shared drive.
"canCopy": True or False, # Output only. Whether the current user can copy files in this shared drive.
"canDeleteChildren": True or False, # Output only. Whether the current user can delete children from folders in this shared drive.
"canDeleteDrive": True or False, # Output only. Whether the current user can delete this shared drive. Attempting to delete the shared drive may still fail if there are untrashed items inside the shared drive.
"canDownload": True or False, # Output only. Whether the current user can download files in this shared drive.
"canEdit": True or False, # Output only. Whether the current user can edit files in this shared drive
"canListChildren": True or False, # Output only. Whether the current user can list the children of folders in this shared drive.
"canManageMembers": True or False, # Output only. Whether the current user can add members to this shared drive or remove them or change their role.
"canReadRevisions": True or False, # Output only. Whether the current user can read the revisions resource of files in this shared drive.
"canRename": True or False, # Output only. Whether the current user can rename files or folders in this shared drive.
"canRenameDrive": True or False, # Output only. Whether the current user can rename this shared drive.
"canResetDriveRestrictions": True or False, # Output only. Whether the current user can reset the shared drive restrictions to defaults.
"canShare": True or False, # Output only. Whether the current user can share files or folders in this shared drive.
"canTrashChildren": True or False, # Output only. Whether the current user can trash children from folders in this shared drive.
},
"colorRgb": "A String", # The color of this shared drive as an RGB hex string. It can only be set on a `drive.drives.update` request that does not set `themeId`.
"createdTime": "A String", # The time at which the shared drive was created (RFC 3339 date-time).
"hidden": True or False, # Whether the shared drive is hidden from default view.
"id": "A String", # Output only. The ID of this shared drive which is also the ID of the top level folder of this shared drive.
"kind": "drive#drive", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#drive"`.
"name": "A String", # The name of this shared drive.
"orgUnitId": "A String", # Output only. The organizational unit of this shared drive. This field is only populated on `drives.list` responses when the `useDomainAdminAccess` parameter is set to `true`.
"restrictions": { # A set of restrictions that apply to this shared drive or items inside this shared drive. Note that restrictions can't be set when creating a shared drive. To add a restriction, first create a shared drive and then use `drives.update` to add restrictions.
"adminManagedRestrictions": True or False, # Whether administrative privileges on this shared drive are required to modify restrictions.
"copyRequiresWriterPermission": True or False, # Whether the options to copy, print, or download files inside this shared drive, should be disabled for readers and commenters. When this restriction is set to `true`, it will override the similarly named field to `true` for any file inside this shared drive.
"domainUsersOnly": True or False, # Whether access to this shared drive and items inside this shared drive is restricted to users of the domain to which this shared drive belongs. This restriction may be overridden by other sharing policies controlled outside of this shared drive.
"downloadRestriction": { # A restriction for copy and download of the file. # Download restrictions applied by shared drive managers.
"restrictedForReaders": True or False, # Whether download and copy is restricted for readers.
"restrictedForWriters": True or False, # Whether download and copy is restricted for writers. If true, download is also restricted for readers.
},
"driveMembersOnly": True or False, # Whether access to items inside this shared drive is restricted to its members.
"sharingFoldersRequiresOrganizerPermission": True or False, # If true, only users with the organizer role can share folders. If false, users with either the organizer role or the file organizer role can share folders.
},
"themeId": "A String", # The ID of the theme from which the background image and color will be set. The set of possible `driveThemes` can be retrieved from a `drive.about.get` response. When not specified on a `drive.drives.create` request, a random theme is chosen from which the background image and color are set. This is a write-only field; it can only be set on requests that don't set `colorRgb` or `backgroundImageFile`.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Representation of a shared drive. Some resource methods (such as `drives.update`) require a `driveId`. Use the `drives.list` method to retrieve the ID for a shared drive.
"backgroundImageFile": { # An image file and cropping parameters from which a background image for this shared drive is set. This is a write only field; it can only be set on `drive.drives.update` requests that don't set `themeId`. When specified, all fields of the `backgroundImageFile` must be set.
"id": "A String", # The ID of an image file in Google Drive to use for the background image.
"width": 3.14, # The width of the cropped image in the closed range of 0 to 1. This value represents the width of the cropped image divided by the width of the entire image. The height is computed by applying a width to height aspect ratio of 80 to 9. The resulting image must be at least 1280 pixels wide and 144 pixels high.
"xCoordinate": 3.14, # The X coordinate of the upper left corner of the cropping area in the background image. This is a value in the closed range of 0 to 1. This value represents the horizontal distance from the left side of the entire image to the left side of the cropping area divided by the width of the entire image.
"yCoordinate": 3.14, # The Y coordinate of the upper left corner of the cropping area in the background image. This is a value in the closed range of 0 to 1. This value represents the vertical distance from the top side of the entire image to the top side of the cropping area divided by the height of the entire image.
},
"backgroundImageLink": "A String", # Output only. A short-lived link to this shared drive's background image.
"capabilities": { # Output only. Capabilities the current user has on this shared drive.
"canAddChildren": True or False, # Output only. Whether the current user can add children to folders in this shared drive.
"canChangeCopyRequiresWriterPermissionRestriction": True or False, # Output only. Whether the current user can change the `copyRequiresWriterPermission` restriction of this shared drive.
"canChangeDomainUsersOnlyRestriction": True or False, # Output only. Whether the current user can change the `domainUsersOnly` restriction of this shared drive.
"canChangeDownloadRestriction": True or False, # Output only. Whether the current user can change organizer-applied download restrictions of this shared drive.
"canChangeDriveBackground": True or False, # Output only. Whether the current user can change the background of this shared drive.
"canChangeDriveMembersOnlyRestriction": True or False, # Output only. Whether the current user can change the `driveMembersOnly` restriction of this shared drive.
"canChangeSharingFoldersRequiresOrganizerPermissionRestriction": True or False, # Output only. Whether the current user can change the `sharingFoldersRequiresOrganizerPermission` restriction of this shared drive.
"canComment": True or False, # Output only. Whether the current user can comment on files in this shared drive.
"canCopy": True or False, # Output only. Whether the current user can copy files in this shared drive.
"canDeleteChildren": True or False, # Output only. Whether the current user can delete children from folders in this shared drive.
"canDeleteDrive": True or False, # Output only. Whether the current user can delete this shared drive. Attempting to delete the shared drive may still fail if there are untrashed items inside the shared drive.
"canDownload": True or False, # Output only. Whether the current user can download files in this shared drive.
"canEdit": True or False, # Output only. Whether the current user can edit files in this shared drive
"canListChildren": True or False, # Output only. Whether the current user can list the children of folders in this shared drive.
"canManageMembers": True or False, # Output only. Whether the current user can add members to this shared drive or remove them or change their role.
"canReadRevisions": True or False, # Output only. Whether the current user can read the revisions resource of files in this shared drive.
"canRename": True or False, # Output only. Whether the current user can rename files or folders in this shared drive.
"canRenameDrive": True or False, # Output only. Whether the current user can rename this shared drive.
"canResetDriveRestrictions": True or False, # Output only. Whether the current user can reset the shared drive restrictions to defaults.
"canShare": True or False, # Output only. Whether the current user can share files or folders in this shared drive.
"canTrashChildren": True or False, # Output only. Whether the current user can trash children from folders in this shared drive.
},
"colorRgb": "A String", # The color of this shared drive as an RGB hex string. It can only be set on a `drive.drives.update` request that does not set `themeId`.
"createdTime": "A String", # The time at which the shared drive was created (RFC 3339 date-time).
"hidden": True or False, # Whether the shared drive is hidden from default view.
"id": "A String", # Output only. The ID of this shared drive which is also the ID of the top level folder of this shared drive.
"kind": "drive#drive", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#drive"`.
"name": "A String", # The name of this shared drive.
"orgUnitId": "A String", # Output only. The organizational unit of this shared drive. This field is only populated on `drives.list` responses when the `useDomainAdminAccess` parameter is set to `true`.
"restrictions": { # A set of restrictions that apply to this shared drive or items inside this shared drive. Note that restrictions can't be set when creating a shared drive. To add a restriction, first create a shared drive and then use `drives.update` to add restrictions.
"adminManagedRestrictions": True or False, # Whether administrative privileges on this shared drive are required to modify restrictions.
"copyRequiresWriterPermission": True or False, # Whether the options to copy, print, or download files inside this shared drive, should be disabled for readers and commenters. When this restriction is set to `true`, it will override the similarly named field to `true` for any file inside this shared drive.
"domainUsersOnly": True or False, # Whether access to this shared drive and items inside this shared drive is restricted to users of the domain to which this shared drive belongs. This restriction may be overridden by other sharing policies controlled outside of this shared drive.
"downloadRestriction": { # A restriction for copy and download of the file. # Download restrictions applied by shared drive managers.
"restrictedForReaders": True or False, # Whether download and copy is restricted for readers.
"restrictedForWriters": True or False, # Whether download and copy is restricted for writers. If true, download is also restricted for readers.
},
"driveMembersOnly": True or False, # Whether access to items inside this shared drive is restricted to its members.
"sharingFoldersRequiresOrganizerPermission": True or False, # If true, only users with the organizer role can share folders. If false, users with either the organizer role or the file organizer role can share folders.
},
"themeId": "A String", # The ID of the theme from which the background image and color will be set. The set of possible `driveThemes` can be retrieved from a `drive.about.get` response. When not specified on a `drive.drives.create` request, a random theme is chosen from which the background image and color are set. This is a write-only field; it can only be set on requests that don't set `colorRgb` or `backgroundImageFile`.
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(driveId, allowItemDeletion=None, useDomainAdminAccess=None, x__xgafv=None)</code>
<pre>Permanently deletes a shared drive for which the user is an `organizer`. The shared drive cannot contain any untrashed items. For more information, see [Manage shared drives](https://developers.google.com/workspace/drive/api/guides/manage-shareddrives).
Args:
driveId: string, The ID of the shared drive. (required)
allowItemDeletion: boolean, Whether any items inside the shared drive should also be deleted. This option is only supported when `useDomainAdminAccess` is also set to `true`.
useDomainAdminAccess: boolean, Issue the request as a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the shared drive belongs.
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(driveId, useDomainAdminAccess=None, x__xgafv=None)</code>
<pre>Gets a shared drive's metadata by ID. For more information, see [Manage shared drives](https://developers.google.com/workspace/drive/api/guides/manage-shareddrives).
Args:
driveId: string, The ID of the shared drive. (required)
useDomainAdminAccess: boolean, Issue the request as a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the shared drive belongs.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Representation of a shared drive. Some resource methods (such as `drives.update`) require a `driveId`. Use the `drives.list` method to retrieve the ID for a shared drive.
"backgroundImageFile": { # An image file and cropping parameters from which a background image for this shared drive is set. This is a write only field; it can only be set on `drive.drives.update` requests that don't set `themeId`. When specified, all fields of the `backgroundImageFile` must be set.
"id": "A String", # The ID of an image file in Google Drive to use for the background image.
"width": 3.14, # The width of the cropped image in the closed range of 0 to 1. This value represents the width of the cropped image divided by the width of the entire image. The height is computed by applying a width to height aspect ratio of 80 to 9. The resulting image must be at least 1280 pixels wide and 144 pixels high.
"xCoordinate": 3.14, # The X coordinate of the upper left corner of the cropping area in the background image. This is a value in the closed range of 0 to 1. This value represents the horizontal distance from the left side of the entire image to the left side of the cropping area divided by the width of the entire image.
"yCoordinate": 3.14, # The Y coordinate of the upper left corner of the cropping area in the background image. This is a value in the closed range of 0 to 1. This value represents the vertical distance from the top side of the entire image to the top side of the cropping area divided by the height of the entire image.
},
"backgroundImageLink": "A String", # Output only. A short-lived link to this shared drive's background image.
"capabilities": { # Output only. Capabilities the current user has on this shared drive.
"canAddChildren": True or False, # Output only. Whether the current user can add children to folders in this shared drive.
"canChangeCopyRequiresWriterPermissionRestriction": True or False, # Output only. Whether the current user can change the `copyRequiresWriterPermission` restriction of this shared drive.
"canChangeDomainUsersOnlyRestriction": True or False, # Output only. Whether the current user can change the `domainUsersOnly` restriction of this shared drive.
"canChangeDownloadRestriction": True or False, # Output only. Whether the current user can change organizer-applied download restrictions of this shared drive.
"canChangeDriveBackground": True or False, # Output only. Whether the current user can change the background of this shared drive.
"canChangeDriveMembersOnlyRestriction": True or False, # Output only. Whether the current user can change the `driveMembersOnly` restriction of this shared drive.
"canChangeSharingFoldersRequiresOrganizerPermissionRestriction": True or False, # Output only. Whether the current user can change the `sharingFoldersRequiresOrganizerPermission` restriction of this shared drive.
"canComment": True or False, # Output only. Whether the current user can comment on files in this shared drive.
"canCopy": True or False, # Output only. Whether the current user can copy files in this shared drive.
"canDeleteChildren": True or False, # Output only. Whether the current user can delete children from folders in this shared drive.
"canDeleteDrive": True or False, # Output only. Whether the current user can delete this shared drive. Attempting to delete the shared drive may still fail if there are untrashed items inside the shared drive.
"canDownload": True or False, # Output only. Whether the current user can download files in this shared drive.
"canEdit": True or False, # Output only. Whether the current user can edit files in this shared drive
"canListChildren": True or False, # Output only. Whether the current user can list the children of folders in this shared drive.
"canManageMembers": True or False, # Output only. Whether the current user can add members to this shared drive or remove them or change their role.
"canReadRevisions": True or False, # Output only. Whether the current user can read the revisions resource of files in this shared drive.
"canRename": True or False, # Output only. Whether the current user can rename files or folders in this shared drive.
"canRenameDrive": True or False, # Output only. Whether the current user can rename this shared drive.
"canResetDriveRestrictions": True or False, # Output only. Whether the current user can reset the shared drive restrictions to defaults.
"canShare": True or False, # Output only. Whether the current user can share files or folders in this shared drive.
"canTrashChildren": True or False, # Output only. Whether the current user can trash children from folders in this shared drive.
},
"colorRgb": "A String", # The color of this shared drive as an RGB hex string. It can only be set on a `drive.drives.update` request that does not set `themeId`.
"createdTime": "A String", # The time at which the shared drive was created (RFC 3339 date-time).
"hidden": True or False, # Whether the shared drive is hidden from default view.
"id": "A String", # Output only. The ID of this shared drive which is also the ID of the top level folder of this shared drive.
"kind": "drive#drive", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#drive"`.
"name": "A String", # The name of this shared drive.
"orgUnitId": "A String", # Output only. The organizational unit of this shared drive. This field is only populated on `drives.list` responses when the `useDomainAdminAccess` parameter is set to `true`.
"restrictions": { # A set of restrictions that apply to this shared drive or items inside this shared drive. Note that restrictions can't be set when creating a shared drive. To add a restriction, first create a shared drive and then use `drives.update` to add restrictions.
"adminManagedRestrictions": True or False, # Whether administrative privileges on this shared drive are required to modify restrictions.
"copyRequiresWriterPermission": True or False, # Whether the options to copy, print, or download files inside this shared drive, should be disabled for readers and commenters. When this restriction is set to `true`, it will override the similarly named field to `true` for any file inside this shared drive.
"domainUsersOnly": True or False, # Whether access to this shared drive and items inside this shared drive is restricted to users of the domain to which this shared drive belongs. This restriction may be overridden by other sharing policies controlled outside of this shared drive.
"downloadRestriction": { # A restriction for copy and download of the file. # Download restrictions applied by shared drive managers.
"restrictedForReaders": True or False, # Whether download and copy is restricted for readers.
"restrictedForWriters": True or False, # Whether download and copy is restricted for writers. If true, download is also restricted for readers.
},
"driveMembersOnly": True or False, # Whether access to items inside this shared drive is restricted to its members.
"sharingFoldersRequiresOrganizerPermission": True or False, # If true, only users with the organizer role can share folders. If false, users with either the organizer role or the file organizer role can share folders.
},
"themeId": "A String", # The ID of the theme from which the background image and color will be set. The set of possible `driveThemes` can be retrieved from a `drive.about.get` response. When not specified on a `drive.drives.create` request, a random theme is chosen from which the background image and color are set. This is a write-only field; it can only be set on requests that don't set `colorRgb` or `backgroundImageFile`.
}</pre>
</div>
<div class="method">
<code class="details" id="hide">hide(driveId, x__xgafv=None)</code>
<pre>Hides a shared drive from the default view. For more information, see [Manage shared drives](https://developers.google.com/workspace/drive/api/guides/manage-shareddrives).
Args:
driveId: string, The ID of the shared drive. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Representation of a shared drive. Some resource methods (such as `drives.update`) require a `driveId`. Use the `drives.list` method to retrieve the ID for a shared drive.
"backgroundImageFile": { # An image file and cropping parameters from which a background image for this shared drive is set. This is a write only field; it can only be set on `drive.drives.update` requests that don't set `themeId`. When specified, all fields of the `backgroundImageFile` must be set.
"id": "A String", # The ID of an image file in Google Drive to use for the background image.
"width": 3.14, # The width of the cropped image in the closed range of 0 to 1. This value represents the width of the cropped image divided by the width of the entire image. The height is computed by applying a width to height aspect ratio of 80 to 9. The resulting image must be at least 1280 pixels wide and 144 pixels high.
"xCoordinate": 3.14, # The X coordinate of the upper left corner of the cropping area in the background image. This is a value in the closed range of 0 to 1. This value represents the horizontal distance from the left side of the entire image to the left side of the cropping area divided by the width of the entire image.
"yCoordinate": 3.14, # The Y coordinate of the upper left corner of the cropping area in the background image. This is a value in the closed range of 0 to 1. This value represents the vertical distance from the top side of the entire image to the top side of the cropping area divided by the height of the entire image.
},
"backgroundImageLink": "A String", # Output only. A short-lived link to this shared drive's background image.
"capabilities": { # Output only. Capabilities the current user has on this shared drive.
"canAddChildren": True or False, # Output only. Whether the current user can add children to folders in this shared drive.
"canChangeCopyRequiresWriterPermissionRestriction": True or False, # Output only. Whether the current user can change the `copyRequiresWriterPermission` restriction of this shared drive.
"canChangeDomainUsersOnlyRestriction": True or False, # Output only. Whether the current user can change the `domainUsersOnly` restriction of this shared drive.
"canChangeDownloadRestriction": True or False, # Output only. Whether the current user can change organizer-applied download restrictions of this shared drive.
"canChangeDriveBackground": True or False, # Output only. Whether the current user can change the background of this shared drive.
"canChangeDriveMembersOnlyRestriction": True or False, # Output only. Whether the current user can change the `driveMembersOnly` restriction of this shared drive.
"canChangeSharingFoldersRequiresOrganizerPermissionRestriction": True or False, # Output only. Whether the current user can change the `sharingFoldersRequiresOrganizerPermission` restriction of this shared drive.
"canComment": True or False, # Output only. Whether the current user can comment on files in this shared drive.
"canCopy": True or False, # Output only. Whether the current user can copy files in this shared drive.
"canDeleteChildren": True or False, # Output only. Whether the current user can delete children from folders in this shared drive.
"canDeleteDrive": True or False, # Output only. Whether the current user can delete this shared drive. Attempting to delete the shared drive may still fail if there are untrashed items inside the shared drive.
"canDownload": True or False, # Output only. Whether the current user can download files in this shared drive.
"canEdit": True or False, # Output only. Whether the current user can edit files in this shared drive
"canListChildren": True or False, # Output only. Whether the current user can list the children of folders in this shared drive.
"canManageMembers": True or False, # Output only. Whether the current user can add members to this shared drive or remove them or change their role.
"canReadRevisions": True or False, # Output only. Whether the current user can read the revisions resource of files in this shared drive.
"canRename": True or False, # Output only. Whether the current user can rename files or folders in this shared drive.
"canRenameDrive": True or False, # Output only. Whether the current user can rename this shared drive.
"canResetDriveRestrictions": True or False, # Output only. Whether the current user can reset the shared drive restrictions to defaults.
"canShare": True or False, # Output only. Whether the current user can share files or folders in this shared drive.
"canTrashChildren": True or False, # Output only. Whether the current user can trash children from folders in this shared drive.
},
"colorRgb": "A String", # The color of this shared drive as an RGB hex string. It can only be set on a `drive.drives.update` request that does not set `themeId`.
"createdTime": "A String", # The time at which the shared drive was created (RFC 3339 date-time).
"hidden": True or False, # Whether the shared drive is hidden from default view.
"id": "A String", # Output only. The ID of this shared drive which is also the ID of the top level folder of this shared drive.
"kind": "drive#drive", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#drive"`.
"name": "A String", # The name of this shared drive.
"orgUnitId": "A String", # Output only. The organizational unit of this shared drive. This field is only populated on `drives.list` responses when the `useDomainAdminAccess` parameter is set to `true`.
"restrictions": { # A set of restrictions that apply to this shared drive or items inside this shared drive. Note that restrictions can't be set when creating a shared drive. To add a restriction, first create a shared drive and then use `drives.update` to add restrictions.
"adminManagedRestrictions": True or False, # Whether administrative privileges on this shared drive are required to modify restrictions.
"copyRequiresWriterPermission": True or False, # Whether the options to copy, print, or download files inside this shared drive, should be disabled for readers and commenters. When this restriction is set to `true`, it will override the similarly named field to `true` for any file inside this shared drive.
"domainUsersOnly": True or False, # Whether access to this shared drive and items inside this shared drive is restricted to users of the domain to which this shared drive belongs. This restriction may be overridden by other sharing policies controlled outside of this shared drive.
"downloadRestriction": { # A restriction for copy and download of the file. # Download restrictions applied by shared drive managers.
"restrictedForReaders": True or False, # Whether download and copy is restricted for readers.
"restrictedForWriters": True or False, # Whether download and copy is restricted for writers. If true, download is also restricted for readers.
},
"driveMembersOnly": True or False, # Whether access to items inside this shared drive is restricted to its members.
"sharingFoldersRequiresOrganizerPermission": True or False, # If true, only users with the organizer role can share folders. If false, users with either the organizer role or the file organizer role can share folders.
},
"themeId": "A String", # The ID of the theme from which the background image and color will be set. The set of possible `driveThemes` can be retrieved from a `drive.about.get` response. When not specified on a `drive.drives.create` request, a random theme is chosen from which the background image and color are set. This is a write-only field; it can only be set on requests that don't set `colorRgb` or `backgroundImageFile`.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(pageSize=None, pageToken=None, q=None, useDomainAdminAccess=None, x__xgafv=None)</code>
<pre> Lists the user's shared drives. This method accepts the `q` parameter, which is a search query combining one or more search terms. For more information, see the [Search for shared drives](/workspace/drive/api/guides/search-shareddrives) guide.
Args:
pageSize: integer, Maximum number of shared drives to return per page.
pageToken: string, Page token for shared drives.
q: string, Query string for searching shared drives.
useDomainAdminAccess: boolean, Issue the request as a domain administrator; if set to true, then all shared drives of the domain in which the requester is an administrator are returned.
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 shared drives.
"drives": [ # The list of shared drives. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched.
{ # Representation of a shared drive. Some resource methods (such as `drives.update`) require a `driveId`. Use the `drives.list` method to retrieve the ID for a shared drive.
"backgroundImageFile": { # An image file and cropping parameters from which a background image for this shared drive is set. This is a write only field; it can only be set on `drive.drives.update` requests that don't set `themeId`. When specified, all fields of the `backgroundImageFile` must be set.
"id": "A String", # The ID of an image file in Google Drive to use for the background image.
"width": 3.14, # The width of the cropped image in the closed range of 0 to 1. This value represents the width of the cropped image divided by the width of the entire image. The height is computed by applying a width to height aspect ratio of 80 to 9. The resulting image must be at least 1280 pixels wide and 144 pixels high.
"xCoordinate": 3.14, # The X coordinate of the upper left corner of the cropping area in the background image. This is a value in the closed range of 0 to 1. This value represents the horizontal distance from the left side of the entire image to the left side of the cropping area divided by the width of the entire image.
"yCoordinate": 3.14, # The Y coordinate of the upper left corner of the cropping area in the background image. This is a value in the closed range of 0 to 1. This value represents the vertical distance from the top side of the entire image to the top side of the cropping area divided by the height of the entire image.
},
"backgroundImageLink": "A String", # Output only. A short-lived link to this shared drive's background image.
"capabilities": { # Output only. Capabilities the current user has on this shared drive.
"canAddChildren": True or False, # Output only. Whether the current user can add children to folders in this shared drive.
"canChangeCopyRequiresWriterPermissionRestriction": True or False, # Output only. Whether the current user can change the `copyRequiresWriterPermission` restriction of this shared drive.
"canChangeDomainUsersOnlyRestriction": True or False, # Output only. Whether the current user can change the `domainUsersOnly` restriction of this shared drive.
"canChangeDownloadRestriction": True or False, # Output only. Whether the current user can change organizer-applied download restrictions of this shared drive.
"canChangeDriveBackground": True or False, # Output only. Whether the current user can change the background of this shared drive.
"canChangeDriveMembersOnlyRestriction": True or False, # Output only. Whether the current user can change the `driveMembersOnly` restriction of this shared drive.
"canChangeSharingFoldersRequiresOrganizerPermissionRestriction": True or False, # Output only. Whether the current user can change the `sharingFoldersRequiresOrganizerPermission` restriction of this shared drive.
"canComment": True or False, # Output only. Whether the current user can comment on files in this shared drive.
"canCopy": True or False, # Output only. Whether the current user can copy files in this shared drive.
"canDeleteChildren": True or False, # Output only. Whether the current user can delete children from folders in this shared drive.
"canDeleteDrive": True or False, # Output only. Whether the current user can delete this shared drive. Attempting to delete the shared drive may still fail if there are untrashed items inside the shared drive.
"canDownload": True or False, # Output only. Whether the current user can download files in this shared drive.
"canEdit": True or False, # Output only. Whether the current user can edit files in this shared drive
"canListChildren": True or False, # Output only. Whether the current user can list the children of folders in this shared drive.
"canManageMembers": True or False, # Output only. Whether the current user can add members to this shared drive or remove them or change their role.
"canReadRevisions": True or False, # Output only. Whether the current user can read the revisions resource of files in this shared drive.
"canRename": True or False, # Output only. Whether the current user can rename files or folders in this shared drive.
"canRenameDrive": True or False, # Output only. Whether the current user can rename this shared drive.
"canResetDriveRestrictions": True or False, # Output only. Whether the current user can reset the shared drive restrictions to defaults.
"canShare": True or False, # Output only. Whether the current user can share files or folders in this shared drive.
"canTrashChildren": True or False, # Output only. Whether the current user can trash children from folders in this shared drive.
},
"colorRgb": "A String", # The color of this shared drive as an RGB hex string. It can only be set on a `drive.drives.update` request that does not set `themeId`.
"createdTime": "A String", # The time at which the shared drive was created (RFC 3339 date-time).
"hidden": True or False, # Whether the shared drive is hidden from default view.
"id": "A String", # Output only. The ID of this shared drive which is also the ID of the top level folder of this shared drive.
"kind": "drive#drive", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#drive"`.
"name": "A String", # The name of this shared drive.
"orgUnitId": "A String", # Output only. The organizational unit of this shared drive. This field is only populated on `drives.list` responses when the `useDomainAdminAccess` parameter is set to `true`.
"restrictions": { # A set of restrictions that apply to this shared drive or items inside this shared drive. Note that restrictions can't be set when creating a shared drive. To add a restriction, first create a shared drive and then use `drives.update` to add restrictions.
"adminManagedRestrictions": True or False, # Whether administrative privileges on this shared drive are required to modify restrictions.
"copyRequiresWriterPermission": True or False, # Whether the options to copy, print, or download files inside this shared drive, should be disabled for readers and commenters. When this restriction is set to `true`, it will override the similarly named field to `true` for any file inside this shared drive.
"domainUsersOnly": True or False, # Whether access to this shared drive and items inside this shared drive is restricted to users of the domain to which this shared drive belongs. This restriction may be overridden by other sharing policies controlled outside of this shared drive.
"downloadRestriction": { # A restriction for copy and download of the file. # Download restrictions applied by shared drive managers.
"restrictedForReaders": True or False, # Whether download and copy is restricted for readers.
"restrictedForWriters": True or False, # Whether download and copy is restricted for writers. If true, download is also restricted for readers.
},
"driveMembersOnly": True or False, # Whether access to items inside this shared drive is restricted to its members.
"sharingFoldersRequiresOrganizerPermission": True or False, # If true, only users with the organizer role can share folders. If false, users with either the organizer role or the file organizer role can share folders.
},
"themeId": "A String", # The ID of the theme from which the background image and color will be set. The set of possible `driveThemes` can be retrieved from a `drive.about.get` response. When not specified on a `drive.drives.create` request, a random theme is chosen from which the background image and color are set. This is a write-only field; it can only be set on requests that don't set `colorRgb` or `backgroundImageFile`.
},
],
"kind": "drive#driveList", # Identifies what kind of resource this is. Value: the fixed string `"drive#driveList"`.
"nextPageToken": "A String", # The page token for the next page of shared drives. This will be absent if the end of the 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.
}</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="unhide">unhide(driveId, x__xgafv=None)</code>
<pre>Restores a shared drive to the default view. For more information, see [Manage shared drives](https://developers.google.com/workspace/drive/api/guides/manage-shareddrives).
Args:
driveId: string, The ID of the shared drive. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Representation of a shared drive. Some resource methods (such as `drives.update`) require a `driveId`. Use the `drives.list` method to retrieve the ID for a shared drive.
"backgroundImageFile": { # An image file and cropping parameters from which a background image for this shared drive is set. This is a write only field; it can only be set on `drive.drives.update` requests that don't set `themeId`. When specified, all fields of the `backgroundImageFile` must be set.
"id": "A String", # The ID of an image file in Google Drive to use for the background image.
"width": 3.14, # The width of the cropped image in the closed range of 0 to 1. This value represents the width of the cropped image divided by the width of the entire image. The height is computed by applying a width to height aspect ratio of 80 to 9. The resulting image must be at least 1280 pixels wide and 144 pixels high.
"xCoordinate": 3.14, # The X coordinate of the upper left corner of the cropping area in the background image. This is a value in the closed range of 0 to 1. This value represents the horizontal distance from the left side of the entire image to the left side of the cropping area divided by the width of the entire image.
"yCoordinate": 3.14, # The Y coordinate of the upper left corner of the cropping area in the background image. This is a value in the closed range of 0 to 1. This value represents the vertical distance from the top side of the entire image to the top side of the cropping area divided by the height of the entire image.
},
"backgroundImageLink": "A String", # Output only. A short-lived link to this shared drive's background image.
"capabilities": { # Output only. Capabilities the current user has on this shared drive.
"canAddChildren": True or False, # Output only. Whether the current user can add children to folders in this shared drive.
"canChangeCopyRequiresWriterPermissionRestriction": True or False, # Output only. Whether the current user can change the `copyRequiresWriterPermission` restriction of this shared drive.
"canChangeDomainUsersOnlyRestriction": True or False, # Output only. Whether the current user can change the `domainUsersOnly` restriction of this shared drive.
"canChangeDownloadRestriction": True or False, # Output only. Whether the current user can change organizer-applied download restrictions of this shared drive.
"canChangeDriveBackground": True or False, # Output only. Whether the current user can change the background of this shared drive.
"canChangeDriveMembersOnlyRestriction": True or False, # Output only. Whether the current user can change the `driveMembersOnly` restriction of this shared drive.
"canChangeSharingFoldersRequiresOrganizerPermissionRestriction": True or False, # Output only. Whether the current user can change the `sharingFoldersRequiresOrganizerPermission` restriction of this shared drive.
"canComment": True or False, # Output only. Whether the current user can comment on files in this shared drive.
"canCopy": True or False, # Output only. Whether the current user can copy files in this shared drive.
"canDeleteChildren": True or False, # Output only. Whether the current user can delete children from folders in this shared drive.
"canDeleteDrive": True or False, # Output only. Whether the current user can delete this shared drive. Attempting to delete the shared drive may still fail if there are untrashed items inside the shared drive.
"canDownload": True or False, # Output only. Whether the current user can download files in this shared drive.
"canEdit": True or False, # Output only. Whether the current user can edit files in this shared drive
"canListChildren": True or False, # Output only. Whether the current user can list the children of folders in this shared drive.
"canManageMembers": True or False, # Output only. Whether the current user can add members to this shared drive or remove them or change their role.
"canReadRevisions": True or False, # Output only. Whether the current user can read the revisions resource of files in this shared drive.
"canRename": True or False, # Output only. Whether the current user can rename files or folders in this shared drive.
"canRenameDrive": True or False, # Output only. Whether the current user can rename this shared drive.
"canResetDriveRestrictions": True or False, # Output only. Whether the current user can reset the shared drive restrictions to defaults.
"canShare": True or False, # Output only. Whether the current user can share files or folders in this shared drive.
"canTrashChildren": True or False, # Output only. Whether the current user can trash children from folders in this shared drive.
},
"colorRgb": "A String", # The color of this shared drive as an RGB hex string. It can only be set on a `drive.drives.update` request that does not set `themeId`.
"createdTime": "A String", # The time at which the shared drive was created (RFC 3339 date-time).
"hidden": True or False, # Whether the shared drive is hidden from default view.
"id": "A String", # Output only. The ID of this shared drive which is also the ID of the top level folder of this shared drive.
"kind": "drive#drive", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#drive"`.
"name": "A String", # The name of this shared drive.
"orgUnitId": "A String", # Output only. The organizational unit of this shared drive. This field is only populated on `drives.list` responses when the `useDomainAdminAccess` parameter is set to `true`.
"restrictions": { # A set of restrictions that apply to this shared drive or items inside this shared drive. Note that restrictions can't be set when creating a shared drive. To add a restriction, first create a shared drive and then use `drives.update` to add restrictions.
"adminManagedRestrictions": True or False, # Whether administrative privileges on this shared drive are required to modify restrictions.
"copyRequiresWriterPermission": True or False, # Whether the options to copy, print, or download files inside this shared drive, should be disabled for readers and commenters. When this restriction is set to `true`, it will override the similarly named field to `true` for any file inside this shared drive.
"domainUsersOnly": True or False, # Whether access to this shared drive and items inside this shared drive is restricted to users of the domain to which this shared drive belongs. This restriction may be overridden by other sharing policies controlled outside of this shared drive.
"downloadRestriction": { # A restriction for copy and download of the file. # Download restrictions applied by shared drive managers.
"restrictedForReaders": True or False, # Whether download and copy is restricted for readers.
"restrictedForWriters": True or False, # Whether download and copy is restricted for writers. If true, download is also restricted for readers.
},
"driveMembersOnly": True or False, # Whether access to items inside this shared drive is restricted to its members.
"sharingFoldersRequiresOrganizerPermission": True or False, # If true, only users with the organizer role can share folders. If false, users with either the organizer role or the file organizer role can share folders.
},
"themeId": "A String", # The ID of the theme from which the background image and color will be set. The set of possible `driveThemes` can be retrieved from a `drive.about.get` response. When not specified on a `drive.drives.create` request, a random theme is chosen from which the background image and color are set. This is a write-only field; it can only be set on requests that don't set `colorRgb` or `backgroundImageFile`.
}</pre>
</div>
<div class="method">
<code class="details" id="update">update(driveId, body=None, useDomainAdminAccess=None, x__xgafv=None)</code>
<pre>Updates the metadata for a shared drive. For more information, see [Manage shared drives](https://developers.google.com/workspace/drive/api/guides/manage-shareddrives).
Args:
driveId: string, The ID of the shared drive. (required)
body: object, The request body.
The object takes the form of:
{ # Representation of a shared drive. Some resource methods (such as `drives.update`) require a `driveId`. Use the `drives.list` method to retrieve the ID for a shared drive.
"backgroundImageFile": { # An image file and cropping parameters from which a background image for this shared drive is set. This is a write only field; it can only be set on `drive.drives.update` requests that don't set `themeId`. When specified, all fields of the `backgroundImageFile` must be set.
"id": "A String", # The ID of an image file in Google Drive to use for the background image.
"width": 3.14, # The width of the cropped image in the closed range of 0 to 1. This value represents the width of the cropped image divided by the width of the entire image. The height is computed by applying a width to height aspect ratio of 80 to 9. The resulting image must be at least 1280 pixels wide and 144 pixels high.
"xCoordinate": 3.14, # The X coordinate of the upper left corner of the cropping area in the background image. This is a value in the closed range of 0 to 1. This value represents the horizontal distance from the left side of the entire image to the left side of the cropping area divided by the width of the entire image.
"yCoordinate": 3.14, # The Y coordinate of the upper left corner of the cropping area in the background image. This is a value in the closed range of 0 to 1. This value represents the vertical distance from the top side of the entire image to the top side of the cropping area divided by the height of the entire image.
},
"backgroundImageLink": "A String", # Output only. A short-lived link to this shared drive's background image.
"capabilities": { # Output only. Capabilities the current user has on this shared drive.
"canAddChildren": True or False, # Output only. Whether the current user can add children to folders in this shared drive.
"canChangeCopyRequiresWriterPermissionRestriction": True or False, # Output only. Whether the current user can change the `copyRequiresWriterPermission` restriction of this shared drive.
"canChangeDomainUsersOnlyRestriction": True or False, # Output only. Whether the current user can change the `domainUsersOnly` restriction of this shared drive.
"canChangeDownloadRestriction": True or False, # Output only. Whether the current user can change organizer-applied download restrictions of this shared drive.
"canChangeDriveBackground": True or False, # Output only. Whether the current user can change the background of this shared drive.
"canChangeDriveMembersOnlyRestriction": True or False, # Output only. Whether the current user can change the `driveMembersOnly` restriction of this shared drive.
"canChangeSharingFoldersRequiresOrganizerPermissionRestriction": True or False, # Output only. Whether the current user can change the `sharingFoldersRequiresOrganizerPermission` restriction of this shared drive.
"canComment": True or False, # Output only. Whether the current user can comment on files in this shared drive.
"canCopy": True or False, # Output only. Whether the current user can copy files in this shared drive.
"canDeleteChildren": True or False, # Output only. Whether the current user can delete children from folders in this shared drive.
"canDeleteDrive": True or False, # Output only. Whether the current user can delete this shared drive. Attempting to delete the shared drive may still fail if there are untrashed items inside the shared drive.
"canDownload": True or False, # Output only. Whether the current user can download files in this shared drive.
"canEdit": True or False, # Output only. Whether the current user can edit files in this shared drive
"canListChildren": True or False, # Output only. Whether the current user can list the children of folders in this shared drive.
"canManageMembers": True or False, # Output only. Whether the current user can add members to this shared drive or remove them or change their role.
"canReadRevisions": True or False, # Output only. Whether the current user can read the revisions resource of files in this shared drive.
"canRename": True or False, # Output only. Whether the current user can rename files or folders in this shared drive.
"canRenameDrive": True or False, # Output only. Whether the current user can rename this shared drive.
"canResetDriveRestrictions": True or False, # Output only. Whether the current user can reset the shared drive restrictions to defaults.
"canShare": True or False, # Output only. Whether the current user can share files or folders in this shared drive.
"canTrashChildren": True or False, # Output only. Whether the current user can trash children from folders in this shared drive.
},
"colorRgb": "A String", # The color of this shared drive as an RGB hex string. It can only be set on a `drive.drives.update` request that does not set `themeId`.
"createdTime": "A String", # The time at which the shared drive was created (RFC 3339 date-time).
"hidden": True or False, # Whether the shared drive is hidden from default view.
"id": "A String", # Output only. The ID of this shared drive which is also the ID of the top level folder of this shared drive.
"kind": "drive#drive", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#drive"`.
"name": "A String", # The name of this shared drive.
"orgUnitId": "A String", # Output only. The organizational unit of this shared drive. This field is only populated on `drives.list` responses when the `useDomainAdminAccess` parameter is set to `true`.
"restrictions": { # A set of restrictions that apply to this shared drive or items inside this shared drive. Note that restrictions can't be set when creating a shared drive. To add a restriction, first create a shared drive and then use `drives.update` to add restrictions.
"adminManagedRestrictions": True or False, # Whether administrative privileges on this shared drive are required to modify restrictions.
"copyRequiresWriterPermission": True or False, # Whether the options to copy, print, or download files inside this shared drive, should be disabled for readers and commenters. When this restriction is set to `true`, it will override the similarly named field to `true` for any file inside this shared drive.
"domainUsersOnly": True or False, # Whether access to this shared drive and items inside this shared drive is restricted to users of the domain to which this shared drive belongs. This restriction may be overridden by other sharing policies controlled outside of this shared drive.
"downloadRestriction": { # A restriction for copy and download of the file. # Download restrictions applied by shared drive managers.
"restrictedForReaders": True or False, # Whether download and copy is restricted for readers.
"restrictedForWriters": True or False, # Whether download and copy is restricted for writers. If true, download is also restricted for readers.
},
"driveMembersOnly": True or False, # Whether access to items inside this shared drive is restricted to its members.
"sharingFoldersRequiresOrganizerPermission": True or False, # If true, only users with the organizer role can share folders. If false, users with either the organizer role or the file organizer role can share folders.
},
"themeId": "A String", # The ID of the theme from which the background image and color will be set. The set of possible `driveThemes` can be retrieved from a `drive.about.get` response. When not specified on a `drive.drives.create` request, a random theme is chosen from which the background image and color are set. This is a write-only field; it can only be set on requests that don't set `colorRgb` or `backgroundImageFile`.
}
useDomainAdminAccess: boolean, Issue the request as a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the shared drive belongs.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Representation of a shared drive. Some resource methods (such as `drives.update`) require a `driveId`. Use the `drives.list` method to retrieve the ID for a shared drive.
"backgroundImageFile": { # An image file and cropping parameters from which a background image for this shared drive is set. This is a write only field; it can only be set on `drive.drives.update` requests that don't set `themeId`. When specified, all fields of the `backgroundImageFile` must be set.
"id": "A String", # The ID of an image file in Google Drive to use for the background image.
"width": 3.14, # The width of the cropped image in the closed range of 0 to 1. This value represents the width of the cropped image divided by the width of the entire image. The height is computed by applying a width to height aspect ratio of 80 to 9. The resulting image must be at least 1280 pixels wide and 144 pixels high.
"xCoordinate": 3.14, # The X coordinate of the upper left corner of the cropping area in the background image. This is a value in the closed range of 0 to 1. This value represents the horizontal distance from the left side of the entire image to the left side of the cropping area divided by the width of the entire image.
"yCoordinate": 3.14, # The Y coordinate of the upper left corner of the cropping area in the background image. This is a value in the closed range of 0 to 1. This value represents the vertical distance from the top side of the entire image to the top side of the cropping area divided by the height of the entire image.
},
"backgroundImageLink": "A String", # Output only. A short-lived link to this shared drive's background image.
"capabilities": { # Output only. Capabilities the current user has on this shared drive.
"canAddChildren": True or False, # Output only. Whether the current user can add children to folders in this shared drive.
"canChangeCopyRequiresWriterPermissionRestriction": True or False, # Output only. Whether the current user can change the `copyRequiresWriterPermission` restriction of this shared drive.
"canChangeDomainUsersOnlyRestriction": True or False, # Output only. Whether the current user can change the `domainUsersOnly` restriction of this shared drive.
"canChangeDownloadRestriction": True or False, # Output only. Whether the current user can change organizer-applied download restrictions of this shared drive.
"canChangeDriveBackground": True or False, # Output only. Whether the current user can change the background of this shared drive.
"canChangeDriveMembersOnlyRestriction": True or False, # Output only. Whether the current user can change the `driveMembersOnly` restriction of this shared drive.
"canChangeSharingFoldersRequiresOrganizerPermissionRestriction": True or False, # Output only. Whether the current user can change the `sharingFoldersRequiresOrganizerPermission` restriction of this shared drive.
"canComment": True or False, # Output only. Whether the current user can comment on files in this shared drive.
"canCopy": True or False, # Output only. Whether the current user can copy files in this shared drive.
"canDeleteChildren": True or False, # Output only. Whether the current user can delete children from folders in this shared drive.
"canDeleteDrive": True or False, # Output only. Whether the current user can delete this shared drive. Attempting to delete the shared drive may still fail if there are untrashed items inside the shared drive.
"canDownload": True or False, # Output only. Whether the current user can download files in this shared drive.
"canEdit": True or False, # Output only. Whether the current user can edit files in this shared drive
"canListChildren": True or False, # Output only. Whether the current user can list the children of folders in this shared drive.
"canManageMembers": True or False, # Output only. Whether the current user can add members to this shared drive or remove them or change their role.
"canReadRevisions": True or False, # Output only. Whether the current user can read the revisions resource of files in this shared drive.
"canRename": True or False, # Output only. Whether the current user can rename files or folders in this shared drive.
"canRenameDrive": True or False, # Output only. Whether the current user can rename this shared drive.
"canResetDriveRestrictions": True or False, # Output only. Whether the current user can reset the shared drive restrictions to defaults.
"canShare": True or False, # Output only. Whether the current user can share files or folders in this shared drive.
"canTrashChildren": True or False, # Output only. Whether the current user can trash children from folders in this shared drive.
},
"colorRgb": "A String", # The color of this shared drive as an RGB hex string. It can only be set on a `drive.drives.update` request that does not set `themeId`.
"createdTime": "A String", # The time at which the shared drive was created (RFC 3339 date-time).
"hidden": True or False, # Whether the shared drive is hidden from default view.
"id": "A String", # Output only. The ID of this shared drive which is also the ID of the top level folder of this shared drive.
"kind": "drive#drive", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#drive"`.
"name": "A String", # The name of this shared drive.
"orgUnitId": "A String", # Output only. The organizational unit of this shared drive. This field is only populated on `drives.list` responses when the `useDomainAdminAccess` parameter is set to `true`.
"restrictions": { # A set of restrictions that apply to this shared drive or items inside this shared drive. Note that restrictions can't be set when creating a shared drive. To add a restriction, first create a shared drive and then use `drives.update` to add restrictions.
"adminManagedRestrictions": True or False, # Whether administrative privileges on this shared drive are required to modify restrictions.
"copyRequiresWriterPermission": True or False, # Whether the options to copy, print, or download files inside this shared drive, should be disabled for readers and commenters. When this restriction is set to `true`, it will override the similarly named field to `true` for any file inside this shared drive.
"domainUsersOnly": True or False, # Whether access to this shared drive and items inside this shared drive is restricted to users of the domain to which this shared drive belongs. This restriction may be overridden by other sharing policies controlled outside of this shared drive.
"downloadRestriction": { # A restriction for copy and download of the file. # Download restrictions applied by shared drive managers.
"restrictedForReaders": True or False, # Whether download and copy is restricted for readers.
"restrictedForWriters": True or False, # Whether download and copy is restricted for writers. If true, download is also restricted for readers.
},
"driveMembersOnly": True or False, # Whether access to items inside this shared drive is restricted to its members.
"sharingFoldersRequiresOrganizerPermission": True or False, # If true, only users with the organizer role can share folders. If false, users with either the organizer role or the file organizer role can share folders.
},
"themeId": "A String", # The ID of the theme from which the background image and color will be set. The set of possible `driveThemes` can be retrieved from a `drive.about.get` response. When not specified on a `drive.drives.create` request, a random theme is chosen from which the background image and color are set. This is a write-only field; it can only be set on requests that don't set `colorRgb` or `backgroundImageFile`.
}</pre>
</div>
</body></html>
|
