Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / a527de24cda7c7d62a371203158fd5f617a1c08c / . / docs / dyn / adexchangebuyer2_v2beta1.accounts.creatives.dealAssociations.html
blob: 984d29b6221ce7437a139b1a0ad2da788233ef40 [file] [log] [blame]
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1<html><body>
2<style>
3
4body, 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
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, 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'Mearadd494642020-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 Cheemalapatic30d2b52017-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">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]81 <code><a href="#list">list(accountId, creativeId, pageToken=None, pageSize=None, query=None, x__xgafv=None)</a></code></p>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]82<p class="firstline">List all creative-deal associations.</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'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]87 <code><a href="#remove">remove(accountId, creativeId, body=None, x__xgafv=None)</a></code></p>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]88<p class="firstline">Remove the association between a deal and a creative.</p>
89<h3>Method Details</h3>
90<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]91 <code class="details" id="add">add(accountId, creativeId, body=None, x__xgafv=None)</code>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]92 <pre>Associate an existing deal with a creative.
93
94Args:
95 accountId: string, The account the creative belongs to. (required)
96 creativeId: string, The ID of the creative associated with the deal. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]97 body: object, The request body.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]98 The object takes the form of:
99
100{ # A request for associating a deal and a creative.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]101 &quot;association&quot;: { # The association between a creative and a deal. # The association between a creative and a deal that should be added.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]102 &quot;creativeId&quot;: &quot;A String&quot;, # The ID of the creative associated with the deal.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]103 &quot;accountId&quot;: &quot;A String&quot;, # The account the creative belongs to.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]104 &quot;dealsId&quot;: &quot;A String&quot;, # The externalDealId for the deal associated with the creative.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]105 },
106 }
107
108 x__xgafv: string, V1 error format.
109 Allowed values
110 1 - v1 error format
111 2 - v2 error format
112
113Returns:
114 An object of the form:
115
116 { # A generic empty message that you can re-use to avoid defining duplicated
117 # empty messages in your APIs. A typical example is to use it as the request
118 # or the response type of an API method. For instance:
119 #
120 # service Foo {
121 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
122 # }
123 #
124 # The JSON representation for `Empty` is empty JSON object `{}`.
125 }</pre>
126</div>
127
128<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]129 <code class="details" id="list">list(accountId, creativeId, pageToken=None, pageSize=None, query=None, x__xgafv=None)</code>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]130 <pre>List all creative-deal associations.
131
132Args:
133 accountId: string, The account to list the associations from.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]134Specify &quot;-&quot; to list all creatives the current user has access to. (required)
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]135 creativeId: string, The creative ID to list the associations from.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]136Specify &quot;-&quot; to list all creatives under the above account. (required)
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]137 pageToken: string, A token identifying a page of results the server should return.
138Typically, this is the value of
139ListDealAssociationsResponse.next_page_token
140returned from the previous call to &#x27;ListDealAssociations&#x27; method.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]141 pageSize: integer, Requested page size. Server may return fewer associations than requested.
142If unspecified, server will pick an appropriate default.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]143 query: string, An optional query string to filter deal associations. If no filter is
144specified, all associations will be returned.
145Supported queries are:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]146&lt;ul&gt;
147&lt;li&gt;accountId=&lt;i&gt;account_id_string&lt;/i&gt;
148&lt;li&gt;creativeId=&lt;i&gt;creative_id_string&lt;/i&gt;
149&lt;li&gt;dealsId=&lt;i&gt;deals_id_string&lt;/i&gt;
150&lt;li&gt;dealsStatus:{approved, conditionally_approved, disapproved,
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]151 not_checked}
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]152&lt;li&gt;openAuctionStatus:{approved, conditionally_approved, disapproved,
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]153 not_checked}
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]154&lt;/ul&gt;
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]155Example: &#x27;dealsId=12345 AND dealsStatus:disapproved&#x27;
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]156 x__xgafv: string, V1 error format.
157 Allowed values
158 1 - v1 error format
159 2 - v2 error format
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]160
161Returns:
162 An object of the form:
163
164 { # A response for listing creative and deal associations
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]165 &quot;associations&quot;: [ # The list of associations.
166 { # The association between a creative and a deal.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]167 &quot;creativeId&quot;: &quot;A String&quot;, # The ID of the creative associated with the deal.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]168 &quot;accountId&quot;: &quot;A String&quot;, # The account the creative belongs to.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]169 &quot;dealsId&quot;: &quot;A String&quot;, # The externalDealId for the deal associated with the creative.
170 },
171 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]172 &quot;nextPageToken&quot;: &quot;A String&quot;, # A token to retrieve the next page of results.
173 # Pass this value in the
174 # ListDealAssociationsRequest.page_token
175 # field in the subsequent call to &#x27;ListDealAssociation&#x27; method to retrieve
176 # the next page of results.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]177 }</pre>
178</div>
179
180<div class="method">
181 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
182 <pre>Retrieves the next page of results.
183
184Args:
185 previous_request: The request for the previous page. (required)
186 previous_response: The response from the request for the previous page. (required)
187
188Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]189 A request object that you can call &#x27;execute()&#x27; on to request the next
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]190 page. Returns None if there are no more items in the collection.
191 </pre>
192</div>
193
194<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]195 <code class="details" id="remove">remove(accountId, creativeId, body=None, x__xgafv=None)</code>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]196 <pre>Remove the association between a deal and a creative.
197
198Args:
199 accountId: string, The account the creative belongs to. (required)
200 creativeId: string, The ID of the creative associated with the deal. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]201 body: object, The request body.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]202 The object takes the form of:
203
204{ # A request for removing the association between a deal and a creative.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]205 &quot;association&quot;: { # The association between a creative and a deal. # The association between a creative and a deal that should be removed.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]206 &quot;creativeId&quot;: &quot;A String&quot;, # The ID of the creative associated with the deal.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]207 &quot;accountId&quot;: &quot;A String&quot;, # The account the creative belongs to.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]208 &quot;dealsId&quot;: &quot;A String&quot;, # The externalDealId for the deal associated with the creative.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]209 },
210 }
211
212 x__xgafv: string, V1 error format.
213 Allowed values
214 1 - v1 error format
215 2 - v2 error format
216
217Returns:
218 An object of the form:
219
220 { # A generic empty message that you can re-use to avoid defining duplicated
221 # empty messages in your APIs. A typical example is to use it as the request
222 # or the response type of an API method. For instance:
223 #
224 # service Foo {
225 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
226 # }
227 #
228 # The JSON representation for `Empty` is empty JSON object `{}`.
229 }</pre>
230</div>
231
232</body></html>