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, confirmUnsafeAccountChange=None)</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, confirmUnsafeAccountChange=None)</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 "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: 114 # - PROTOCOL_ADX 115 # - PROTOCOL_OPENRTB_2_2 116 # - PROTOCOL_OPENRTB_2_3 117 # - PROTOCOL_OPENRTB_2_4 118 # - PROTOCOL_OPENRTB_2_5 119 # - PROTOCOL_OPENRTB_PROTOBUF_2_3 120 # - PROTOCOL_OPENRTB_PROTOBUF_2_4 121 # - PROTOCOL_OPENRTB_PROTOBUF_2_5 122 }, 123 ], 124 "cookieMatchingNid": "A String", # The nid parameter value used in cookie match requests. Please contact your technical account manager if you need to change this. 125 "numberActiveCreatives": 42, # The number of creatives that this account inserted or bid with in the last 30 days. 126 "id": 42, # Account id. 127 "cookieMatchingUrl": "A String", # The base URL used in cookie match requests. 128 }</pre> 129 </div> 130 131 <div class="method"> 132 <code class="details" id="list">list()</code> 133 <pre>Retrieves the authenticated user's list of accounts. 134 135 Args: 136 137 Returns: 138 An object of the form: 139 140 { # 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. 141 "items": [ # A list of accounts. 142 { # Configuration data for an Ad Exchange buyer account. 143 "kind": "adexchangebuyer#account", # Resource type. 144 "maximumTotalQps": 42, # The sum of all bidderLocation.maximumQps values cannot exceed this. Please contact your technical account manager if you need to change this. 145 "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. 146 "bidderLocation": [ # Your bidder locations that have distinct URLs. 147 { 148 "url": "A String", # The URL to which the Ad Exchange will send bid requests. 149 "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: 150 # - ASIA 151 # - EUROPE 152 # - US_EAST 153 # - US_WEST 154 "maximumQps": 42, # The maximum queries per second the Ad Exchange will send. 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 }, 165 ], 166 "cookieMatchingNid": "A String", # The nid parameter value used in cookie match requests. Please contact your technical account manager if you need to change this. 167 "numberActiveCreatives": 42, # The number of creatives that this account inserted or bid with in the last 30 days. 168 "id": 42, # Account id. 169 "cookieMatchingUrl": "A String", # The base URL used in cookie match requests. 170 }, 171 ], 172 "kind": "adexchangebuyer#accountsList", # Resource type. 173 }</pre> 174 </div> 175 176 <div class="method"> 177 <code class="details" id="patch">patch(id, body, confirmUnsafeAccountChange=None)</code> 178 <pre>Updates an existing account. This method supports patch semantics. 179 180 Args: 181 id: integer, The account id (required) 182 body: object, The request body. (required) 183 The object takes the form of: 184 185 { # Configuration data for an Ad Exchange buyer account. 186 "kind": "adexchangebuyer#account", # Resource type. 187 "maximumTotalQps": 42, # The sum of all bidderLocation.maximumQps values cannot exceed this. Please contact your technical account manager if you need to change this. 188 "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. 189 "bidderLocation": [ # Your bidder locations that have distinct URLs. 190 { 191 "url": "A String", # The URL to which the Ad Exchange will send bid requests. 192 "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: 193 # - ASIA 194 # - EUROPE 195 # - US_EAST 196 # - US_WEST 197 "maximumQps": 42, # The maximum queries per second the Ad Exchange will send. 198 "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: 199 # - PROTOCOL_ADX 200 # - PROTOCOL_OPENRTB_2_2 201 # - PROTOCOL_OPENRTB_2_3 202 # - PROTOCOL_OPENRTB_2_4 203 # - PROTOCOL_OPENRTB_2_5 204 # - PROTOCOL_OPENRTB_PROTOBUF_2_3 205 # - PROTOCOL_OPENRTB_PROTOBUF_2_4 206 # - PROTOCOL_OPENRTB_PROTOBUF_2_5 207 }, 208 ], 209 "cookieMatchingNid": "A String", # The nid parameter value used in cookie match requests. Please contact your technical account manager if you need to change this. 210 "numberActiveCreatives": 42, # The number of creatives that this account inserted or bid with in the last 30 days. 211 "id": 42, # Account id. 212 "cookieMatchingUrl": "A String", # The base URL used in cookie match requests. 213 } 214 215 confirmUnsafeAccountChange: boolean, Confirmation for erasing bidder and cookie matching urls. 216 217 Returns: 218 An object of the form: 219 220 { # Configuration data for an Ad Exchange buyer account. 221 "kind": "adexchangebuyer#account", # Resource type. 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 "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. 224 "bidderLocation": [ # Your bidder locations that have distinct URLs. 225 { 226 "url": "A String", # The URL to which the Ad Exchange will send bid requests. 227 "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: 228 # - ASIA 229 # - EUROPE 230 # - US_EAST 231 # - US_WEST 232 "maximumQps": 42, # The maximum queries per second the Ad Exchange will send. 233 "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: 234 # - PROTOCOL_ADX 235 # - PROTOCOL_OPENRTB_2_2 236 # - PROTOCOL_OPENRTB_2_3 237 # - PROTOCOL_OPENRTB_2_4 238 # - PROTOCOL_OPENRTB_2_5 239 # - PROTOCOL_OPENRTB_PROTOBUF_2_3 240 # - PROTOCOL_OPENRTB_PROTOBUF_2_4 241 # - PROTOCOL_OPENRTB_PROTOBUF_2_5 242 }, 243 ], 244 "cookieMatchingNid": "A String", # The nid parameter value used in cookie match requests. Please contact your technical account manager if you need to change this. 245 "numberActiveCreatives": 42, # The number of creatives that this account inserted or bid with in the last 30 days. 246 "id": 42, # Account id. 247 "cookieMatchingUrl": "A String", # The base URL used in cookie match requests. 248 }</pre> 249 </div> 250 251 <div class="method"> 252 <code class="details" id="update">update(id, body, confirmUnsafeAccountChange=None)</code> 253 <pre>Updates an existing account. 254 255 Args: 256 id: integer, The account id (required) 257 body: object, The request body. (required) 258 The object takes the form of: 259 260 { # Configuration data for an Ad Exchange buyer account. 261 "kind": "adexchangebuyer#account", # Resource type. 262 "maximumTotalQps": 42, # The sum of all bidderLocation.maximumQps values cannot exceed this. Please contact your technical account manager if you need to change this. 263 "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. 264 "bidderLocation": [ # Your bidder locations that have distinct URLs. 265 { 266 "url": "A String", # The URL to which the Ad Exchange will send bid requests. 267 "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: 268 # - ASIA 269 # - EUROPE 270 # - US_EAST 271 # - US_WEST 272 "maximumQps": 42, # The maximum queries per second the Ad Exchange will send. 273 "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: 274 # - PROTOCOL_ADX 275 # - PROTOCOL_OPENRTB_2_2 276 # - PROTOCOL_OPENRTB_2_3 277 # - PROTOCOL_OPENRTB_2_4 278 # - PROTOCOL_OPENRTB_2_5 279 # - PROTOCOL_OPENRTB_PROTOBUF_2_3 280 # - PROTOCOL_OPENRTB_PROTOBUF_2_4 281 # - PROTOCOL_OPENRTB_PROTOBUF_2_5 282 }, 283 ], 284 "cookieMatchingNid": "A String", # The nid parameter value used in cookie match requests. Please contact your technical account manager if you need to change this. 285 "numberActiveCreatives": 42, # The number of creatives that this account inserted or bid with in the last 30 days. 286 "id": 42, # Account id. 287 "cookieMatchingUrl": "A String", # The base URL used in cookie match requests. 288 } 289 290 confirmUnsafeAccountChange: boolean, Confirmation for erasing bidder and cookie matching urls. 291 292 Returns: 293 An object of the form: 294 295 { # Configuration data for an Ad Exchange buyer account. 296 "kind": "adexchangebuyer#account", # Resource type. 297 "maximumTotalQps": 42, # The sum of all bidderLocation.maximumQps values cannot exceed this. Please contact your technical account manager if you need to change this. 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 "bidderLocation": [ # Your bidder locations that have distinct URLs. 300 { 301 "url": "A String", # The URL to which the Ad Exchange will send bid requests. 302 "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: 303 # - ASIA 304 # - EUROPE 305 # - US_EAST 306 # - US_WEST 307 "maximumQps": 42, # The maximum queries per second the Ad Exchange will send. 308 "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: 309 # - PROTOCOL_ADX 310 # - PROTOCOL_OPENRTB_2_2 311 # - PROTOCOL_OPENRTB_2_3 312 # - PROTOCOL_OPENRTB_2_4 313 # - PROTOCOL_OPENRTB_2_5 314 # - PROTOCOL_OPENRTB_PROTOBUF_2_3 315 # - PROTOCOL_OPENRTB_PROTOBUF_2_4 316 # - PROTOCOL_OPENRTB_PROTOBUF_2_5 317 }, 318 ], 319 "cookieMatchingNid": "A String", # The nid parameter value used in cookie match requests. Please contact your technical account manager if you need to change this. 320 "numberActiveCreatives": 42, # The number of creatives that this account inserted or bid with in the last 30 days. 321 "id": 42, # Account id. 322 "cookieMatchingUrl": "A String", # The base URL used in cookie match requests. 323 }</pre> 324 </div> 325 326 </body></html>
