DSP response

The proposal to participate in an auction is sent using the POST method in JSON format (Content-Type: application/json).

{
  "id": "(string)",
  "cur": "(string)",
  "seatbid": [
    {
      "seat": "(string)",
      "bid": [
        {
          "impid": "(string)",
          "id": "(string)",
          "price": "(float)",
          "adid": "(string)",
          "adomain": [
            "(array of strings)"
          ],
          "bundle": "(string)",
          "payload": "(string)",
          "cid": "(string)",
          "crid": "(string)",
          "lurl": "(string)",
          "nurl": "(string)",
          "burl": "(string)",
          "attr": [
            "(array of strings)"
          ],
          "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)"
              }
            }
          }
        }
      ]
    }
  ]
}
Copied to clipboard

Response parameters
Bid Response object
Parameter	Description	Required
`id`	Auction ID obtained from the RTB host.	yes
`cur`	Currency that the bid is shown in: Seatbid.Bid.price parameter. Acceptable values: RUB — Russian ruble. USD — United States dollar. EUR — Euro. CHF — Swiss franc. TRY — Turkish lira. UAH — Ukrainian hryvnia. KZT — Kazakhstani tenge.	yes
`seatbid`	Array of Seatbid objects. Contains bids for impressions.	yes
Seatbid object
`seat`	ID of the auction participant making a bid.	yes
`bid`	Array of Seatbid.Bid objects. Each object contains banner parameters and a bid for impressions.	yes
Seatbid.Bid object
`impid`	ID of the Imp.id object of the ORTB host request.	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
`bundle`	App ID in the App Store or Google Play.	no
`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
`attr`	A set of creative parameters.	no
`adm`	HTML code of the creative to be directly embedded on the page. May contain macros that will be replaced when rendering a creative.	no
`w`	Width of the block in pixels.	yes
`h`	Height of the block in pixels.	yes
`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
`client`	Information about the customer under the original contract.	no
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
`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 parameters
Bid Response object
Parameter	Description	Required
`id`	Auction ID obtained from the RTB host.	yes
`cur`	Currency that the bid is shown in: Seatbid.Bid.price parameter. Acceptable values: RUB — Russian ruble. USD — United States dollar. EUR — Euro. CHF — Swiss franc. TRY — Turkish lira. UAH — Ukrainian hryvnia. KZT — Kazakhstani tenge.	yes
`seatbid`	Array of Seatbid objects. Contains bids for impressions.	yes
Seatbid object
`seat`	ID of the auction participant making a bid.	yes
`bid`	Array of Seatbid.Bid objects. Each object contains banner parameters and a bid for impressions.	yes
Seatbid.Bid object
`impid`	ID of the Imp.id object of the ORTB host request.	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
`bundle`	App ID in the App Store or Google Play.	no
`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
`attr`	A set of creative parameters.	no
`adm`	HTML code of the creative to be directly embedded on the page. May contain macros that will be replaced when rendering a creative.	no
`w`	Width of the block in pixels.	yes
`h`	Height of the block in pixels.	yes
`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
`client`	Information about the customer under the original contract.	no
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
`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

