Web ads: DSP response
The bid response is submitted via the POST method in JSON format (Content-Type: application/json).
Response body
The response body contains a Bid Response object.
Alert
Tracking pixels must support HTTPS.
{
"id": "(string)",
"cur": "(string)",
"seatbid": [
{
"seat": "(string)",
"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)",
"w": "(int)",
"h": "(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
Bid Response object
|
Parameter |
Description |
Required |
|
id |
Auction ID received from the RTB host. |
Yes |
|
cur |
Currency used to specify the bid (
|
Yes |
|
seatbid |
Array of |
Yes |
Seatbid object
|
Parameter |
Description |
Required |
|
seat |
ID of the auction participant on whose behalf the bid is placed. |
Yes |
|
bid |
Array of |
Yes |
Seatbid.Bid object
|
Parameter |
Description |
Required |
|
impid |
ID of the request's |
Yes |
|
id |
Ad unit ID on the HTML page, received from the OpenRTB host. |
Yes |
|
price |
Bid price for the impression set by the DSP. This is the cost per 1000 impressions (CPM). |
Yes |
|
adid |
Banner ID in the DSP. |
Yes |
|
adomain |
Advertiser domain for the ad included in the DSP response. Only one value is allowed in the array. |
Yes |
|
payload |
JSON string received from the DSP. Maximum 1024 characters. This can be passed in a bid loss notification. |
No |
|
cid |
Campaign ID on the DSP side. |
Yes |
|
crid |
Ad unit ID on the HTML page, received from the OpenRTB host. |
No |
|
lurl |
URL called when the bid loses the auction. |
No |
|
nurl |
URL called when the bid wins the auction. |
No |
|
burl |
URL called when funds are debited for a billable event. |
No |
|
adm |
Creative's HTML code that should be embedded directly on the page. It may include macros that expand when the creative renders. XML code that should be embedded into a video player. It may include macros that expand when the creative renders (video ads). |
No |
|
w |
Ad unit width in pixels. |
Yes |
|
h |
Ad unit height in pixels. |
Yes |
|
cat |
IAB content categories for the ad creative. |
No |
|
iurl |
URL of the image from the campaign content for quality assurance and ad safety review. |
No |
|
protocol |
Supported video protocol. |
No |
|
ext |
Object with additional parameters. |
No |
Bid.ext object
|
Parameter |
Description |
Required |
|
nroa |
Parent object for extension. |
No |
nroa object
|
Parameter |
Description |
Required |
|
erid |
ERID |
No |
|
has_nroa_markup |
Flag indicating whether the creative includes ad labeling required by Russian law. Allowed values: |
No |
|
client |
Client details under the initial contract. |
No |
|
contractor |
Contractor details under the initial contract. |
No |
|
initial_contract |
Details of the initial contract. |
No |
|
parent_contracts |
List of parent contracts. If the primary contract is of the "additional agreement" type, pass information for the initial contract. |
Required for additional agreements |
Client object
|
Parameter |
Description |
Required |
|
inn |
INN (TIN) of an individual or legal entity. |
No |
|
legal_form |
Entity type from the "List of entity types". |
No |
|
name |
Entity type and legal name. |
No |
|
mobile_phone |
Phone number. It must be specified for foreign individuals and legal entities in accordance with ERIR requirements. |
No |
|
epay_number |
Bank account number, e-wallet ID, or similar payment identifier, excluding bank card numbers. |
No |
|
reg_number |
Registration number or its equivalent. It must be specified for foreign individuals and legal entities in accordance with ERIR requirements. |
No |
|
alternative_inn |
The taxpayer number or its equivalent in the country of registration. It must be specified for foreign individuals and legal entities in accordance with ERIR requirements. |
No |
|
oksm_number |
Code of the country where the legal entity is registered, according to OKSM. It must be specified for foreign legal entities in accordance with ERIR requirements. |
No |
Sample response for a banner ad
{
"id": "2959715181885154373",
"cur": "RUB",
"seatbid": [
{
"seat": "dsp-global",
"bid": [
{
"impid": "103",
"id": "5ed134b186ca98265293b16c82a7d400",
"price": 32.53,
"adid": "",
"adomain": [
"newbalance.ru"
],
"payload": "6xloAnIVotDKYLYiJvFa7KZAOus_XttPiOJvqXeYa8d2A42ZaSHKZ58F5JVooWyuRIknSeLjoOY4DIS0BOAc_OtReqi2xi-19iMlSxkY4Ou0ghOh9tzGSrTD0OjGmGzX57so3RLtgMX1ePRHDTVWEx4ck5kOtA87IPnmhltnCXRiEP0pFlFTmxJTqnqeT-IjAulqTWUfnjs2Wnq3ReXEQiiLHxJ5Pxfekwci3DLLx_7eNWfSRhgmxFvRD2az1CJN50-FKj-I60xyw0BKT5Vnl3dZa5-CQ5HkiHpPsH0kGm8eVt9crezg0upU_FbAgRseoWEEsQ0moYoogl8r-9mZrD5pM19xnNesEkopxwA73xOvflYGRIanDgGkfwetgzjLW-kn0-hXwgJxVQYIZJBMY5rd5Vhb6YYbBpOeemREwIxebK8IPZ9sUg",
"cid": "111074",
"crid": "",
"lurl": "http://dsp.site.ru/yandexortb/auction/notify?profile=270&imp=S-W20CMRLJqbBxuJp5nDf4scTFpFmUejZDcxNc_lEAhP4FBLi1-DOr4b2WIPPnVLEEU8ecbxIyGuMqyAAZMCnEmGz970qCCZb87fFc6CpFdG5wXVjGcymKgImpgfNYUS-f0A9uSSvk1GYWt_Ya_2_DoVlnp26CI5_hTBEvKqRHb6jNhkK_N9N0GaoC9u-nSW998Yq7HbnsrrhcdHXcyuBGqAUlIE52NQT-UR_I12QFvJ7_CPrjyZiiYgmjeosnSy0dlBV7cL5cysMHlNKiNZB77GcfZaQamE7c4DdbdDf_9FQXZeujvbua5EXdkK0Nsh2lamig04JOnrBpILg-NJepHavjIHAhw3YhCKnWyTDygmXKWv3MVse3VyvuUarLOeDqhUSyAN3aX5Xqo2SzE9V1088glfO3e7RtH5Dugv-pQc0Wvkqq1dkg",
"nurl": "http://dsp.site.ru/yandexortb/auction/notify?profile=270&imp=YbkelGS3jzCPzyueufqCFSZxX4pkpC3LpctDQG4vTZ6PpL8UOtO3tvvBKL27jczCFglYB6hnBmsowc-AqT6lWqGnFYF0AzsQtg4OuodQD9BX5elxuup9R2uiibh9ljlq_XmN4wJOt5qXsTVcE8ICcec7cASnJbFTmw3-PKoXdE6blSkjhyhsLEhy957Wu9ycMOiVeWhs8rq5FnnVosJRjLeBq3ydPrnuvQY8PdAKKs3boI7aMTqjlwN7ZrDcEpIuXxsmY4GOaFdNr_ISe_HfRl1zHbZ6fyVQc0tb9Bdzdt-WSXh98ku_YSmGmUrkgyyHdbWR2YD7XSDyItOt6M4xxv2Xc09XfWcFpMgSJInteqMWsJ6qEIKg8hU6asFZDdgiMQ6d_9vjX7nz4E9_o8frct9Ol8cn79FpyUnKzXvvNQGEsoZFlT-WSQ",
"burl": "http://dsp.site.ru/yandexortb/auction/notify?profile=270&imp=tuqMXsc_qeWxpdjZvM_thf7GFx3_h_OeU77q9FwQzvRJYBE1VXWZ4RRmJK-tOQORLcpmsfxiJKqp93WnibUpT-s5Tux7aEhGA_DDSuzB74q6tVCj1VzrOtJnw31mNNoLy0teiiPZHVtKM9vwUbVk6F3WvVVb5Pa5V2xJwzaQIWlT6XeZjMlaPrmumkjcdqLvTXPA45l7s9g1fLSLai7BTvfDYif2dsdS7--_HXVWTAae5QBH7-UPf-ed7Wn_UR5NWqiRPgE3w3DAf6o9EJWAVZI4UPKNwj-xv0KN3ET4mBOs_Yt5XbXomZIYLrl7Y6Uhyzw1sFLPnrsJxqP7susS_goVErL4oFjt1GvLs0eblfrdNpqc1IQIfy-cC4q4XMubeip7JHS_0MH0g5b1ZhnzpgIwZD0JBSuSPSo6S_i7TUg1DmgC-90hxQ",
"adm": "<iframe id='659fa948' name='659fa948' src='http://dsp.site.ru/delivery/r/afr.php?did=5ed134b186ca98265293b16c82a7d400&z=${AUCTION_PRICE}&u=%7CkfLBF84WGYk8GZaTnlZApLIxNAXnhxO2e5dFwhlHm2Q%3D%7C&c1=pHOA86cDdpKTosiVYbtIXOR9N0v5mNdEGl8j8F6oCQy-14RbOZ40izPRWJiZCfaajt-CCD-Aess2l_fYRVoTqxcurWGNXEf5K2mNqaz-SJ-21tGUu8jK0Zak4HBs6fdKMxzvO1i7AuvFc4JUhosN3MuGpn6nFTg07hAYBotknCi3wLzo4zb9_u99oTq750u4C2Al809A98-K4vvnvjh1q3n2RJXEtnymIBX_0tUj07SmVQV9igSM3RBxUukocP4I-bwThQUKzrxtOUWDY8drq5z-cY4X2YPpxiKwNrtdNeBnwo2rftdjif4YFm4vHaNCzB_3ryOVrDE-3EblUJRCtuJv9RYlWVMfCoYzsgXY6ozASo0Amvmj0AD2_6IYWaJqQDSX18ZPwdmmyEWmnWZltfZqzK7MggRULjr5_JR_n8i5cqKFvoTsqKKqWgAseP34' framespacing='0' frameborder='no' scrolling='no' width='300' height='600'></iframe>",
"w": 300,
"h": 600,
"ext": {
"nroa": {
"erid":"efr23i",
"has_nroa_markup":0,
"client":{
"inn":"71445203",
"name":"ООО Неваляшка",
"legal_form":"ul"
}
}
}
}
]
}
]
}
Sample response for a video ad
{
"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":"ООО Неваляшка",
"legal_form":"ul"
}
}
}
}
]
}
]
}
Sample attribute for labeling a video ad
This attribute should be added to the XML code from the seatbid.bid.adm field:
<Ad>
...
<InLine>
<Extensions>
<Extension type="nroa_inform">
<Url>https://example.com/...</Url>
</Extension>
</Extensions>
</InLine>
</Ad>