Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 26aa9e282e30ca9c8797ee5346cbe9c0b9ca65a7 / . / docs / dyn / adexchangebuyer_v1_2.accounts.html
blob: db1693a4a0ee2dcb4de2281e0305760fa686ec2f [file] [log] [blame]
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[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="adexchangebuyer_v1_2.html">Ad Exchange Buyer API</a> . <a href="adexchangebuyer_v1_2.accounts.html">accounts</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Dmitry Frenkel3e17f892020-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">
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]81 <code><a href="#get">get(id)</a></code></p>
82<p class="firstline">Gets one account by ID.</p>
83<p class="toc_element">
84 <code><a href="#list">list()</a></code></p>
85<p class="firstline">Retrieves the authenticated user's list of accounts.</p>
86<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]87 <code><a href="#patch">patch(id, body=None)</a></code></p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]88<p class="firstline">Updates an existing account. This method supports patch semantics.</p>
89<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]90 <code><a href="#update">update(id, body=None)</a></code></p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]91<p class="firstline">Updates an existing account.</p>
92<h3>Method Details</h3>
93<div class="method">
Dmitry Frenkel3e17f892020-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">
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]99 <code class="details" id="get">get(id)</code>
100 <pre>Gets one account by ID.
101
102Args:
103 id: integer, The account id (required)
104
105Returns:
106 An object of the form:
107
108 { # Configuration data for an Ad Exchange buyer account.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]109 &quot;bidderLocation&quot;: [ # Your bidder locations that have distinct URLs.
110 {
111 &quot;maximumQps&quot;: 42, # The maximum queries per second the Ad Exchange will send.
112 &quot;region&quot;: &quot;A String&quot;, # The geographical region the Ad Exchange should send requests from. Only used by some quota systems, but always setting the value is recommended. Allowed values:
113 # - ASIA
114 # - EUROPE
115 # - US_EAST
116 # - US_WEST
117 &quot;url&quot;: &quot;A String&quot;, # The URL to which the Ad Exchange will send bid requests.
118 },
119 ],
120 &quot;cookieMatchingNid&quot;: &quot;A String&quot;, # The nid parameter value used in cookie match requests. Please contact your technical account manager if you need to change this.
121 &quot;cookieMatchingUrl&quot;: &quot;A String&quot;, # The base URL used in cookie match requests.
122 &quot;id&quot;: 42, # Account id.
123 &quot;kind&quot;: &quot;adexchangebuyer#account&quot;, # Resource type.
124 &quot;maximumActiveCreatives&quot;: 42, # The maximum number of active creatives that an account can have, where a creative is active if it was inserted or bid with in the last 30 days. Please contact your technical account manager if you need to change this.
125 &quot;maximumTotalQps&quot;: 42, # The sum of all bidderLocation.maximumQps values cannot exceed this. Please contact your technical account manager if you need to change this.
126 &quot;numberActiveCreatives&quot;: 42, # The number of creatives that this account inserted or bid with in the last 30 days.
127}</pre>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]128</div>
129
130<div class="method">
131 <code class="details" id="list">list()</code>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]132 <pre>Retrieves the authenticated user&#x27;s list of accounts.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]133
134Args:
135
136Returns:
137 An object of the form:
138
139 { # An account feed lists Ad Exchange buyer accounts that the user has access to. Each entry in the feed corresponds to a single buyer account.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]140 &quot;items&quot;: [ # A list of accounts.
141 { # Configuration data for an Ad Exchange buyer account.
142 &quot;bidderLocation&quot;: [ # Your bidder locations that have distinct URLs.
143 {
144 &quot;maximumQps&quot;: 42, # The maximum queries per second the Ad Exchange will send.
145 &quot;region&quot;: &quot;A String&quot;, # The geographical region the Ad Exchange should send requests from. Only used by some quota systems, but always setting the value is recommended. Allowed values:
146 # - ASIA
147 # - EUROPE
148 # - US_EAST
149 # - US_WEST
150 &quot;url&quot;: &quot;A String&quot;, # The URL to which the Ad Exchange will send bid requests.
151 },
152 ],
153 &quot;cookieMatchingNid&quot;: &quot;A String&quot;, # The nid parameter value used in cookie match requests. Please contact your technical account manager if you need to change this.
154 &quot;cookieMatchingUrl&quot;: &quot;A String&quot;, # The base URL used in cookie match requests.
155 &quot;id&quot;: 42, # Account id.
156 &quot;kind&quot;: &quot;adexchangebuyer#account&quot;, # Resource type.
157 &quot;maximumActiveCreatives&quot;: 42, # The maximum number of active creatives that an account can have, where a creative is active if it was inserted or bid with in the last 30 days. Please contact your technical account manager if you need to change this.
158 &quot;maximumTotalQps&quot;: 42, # The sum of all bidderLocation.maximumQps values cannot exceed this. Please contact your technical account manager if you need to change this.
159 &quot;numberActiveCreatives&quot;: 42, # The number of creatives that this account inserted or bid with in the last 30 days.
160 },
161 ],
162 &quot;kind&quot;: &quot;adexchangebuyer#accountsList&quot;, # Resource type.
163}</pre>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]164</div>
165
166<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]167 <code class="details" id="patch">patch(id, body=None)</code>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]168 <pre>Updates an existing account. This method supports patch semantics.
169
170Args:
171 id: integer, The account id (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]172 body: object, The request body.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]173 The object takes the form of:
174
175{ # Configuration data for an Ad Exchange buyer account.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]176 &quot;bidderLocation&quot;: [ # Your bidder locations that have distinct URLs.
177 {
178 &quot;maximumQps&quot;: 42, # The maximum queries per second the Ad Exchange will send.
179 &quot;region&quot;: &quot;A String&quot;, # The geographical region the Ad Exchange should send requests from. Only used by some quota systems, but always setting the value is recommended. Allowed values:
180 # - ASIA
181 # - EUROPE
182 # - US_EAST
183 # - US_WEST
184 &quot;url&quot;: &quot;A String&quot;, # The URL to which the Ad Exchange will send bid requests.
185 },
186 ],
187 &quot;cookieMatchingNid&quot;: &quot;A String&quot;, # The nid parameter value used in cookie match requests. Please contact your technical account manager if you need to change this.
188 &quot;cookieMatchingUrl&quot;: &quot;A String&quot;, # The base URL used in cookie match requests.
189 &quot;id&quot;: 42, # Account id.
190 &quot;kind&quot;: &quot;adexchangebuyer#account&quot;, # Resource type.
191 &quot;maximumActiveCreatives&quot;: 42, # The maximum number of active creatives that an account can have, where a creative is active if it was inserted or bid with in the last 30 days. Please contact your technical account manager if you need to change this.
192 &quot;maximumTotalQps&quot;: 42, # The sum of all bidderLocation.maximumQps values cannot exceed this. Please contact your technical account manager if you need to change this.
193 &quot;numberActiveCreatives&quot;: 42, # The number of creatives that this account inserted or bid with in the last 30 days.
194}
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]195
196
197Returns:
198 An object of the form:
199
200 { # Configuration data for an Ad Exchange buyer account.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]201 &quot;bidderLocation&quot;: [ # Your bidder locations that have distinct URLs.
202 {
203 &quot;maximumQps&quot;: 42, # The maximum queries per second the Ad Exchange will send.
204 &quot;region&quot;: &quot;A String&quot;, # The geographical region the Ad Exchange should send requests from. Only used by some quota systems, but always setting the value is recommended. Allowed values:
205 # - ASIA
206 # - EUROPE
207 # - US_EAST
208 # - US_WEST
209 &quot;url&quot;: &quot;A String&quot;, # The URL to which the Ad Exchange will send bid requests.
210 },
211 ],
212 &quot;cookieMatchingNid&quot;: &quot;A String&quot;, # The nid parameter value used in cookie match requests. Please contact your technical account manager if you need to change this.
213 &quot;cookieMatchingUrl&quot;: &quot;A String&quot;, # The base URL used in cookie match requests.
214 &quot;id&quot;: 42, # Account id.
215 &quot;kind&quot;: &quot;adexchangebuyer#account&quot;, # Resource type.
216 &quot;maximumActiveCreatives&quot;: 42, # The maximum number of active creatives that an account can have, where a creative is active if it was inserted or bid with in the last 30 days. Please contact your technical account manager if you need to change this.
217 &quot;maximumTotalQps&quot;: 42, # The sum of all bidderLocation.maximumQps values cannot exceed this. Please contact your technical account manager if you need to change this.
218 &quot;numberActiveCreatives&quot;: 42, # The number of creatives that this account inserted or bid with in the last 30 days.
219}</pre>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]220</div>
221
222<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]223 <code class="details" id="update">update(id, body=None)</code>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]224 <pre>Updates an existing account.
225
226Args:
227 id: integer, The account id (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]228 body: object, The request body.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]229 The object takes the form of:
230
231{ # Configuration data for an Ad Exchange buyer account.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]232 &quot;bidderLocation&quot;: [ # Your bidder locations that have distinct URLs.
233 {
234 &quot;maximumQps&quot;: 42, # The maximum queries per second the Ad Exchange will send.
235 &quot;region&quot;: &quot;A String&quot;, # The geographical region the Ad Exchange should send requests from. Only used by some quota systems, but always setting the value is recommended. Allowed values:
236 # - ASIA
237 # - EUROPE
238 # - US_EAST
239 # - US_WEST
240 &quot;url&quot;: &quot;A String&quot;, # The URL to which the Ad Exchange will send bid requests.
241 },
242 ],
243 &quot;cookieMatchingNid&quot;: &quot;A String&quot;, # The nid parameter value used in cookie match requests. Please contact your technical account manager if you need to change this.
244 &quot;cookieMatchingUrl&quot;: &quot;A String&quot;, # The base URL used in cookie match requests.
245 &quot;id&quot;: 42, # Account id.
246 &quot;kind&quot;: &quot;adexchangebuyer#account&quot;, # Resource type.
247 &quot;maximumActiveCreatives&quot;: 42, # The maximum number of active creatives that an account can have, where a creative is active if it was inserted or bid with in the last 30 days. Please contact your technical account manager if you need to change this.
248 &quot;maximumTotalQps&quot;: 42, # The sum of all bidderLocation.maximumQps values cannot exceed this. Please contact your technical account manager if you need to change this.
249 &quot;numberActiveCreatives&quot;: 42, # The number of creatives that this account inserted or bid with in the last 30 days.
250}
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]251
252
253Returns:
254 An object of the form:
255
256 { # Configuration data for an Ad Exchange buyer account.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]257 &quot;bidderLocation&quot;: [ # Your bidder locations that have distinct URLs.
258 {
259 &quot;maximumQps&quot;: 42, # The maximum queries per second the Ad Exchange will send.
260 &quot;region&quot;: &quot;A String&quot;, # The geographical region the Ad Exchange should send requests from. Only used by some quota systems, but always setting the value is recommended. Allowed values:
261 # - ASIA
262 # - EUROPE
263 # - US_EAST
264 # - US_WEST
265 &quot;url&quot;: &quot;A String&quot;, # The URL to which the Ad Exchange will send bid requests.
266 },
267 ],
268 &quot;cookieMatchingNid&quot;: &quot;A String&quot;, # The nid parameter value used in cookie match requests. Please contact your technical account manager if you need to change this.
269 &quot;cookieMatchingUrl&quot;: &quot;A String&quot;, # The base URL used in cookie match requests.
270 &quot;id&quot;: 42, # Account id.
271 &quot;kind&quot;: &quot;adexchangebuyer#account&quot;, # Resource type.
272 &quot;maximumActiveCreatives&quot;: 42, # The maximum number of active creatives that an account can have, where a creative is active if it was inserted or bid with in the last 30 days. Please contact your technical account manager if you need to change this.
273 &quot;maximumTotalQps&quot;: 42, # The sum of all bidderLocation.maximumQps values cannot exceed this. Please contact your technical account manager if you need to change this.
274 &quot;numberActiveCreatives&quot;: 42, # The number of creatives that this account inserted or bid with in the last 30 days.
275}</pre>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]276</div>
277
278</body></html>