Blame - docs/dyn/tagmanager_v2.accounts.user_permissions.html - platform/external/python/google-api-python-client

blob: d0eca81e255e003212e2105bcc04ac22d9a48e9f [file] [log] [blame]

Sai Cheemalapati	4ba8c23	2017-06-06 18:46:08 -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="tagmanager_v2.html">Tag Manager API</a> . <a href="tagmanager_v2.accounts.html">accounts</a> . <a href="tagmanager_v2.accounts.user_permissions.html">user_permissions</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">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	81	<code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
Sai Cheemalapati	4ba8c23	2017-06-06 18:46:08 -0400	[diff] [blame]	82	<p class="firstline">Creates a user's Account & Container access.</p>
				83	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	84	<code><a href="#delete">delete(path, x__xgafv=None)</a></code></p>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	85	<p class="firstline">Removes a user from the account, revoking access to it and all of its containers.</p>
Sai Cheemalapati	4ba8c23	2017-06-06 18:46:08 -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="#get">get(path, x__xgafv=None)</a></code></p>
Sai Cheemalapati	4ba8c23	2017-06-06 18:46:08 -0400	[diff] [blame]	88	<p class="firstline">Gets a user's Account & Container access.</p>
				89	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	90	<code><a href="#list">list(parent, pageToken=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	91	<p class="firstline">List all users that have access to the account along with Account and Container user access granted to each of them.</p>
Sai Cheemalapati	4ba8c23	2017-06-06 18:46:08 -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(path, body=None, x__xgafv=None)</a></code></p>
Sai Cheemalapati	4ba8c23	2017-06-06 18:46:08 -0400	[diff] [blame]	97	<p class="firstline">Updates a user's Account & Container access.</p>
				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">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	105	<code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	106	<pre>Creates a user's Account & Container access.
Sai Cheemalapati	4ba8c23	2017-06-06 18:46:08 -0400	[diff] [blame]	107
				108	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	109	parent: string, GTM Account's API relative path. Example: accounts/{account_id} (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	110	body: object, The request body.
Sai Cheemalapati	4ba8c23	2017-06-06 18:46:08 -0400	[diff] [blame]	111	The object takes the form of:
				112
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	113	{ # Represents a user's permissions to an account and its container.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	114	"accountAccess": { # Defines the Google Tag Manager Account access permissions. # GTM Account access permissions. @mutable tagmanager.accounts.permissions.create @mutable tagmanager.accounts.permissions.update
				115	"permission": "A String", # Whether the user has no access, user access, or admin access to an account. @mutable tagmanager.accounts.permissions.create @mutable tagmanager.accounts.permissions.update
				116	},
				117	"accountId": "A String", # The Account ID uniquely identifies the GTM Account.
				118	"containerAccess": [ # GTM Container access permissions. @mutable tagmanager.accounts.permissions.create @mutable tagmanager.accounts.permissions.update
				119	{ # Defines the Google Tag Manager Container access permissions.
				120	"containerId": "A String", # GTM Container ID. @mutable tagmanager.accounts.permissions.create @mutable tagmanager.accounts.permissions.update
				121	"permission": "A String", # List of Container permissions. @mutable tagmanager.accounts.permissions.create @mutable tagmanager.accounts.permissions.update
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame]	122	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	123	],
				124	"emailAddress": "A String", # User's email address. @mutable tagmanager.accounts.permissions.create
				125	"path": "A String", # GTM UserPermission's API relative path.
				126	}
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame]	127
				128	x__xgafv: string, V1 error format.
				129	Allowed values
				130	1 - v1 error format
				131	2 - v2 error format
				132
				133	Returns:
				134	An object of the form:
				135
				136	{ # Represents a user's permissions to an account and its container.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	137	"accountAccess": { # Defines the Google Tag Manager Account access permissions. # GTM Account access permissions. @mutable tagmanager.accounts.permissions.create @mutable tagmanager.accounts.permissions.update
				138	"permission": "A String", # Whether the user has no access, user access, or admin access to an account. @mutable tagmanager.accounts.permissions.create @mutable tagmanager.accounts.permissions.update
				139	},
				140	"accountId": "A String", # The Account ID uniquely identifies the GTM Account.
				141	"containerAccess": [ # GTM Container access permissions. @mutable tagmanager.accounts.permissions.create @mutable tagmanager.accounts.permissions.update
				142	{ # Defines the Google Tag Manager Container access permissions.
				143	"containerId": "A String", # GTM Container ID. @mutable tagmanager.accounts.permissions.create @mutable tagmanager.accounts.permissions.update
				144	"permission": "A String", # List of Container permissions. @mutable tagmanager.accounts.permissions.create @mutable tagmanager.accounts.permissions.update
				145	},
				146	],
				147	"emailAddress": "A String", # User's email address. @mutable tagmanager.accounts.permissions.create
				148	"path": "A String", # GTM UserPermission's API relative path.
				149	}</pre>
