Skip to content

Commit 0669410

Browse files
author
Takashi Matsuo
committed
Update docs for 1.4.2 release
1 parent c1f8bed commit 0669410

File tree

420 files changed

+71531
-10544
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

420 files changed

+71531
-10544
lines changed
+270
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,270 @@
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="adexchangebuyer_v1_4.html">Ad Exchange Buyer API</a> . <a href="adexchangebuyer_v1_4.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+
94+
Args:
95+
id: integer, The account id (required)
96+
97+
Returns:
98+
An object of the form:
99+
100+
{ # Configuration data for an Ad Exchange buyer account.
101+
"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+
"maximumActiveCreatives": 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.
104+
"bidderLocation": [ # Your bidder locations that have distinct URLs.
105+
{
106+
"url": "A String", # The URL to which the Ad Exchange will send bid requests.
107+
"region": "A String", # 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:
108+
# - ASIA
109+
# - EUROPE
110+
# - US_EAST
111+
# - US_WEST
112+
"maximumQps": 42, # The maximum queries per second the Ad Exchange will send.
113+
},
114+
],
115+
"cookieMatchingNid": "A String", # The nid parameter value used in cookie match requests. Please contact your technical account manager if you need to change this.
116+
"numberActiveCreatives": 42, # The number of creatives that this account inserted or bid with in the last 30 days.
117+
"id": 42, # Account id.
118+
"cookieMatchingUrl": "A String", # The base URL used in cookie match requests.
119+
}</pre>
120+
</div>
121+
122+
<div class="method">
123+
<code class="details" id="list">list()</code>
124+
<pre>Retrieves the authenticated user's list of accounts.
125+
126+
Args:
127+
128+
Returns:
129+
An object of the form:
130+
131+
{ # 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.
132+
"items": [ # A list of accounts.
133+
{ # Configuration data for an Ad Exchange buyer account.
134+
"kind": "adexchangebuyer#account", # Resource type.
135+
"maximumTotalQps": 42, # The sum of all bidderLocation.maximumQps values cannot exceed this. Please contact your technical account manager if you need to change this.
136+
"maximumActiveCreatives": 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.
137+
"bidderLocation": [ # Your bidder locations that have distinct URLs.
138+
{
139+
"url": "A String", # The URL to which the Ad Exchange will send bid requests.
140+
"region": "A String", # 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:
141+
# - ASIA
142+
# - EUROPE
143+
# - US_EAST
144+
# - US_WEST
145+
"maximumQps": 42, # The maximum queries per second the Ad Exchange will send.
146+
},
147+
],
148+
"cookieMatchingNid": "A String", # The nid parameter value used in cookie match requests. Please contact your technical account manager if you need to change this.
149+
"numberActiveCreatives": 42, # The number of creatives that this account inserted or bid with in the last 30 days.
150+
"id": 42, # Account id.
151+
"cookieMatchingUrl": "A String", # The base URL used in cookie match requests.
152+
},
153+
],
154+
"kind": "adexchangebuyer#accountsList", # Resource type.
155+
}</pre>
156+
</div>
157+
158+
<div class="method">
159+
<code class="details" id="patch">patch(id, body)</code>
160+
<pre>Updates an existing account. This method supports patch semantics.
161+
162+
Args:
163+
id: integer, The account id (required)
164+
body: object, The request body. (required)
165+
The object takes the form of:
166+
167+
{ # Configuration data for an Ad Exchange buyer account.
168+
"kind": "adexchangebuyer#account", # Resource type.
169+
"maximumTotalQps": 42, # The sum of all bidderLocation.maximumQps values cannot exceed this. Please contact your technical account manager if you need to change this.
170+
"maximumActiveCreatives": 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.
171+
"bidderLocation": [ # Your bidder locations that have distinct URLs.
172+
{
173+
"url": "A String", # The URL to which the Ad Exchange will send bid requests.
174+
"region": "A String", # 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:
175+
# - ASIA
176+
# - EUROPE
177+
# - US_EAST
178+
# - US_WEST
179+
"maximumQps": 42, # The maximum queries per second the Ad Exchange will send.
180+
},
181+
],
182+
"cookieMatchingNid": "A String", # The nid parameter value used in cookie match requests. Please contact your technical account manager if you need to change this.
183+
"numberActiveCreatives": 42, # The number of creatives that this account inserted or bid with in the last 30 days.
184+
"id": 42, # Account id.
185+
"cookieMatchingUrl": "A String", # The base URL used in cookie match requests.
186+
}
187+
188+
189+
Returns:
190+
An object of the form:
191+
192+
{ # Configuration data for an Ad Exchange buyer account.
193+
"kind": "adexchangebuyer#account", # Resource type.
194+
"maximumTotalQps": 42, # The sum of all bidderLocation.maximumQps values cannot exceed this. Please contact your technical account manager if you need to change this.
195+
"maximumActiveCreatives": 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.
196+
"bidderLocation": [ # Your bidder locations that have distinct URLs.
197+
{
198+
"url": "A String", # The URL to which the Ad Exchange will send bid requests.
199+
"region": "A String", # 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:
200+
# - ASIA
201+
# - EUROPE
202+
# - US_EAST
203+
# - US_WEST
204+
"maximumQps": 42, # The maximum queries per second the Ad Exchange will send.
205+
},
206+
],
207+
"cookieMatchingNid": "A String", # The nid parameter value used in cookie match requests. Please contact your technical account manager if you need to change this.
208+
"numberActiveCreatives": 42, # The number of creatives that this account inserted or bid with in the last 30 days.
209+
"id": 42, # Account id.
210+
"cookieMatchingUrl": "A String", # The base URL used in cookie match requests.
211+
}</pre>
212+
</div>
213+
214+
<div class="method">
215+
<code class="details" id="update">update(id, body)</code>
216+
<pre>Updates an existing account.
217+
218+
Args:
219+
id: integer, The account id (required)
220+
body: object, The request body. (required)
221+
The object takes the form of:
222+
223+
{ # Configuration data for an Ad Exchange buyer account.
224+
"kind": "adexchangebuyer#account", # Resource type.
225+
"maximumTotalQps": 42, # The sum of all bidderLocation.maximumQps values cannot exceed this. Please contact your technical account manager if you need to change this.
226+
"maximumActiveCreatives": 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.
227+
"bidderLocation": [ # Your bidder locations that have distinct URLs.
228+
{
229+
"url": "A String", # The URL to which the Ad Exchange will send bid requests.
230+
"region": "A String", # 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:
231+
# - ASIA
232+
# - EUROPE
233+
# - US_EAST
234+
# - US_WEST
235+
"maximumQps": 42, # The maximum queries per second the Ad Exchange will send.
236+
},
237+
],
238+
"cookieMatchingNid": "A String", # The nid parameter value used in cookie match requests. Please contact your technical account manager if you need to change this.
239+
"numberActiveCreatives": 42, # The number of creatives that this account inserted or bid with in the last 30 days.
240+
"id": 42, # Account id.
241+
"cookieMatchingUrl": "A String", # The base URL used in cookie match requests.
242+
}
243+
244+
245+
Returns:
246+
An object of the form:
247+
248+
{ # Configuration data for an Ad Exchange buyer account.
249+
"kind": "adexchangebuyer#account", # Resource type.
250+
"maximumTotalQps": 42, # The sum of all bidderLocation.maximumQps values cannot exceed this. Please contact your technical account manager if you need to change this.
251+
"maximumActiveCreatives": 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.
252+
"bidderLocation": [ # Your bidder locations that have distinct URLs.
253+
{
254+
"url": "A String", # The URL to which the Ad Exchange will send bid requests.
255+
"region": "A String", # 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:
256+
# - ASIA
257+
# - EUROPE
258+
# - US_EAST
259+
# - US_WEST
260+
"maximumQps": 42, # The maximum queries per second the Ad Exchange will send.
261+
},
262+
],
263+
"cookieMatchingNid": "A String", # The nid parameter value used in cookie match requests. Please contact your technical account manager if you need to change this.
264+
"numberActiveCreatives": 42, # The number of creatives that this account inserted or bid with in the last 30 days.
265+
"id": 42, # Account id.
266+
"cookieMatchingUrl": "A String", # The base URL used in cookie match requests.
267+
}</pre>
268+
</div>
269+
270+
</body></html>

0 commit comments

Comments
 (0)