Debian Codegraph @

docs/dyn/drive_v2.teamdrives.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.teamdrives.html">teamdrives</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(teamDriveId, x__xgafv=None)</a></code></p>
82 <p class="firstline">Deprecated: Use `drives.delete` instead.</p>
83 <p class="toc_element">
84 <code><a href="#get">get(teamDriveId, useDomainAdminAccess=None, x__xgafv=None)</a></code></p>
85 <p class="firstline">Deprecated: Use `drives.get` instead.</p>
86 <p class="toc_element">
87 <code><a href="#insert">insert(requestId, body=None, x__xgafv=None)</a></code></p>
88 <p class="firstline">Deprecated: Use `drives.insert` instead.</p>
89 <p class="toc_element">
90 <code><a href="#list">list(maxResults=None, pageToken=None, q=None, useDomainAdminAccess=None, x__xgafv=None)</a></code></p>
91 <p class="firstline">Deprecated: Use `drives.list` instead.</p>
92 <p class="toc_element">
93 <code><a href="#list_next">list_next()</a></code></p>
94 <p class="firstline">Retrieves the next page of results.</p>
95 <p class="toc_element">
96 <code><a href="#update">update(teamDriveId, body=None, useDomainAdminAccess=None, x__xgafv=None)</a></code></p>
97 <p class="firstline">Deprecated: Use `drives.update` instead.</p>
98 <h3>Method Details</h3>
99 <div class="method">
100 <code class="details" id="close">close()</code>
101 <pre>Close httplib2 connections.</pre>
102 </div>
103
104 <div class="method">
105 <code class="details" id="delete">delete(teamDriveId, x__xgafv=None)</code>
106 <pre>Deprecated: Use `drives.delete` instead.
107
108 Args:
109 teamDriveId: string, The ID of the Team Drive (required)
110 x__xgafv: string, V1 error format.
111 Allowed values
112 1 - v1 error format
113 2 - v2 error format
114 </pre>
115 </div>
116
117 <div class="method">
118 <code class="details" id="get">get(teamDriveId, useDomainAdminAccess=None, x__xgafv=None)</code>
119 <pre>Deprecated: Use `drives.get` instead.
120
121 Args:
122 teamDriveId: string, The ID of the Team Drive (required)
123 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 Team Drive belongs.
124 x__xgafv: string, V1 error format.
125 Allowed values
126 1 - v1 error format
127 2 - v2 error format
128
129 Returns:
130 An object of the form:
131
132 { # Deprecated: Use the `drive` collection instead.
133 &quot;backgroundImageFile&quot;: { # An image file and cropping parameters from which a background image for this Team Drive is set. This is a write only field; it can only be set on `drive.teamdrives.update` requests that don&#x27;t set `themeId`. When specified, all fields of the `backgroundImageFile` must be set.
134 &quot;id&quot;: &quot;A String&quot;, # The ID of an image file in Drive to use for the background image.
135 &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.
136 &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.
137 &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.
138 },
139 &quot;backgroundImageLink&quot;: &quot;A String&quot;, # A short-lived link to this Team Drive&#x27;s background image.
140 &quot;capabilities&quot;: { # Capabilities the current user has on this Team Drive.
141 &quot;canAddChildren&quot;: True or False, # Whether the current user can add children to folders in this Team Drive.
142 &quot;canChangeCopyRequiresWriterPermissionRestriction&quot;: True or False, # Whether the current user can change the `copyRequiresWriterPermission` restriction of this Team Drive.
143 &quot;canChangeDomainUsersOnlyRestriction&quot;: True or False, # Whether the current user can change the `domainUsersOnly` restriction of this Team Drive.
144 &quot;canChangeSharingFoldersRequiresOrganizerPermissionRestriction&quot;: True or False, # Whether the current user can change the `sharingFoldersRequiresOrganizerPermission` restriction of this Team Drive.
145 &quot;canChangeTeamDriveBackground&quot;: True or False, # Whether the current user can change the background of this Team Drive.
146 &quot;canChangeTeamMembersOnlyRestriction&quot;: True or False, # Whether the current user can change the `teamMembersOnly` restriction of this Team Drive.
147 &quot;canComment&quot;: True or False, # Whether the current user can comment on files in this Team Drive.
148 &quot;canCopy&quot;: True or False, # Whether the current user can copy files in this Team Drive.
149 &quot;canDeleteChildren&quot;: True or False, # Whether the current user can delete children from folders in this Team Drive.
150 &quot;canDeleteTeamDrive&quot;: True or False, # Whether the current user can delete this Team Drive. Attempting to delete the Team Drive may still fail if there are untrashed items inside the Team Drive.
151 &quot;canDownload&quot;: True or False, # Whether the current user can download files in this Team Drive.
152 &quot;canEdit&quot;: True or False, # Whether the current user can edit files in this Team Drive
153 &quot;canListChildren&quot;: True or False, # Whether the current user can list the children of folders in this Team Drive.
154 &quot;canManageMembers&quot;: True or False, # Whether the current user can add members to this Team Drive or remove them or change their role.
155 &quot;canReadRevisions&quot;: True or False, # Whether the current user can read the revisions resource of files in this Team Drive.
156 &quot;canRemoveChildren&quot;: True or False, # Deprecated: Use `canDeleteChildren` or `canTrashChildren` instead.
157 &quot;canRename&quot;: True or False, # Whether the current user can rename files or folders in this Team Drive.
158 &quot;canRenameTeamDrive&quot;: True or False, # Whether the current user can rename this Team Drive.
159 &quot;canResetTeamDriveRestrictions&quot;: True or False, # Whether the current user can reset the Team Drive restrictions to defaults.
160 &quot;canShare&quot;: True or False, # Whether the current user can share files or folders in this Team Drive.
161 &quot;canTrashChildren&quot;: True or False, # Whether the current user can trash children from folders in this Team Drive.
162 },
163 &quot;colorRgb&quot;: &quot;A String&quot;, # The color of this Team Drive as an RGB hex string. It can only be set on a `drive.teamdrives.update` request that does not set `themeId`.
164 &quot;createdDate&quot;: &quot;A String&quot;, # The time at which the Team Drive was created (RFC 3339 date-time).
165 &quot;id&quot;: &quot;A String&quot;, # The ID of this Team Drive which is also the ID of the top level folder of this Team Drive.
166 &quot;kind&quot;: &quot;drive#teamDrive&quot;, # This is always `drive#teamDrive`
167 &quot;name&quot;: &quot;A String&quot;, # The name of this Team Drive.
168 &quot;orgUnitId&quot;: &quot;A String&quot;, # The organizational unit of this shared drive. This field is only populated on `drives.list` responses when the `useDomainAdminAccess` parameter is set to `true`.
169 &quot;restrictions&quot;: { # A set of restrictions that apply to this Team Drive or items inside this Team Drive.
170 &quot;adminManagedRestrictions&quot;: True or False, # Whether administrative privileges on this Team Drive are required to modify restrictions.
171 &quot;copyRequiresWriterPermission&quot;: True or False, # Whether the options to copy, print, or download files inside this Team 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 Team Drive.
172 &quot;domainUsersOnly&quot;: True or False, # Whether access to this Team Drive and items inside this Team Drive is restricted to users of the domain to which this Team Drive belongs. This restriction may be overridden by other sharing policies controlled outside of this Team Drive.
173 &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.
174 &quot;teamMembersOnly&quot;: True or False, # Whether access to items inside this Team Drive is restricted to members of this Team Drive.
175 },
176 &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 `teamDriveThemes` can be retrieved from a `drive.about.get` response. When not specified on a `drive.teamdrives.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`.
177 }</pre>
178 </div>
179
180 <div class="method">
181 <code class="details" id="insert">insert(requestId, body=None, x__xgafv=None)</code>
182 <pre>Deprecated: Use `drives.insert` instead.
183
184 Args:
185 requestId: string, Required. An ID, such as a random UUID, which uniquely identifies this user&#x27;s request for idempotent creation of a Team Drive. A repeated request by the same user and with the same request ID will avoid creating duplicates by attempting to create the same Team Drive. If the Team Drive already exists a 409 error will be returned. (required)
186 body: object, The request body.
187 The object takes the form of:
188
189 { # Deprecated: Use the `drive` collection instead.
190 &quot;backgroundImageFile&quot;: { # An image file and cropping parameters from which a background image for this Team Drive is set. This is a write only field; it can only be set on `drive.teamdrives.update` requests that don&#x27;t set `themeId`. When specified, all fields of the `backgroundImageFile` must be set.
191 &quot;id&quot;: &quot;A String&quot;, # The ID of an image file in Drive to use for the background image.
192 &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.
193 &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.
194 &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.
195 },
196 &quot;backgroundImageLink&quot;: &quot;A String&quot;, # A short-lived link to this Team Drive&#x27;s background image.
197 &quot;capabilities&quot;: { # Capabilities the current user has on this Team Drive.
198 &quot;canAddChildren&quot;: True or False, # Whether the current user can add children to folders in this Team Drive.
199 &quot;canChangeCopyRequiresWriterPermissionRestriction&quot;: True or False, # Whether the current user can change the `copyRequiresWriterPermission` restriction of this Team Drive.
200 &quot;canChangeDomainUsersOnlyRestriction&quot;: True or False, # Whether the current user can change the `domainUsersOnly` restriction of this Team Drive.
201 &quot;canChangeSharingFoldersRequiresOrganizerPermissionRestriction&quot;: True or False, # Whether the current user can change the `sharingFoldersRequiresOrganizerPermission` restriction of this Team Drive.
202 &quot;canChangeTeamDriveBackground&quot;: True or False, # Whether the current user can change the background of this Team Drive.
203 &quot;canChangeTeamMembersOnlyRestriction&quot;: True or False, # Whether the current user can change the `teamMembersOnly` restriction of this Team Drive.
204 &quot;canComment&quot;: True or False, # Whether the current user can comment on files in this Team Drive.
205 &quot;canCopy&quot;: True or False, # Whether the current user can copy files in this Team Drive.
206 &quot;canDeleteChildren&quot;: True or False, # Whether the current user can delete children from folders in this Team Drive.
207 &quot;canDeleteTeamDrive&quot;: True or False, # Whether the current user can delete this Team Drive. Attempting to delete the Team Drive may still fail if there are untrashed items inside the Team Drive.
208 &quot;canDownload&quot;: True or False, # Whether the current user can download files in this Team Drive.
209 &quot;canEdit&quot;: True or False, # Whether the current user can edit files in this Team Drive
210 &quot;canListChildren&quot;: True or False, # Whether the current user can list the children of folders in this Team Drive.
211 &quot;canManageMembers&quot;: True or False, # Whether the current user can add members to this Team Drive or remove them or change their role.
212 &quot;canReadRevisions&quot;: True or False, # Whether the current user can read the revisions resource of files in this Team Drive.
213 &quot;canRemoveChildren&quot;: True or False, # Deprecated: Use `canDeleteChildren` or `canTrashChildren` instead.
214 &quot;canRename&quot;: True or False, # Whether the current user can rename files or folders in this Team Drive.
215 &quot;canRenameTeamDrive&quot;: True or False, # Whether the current user can rename this Team Drive.
216 &quot;canResetTeamDriveRestrictions&quot;: True or False, # Whether the current user can reset the Team Drive restrictions to defaults.
217 &quot;canShare&quot;: True or False, # Whether the current user can share files or folders in this Team Drive.
218 &quot;canTrashChildren&quot;: True or False, # Whether the current user can trash children from folders in this Team Drive.
219 },
220 &quot;colorRgb&quot;: &quot;A String&quot;, # The color of this Team Drive as an RGB hex string. It can only be set on a `drive.teamdrives.update` request that does not set `themeId`.
221 &quot;createdDate&quot;: &quot;A String&quot;, # The time at which the Team Drive was created (RFC 3339 date-time).
222 &quot;id&quot;: &quot;A String&quot;, # The ID of this Team Drive which is also the ID of the top level folder of this Team Drive.
223 &quot;kind&quot;: &quot;drive#teamDrive&quot;, # This is always `drive#teamDrive`
224 &quot;name&quot;: &quot;A String&quot;, # The name of this Team Drive.
225 &quot;orgUnitId&quot;: &quot;A String&quot;, # The organizational unit of this shared drive. This field is only populated on `drives.list` responses when the `useDomainAdminAccess` parameter is set to `true`.
226 &quot;restrictions&quot;: { # A set of restrictions that apply to this Team Drive or items inside this Team Drive.
227 &quot;adminManagedRestrictions&quot;: True or False, # Whether administrative privileges on this Team Drive are required to modify restrictions.
228 &quot;copyRequiresWriterPermission&quot;: True or False, # Whether the options to copy, print, or download files inside this Team 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 Team Drive.
229 &quot;domainUsersOnly&quot;: True or False, # Whether access to this Team Drive and items inside this Team Drive is restricted to users of the domain to which this Team Drive belongs. This restriction may be overridden by other sharing policies controlled outside of this Team Drive.
230 &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.
231 &quot;teamMembersOnly&quot;: True or False, # Whether access to items inside this Team Drive is restricted to members of this Team Drive.
232 },
233 &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 `teamDriveThemes` can be retrieved from a `drive.about.get` response. When not specified on a `drive.teamdrives.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`.
234 }
235
236 x__xgafv: string, V1 error format.
237 Allowed values
238 1 - v1 error format
239 2 - v2 error format
240
241 Returns:
242 An object of the form:
243
244 { # Deprecated: Use the `drive` collection instead.
245 &quot;backgroundImageFile&quot;: { # An image file and cropping parameters from which a background image for this Team Drive is set. This is a write only field; it can only be set on `drive.teamdrives.update` requests that don&#x27;t set `themeId`. When specified, all fields of the `backgroundImageFile` must be set.
246 &quot;id&quot;: &quot;A String&quot;, # The ID of an image file in Drive to use for the background image.
247 &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.
248 &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.
249 &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.
250 },
251 &quot;backgroundImageLink&quot;: &quot;A String&quot;, # A short-lived link to this Team Drive&#x27;s background image.
252 &quot;capabilities&quot;: { # Capabilities the current user has on this Team Drive.
253 &quot;canAddChildren&quot;: True or False, # Whether the current user can add children to folders in this Team Drive.
254 &quot;canChangeCopyRequiresWriterPermissionRestriction&quot;: True or False, # Whether the current user can change the `copyRequiresWriterPermission` restriction of this Team Drive.
255 &quot;canChangeDomainUsersOnlyRestriction&quot;: True or False, # Whether the current user can change the `domainUsersOnly` restriction of this Team Drive.
256 &quot;canChangeSharingFoldersRequiresOrganizerPermissionRestriction&quot;: True or False, # Whether the current user can change the `sharingFoldersRequiresOrganizerPermission` restriction of this Team Drive.
257 &quot;canChangeTeamDriveBackground&quot;: True or False, # Whether the current user can change the background of this Team Drive.
258 &quot;canChangeTeamMembersOnlyRestriction&quot;: True or False, # Whether the current user can change the `teamMembersOnly` restriction of this Team Drive.
259 &quot;canComment&quot;: True or False, # Whether the current user can comment on files in this Team Drive.
260 &quot;canCopy&quot;: True or False, # Whether the current user can copy files in this Team Drive.
261 &quot;canDeleteChildren&quot;: True or False, # Whether the current user can delete children from folders in this Team Drive.
262 &quot;canDeleteTeamDrive&quot;: True or False, # Whether the current user can delete this Team Drive. Attempting to delete the Team Drive may still fail if there are untrashed items inside the Team Drive.
263 &quot;canDownload&quot;: True or False, # Whether the current user can download files in this Team Drive.
264 &quot;canEdit&quot;: True or False, # Whether the current user can edit files in this Team Drive
265 &quot;canListChildren&quot;: True or False, # Whether the current user can list the children of folders in this Team Drive.
266 &quot;canManageMembers&quot;: True or False, # Whether the current user can add members to this Team Drive or remove them or change their role.
267 &quot;canReadRevisions&quot;: True or False, # Whether the current user can read the revisions resource of files in this Team Drive.
268 &quot;canRemoveChildren&quot;: True or False, # Deprecated: Use `canDeleteChildren` or `canTrashChildren` instead.
269 &quot;canRename&quot;: True or False, # Whether the current user can rename files or folders in this Team Drive.
270 &quot;canRenameTeamDrive&quot;: True or False, # Whether the current user can rename this Team Drive.
271 &quot;canResetTeamDriveRestrictions&quot;: True or False, # Whether the current user can reset the Team Drive restrictions to defaults.
272 &quot;canShare&quot;: True or False, # Whether the current user can share files or folders in this Team Drive.
273 &quot;canTrashChildren&quot;: True or False, # Whether the current user can trash children from folders in this Team Drive.
274 },
275 &quot;colorRgb&quot;: &quot;A String&quot;, # The color of this Team Drive as an RGB hex string. It can only be set on a `drive.teamdrives.update` request that does not set `themeId`.
276 &quot;createdDate&quot;: &quot;A String&quot;, # The time at which the Team Drive was created (RFC 3339 date-time).
277 &quot;id&quot;: &quot;A String&quot;, # The ID of this Team Drive which is also the ID of the top level folder of this Team Drive.
278 &quot;kind&quot;: &quot;drive#teamDrive&quot;, # This is always `drive#teamDrive`
279 &quot;name&quot;: &quot;A String&quot;, # The name of this Team Drive.
280 &quot;orgUnitId&quot;: &quot;A String&quot;, # The organizational unit of this shared drive. This field is only populated on `drives.list` responses when the `useDomainAdminAccess` parameter is set to `true`.
281 &quot;restrictions&quot;: { # A set of restrictions that apply to this Team Drive or items inside this Team Drive.
282 &quot;adminManagedRestrictions&quot;: True or False, # Whether administrative privileges on this Team Drive are required to modify restrictions.
283 &quot;copyRequiresWriterPermission&quot;: True or False, # Whether the options to copy, print, or download files inside this Team 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 Team Drive.
284 &quot;domainUsersOnly&quot;: True or False, # Whether access to this Team Drive and items inside this Team Drive is restricted to users of the domain to which this Team Drive belongs. This restriction may be overridden by other sharing policies controlled outside of this Team Drive.
285 &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.
286 &quot;teamMembersOnly&quot;: True or False, # Whether access to items inside this Team Drive is restricted to members of this Team Drive.
287 },
288 &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 `teamDriveThemes` can be retrieved from a `drive.about.get` response. When not specified on a `drive.teamdrives.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`.
289 }</pre>
290 </div>
291
292 <div class="method">
293 <code class="details" id="list">list(maxResults=None, pageToken=None, q=None, useDomainAdminAccess=None, x__xgafv=None)</code>
294 <pre>Deprecated: Use `drives.list` instead.
295
296 Args:
297 maxResults: integer, Maximum number of Team Drives to return.
298 pageToken: string, Page token for Team Drives.
299 q: string, Query string for searching Team Drives.
300 useDomainAdminAccess: boolean, Issue the request as a domain administrator; if set to true, then all Team Drives of the domain in which the requester is an administrator are returned.
301 x__xgafv: string, V1 error format.
302 Allowed values
303 1 - v1 error format
304 2 - v2 error format
305
306 Returns:
307 An object of the form:
308
309 { # A list of Team Drives.
310 &quot;items&quot;: [ # The list of Team Drives.
311 { # Deprecated: Use the `drive` collection instead.
312 &quot;backgroundImageFile&quot;: { # An image file and cropping parameters from which a background image for this Team Drive is set. This is a write only field; it can only be set on `drive.teamdrives.update` requests that don&#x27;t set `themeId`. When specified, all fields of the `backgroundImageFile` must be set.
313 &quot;id&quot;: &quot;A String&quot;, # The ID of an image file in Drive to use for the background image.
314 &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.
315 &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.
316 &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.
317 },
318 &quot;backgroundImageLink&quot;: &quot;A String&quot;, # A short-lived link to this Team Drive&#x27;s background image.
319 &quot;capabilities&quot;: { # Capabilities the current user has on this Team Drive.
320 &quot;canAddChildren&quot;: True or False, # Whether the current user can add children to folders in this Team Drive.
321 &quot;canChangeCopyRequiresWriterPermissionRestriction&quot;: True or False, # Whether the current user can change the `copyRequiresWriterPermission` restriction of this Team Drive.
322 &quot;canChangeDomainUsersOnlyRestriction&quot;: True or False, # Whether the current user can change the `domainUsersOnly` restriction of this Team Drive.
323 &quot;canChangeSharingFoldersRequiresOrganizerPermissionRestriction&quot;: True or False, # Whether the current user can change the `sharingFoldersRequiresOrganizerPermission` restriction of this Team Drive.
324 &quot;canChangeTeamDriveBackground&quot;: True or False, # Whether the current user can change the background of this Team Drive.
325 &quot;canChangeTeamMembersOnlyRestriction&quot;: True or False, # Whether the current user can change the `teamMembersOnly` restriction of this Team Drive.
326 &quot;canComment&quot;: True or False, # Whether the current user can comment on files in this Team Drive.
327 &quot;canCopy&quot;: True or False, # Whether the current user can copy files in this Team Drive.
328 &quot;canDeleteChildren&quot;: True or False, # Whether the current user can delete children from folders in this Team Drive.
329 &quot;canDeleteTeamDrive&quot;: True or False, # Whether the current user can delete this Team Drive. Attempting to delete the Team Drive may still fail if there are untrashed items inside the Team Drive.
330 &quot;canDownload&quot;: True or False, # Whether the current user can download files in this Team Drive.
331 &quot;canEdit&quot;: True or False, # Whether the current user can edit files in this Team Drive
332 &quot;canListChildren&quot;: True or False, # Whether the current user can list the children of folders in this Team Drive.
333 &quot;canManageMembers&quot;: True or False, # Whether the current user can add members to this Team Drive or remove them or change their role.
334 &quot;canReadRevisions&quot;: True or False, # Whether the current user can read the revisions resource of files in this Team Drive.
335 &quot;canRemoveChildren&quot;: True or False, # Deprecated: Use `canDeleteChildren` or `canTrashChildren` instead.
336 &quot;canRename&quot;: True or False, # Whether the current user can rename files or folders in this Team Drive.
337 &quot;canRenameTeamDrive&quot;: True or False, # Whether the current user can rename this Team Drive.
338 &quot;canResetTeamDriveRestrictions&quot;: True or False, # Whether the current user can reset the Team Drive restrictions to defaults.
339 &quot;canShare&quot;: True or False, # Whether the current user can share files or folders in this Team Drive.
340 &quot;canTrashChildren&quot;: True or False, # Whether the current user can trash children from folders in this Team Drive.
341 },
342 &quot;colorRgb&quot;: &quot;A String&quot;, # The color of this Team Drive as an RGB hex string. It can only be set on a `drive.teamdrives.update` request that does not set `themeId`.
343 &quot;createdDate&quot;: &quot;A String&quot;, # The time at which the Team Drive was created (RFC 3339 date-time).
344 &quot;id&quot;: &quot;A String&quot;, # The ID of this Team Drive which is also the ID of the top level folder of this Team Drive.
345 &quot;kind&quot;: &quot;drive#teamDrive&quot;, # This is always `drive#teamDrive`
346 &quot;name&quot;: &quot;A String&quot;, # The name of this Team Drive.
347 &quot;orgUnitId&quot;: &quot;A String&quot;, # The organizational unit of this shared drive. This field is only populated on `drives.list` responses when the `useDomainAdminAccess` parameter is set to `true`.
348 &quot;restrictions&quot;: { # A set of restrictions that apply to this Team Drive or items inside this Team Drive.
349 &quot;adminManagedRestrictions&quot;: True or False, # Whether administrative privileges on this Team Drive are required to modify restrictions.
350 &quot;copyRequiresWriterPermission&quot;: True or False, # Whether the options to copy, print, or download files inside this Team 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 Team Drive.
351 &quot;domainUsersOnly&quot;: True or False, # Whether access to this Team Drive and items inside this Team Drive is restricted to users of the domain to which this Team Drive belongs. This restriction may be overridden by other sharing policies controlled outside of this Team Drive.
352 &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.
353 &quot;teamMembersOnly&quot;: True or False, # Whether access to items inside this Team Drive is restricted to members of this Team Drive.
354 },
355 &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 `teamDriveThemes` can be retrieved from a `drive.about.get` response. When not specified on a `drive.teamdrives.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`.
356 },
357 ],
358 &quot;kind&quot;: &quot;drive#teamDriveList&quot;, # This is always `drive#teamDriveList`
359 &quot;nextPageToken&quot;: &quot;A String&quot;, # The page token for the next page of Team Drives.
360 }</pre>
361 </div>
362
363 <div class="method">
364 <code class="details" id="list_next">list_next()</code>
365 <pre>Retrieves the next page of results.
366
367 Args:
368 previous_request: The request for the previous page. (required)
369 previous_response: The response from the request for the previous page. (required)
370
371 Returns:
372 A request object that you can call &#x27;execute()&#x27; on to request the next
373 page. Returns None if there are no more items in the collection.
374 </pre>
375 </div>
376
377 <div class="method">
378 <code class="details" id="update">update(teamDriveId, body=None, useDomainAdminAccess=None, x__xgafv=None)</code>
379 <pre>Deprecated: Use `drives.update` instead.
380
381 Args:
382 teamDriveId: string, The ID of the Team Drive (required)
383 body: object, The request body.
384 The object takes the form of:
385
386 { # Deprecated: Use the `drive` collection instead.
387 &quot;backgroundImageFile&quot;: { # An image file and cropping parameters from which a background image for this Team Drive is set. This is a write only field; it can only be set on `drive.teamdrives.update` requests that don&#x27;t set `themeId`. When specified, all fields of the `backgroundImageFile` must be set.
388 &quot;id&quot;: &quot;A String&quot;, # The ID of an image file in Drive to use for the background image.
389 &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.
390 &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.
391 &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.
392 },
393 &quot;backgroundImageLink&quot;: &quot;A String&quot;, # A short-lived link to this Team Drive&#x27;s background image.
394 &quot;capabilities&quot;: { # Capabilities the current user has on this Team Drive.
395 &quot;canAddChildren&quot;: True or False, # Whether the current user can add children to folders in this Team Drive.
396 &quot;canChangeCopyRequiresWriterPermissionRestriction&quot;: True or False, # Whether the current user can change the `copyRequiresWriterPermission` restriction of this Team Drive.
397 &quot;canChangeDomainUsersOnlyRestriction&quot;: True or False, # Whether the current user can change the `domainUsersOnly` restriction of this Team Drive.
398 &quot;canChangeSharingFoldersRequiresOrganizerPermissionRestriction&quot;: True or False, # Whether the current user can change the `sharingFoldersRequiresOrganizerPermission` restriction of this Team Drive.
399 &quot;canChangeTeamDriveBackground&quot;: True or False, # Whether the current user can change the background of this Team Drive.
400 &quot;canChangeTeamMembersOnlyRestriction&quot;: True or False, # Whether the current user can change the `teamMembersOnly` restriction of this Team Drive.
401 &quot;canComment&quot;: True or False, # Whether the current user can comment on files in this Team Drive.
402 &quot;canCopy&quot;: True or False, # Whether the current user can copy files in this Team Drive.
403 &quot;canDeleteChildren&quot;: True or False, # Whether the current user can delete children from folders in this Team Drive.
404 &quot;canDeleteTeamDrive&quot;: True or False, # Whether the current user can delete this Team Drive. Attempting to delete the Team Drive may still fail if there are untrashed items inside the Team Drive.
405 &quot;canDownload&quot;: True or False, # Whether the current user can download files in this Team Drive.
406 &quot;canEdit&quot;: True or False, # Whether the current user can edit files in this Team Drive
407 &quot;canListChildren&quot;: True or False, # Whether the current user can list the children of folders in this Team Drive.
408 &quot;canManageMembers&quot;: True or False, # Whether the current user can add members to this Team Drive or remove them or change their role.
409 &quot;canReadRevisions&quot;: True or False, # Whether the current user can read the revisions resource of files in this Team Drive.
410 &quot;canRemoveChildren&quot;: True or False, # Deprecated: Use `canDeleteChildren` or `canTrashChildren` instead.
411 &quot;canRename&quot;: True or False, # Whether the current user can rename files or folders in this Team Drive.
412 &quot;canRenameTeamDrive&quot;: True or False, # Whether the current user can rename this Team Drive.
413 &quot;canResetTeamDriveRestrictions&quot;: True or False, # Whether the current user can reset the Team Drive restrictions to defaults.
414 &quot;canShare&quot;: True or False, # Whether the current user can share files or folders in this Team Drive.
415 &quot;canTrashChildren&quot;: True or False, # Whether the current user can trash children from folders in this Team Drive.
416 },
417 &quot;colorRgb&quot;: &quot;A String&quot;, # The color of this Team Drive as an RGB hex string. It can only be set on a `drive.teamdrives.update` request that does not set `themeId`.
418 &quot;createdDate&quot;: &quot;A String&quot;, # The time at which the Team Drive was created (RFC 3339 date-time).
419 &quot;id&quot;: &quot;A String&quot;, # The ID of this Team Drive which is also the ID of the top level folder of this Team Drive.
420 &quot;kind&quot;: &quot;drive#teamDrive&quot;, # This is always `drive#teamDrive`
421 &quot;name&quot;: &quot;A String&quot;, # The name of this Team Drive.
422 &quot;orgUnitId&quot;: &quot;A String&quot;, # The organizational unit of this shared drive. This field is only populated on `drives.list` responses when the `useDomainAdminAccess` parameter is set to `true`.
423 &quot;restrictions&quot;: { # A set of restrictions that apply to this Team Drive or items inside this Team Drive.
424 &quot;adminManagedRestrictions&quot;: True or False, # Whether administrative privileges on this Team Drive are required to modify restrictions.
425 &quot;copyRequiresWriterPermission&quot;: True or False, # Whether the options to copy, print, or download files inside this Team 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 Team Drive.
426 &quot;domainUsersOnly&quot;: True or False, # Whether access to this Team Drive and items inside this Team Drive is restricted to users of the domain to which this Team Drive belongs. This restriction may be overridden by other sharing policies controlled outside of this Team Drive.
427 &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.
428 &quot;teamMembersOnly&quot;: True or False, # Whether access to items inside this Team Drive is restricted to members of this Team Drive.
429 },
430 &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 `teamDriveThemes` can be retrieved from a `drive.about.get` response. When not specified on a `drive.teamdrives.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`.
431 }
432
433 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 Team Drive belongs.
434 x__xgafv: string, V1 error format.
435 Allowed values
436 1 - v1 error format
437 2 - v2 error format
438
439 Returns:
440 An object of the form:
441
442 { # Deprecated: Use the `drive` collection instead.
443 &quot;backgroundImageFile&quot;: { # An image file and cropping parameters from which a background image for this Team Drive is set. This is a write only field; it can only be set on `drive.teamdrives.update` requests that don&#x27;t set `themeId`. When specified, all fields of the `backgroundImageFile` must be set.
444 &quot;id&quot;: &quot;A String&quot;, # The ID of an image file in Drive to use for the background image.
445 &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.
446 &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.
447 &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.
448 },
449 &quot;backgroundImageLink&quot;: &quot;A String&quot;, # A short-lived link to this Team Drive&#x27;s background image.
450 &quot;capabilities&quot;: { # Capabilities the current user has on this Team Drive.
451 &quot;canAddChildren&quot;: True or False, # Whether the current user can add children to folders in this Team Drive.
452 &quot;canChangeCopyRequiresWriterPermissionRestriction&quot;: True or False, # Whether the current user can change the `copyRequiresWriterPermission` restriction of this Team Drive.
453 &quot;canChangeDomainUsersOnlyRestriction&quot;: True or False, # Whether the current user can change the `domainUsersOnly` restriction of this Team Drive.
454 &quot;canChangeSharingFoldersRequiresOrganizerPermissionRestriction&quot;: True or False, # Whether the current user can change the `sharingFoldersRequiresOrganizerPermission` restriction of this Team Drive.
455 &quot;canChangeTeamDriveBackground&quot;: True or False, # Whether the current user can change the background of this Team Drive.
456 &quot;canChangeTeamMembersOnlyRestriction&quot;: True or False, # Whether the current user can change the `teamMembersOnly` restriction of this Team Drive.
457 &quot;canComment&quot;: True or False, # Whether the current user can comment on files in this Team Drive.
458 &quot;canCopy&quot;: True or False, # Whether the current user can copy files in this Team Drive.
459 &quot;canDeleteChildren&quot;: True or False, # Whether the current user can delete children from folders in this Team Drive.
460 &quot;canDeleteTeamDrive&quot;: True or False, # Whether the current user can delete this Team Drive. Attempting to delete the Team Drive may still fail if there are untrashed items inside the Team Drive.
461 &quot;canDownload&quot;: True or False, # Whether the current user can download files in this Team Drive.
462 &quot;canEdit&quot;: True or False, # Whether the current user can edit files in this Team Drive
463 &quot;canListChildren&quot;: True or False, # Whether the current user can list the children of folders in this Team Drive.
464 &quot;canManageMembers&quot;: True or False, # Whether the current user can add members to this Team Drive or remove them or change their role.
465 &quot;canReadRevisions&quot;: True or False, # Whether the current user can read the revisions resource of files in this Team Drive.
466 &quot;canRemoveChildren&quot;: True or False, # Deprecated: Use `canDeleteChildren` or `canTrashChildren` instead.
467 &quot;canRename&quot;: True or False, # Whether the current user can rename files or folders in this Team Drive.
468 &quot;canRenameTeamDrive&quot;: True or False, # Whether the current user can rename this Team Drive.
469 &quot;canResetTeamDriveRestrictions&quot;: True or False, # Whether the current user can reset the Team Drive restrictions to defaults.
470 &quot;canShare&quot;: True or False, # Whether the current user can share files or folders in this Team Drive.
471 &quot;canTrashChildren&quot;: True or False, # Whether the current user can trash children from folders in this Team Drive.
472 },
473 &quot;colorRgb&quot;: &quot;A String&quot;, # The color of this Team Drive as an RGB hex string. It can only be set on a `drive.teamdrives.update` request that does not set `themeId`.
474 &quot;createdDate&quot;: &quot;A String&quot;, # The time at which the Team Drive was created (RFC 3339 date-time).
475 &quot;id&quot;: &quot;A String&quot;, # The ID of this Team Drive which is also the ID of the top level folder of this Team Drive.
476 &quot;kind&quot;: &quot;drive#teamDrive&quot;, # This is always `drive#teamDrive`
477 &quot;name&quot;: &quot;A String&quot;, # The name of this Team Drive.
478 &quot;orgUnitId&quot;: &quot;A String&quot;, # The organizational unit of this shared drive. This field is only populated on `drives.list` responses when the `useDomainAdminAccess` parameter is set to `true`.
479 &quot;restrictions&quot;: { # A set of restrictions that apply to this Team Drive or items inside this Team Drive.
480 &quot;adminManagedRestrictions&quot;: True or False, # Whether administrative privileges on this Team Drive are required to modify restrictions.
481 &quot;copyRequiresWriterPermission&quot;: True or False, # Whether the options to copy, print, or download files inside this Team 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 Team Drive.
482 &quot;domainUsersOnly&quot;: True or False, # Whether access to this Team Drive and items inside this Team Drive is restricted to users of the domain to which this Team Drive belongs. This restriction may be overridden by other sharing policies controlled outside of this Team Drive.
483 &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.
484 &quot;teamMembersOnly&quot;: True or False, # Whether access to items inside this Team Drive is restricted to members of this Team Drive.
485 },
486 &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 `teamDriveThemes` can be retrieved from a `drive.about.get` response. When not specified on a `drive.teamdrives.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`.
487 }</pre>
488 </div>
489
490 </body></html>