blob: d5bac1bc3430765eebe1f1e832a4dfac7c995f81 [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.directDeals.html">directDeals</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 direct deal 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 direct deals.</p>
83<h3>Method Details</h3>
84<div class="method">
85 <code class="details" id="get">get(id)</code>
86 <pre>Gets one direct deal by ID.
87
88Args:
89 id: string, The direct deal id (required)
90
91Returns:
92 An object of the form:
93
94 {
95 "advertiser": "A String", # The name of the advertiser this deal is for.
96 "kind": "adexchangebuyer#directDeal", # Resource type.
97 "currencyCode": "A String", # The currency code that applies to the fixed_cpm value. If not set then assumed to be USD.
98 "fixedCpm": "A String", # The fixed price for this direct deal. In cpm micros of currency according to currency_code.
99 "startTime": "A String", # Start time for when this deal becomes active. If not set then this deal is active immediately upon creation. In seconds since the epoch.
100 "endTime": "A String", # End time for when this deal stops being active. If not set then this deal is valid until manually disabled by the publisher. In seconds since the epoch.
101 "sellerNetwork": "A String", # The name of the publisher offering this direct deal.
102 "id": "A String", # Deal id.
103 "accountId": 42, # The account id of the buyer this deal is for.
104 }</pre>
105</div>
106
107<div class="method">
108 <code class="details" id="list">list()</code>
109 <pre>Retrieves the authenticated user's list of direct deals.
110
111Args:
112
113Returns:
114 An object of the form:
115
116 {
117 "kind": "adexchangebuyer#directDealsList", # Resource type.
118 "directDeals": [ # A list of direct deals relevant for your account.
119 {
120 "advertiser": "A String", # The name of the advertiser this deal is for.
121 "kind": "adexchangebuyer#directDeal", # Resource type.
122 "currencyCode": "A String", # The currency code that applies to the fixed_cpm value. If not set then assumed to be USD.
123 "fixedCpm": "A String", # The fixed price for this direct deal. In cpm micros of currency according to currency_code.
124 "startTime": "A String", # Start time for when this deal becomes active. If not set then this deal is active immediately upon creation. In seconds since the epoch.
125 "endTime": "A String", # End time for when this deal stops being active. If not set then this deal is valid until manually disabled by the publisher. In seconds since the epoch.
126 "sellerNetwork": "A String", # The name of the publisher offering this direct deal.
127 "id": "A String", # Deal id.
128 "accountId": 42, # The account id of the buyer this deal is for.
129 },
130 ],
131 }</pre>
132</div>
133
134</body></html>