DSP Partners API endpoints
Endpoint reference for the DSP Partners tag (3 endpoints): Administrators only: the network's OpenRTB demand partners and their settings. Needs the DSP Partners console permission, or the account-side grant of the same name
Administrators only: the network’s OpenRTB demand partners and their settings. Needs the DSP Partners console permission, or the account-side grant of the same name. 3 endpoints, generated from the OpenAPI spec. Authentication, the response envelope, pagination and error codes are shared by all endpoints — see REST API overview. Parameters marked form go in an application/x-www-form-urlencoded request body.
GET /rest-api/dsp-partners.do
List the network’s DSP partners.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
name | query | string | no | Only partners whose name contains this, ignoring case |
active | query | boolean | no | true for the partners that are switched on, false for the retired ones; left out, both |
start | query | integer | no | Skip this many partners (zero-based position in the name-ordered list). Default 0 |
limit | query | integer | no | How many partners to return, 1-500. Default 50 |
Responses: 200 — {success, editable, partners:[{id, name, active, url, …}], returned, total, more}. Errors follow the shared conventions.
GET /rest-api/dsp-partners/{id}.do
Read one DSP partner.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
id | path | integer | yes | The partner’s id |
Responses: 200 — {success, editable, partner:{id, name, active, url, parameters, analyticsSync, …}} · 404 — No partner with this id. Errors follow the shared conventions.
POST /rest-api/dsp-partners/{id}.do
Change one DSP partner’s settings.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
id | path | integer | yes | The partner’s id |
name | form | string | no | The partner’s name, as the console and the reports show it |
active | form | boolean | no | Whether the partner is asked for bids at all; a switched-off partner keeps the creatives that name it |
url | form | string | no | The bid endpoint this partner is asked at |
timeout | form | integer | no | Milliseconds the bid may take, 0-30000; it is also the tmax the request carries |
nurlTimeout | form | integer | no | Milliseconds a win or loss notice may take, 0-60000; empty for the platform default of 5000 |
maxQueriesPerSecond | form | integer | no | Most bid requests a second this partner is sent; 0 blocks it, empty is unlimited |
pricingModel | form | string | no | What the partner is billed on: CPM, CPC or CPI. A model that does not match how it reports books zero Values: CPM, CPC, CPI. |
protocolVersion | form | string | no | The OpenRTB version the bid request is written in Values: V_2_2, V_2_3_1, V_2_4, V_2_5, V_2_6. |
nativeProtocolVersion | form | string | no | The OpenRTB Native version a native bid request is written in Values: V_1_0, V_1_1, V_1_2. |
encryptionType | form | string | no | How the macros this partner is sent are encrypted: NO_ENCRYPTION, BASE64 or BLOWFISH Values: NO_ENCRYPTION, BASE64, BLOWFISH. |
secondPriceOnly | form | boolean | no | Settle a win at the runner-up’s price rather than the bid |
headerBiddingEnabled | form | boolean | no | Ask this partner on header-bidding requests as well |
gzipBidRequest | form | boolean | no | Send the bid request gzipped |
wrapClickThrough | form | boolean | no | Count the click here before sending the visitor on to the partner’s landing page |
nativeRequestWrap | form | boolean | no | Wrap the native bid request in its OpenRTB envelope |
nativeResponseWrap | form | boolean | no | Expect the native bid response in its OpenRTB envelope |
creativeScanProvider | form | string | no | 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 |
Responses: 200 — {success, id, changed:[…]} · 404 — No partner with this id. Errors follow the shared conventions.
Related
- REST API overview — authentication and conventions
- API endpoint reference by tag
- Network services and miscellaneous APIs