blob: 8f5342b97b0f05cc65cf45ff3f0835bf653eccc1 [file] [log] [blame]
Joe Gregorio075572b2012-07-09 16:53:09 -04001<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.html">Ad Exchange Buyer API</a> . <a href="adexchangebuyer_v1.accounts.html">accounts</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#get">get(id)</a></code></p>
79<p class="firstline">Gets one account by ID.</p>
80<p class="toc_element">
81 <code><a href="#list">list()</a></code></p>
82<p class="firstline">Retrieves the authenticated user's list of accounts.</p>
83<p class="toc_element">
84 <code><a href="#patch">patch(id, body)</a></code></p>
85<p class="firstline">Updates an existing account. This method supports patch semantics.</p>
86<p class="toc_element">
87 <code><a href="#update">update(id, body)</a></code></p>
88<p class="firstline">Updates an existing account.</p>
89<h3>Method Details</h3>
90<div class="method">
91 <code class="details" id="get">get(id)</code>
92 <pre>Gets one account by ID.
93
94Args:
95 id: integer, The account id (required)
96
97Returns:
98 An object of the form:
99
Joe Gregorio1b425aa2012-08-24 12:04:34 -0400100 { # Configuration data for an Ad Exchange buyer account.
Joe Gregorio075572b2012-07-09 16:53:09 -0400101 "kind": "adexchangebuyer#account", # Resource type.
102 "maximumTotalQps": 42, # The sum of all bidderLocation.maximumQps values cannot exceed this. Please contact your technical account manager if you need to change this.
103 "bidderLocation": [ # Your bidder locations that have distinct URLs.
104 {
105 "url": "A String", # The URL to which the Ad Exchange will send bid requests.
106 "maximumQps": 42, # The maximum queries per second the Ad Exchange will send.
107 },
108 ],
109 "cookieMatchingNid": "A String", # The nid parameter value used in cookie match requests. Please contact your technical account manager if you need to change this.
110 "id": 42, # Account id.
111 "cookieMatchingUrl": "A String", # The base URL used in cookie match requests.
112 }</pre>
113</div>
114
115<div class="method">
116 <code class="details" id="list">list()</code>
117 <pre>Retrieves the authenticated user's list of accounts.
118
119Args:
120
121Returns:
122 An object of the form:
123
Joe Gregorio1b425aa2012-08-24 12:04:34 -0400124 { # 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.
Joe Gregorio075572b2012-07-09 16:53:09 -0400125 "items": [ # A list of accounts.
Joe Gregorio1b425aa2012-08-24 12:04:34 -0400126 { # Configuration data for an Ad Exchange buyer account.
Joe Gregorio075572b2012-07-09 16:53:09 -0400127 "kind": "adexchangebuyer#account", # Resource type.
128 "maximumTotalQps": 42, # The sum of all bidderLocation.maximumQps values cannot exceed this. Please contact your technical account manager if you need to change this.
129 "bidderLocation": [ # Your bidder locations that have distinct URLs.
130 {
131 "url": "A String", # The URL to which the Ad Exchange will send bid requests.
132 "maximumQps": 42, # The maximum queries per second the Ad Exchange will send.
133 },
134 ],
135 "cookieMatchingNid": "A String", # The nid parameter value used in cookie match requests. Please contact your technical account manager if you need to change this.
136 "id": 42, # Account id.
137 "cookieMatchingUrl": "A String", # The base URL used in cookie match requests.
138 },
139 ],
140 "kind": "adexchangebuyer#accountsList", # Resource type.
141 }</pre>
142</div>
143
144<div class="method">
145 <code class="details" id="patch">patch(id, body)</code>
146 <pre>Updates an existing account. This method supports patch semantics.
147
148Args:
149 id: integer, The account id (required)
150 body: object, The request body. (required)
151 The object takes the form of:
152
Joe Gregorio1b425aa2012-08-24 12:04:34 -0400153{ # Configuration data for an Ad Exchange buyer account.
Joe Gregorio075572b2012-07-09 16:53:09 -0400154 "kind": "adexchangebuyer#account", # Resource type.
155 "maximumTotalQps": 42, # The sum of all bidderLocation.maximumQps values cannot exceed this. Please contact your technical account manager if you need to change this.
156 "bidderLocation": [ # Your bidder locations that have distinct URLs.
157 {
158 "url": "A String", # The URL to which the Ad Exchange will send bid requests.
159 "maximumQps": 42, # The maximum queries per second the Ad Exchange will send.
160 },
161 ],
162 "cookieMatchingNid": "A String", # The nid parameter value used in cookie match requests. Please contact your technical account manager if you need to change this.
163 "id": 42, # Account id.
164 "cookieMatchingUrl": "A String", # The base URL used in cookie match requests.
165 }
166
167
168Returns:
169 An object of the form:
170
Joe Gregorio1b425aa2012-08-24 12:04:34 -0400171 { # Configuration data for an Ad Exchange buyer account.
Joe Gregorio075572b2012-07-09 16:53:09 -0400172 "kind": "adexchangebuyer#account", # Resource type.
173 "maximumTotalQps": 42, # The sum of all bidderLocation.maximumQps values cannot exceed this. Please contact your technical account manager if you need to change this.
174 "bidderLocation": [ # Your bidder locations that have distinct URLs.
175 {
176 "url": "A String", # The URL to which the Ad Exchange will send bid requests.
177 "maximumQps": 42, # The maximum queries per second the Ad Exchange will send.
178 },
179 ],
180 "cookieMatchingNid": "A String", # The nid parameter value used in cookie match requests. Please contact your technical account manager if you need to change this.
181 "id": 42, # Account id.
182 "cookieMatchingUrl": "A String", # The base URL used in cookie match requests.
183 }</pre>
184</div>
185
186<div class="method">
187 <code class="details" id="update">update(id, body)</code>
188 <pre>Updates an existing account.
189
190Args:
191 id: integer, The account id (required)
192 body: object, The request body. (required)
193 The object takes the form of:
194
Joe Gregorio1b425aa2012-08-24 12:04:34 -0400195{ # Configuration data for an Ad Exchange buyer account.
Joe Gregorio075572b2012-07-09 16:53:09 -0400196 "kind": "adexchangebuyer#account", # Resource type.
197 "maximumTotalQps": 42, # The sum of all bidderLocation.maximumQps values cannot exceed this. Please contact your technical account manager if you need to change this.
198 "bidderLocation": [ # Your bidder locations that have distinct URLs.
199 {
200 "url": "A String", # The URL to which the Ad Exchange will send bid requests.
201 "maximumQps": 42, # The maximum queries per second the Ad Exchange will send.
202 },
203 ],
204 "cookieMatchingNid": "A String", # The nid parameter value used in cookie match requests. Please contact your technical account manager if you need to change this.
205 "id": 42, # Account id.
206 "cookieMatchingUrl": "A String", # The base URL used in cookie match requests.
207 }
208
209
210Returns:
211 An object of the form:
212
Joe Gregorio1b425aa2012-08-24 12:04:34 -0400213 { # Configuration data for an Ad Exchange buyer account.
Joe Gregorio075572b2012-07-09 16:53:09 -0400214 "kind": "adexchangebuyer#account", # Resource type.
215 "maximumTotalQps": 42, # The sum of all bidderLocation.maximumQps values cannot exceed this. Please contact your technical account manager if you need to change this.
216 "bidderLocation": [ # Your bidder locations that have distinct URLs.
217 {
218 "url": "A String", # The URL to which the Ad Exchange will send bid requests.
219 "maximumQps": 42, # The maximum queries per second the Ad Exchange will send.
220 },
221 ],
222 "cookieMatchingNid": "A String", # The nid parameter value used in cookie match requests. Please contact your technical account manager if you need to change this.
223 "id": 42, # Account id.
224 "cookieMatchingUrl": "A String", # The base URL used in cookie match requests.
225 }</pre>
226</div>
227
228</body></html>