Blame - docs/dyn/adexchangebuyer2_v2beta1.accounts.creatives.dealAssociations.html - platform/external/python/google-api-python-client

blob: 032fea11fd324d404a8c971be4418eaf62107bce [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="adexchangebuyer2_v2beta1.html">Ad Exchange Buyer API II</a> . <a href="adexchangebuyer2_v2beta1.accounts.html">accounts</a> . <a href="adexchangebuyer2_v2beta1.accounts.creatives.html">creatives</a> . <a href="adexchangebuyer2_v2beta1.accounts.creatives.dealAssociations.html">dealAssociations</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="#add">add(accountId, creativeId, body=None, x__xgafv=None)</a></code></p>
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	79	<p class="firstline">Associate an existing deal with a creative.</p>
				80	<p class="toc_element">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	81	<code><a href="#close">close()</a></code></p>
				82	<p class="firstline">Close httplib2 connections.</p>
				83	<p class="toc_element">
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	84	<code><a href="#list">list(accountId, creativeId, query=None, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p>
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	85	<p class="firstline">List all creative-deal associations.</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	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	90	<code><a href="#remove">remove(accountId, creativeId, body=None, x__xgafv=None)</a></code></p>
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	91	<p class="firstline">Remove the association between a deal and a creative.</p>
				92	<h3>Method Details</h3>
				93	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	94	<code class="details" id="add">add(accountId, creativeId, body=None, x__xgafv=None)</code>
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	95	<pre>Associate an existing deal with a creative.
				96
				97	Args:
				98	accountId: string, The account the creative belongs to. (required)
				99	creativeId: string, The ID of the creative associated with the deal. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	100	body: object, The request body.
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	101	The object takes the form of:
				102
				103	{ # A request for associating a deal and a creative.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	104	"association": { # The association between a creative and a deal. # The association between a creative and a deal that should be added.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	105	"creativeId": "A String", # The ID of the creative associated with the deal.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	106	"accountId": "A String", # The account the creative belongs to.
				107	"dealsId": "A String", # The externalDealId for the deal associated with the creative.
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	108	},
				109	}
				110
				111	x__xgafv: string, V1 error format.
				112	Allowed values
				113	1 - v1 error format
				114	2 - v2 error format
				115
				116	Returns:
				117	An object of the form:
				118
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	119	{ # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	120	}</pre>
				121	</div>
				122
				123	<div class="method">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	124	<code class="details" id="close">close()</code>
				125	<pre>Close httplib2 connections.</pre>
				126	</div>
				127
				128	<div class="method">
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	129	<code class="details" id="list">list(accountId, creativeId, query=None, pageToken=None, pageSize=None, x__xgafv=None)</code>
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	130	<pre>List all creative-deal associations.
				131
				132	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	133	accountId: string, The account to list the associations from. Specify "-" to list all creatives the current user has access to. (required)
				134	creativeId: string, The creative ID to list the associations from. Specify "-" to list all creatives under the above account. (required)
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	135	query: string, An optional query string to filter deal associations. If no filter is specified, all associations will be returned. Supported queries are: - accountId=account_id_string - creativeId=creative_id_string - dealsId=deals_id_string - dealsStatus:{approved, conditionally_approved, disapproved, not_checked} - openAuctionStatus:{approved, conditionally_approved, disapproved, not_checked} Example: 'dealsId=12345 AND dealsStatus:disapproved'
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	136	pageToken: string, A token identifying a page of results the server should return. Typically, this is the value of ListDealAssociationsResponse.next_page_token returned from the previous call to 'ListDealAssociations' method.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	137	pageSize: integer, Requested page size. Server may return fewer associations than requested. If unspecified, server will pick an appropriate default.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	138	x__xgafv: string, V1 error format.
				139	Allowed values
				140	1 - v1 error format
				141	2 - v2 error format
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	142
				143	Returns:
				144	An object of the form:
				145
				146	{ # A response for listing creative and deal associations
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	147	"associations": [ # The list of associations.
				148	{ # The association between a creative and a deal.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	149	"creativeId": "A String", # The ID of the creative associated with the deal.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	150	"accountId": "A String", # The account the creative belongs to.
				151	"dealsId": "A String", # The externalDealId for the deal associated with the creative.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	152	},
				153	],
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	154	"nextPageToken": "A String", # A token to retrieve the next page of results. Pass this value in the ListDealAssociationsRequest.page_token field in the subsequent call to 'ListDealAssociation' method to retrieve the next page of results.
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	155	}</pre>
				156	</div>
				157
				158	<div class="method">
				159	<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
				160	<pre>Retrieves the next page of results.
				161
				162	Args:
				163	previous_request: The request for the previous page. (required)
				164	previous_response: The response from the request for the previous page. (required)
				165
				166	Returns:
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	167	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]	168	page. Returns None if there are no more items in the collection.
				169	</pre>
				170	</div>
				171
				172	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	173	<code class="details" id="remove">remove(accountId, creativeId, body=None, x__xgafv=None)</code>
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	174	<pre>Remove the association between a deal and a creative.
				175
				176	Args:
				177	accountId: string, The account the creative belongs to. (required)
				178	creativeId: string, The ID of the creative associated with the deal. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	179	body: object, The request body.
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	180	The object takes the form of:
				181
				182	{ # A request for removing the association between a deal and a creative.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	183	"association": { # The association between a creative and a deal. # The association between a creative and a deal that should be removed.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	184	"creativeId": "A String", # The ID of the creative associated with the deal.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	185	"accountId": "A String", # The account the creative belongs to.
				186	"dealsId": "A String", # The externalDealId for the deal associated with the creative.
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	187	},
				188	}
				189
				190	x__xgafv: string, V1 error format.
				191	Allowed values
				192	1 - v1 error format
				193	2 - v2 error format
				194
				195	Returns:
				196	An object of the form:
				197
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	198	{ # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	199	}</pre>
				200	</div>
				201
				202	</body></html>