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_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="#close">close()</a></code></p> 79<p class="firstline">Close httplib2 connections.</p> 80<p class="toc_element"> 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"> 87 <code><a href="#patch">patch(id, body=None, confirmUnsafeAccountChange=None)</a></code></p> 88<p class="firstline">Updates an existing account. This method supports patch semantics.</p> 89<p class="toc_element"> 90 <code><a href="#update">update(id, body=None, confirmUnsafeAccountChange=None)</a></code></p> 91<p class="firstline">Updates an existing account.</p> 92<h3>Method Details</h3> 93<div class="method"> 94 <code class="details" id="close">close()</code> 95 <pre>Close httplib2 connections.</pre> 96</div> 97 98<div class="method"> 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. 109 "applyPretargetingToNonGuaranteedDeals": True or False, # When this is false, bid requests that include a deal ID for a private auction or preferred deal are always sent to your bidder. When true, all active pretargeting configs will be applied to private auctions and preferred deals. Programmatic Guaranteed deals (when enabled) are always sent to your bidder. 110 "bidderLocation": [ # Your bidder locations that have distinct URLs. 111 { 112 "bidProtocol": "A String", # The protocol that the bidder endpoint is using. OpenRTB protocols with prefix PROTOCOL_OPENRTB_PROTOBUF use proto buffer, otherwise use JSON. Allowed values: 113 # - PROTOCOL_ADX 114 # - PROTOCOL_OPENRTB_2_2 115 # - PROTOCOL_OPENRTB_2_3 116 # - PROTOCOL_OPENRTB_2_4 117 # - PROTOCOL_OPENRTB_2_5 118 # - PROTOCOL_OPENRTB_PROTOBUF_2_3 119 # - PROTOCOL_OPENRTB_PROTOBUF_2_4 120 # - PROTOCOL_OPENRTB_PROTOBUF_2_5 121 "maximumQps": 42, # The maximum queries per second the Ad Exchange will send. 122 "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: 123 # - ASIA 124 # - EUROPE 125 # - US_EAST 126 # - US_WEST 127 "url": "A String", # The URL to which the Ad Exchange will send bid requests. 128 }, 129 ], 130 "cookieMatchingNid": "A String", # The nid parameter value used in cookie match requests. Please contact your technical account manager if you need to change this. 131 "cookieMatchingUrl": "A String", # The base URL used in cookie match requests. 132 "id": 42, # Account id. 133 "kind": "adexchangebuyer#account", # Resource type. 134 "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. 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 "numberActiveCreatives": 42, # The number of creatives that this account inserted or bid with in the last 30 days. 137}</pre> 138</div> 139 140<div class="method"> 141 <code class="details" id="list">list()</code> 142 <pre>Retrieves the authenticated user's list of accounts. 143 144Args: 145 146Returns: 147 An object of the form: 148 149 { # 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. 150 "items": [ # A list of accounts. 151 { # Configuration data for an Ad Exchange buyer account. 152 "applyPretargetingToNonGuaranteedDeals": True or False, # When this is false, bid requests that include a deal ID for a private auction or preferred deal are always sent to your bidder. When true, all active pretargeting configs will be applied to private auctions and preferred deals. Programmatic Guaranteed deals (when enabled) are always sent to your bidder. 153 "bidderLocation": [ # Your bidder locations that have distinct URLs. 154 { 155 "bidProtocol": "A String", # The protocol that the bidder endpoint is using. OpenRTB protocols with prefix PROTOCOL_OPENRTB_PROTOBUF use proto buffer, otherwise use JSON. Allowed values: 156 # - PROTOCOL_ADX 157 # - PROTOCOL_OPENRTB_2_2 158 # - PROTOCOL_OPENRTB_2_3 159 # - PROTOCOL_OPENRTB_2_4 160 # - PROTOCOL_OPENRTB_2_5 161 # - PROTOCOL_OPENRTB_PROTOBUF_2_3 162 # - PROTOCOL_OPENRTB_PROTOBUF_2_4 163 # - PROTOCOL_OPENRTB_PROTOBUF_2_5 164 "maximumQps": 42, # The maximum queries per second the Ad Exchange will send. 165 "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: 166 # - ASIA 167 # - EUROPE 168 # - US_EAST 169 # - US_WEST 170 "url": "A String", # The URL to which the Ad Exchange will send bid requests. 171 }, 172 ], 173 "cookieMatchingNid": "A String", # The nid parameter value used in cookie match requests. Please contact your technical account manager if you need to change this. 174 "cookieMatchingUrl": "A String", # The base URL used in cookie match requests. 175 "id": 42, # Account id. 176 "kind": "adexchangebuyer#account", # Resource type. 177 "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. 178 "maximumTotalQps": 42, # The sum of all bidderLocation.maximumQps values cannot exceed this. Please contact your technical account manager if you need to change this. 179 "numberActiveCreatives": 42, # The number of creatives that this account inserted or bid with in the last 30 days. 180 }, 181 ], 182 "kind": "adexchangebuyer#accountsList", # Resource type. 183}</pre> 184</div> 185 186<div class="method"> 187 <code class="details" id="patch">patch(id, body=None, confirmUnsafeAccountChange=None)</code> 188 <pre>Updates an existing account. This method supports patch semantics. 189 190Args: 191 id: integer, The account id (required) 192 body: object, The request body. 193 The object takes the form of: 194 195{ # Configuration data for an Ad Exchange buyer account. 196 "applyPretargetingToNonGuaranteedDeals": True or False, # When this is false, bid requests that include a deal ID for a private auction or preferred deal are always sent to your bidder. When true, all active pretargeting configs will be applied to private auctions and preferred deals. Programmatic Guaranteed deals (when enabled) are always sent to your bidder. 197 "bidderLocation": [ # Your bidder locations that have distinct URLs. 198 { 199 "bidProtocol": "A String", # The protocol that the bidder endpoint is using. OpenRTB protocols with prefix PROTOCOL_OPENRTB_PROTOBUF use proto buffer, otherwise use JSON. Allowed values: 200 # - PROTOCOL_ADX 201 # - PROTOCOL_OPENRTB_2_2 202 # - PROTOCOL_OPENRTB_2_3 203 # - PROTOCOL_OPENRTB_2_4 204 # - PROTOCOL_OPENRTB_2_5 205 # - PROTOCOL_OPENRTB_PROTOBUF_2_3 206 # - PROTOCOL_OPENRTB_PROTOBUF_2_4 207 # - PROTOCOL_OPENRTB_PROTOBUF_2_5 208 "maximumQps": 42, # The maximum queries per second the Ad Exchange will send. 209 "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: 210 # - ASIA 211 # - EUROPE 212 # - US_EAST 213 # - US_WEST 214 "url": "A String", # The URL to which the Ad Exchange will send bid requests. 215 }, 216 ], 217 "cookieMatchingNid": "A String", # The nid parameter value used in cookie match requests. Please contact your technical account manager if you need to change this. 218 "cookieMatchingUrl": "A String", # The base URL used in cookie match requests. 219 "id": 42, # Account id. 220 "kind": "adexchangebuyer#account", # Resource type. 221 "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. 222 "maximumTotalQps": 42, # The sum of all bidderLocation.maximumQps values cannot exceed this. Please contact your technical account manager if you need to change this. 223 "numberActiveCreatives": 42, # The number of creatives that this account inserted or bid with in the last 30 days. 224} 225 226 confirmUnsafeAccountChange: boolean, Confirmation for erasing bidder and cookie matching urls. 227 228Returns: 229 An object of the form: 230 231 { # Configuration data for an Ad Exchange buyer account. 232 "applyPretargetingToNonGuaranteedDeals": True or False, # When this is false, bid requests that include a deal ID for a private auction or preferred deal are always sent to your bidder. When true, all active pretargeting configs will be applied to private auctions and preferred deals. Programmatic Guaranteed deals (when enabled) are always sent to your bidder. 233 "bidderLocation": [ # Your bidder locations that have distinct URLs. 234 { 235 "bidProtocol": "A String", # The protocol that the bidder endpoint is using. OpenRTB protocols with prefix PROTOCOL_OPENRTB_PROTOBUF use proto buffer, otherwise use JSON. Allowed values: 236 # - PROTOCOL_ADX 237 # - PROTOCOL_OPENRTB_2_2 238 # - PROTOCOL_OPENRTB_2_3 239 # - PROTOCOL_OPENRTB_2_4 240 # - PROTOCOL_OPENRTB_2_5 241 # - PROTOCOL_OPENRTB_PROTOBUF_2_3 242 # - PROTOCOL_OPENRTB_PROTOBUF_2_4 243 # - PROTOCOL_OPENRTB_PROTOBUF_2_5 244 "maximumQps": 42, # The maximum queries per second the Ad Exchange will send. 245 "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: 246 # - ASIA 247 # - EUROPE 248 # - US_EAST 249 # - US_WEST 250 "url": "A String", # The URL to which the Ad Exchange will send bid requests. 251 }, 252 ], 253 "cookieMatchingNid": "A String", # The nid parameter value used in cookie match requests. Please contact your technical account manager if you need to change this. 254 "cookieMatchingUrl": "A String", # The base URL used in cookie match requests. 255 "id": 42, # Account id. 256 "kind": "adexchangebuyer#account", # Resource type. 257 "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. 258 "maximumTotalQps": 42, # The sum of all bidderLocation.maximumQps values cannot exceed this. Please contact your technical account manager if you need to change this. 259 "numberActiveCreatives": 42, # The number of creatives that this account inserted or bid with in the last 30 days. 260}</pre> 261</div> 262 263<div class="method"> 264 <code class="details" id="update">update(id, body=None, confirmUnsafeAccountChange=None)</code> 265 <pre>Updates an existing account. 266 267Args: 268 id: integer, The account id (required) 269 body: object, The request body. 270 The object takes the form of: 271 272{ # Configuration data for an Ad Exchange buyer account. 273 "applyPretargetingToNonGuaranteedDeals": True or False, # When this is false, bid requests that include a deal ID for a private auction or preferred deal are always sent to your bidder. When true, all active pretargeting configs will be applied to private auctions and preferred deals. Programmatic Guaranteed deals (when enabled) are always sent to your bidder. 274 "bidderLocation": [ # Your bidder locations that have distinct URLs. 275 { 276 "bidProtocol": "A String", # The protocol that the bidder endpoint is using. OpenRTB protocols with prefix PROTOCOL_OPENRTB_PROTOBUF use proto buffer, otherwise use JSON. Allowed values: 277 # - PROTOCOL_ADX 278 # - PROTOCOL_OPENRTB_2_2 279 # - PROTOCOL_OPENRTB_2_3 280 # - PROTOCOL_OPENRTB_2_4 281 # - PROTOCOL_OPENRTB_2_5 282 # - PROTOCOL_OPENRTB_PROTOBUF_2_3 283 # - PROTOCOL_OPENRTB_PROTOBUF_2_4 284 # - PROTOCOL_OPENRTB_PROTOBUF_2_5 285 "maximumQps": 42, # The maximum queries per second the Ad Exchange will send. 286 "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: 287 # - ASIA 288 # - EUROPE 289 # - US_EAST 290 # - US_WEST 291 "url": "A String", # The URL to which the Ad Exchange will send bid requests. 292 }, 293 ], 294 "cookieMatchingNid": "A String", # The nid parameter value used in cookie match requests. Please contact your technical account manager if you need to change this. 295 "cookieMatchingUrl": "A String", # The base URL used in cookie match requests. 296 "id": 42, # Account id. 297 "kind": "adexchangebuyer#account", # Resource type. 298 "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. 299 "maximumTotalQps": 42, # The sum of all bidderLocation.maximumQps values cannot exceed this. Please contact your technical account manager if you need to change this. 300 "numberActiveCreatives": 42, # The number of creatives that this account inserted or bid with in the last 30 days. 301} 302 303 confirmUnsafeAccountChange: boolean, Confirmation for erasing bidder and cookie matching urls. 304 305Returns: 306 An object of the form: 307 308 { # Configuration data for an Ad Exchange buyer account. 309 "applyPretargetingToNonGuaranteedDeals": True or False, # When this is false, bid requests that include a deal ID for a private auction or preferred deal are always sent to your bidder. When true, all active pretargeting configs will be applied to private auctions and preferred deals. Programmatic Guaranteed deals (when enabled) are always sent to your bidder. 310 "bidderLocation": [ # Your bidder locations that have distinct URLs. 311 { 312 "bidProtocol": "A String", # The protocol that the bidder endpoint is using. OpenRTB protocols with prefix PROTOCOL_OPENRTB_PROTOBUF use proto buffer, otherwise use JSON. Allowed values: 313 # - PROTOCOL_ADX 314 # - PROTOCOL_OPENRTB_2_2 315 # - PROTOCOL_OPENRTB_2_3 316 # - PROTOCOL_OPENRTB_2_4 317 # - PROTOCOL_OPENRTB_2_5 318 # - PROTOCOL_OPENRTB_PROTOBUF_2_3 319 # - PROTOCOL_OPENRTB_PROTOBUF_2_4 320 # - PROTOCOL_OPENRTB_PROTOBUF_2_5 321 "maximumQps": 42, # The maximum queries per second the Ad Exchange will send. 322 "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: 323 # - ASIA 324 # - EUROPE 325 # - US_EAST 326 # - US_WEST 327 "url": "A String", # The URL to which the Ad Exchange will send bid requests. 328 }, 329 ], 330 "cookieMatchingNid": "A String", # The nid parameter value used in cookie match requests. Please contact your technical account manager if you need to change this. 331 "cookieMatchingUrl": "A String", # The base URL used in cookie match requests. 332 "id": 42, # Account id. 333 "kind": "adexchangebuyer#account", # Resource type. 334 "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. 335 "maximumTotalQps": 42, # The sum of all bidderLocation.maximumQps values cannot exceed this. Please contact your technical account manager if you need to change this. 336 "numberActiveCreatives": 42, # The number of creatives that this account inserted or bid with in the last 30 days. 337}</pre> 338</div> 339 340</body></html>