1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="drive_v2.html">Google Drive API</a> . <a href="drive_v2.teamdrives.html">teamdrives</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#delete">delete(teamDriveId, x__xgafv=None)</a></code></p>
<p class="firstline">Deprecated: Use `drives.delete` instead.</p>
<p class="toc_element">
<code><a href="#get">get(teamDriveId, useDomainAdminAccess=None, x__xgafv=None)</a></code></p>
<p class="firstline">Deprecated: Use `drives.get` instead.</p>
<p class="toc_element">
<code><a href="#insert">insert(requestId, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Deprecated: Use `drives.insert` instead.</p>
<p class="toc_element">
<code><a href="#list">list(maxResults=None, pageToken=None, q=None, useDomainAdminAccess=None, x__xgafv=None)</a></code></p>
<p class="firstline">Deprecated: Use `drives.list` instead.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#update">update(teamDriveId, body=None, useDomainAdminAccess=None, x__xgafv=None)</a></code></p>
<p class="firstline">Deprecated: Use `drives.update` instead.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(teamDriveId, x__xgafv=None)</code>
<pre>Deprecated: Use `drives.delete` instead.
Args:
teamDriveId: string, The ID of the Team Drive (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
</pre>
</div>
<div class="method">
<code class="details" id="get">get(teamDriveId, useDomainAdminAccess=None, x__xgafv=None)</code>
<pre>Deprecated: Use `drives.get` instead.
Args:
teamDriveId: string, The ID of the Team Drive (required)
useDomainAdminAccess: boolean, Issue the request as a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the Team Drive belongs.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Deprecated: Use the `drive` collection instead.
"backgroundImageFile": { # 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't set `themeId`. When specified, all fields of the `backgroundImageFile` must be set.
"id": "A String", # The ID of an image file in Drive to use for the background image.
"width": 3.14, # The width of the cropped image in the closed range of 0 to 1. This value represents the width of the cropped image divided by the width of the entire image. The height is computed by applying a width to height aspect ratio of 80 to 9. The resulting image must be at least 1280 pixels wide and 144 pixels high.
"xCoordinate": 3.14, # The X coordinate of the upper left corner of the cropping area in the background image. This is a value in the closed range of 0 to 1. This value represents the horizontal distance from the left side of the entire image to the left side of the cropping area divided by the width of the entire image.
"yCoordinate": 3.14, # The Y coordinate of the upper left corner of the cropping area in the background image. This is a value in the closed range of 0 to 1. This value represents the vertical distance from the top side of the entire image to the top side of the cropping area divided by the height of the entire image.
},
"backgroundImageLink": "A String", # A short-lived link to this Team Drive's background image.
"capabilities": { # Capabilities the current user has on this Team Drive.
"canAddChildren": True or False, # Whether the current user can add children to folders in this Team Drive.
"canChangeCopyRequiresWriterPermissionRestriction": True or False, # Whether the current user can change the `copyRequiresWriterPermission` restriction of this Team Drive.
"canChangeDomainUsersOnlyRestriction": True or False, # Whether the current user can change the `domainUsersOnly` restriction of this Team Drive.
"canChangeSharingFoldersRequiresOrganizerPermissionRestriction": True or False, # Whether the current user can change the `sharingFoldersRequiresOrganizerPermission` restriction of this Team Drive.
"canChangeTeamDriveBackground": True or False, # Whether the current user can change the background of this Team Drive.
"canChangeTeamMembersOnlyRestriction": True or False, # Whether the current user can change the `teamMembersOnly` restriction of this Team Drive.
"canComment": True or False, # Whether the current user can comment on files in this Team Drive.
"canCopy": True or False, # Whether the current user can copy files in this Team Drive.
"canDeleteChildren": True or False, # Whether the current user can delete children from folders in this Team Drive.
"canDeleteTeamDrive": 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.
"canDownload": True or False, # Whether the current user can download files in this Team Drive.
"canEdit": True or False, # Whether the current user can edit files in this Team Drive
"canListChildren": True or False, # Whether the current user can list the children of folders in this Team Drive.
"canManageMembers": True or False, # Whether the current user can add members to this Team Drive or remove them or change their role.
"canReadRevisions": True or False, # Whether the current user can read the revisions resource of files in this Team Drive.
"canRemoveChildren": True or False, # Deprecated: Use `canDeleteChildren` or `canTrashChildren` instead.
"canRename": True or False, # Whether the current user can rename files or folders in this Team Drive.
"canRenameTeamDrive": True or False, # Whether the current user can rename this Team Drive.
"canResetTeamDriveRestrictions": True or False, # Whether the current user can reset the Team Drive restrictions to defaults.
"canShare": True or False, # Whether the current user can share files or folders in this Team Drive.
"canTrashChildren": True or False, # Whether the current user can trash children from folders in this Team Drive.
},
"colorRgb": "A String", # 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`.
"createdDate": "A String", # The time at which the Team Drive was created (RFC 3339 date-time).
"id": "A String", # The ID of this Team Drive which is also the ID of the top level folder of this Team Drive.
"kind": "drive#teamDrive", # This is always `drive#teamDrive`
"name": "A String", # The name of this Team Drive.
"orgUnitId": "A String", # The organizational unit of this shared drive. This field is only populated on `drives.list` responses when the `useDomainAdminAccess` parameter is set to `true`.
"restrictions": { # A set of restrictions that apply to this Team Drive or items inside this Team Drive.
"adminManagedRestrictions": True or False, # Whether administrative privileges on this Team Drive are required to modify restrictions.
"copyRequiresWriterPermission": 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.
"domainUsersOnly": 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.
"sharingFoldersRequiresOrganizerPermission": True or False, # If true, only users with the organizer role can share folders. If false, users with either the organizer role or the file organizer role can share folders.
"teamMembersOnly": True or False, # Whether access to items inside this Team Drive is restricted to members of this Team Drive.
},
"themeId": "A String", # 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't set `colorRgb` or `backgroundImageFile`.
}</pre>
</div>
<div class="method">
<code class="details" id="insert">insert(requestId, body=None, x__xgafv=None)</code>
<pre>Deprecated: Use `drives.insert` instead.
Args:
requestId: string, Required. An ID, such as a random UUID, which uniquely identifies this user'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)
body: object, The request body.
The object takes the form of:
{ # Deprecated: Use the `drive` collection instead.
"backgroundImageFile": { # 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't set `themeId`. When specified, all fields of the `backgroundImageFile` must be set.
"id": "A String", # The ID of an image file in Drive to use for the background image.
"width": 3.14, # The width of the cropped image in the closed range of 0 to 1. This value represents the width of the cropped image divided by the width of the entire image. The height is computed by applying a width to height aspect ratio of 80 to 9. The resulting image must be at least 1280 pixels wide and 144 pixels high.
"xCoordinate": 3.14, # The X coordinate of the upper left corner of the cropping area in the background image. This is a value in the closed range of 0 to 1. This value represents the horizontal distance from the left side of the entire image to the left side of the cropping area divided by the width of the entire image.
"yCoordinate": 3.14, # The Y coordinate of the upper left corner of the cropping area in the background image. This is a value in the closed range of 0 to 1. This value represents the vertical distance from the top side of the entire image to the top side of the cropping area divided by the height of the entire image.
},
"backgroundImageLink": "A String", # A short-lived link to this Team Drive's background image.
"capabilities": { # Capabilities the current user has on this Team Drive.
"canAddChildren": True or False, # Whether the current user can add children to folders in this Team Drive.
"canChangeCopyRequiresWriterPermissionRestriction": True or False, # Whether the current user can change the `copyRequiresWriterPermission` restriction of this Team Drive.
"canChangeDomainUsersOnlyRestriction": True or False, # Whether the current user can change the `domainUsersOnly` restriction of this Team Drive.
"canChangeSharingFoldersRequiresOrganizerPermissionRestriction": True or False, # Whether the current user can change the `sharingFoldersRequiresOrganizerPermission` restriction of this Team Drive.
"canChangeTeamDriveBackground": True or False, # Whether the current user can change the background of this Team Drive.
"canChangeTeamMembersOnlyRestriction": True or False, # Whether the current user can change the `teamMembersOnly` restriction of this Team Drive.
"canComment": True or False, # Whether the current user can comment on files in this Team Drive.
"canCopy": True or False, # Whether the current user can copy files in this Team Drive.
"canDeleteChildren": True or False, # Whether the current user can delete children from folders in this Team Drive.
"canDeleteTeamDrive": 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.
"canDownload": True or False, # Whether the current user can download files in this Team Drive.
"canEdit": True or False, # Whether the current user can edit files in this Team Drive
"canListChildren": True or False, # Whether the current user can list the children of folders in this Team Drive.
"canManageMembers": True or False, # Whether the current user can add members to this Team Drive or remove them or change their role.
"canReadRevisions": True or False, # Whether the current user can read the revisions resource of files in this Team Drive.
"canRemoveChildren": True or False, # Deprecated: Use `canDeleteChildren` or `canTrashChildren` instead.
"canRename": True or False, # Whether the current user can rename files or folders in this Team Drive.
"canRenameTeamDrive": True or False, # Whether the current user can rename this Team Drive.
"canResetTeamDriveRestrictions": True or False, # Whether the current user can reset the Team Drive restrictions to defaults.
"canShare": True or False, # Whether the current user can share files or folders in this Team Drive.
"canTrashChildren": True or False, # Whether the current user can trash children from folders in this Team Drive.
},
"colorRgb": "A String", # 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`.
"createdDate": "A String", # The time at which the Team Drive was created (RFC 3339 date-time).
"id": "A String", # The ID of this Team Drive which is also the ID of the top level folder of this Team Drive.
"kind": "drive#teamDrive", # This is always `drive#teamDrive`
"name": "A String", # The name of this Team Drive.
"orgUnitId": "A String", # The organizational unit of this shared drive. This field is only populated on `drives.list` responses when the `useDomainAdminAccess` parameter is set to `true`.
"restrictions": { # A set of restrictions that apply to this Team Drive or items inside this Team Drive.
"adminManagedRestrictions": True or False, # Whether administrative privileges on this Team Drive are required to modify restrictions.
"copyRequiresWriterPermission": 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.
"domainUsersOnly": 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.
"sharingFoldersRequiresOrganizerPermission": True or False, # If true, only users with the organizer role can share folders. If false, users with either the organizer role or the file organizer role can share folders.
"teamMembersOnly": True or False, # Whether access to items inside this Team Drive is restricted to members of this Team Drive.
},
"themeId": "A String", # 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't set `colorRgb` or `backgroundImageFile`.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Deprecated: Use the `drive` collection instead.
"backgroundImageFile": { # 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't set `themeId`. When specified, all fields of the `backgroundImageFile` must be set.
"id": "A String", # The ID of an image file in Drive to use for the background image.
"width": 3.14, # The width of the cropped image in the closed range of 0 to 1. This value represents the width of the cropped image divided by the width of the entire image. The height is computed by applying a width to height aspect ratio of 80 to 9. The resulting image must be at least 1280 pixels wide and 144 pixels high.
"xCoordinate": 3.14, # The X coordinate of the upper left corner of the cropping area in the background image. This is a value in the closed range of 0 to 1. This value represents the horizontal distance from the left side of the entire image to the left side of the cropping area divided by the width of the entire image.
"yCoordinate": 3.14, # The Y coordinate of the upper left corner of the cropping area in the background image. This is a value in the closed range of 0 to 1. This value represents the vertical distance from the top side of the entire image to the top side of the cropping area divided by the height of the entire image.
},
"backgroundImageLink": "A String", # A short-lived link to this Team Drive's background image.
"capabilities": { # Capabilities the current user has on this Team Drive.
"canAddChildren": True or False, # Whether the current user can add children to folders in this Team Drive.
"canChangeCopyRequiresWriterPermissionRestriction": True or False, # Whether the current user can change the `copyRequiresWriterPermission` restriction of this Team Drive.
"canChangeDomainUsersOnlyRestriction": True or False, # Whether the current user can change the `domainUsersOnly` restriction of this Team Drive.
"canChangeSharingFoldersRequiresOrganizerPermissionRestriction": True or False, # Whether the current user can change the `sharingFoldersRequiresOrganizerPermission` restriction of this Team Drive.
"canChangeTeamDriveBackground": True or False, # Whether the current user can change the background of this Team Drive.
"canChangeTeamMembersOnlyRestriction": True or False, # Whether the current user can change the `teamMembersOnly` restriction of this Team Drive.
"canComment": True or False, # Whether the current user can comment on files in this Team Drive.
"canCopy": True or False, # Whether the current user can copy files in this Team Drive.
"canDeleteChildren": True or False, # Whether the current user can delete children from folders in this Team Drive.
"canDeleteTeamDrive": 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.
"canDownload": True or False, # Whether the current user can download files in this Team Drive.
"canEdit": True or False, # Whether the current user can edit files in this Team Drive
"canListChildren": True or False, # Whether the current user can list the children of folders in this Team Drive.
"canManageMembers": True or False, # Whether the current user can add members to this Team Drive or remove them or change their role.
"canReadRevisions": True or False, # Whether the current user can read the revisions resource of files in this Team Drive.
"canRemoveChildren": True or False, # Deprecated: Use `canDeleteChildren` or `canTrashChildren` instead.
"canRename": True or False, # Whether the current user can rename files or folders in this Team Drive.
"canRenameTeamDrive": True or False, # Whether the current user can rename this Team Drive.
"canResetTeamDriveRestrictions": True or False, # Whether the current user can reset the Team Drive restrictions to defaults.
"canShare": True or False, # Whether the current user can share files or folders in this Team Drive.
"canTrashChildren": True or False, # Whether the current user can trash children from folders in this Team Drive.
},
"colorRgb": "A String", # 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`.
"createdDate": "A String", # The time at which the Team Drive was created (RFC 3339 date-time).
"id": "A String", # The ID of this Team Drive which is also the ID of the top level folder of this Team Drive.
"kind": "drive#teamDrive", # This is always `drive#teamDrive`
"name": "A String", # The name of this Team Drive.
"orgUnitId": "A String", # The organizational unit of this shared drive. This field is only populated on `drives.list` responses when the `useDomainAdminAccess` parameter is set to `true`.
"restrictions": { # A set of restrictions that apply to this Team Drive or items inside this Team Drive.
"adminManagedRestrictions": True or False, # Whether administrative privileges on this Team Drive are required to modify restrictions.
"copyRequiresWriterPermission": 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.
"domainUsersOnly": 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.
"sharingFoldersRequiresOrganizerPermission": True or False, # If true, only users with the organizer role can share folders. If false, users with either the organizer role or the file organizer role can share folders.
"teamMembersOnly": True or False, # Whether access to items inside this Team Drive is restricted to members of this Team Drive.
},
"themeId": "A String", # 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't set `colorRgb` or `backgroundImageFile`.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(maxResults=None, pageToken=None, q=None, useDomainAdminAccess=None, x__xgafv=None)</code>
<pre>Deprecated: Use `drives.list` instead.
Args:
maxResults: integer, Maximum number of Team Drives to return.
pageToken: string, Page token for Team Drives.
q: string, Query string for searching Team Drives.
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.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A list of Team Drives.
"items": [ # The list of Team Drives.
{ # Deprecated: Use the `drive` collection instead.
"backgroundImageFile": { # 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't set `themeId`. When specified, all fields of the `backgroundImageFile` must be set.
"id": "A String", # The ID of an image file in Drive to use for the background image.
"width": 3.14, # The width of the cropped image in the closed range of 0 to 1. This value represents the width of the cropped image divided by the width of the entire image. The height is computed by applying a width to height aspect ratio of 80 to 9. The resulting image must be at least 1280 pixels wide and 144 pixels high.
"xCoordinate": 3.14, # The X coordinate of the upper left corner of the cropping area in the background image. This is a value in the closed range of 0 to 1. This value represents the horizontal distance from the left side of the entire image to the left side of the cropping area divided by the width of the entire image.
"yCoordinate": 3.14, # The Y coordinate of the upper left corner of the cropping area in the background image. This is a value in the closed range of 0 to 1. This value represents the vertical distance from the top side of the entire image to the top side of the cropping area divided by the height of the entire image.
},
"backgroundImageLink": "A String", # A short-lived link to this Team Drive's background image.
"capabilities": { # Capabilities the current user has on this Team Drive.
"canAddChildren": True or False, # Whether the current user can add children to folders in this Team Drive.
"canChangeCopyRequiresWriterPermissionRestriction": True or False, # Whether the current user can change the `copyRequiresWriterPermission` restriction of this Team Drive.
"canChangeDomainUsersOnlyRestriction": True or False, # Whether the current user can change the `domainUsersOnly` restriction of this Team Drive.
"canChangeSharingFoldersRequiresOrganizerPermissionRestriction": True or False, # Whether the current user can change the `sharingFoldersRequiresOrganizerPermission` restriction of this Team Drive.
"canChangeTeamDriveBackground": True or False, # Whether the current user can change the background of this Team Drive.
"canChangeTeamMembersOnlyRestriction": True or False, # Whether the current user can change the `teamMembersOnly` restriction of this Team Drive.
"canComment": True or False, # Whether the current user can comment on files in this Team Drive.
"canCopy": True or False, # Whether the current user can copy files in this Team Drive.
"canDeleteChildren": True or False, # Whether the current user can delete children from folders in this Team Drive.
"canDeleteTeamDrive": 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.
"canDownload": True or False, # Whether the current user can download files in this Team Drive.
"canEdit": True or False, # Whether the current user can edit files in this Team Drive
"canListChildren": True or False, # Whether the current user can list the children of folders in this Team Drive.
"canManageMembers": True or False, # Whether the current user can add members to this Team Drive or remove them or change their role.
"canReadRevisions": True or False, # Whether the current user can read the revisions resource of files in this Team Drive.
"canRemoveChildren": True or False, # Deprecated: Use `canDeleteChildren` or `canTrashChildren` instead.
"canRename": True or False, # Whether the current user can rename files or folders in this Team Drive.
"canRenameTeamDrive": True or False, # Whether the current user can rename this Team Drive.
"canResetTeamDriveRestrictions": True or False, # Whether the current user can reset the Team Drive restrictions to defaults.
"canShare": True or False, # Whether the current user can share files or folders in this Team Drive.
"canTrashChildren": True or False, # Whether the current user can trash children from folders in this Team Drive.
},
"colorRgb": "A String", # 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`.
"createdDate": "A String", # The time at which the Team Drive was created (RFC 3339 date-time).
"id": "A String", # The ID of this Team Drive which is also the ID of the top level folder of this Team Drive.
"kind": "drive#teamDrive", # This is always `drive#teamDrive`
"name": "A String", # The name of this Team Drive.
"orgUnitId": "A String", # The organizational unit of this shared drive. This field is only populated on `drives.list` responses when the `useDomainAdminAccess` parameter is set to `true`.
"restrictions": { # A set of restrictions that apply to this Team Drive or items inside this Team Drive.
"adminManagedRestrictions": True or False, # Whether administrative privileges on this Team Drive are required to modify restrictions.
"copyRequiresWriterPermission": 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.
"domainUsersOnly": 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.
"sharingFoldersRequiresOrganizerPermission": True or False, # If true, only users with the organizer role can share folders. If false, users with either the organizer role or the file organizer role can share folders.
"teamMembersOnly": True or False, # Whether access to items inside this Team Drive is restricted to members of this Team Drive.
},
"themeId": "A String", # 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't set `colorRgb` or `backgroundImageFile`.
},
],
"kind": "drive#teamDriveList", # This is always `drive#teamDriveList`
"nextPageToken": "A String", # The page token for the next page of Team Drives.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
<div class="method">
<code class="details" id="update">update(teamDriveId, body=None, useDomainAdminAccess=None, x__xgafv=None)</code>
<pre>Deprecated: Use `drives.update` instead.
Args:
teamDriveId: string, The ID of the Team Drive (required)
body: object, The request body.
The object takes the form of:
{ # Deprecated: Use the `drive` collection instead.
"backgroundImageFile": { # 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't set `themeId`. When specified, all fields of the `backgroundImageFile` must be set.
"id": "A String", # The ID of an image file in Drive to use for the background image.
"width": 3.14, # The width of the cropped image in the closed range of 0 to 1. This value represents the width of the cropped image divided by the width of the entire image. The height is computed by applying a width to height aspect ratio of 80 to 9. The resulting image must be at least 1280 pixels wide and 144 pixels high.
"xCoordinate": 3.14, # The X coordinate of the upper left corner of the cropping area in the background image. This is a value in the closed range of 0 to 1. This value represents the horizontal distance from the left side of the entire image to the left side of the cropping area divided by the width of the entire image.
"yCoordinate": 3.14, # The Y coordinate of the upper left corner of the cropping area in the background image. This is a value in the closed range of 0 to 1. This value represents the vertical distance from the top side of the entire image to the top side of the cropping area divided by the height of the entire image.
},
"backgroundImageLink": "A String", # A short-lived link to this Team Drive's background image.
"capabilities": { # Capabilities the current user has on this Team Drive.
"canAddChildren": True or False, # Whether the current user can add children to folders in this Team Drive.
"canChangeCopyRequiresWriterPermissionRestriction": True or False, # Whether the current user can change the `copyRequiresWriterPermission` restriction of this Team Drive.
"canChangeDomainUsersOnlyRestriction": True or False, # Whether the current user can change the `domainUsersOnly` restriction of this Team Drive.
"canChangeSharingFoldersRequiresOrganizerPermissionRestriction": True or False, # Whether the current user can change the `sharingFoldersRequiresOrganizerPermission` restriction of this Team Drive.
"canChangeTeamDriveBackground": True or False, # Whether the current user can change the background of this Team Drive.
"canChangeTeamMembersOnlyRestriction": True or False, # Whether the current user can change the `teamMembersOnly` restriction of this Team Drive.
"canComment": True or False, # Whether the current user can comment on files in this Team Drive.
"canCopy": True or False, # Whether the current user can copy files in this Team Drive.
"canDeleteChildren": True or False, # Whether the current user can delete children from folders in this Team Drive.
"canDeleteTeamDrive": 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.
"canDownload": True or False, # Whether the current user can download files in this Team Drive.
"canEdit": True or False, # Whether the current user can edit files in this Team Drive
"canListChildren": True or False, # Whether the current user can list the children of folders in this Team Drive.
"canManageMembers": True or False, # Whether the current user can add members to this Team Drive or remove them or change their role.
"canReadRevisions": True or False, # Whether the current user can read the revisions resource of files in this Team Drive.
"canRemoveChildren": True or False, # Deprecated: Use `canDeleteChildren` or `canTrashChildren` instead.
"canRename": True or False, # Whether the current user can rename files or folders in this Team Drive.
"canRenameTeamDrive": True or False, # Whether the current user can rename this Team Drive.
"canResetTeamDriveRestrictions": True or False, # Whether the current user can reset the Team Drive restrictions to defaults.
"canShare": True or False, # Whether the current user can share files or folders in this Team Drive.
"canTrashChildren": True or False, # Whether the current user can trash children from folders in this Team Drive.
},
"colorRgb": "A String", # 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`.
"createdDate": "A String", # The time at which the Team Drive was created (RFC 3339 date-time).
"id": "A String", # The ID of this Team Drive which is also the ID of the top level folder of this Team Drive.
"kind": "drive#teamDrive", # This is always `drive#teamDrive`
"name": "A String", # The name of this Team Drive.
"orgUnitId": "A String", # The organizational unit of this shared drive. This field is only populated on `drives.list` responses when the `useDomainAdminAccess` parameter is set to `true`.
"restrictions": { # A set of restrictions that apply to this Team Drive or items inside this Team Drive.
"adminManagedRestrictions": True or False, # Whether administrative privileges on this Team Drive are required to modify restrictions.
"copyRequiresWriterPermission": 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.
"domainUsersOnly": 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.
"sharingFoldersRequiresOrganizerPermission": True or False, # If true, only users with the organizer role can share folders. If false, users with either the organizer role or the file organizer role can share folders.
"teamMembersOnly": True or False, # Whether access to items inside this Team Drive is restricted to members of this Team Drive.
},
"themeId": "A String", # 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't set `colorRgb` or `backgroundImageFile`.
}
useDomainAdminAccess: boolean, Issue the request as a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the Team Drive belongs.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Deprecated: Use the `drive` collection instead.
"backgroundImageFile": { # 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't set `themeId`. When specified, all fields of the `backgroundImageFile` must be set.
"id": "A String", # The ID of an image file in Drive to use for the background image.
"width": 3.14, # The width of the cropped image in the closed range of 0 to 1. This value represents the width of the cropped image divided by the width of the entire image. The height is computed by applying a width to height aspect ratio of 80 to 9. The resulting image must be at least 1280 pixels wide and 144 pixels high.
"xCoordinate": 3.14, # The X coordinate of the upper left corner of the cropping area in the background image. This is a value in the closed range of 0 to 1. This value represents the horizontal distance from the left side of the entire image to the left side of the cropping area divided by the width of the entire image.
"yCoordinate": 3.14, # The Y coordinate of the upper left corner of the cropping area in the background image. This is a value in the closed range of 0 to 1. This value represents the vertical distance from the top side of the entire image to the top side of the cropping area divided by the height of the entire image.
},
"backgroundImageLink": "A String", # A short-lived link to this Team Drive's background image.
"capabilities": { # Capabilities the current user has on this Team Drive.
"canAddChildren": True or False, # Whether the current user can add children to folders in this Team Drive.
"canChangeCopyRequiresWriterPermissionRestriction": True or False, # Whether the current user can change the `copyRequiresWriterPermission` restriction of this Team Drive.
"canChangeDomainUsersOnlyRestriction": True or False, # Whether the current user can change the `domainUsersOnly` restriction of this Team Drive.
"canChangeSharingFoldersRequiresOrganizerPermissionRestriction": True or False, # Whether the current user can change the `sharingFoldersRequiresOrganizerPermission` restriction of this Team Drive.
"canChangeTeamDriveBackground": True or False, # Whether the current user can change the background of this Team Drive.
"canChangeTeamMembersOnlyRestriction": True or False, # Whether the current user can change the `teamMembersOnly` restriction of this Team Drive.
"canComment": True or False, # Whether the current user can comment on files in this Team Drive.
"canCopy": True or False, # Whether the current user can copy files in this Team Drive.
"canDeleteChildren": True or False, # Whether the current user can delete children from folders in this Team Drive.
"canDeleteTeamDrive": 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.
"canDownload": True or False, # Whether the current user can download files in this Team Drive.
"canEdit": True or False, # Whether the current user can edit files in this Team Drive
"canListChildren": True or False, # Whether the current user can list the children of folders in this Team Drive.
"canManageMembers": True or False, # Whether the current user can add members to this Team Drive or remove them or change their role.
"canReadRevisions": True or False, # Whether the current user can read the revisions resource of files in this Team Drive.
"canRemoveChildren": True or False, # Deprecated: Use `canDeleteChildren` or `canTrashChildren` instead.
"canRename": True or False, # Whether the current user can rename files or folders in this Team Drive.
"canRenameTeamDrive": True or False, # Whether the current user can rename this Team Drive.
"canResetTeamDriveRestrictions": True or False, # Whether the current user can reset the Team Drive restrictions to defaults.
"canShare": True or False, # Whether the current user can share files or folders in this Team Drive.
"canTrashChildren": True or False, # Whether the current user can trash children from folders in this Team Drive.
},
"colorRgb": "A String", # 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`.
"createdDate": "A String", # The time at which the Team Drive was created (RFC 3339 date-time).
"id": "A String", # The ID of this Team Drive which is also the ID of the top level folder of this Team Drive.
"kind": "drive#teamDrive", # This is always `drive#teamDrive`
"name": "A String", # The name of this Team Drive.
"orgUnitId": "A String", # The organizational unit of this shared drive. This field is only populated on `drives.list` responses when the `useDomainAdminAccess` parameter is set to `true`.
"restrictions": { # A set of restrictions that apply to this Team Drive or items inside this Team Drive.
"adminManagedRestrictions": True or False, # Whether administrative privileges on this Team Drive are required to modify restrictions.
"copyRequiresWriterPermission": 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.
"domainUsersOnly": 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.
"sharingFoldersRequiresOrganizerPermission": True or False, # If true, only users with the organizer role can share folders. If false, users with either the organizer role or the file organizer role can share folders.
"teamMembersOnly": True or False, # Whether access to items inside this Team Drive is restricted to members of this Team Drive.
},
"themeId": "A String", # 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't set `colorRgb` or `backgroundImageFile`.
}</pre>
</div>
</body></html>
|