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

blob: 0736c68390ffd4428b8a5d8961534e81eb70183e [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">
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(accountId, clientAccountId, body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	82	<p class="firstline">Creates and sends out an email invitation to access an Ad Exchange client buyer account.</p>
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	83	<p class="toc_element">
Thomas Coffee	2f24537	2017-03-27 10:39:26 -0700	[diff] [blame]	84	<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]	85	<p class="firstline">Retrieves an existing client user invitation.</p>
				86	<p class="toc_element">
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	87	<code><a href="#list">list(accountId, clientAccountId, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	88	<p class="firstline">Lists all the client users invitations for a client with a given account ID.</p>
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	89	<p class="toc_element">
				90	<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
				91	<p class="firstline">Retrieves the next page of results.</p>
				92	<h3>Method Details</h3>
				93	<div class="method">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	94	<code class="details" id="close">close()</code>
				95	<pre>Close httplib2 connections.</pre>
				96	</div>
				97
				98	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	99	<code class="details" id="create">create(accountId, clientAccountId, body=None, x__xgafv=None)</code>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	100	<pre>Creates and sends out an email invitation to access an Ad Exchange client buyer account.
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	101
				102	Args:
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	103	accountId: string, Numerical account ID of the client's sponsor buyer. (required) (required)
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	104	clientAccountId: string, Numerical account ID of the client buyer that the user should be associated with. (required) (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	105	body: object, The request body.
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	106	The object takes the form of:
				107
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	108	{ # An invitation for a new client user to get access to the Authorized Buyers UI. All fields are required unless otherwise specified.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	109	"clientAccountId": "A String", # Numerical account ID of the client buyer that the invited user is associated with. The value of this field is ignored in create operations.
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	110	"email": "A String", # The email address to which the invitation is sent. Email addresses should be unique among all client users under each sponsor buyer.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	111	"invitationId": "A String", # The unique numerical ID of the invitation that is sent to the user. The value of this field is ignored in create operations.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	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
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	122	{ # An invitation for a new client user to get access to the Authorized Buyers UI. All fields are required unless otherwise specified.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	123	"clientAccountId": "A String", # Numerical account ID of the client buyer that the invited user is associated with. The value of this field is ignored in create operations.
				124	"email": "A String", # The email address to which the invitation is sent. Email addresses should be unique among all client users under each sponsor buyer.
				125	"invitationId": "A String", # The unique numerical ID of the invitation that is sent to the user. The value of this field is ignored in create operations.
				126	}</pre>
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	127	</div>
				128
				129	<div class="method">
Thomas Coffee	2f24537	2017-03-27 10:39:26 -0700	[diff] [blame]	130	<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]	131	<pre>Retrieves an existing client user invitation.
				132
				133	Args:
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	134	accountId: string, Numerical account ID of the client's sponsor buyer. (required) (required)
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	135	clientAccountId: string, Numerical account ID of the client buyer that the user invitation to be retrieved is associated with. (required) (required)
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	136	invitationId: string, Numerical identifier of the user invitation to retrieve. (required) (required)
				137	x__xgafv: string, V1 error format.
				138	Allowed values
				139	1 - v1 error format
				140	2 - v2 error format
				141
				142	Returns:
				143	An object of the form:
				144
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	145	{ # An invitation for a new client user to get access to the Authorized Buyers UI. All fields are required unless otherwise specified.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	146	"clientAccountId": "A String", # Numerical account ID of the client buyer that the invited user is associated with. The value of this field is ignored in create operations.
				147	"email": "A String", # The email address to which the invitation is sent. Email addresses should be unique among all client users under each sponsor buyer.
				148	"invitationId": "A String", # The unique numerical ID of the invitation that is sent to the user. The value of this field is ignored in create operations.
				149	}</pre>
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	150	</div>
				151
				152	<div class="method">
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	153	<code class="details" id="list">list(accountId, clientAccountId, pageSize=None, pageToken=None, x__xgafv=None)</code>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	154	<pre>Lists all the client users invitations for a client with a given account ID.
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	155
				156	Args:
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	157	accountId: string, Numerical account ID of the client's sponsor buyer. (required) (required)
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	158	clientAccountId: string, Numerical account ID of the client buyer to list invitations for. (required) You must either specify a string representation of a numerical account identifier or the `-` character to list all the invitations for all the clients of a given sponsor buyer. (required)
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	159	pageSize: integer, Requested page size. Server may return fewer clients than requested. If unspecified, server will pick an appropriate default.
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	160	pageToken: string, A token identifying a page of results the server should return. Typically, this is the value of ListClientUserInvitationsResponse.nextPageToken returned from the previous call to the clients.invitations.list method.
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	161	x__xgafv: string, V1 error format.
				162	Allowed values
				163	1 - v1 error format
				164	2 - v2 error format
				165
				166	Returns:
				167	An object of the form:
				168
				169	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	170	"invitations": [ # The returned list of client users.
				171	{ # An invitation for a new client user to get access to the Authorized Buyers UI. All fields are required unless otherwise specified.
				172	"clientAccountId": "A String", # Numerical account ID of the client buyer that the invited user is associated with. The value of this field is ignored in create operations.
				173	"email": "A String", # The email address to which the invitation is sent. Email addresses should be unique among all client users under each sponsor buyer.
				174	"invitationId": "A String", # The unique numerical ID of the invitation that is sent to the user. The value of this field is ignored in create operations.
				175	},
				176	],
				177	"nextPageToken": "A String", # A token to retrieve the next page of results. Pass this value in the ListClientUserInvitationsRequest.pageToken field in the subsequent call to the clients.invitations.list method to retrieve the next page of results.
				178	}</pre>
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	179	</div>
				180
				181	<div class="method">
				182	<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
				183	<pre>Retrieves the next page of results.
				184
				185	Args:
				186	previous_request: The request for the previous page. (required)
				187	previous_response: The response from the request for the previous page. (required)
				188
				189	Returns:
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	190	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]	191	page. Returns None if there are no more items in the collection.
				192	</pre>
				193	</div>
				194
				195	</body></html>