Sai Cheemalapati	4ba8c23	2017-06-06 18:46:08 -0400	[diff] [blame]	150	</div>
				151
				152	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	153	<code class="details" id="delete">delete(path, x__xgafv=None)</code>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	154	<pre>Removes a user from the account, revoking access to it and all of its containers.
Sai Cheemalapati	4ba8c23	2017-06-06 18:46:08 -0400	[diff] [blame]	155
				156	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	157	path: string, GTM UserPermission's API relative path. Example: accounts/{account_id}/user_permissions/{user_permission_id} (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	158	x__xgafv: string, V1 error format.
				159	Allowed values
				160	1 - v1 error format
				161	2 - v2 error format
Sai Cheemalapati	4ba8c23	2017-06-06 18:46:08 -0400	[diff] [blame]	162	</pre>
				163	</div>
				164
				165	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	166	<code class="details" id="get">get(path, x__xgafv=None)</code>
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	167	<pre>Gets a user's Account & Container access.
Sai Cheemalapati	4ba8c23	2017-06-06 18:46:08 -0400	[diff] [blame]	168
				169	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	170	path: string, GTM UserPermission's API relative path. Example: accounts/{account_id}/user_permissions/{user_permission_id} (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	171	x__xgafv: string, V1 error format.
				172	Allowed values
				173	1 - v1 error format
				174	2 - v2 error format
Sai Cheemalapati	4ba8c23	2017-06-06 18:46:08 -0400	[diff] [blame]	175
				176	Returns:
				177	An object of the form:
				178
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	179	{ # Represents a user's permissions to an account and its container.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	180	"accountAccess": { # Defines the Google Tag Manager Account access permissions. # GTM Account access permissions. @mutable tagmanager.accounts.permissions.create @mutable tagmanager.accounts.permissions.update
				181	"permission": "A String", # Whether the user has no access, user access, or admin access to an account. @mutable tagmanager.accounts.permissions.create @mutable tagmanager.accounts.permissions.update
				182	},
				183	"accountId": "A String", # The Account ID uniquely identifies the GTM Account.
				184	"containerAccess": [ # GTM Container access permissions. @mutable tagmanager.accounts.permissions.create @mutable tagmanager.accounts.permissions.update
				185	{ # Defines the Google Tag Manager Container access permissions.
				186	"containerId": "A String", # GTM Container ID. @mutable tagmanager.accounts.permissions.create @mutable tagmanager.accounts.permissions.update
				187	"permission": "A String", # List of Container permissions. @mutable tagmanager.accounts.permissions.create @mutable tagmanager.accounts.permissions.update
				188	},
				189	],
				190	"emailAddress": "A String", # User's email address. @mutable tagmanager.accounts.permissions.create
				191	"path": "A String", # GTM UserPermission's API relative path.
				192	}</pre>
Sai Cheemalapati	4ba8c23	2017-06-06 18:46:08 -0400	[diff] [blame]	193	</div>
				194
				195	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	196	<code class="details" id="list">list(parent, pageToken=None, x__xgafv=None)</code>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	197	<pre>List all users that have access to the account along with Account and Container user access granted to each of them.
Sai Cheemalapati	4ba8c23	2017-06-06 18:46:08 -0400	[diff] [blame]	198
				199	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	200	parent: string, GTM Accounts's API relative path. Example: accounts/{account_id} (required)
Sai Cheemalapati	4ba8c23	2017-06-06 18:46:08 -0400	[diff] [blame]	201	pageToken: string, Continuation token for fetching the next page of results.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	202	x__xgafv: string, V1 error format.
				203	Allowed values
				204	1 - v1 error format
				205	2 - v2 error format
