Browse the help center

Change one DSP partner's settings

Changes only the settings the call names and leaves every other one as it is, so a client that is switching a partner off does not have to send its endpoint, its currency and its parameters back to keep them.

Reference
POST https://YOUR-NETWORK-DOMAIN/rest-api/dsp-partners/{id}.do

Changes only the settings the call names and leaves every other one as it is, so a client that is switching a partner off does not have to send its endpoint, its currency and its parameters back to keep them. Each one is checked the way the console checks it, and a call that fails a check changes nothing at all. Switching a partner off stops it being offered anywhere new while the creatives that already name it keep it; switching one on is refused while its currency has no rate to price it by, exactly as the page refuses it. The currency and contractual rate, the supply-chain domain, user matching, the per-partner parameters and analytics sync are not changed here: each is checked against the other fields of the page's form, which a call naming three settings cannot supply. Read the partner back to confirm what was stored. Requires the DSP Partners permission.

Path Params

id integer required

The partner's id

12

Form Params

name string

The partner's name, as the console and the reports show it

TrafficStars

active boolean

Whether the partner is asked for bids at all; a switched-off partner keeps the creatives that name it

true

url string

The bid endpoint this partner is asked at

https://bid.partner.example/rtb

timeout integer

Milliseconds the bid may take, 0-30000; it is also the tmax the request carries

300

nurlTimeout integer

Milliseconds a win or loss notice may take, 0-60000; empty for the platform default of 5000

5000

maxQueriesPerSecond integer

Most bid requests a second this partner is sent; 0 blocks it, empty is unlimited

500

pricingModel string

What the partner is billed on: CPM, CPC or CPI. A model that does not match how it reports books zero

CPM

protocolVersion string

The OpenRTB version the bid request is written in

V_2_5

nativeProtocolVersion string

The OpenRTB Native version a native bid request is written in

V_1_2

encryptionType string

How the macros this partner is sent are encrypted: NO_ENCRYPTION, BASE64 or BLOWFISH

NO_ENCRYPTION

secondPriceOnly boolean

Settle a win at the runner-up's price rather than the bid

false

headerBiddingEnabled boolean

Ask this partner on header-bidding requests as well

false

gzipBidRequest boolean

Send the bid request gzipped

false

wrapClickThrough boolean

Count the click here before sending the visitor on to the partner's landing page

true

nativeRequestWrap boolean

Wrap the native bid request in its OpenRTB envelope

true

nativeResponseWrap boolean

Expect the native bid response in its OpenRTB envelope

true

creativeScanProvider string

Which provider scans this partner's creatives: MEDIA_TRUST, GEO_EDGE, or NONE to trust them unscanned. A provider the network has no account for is refused

GEO_EDGE

Responses

200

{success, id, changed:[...]}

400

A value is outside the range the console allows, or a rule it enforces is broken

401

Authentication error

403

The caller does not hold the DSP Partners permission

404

No partner with this id

Please disable Adblock
Are you using adblock? Disable it and reload the page to proceed to the destination page.

A registration has already been submitted from this page. Please try again in 10 minutes.