blob: 366106e12df67f76e00eb3f2354528e727236d9e [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001<html><body>
2<style>
3
4body, 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
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, 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">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="#delete">delete(driveId)</a></code></p>
79<p class="firstline">Permanently deletes a shared drive for which the user is an organizer. The shared drive cannot contain any untrashed items.</p>
80<p class="toc_element">
81 <code><a href="#get">get(driveId, useDomainAdminAccess=None)</a></code></p>
82<p class="firstline">Gets a shared drive's metadata by ID.</p>
83<p class="toc_element">
84 <code><a href="#hide">hide(driveId)</a></code></p>
85<p class="firstline">Hides a shared drive from the default view.</p>
86<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070087 <code><a href="#insert">insert(requestId, body=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070088<p class="firstline">Creates a new shared drive.</p>
89<p class="toc_element">
Bu Sun Kim65020912020-05-20 12:08:20 -070090 <code><a href="#list">list(maxResults=None, pageToken=None, q=None, useDomainAdminAccess=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070091<p class="firstline">Lists the user's shared drives.</p>
92<p class="toc_element">
93 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
94<p class="firstline">Retrieves the next page of results.</p>
95<p class="toc_element">
96 <code><a href="#unhide">unhide(driveId)</a></code></p>
97<p class="firstline">Restores a shared drive to the default view.</p>
98<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070099 <code><a href="#update">update(driveId, body=None, useDomainAdminAccess=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700100<p class="firstline">Updates the metadata for a shared drive.</p>
101<h3>Method Details</h3>
102<div class="method">
103 <code class="details" id="delete">delete(driveId)</code>
104 <pre>Permanently deletes a shared drive for which the user is an organizer. The shared drive cannot contain any untrashed items.
105
106Args:
107 driveId: string, The ID of the shared drive. (required)
108</pre>
109</div>
110
111<div class="method">
112 <code class="details" id="get">get(driveId, useDomainAdminAccess=None)</code>
Bu Sun Kim65020912020-05-20 12:08:20 -0700113 <pre>Gets a shared drive&#x27;s metadata by ID.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700114
115Args:
116 driveId: string, The ID of the shared drive. (required)
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
119Returns:
120 An object of the form:
121
122 { # Representation of a shared drive.
Bu Sun Kim65020912020-05-20 12:08:20 -0700123 &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.
124 &quot;id&quot;: &quot;A String&quot;, # The ID of an image file in Google Drive to use for the background image.
125 &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.
126 &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.
127 &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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700128 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700129 &quot;backgroundImageLink&quot;: &quot;A String&quot;, # A short-lived link to this shared drive&#x27;s background image.
130 &quot;capabilities&quot;: { # Capabilities the current user has on this shared drive.
131 &quot;canAddChildren&quot;: True or False, # Whether the current user can add children to folders in this shared drive.
132 &quot;canChangeCopyRequiresWriterPermissionRestriction&quot;: True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this shared drive.
133 &quot;canChangeDomainUsersOnlyRestriction&quot;: True or False, # Whether the current user can change the domainUsersOnly restriction of this shared drive.
134 &quot;canChangeDriveBackground&quot;: True or False, # Whether the current user can change the background of this shared drive.
135 &quot;canChangeDriveMembersOnlyRestriction&quot;: True or False, # Whether the current user can change the driveMembersOnly restriction of this shared drive.
136 &quot;canComment&quot;: True or False, # Whether the current user can comment on files in this shared drive.
137 &quot;canCopy&quot;: True or False, # Whether the current user can copy files in this shared drive.
138 &quot;canDeleteChildren&quot;: True or False, # Whether the current user can delete children from folders in this shared drive.
139 &quot;canDeleteDrive&quot;: True or False, # 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.
140 &quot;canDownload&quot;: True or False, # Whether the current user can download files in this shared drive.
141 &quot;canEdit&quot;: True or False, # Whether the current user can edit files in this shared drive
142 &quot;canListChildren&quot;: True or False, # Whether the current user can list the children of folders in this shared drive.
143 &quot;canManageMembers&quot;: True or False, # Whether the current user can add members to this shared drive or remove them or change their role.
144 &quot;canReadRevisions&quot;: True or False, # Whether the current user can read the revisions resource of files in this shared drive.
145 &quot;canRename&quot;: True or False, # Whether the current user can rename files or folders in this shared drive.
146 &quot;canRenameDrive&quot;: True or False, # Whether the current user can rename this shared drive.
147 &quot;canShare&quot;: True or False, # Whether the current user can share files or folders in this shared drive.
148 &quot;canTrashChildren&quot;: True or False, # Whether the current user can trash children from folders in this shared drive.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700149 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700150 &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.
151 &quot;createdDate&quot;: &quot;A String&quot;, # The time at which the shared drive was created (RFC 3339 date-time).
152 &quot;hidden&quot;: True or False, # Whether the shared drive is hidden from default view.
153 &quot;id&quot;: &quot;A String&quot;, # The ID of this shared drive which is also the ID of the top level folder of this shared drive.
154 &quot;kind&quot;: &quot;drive#drive&quot;, # This is always drive#drive
155 &quot;name&quot;: &quot;A String&quot;, # The name of this shared drive.
156 &quot;restrictions&quot;: { # A set of restrictions that apply to this shared drive or items inside this shared drive.
157 &quot;adminManagedRestrictions&quot;: True or False, # Whether administrative privileges on this shared drive are required to modify restrictions.
158 &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.
159 &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.
160 &quot;driveMembersOnly&quot;: True or False, # Whether access to items inside this shared drive is restricted to its members.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700161 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700162 &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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700163 }</pre>
164</div>
165
166<div class="method">
167 <code class="details" id="hide">hide(driveId)</code>
168 <pre>Hides a shared drive from the default view.
169
170Args:
171 driveId: string, The ID of the shared drive. (required)
172
173Returns:
174 An object of the form:
175
176 { # Representation of a shared drive.
Bu Sun Kim65020912020-05-20 12:08:20 -0700177 &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.
178 &quot;id&quot;: &quot;A String&quot;, # The ID of an image file in Google Drive to use for the background image.
179 &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.
180 &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.
181 &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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700182 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700183 &quot;backgroundImageLink&quot;: &quot;A String&quot;, # A short-lived link to this shared drive&#x27;s background image.
184 &quot;capabilities&quot;: { # Capabilities the current user has on this shared drive.
185 &quot;canAddChildren&quot;: True or False, # Whether the current user can add children to folders in this shared drive.
186 &quot;canChangeCopyRequiresWriterPermissionRestriction&quot;: True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this shared drive.
187 &quot;canChangeDomainUsersOnlyRestriction&quot;: True or False, # Whether the current user can change the domainUsersOnly restriction of this shared drive.
188 &quot;canChangeDriveBackground&quot;: True or False, # Whether the current user can change the background of this shared drive.
189 &quot;canChangeDriveMembersOnlyRestriction&quot;: True or False, # Whether the current user can change the driveMembersOnly restriction of this shared drive.
190 &quot;canComment&quot;: True or False, # Whether the current user can comment on files in this shared drive.
191 &quot;canCopy&quot;: True or False, # Whether the current user can copy files in this shared drive.
192 &quot;canDeleteChildren&quot;: True or False, # Whether the current user can delete children from folders in this shared drive.
193 &quot;canDeleteDrive&quot;: True or False, # 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.
194 &quot;canDownload&quot;: True or False, # Whether the current user can download files in this shared drive.
195 &quot;canEdit&quot;: True or False, # Whether the current user can edit files in this shared drive
196 &quot;canListChildren&quot;: True or False, # Whether the current user can list the children of folders in this shared drive.
197 &quot;canManageMembers&quot;: True or False, # Whether the current user can add members to this shared drive or remove them or change their role.
198 &quot;canReadRevisions&quot;: True or False, # Whether the current user can read the revisions resource of files in this shared drive.
199 &quot;canRename&quot;: True or False, # Whether the current user can rename files or folders in this shared drive.
200 &quot;canRenameDrive&quot;: True or False, # Whether the current user can rename this shared drive.
201 &quot;canShare&quot;: True or False, # Whether the current user can share files or folders in this shared drive.
202 &quot;canTrashChildren&quot;: True or False, # Whether the current user can trash children from folders in this shared drive.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700203 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700204 &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.
205 &quot;createdDate&quot;: &quot;A String&quot;, # The time at which the shared drive was created (RFC 3339 date-time).
206 &quot;hidden&quot;: True or False, # Whether the shared drive is hidden from default view.
207 &quot;id&quot;: &quot;A String&quot;, # The ID of this shared drive which is also the ID of the top level folder of this shared drive.
208 &quot;kind&quot;: &quot;drive#drive&quot;, # This is always drive#drive
209 &quot;name&quot;: &quot;A String&quot;, # The name of this shared drive.
210 &quot;restrictions&quot;: { # A set of restrictions that apply to this shared drive or items inside this shared drive.
211 &quot;adminManagedRestrictions&quot;: True or False, # Whether administrative privileges on this shared drive are required to modify restrictions.
212 &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.
213 &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.
214 &quot;driveMembersOnly&quot;: True or False, # Whether access to items inside this shared drive is restricted to its members.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700215 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700216 &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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700217 }</pre>
218</div>
219
220<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700221 <code class="details" id="insert">insert(requestId, body=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700222 <pre>Creates a new shared drive.
223
224Args:
Bu Sun Kim65020912020-05-20 12:08:20 -0700225 requestId: string, 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)
Dan O'Mearadd494642020-05-01 07:42:23 -0700226 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700227 The object takes the form of:
228
229{ # Representation of a shared drive.
Bu Sun Kim65020912020-05-20 12:08:20 -0700230 &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.
231 &quot;id&quot;: &quot;A String&quot;, # The ID of an image file in Google Drive to use for the background image.
232 &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.
233 &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.
234 &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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700235 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700236 &quot;backgroundImageLink&quot;: &quot;A String&quot;, # A short-lived link to this shared drive&#x27;s background image.
237 &quot;capabilities&quot;: { # Capabilities the current user has on this shared drive.
238 &quot;canAddChildren&quot;: True or False, # Whether the current user can add children to folders in this shared drive.
239 &quot;canChangeCopyRequiresWriterPermissionRestriction&quot;: True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this shared drive.
240 &quot;canChangeDomainUsersOnlyRestriction&quot;: True or False, # Whether the current user can change the domainUsersOnly restriction of this shared drive.
241 &quot;canChangeDriveBackground&quot;: True or False, # Whether the current user can change the background of this shared drive.
242 &quot;canChangeDriveMembersOnlyRestriction&quot;: True or False, # Whether the current user can change the driveMembersOnly restriction of this shared drive.
243 &quot;canComment&quot;: True or False, # Whether the current user can comment on files in this shared drive.
244 &quot;canCopy&quot;: True or False, # Whether the current user can copy files in this shared drive.
245 &quot;canDeleteChildren&quot;: True or False, # Whether the current user can delete children from folders in this shared drive.
246 &quot;canDeleteDrive&quot;: True or False, # 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.
247 &quot;canDownload&quot;: True or False, # Whether the current user can download files in this shared drive.
248 &quot;canEdit&quot;: True or False, # Whether the current user can edit files in this shared drive
249 &quot;canListChildren&quot;: True or False, # Whether the current user can list the children of folders in this shared drive.
250 &quot;canManageMembers&quot;: True or False, # Whether the current user can add members to this shared drive or remove them or change their role.
251 &quot;canReadRevisions&quot;: True or False, # Whether the current user can read the revisions resource of files in this shared drive.
252 &quot;canRename&quot;: True or False, # Whether the current user can rename files or folders in this shared drive.
253 &quot;canRenameDrive&quot;: True or False, # Whether the current user can rename this shared drive.
254 &quot;canShare&quot;: True or False, # Whether the current user can share files or folders in this shared drive.
255 &quot;canTrashChildren&quot;: True or False, # Whether the current user can trash children from folders in this shared drive.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700256 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700257 &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.
258 &quot;createdDate&quot;: &quot;A String&quot;, # The time at which the shared drive was created (RFC 3339 date-time).
259 &quot;hidden&quot;: True or False, # Whether the shared drive is hidden from default view.
260 &quot;id&quot;: &quot;A String&quot;, # The ID of this shared drive which is also the ID of the top level folder of this shared drive.
261 &quot;kind&quot;: &quot;drive#drive&quot;, # This is always drive#drive
262 &quot;name&quot;: &quot;A String&quot;, # The name of this shared drive.
263 &quot;restrictions&quot;: { # A set of restrictions that apply to this shared drive or items inside this shared drive.
264 &quot;adminManagedRestrictions&quot;: True or False, # Whether administrative privileges on this shared drive are required to modify restrictions.
265 &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.
266 &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.
267 &quot;driveMembersOnly&quot;: True or False, # Whether access to items inside this shared drive is restricted to its members.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700268 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700269 &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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700270}
271
272
273Returns:
274 An object of the form:
275
276 { # Representation of a shared drive.
Bu Sun Kim65020912020-05-20 12:08:20 -0700277 &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.
278 &quot;id&quot;: &quot;A String&quot;, # The ID of an image file in Google Drive to use for the background image.
279 &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.
280 &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.
281 &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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700282 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700283 &quot;backgroundImageLink&quot;: &quot;A String&quot;, # A short-lived link to this shared drive&#x27;s background image.
284 &quot;capabilities&quot;: { # Capabilities the current user has on this shared drive.
285 &quot;canAddChildren&quot;: True or False, # Whether the current user can add children to folders in this shared drive.
286 &quot;canChangeCopyRequiresWriterPermissionRestriction&quot;: True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this shared drive.
287 &quot;canChangeDomainUsersOnlyRestriction&quot;: True or False, # Whether the current user can change the domainUsersOnly restriction of this shared drive.
288 &quot;canChangeDriveBackground&quot;: True or False, # Whether the current user can change the background of this shared drive.
289 &quot;canChangeDriveMembersOnlyRestriction&quot;: True or False, # Whether the current user can change the driveMembersOnly restriction of this shared drive.
290 &quot;canComment&quot;: True or False, # Whether the current user can comment on files in this shared drive.
291 &quot;canCopy&quot;: True or False, # Whether the current user can copy files in this shared drive.
292 &quot;canDeleteChildren&quot;: True or False, # Whether the current user can delete children from folders in this shared drive.
293 &quot;canDeleteDrive&quot;: True or False, # 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.
294 &quot;canDownload&quot;: True or False, # Whether the current user can download files in this shared drive.
295 &quot;canEdit&quot;: True or False, # Whether the current user can edit files in this shared drive
296 &quot;canListChildren&quot;: True or False, # Whether the current user can list the children of folders in this shared drive.
297 &quot;canManageMembers&quot;: True or False, # Whether the current user can add members to this shared drive or remove them or change their role.
298 &quot;canReadRevisions&quot;: True or False, # Whether the current user can read the revisions resource of files in this shared drive.
299 &quot;canRename&quot;: True or False, # Whether the current user can rename files or folders in this shared drive.
300 &quot;canRenameDrive&quot;: True or False, # Whether the current user can rename this shared drive.
301 &quot;canShare&quot;: True or False, # Whether the current user can share files or folders in this shared drive.
302 &quot;canTrashChildren&quot;: True or False, # Whether the current user can trash children from folders in this shared drive.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700303 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700304 &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.
305 &quot;createdDate&quot;: &quot;A String&quot;, # The time at which the shared drive was created (RFC 3339 date-time).
306 &quot;hidden&quot;: True or False, # Whether the shared drive is hidden from default view.
307 &quot;id&quot;: &quot;A String&quot;, # The ID of this shared drive which is also the ID of the top level folder of this shared drive.
308 &quot;kind&quot;: &quot;drive#drive&quot;, # This is always drive#drive
309 &quot;name&quot;: &quot;A String&quot;, # The name of this shared drive.
310 &quot;restrictions&quot;: { # A set of restrictions that apply to this shared drive or items inside this shared drive.
311 &quot;adminManagedRestrictions&quot;: True or False, # Whether administrative privileges on this shared drive are required to modify restrictions.
312 &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.
313 &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.
314 &quot;driveMembersOnly&quot;: True or False, # Whether access to items inside this shared drive is restricted to its members.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700315 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700316 &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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700317 }</pre>
318</div>
319
320<div class="method">
Bu Sun Kim65020912020-05-20 12:08:20 -0700321 <code class="details" id="list">list(maxResults=None, pageToken=None, q=None, useDomainAdminAccess=None)</code>
322 <pre>Lists the user&#x27;s shared drives.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700323
324Args:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700325 maxResults: integer, Maximum number of shared drives to return.
Bu Sun Kim65020912020-05-20 12:08:20 -0700326 pageToken: string, Page token for shared drives.
327 q: string, Query string for searching shared drives.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700328 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.
329
330Returns:
331 An object of the form:
332
333 { # A list of shared drives.
Bu Sun Kim65020912020-05-20 12:08:20 -0700334 &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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700335 { # Representation of a shared drive.
Bu Sun Kim65020912020-05-20 12:08:20 -0700336 &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.
337 &quot;id&quot;: &quot;A String&quot;, # The ID of an image file in Google Drive to use for the background image.
338 &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.
339 &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.
340 &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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700341 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700342 &quot;backgroundImageLink&quot;: &quot;A String&quot;, # A short-lived link to this shared drive&#x27;s background image.
343 &quot;capabilities&quot;: { # Capabilities the current user has on this shared drive.
344 &quot;canAddChildren&quot;: True or False, # Whether the current user can add children to folders in this shared drive.
345 &quot;canChangeCopyRequiresWriterPermissionRestriction&quot;: True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this shared drive.
346 &quot;canChangeDomainUsersOnlyRestriction&quot;: True or False, # Whether the current user can change the domainUsersOnly restriction of this shared drive.
347 &quot;canChangeDriveBackground&quot;: True or False, # Whether the current user can change the background of this shared drive.
348 &quot;canChangeDriveMembersOnlyRestriction&quot;: True or False, # Whether the current user can change the driveMembersOnly restriction of this shared drive.
349 &quot;canComment&quot;: True or False, # Whether the current user can comment on files in this shared drive.
350 &quot;canCopy&quot;: True or False, # Whether the current user can copy files in this shared drive.
351 &quot;canDeleteChildren&quot;: True or False, # Whether the current user can delete children from folders in this shared drive.
352 &quot;canDeleteDrive&quot;: True or False, # 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.
353 &quot;canDownload&quot;: True or False, # Whether the current user can download files in this shared drive.
354 &quot;canEdit&quot;: True or False, # Whether the current user can edit files in this shared drive
355 &quot;canListChildren&quot;: True or False, # Whether the current user can list the children of folders in this shared drive.
356 &quot;canManageMembers&quot;: True or False, # Whether the current user can add members to this shared drive or remove them or change their role.
357 &quot;canReadRevisions&quot;: True or False, # Whether the current user can read the revisions resource of files in this shared drive.
358 &quot;canRename&quot;: True or False, # Whether the current user can rename files or folders in this shared drive.
359 &quot;canRenameDrive&quot;: True or False, # Whether the current user can rename this shared drive.
360 &quot;canShare&quot;: True or False, # Whether the current user can share files or folders in this shared drive.
361 &quot;canTrashChildren&quot;: True or False, # Whether the current user can trash children from folders in this shared drive.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700362 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700363 &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.
364 &quot;createdDate&quot;: &quot;A String&quot;, # The time at which the shared drive was created (RFC 3339 date-time).
365 &quot;hidden&quot;: True or False, # Whether the shared drive is hidden from default view.
366 &quot;id&quot;: &quot;A String&quot;, # The ID of this shared drive which is also the ID of the top level folder of this shared drive.
367 &quot;kind&quot;: &quot;drive#drive&quot;, # This is always drive#drive
368 &quot;name&quot;: &quot;A String&quot;, # The name of this shared drive.
369 &quot;restrictions&quot;: { # A set of restrictions that apply to this shared drive or items inside this shared drive.
370 &quot;adminManagedRestrictions&quot;: True or False, # Whether administrative privileges on this shared drive are required to modify restrictions.
371 &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.
372 &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.
373 &quot;driveMembersOnly&quot;: True or False, # Whether access to items inside this shared drive is restricted to its members.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700374 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700375 &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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700376 },
377 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700378 &quot;kind&quot;: &quot;drive#driveList&quot;, # This is always drive#driveList
379 &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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700380 }</pre>
381</div>
382
383<div class="method">
384 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
385 <pre>Retrieves the next page of results.
386
387Args:
388 previous_request: The request for the previous page. (required)
389 previous_response: The response from the request for the previous page. (required)
390
391Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700392 A request object that you can call &#x27;execute()&#x27; on to request the next
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700393 page. Returns None if there are no more items in the collection.
394 </pre>
395</div>
396
397<div class="method">
398 <code class="details" id="unhide">unhide(driveId)</code>
399 <pre>Restores a shared drive to the default view.
400
401Args:
402 driveId: string, The ID of the shared drive. (required)
403
404Returns:
405 An object of the form:
406
407 { # Representation of a shared drive.
Bu Sun Kim65020912020-05-20 12:08:20 -0700408 &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.
409 &quot;id&quot;: &quot;A String&quot;, # The ID of an image file in Google Drive to use for the background image.
410 &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.
411 &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.
412 &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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700413 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700414 &quot;backgroundImageLink&quot;: &quot;A String&quot;, # A short-lived link to this shared drive&#x27;s background image.
415 &quot;capabilities&quot;: { # Capabilities the current user has on this shared drive.
416 &quot;canAddChildren&quot;: True or False, # Whether the current user can add children to folders in this shared drive.
417 &quot;canChangeCopyRequiresWriterPermissionRestriction&quot;: True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this shared drive.
418 &quot;canChangeDomainUsersOnlyRestriction&quot;: True or False, # Whether the current user can change the domainUsersOnly restriction of this shared drive.
419 &quot;canChangeDriveBackground&quot;: True or False, # Whether the current user can change the background of this shared drive.
420 &quot;canChangeDriveMembersOnlyRestriction&quot;: True or False, # Whether the current user can change the driveMembersOnly restriction of this shared drive.
421 &quot;canComment&quot;: True or False, # Whether the current user can comment on files in this shared drive.
422 &quot;canCopy&quot;: True or False, # Whether the current user can copy files in this shared drive.
423 &quot;canDeleteChildren&quot;: True or False, # Whether the current user can delete children from folders in this shared drive.
424 &quot;canDeleteDrive&quot;: True or False, # 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.
425 &quot;canDownload&quot;: True or False, # Whether the current user can download files in this shared drive.
426 &quot;canEdit&quot;: True or False, # Whether the current user can edit files in this shared drive
427 &quot;canListChildren&quot;: True or False, # Whether the current user can list the children of folders in this shared drive.
428 &quot;canManageMembers&quot;: True or False, # Whether the current user can add members to this shared drive or remove them or change their role.
429 &quot;canReadRevisions&quot;: True or False, # Whether the current user can read the revisions resource of files in this shared drive.
430 &quot;canRename&quot;: True or False, # Whether the current user can rename files or folders in this shared drive.
431 &quot;canRenameDrive&quot;: True or False, # Whether the current user can rename this shared drive.
432 &quot;canShare&quot;: True or False, # Whether the current user can share files or folders in this shared drive.
433 &quot;canTrashChildren&quot;: True or False, # Whether the current user can trash children from folders in this shared drive.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700434 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700435 &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.
436 &quot;createdDate&quot;: &quot;A String&quot;, # The time at which the shared drive was created (RFC 3339 date-time).
437 &quot;hidden&quot;: True or False, # Whether the shared drive is hidden from default view.
438 &quot;id&quot;: &quot;A String&quot;, # The ID of this shared drive which is also the ID of the top level folder of this shared drive.
439 &quot;kind&quot;: &quot;drive#drive&quot;, # This is always drive#drive
440 &quot;name&quot;: &quot;A String&quot;, # The name of this shared drive.
441 &quot;restrictions&quot;: { # A set of restrictions that apply to this shared drive or items inside this shared drive.
442 &quot;adminManagedRestrictions&quot;: True or False, # Whether administrative privileges on this shared drive are required to modify restrictions.
443 &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.
444 &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.
445 &quot;driveMembersOnly&quot;: True or False, # Whether access to items inside this shared drive is restricted to its members.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700446 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700447 &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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700448 }</pre>
449</div>
450
451<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700452 <code class="details" id="update">update(driveId, body=None, useDomainAdminAccess=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700453 <pre>Updates the metadata for a shared drive.
454
455Args:
456 driveId: string, The ID of the shared drive. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700457 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700458 The object takes the form of:
459
460{ # Representation of a shared drive.
Bu Sun Kim65020912020-05-20 12:08:20 -0700461 &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.
462 &quot;id&quot;: &quot;A String&quot;, # The ID of an image file in Google Drive to use for the background image.
463 &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.
464 &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.
465 &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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700466 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700467 &quot;backgroundImageLink&quot;: &quot;A String&quot;, # A short-lived link to this shared drive&#x27;s background image.
468 &quot;capabilities&quot;: { # Capabilities the current user has on this shared drive.
469 &quot;canAddChildren&quot;: True or False, # Whether the current user can add children to folders in this shared drive.
470 &quot;canChangeCopyRequiresWriterPermissionRestriction&quot;: True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this shared drive.
471 &quot;canChangeDomainUsersOnlyRestriction&quot;: True or False, # Whether the current user can change the domainUsersOnly restriction of this shared drive.
472 &quot;canChangeDriveBackground&quot;: True or False, # Whether the current user can change the background of this shared drive.
473 &quot;canChangeDriveMembersOnlyRestriction&quot;: True or False, # Whether the current user can change the driveMembersOnly restriction of this shared drive.
474 &quot;canComment&quot;: True or False, # Whether the current user can comment on files in this shared drive.
475 &quot;canCopy&quot;: True or False, # Whether the current user can copy files in this shared drive.
476 &quot;canDeleteChildren&quot;: True or False, # Whether the current user can delete children from folders in this shared drive.
477 &quot;canDeleteDrive&quot;: True or False, # 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.
478 &quot;canDownload&quot;: True or False, # Whether the current user can download files in this shared drive.
479 &quot;canEdit&quot;: True or False, # Whether the current user can edit files in this shared drive
480 &quot;canListChildren&quot;: True or False, # Whether the current user can list the children of folders in this shared drive.
481 &quot;canManageMembers&quot;: True or False, # Whether the current user can add members to this shared drive or remove them or change their role.
482 &quot;canReadRevisions&quot;: True or False, # Whether the current user can read the revisions resource of files in this shared drive.
483 &quot;canRename&quot;: True or False, # Whether the current user can rename files or folders in this shared drive.
484 &quot;canRenameDrive&quot;: True or False, # Whether the current user can rename this shared drive.
485 &quot;canShare&quot;: True or False, # Whether the current user can share files or folders in this shared drive.
486 &quot;canTrashChildren&quot;: True or False, # Whether the current user can trash children from folders in this shared drive.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700487 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700488 &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.
489 &quot;createdDate&quot;: &quot;A String&quot;, # The time at which the shared drive was created (RFC 3339 date-time).
490 &quot;hidden&quot;: True or False, # Whether the shared drive is hidden from default view.
491 &quot;id&quot;: &quot;A String&quot;, # The ID of this shared drive which is also the ID of the top level folder of this shared drive.
492 &quot;kind&quot;: &quot;drive#drive&quot;, # This is always drive#drive
493 &quot;name&quot;: &quot;A String&quot;, # The name of this shared drive.
494 &quot;restrictions&quot;: { # A set of restrictions that apply to this shared drive or items inside this shared drive.
495 &quot;adminManagedRestrictions&quot;: True or False, # Whether administrative privileges on this shared drive are required to modify restrictions.
496 &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.
497 &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.
498 &quot;driveMembersOnly&quot;: True or False, # Whether access to items inside this shared drive is restricted to its members.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700499 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700500 &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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700501}
502
503 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.
504
505Returns:
506 An object of the form:
507
508 { # Representation of a shared drive.
Bu Sun Kim65020912020-05-20 12:08:20 -0700509 &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.
510 &quot;id&quot;: &quot;A String&quot;, # The ID of an image file in Google Drive to use for the background image.
511 &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.
512 &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.
513 &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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700514 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700515 &quot;backgroundImageLink&quot;: &quot;A String&quot;, # A short-lived link to this shared drive&#x27;s background image.
516 &quot;capabilities&quot;: { # Capabilities the current user has on this shared drive.
517 &quot;canAddChildren&quot;: True or False, # Whether the current user can add children to folders in this shared drive.
518 &quot;canChangeCopyRequiresWriterPermissionRestriction&quot;: True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this shared drive.
519 &quot;canChangeDomainUsersOnlyRestriction&quot;: True or False, # Whether the current user can change the domainUsersOnly restriction of this shared drive.
520 &quot;canChangeDriveBackground&quot;: True or False, # Whether the current user can change the background of this shared drive.
521 &quot;canChangeDriveMembersOnlyRestriction&quot;: True or False, # Whether the current user can change the driveMembersOnly restriction of this shared drive.
522 &quot;canComment&quot;: True or False, # Whether the current user can comment on files in this shared drive.
523 &quot;canCopy&quot;: True or False, # Whether the current user can copy files in this shared drive.
524 &quot;canDeleteChildren&quot;: True or False, # Whether the current user can delete children from folders in this shared drive.
525 &quot;canDeleteDrive&quot;: True or False, # 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.
526 &quot;canDownload&quot;: True or False, # Whether the current user can download files in this shared drive.
527 &quot;canEdit&quot;: True or False, # Whether the current user can edit files in this shared drive
528 &quot;canListChildren&quot;: True or False, # Whether the current user can list the children of folders in this shared drive.
529 &quot;canManageMembers&quot;: True or False, # Whether the current user can add members to this shared drive or remove them or change their role.
530 &quot;canReadRevisions&quot;: True or False, # Whether the current user can read the revisions resource of files in this shared drive.
531 &quot;canRename&quot;: True or False, # Whether the current user can rename files or folders in this shared drive.
532 &quot;canRenameDrive&quot;: True or False, # Whether the current user can rename this shared drive.
533 &quot;canShare&quot;: True or False, # Whether the current user can share files or folders in this shared drive.
534 &quot;canTrashChildren&quot;: True or False, # Whether the current user can trash children from folders in this shared drive.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700535 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700536 &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.
537 &quot;createdDate&quot;: &quot;A String&quot;, # The time at which the shared drive was created (RFC 3339 date-time).
538 &quot;hidden&quot;: True or False, # Whether the shared drive is hidden from default view.
539 &quot;id&quot;: &quot;A String&quot;, # The ID of this shared drive which is also the ID of the top level folder of this shared drive.
540 &quot;kind&quot;: &quot;drive#drive&quot;, # This is always drive#drive
541 &quot;name&quot;: &quot;A String&quot;, # The name of this shared drive.
542 &quot;restrictions&quot;: { # A set of restrictions that apply to this shared drive or items inside this shared drive.
543 &quot;adminManagedRestrictions&quot;: True or False, # Whether administrative privileges on this shared drive are required to modify restrictions.
544 &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.
545 &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.
546 &quot;driveMembersOnly&quot;: True or False, # Whether access to items inside this shared drive is restricted to its members.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700547 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700548 &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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700549 }</pre>
550</div>
551
552</body></html>