Debian Codegraph @

docs/dyn/drive_v2.drives.html

raw
1 <html><body>
2 <style>
3
4 body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13 }
14
15 body {
16 font-size: 13px;
17 padding: 1em;
18 }
19
20 h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23 }
24
25 h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28 }
29
30 h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34 }
35
36 pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39 }
40
41 pre {
42 margin-top: 0.5em;
43 }
44
45 h1, h2, h3, p {
46 font-family: Arial, sans serif;
47 }
48
49 h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51 }
52
53 .toc_element {
54 margin-top: 0.5em;
55 }
56
57 .firstline {
58 margin-left: 2 em;
59 }
60
61 .method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66 }
67
68 .details {
69 font-weight: bold;
70 font-size: 14px;
71 }
72
73 </style>
74
75 <h1><a href="drive_v2.html">Google Drive API</a> . <a href="drive_v2.drives.html">drives</a></h1>
76 <h2>Instance Methods</h2>
77 <p class="toc_element">
78 <code><a href="#close">close()</a></code></p>
79 <p class="firstline">Close httplib2 connections.</p>
80 <p class="toc_element">
81 <code><a href="#delete">delete(driveId, allowItemDeletion=None, useDomainAdminAccess=None, x__xgafv=None)</a></code></p>
82 <p class="firstline">Permanently deletes a shared drive for which the user is an `organizer`. The shared drive cannot contain any untrashed items.</p>
83 <p class="toc_element">
84 <code><a href="#get">get(driveId, useDomainAdminAccess=None, x__xgafv=None)</a></code></p>
85 <p class="firstline">Gets a shared drive's metadata by ID.</p>
86 <p class="toc_element">
87 <code><a href="#hide">hide(driveId, x__xgafv=None)</a></code></p>
88 <p class="firstline">Hides a shared drive from the default view.</p>
89 <p class="toc_element">
90 <code><a href="#insert">insert(requestId, body=None, x__xgafv=None)</a></code></p>
91 <p class="firstline">Creates a new shared drive.</p>
92 <p class="toc_element">
93 <code><a href="#list">list(maxResults=None, pageToken=None, q=None, useDomainAdminAccess=None, x__xgafv=None)</a></code></p>
94 <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](https://developers.google.com/workspace/drive/api/guides/search-shareddrives) guide.</p>
95 <p class="toc_element">
96 <code><a href="#list_next">list_next()</a></code></p>
97 <p class="firstline">Retrieves the next page of results.</p>
98 <p class="toc_element">
99 <code><a href="#unhide">unhide(driveId, x__xgafv=None)</a></code></p>
100 <p class="firstline">Restores a shared drive to the default view.</p>
101 <p class="toc_element">
102 <code><a href="#update">update(driveId, body=None, useDomainAdminAccess=None, x__xgafv=None)</a></code></p>
103 <p class="firstline">Updates the metadata for a shared drive.</p>
104 <h3>Method Details</h3>
105 <div class="method">
106 <code class="details" id="close">close()</code>
107 <pre>Close httplib2 connections.</pre>
108 </div>
109
110 <div class="method">
111 <code class="details" id="delete">delete(driveId, allowItemDeletion=None, useDomainAdminAccess=None, x__xgafv=None)</code>
112 <pre>Permanently deletes a shared drive for which the user is an `organizer`. The shared drive cannot contain any untrashed items.
113
114 Args:
115 driveId: string, The ID of the shared drive. (required)
116 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`.
117 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.
118 x__xgafv: string, V1 error format.
119 Allowed values
120 1 - v1 error format
121 2 - v2 error format
122 </pre>
123 </div>
124
125 <div class="method">
126 <code class="details" id="get">get(driveId, useDomainAdminAccess=None, x__xgafv=None)</code>
127 <pre>Gets a shared drive&#x27;s metadata by ID.
128
129 Args:
130 driveId: string, The ID of the shared drive. (required)
131 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.
132 x__xgafv: string, V1 error format.
133 Allowed values
134 1 - v1 error format
135 2 - v2 error format
136
137 Returns:
138 An object of the form:
139
140 { # 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.
141 &quot;backgroundImageFile&quot;: { # 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&#x27;t set `themeId`. When specified, all fields of the `backgroundImageFile` must be set.
142 &quot;id&quot;: &quot;A String&quot;, # The ID of an image file in Google Drive to use for the background image.
143 &quot;width&quot;: 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.
144 &quot;xCoordinate&quot;: 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.
145 &quot;yCoordinate&quot;: 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.
146 },
147 &quot;backgroundImageLink&quot;: &quot;A String&quot;, # Output only. A short-lived link to this shared drive&#x27;s background image.
148 &quot;capabilities&quot;: { # Output only. Capabilities the current user has on this shared drive.
149 &quot;canAddChildren&quot;: True or False, # Output only. Whether the current user can add children to folders in this shared drive.
150 &quot;canChangeCopyRequiresWriterPermissionRestriction&quot;: True or False, # Output only. Whether the current user can change the `copyRequiresWriterPermission` restriction of this shared drive.
151 &quot;canChangeDomainUsersOnlyRestriction&quot;: True or False, # Output only. Whether the current user can change the `domainUsersOnly` restriction of this shared drive.
152 &quot;canChangeDriveBackground&quot;: True or False, # Output only. Whether the current user can change the background of this shared drive.
153 &quot;canChangeDriveMembersOnlyRestriction&quot;: True or False, # Output only. Whether the current user can change the `driveMembersOnly` restriction of this shared drive.
154 &quot;canChangeSharingFoldersRequiresOrganizerPermissionRestriction&quot;: True or False, # Output only. Whether the current user can change the `sharingFoldersRequiresOrganizerPermission` restriction of this shared drive.
155 &quot;canComment&quot;: True or False, # Output only. Whether the current user can comment on files in this shared drive.
156 &quot;canCopy&quot;: True or False, # Output only. Whether the current user can copy files in this shared drive.
157 &quot;canDeleteChildren&quot;: True or False, # Output only. Whether the current user can delete children from folders in this shared drive.
158 &quot;canDeleteDrive&quot;: 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.
159 &quot;canDownload&quot;: True or False, # Output only. Whether the current user can download files in this shared drive.
160 &quot;canEdit&quot;: True or False, # Output only. Whether the current user can edit files in this shared drive
161 &quot;canListChildren&quot;: True or False, # Output only. Whether the current user can list the children of folders in this shared drive.
162 &quot;canManageMembers&quot;: True or False, # Output only. Whether the current user can add members to this shared drive or remove them or change their role.
163 &quot;canReadRevisions&quot;: True or False, # Output only. Whether the current user can read the revisions resource of files in this shared drive.
164 &quot;canRename&quot;: True or False, # Output only. Whether the current user can rename files or folders in this shared drive.
165 &quot;canRenameDrive&quot;: True or False, # Output only. Whether the current user can rename this shared drive.
166 &quot;canResetDriveRestrictions&quot;: True or False, # Output only. Whether the current user can reset the shared drive restrictions to defaults.
167 &quot;canShare&quot;: True or False, # Output only. Whether the current user can share files or folders in this shared drive.
168 &quot;canTrashChildren&quot;: True or False, # Output only. Whether the current user can trash children from folders in this shared drive.
169 },
170 &quot;colorRgb&quot;: &quot;A String&quot;, # 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`.
171 &quot;createdDate&quot;: &quot;A String&quot;, # The time at which the shared drive was created (RFC 3339 date-time).
172 &quot;hidden&quot;: True or False, # Whether the shared drive is hidden from default view.
173 &quot;id&quot;: &quot;A String&quot;, # Output only. The ID of this shared drive which is also the ID of the top level folder of this shared drive.
174 &quot;kind&quot;: &quot;drive#drive&quot;, # Output only. This is always `drive#drive`
175 &quot;name&quot;: &quot;A String&quot;, # The name of this shared drive.
176 &quot;orgUnitId&quot;: &quot;A String&quot;, # 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`.
177 &quot;restrictions&quot;: { # A set of restrictions that apply to this shared drive or items inside this shared drive.
178 &quot;adminManagedRestrictions&quot;: True or False, # Whether administrative privileges on this shared drive are required to modify restrictions.
179 &quot;copyRequiresWriterPermission&quot;: 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.
180 &quot;domainUsersOnly&quot;: 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.
181 &quot;driveMembersOnly&quot;: True or False, # Whether access to items inside this shared drive is restricted to its members.
182 &quot;sharingFoldersRequiresOrganizerPermission&quot;: 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.
183 },
184 &quot;themeId&quot;: &quot;A String&quot;, # 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.insert` 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&#x27;t set `colorRgb` or `backgroundImageFile`.
185 }</pre>
186 </div>
187
188 <div class="method">
189 <code class="details" id="hide">hide(driveId, x__xgafv=None)</code>
190 <pre>Hides a shared drive from the default view.
191
192 Args:
193 driveId: string, The ID of the shared drive. (required)
194 x__xgafv: string, V1 error format.
195 Allowed values
196 1 - v1 error format
197 2 - v2 error format
198
199 Returns:
200 An object of the form:
201
202 { # 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.
203 &quot;backgroundImageFile&quot;: { # 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&#x27;t set `themeId`. When specified, all fields of the `backgroundImageFile` must be set.
204 &quot;id&quot;: &quot;A String&quot;, # The ID of an image file in Google Drive to use for the background image.
205 &quot;width&quot;: 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.
206 &quot;xCoordinate&quot;: 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.
207 &quot;yCoordinate&quot;: 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.
208 },
209 &quot;backgroundImageLink&quot;: &quot;A String&quot;, # Output only. A short-lived link to this shared drive&#x27;s background image.
210 &quot;capabilities&quot;: { # Output only. Capabilities the current user has on this shared drive.
211 &quot;canAddChildren&quot;: True or False, # Output only. Whether the current user can add children to folders in this shared drive.
212 &quot;canChangeCopyRequiresWriterPermissionRestriction&quot;: True or False, # Output only. Whether the current user can change the `copyRequiresWriterPermission` restriction of this shared drive.
213 &quot;canChangeDomainUsersOnlyRestriction&quot;: True or False, # Output only. Whether the current user can change the `domainUsersOnly` restriction of this shared drive.
214 &quot;canChangeDriveBackground&quot;: True or False, # Output only. Whether the current user can change the background of this shared drive.
215 &quot;canChangeDriveMembersOnlyRestriction&quot;: True or False, # Output only. Whether the current user can change the `driveMembersOnly` restriction of this shared drive.
216 &quot;canChangeSharingFoldersRequiresOrganizerPermissionRestriction&quot;: True or False, # Output only. Whether the current user can change the `sharingFoldersRequiresOrganizerPermission` restriction of this shared drive.
217 &quot;canComment&quot;: True or False, # Output only. Whether the current user can comment on files in this shared drive.
218 &quot;canCopy&quot;: True or False, # Output only. Whether the current user can copy files in this shared drive.
219 &quot;canDeleteChildren&quot;: True or False, # Output only. Whether the current user can delete children from folders in this shared drive.
220 &quot;canDeleteDrive&quot;: 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.
221 &quot;canDownload&quot;: True or False, # Output only. Whether the current user can download files in this shared drive.
222 &quot;canEdit&quot;: True or False, # Output only. Whether the current user can edit files in this shared drive
223 &quot;canListChildren&quot;: True or False, # Output only. Whether the current user can list the children of folders in this shared drive.
224 &quot;canManageMembers&quot;: True or False, # Output only. Whether the current user can add members to this shared drive or remove them or change their role.
225 &quot;canReadRevisions&quot;: True or False, # Output only. Whether the current user can read the revisions resource of files in this shared drive.
226 &quot;canRename&quot;: True or False, # Output only. Whether the current user can rename files or folders in this shared drive.
227 &quot;canRenameDrive&quot;: True or False, # Output only. Whether the current user can rename this shared drive.
228 &quot;canResetDriveRestrictions&quot;: True or False, # Output only. Whether the current user can reset the shared drive restrictions to defaults.
229 &quot;canShare&quot;: True or False, # Output only. Whether the current user can share files or folders in this shared drive.
230 &quot;canTrashChildren&quot;: True or False, # Output only. Whether the current user can trash children from folders in this shared drive.
231 },
232 &quot;colorRgb&quot;: &quot;A String&quot;, # 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`.
233 &quot;createdDate&quot;: &quot;A String&quot;, # The time at which the shared drive was created (RFC 3339 date-time).
234 &quot;hidden&quot;: True or False, # Whether the shared drive is hidden from default view.
235 &quot;id&quot;: &quot;A String&quot;, # Output only. The ID of this shared drive which is also the ID of the top level folder of this shared drive.
236 &quot;kind&quot;: &quot;drive#drive&quot;, # Output only. This is always `drive#drive`
237 &quot;name&quot;: &quot;A String&quot;, # The name of this shared drive.
238 &quot;orgUnitId&quot;: &quot;A String&quot;, # 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`.
239 &quot;restrictions&quot;: { # A set of restrictions that apply to this shared drive or items inside this shared drive.
240 &quot;adminManagedRestrictions&quot;: True or False, # Whether administrative privileges on this shared drive are required to modify restrictions.
241 &quot;copyRequiresWriterPermission&quot;: 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.
242 &quot;domainUsersOnly&quot;: 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.
243 &quot;driveMembersOnly&quot;: True or False, # Whether access to items inside this shared drive is restricted to its members.
244 &quot;sharingFoldersRequiresOrganizerPermission&quot;: 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.
245 },
246 &quot;themeId&quot;: &quot;A String&quot;, # 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.insert` 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&#x27;t set `colorRgb` or `backgroundImageFile`.
247 }</pre>
248 </div>
249
250 <div class="method">
251 <code class="details" id="insert">insert(requestId, body=None, x__xgafv=None)</code>
252 <pre>Creates a new shared drive.
253
254 Args:
255 requestId: string, Required. An ID, such as a random UUID, which uniquely identifies this user&#x27;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)
256 body: object, The request body.
257 The object takes the form of:
258
259 { # 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.
260 &quot;backgroundImageFile&quot;: { # 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&#x27;t set `themeId`. When specified, all fields of the `backgroundImageFile` must be set.
261 &quot;id&quot;: &quot;A String&quot;, # The ID of an image file in Google Drive to use for the background image.
262 &quot;width&quot;: 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.
263 &quot;xCoordinate&quot;: 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.
264 &quot;yCoordinate&quot;: 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.
265 },
266 &quot;backgroundImageLink&quot;: &quot;A String&quot;, # Output only. A short-lived link to this shared drive&#x27;s background image.
267 &quot;capabilities&quot;: { # Output only. Capabilities the current user has on this shared drive.
268 &quot;canAddChildren&quot;: True or False, # Output only. Whether the current user can add children to folders in this shared drive.
269 &quot;canChangeCopyRequiresWriterPermissionRestriction&quot;: True or False, # Output only. Whether the current user can change the `copyRequiresWriterPermission` restriction of this shared drive.
270 &quot;canChangeDomainUsersOnlyRestriction&quot;: True or False, # Output only. Whether the current user can change the `domainUsersOnly` restriction of this shared drive.
271 &quot;canChangeDriveBackground&quot;: True or False, # Output only. Whether the current user can change the background of this shared drive.
272 &quot;canChangeDriveMembersOnlyRestriction&quot;: True or False, # Output only. Whether the current user can change the `driveMembersOnly` restriction of this shared drive.
273 &quot;canChangeSharingFoldersRequiresOrganizerPermissionRestriction&quot;: True or False, # Output only. Whether the current user can change the `sharingFoldersRequiresOrganizerPermission` restriction of this shared drive.
274 &quot;canComment&quot;: True or False, # Output only. Whether the current user can comment on files in this shared drive.
275 &quot;canCopy&quot;: True or False, # Output only. Whether the current user can copy files in this shared drive.
276 &quot;canDeleteChildren&quot;: True or False, # Output only. Whether the current user can delete children from folders in this shared drive.
277 &quot;canDeleteDrive&quot;: 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.
278 &quot;canDownload&quot;: True or False, # Output only. Whether the current user can download files in this shared drive.
279 &quot;canEdit&quot;: True or False, # Output only. Whether the current user can edit files in this shared drive
280 &quot;canListChildren&quot;: True or False, # Output only. Whether the current user can list the children of folders in this shared drive.
281 &quot;canManageMembers&quot;: True or False, # Output only. Whether the current user can add members to this shared drive or remove them or change their role.
282 &quot;canReadRevisions&quot;: True or False, # Output only. Whether the current user can read the revisions resource of files in this shared drive.
283 &quot;canRename&quot;: True or False, # Output only. Whether the current user can rename files or folders in this shared drive.
284 &quot;canRenameDrive&quot;: True or False, # Output only. Whether the current user can rename this shared drive.
285 &quot;canResetDriveRestrictions&quot;: True or False, # Output only. Whether the current user can reset the shared drive restrictions to defaults.
286 &quot;canShare&quot;: True or False, # Output only. Whether the current user can share files or folders in this shared drive.
287 &quot;canTrashChildren&quot;: True or False, # Output only. Whether the current user can trash children from folders in this shared drive.
288 },
289 &quot;colorRgb&quot;: &quot;A String&quot;, # 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`.
290 &quot;createdDate&quot;: &quot;A String&quot;, # The time at which the shared drive was created (RFC 3339 date-time).
291 &quot;hidden&quot;: True or False, # Whether the shared drive is hidden from default view.
292 &quot;id&quot;: &quot;A String&quot;, # Output only. The ID of this shared drive which is also the ID of the top level folder of this shared drive.
293 &quot;kind&quot;: &quot;drive#drive&quot;, # Output only. This is always `drive#drive`
294 &quot;name&quot;: &quot;A String&quot;, # The name of this shared drive.
295 &quot;orgUnitId&quot;: &quot;A String&quot;, # 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`.
296 &quot;restrictions&quot;: { # A set of restrictions that apply to this shared drive or items inside this shared drive.
297 &quot;adminManagedRestrictions&quot;: True or False, # Whether administrative privileges on this shared drive are required to modify restrictions.
298 &quot;copyRequiresWriterPermission&quot;: 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.
299 &quot;domainUsersOnly&quot;: 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.
300 &quot;driveMembersOnly&quot;: True or False, # Whether access to items inside this shared drive is restricted to its members.
301 &quot;sharingFoldersRequiresOrganizerPermission&quot;: 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.
302 },
303 &quot;themeId&quot;: &quot;A String&quot;, # 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.insert` 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&#x27;t set `colorRgb` or `backgroundImageFile`.
304 }
305
306 x__xgafv: string, V1 error format.
307 Allowed values
308 1 - v1 error format
309 2 - v2 error format
310
311 Returns:
312 An object of the form:
313
314 { # 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.
315 &quot;backgroundImageFile&quot;: { # 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&#x27;t set `themeId`. When specified, all fields of the `backgroundImageFile` must be set.
316 &quot;id&quot;: &quot;A String&quot;, # The ID of an image file in Google Drive to use for the background image.
317 &quot;width&quot;: 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.
318 &quot;xCoordinate&quot;: 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.
319 &quot;yCoordinate&quot;: 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.
320 },
321 &quot;backgroundImageLink&quot;: &quot;A String&quot;, # Output only. A short-lived link to this shared drive&#x27;s background image.
322 &quot;capabilities&quot;: { # Output only. Capabilities the current user has on this shared drive.
323 &quot;canAddChildren&quot;: True or False, # Output only. Whether the current user can add children to folders in this shared drive.
324 &quot;canChangeCopyRequiresWriterPermissionRestriction&quot;: True or False, # Output only. Whether the current user can change the `copyRequiresWriterPermission` restriction of this shared drive.
325 &quot;canChangeDomainUsersOnlyRestriction&quot;: True or False, # Output only. Whether the current user can change the `domainUsersOnly` restriction of this shared drive.
326 &quot;canChangeDriveBackground&quot;: True or False, # Output only. Whether the current user can change the background of this shared drive.
327 &quot;canChangeDriveMembersOnlyRestriction&quot;: True or False, # Output only. Whether the current user can change the `driveMembersOnly` restriction of this shared drive.
328 &quot;canChangeSharingFoldersRequiresOrganizerPermissionRestriction&quot;: True or False, # Output only. Whether the current user can change the `sharingFoldersRequiresOrganizerPermission` restriction of this shared drive.
329 &quot;canComment&quot;: True or False, # Output only. Whether the current user can comment on files in this shared drive.
330 &quot;canCopy&quot;: True or False, # Output only. Whether the current user can copy files in this shared drive.
331 &quot;canDeleteChildren&quot;: True or False, # Output only. Whether the current user can delete children from folders in this shared drive.
332 &quot;canDeleteDrive&quot;: 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.
333 &quot;canDownload&quot;: True or False, # Output only. Whether the current user can download files in this shared drive.
334 &quot;canEdit&quot;: True or False, # Output only. Whether the current user can edit files in this shared drive
335 &quot;canListChildren&quot;: True or False, # Output only. Whether the current user can list the children of folders in this shared drive.
336 &quot;canManageMembers&quot;: True or False, # Output only. Whether the current user can add members to this shared drive or remove them or change their role.
337 &quot;canReadRevisions&quot;: True or False, # Output only. Whether the current user can read the revisions resource of files in this shared drive.
338 &quot;canRename&quot;: True or False, # Output only. Whether the current user can rename files or folders in this shared drive.
339 &quot;canRenameDrive&quot;: True or False, # Output only. Whether the current user can rename this shared drive.
340 &quot;canResetDriveRestrictions&quot;: True or False, # Output only. Whether the current user can reset the shared drive restrictions to defaults.
341 &quot;canShare&quot;: True or False, # Output only. Whether the current user can share files or folders in this shared drive.
342 &quot;canTrashChildren&quot;: True or False, # Output only. Whether the current user can trash children from folders in this shared drive.
343 },
344 &quot;colorRgb&quot;: &quot;A String&quot;, # 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`.
345 &quot;createdDate&quot;: &quot;A String&quot;, # The time at which the shared drive was created (RFC 3339 date-time).
346 &quot;hidden&quot;: True or False, # Whether the shared drive is hidden from default view.
347 &quot;id&quot;: &quot;A String&quot;, # Output only. The ID of this shared drive which is also the ID of the top level folder of this shared drive.
348 &quot;kind&quot;: &quot;drive#drive&quot;, # Output only. This is always `drive#drive`
349 &quot;name&quot;: &quot;A String&quot;, # The name of this shared drive.
350 &quot;orgUnitId&quot;: &quot;A String&quot;, # 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`.
351 &quot;restrictions&quot;: { # A set of restrictions that apply to this shared drive or items inside this shared drive.
352 &quot;adminManagedRestrictions&quot;: True or False, # Whether administrative privileges on this shared drive are required to modify restrictions.
353 &quot;copyRequiresWriterPermission&quot;: 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.
354 &quot;domainUsersOnly&quot;: 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.
355 &quot;driveMembersOnly&quot;: True or False, # Whether access to items inside this shared drive is restricted to its members.
356 &quot;sharingFoldersRequiresOrganizerPermission&quot;: 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.
357 },
358 &quot;themeId&quot;: &quot;A String&quot;, # 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.insert` 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&#x27;t set `colorRgb` or `backgroundImageFile`.
359 }</pre>
360 </div>
361
362 <div class="method">
363 <code class="details" id="list">list(maxResults=None, pageToken=None, q=None, useDomainAdminAccess=None, x__xgafv=None)</code>
364 <pre> Lists the user&#x27;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](https://developers.google.com/workspace/drive/api/guides/search-shareddrives) guide.
365
366 Args:
367 maxResults: integer, Maximum number of shared drives to return per page.
368 pageToken: string, Page token for shared drives.
369 q: string, Query string for searching shared drives.
370 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.
371 x__xgafv: string, V1 error format.
372 Allowed values
373 1 - v1 error format
374 2 - v2 error format
375
376 Returns:
377 An object of the form:
378
379 { # A list of shared drives.
380 &quot;items&quot;: [ # The list of shared drives. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched.
381 { # 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.
382 &quot;backgroundImageFile&quot;: { # 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&#x27;t set `themeId`. When specified, all fields of the `backgroundImageFile` must be set.
383 &quot;id&quot;: &quot;A String&quot;, # The ID of an image file in Google Drive to use for the background image.
384 &quot;width&quot;: 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.
385 &quot;xCoordinate&quot;: 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.
386 &quot;yCoordinate&quot;: 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.
387 },
388 &quot;backgroundImageLink&quot;: &quot;A String&quot;, # Output only. A short-lived link to this shared drive&#x27;s background image.
389 &quot;capabilities&quot;: { # Output only. Capabilities the current user has on this shared drive.
390 &quot;canAddChildren&quot;: True or False, # Output only. Whether the current user can add children to folders in this shared drive.
391 &quot;canChangeCopyRequiresWriterPermissionRestriction&quot;: True or False, # Output only. Whether the current user can change the `copyRequiresWriterPermission` restriction of this shared drive.
392 &quot;canChangeDomainUsersOnlyRestriction&quot;: True or False, # Output only. Whether the current user can change the `domainUsersOnly` restriction of this shared drive.
393 &quot;canChangeDriveBackground&quot;: True or False, # Output only. Whether the current user can change the background of this shared drive.
394 &quot;canChangeDriveMembersOnlyRestriction&quot;: True or False, # Output only. Whether the current user can change the `driveMembersOnly` restriction of this shared drive.
395 &quot;canChangeSharingFoldersRequiresOrganizerPermissionRestriction&quot;: True or False, # Output only. Whether the current user can change the `sharingFoldersRequiresOrganizerPermission` restriction of this shared drive.
396 &quot;canComment&quot;: True or False, # Output only. Whether the current user can comment on files in this shared drive.
397 &quot;canCopy&quot;: True or False, # Output only. Whether the current user can copy files in this shared drive.
398 &quot;canDeleteChildren&quot;: True or False, # Output only. Whether the current user can delete children from folders in this shared drive.
399 &quot;canDeleteDrive&quot;: 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.
400 &quot;canDownload&quot;: True or False, # Output only. Whether the current user can download files in this shared drive.
401 &quot;canEdit&quot;: True or False, # Output only. Whether the current user can edit files in this shared drive
402 &quot;canListChildren&quot;: True or False, # Output only. Whether the current user can list the children of folders in this shared drive.
403 &quot;canManageMembers&quot;: True or False, # Output only. Whether the current user can add members to this shared drive or remove them or change their role.
404 &quot;canReadRevisions&quot;: True or False, # Output only. Whether the current user can read the revisions resource of files in this shared drive.
405 &quot;canRename&quot;: True or False, # Output only. Whether the current user can rename files or folders in this shared drive.
406 &quot;canRenameDrive&quot;: True or False, # Output only. Whether the current user can rename this shared drive.
407 &quot;canResetDriveRestrictions&quot;: True or False, # Output only. Whether the current user can reset the shared drive restrictions to defaults.
408 &quot;canShare&quot;: True or False, # Output only. Whether the current user can share files or folders in this shared drive.
409 &quot;canTrashChildren&quot;: True or False, # Output only. Whether the current user can trash children from folders in this shared drive.
410 },
411 &quot;colorRgb&quot;: &quot;A String&quot;, # 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`.
412 &quot;createdDate&quot;: &quot;A String&quot;, # The time at which the shared drive was created (RFC 3339 date-time).
413 &quot;hidden&quot;: True or False, # Whether the shared drive is hidden from default view.
414 &quot;id&quot;: &quot;A String&quot;, # Output only. The ID of this shared drive which is also the ID of the top level folder of this shared drive.
415 &quot;kind&quot;: &quot;drive#drive&quot;, # Output only. This is always `drive#drive`
416 &quot;name&quot;: &quot;A String&quot;, # The name of this shared drive.
417 &quot;orgUnitId&quot;: &quot;A String&quot;, # 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`.
418 &quot;restrictions&quot;: { # A set of restrictions that apply to this shared drive or items inside this shared drive.
419 &quot;adminManagedRestrictions&quot;: True or False, # Whether administrative privileges on this shared drive are required to modify restrictions.
420 &quot;copyRequiresWriterPermission&quot;: 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.
421 &quot;domainUsersOnly&quot;: 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.
422 &quot;driveMembersOnly&quot;: True or False, # Whether access to items inside this shared drive is restricted to its members.
423 &quot;sharingFoldersRequiresOrganizerPermission&quot;: 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.
424 },
425 &quot;themeId&quot;: &quot;A String&quot;, # 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.insert` 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&#x27;t set `colorRgb` or `backgroundImageFile`.
426 },
427 ],
428 &quot;kind&quot;: &quot;drive#driveList&quot;, # This is always `drive#driveList`
429 &quot;nextPageToken&quot;: &quot;A String&quot;, # 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.
430 }</pre>
431 </div>
432
433 <div class="method">
434 <code class="details" id="list_next">list_next()</code>
435 <pre>Retrieves the next page of results.
436
437 Args:
438 previous_request: The request for the previous page. (required)
439 previous_response: The response from the request for the previous page. (required)
440
441 Returns:
442 A request object that you can call &#x27;execute()&#x27; on to request the next
443 page. Returns None if there are no more items in the collection.
444 </pre>
445 </div>
446
447 <div class="method">
448 <code class="details" id="unhide">unhide(driveId, x__xgafv=None)</code>
449 <pre>Restores a shared drive to the default view.
450
451 Args:
452 driveId: string, The ID of the shared drive. (required)
453 x__xgafv: string, V1 error format.
454 Allowed values
455 1 - v1 error format
456 2 - v2 error format
457
458 Returns:
459 An object of the form:
460
461 { # 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.
462 &quot;backgroundImageFile&quot;: { # 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&#x27;t set `themeId`. When specified, all fields of the `backgroundImageFile` must be set.
463 &quot;id&quot;: &quot;A String&quot;, # The ID of an image file in Google Drive to use for the background image.
464 &quot;width&quot;: 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.
465 &quot;xCoordinate&quot;: 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.
466 &quot;yCoordinate&quot;: 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.
467 },
468 &quot;backgroundImageLink&quot;: &quot;A String&quot;, # Output only. A short-lived link to this shared drive&#x27;s background image.
469 &quot;capabilities&quot;: { # Output only. Capabilities the current user has on this shared drive.
470 &quot;canAddChildren&quot;: True or False, # Output only. Whether the current user can add children to folders in this shared drive.
471 &quot;canChangeCopyRequiresWriterPermissionRestriction&quot;: True or False, # Output only. Whether the current user can change the `copyRequiresWriterPermission` restriction of this shared drive.
472 &quot;canChangeDomainUsersOnlyRestriction&quot;: True or False, # Output only. Whether the current user can change the `domainUsersOnly` restriction of this shared drive.
473 &quot;canChangeDriveBackground&quot;: True or False, # Output only. Whether the current user can change the background of this shared drive.
474 &quot;canChangeDriveMembersOnlyRestriction&quot;: True or False, # Output only. Whether the current user can change the `driveMembersOnly` restriction of this shared drive.
475 &quot;canChangeSharingFoldersRequiresOrganizerPermissionRestriction&quot;: True or False, # Output only. Whether the current user can change the `sharingFoldersRequiresOrganizerPermission` restriction of this shared drive.
476 &quot;canComment&quot;: True or False, # Output only. Whether the current user can comment on files in this shared drive.
477 &quot;canCopy&quot;: True or False, # Output only. Whether the current user can copy files in this shared drive.
478 &quot;canDeleteChildren&quot;: True or False, # Output only. Whether the current user can delete children from folders in this shared drive.
479 &quot;canDeleteDrive&quot;: 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.
480 &quot;canDownload&quot;: True or False, # Output only. Whether the current user can download files in this shared drive.
481 &quot;canEdit&quot;: True or False, # Output only. Whether the current user can edit files in this shared drive
482 &quot;canListChildren&quot;: True or False, # Output only. Whether the current user can list the children of folders in this shared drive.
483 &quot;canManageMembers&quot;: True or False, # Output only. Whether the current user can add members to this shared drive or remove them or change their role.
484 &quot;canReadRevisions&quot;: True or False, # Output only. Whether the current user can read the revisions resource of files in this shared drive.
485 &quot;canRename&quot;: True or False, # Output only. Whether the current user can rename files or folders in this shared drive.
486 &quot;canRenameDrive&quot;: True or False, # Output only. Whether the current user can rename this shared drive.
487 &quot;canResetDriveRestrictions&quot;: True or False, # Output only. Whether the current user can reset the shared drive restrictions to defaults.
488 &quot;canShare&quot;: True or False, # Output only. Whether the current user can share files or folders in this shared drive.
489 &quot;canTrashChildren&quot;: True or False, # Output only. Whether the current user can trash children from folders in this shared drive.
490 },
491 &quot;colorRgb&quot;: &quot;A String&quot;, # 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`.
492 &quot;createdDate&quot;: &quot;A String&quot;, # The time at which the shared drive was created (RFC 3339 date-time).
493 &quot;hidden&quot;: True or False, # Whether the shared drive is hidden from default view.
494 &quot;id&quot;: &quot;A String&quot;, # Output only. The ID of this shared drive which is also the ID of the top level folder of this shared drive.
495 &quot;kind&quot;: &quot;drive#drive&quot;, # Output only. This is always `drive#drive`
496 &quot;name&quot;: &quot;A String&quot;, # The name of this shared drive.
497 &quot;orgUnitId&quot;: &quot;A String&quot;, # 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`.
498 &quot;restrictions&quot;: { # A set of restrictions that apply to this shared drive or items inside this shared drive.
499 &quot;adminManagedRestrictions&quot;: True or False, # Whether administrative privileges on this shared drive are required to modify restrictions.
500 &quot;copyRequiresWriterPermission&quot;: 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.
501 &quot;domainUsersOnly&quot;: 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.
502 &quot;driveMembersOnly&quot;: True or False, # Whether access to items inside this shared drive is restricted to its members.
503 &quot;sharingFoldersRequiresOrganizerPermission&quot;: 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.
504 },
505 &quot;themeId&quot;: &quot;A String&quot;, # 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.insert` 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&#x27;t set `colorRgb` or `backgroundImageFile`.
506 }</pre>
507 </div>
508
509 <div class="method">
510 <code class="details" id="update">update(driveId, body=None, useDomainAdminAccess=None, x__xgafv=None)</code>
511 <pre>Updates the metadata for a shared drive.
512
513 Args:
514 driveId: string, The ID of the shared drive. (required)
515 body: object, The request body.
516 The object takes the form of:
517
518 { # 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.
519 &quot;backgroundImageFile&quot;: { # 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&#x27;t set `themeId`. When specified, all fields of the `backgroundImageFile` must be set.
520 &quot;id&quot;: &quot;A String&quot;, # The ID of an image file in Google Drive to use for the background image.
521 &quot;width&quot;: 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.
522 &quot;xCoordinate&quot;: 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.
523 &quot;yCoordinate&quot;: 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.
524 },
525 &quot;backgroundImageLink&quot;: &quot;A String&quot;, # Output only. A short-lived link to this shared drive&#x27;s background image.
526 &quot;capabilities&quot;: { # Output only. Capabilities the current user has on this shared drive.
527 &quot;canAddChildren&quot;: True or False, # Output only. Whether the current user can add children to folders in this shared drive.
528 &quot;canChangeCopyRequiresWriterPermissionRestriction&quot;: True or False, # Output only. Whether the current user can change the `copyRequiresWriterPermission` restriction of this shared drive.
529 &quot;canChangeDomainUsersOnlyRestriction&quot;: True or False, # Output only. Whether the current user can change the `domainUsersOnly` restriction of this shared drive.
530 &quot;canChangeDriveBackground&quot;: True or False, # Output only. Whether the current user can change the background of this shared drive.
531 &quot;canChangeDriveMembersOnlyRestriction&quot;: True or False, # Output only. Whether the current user can change the `driveMembersOnly` restriction of this shared drive.
532 &quot;canChangeSharingFoldersRequiresOrganizerPermissionRestriction&quot;: True or False, # Output only. Whether the current user can change the `sharingFoldersRequiresOrganizerPermission` restriction of this shared drive.
533 &quot;canComment&quot;: True or False, # Output only. Whether the current user can comment on files in this shared drive.
534 &quot;canCopy&quot;: True or False, # Output only. Whether the current user can copy files in this shared drive.
535 &quot;canDeleteChildren&quot;: True or False, # Output only. Whether the current user can delete children from folders in this shared drive.
536 &quot;canDeleteDrive&quot;: 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.
537 &quot;canDownload&quot;: True or False, # Output only. Whether the current user can download files in this shared drive.
538 &quot;canEdit&quot;: True or False, # Output only. Whether the current user can edit files in this shared drive
539 &quot;canListChildren&quot;: True or False, # Output only. Whether the current user can list the children of folders in this shared drive.
540 &quot;canManageMembers&quot;: True or False, # Output only. Whether the current user can add members to this shared drive or remove them or change their role.
541 &quot;canReadRevisions&quot;: True or False, # Output only. Whether the current user can read the revisions resource of files in this shared drive.
542 &quot;canRename&quot;: True or False, # Output only. Whether the current user can rename files or folders in this shared drive.
543 &quot;canRenameDrive&quot;: True or False, # Output only. Whether the current user can rename this shared drive.
544 &quot;canResetDriveRestrictions&quot;: True or False, # Output only. Whether the current user can reset the shared drive restrictions to defaults.
545 &quot;canShare&quot;: True or False, # Output only. Whether the current user can share files or folders in this shared drive.
546 &quot;canTrashChildren&quot;: True or False, # Output only. Whether the current user can trash children from folders in this shared drive.
547 },
548 &quot;colorRgb&quot;: &quot;A String&quot;, # 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`.
549 &quot;createdDate&quot;: &quot;A String&quot;, # The time at which the shared drive was created (RFC 3339 date-time).
550 &quot;hidden&quot;: True or False, # Whether the shared drive is hidden from default view.
551 &quot;id&quot;: &quot;A String&quot;, # Output only. The ID of this shared drive which is also the ID of the top level folder of this shared drive.
552 &quot;kind&quot;: &quot;drive#drive&quot;, # Output only. This is always `drive#drive`
553 &quot;name&quot;: &quot;A String&quot;, # The name of this shared drive.
554 &quot;orgUnitId&quot;: &quot;A String&quot;, # 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`.
555 &quot;restrictions&quot;: { # A set of restrictions that apply to this shared drive or items inside this shared drive.
556 &quot;adminManagedRestrictions&quot;: True or False, # Whether administrative privileges on this shared drive are required to modify restrictions.
557 &quot;copyRequiresWriterPermission&quot;: 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.
558 &quot;domainUsersOnly&quot;: 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.
559 &quot;driveMembersOnly&quot;: True or False, # Whether access to items inside this shared drive is restricted to its members.
560 &quot;sharingFoldersRequiresOrganizerPermission&quot;: 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.
561 },
562 &quot;themeId&quot;: &quot;A String&quot;, # 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.insert` 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&#x27;t set `colorRgb` or `backgroundImageFile`.
563 }
564
565 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.
566 x__xgafv: string, V1 error format.
567 Allowed values
568 1 - v1 error format
569 2 - v2 error format
570
571 Returns:
572 An object of the form:
573
574 { # 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.
575 &quot;backgroundImageFile&quot;: { # 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&#x27;t set `themeId`. When specified, all fields of the `backgroundImageFile` must be set.
576 &quot;id&quot;: &quot;A String&quot;, # The ID of an image file in Google Drive to use for the background image.
577 &quot;width&quot;: 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.
578 &quot;xCoordinate&quot;: 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.
579 &quot;yCoordinate&quot;: 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.
580 },
581 &quot;backgroundImageLink&quot;: &quot;A String&quot;, # Output only. A short-lived link to this shared drive&#x27;s background image.
582 &quot;capabilities&quot;: { # Output only. Capabilities the current user has on this shared drive.
583 &quot;canAddChildren&quot;: True or False, # Output only. Whether the current user can add children to folders in this shared drive.
584 &quot;canChangeCopyRequiresWriterPermissionRestriction&quot;: True or False, # Output only. Whether the current user can change the `copyRequiresWriterPermission` restriction of this shared drive.
585 &quot;canChangeDomainUsersOnlyRestriction&quot;: True or False, # Output only. Whether the current user can change the `domainUsersOnly` restriction of this shared drive.
586 &quot;canChangeDriveBackground&quot;: True or False, # Output only. Whether the current user can change the background of this shared drive.
587 &quot;canChangeDriveMembersOnlyRestriction&quot;: True or False, # Output only. Whether the current user can change the `driveMembersOnly` restriction of this shared drive.
588 &quot;canChangeSharingFoldersRequiresOrganizerPermissionRestriction&quot;: True or False, # Output only. Whether the current user can change the `sharingFoldersRequiresOrganizerPermission` restriction of this shared drive.
589 &quot;canComment&quot;: True or False, # Output only. Whether the current user can comment on files in this shared drive.
590 &quot;canCopy&quot;: True or False, # Output only. Whether the current user can copy files in this shared drive.
591 &quot;canDeleteChildren&quot;: True or False, # Output only. Whether the current user can delete children from folders in this shared drive.
592 &quot;canDeleteDrive&quot;: 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.
593 &quot;canDownload&quot;: True or False, # Output only. Whether the current user can download files in this shared drive.
594 &quot;canEdit&quot;: True or False, # Output only. Whether the current user can edit files in this shared drive
595 &quot;canListChildren&quot;: True or False, # Output only. Whether the current user can list the children of folders in this shared drive.
596 &quot;canManageMembers&quot;: True or False, # Output only. Whether the current user can add members to this shared drive or remove them or change their role.
597 &quot;canReadRevisions&quot;: True or False, # Output only. Whether the current user can read the revisions resource of files in this shared drive.
598 &quot;canRename&quot;: True or False, # Output only. Whether the current user can rename files or folders in this shared drive.
599 &quot;canRenameDrive&quot;: True or False, # Output only. Whether the current user can rename this shared drive.
600 &quot;canResetDriveRestrictions&quot;: True or False, # Output only. Whether the current user can reset the shared drive restrictions to defaults.
601 &quot;canShare&quot;: True or False, # Output only. Whether the current user can share files or folders in this shared drive.
602 &quot;canTrashChildren&quot;: True or False, # Output only. Whether the current user can trash children from folders in this shared drive.
603 },
604 &quot;colorRgb&quot;: &quot;A String&quot;, # 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`.
605 &quot;createdDate&quot;: &quot;A String&quot;, # The time at which the shared drive was created (RFC 3339 date-time).
606 &quot;hidden&quot;: True or False, # Whether the shared drive is hidden from default view.
607 &quot;id&quot;: &quot;A String&quot;, # Output only. The ID of this shared drive which is also the ID of the top level folder of this shared drive.
608 &quot;kind&quot;: &quot;drive#drive&quot;, # Output only. This is always `drive#drive`
609 &quot;name&quot;: &quot;A String&quot;, # The name of this shared drive.
610 &quot;orgUnitId&quot;: &quot;A String&quot;, # 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`.
611 &quot;restrictions&quot;: { # A set of restrictions that apply to this shared drive or items inside this shared drive.
612 &quot;adminManagedRestrictions&quot;: True or False, # Whether administrative privileges on this shared drive are required to modify restrictions.
613 &quot;copyRequiresWriterPermission&quot;: 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.
614 &quot;domainUsersOnly&quot;: 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.
615 &quot;driveMembersOnly&quot;: True or False, # Whether access to items inside this shared drive is restricted to its members.
616 &quot;sharingFoldersRequiresOrganizerPermission&quot;: 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.
617 },
618 &quot;themeId&quot;: &quot;A String&quot;, # 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.insert` 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&#x27;t set `colorRgb` or `backgroundImageFile`.
619 }</pre>
620 </div>
621
622 </body></html>