{
  "id": "5834842956793170835",
  "cur": "RUB",
  "units": 1,
  "seatbid": [
    {
      "seat": "dsp-partner-global",
      "bid": [
        {
          "impid": "10",
          "id": "615b146ecf3275146cde449d4b3eb400",
          "traceid": "615b146ecf3275146cde449d4b3eb400",
          "price": 4.82,
          "adid": "36124_",
          "adomain": [
            "farfetch.com"
          ],
          "bundle": "906698760",
          "payload": "S-W20CMRLJqbBxuJp5nDf4scTFpFmUejZDcxNc_lEAhP4FBLi1-DOr4b2WIPPnVLEEU8ecbxIyGuMqyAAZMCnEmGz970qCCZb87fFc6CpFdG5wXVjGcymKgImpgfNYUS-f0A9uSSvk1GYWt_Ya_2_DoVlnp26CI5_hTBEvKqRHb6jNhkK_N9N0GaoC9u-nSW998Yq7HbnsrrhcdHXcyuBGqAUlIE52NQT-UR_I12QFvJ7_CPrjyZiiYgmjeosnSy0dlBV7cL5cysMHlNKiNZB77GcfZaQamE7c4DdbdDf_9FQXZeujvbua5EXdkK0Nsh2lamig04JOnrBpILg-NJepHavjIHAhw3YhCKnWyTDygmXKWv3MVse3VyvuUarLOeDqhUSyAN3aX5Xqo2SzE9V1088glfO3e7RtH5Dugv-pQc0Wvkqq1dkg",
          "cid": "185338",
          "crid": "36124_",
          "lurl": "http://rtb.nl.eu.dsp-partner.com/yandexortb/auction/notify?profile=270&imp=S-W20CMRLJqbBxuJp5nDf4scTFpFmUejZDcxNc_lEAhP4FBLi1-DOr4b2WIPPnVLEEU8ecbxIyGuMqyAAZMCnEmGz970qCCZb87fFc6CpFdG5wXVjGcymKgImpgfNYUS-f0A9uSSvk1GYWt_Ya_2_DoVlnp26CI5_hTBEvKqRHb6jNhkK_N9N0GaoC9u-nSW998Yq7HbnsrrhcdHXcyuBGqAUlIE52NQT-UR_I12QFvJ7_CPrjyZiiYgmjeosnSy0dlBV7cL5cysMHlNKiNZB77GcfZaQamE7c4DdbdDf_9FQXZeujvbua5EXdkK0Nsh2lamig04JOnrBpILg-NJepHavjIHAhw3YhCKnWyTDygmXKWv3MVse3VyvuUarLOeDqhUSyAN3aX5Xqo2SzE9V1088glfO3e7RtH5Dugv-pQc0Wvkqq1dkg&st=${AUCTION_LOSS}",
          "nurl": "http://rtb.nl.eu.dsp-partner.com/yandexortb/auction/notify?profile=270&imp=W1g6Zz8k8fjYsF8C2ymvB1GoWyc3csS1z9KYruC7_YZH5gP5mTxeH2ufjxoAIqCgBs7ZQS4ALh2rXGarcrrm6OAALRdhsCRx5QBiN99rLMqXkTBrG3KwOOHalRN0NSoJkJwXOANLLnpwWNkoWzD41vy_HmJvOBdWbo0VExtzMSteNYmOf8D4YIUhUbgQhpS3xArd593WM5a8ls3Qwxa60hHzETu4zx12dzzujI1QQOpyyQph4KrXb_PUBCcgUlE4Kept1fPqQ0f9zibVv5GudzFdw70UUMW3B3O5HQSIhlQuB5uIUYdnjoXIORzKBP1YQSIxGGA-uFY_1igRWXEkgRpgG_IBOFmBHxA9SkMR9P-k3Ta0-MWzpONYDBXARmA9a6eW-xWVJchKlWk2eDNWMvMoa43xEtIUM05jKX5sU6OUsZQNtg78Ww",
          "burl": "https://rtb.nl.eu.dsp-partner.com/yandexortb/auction/notify?profile=270&imp=yYeYv3VyrghjGRIW8gfr_a-PhH6wlEbGFj31O6wZJkxwzp7pa32MVoEsUqGI5nBbOm7ClCNF5yDLshDuDt2cF_sSZY3LCxizheTizCFYgf3eL_AJ397DdkrA3qq9QrPRJH4boFyVDJVGGfQ26vfKfDDMMUxkuW2fHKOyo2toeBkO7CjveZB7iB9P4IgMlnSO6psgLG8KUKtk8HIQHeNFdKG5SBMvm1vhZ2Y4nGBqyXbHYDCWfFjF0qImeCEKrL2pvWM3VXojYU5CuS-svs3h3vLnghHCOWhST0Cn3mnmM_5aLjfsJ0C_T0gNX6QCf7N4LPfxIcFQtBiZsJ13w0aocjVw83KAWcPUSlVfwRZm-Lixe0LDtkdU_Ujo4_GaAM3vPME5XSCahRpLjjFQon9ypdwlXUXMXDmZg-Uo8zbnxA6A2GWLdkBbtw",
          "attr": [],
          "adm": "<script type='text/javascript' src='https://ads.eu.dsp-partner.com/delivery/r/ajs.php?z=${ENCRYPTED_AUCTION_PRICE}&u=%7CNhP%2FXoi4ZnaLsZN7OVBxJg52BL54hbgJDBTW%2FMWhcNA%3D%7C&c1=jWCgqsKSUoVnhbPUYduT0I_a4gxRTN4fFxJSFPxaOqcrqhLC6ZrfdcTmceDoB2R-RVV94C5ubnLKAl6vJozak3kdPx-fkSv1NWZyq-NV2ST5u8rCmF9b4MovSZUjDmDfsX7I73brvdDU8QQ95EtuWUcIm-oPBYKmuDbDsFlXwvpmNUpZQ24dbE4EWPPg2Y8d0YgWaJMrOKIpJVAWgFVfGa36EoTvWxEO9cpnlETWOZEhyOQ7-InwHAa1Dyk9wt9_nf5kq2HLKbiTt3xO5WKYiDPm4Yu-f0YYmgnGVE2Jmg7y9zxU4sLLIT6KHK6Jnel0s55ws5QO7mI0-x4b9WSa1r7vTUZTUio_q12HjAdAJEUwmk0ZmekNQc86DOkMD2612hbPWpetlD_mukWzStOOpBaF2BmieuSzm8AOH7pvsSZezWofNUic4B-oo2TrcX3UziCaN0eGWzM5_g3YbInP4uZm7jemvHYPEEFqhclqws8yKQHGPJTQrIay7enGz7Rl'></script>",
          "w": 300,
          "h": 300,
          "ext": {
            "nroa": {
              "erid":"efr23i",
              "has_nroa_markup":0,
              "client":{
                "inn":"71445203",
                "name":"ООО Неваляшка",
                "legal_form":"ul"
              }
            }
          }
        }
      ]
    }
  ]
}
Copied to clipboard