Blame - docs/dyn/drive_v2.teamdrives.html - platform/external/python/google-api-python-client

blob: 6fc92143eed2fd4ae0ce82605ce04a8b987755c0 [file] [log] [blame]

Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	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">Drive API</a> . <a href="drive_v2.teamdrives.html">teamdrives</a></h1>
				76	<h2>Instance Methods</h2>
				77	<p class="toc_element">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame^]	78	<code><a href="#close">close()</a></code></p>
				79	<p class="firstline">Close httplib2 connections.</p>
				80	<p class="toc_element">
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	81	<code><a href="#delete">delete(teamDriveId)</a></code></p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	82	<p class="firstline">Deprecated use drives.delete instead.</p>
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	83	<p class="toc_element">
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	84	<code><a href="#get">get(teamDriveId, useDomainAdminAccess=None)</a></code></p>
				85	<p class="firstline">Deprecated use drives.get instead.</p>
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	86	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	87	<code><a href="#insert">insert(requestId, body=None)</a></code></p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	88	<p class="firstline">Deprecated use drives.insert instead.</p>
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	89	<p class="toc_element">
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	90	<code><a href="#list">list(maxResults=None, pageToken=None, q=None, useDomainAdminAccess=None)</a></code></p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	91	<p class="firstline">Deprecated use drives.list instead.</p>
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	92	<p class="toc_element">
				93	<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
				94	<p class="firstline">Retrieves the next page of results.</p>
				95	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	96	<code><a href="#update">update(teamDriveId, body=None, useDomainAdminAccess=None)</a></code></p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	97	<p class="firstline">Deprecated use drives.update instead.</p>
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	98	<h3>Method Details</h3>
				99	<div class="method">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame^]	100	<code class="details" id="close">close()</code>
				101	<pre>Close httplib2 connections.</pre>
				102	</div>
				103
				104	<div class="method">
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	105	<code class="details" id="delete">delete(teamDriveId)</code>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	106	<pre>Deprecated use drives.delete instead.
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	107
				108	Args:
				109	teamDriveId: string, The ID of the Team Drive (required)
				110	</pre>
				111	</div>
				112
				113	<div class="method">
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	114	<code class="details" id="get">get(teamDriveId, useDomainAdminAccess=None)</code>
				115	<pre>Deprecated use drives.get instead.
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	116
				117	Args:
				118	teamDriveId: string, The ID of the Team Drive (required)
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	119	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.
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	120
				121	Returns:
				122	An object of the form:
				123
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	124	{ # Deprecated: use the drive collection instead.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	125	"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.
				126	"id": "A String", # The ID of an image file in Drive to use for the background image.
				127	"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.
				128	"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.
				129	"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.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	130	},
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	131	"backgroundImageLink": "A String", # A short-lived link to this Team Drive's background image.
				132	"capabilities": { # Capabilities the current user has on this Team Drive.
				133	"canAddChildren": True or False, # Whether the current user can add children to folders in this Team Drive.
				134	"canChangeCopyRequiresWriterPermissionRestriction": True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this Team Drive.
				135	"canChangeDomainUsersOnlyRestriction": True or False, # Whether the current user can change the domainUsersOnly restriction of this Team Drive.
				136	"canChangeTeamDriveBackground": True or False, # Whether the current user can change the background of this Team Drive.
				137	"canChangeTeamMembersOnlyRestriction": True or False, # Whether the current user can change the teamMembersOnly restriction of this Team Drive.
				138	"canComment": True or False, # Whether the current user can comment on files in this Team Drive.
				139	"canCopy": True or False, # Whether the current user can copy files in this Team Drive.
				140	"canDeleteChildren": True or False, # Whether the current user can delete children from folders in this Team Drive.
				141	"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.
				142	"canDownload": True or False, # Whether the current user can download files in this Team Drive.
				143	"canEdit": True or False, # Whether the current user can edit files in this Team Drive
				144	"canListChildren": True or False, # Whether the current user can list the children of folders in this Team Drive.
				145	"canManageMembers": True or False, # Whether the current user can add members to this Team Drive or remove them or change their role.
				146	"canReadRevisions": True or False, # Whether the current user can read the revisions resource of files in this Team Drive.
				147	"canRemoveChildren": True or False, # Deprecated - use canDeleteChildren or canTrashChildren instead.
				148	"canRename": True or False, # Whether the current user can rename files or folders in this Team Drive.
				149	"canRenameTeamDrive": True or False, # Whether the current user can rename this Team Drive.
				150	"canShare": True or False, # Whether the current user can share files or folders in this Team Drive.
				151	"canTrashChildren": True or False, # Whether the current user can trash children from folders in this Team Drive.
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	152	},
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	153	"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.
				154	"createdDate": "A String", # The time at which the Team Drive was created (RFC 3339 date-time).
				155	"id": "A String", # The ID of this Team Drive which is also the ID of the top level folder of this Team Drive.
				156	"kind": "drive#teamDrive", # This is always drive#teamDrive
				157	"name": "A String", # The name of this Team Drive.
				158	"restrictions": { # A set of restrictions that apply to this Team Drive or items inside this Team Drive.
				159	"adminManagedRestrictions": True or False, # Whether administrative privileges on this Team Drive are required to modify restrictions.
				160	"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.
				161	"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.
				162	"teamMembersOnly": True or False, # Whether access to items inside this Team Drive is restricted to members of this Team Drive.
Sai Cheemalapati	4ba8c23	2017-06-06 18:46:08 -0400	[diff] [blame]	163	},
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	164	"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.
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	165	}</pre>
				166	</div>
				167
				168	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	169	<code class="details" id="insert">insert(requestId, body=None)</code>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	170	<pre>Deprecated use drives.insert instead.
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	171
				172	Args:
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	173	requestId: string, 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)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	174	body: object, The request body.
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	175	The object takes the form of:
				176
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	177	{ # Deprecated: use the drive collection instead.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	178	"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.
				179	"id": "A String", # The ID of an image file in Drive to use for the background image.
				180	"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.
				181	"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.
				182	"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.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	183	},
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	184	"backgroundImageLink": "A String", # A short-lived link to this Team Drive's background image.
				185	"capabilities": { # Capabilities the current user has on this Team Drive.
				186	"canAddChildren": True or False, # Whether the current user can add children to folders in this Team Drive.
				187	"canChangeCopyRequiresWriterPermissionRestriction": True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this Team Drive.
				188	"canChangeDomainUsersOnlyRestriction": True or False, # Whether the current user can change the domainUsersOnly restriction of this Team Drive.
				189	"canChangeTeamDriveBackground": True or False, # Whether the current user can change the background of this Team Drive.
				190	"canChangeTeamMembersOnlyRestriction": True or False, # Whether the current user can change the teamMembersOnly restriction of this Team Drive.
				191	"canComment": True or False, # Whether the current user can comment on files in this Team Drive.
				192	"canCopy": True or False, # Whether the current user can copy files in this Team Drive.
				193	"canDeleteChildren": True or False, # Whether the current user can delete children from folders in this Team Drive.
				194	"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.
				195	"canDownload": True or False, # Whether the current user can download files in this Team Drive.
				196	"canEdit": True or False, # Whether the current user can edit files in this Team Drive
				197	"canListChildren": True or False, # Whether the current user can list the children of folders in this Team Drive.
				198	"canManageMembers": True or False, # Whether the current user can add members to this Team Drive or remove them or change their role.
				199	"canReadRevisions": True or False, # Whether the current user can read the revisions resource of files in this Team Drive.
				200	"canRemoveChildren": True or False, # Deprecated - use canDeleteChildren or canTrashChildren instead.
				201	"canRename": True or False, # Whether the current user can rename files or folders in this Team Drive.
				202	"canRenameTeamDrive": True or False, # Whether the current user can rename this Team Drive.
				203	"canShare": True or False, # Whether the current user can share files or folders in this Team Drive.
				204	"canTrashChildren": True or False, # Whether the current user can trash children from folders in this Team Drive.
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	205	},
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	206	"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.
				207	"createdDate": "A String", # The time at which the Team Drive was created (RFC 3339 date-time).
				208	"id": "A String", # The ID of this Team Drive which is also the ID of the top level folder of this Team Drive.
				209	"kind": "drive#teamDrive", # This is always drive#teamDrive
				210	"name": "A String", # The name of this Team Drive.
				211	"restrictions": { # A set of restrictions that apply to this Team Drive or items inside this Team Drive.
				212	"adminManagedRestrictions": True or False, # Whether administrative privileges on this Team Drive are required to modify restrictions.
				213	"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.
				214	"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.
				215	"teamMembersOnly": True or False, # Whether access to items inside this Team Drive is restricted to members of this Team Drive.
Sai Cheemalapati	4ba8c23	2017-06-06 18:46:08 -0400	[diff] [blame]	216	},
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	217	"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.
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	218	}
				219
				220
				221	Returns:
				222	An object of the form:
				223
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	224	{ # Deprecated: use the drive collection instead.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	225	"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.
				226	"id": "A String", # The ID of an image file in Drive to use for the background image.
				227	"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.
				228	"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.
				229	"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.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	230	},
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	231	"backgroundImageLink": "A String", # A short-lived link to this Team Drive's background image.
				232	"capabilities": { # Capabilities the current user has on this Team Drive.
				233	"canAddChildren": True or False, # Whether the current user can add children to folders in this Team Drive.
				234	"canChangeCopyRequiresWriterPermissionRestriction": True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this Team Drive.
				235	"canChangeDomainUsersOnlyRestriction": True or False, # Whether the current user can change the domainUsersOnly restriction of this Team Drive.
				236	"canChangeTeamDriveBackground": True or False, # Whether the current user can change the background of this Team Drive.
				237	"canChangeTeamMembersOnlyRestriction": True or False, # Whether the current user can change the teamMembersOnly restriction of this Team Drive.
				238	"canComment": True or False, # Whether the current user can comment on files in this Team Drive.
				239	"canCopy": True or False, # Whether the current user can copy files in this Team Drive.
				240	"canDeleteChildren": True or False, # Whether the current user can delete children from folders in this Team Drive.
				241	"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.
				242	"canDownload": True or False, # Whether the current user can download files in this Team Drive.
				243	"canEdit": True or False, # Whether the current user can edit files in this Team Drive
				244	"canListChildren": True or False, # Whether the current user can list the children of folders in this Team Drive.
				245	"canManageMembers": True or False, # Whether the current user can add members to this Team Drive or remove them or change their role.
				246	"canReadRevisions": True or False, # Whether the current user can read the revisions resource of files in this Team Drive.
				247	"canRemoveChildren": True or False, # Deprecated - use canDeleteChildren or canTrashChildren instead.
				248	"canRename": True or False, # Whether the current user can rename files or folders in this Team Drive.
				249	"canRenameTeamDrive": True or False, # Whether the current user can rename this Team Drive.
				250	"canShare": True or False, # Whether the current user can share files or folders in this Team Drive.
				251	"canTrashChildren": True or False, # Whether the current user can trash children from folders in this Team Drive.
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	252	},
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	253	"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.
				254	"createdDate": "A String", # The time at which the Team Drive was created (RFC 3339 date-time).
				255	"id": "A String", # The ID of this Team Drive which is also the ID of the top level folder of this Team Drive.
				256	"kind": "drive#teamDrive", # This is always drive#teamDrive
				257	"name": "A String", # The name of this Team Drive.
				258	"restrictions": { # A set of restrictions that apply to this Team Drive or items inside this Team Drive.
				259	"adminManagedRestrictions": True or False, # Whether administrative privileges on this Team Drive are required to modify restrictions.
				260	"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.
				261	"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.
				262	"teamMembersOnly": True or False, # Whether access to items inside this Team Drive is restricted to members of this Team Drive.
Sai Cheemalapati	4ba8c23	2017-06-06 18:46:08 -0400	[diff] [blame]	263	},
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	264	"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.
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	265	}</pre>
				266	</div>
				267
				268	<div class="method">
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	269	<code class="details" id="list">list(maxResults=None, pageToken=None, q=None, useDomainAdminAccess=None)</code>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	270	<pre>Deprecated use drives.list instead.
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	271
				272	Args:
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	273	maxResults: integer, Maximum number of Team Drives to return.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	274	pageToken: string, Page token for Team Drives.
				275	q: string, Query string for searching Team Drives.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	276	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.
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	277
				278	Returns:
				279	An object of the form:
				280
				281	{ # A list of Team Drives.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	282	"items": [ # The list of Team Drives.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	283	{ # Deprecated: use the drive collection instead.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	284	"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.
				285	"id": "A String", # The ID of an image file in Drive to use for the background image.
				286	"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.
				287	"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.
				288	"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.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	289	},
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	290	"backgroundImageLink": "A String", # A short-lived link to this Team Drive's background image.
				291	"capabilities": { # Capabilities the current user has on this Team Drive.
				292	"canAddChildren": True or False, # Whether the current user can add children to folders in this Team Drive.
				293	"canChangeCopyRequiresWriterPermissionRestriction": True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this Team Drive.
				294	"canChangeDomainUsersOnlyRestriction": True or False, # Whether the current user can change the domainUsersOnly restriction of this Team Drive.
				295	"canChangeTeamDriveBackground": True or False, # Whether the current user can change the background of this Team Drive.
				296	"canChangeTeamMembersOnlyRestriction": True or False, # Whether the current user can change the teamMembersOnly restriction of this Team Drive.
				297	"canComment": True or False, # Whether the current user can comment on files in this Team Drive.
				298	"canCopy": True or False, # Whether the current user can copy files in this Team Drive.
				299	"canDeleteChildren": True or False, # Whether the current user can delete children from folders in this Team Drive.
				300	"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.
				301	"canDownload": True or False, # Whether the current user can download files in this Team Drive.
				302	"canEdit": True or False, # Whether the current user can edit files in this Team Drive
				303	"canListChildren": True or False, # Whether the current user can list the children of folders in this Team Drive.
				304	"canManageMembers": True or False, # Whether the current user can add members to this Team Drive or remove them or change their role.
				305	"canReadRevisions": True or False, # Whether the current user can read the revisions resource of files in this Team Drive.
				306	"canRemoveChildren": True or False, # Deprecated - use canDeleteChildren or canTrashChildren instead.
				307	"canRename": True or False, # Whether the current user can rename files or folders in this Team Drive.
				308	"canRenameTeamDrive": True or False, # Whether the current user can rename this Team Drive.
				309	"canShare": True or False, # Whether the current user can share files or folders in this Team Drive.
				310	"canTrashChildren": True or False, # Whether the current user can trash children from folders in this Team Drive.
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	311	},
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	312	"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.
				313	"createdDate": "A String", # The time at which the Team Drive was created (RFC 3339 date-time).
				314	"id": "A String", # The ID of this Team Drive which is also the ID of the top level folder of this Team Drive.
				315	"kind": "drive#teamDrive", # This is always drive#teamDrive
				316	"name": "A String", # The name of this Team Drive.
				317	"restrictions": { # A set of restrictions that apply to this Team Drive or items inside this Team Drive.
				318	"adminManagedRestrictions": True or False, # Whether administrative privileges on this Team Drive are required to modify restrictions.
				319	"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.
				320	"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.
				321	"teamMembersOnly": True or False, # Whether access to items inside this Team Drive is restricted to members of this Team Drive.
Sai Cheemalapati	4ba8c23	2017-06-06 18:46:08 -0400	[diff] [blame]	322	},
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	323	"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.
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	324	},
				325	],
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	326	"kind": "drive#teamDriveList", # This is always drive#teamDriveList
				327	"nextPageToken": "A String", # The page token for the next page of Team Drives.
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	328	}</pre>
				329	</div>
				330
				331	<div class="method">
				332	<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
				333	<pre>Retrieves the next page of results.
				334
				335	Args:
				336	previous_request: The request for the previous page. (required)
				337	previous_response: The response from the request for the previous page. (required)
				338
				339	Returns:
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	340	A request object that you can call 'execute()' on to request the next
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	341	page. Returns None if there are no more items in the collection.
				342	</pre>
				343	</div>
				344
				345	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	346	<code class="details" id="update">update(teamDriveId, body=None, useDomainAdminAccess=None)</code>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	347	<pre>Deprecated use drives.update instead.
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	348
				349	Args:
				350	teamDriveId: string, The ID of the Team Drive (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	351	body: object, The request body.
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	352	The object takes the form of:
				353
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	354	{ # Deprecated: use the drive collection instead.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	355	"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.
				356	"id": "A String", # The ID of an image file in Drive to use for the background image.
				357	"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.
				358	"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.
				359	"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.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	360	},
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	361	"backgroundImageLink": "A String", # A short-lived link to this Team Drive's background image.
				362	"capabilities": { # Capabilities the current user has on this Team Drive.
				363	"canAddChildren": True or False, # Whether the current user can add children to folders in this Team Drive.
				364	"canChangeCopyRequiresWriterPermissionRestriction": True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this Team Drive.
				365	"canChangeDomainUsersOnlyRestriction": True or False, # Whether the current user can change the domainUsersOnly restriction of this Team Drive.
				366	"canChangeTeamDriveBackground": True or False, # Whether the current user can change the background of this Team Drive.
				367	"canChangeTeamMembersOnlyRestriction": True or False, # Whether the current user can change the teamMembersOnly restriction of this Team Drive.
				368	"canComment": True or False, # Whether the current user can comment on files in this Team Drive.
				369	"canCopy": True or False, # Whether the current user can copy files in this Team Drive.
				370	"canDeleteChildren": True or False, # Whether the current user can delete children from folders in this Team Drive.
				371	"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.
				372	"canDownload": True or False, # Whether the current user can download files in this Team Drive.
				373	"canEdit": True or False, # Whether the current user can edit files in this Team Drive
				374	"canListChildren": True or False, # Whether the current user can list the children of folders in this Team Drive.
				375	"canManageMembers": True or False, # Whether the current user can add members to this Team Drive or remove them or change their role.
				376	"canReadRevisions": True or False, # Whether the current user can read the revisions resource of files in this Team Drive.
				377	"canRemoveChildren": True or False, # Deprecated - use canDeleteChildren or canTrashChildren instead.
				378	"canRename": True or False, # Whether the current user can rename files or folders in this Team Drive.
				379	"canRenameTeamDrive": True or False, # Whether the current user can rename this Team Drive.
				380	"canShare": True or False, # Whether the current user can share files or folders in this Team Drive.
				381	"canTrashChildren": True or False, # Whether the current user can trash children from folders in this Team Drive.
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	382	},
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	383	"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.
				384	"createdDate": "A String", # The time at which the Team Drive was created (RFC 3339 date-time).
				385	"id": "A String", # The ID of this Team Drive which is also the ID of the top level folder of this Team Drive.
				386	"kind": "drive#teamDrive", # This is always drive#teamDrive
				387	"name": "A String", # The name of this Team Drive.
				388	"restrictions": { # A set of restrictions that apply to this Team Drive or items inside this Team Drive.
				389	"adminManagedRestrictions": True or False, # Whether administrative privileges on this Team Drive are required to modify restrictions.
				390	"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.
				391	"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.
				392	"teamMembersOnly": True or False, # Whether access to items inside this Team Drive is restricted to members of this Team Drive.
Sai Cheemalapati	4ba8c23	2017-06-06 18:46:08 -0400	[diff] [blame]	393	},
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	394	"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.
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	395	}
				396
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	397	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.
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	398
				399	Returns:
				400	An object of the form:
				401
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	402	{ # Deprecated: use the drive collection instead.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	403	"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.
				404	"id": "A String", # The ID of an image file in Drive to use for the background image.
				405	"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.
				406	"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.
				407	"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.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	408	},
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	409	"backgroundImageLink": "A String", # A short-lived link to this Team Drive's background image.
				410	"capabilities": { # Capabilities the current user has on this Team Drive.
				411	"canAddChildren": True or False, # Whether the current user can add children to folders in this Team Drive.
				412	"canChangeCopyRequiresWriterPermissionRestriction": True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this Team Drive.
				413	"canChangeDomainUsersOnlyRestriction": True or False, # Whether the current user can change the domainUsersOnly restriction of this Team Drive.
				414	"canChangeTeamDriveBackground": True or False, # Whether the current user can change the background of this Team Drive.
				415	"canChangeTeamMembersOnlyRestriction": True or False, # Whether the current user can change the teamMembersOnly restriction of this Team Drive.
				416	"canComment": True or False, # Whether the current user can comment on files in this Team Drive.
				417	"canCopy": True or False, # Whether the current user can copy files in this Team Drive.
				418	"canDeleteChildren": True or False, # Whether the current user can delete children from folders in this Team Drive.
				419	"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.
				420	"canDownload": True or False, # Whether the current user can download files in this Team Drive.
				421	"canEdit": True or False, # Whether the current user can edit files in this Team Drive
				422	"canListChildren": True or False, # Whether the current user can list the children of folders in this Team Drive.
				423	"canManageMembers": True or False, # Whether the current user can add members to this Team Drive or remove them or change their role.
				424	"canReadRevisions": True or False, # Whether the current user can read the revisions resource of files in this Team Drive.
				425	"canRemoveChildren": True or False, # Deprecated - use canDeleteChildren or canTrashChildren instead.
				426	"canRename": True or False, # Whether the current user can rename files or folders in this Team Drive.
				427	"canRenameTeamDrive": True or False, # Whether the current user can rename this Team Drive.
				428	"canShare": True or False, # Whether the current user can share files or folders in this Team Drive.
				429	"canTrashChildren": True or False, # Whether the current user can trash children from folders in this Team Drive.
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	430	},
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	431	"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.
				432	"createdDate": "A String", # The time at which the Team Drive was created (RFC 3339 date-time).
				433	"id": "A String", # The ID of this Team Drive which is also the ID of the top level folder of this Team Drive.
				434	"kind": "drive#teamDrive", # This is always drive#teamDrive
				435	"name": "A String", # The name of this Team Drive.
				436	"restrictions": { # A set of restrictions that apply to this Team Drive or items inside this Team Drive.
				437	"adminManagedRestrictions": True or False, # Whether administrative privileges on this Team Drive are required to modify restrictions.
				438	"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.
				439	"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.
				440	"teamMembersOnly": True or False, # Whether access to items inside this Team Drive is restricted to members of this Team Drive.
Sai Cheemalapati	4ba8c23	2017-06-06 18:46:08 -0400	[diff] [blame]	441	},
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	442	"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.
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	443	}</pre>
				444	</div>
				445
				446	</body></html>