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

blob: 7d1bf2ea7fc16273865f584e6e40a43feeb3e69b [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.invitations.html">invitations</a></h1>
				76	<h2>Instance Methods</h2>
				77	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	78	<code><a href="#create">create(accountId, clientAccountId, body=None, x__xgafv=None)</a></code></p>
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	79	<p class="firstline">Creates and sends out an email invitation to access</p>
				80	<p class="toc_element">
Thomas Coffee	2f24537	2017-03-27 10:39:26 -0700	[diff] [blame]	81	<code><a href="#get">get(accountId, clientAccountId, invitationId, x__xgafv=None)</a></code></p>
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	82	<p class="firstline">Retrieves an existing client user invitation.</p>
				83	<p class="toc_element">
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame]	84	<code><a href="#list">list(accountId, clientAccountId, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	85	<p class="firstline">Lists all the client users invitations for a client</p>
				86	<p class="toc_element">
				87	<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
				88	<p class="firstline">Retrieves the next page of results.</p>
				89	<h3>Method Details</h3>
				90	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	91	<code class="details" id="create">create(accountId, clientAccountId, body=None, x__xgafv=None)</code>
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	92	<pre>Creates and sends out an email invitation to access
				93	an Ad Exchange client buyer account.
				94
				95	Args:
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	96	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]	97	clientAccountId: string, Numerical account ID of the client buyer that the user
				98	should be associated with. (required) (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	99	body: object, The request body.
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	100	The object takes the form of:
				101
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	102	{ # An invitation for a new client user to get access to the Authorized Buyers
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	103	# UI. All fields are required unless otherwise specified.
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame]	104	"email": "A String", # The email address to which the invitation is sent. Email
				105	# addresses should be unique among all client users under each sponsor
				106	# buyer.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	107	"clientAccountId": "A String", # Numerical account ID of the client buyer
				108	# that the invited user is associated with.
				109	# The value of this field is ignored in create operations.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	110	"invitationId": "A String", # The unique numerical ID of the invitation that is sent to the user.
				111	# The value of this field is ignored in create operations.
				112	}
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	113
				114	x__xgafv: string, V1 error format.
				115	Allowed values
				116	1 - v1 error format
				117	2 - v2 error format
				118
				119	Returns:
				120	An object of the form:
				121
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	122	{ # An invitation for a new client user to get access to the Authorized Buyers
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	123	# UI. All fields are required unless otherwise specified.
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame]	124	"email": "A String", # The email address to which the invitation is sent. Email
				125	# addresses should be unique among all client users under each sponsor
				126	# buyer.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	127	"clientAccountId": "A String", # Numerical account ID of the client buyer
				128	# that the invited user is associated with.
				129	# The value of this field is ignored in create operations.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	130	"invitationId": "A String", # The unique numerical ID of the invitation that is sent to the user.
				131	# The value of this field is ignored in create operations.
				132	}</pre>
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	133	</div>
				134
				135	<div class="method">
Thomas Coffee	2f24537	2017-03-27 10:39:26 -0700	[diff] [blame]	136	<code class="details" id="get">get(accountId, clientAccountId, invitationId, x__xgafv=None)</code>
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	137	<pre>Retrieves an existing client user invitation.
				138
				139	Args:
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	140	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]	141	clientAccountId: string, Numerical account ID of the client buyer that the user invitation
				142	to be retrieved is associated with. (required) (required)
				143	invitationId: string, Numerical identifier of the user invitation to retrieve. (required) (required)
				144	x__xgafv: string, V1 error format.
				145	Allowed values
				146	1 - v1 error format
				147	2 - v2 error format
				148
				149	Returns:
				150	An object of the form:
				151
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	152	{ # An invitation for a new client user to get access to the Authorized Buyers
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	153	# UI. All fields are required unless otherwise specified.
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame]	154	"email": "A String", # The email address to which the invitation is sent. Email
				155	# addresses should be unique among all client users under each sponsor
				156	# buyer.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	157	"clientAccountId": "A String", # Numerical account ID of the client buyer
				158	# that the invited user is associated with.
				159	# The value of this field is ignored in create operations.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	160	"invitationId": "A String", # The unique numerical ID of the invitation that is sent to the user.
				161	# The value of this field is ignored in create operations.
				162	}</pre>
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	163	</div>
				164
				165	<div class="method">
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame]	166	<code class="details" id="list">list(accountId, clientAccountId, pageSize=None, pageToken=None, x__xgafv=None)</code>
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	167	<pre>Lists all the client users invitations for a client
				168	with a given account ID.
				169
				170	Args:
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	171	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]	172	clientAccountId: string, Numerical account ID of the client buyer to list invitations for.
				173	(required)
				174	You must either specify a string representation of a
				175	numerical account identifier or the `-` character
				176	to list all the invitations for all the clients
				177	of a given sponsor buyer. (required)
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame]	178	pageSize: integer, Requested page size. Server may return fewer clients than requested.
				179	If unspecified, server will pick an appropriate default.
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	180	pageToken: string, A token identifying a page of results the server should return.
				181	Typically, this is the value of
				182	ListClientUserInvitationsResponse.nextPageToken
				183	returned from the previous call to the
				184	clients.invitations.list
				185	method.
				186	x__xgafv: string, V1 error format.
				187	Allowed values
				188	1 - v1 error format
				189	2 - v2 error format
				190
				191	Returns:
				192	An object of the form:
				193
				194	{
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame]	195	"invitations": [ # The returned list of client users.
				196	{ # An invitation for a new client user to get access to the Authorized Buyers
				197	# UI. All fields are required unless otherwise specified.
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame]	198	"email": "A String", # The email address to which the invitation is sent. Email
				199	# addresses should be unique among all client users under each sponsor
				200	# buyer.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	201	"clientAccountId": "A String", # Numerical account ID of the client buyer
				202	# that the invited user is associated with.
				203	# The value of this field is ignored in create operations.
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame]	204	"invitationId": "A String", # The unique numerical ID of the invitation that is sent to the user.
				205	# The value of this field is ignored in create operations.
				206	},
				207	],
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	208	"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]	209	# Pass this value in the
				210	# ListClientUserInvitationsRequest.pageToken
				211	# field in the subsequent call to the
				212	# clients.invitations.list
				213	# method to retrieve the next
				214	# page of results.
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	215	}</pre>
				216	</div>
				217
				218	<div class="method">
				219	<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
				220	<pre>Retrieves the next page of results.
				221
				222	Args:
				223	previous_request: The request for the previous page. (required)
				224	previous_response: The response from the request for the previous page. (required)
				225
				226	Returns:
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	227	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]	228	page. Returns None if there are no more items in the collection.
				229	</pre>
				230	</div>
				231
				232	</body></html>