Blame - docs/dyn/adexchangebuyer2_v2beta1.accounts.clients.users.html - platform/external/python/google-api-python-client

blob: 36b49c6a0e7dfb4d0ae0dabdd324f037c37c4ba4 [file] [log] [blame]

Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[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="adexchangebuyer2_v2beta1.html">Ad Exchange Buyer API II</a> . <a href="adexchangebuyer2_v2beta1.accounts.html">accounts</a> . <a href="adexchangebuyer2_v2beta1.accounts.clients.html">clients</a> . <a href="adexchangebuyer2_v2beta1.accounts.clients.users.html">users</a></h1>
				76	<h2>Instance Methods</h2>
				77	<p class="toc_element">
Thomas Coffee	2f24537	2017-03-27 10:39:26 -0700	[diff] [blame]	78	<code><a href="#get">get(accountId, clientAccountId, userId, x__xgafv=None)</a></code></p>
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	79	<p class="firstline">Retrieves an existing client user.</p>
				80	<p class="toc_element">
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	81	<code><a href="#list">list(accountId, clientAccountId, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p>
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	82	<p class="firstline">Lists all the known client users for a specified</p>
				83	<p class="toc_element">
				84	<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
				85	<p class="firstline">Retrieves the next page of results.</p>
				86	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	87	<code><a href="#update">update(accountId, clientAccountId, userId, body=None, x__xgafv=None)</a></code></p>
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	88	<p class="firstline">Updates an existing client user.</p>
				89	<h3>Method Details</h3>
				90	<div class="method">
Thomas Coffee	2f24537	2017-03-27 10:39:26 -0700	[diff] [blame]	91	<code class="details" id="get">get(accountId, clientAccountId, userId, x__xgafv=None)</code>
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	92	<pre>Retrieves an existing client user.
				93
				94	Args:
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	95	accountId: string, Numerical account ID of the client's sponsor buyer. (required) (required)
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	96	clientAccountId: string, Numerical account ID of the client buyer
				97	that the user to be retrieved is associated with. (required) (required)
				98	userId: string, Numerical identifier of the user to retrieve. (required) (required)
				99	x__xgafv: string, V1 error format.
				100	Allowed values
				101	1 - v1 error format
				102	2 - v2 error format
				103
				104	Returns:
				105	An object of the form:
				106
				107	{ # A client user is created under a client buyer and has restricted access to
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	108	# the Marketplace and certain other sections of the Authorized Buyers UI based
				109	# on the role granted to the associated client buyer.
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	110	#
				111	# The only way a new client user can be created is via accepting an
				112	# email invitation
				113	# (see the
				114	# accounts.clients.invitations.create
				115	# method).
				116	#
				117	# All fields are required unless otherwise specified.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	118	"clientAccountId": "A String", # Numerical account ID of the client buyer
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	119	# with which the user is associated; the
				120	# buyer must be a client of the current sponsor buyer.
				121	# The value of this field is ignored in an update operation.
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame]	122	"userId": "A String", # The unique numerical ID of the client user
				123	# that has accepted an invitation.
				124	# The value of this field is ignored in an update operation.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	125	"status": "A String", # The status of the client user.
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame]	126	"email": "A String", # User's email address. The value of this field
				127	# is ignored in an update operation.
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	128	}</pre>
				129	</div>
				130
				131	<div class="method">
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	132	<code class="details" id="list">list(accountId, clientAccountId, pageToken=None, pageSize=None, x__xgafv=None)</code>
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	133	<pre>Lists all the known client users for a specified
				134	sponsor buyer account ID.
				135
				136	Args:
				137	accountId: string, Numerical account ID of the sponsor buyer of the client to list users for.
				138	(required) (required)
				139	clientAccountId: string, The account ID of the client buyer to list users for. (required)
				140	You must specify either a string representation of a
				141	numerical account identifier or the `-` character
				142	to list all the client users for all the clients
				143	of a given sponsor buyer. (required)
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	144	pageToken: string, A token identifying a page of results the server should return.
				145	Typically, this is the value of
				146	ListClientUsersResponse.nextPageToken
				147	returned from the previous call to the
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	148	accounts.clients.users.list
				149	method.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	150	pageSize: integer, Requested page size. The server may return fewer clients than requested.
				151	If unspecified, the server will pick an appropriate default.
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	152	x__xgafv: string, V1 error format.
				153	Allowed values
				154	1 - v1 error format
				155	2 - v2 error format
				156
				157	Returns:
				158	An object of the form:
				159
				160	{
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	161	"nextPageToken": "A String", # A token to retrieve the next page of results.
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	162	# Pass this value in the
				163	# ListClientUsersRequest.pageToken
				164	# field in the subsequent call to the
				165	# clients.invitations.list
				166	# method to retrieve the next
				167	# page of results.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	168	"users": [ # The returned list of client users.
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	169	{ # A client user is created under a client buyer and has restricted access to
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	170	# the Marketplace and certain other sections of the Authorized Buyers UI based
				171	# on the role granted to the associated client buyer.
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	172	#
				173	# The only way a new client user can be created is via accepting an
				174	# email invitation
				175	# (see the
				176	# accounts.clients.invitations.create
				177	# method).
				178	#
				179	# All fields are required unless otherwise specified.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	180	"clientAccountId": "A String", # Numerical account ID of the client buyer
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	181	# with which the user is associated; the
				182	# buyer must be a client of the current sponsor buyer.
				183	# The value of this field is ignored in an update operation.
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame]	184	"userId": "A String", # The unique numerical ID of the client user
				185	# that has accepted an invitation.
				186	# The value of this field is ignored in an update operation.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	187	"status": "A String", # The status of the client user.
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame]	188	"email": "A String", # User's email address. The value of this field
				189	# is ignored in an update operation.
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	190	},
				191	],
				192	}</pre>
				193	</div>
				194
				195	<div class="method">
				196	<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
				197	<pre>Retrieves the next page of results.
				198
				199	Args:
				200	previous_request: The request for the previous page. (required)
				201	previous_response: The response from the request for the previous page. (required)
				202
				203	Returns:
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	204	A request object that you can call 'execute()' on to request the next
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	205	page. Returns None if there are no more items in the collection.
				206	</pre>
				207	</div>
				208
				209	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	210	<code class="details" id="update">update(accountId, clientAccountId, userId, body=None, x__xgafv=None)</code>
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	211	<pre>Updates an existing client user.
				212	Only the user status can be changed on update.
				213
				214	Args:
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	215	accountId: string, Numerical account ID of the client's sponsor buyer. (required) (required)
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	216	clientAccountId: string, Numerical account ID of the client buyer that the user to be retrieved
				217	is associated with. (required) (required)
				218	userId: string, Numerical identifier of the user to retrieve. (required) (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	219	body: object, The request body.
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	220	The object takes the form of:
				221
				222	{ # A client user is created under a client buyer and has restricted access to
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	223	# the Marketplace and certain other sections of the Authorized Buyers UI based
				224	# on the role granted to the associated client buyer.
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	225	#
				226	# The only way a new client user can be created is via accepting an
				227	# email invitation
				228	# (see the
				229	# accounts.clients.invitations.create
				230	# method).
				231	#
				232	# All fields are required unless otherwise specified.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	233	"clientAccountId": "A String", # Numerical account ID of the client buyer
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	234	# with which the user is associated; the
				235	# buyer must be a client of the current sponsor buyer.
				236	# The value of this field is ignored in an update operation.
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame]	237	"userId": "A String", # The unique numerical ID of the client user
				238	# that has accepted an invitation.
				239	# The value of this field is ignored in an update operation.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	240	"status": "A String", # The status of the client user.
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame]	241	"email": "A String", # User's email address. The value of this field
				242	# is ignored in an update operation.
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	243	}
				244
				245	x__xgafv: string, V1 error format.
				246	Allowed values
				247	1 - v1 error format
				248	2 - v2 error format
				249
				250	Returns:
				251	An object of the form:
				252
				253	{ # A client user is created under a client buyer and has restricted access to
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	254	# the Marketplace and certain other sections of the Authorized Buyers UI based
				255	# on the role granted to the associated client buyer.
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	256	#
				257	# The only way a new client user can be created is via accepting an
				258	# email invitation
				259	# (see the
				260	# accounts.clients.invitations.create
				261	# method).
				262	#
				263	# All fields are required unless otherwise specified.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	264	"clientAccountId": "A String", # Numerical account ID of the client buyer
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	265	# with which the user is associated; the
				266	# buyer must be a client of the current sponsor buyer.
				267	# The value of this field is ignored in an update operation.
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame]	268	"userId": "A String", # The unique numerical ID of the client user
				269	# that has accepted an invitation.
				270	# The value of this field is ignored in an update operation.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	271	"status": "A String", # The status of the client user.
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame]	272	"email": "A String", # User's email address. The value of this field
				273	# is ignored in an update operation.
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	274	}</pre>
				275	</div>
				276
				277	</body></html>