DSP response
The proposal to participate in an auction is sent using the POST method in JSON format (Content-Type: application/json).
Response body
The response body contains the Bid Response object shown below.
Alert
Tracking pixels must support HTTPS.
{
"id": "(string)",
"cur": "(string)",
"seatbid": [
{
"bid": [
{
"impid": "(string)",
"id": "(string)",
"price": "(float)",
"adid": "(string)",
"adomain": [
"(array of strings)"
],
"payload": "(string)",
"cid": "(string)",
"crid": "(string)",
"lurl": "(string)",
"nurl": "(string)",
"burl": "(string)",
"adm": "(string)",
"cat": [
"(array of strings)"
],
"exp": "(int)",
"iurl": "(string)",
"protocol": "(int)",
"ext": {
"nroa": {
"erid": "(string)",
"has_nroa_markup": "(int)",
"client": {
"inn": "(string)",
"legal_form": "(string)",
"name": "(string)",
"mobile_phone": "(string)",
"epay_number": "(string)",
"reg_number": "(string)",
"alternative_inn": "(string)",
"oksm_number": "(string)"
}
}
}
}
]
}
]
}
Response parameters
|
Parameter |
Description |
Required |
|
Bid Response object |
||
|
id |
Auction ID obtained from the RTB host. |
yes |
|
cur |
Currency that the bid is shown in:
|
yes |
|
seatbid |
Array of |
yes |
|
Seatbid object |
||
|
bid |
Array of |
yes |
|
Seatbid.Bid object |
||
|
impid |
ID of the |
yes |
|
id |
ID of the ad unit on the HTML page, obtained from the ORTB host. |
yes |
|
price |
Bid — The price for impressions that the DSP agrees to. Specified per 1000 impressions. |
yes |
|
adid |
The banner ID in the DSP. |
yes |
|
adomain |
The domain of the advertiser whose ad is contained in the DSP response. Only one value is allowed in the array. |
yes |
|
payload |
JSON received from the DSP. Up to 1024 characters. Can be transferred in a Bid Loss Notification. |
no |
|
cid |
Ad campaign ID on the DSP side. |
yes |
|
crid |
ID of the ad unit on the HTML page, obtained from the ORTB host. |
no |
|
lurl |
URL called when losing an auction. |
no |
|
nurl |
URL called when winning an auction. |
no |
|
burl |
URL called when debiting funds for a paid event. |
no |
|
adm |
XML code to be embedded in the player. May contain macros that will be replaced when rendering a creative. |
no |
|
cat |
IAB content categories for creative. |
no |
|
iurl |
Link to an image from the campaign content to check the quality and safety of the ad. |
no |
|
protocol |
Supported video protocol. |
no |
|
ext |
Object with additional parameters. |
no |
|
Bid.ext object |
||
|
nroa |
The parent object for the extension. |
no |
|
nroa object |
||
|
erid |
ERID |
no |
|
has_nroa_markup |
Whether the creative includes labeling according to the legislation. Possible values: 0 or 1. |
no |
|
contractor |
Information about the contractor under the original contract. |
no |
|
client |
Information about the customer under the original contract. |
no |
|
initial_contract |
Information about the customer under the original contract. |
no |
|
parent_contracts |
List of “parent” contracts. If the client's original contract has the “additional agreement” type, information about the corresponding source contract must be transmitted |
Mandatory for additional agreements |
|
Client object |
||
|
inn |
TIN of an individual or a legal entity. |
no |
|
legal_form |
Organization type from the “List of organization types”. |
no |
|
name |
Legal form and name. |
no |
|
mobile_phone |
Phone number. Filled in for foreign individuals and legal entities in accordance with the requirements of the state register. |
no |
|
epay_number |
Bank account number or electronic wallet number or similar, except bank card number. |
no |
|
reg_number |
Registration number or its equivalent. Filled in for foreign individuals and legal entities in accordance with the requirements of the state register. |
no |
|
alternative_inn |
Taxpayer's number or its equivalent in the country of registration. Filled in for foreign individuals and legal entities in accordance with the requirements of the state register. |
no |
|
oksm_number |
The code of the legal entity's country of registration under the Russian classifier of world countries (OKSM). Filled in for foreign legal entities in accordance with the requirements of the state register. |
no |
Response example
{
"bidid": "9218750a64d68fb3ae3b8d5d849c9d63",
"cur": "RUB",
"id": "2071435468055052649",
"seatbid": [
{
"bid": [
{
"adid": "6256ab117bc72f01b40e8af5",
"adm": "<?xml version=\"1.0\" encoding=\"utf-8\" ?><VAST version=\"4.0\"><Ad id=\"6256ab117bc72f01b40e8af5\"><InLine><AdSystem>dspname</AdSystem><AdTitle><![CDATA[VTR.mp4]]></AdTitle><Error><![CDATA[https://dsa.dspname.ai/DeliverySeance/SaveErrorEvent2?ssp=182&sid=__33_e5qqr3dz1e9cx9qubkzpt89g5naeb7wyg6k8dy9c6x4fgkiczewdjttt734gj6nw8x47eahstg4qe&err=[ERRORCODE]&r=]]></Error><Impression><![CDATA[https://dsa.dspname.ai/DeliverySeance/SaveImpression2?ssp=182&sid=__33_sdrxb1q6oespyikbribry7ryidtowfd8i8o91qh8kwi4np151exo3tte7hcxt9on3jfrh14tph86s&adid=__33_c9ot7f34znk39gtef3hxepe78szytf65ny15pbtoxc7boaka4nh9iswewtrasapcgma6whrxp4f6r&p=&rdu=&r=]]></Impression><Impression><![CDATA[https://ad.adriver.ru/cgi-bin/rle.cgi?sid=1&ad=735441&bt=21&pid=3368131&bid=7829021&bn=7829021&rnd=1535275276]]></Impression><Creatives><Creative><Linear><Duration>00:00:13</Duration><TrackingEvents><Tracking event=\"start\"><![CDATA[https://dsa.dspname.ai/DeliverySeance/SaveStartEvent2?ssp=182&sid=__33_e5qqr3dz1e9cx9qubkzpt89g5naeb7wyg6k8dy9c6x4fgkiczewdjttt734gj6nw8x47eahstg4qe&r=]]></Tracking><Tracking event=\"firstQuartile\"><![CDATA[https://dsa.dspname.ai/DeliverySeance/SaveView2?ssp=182&sid=__33_a1togz6kyzr9dubjysqysb3i3jm3ans1tpuf1sp1qd7kzzzp719gfhrqkp1indfjiqagd5zmbdsqs&r=]]></Tracking><Tracking event=\"firstQuartile\"><![CDATA[https://dsa.dspname.ai/DeliverySeance/SaveFirstQuartileEvent2?ssp=182&sid=__33_e5qqr3dz1e9cx9qubkzpt89g5naeb7wyg6k8dy9c6x4fgkiczewdjttt734gj6nw8x47eahstg4qe&r=]]></Tracking><Tracking event=\"midpoint\"><![CDATA[https://dsa.dspname.ai/DeliverySeance/SaveMidpointEvent2?ssp=182&sid=__33_e5qqr3dz1e9cx9qubkzpt89g5naeb7wyg6k8dy9c6x4fgkiczewdjttt734gj6nw8x47eahstg4qe&r=]]></Tracking><Tracking event=\"thirdQuartile\"><![CDATA[https://dsa.dspname.ai/DeliverySeance/SaveThirdQuartileEvent2?ssp=182&sid=__33_e5qqr3dz1e9cx9qubkzpt89g5naeb7wyg6k8dy9c6x4fgkiczewdjttt734gj6nw8x47eahstg4qe&r=]]></Tracking><Tracking event=\"complete\"><![CDATA[https://dsa.dspname.ai/DeliverySeance/SaveCompleteEvent2?ssp=182&sid=__33_e5qqr3dz1e9cx9qubkzpt89g5naeb7wyg6k8dy9c6x4fgkiczewdjttt734gj6nw8x47eahstg4qe&r=]]></Tracking><Tracking event=\"mute\"><![CDATA[https://dsa.dspname.ai/DeliverySeance/SaveMuteEvent2?ssp=182&sid=__33_e5qqr3dz1e9cx9qubkzpt89g5naeb7wyg6k8dy9c6x4fgkiczewdjttt734gj6nw8x47eahstg4qe&r=]]></Tracking><Tracking event=\"unmute\"><![CDATA[https://dsa.dspname.ai/DeliverySeance/SaveUnmuteEvent2?ssp=182&sid=__33_e5qqr3dz1e9cx9qubkzpt89g5naeb7wyg6k8dy9c6x4fgkiczewdjttt734gj6nw8x47eahstg4qe&r=]]></Tracking><Tracking event=\"pause\"><![CDATA[https://dsa.dspname.ai/DeliverySeance/SavePauseEvent2?ssp=182&sid=__33_e5qqr3dz1e9cx9qubkzpt89g5naeb7wyg6k8dy9c6x4fgkiczewdjttt734gj6nw8x47eahstg4qe&r=]]></Tracking><Tracking event=\"rewind\"><![CDATA[https://dsa.dspname.ai/DeliverySeance/SaveRewindEvent2?ssp=182&sid=__33_e5qqr3dz1e9cx9qubkzpt89g5naeb7wyg6k8dy9c6x4fgkiczewdjttt734gj6nw8x47eahstg4qe&r=]]></Tracking><Tracking event=\"resume\"><![CDATA[https://dsa.dspname.ai/DeliverySeance/SaveResumeEvent2?ssp=182&sid=__33_e5qqr3dz1e9cx9qubkzpt89g5naeb7wyg6k8dy9c6x4fgkiczewdjttt734gj6nw8x47eahstg4qe&r=]]></Tracking><Tracking event=\"fullscreen\"><![CDATA[https://dsa.dspname.ai/DeliverySeance/SaveFullscreenEvent2?ssp=182&sid=__33_e5qqr3dz1e9cx9qubkzpt89g5naeb7wyg6k8dy9c6x4fgkiczewdjttt734gj6nw8x47eahstg4qe&r=]]></Tracking><Tracking event=\"expand\"><![CDATA[https://dsa.dspname.ai/DeliverySeance/SaveExpandEvent2?ssp=182&sid=__33_e5qqr3dz1e9cx9qubkzpt89g5naeb7wyg6k8dy9c6x4fgkiczewdjttt734gj6nw8x47eahstg4qe&r=]]></Tracking><Tracking event=\"collapse\"><![CDATA[https://dsa.dspname.ai/DeliverySeance/SaveCollapseEvent2?ssp=182&sid=__33_e5qqr3dz1e9cx9qubkzpt89g5naeb7wyg6k8dy9c6x4fgkiczewdjttt734gj6nw8x47eahstg4qe&r=]]></Tracking><Tracking event=\"acceptInvitation\"><![CDATA[https://dsa.dspname.ai/DeliverySeance/SaveAcceptInvitationEvent2?ssp=182&sid=__33_e5qqr3dz1e9cx9qubkzpt89g5naeb7wyg6k8dy9c6x4fgkiczewdjttt734gj6nw8x47eahstg4qe&r=]]></Tracking><Tracking event=\"close\"><![CDATA[https://dsa.dspname.ai/DeliverySeance/SaveCloseEvent2?ssp=182&sid=__33_e5qqr3dz1e9cx9qubkzpt89g5naeb7wyg6k8dy9c6x4fgkiczewdjttt734gj6nw8x47eahstg4qe&r=]]></Tracking></TrackingEvents><VideoClicks><ClickThrough><![CDATA[https://dsa.dspname.ai/DeliverySeance/SaveClick2?sid=__33_wpucgzrpt5g9bs5nsbc11nx8naddt6nz4nkppqpgbdf55w1k1ox3d3fyjswgj6b93z165kgnaazae&ssp=182&bn=__33_y5wbgpyx8ihucfd3cs94oz6sj46g7jwh3mfaqwcfmwqncb6eozhbeokqo1wc3ctisouhh64674znh&dst=__33_h63mwajiyeg76rudc3drjw7kwfet7h3sh4s6467jr63h9rdax1xbbkut3acncd9dj6t9wwkytq9xebh9tacr5if8wgx1t9tsqjcbgo8j5bz569kgwiw5epk5erx56cbkgwq8mjyintnw1n8uk7wdnmmz7q4shtowj1d8rj5cgt75n9e3nai3ttas9pgyzm9stgeuse9u1n16n&bct=&r=]]></ClickThrough></VideoClicks><MediaFiles><MediaFile delivery=\"progressive\" type=\"video/x-flv\" bitrate=\"7717\" width=\"1920\" height=\"1080\"><![CDATA[https://content.dspname.ai/dspname/90/15/9015D1B05995C9263F7598EB8B2A6F66.flv]]></MediaFile><MediaFile delivery=\"progressive\" type=\"video/mp4\" bitrate=\"9140\" width=\"1920\" height=\"1080\"><![CDATA[https://content.dspname.ai/dspname/BB/48/BB486A4504ED516F956E78DBAFFED661.mp4]]></MediaFile><MediaFile delivery=\"progressive\" type=\"video/webm\" bitrate=\"8515\" width=\"1920\" height=\"1080\"><![CDATA[https://content.dspname.ai/dspname/76/88/768891ED424907E2710F3511C33F91F3.webm]]></MediaFile><MediaFile delivery=\"progressive\" type=\"video/x-ms-wmv\" bitrate=\"200\" width=\"1920\" height=\"1080\"><![CDATA[https://content.dspname.ai/dspname/C2/5B/C25B86B85243C25375375A598E8FE820.wmv]]></MediaFile></MediaFiles></Linear></Creative></Creatives><Extensions></Extensions></InLine></Ad></VAST>",
"adomain": [
"kontur.ru"
],
"burl": "https://dssa.dspname.ai/openrtb/bil/182/?r=9547351836376329&sid=__33_6hb3sm9y5hrusrs1d8u8tcbnanpjo589b4ytsazxhofsdt8cys6d4dbgxj4bx1kidt947484roits&adid=__33_p4dcrkpsgddfbr4ssyjbtjspp6u5y5yxnot9gmd8yb9cbice99qm1k6y61hw7qdteek9xzr3hur6q&p=${AUCTION_PRICE}",
"cat": [
"IAB3"
],
"cid": "6256aae67bc72f01b40e8ae8",
"crid": "6256ab117bc72f01b40e8af5",
"exp": 7200,
"ext": {},
"id": "1e66c5dda15e8ae37bbb2f8f62d87575",
"impid": "14",
"iurl": "https://content.dspname.ai/dspname/BB/48/BB486A4504ED516F956E78DBAFFED661.mp4",
"nurl": "https://dssa.dspname.ai/openrtb/video2/182/?r=9547351836376329&sid=__33_6hb3sm9y5hrusrs1d8u8tcbnanpjo589b4ytsazxhofsdt8cys6d4dbgxj4bx1kidt947484roits&adid=__33_p4dcrkpsgddfbr4ssyjbtjspp6u5y5yxnot9gmd8yb9cbice99qm1k6y61hw7qdteek9xzr3hur6q&p=${AUCTION_PRICE}&adm=False",
"payload": "1e66c5dda15e8ae37bbb2f8f62d87575",
"price": 55,
"protocol": 7,
"ext": {
"nroa": {
"erid":"efr23i",
"has_nroa_markup":0,
"client":{
"inn":"71445203",
"name":"Company",
"legal_form":"ul"
}
}
}
}
]
}
]
}
Example of an attribute for marking ad.
The attribute is added to the XML code from seatbid.bid.adm:
<Ad>
...
<InLine>
<Extensions>
<Extension type="nroa_inform">
<Url>https://example.com/...</Url>
</Extension>
</Extensions>
</InLine>
</Ad>