Sai Cheemalapati	4ba8c23	2017-06-06 18:46:08 -0400	[diff] [blame]	206
				207	Returns:
				208	An object of the form:
				209
				210	{ # List user permissions response.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	211	"nextPageToken": "A String", # Continuation token for fetching the next page of results.
				212	"userPermission": [ # All GTM UserPermissions of a GTM Account.
				213	{ # Represents a user's permissions to an account and its container.
				214	"accountAccess": { # Defines the Google Tag Manager Account access permissions. # GTM Account access permissions. @mutable tagmanager.accounts.permissions.create @mutable tagmanager.accounts.permissions.update
				215	"permission": "A String", # Whether the user has no access, user access, or admin access to an account. @mutable tagmanager.accounts.permissions.create @mutable tagmanager.accounts.permissions.update
				216	},
				217	"accountId": "A String", # The Account ID uniquely identifies the GTM Account.
				218	"containerAccess": [ # GTM Container access permissions. @mutable tagmanager.accounts.permissions.create @mutable tagmanager.accounts.permissions.update
				219	{ # Defines the Google Tag Manager Container access permissions.
				220	"containerId": "A String", # GTM Container ID. @mutable tagmanager.accounts.permissions.create @mutable tagmanager.accounts.permissions.update
				221	"permission": "A String", # List of Container permissions. @mutable tagmanager.accounts.permissions.create @mutable tagmanager.accounts.permissions.update
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	222	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	223	],
				224	"emailAddress": "A String", # User's email address. @mutable tagmanager.accounts.permissions.create
				225	"path": "A String", # GTM UserPermission's API relative path.
				226	},
				227	],
				228	}</pre>
Sai Cheemalapati	4ba8c23	2017-06-06 18:46:08 -0400	[diff] [blame]	229	</div>
				230
				231	<div class="method">
				232	<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
				233	<pre>Retrieves the next page of results.
				234
				235	Args:
				236	previous_request: The request for the previous page. (required)
				237	previous_response: The response from the request for the previous page. (required)
				238
				239	Returns:
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	240	A request object that you can call 'execute()' on to request the next
Sai Cheemalapati	4ba8c23	2017-06-06 18:46:08 -0400	[diff] [blame]	241	page. Returns None if there are no more items in the collection.
				242	</pre>
				243	</div>
				244
				245	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	246	<code class="details" id="update">update(path, body=None, x__xgafv=None)</code>
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	247	<pre>Updates a user's Account & Container access.
Sai Cheemalapati	4ba8c23	2017-06-06 18:46:08 -0400	[diff] [blame]	248
				249	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	250	path: string, GTM UserPermission's API relative path. Example: accounts/{account_id}/user_permissions/{user_permission_id} (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	251	body: object, The request body.
Sai Cheemalapati	4ba8c23	2017-06-06 18:46:08 -0400	[diff] [blame]	252	The object takes the form of:
				253
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	254	{ # Represents a user's permissions to an account and its container.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	255	"accountAccess": { # Defines the Google Tag Manager Account access permissions. # GTM Account access permissions. @mutable tagmanager.accounts.permissions.create @mutable tagmanager.accounts.permissions.update
				256	"permission": "A String", # Whether the user has no access, user access, or admin access to an account. @mutable tagmanager.accounts.permissions.create @mutable tagmanager.accounts.permissions.update
				257	},
				258	"accountId": "A String", # The Account ID uniquely identifies the GTM Account.
				259	"containerAccess": [ # GTM Container access permissions. @mutable tagmanager.accounts.permissions.create @mutable tagmanager.accounts.permissions.update
				260	{ # Defines the Google Tag Manager Container access permissions.
				261	"containerId": "A String", # GTM Container ID. @mutable tagmanager.accounts.permissions.create @mutable tagmanager.accounts.permissions.update
				262	"permission": "A String", # List of Container permissions. @mutable tagmanager.accounts.permissions.create @mutable tagmanager.accounts.permissions.update
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame]	263	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	264	],
				265	"emailAddress": "A String", # User's email address. @mutable tagmanager.accounts.permissions.create
				266	"path": "A String", # GTM UserPermission's API relative path.
				267	}
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame]	268
				269	x__xgafv: string, V1 error format.
				270	Allowed values
				271	1 - v1 error format
				272	2 - v2 error format
				273
				274	Returns:
				275	An object of the form:
				276
				277	{ # Represents a user's permissions to an account and its container.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	278	"accountAccess": { # Defines the Google Tag Manager Account access permissions. # GTM Account access permissions. @mutable tagmanager.accounts.permissions.create @mutable tagmanager.accounts.permissions.update
				279	"permission": "A String", # Whether the user has no access, user access, or admin access to an account. @mutable tagmanager.accounts.permissions.create @mutable tagmanager.accounts.permissions.update
				280	},
				281	"accountId": "A String", # The Account ID uniquely identifies the GTM Account.
				282	"containerAccess": [ # GTM Container access permissions. @mutable tagmanager.accounts.permissions.create @mutable tagmanager.accounts.permissions.update
				283	{ # Defines the Google Tag Manager Container access permissions.
				284	"containerId": "A String", # GTM Container ID. @mutable tagmanager.accounts.permissions.create @mutable tagmanager.accounts.permissions.update
				285	"permission": "A String", # List of Container permissions. @mutable tagmanager.accounts.permissions.create @mutable tagmanager.accounts.permissions.update
				286	},
				287	],
				288	"emailAddress": "A String", # User's email address. @mutable tagmanager.accounts.permissions.create
				289	"path": "A String", # GTM UserPermission's API relative path.
				290	}</pre>
Sai Cheemalapati	4ba8c23	2017-06-06 18:46:08 -0400	[diff] [blame]	291	</div>
				292
				293	</body></html>