• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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_3.html">Ad Exchange Buyer API</a> . <a href="adexchangebuyer_v1_3.budget.html">budget</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78  <code><a href="#get">get(accountId, billingId)</a></code></p>
79<p class="firstline">Returns the budget information for the adgroup specified by the accountId and billingId.</p>
80<p class="toc_element">
81  <code><a href="#patch">patch(accountId, billingId, body)</a></code></p>
82<p class="firstline">Updates the budget amount for the budget of the adgroup specified by the accountId and billingId, with the budget amount in the request. This method supports patch semantics.</p>
83<p class="toc_element">
84  <code><a href="#update">update(accountId, billingId, body)</a></code></p>
85<p class="firstline">Updates the budget amount for the budget of the adgroup specified by the accountId and billingId, with the budget amount in the request.</p>
86<h3>Method Details</h3>
87<div class="method">
88    <code class="details" id="get">get(accountId, billingId)</code>
89  <pre>Returns the budget information for the adgroup specified by the accountId and billingId.
90
91Args:
92  accountId: string, The account id to get the budget information for. (required)
93  billingId: string, The billing id to get the budget information for. (required)
94
95Returns:
96  An object of the form:
97
98    { # The configuration data for Ad Exchange RTB - Budget API.
99      "kind": "adexchangebuyer#budget", # The kind of the resource, i.e. "adexchangebuyer#budget".
100      "budgetAmount": "A String", # The daily budget amount in unit amount of the account currency to apply for the billingId provided. This is required for update requests.
101      "currencyCode": "A String", # The currency code for the buyer. This cannot be altered here.
102      "billingId": "A String", # The billing id to determine which adgroup to provide budget information for. This is required for get and update requests.
103      "id": "A String", # The unique id that describes this item.
104      "accountId": "A String", # The id of the account. This is required for get and update requests.
105    }</pre>
106</div>
107
108<div class="method">
109    <code class="details" id="patch">patch(accountId, billingId, body)</code>
110  <pre>Updates the budget amount for the budget of the adgroup specified by the accountId and billingId, with the budget amount in the request. This method supports patch semantics.
111
112Args:
113  accountId: string, The account id associated with the budget being updated. (required)
114  billingId: string, The billing id associated with the budget being updated. (required)
115  body: object, The request body. (required)
116    The object takes the form of:
117
118{ # The configuration data for Ad Exchange RTB - Budget API.
119    "kind": "adexchangebuyer#budget", # The kind of the resource, i.e. "adexchangebuyer#budget".
120    "budgetAmount": "A String", # The daily budget amount in unit amount of the account currency to apply for the billingId provided. This is required for update requests.
121    "currencyCode": "A String", # The currency code for the buyer. This cannot be altered here.
122    "billingId": "A String", # The billing id to determine which adgroup to provide budget information for. This is required for get and update requests.
123    "id": "A String", # The unique id that describes this item.
124    "accountId": "A String", # The id of the account. This is required for get and update requests.
125  }
126
127
128Returns:
129  An object of the form:
130
131    { # The configuration data for Ad Exchange RTB - Budget API.
132      "kind": "adexchangebuyer#budget", # The kind of the resource, i.e. "adexchangebuyer#budget".
133      "budgetAmount": "A String", # The daily budget amount in unit amount of the account currency to apply for the billingId provided. This is required for update requests.
134      "currencyCode": "A String", # The currency code for the buyer. This cannot be altered here.
135      "billingId": "A String", # The billing id to determine which adgroup to provide budget information for. This is required for get and update requests.
136      "id": "A String", # The unique id that describes this item.
137      "accountId": "A String", # The id of the account. This is required for get and update requests.
138    }</pre>
139</div>
140
141<div class="method">
142    <code class="details" id="update">update(accountId, billingId, body)</code>
143  <pre>Updates the budget amount for the budget of the adgroup specified by the accountId and billingId, with the budget amount in the request.
144
145Args:
146  accountId: string, The account id associated with the budget being updated. (required)
147  billingId: string, The billing id associated with the budget being updated. (required)
148  body: object, The request body. (required)
149    The object takes the form of:
150
151{ # The configuration data for Ad Exchange RTB - Budget API.
152    "kind": "adexchangebuyer#budget", # The kind of the resource, i.e. "adexchangebuyer#budget".
153    "budgetAmount": "A String", # The daily budget amount in unit amount of the account currency to apply for the billingId provided. This is required for update requests.
154    "currencyCode": "A String", # The currency code for the buyer. This cannot be altered here.
155    "billingId": "A String", # The billing id to determine which adgroup to provide budget information for. This is required for get and update requests.
156    "id": "A String", # The unique id that describes this item.
157    "accountId": "A String", # The id of the account. This is required for get and update requests.
158  }
159
160
161Returns:
162  An object of the form:
163
164    { # The configuration data for Ad Exchange RTB - Budget API.
165      "kind": "adexchangebuyer#budget", # The kind of the resource, i.e. "adexchangebuyer#budget".
166      "budgetAmount": "A String", # The daily budget amount in unit amount of the account currency to apply for the billingId provided. This is required for update requests.
167      "currencyCode": "A String", # The currency code for the buyer. This cannot be altered here.
168      "billingId": "A String", # The billing id to determine which adgroup to provide budget information for. This is required for get and update requests.
169      "id": "A String", # The unique id that describes this item.
170      "accountId": "A String", # The id of the account. This is required for get and update requests.
171    }</pre>
172</div>
173
174</body></html>