DSP response

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

The response body contains the Bid Response object shown below.

Attention.

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)"
          ],
          "bundle": "(string)",
          "payload": "(string)",
          "cid": "(string)",
          "crid": "(string)",
          "lurl": "(string)",
          "nurl": "(string)",
          "burl": "(string)",
          "adm": "{\"native\": { \"ver\": (string), \"assets\": [{\"id\": (int),\"required\": (int),\"title\": { \"text\": (string)}},{\"id\": (int),\"required\": (int),\"img\": { \"url\": (string), \"w\": (int), \"h\": (int)}},{\"id\": (int),\"required\": (int),\"data\": { \"value\": (float)}} ], \"eventtrackers\": [{\"event\": (int),\"method\": (int),\"url\": (string)} ], \"link\": {\"url\": (string) }, \"privacy\": (string), \"ext\": {\"privacy\": {\"imageurl\": (string),\"clickurl\": (string)}}}}}]}]}",
          "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
Parameter Description Required
Bid Response object
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
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 asset parameters. no
adm

Contains an encoded string with the Seatbid.Bid.Adm.Native object. See Response example.

 no
native The Seatbid.Bid.Adm.Native object with native banner parameters. no
w Width of the block in pixels. yes
h Height of the block in pixels. yes
ext Object with additional parameters. no
Seatbid.Bid.Adm.Native object
ver Native Markup version. no
assets The Seatbid.Bid.Adm.Native.Assets object with asset parameters. no
eventtrackers The Seatbid.Bid.Adm.Native.Eventtrackers object with event tracking parameters. no
link The Seatbid.Bid.Adm.Native.Link object with a link in the ad. yes
privacy

Terms of confidentiality.

  • 1 — Native advertising contains a privacy notice for the user.
  • 0 — No privacy notice.
 no
ext The Seatbid.Bid.Adm.Native.Ext object with additional parameters. no
Seatbid.Bid.Adm.Native.Assets object
id Asset ID. yes
required

Flag indicating whether the asset is mandatory.

  • 1 — Required asset.
  • 0 — Optional asset.
 no
title The Seatbid.Bid.Adm.Native.Assets.Title object with asset title parameters. yes
img The Seatbid.Bid.Adm.Native.Assets.Img object with asset image parameters. no
data The Seatbid.Bid.Adm.Native.Assets.Data object with asset content parameters. no
Seatbid.Bid.Adm.Native.Assets.Title object
text Ad title text. yes
Seatbid.Bid.Adm.Native.Assets.Img object
w Image width. no
url A link to an image. yes
h Image height. no
Seatbid.Bid.Adm.Native.Assets.Data object
value Ad text. yes
Seatbid.Bid.Adm.Native.Link object
url A link in the ad. yes
Seatbid.Bid.Adm.Native.Eventtrackers object
event The event being tracked. yes
method Event tracking method. yes
url Event link. 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
Parameter Description Required
Bid Response object
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
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 asset parameters. no
adm

Contains an encoded string with the Seatbid.Bid.Adm.Native object. See Response example.

 no
native The Seatbid.Bid.Adm.Native object with native banner parameters. no
w Width of the block in pixels. yes
h Height of the block in pixels. yes
ext Object with additional parameters. no
Seatbid.Bid.Adm.Native object
ver Native Markup version. no
assets The Seatbid.Bid.Adm.Native.Assets object with asset parameters. no
eventtrackers The Seatbid.Bid.Adm.Native.Eventtrackers object with event tracking parameters. no
link The Seatbid.Bid.Adm.Native.Link object with a link in the ad. yes
privacy

Terms of confidentiality.

  • 1 — Native advertising contains a privacy notice for the user.
  • 0 — No privacy notice.
 no
ext The Seatbid.Bid.Adm.Native.Ext object with additional parameters. no
Seatbid.Bid.Adm.Native.Assets object
id Asset ID. yes
required

Flag indicating whether the asset is mandatory.

  • 1 — Required asset.
  • 0 — Optional asset.
 no
title The Seatbid.Bid.Adm.Native.Assets.Title object with asset title parameters. yes
img The Seatbid.Bid.Adm.Native.Assets.Img object with asset image parameters. no
data The Seatbid.Bid.Adm.Native.Assets.Data object with asset content parameters. no
Seatbid.Bid.Adm.Native.Assets.Title object
text Ad title text. yes
Seatbid.Bid.Adm.Native.Assets.Img object
w Image width. no
url A link to an image. yes
h Image height. no
Seatbid.Bid.Adm.Native.Assets.Data object
value Ad text. yes
Seatbid.Bid.Adm.Native.Link object
url A link in the ad. yes
Seatbid.Bid.Adm.Native.Eventtrackers object
event The event being tracked. yes
method Event tracking method. yes
url Event link. 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": "1545692916559180241",
  "bidid": "6beac02b-af24-11ec-a3ac-4f447779ff3d",
  "cur": "USD",
  "seatbid": [
    {
      "seat": "acc-25504",
      "bid": [
        {
          "id": "6beac02b-af24-11ec-a3ac-f45f1fae223d",
          "impid": "4",
          "price": 0.011136,
          "nurl": "https://gwbudgetali.iymedia.me/budget.php?1=1&appName=outbrain&adx=yandex&requestId=1545692916559180241&impId=4&bidId=6beac02b-af24-11ec-a3ac-f45f1fae223d&bidType=bid&publisherId=16617488&region=eu-central-1&host=ali-fra109-gatewaydocker-135-248&bidUtcTime=1648533150588&bidPrice=0.01225&gwBidPrice=0.011136&resellerPrice=0.01127&commissionRate=0.1&tagid=295403-4&ifa=&reqip=46.223.41.0&bundle=ru.swc.yaplakal&cheatingScore=0&finalAppId=380&adomain=nation.com&country=DEU&exchange=&impType=native&os=android&osv=11&chargeType=burl&auctionPrice=${AUCTION_PRICE}&encoding=urlencoding",
          "burl": "https://gwbudgetali.iymedia.me/burl.php?1=1&appName=outbrain&adx=yandex&requestId=1545692916559180241&impId=4&bidId=6beac02b-af24-11ec-a3ac-f45f1fae223d&bidType=bid&publisherId=16617488&region=eu-central-1&host=ali-fra109-gatewaydocker-135-248&bidUtcTime=1648533150588&bidPrice=0.01225&gwBidPrice=0.011136&resellerPrice=0.01127&commissionRate=0.1&tagid=295403-4&ifa=&reqip=46.223.41.0&bundle=ru.swc.yaplakal&cheatingScore=0&finalAppId=380&adomain=nation.com&country=DEU&exchange=&impType=native&os=android&osv=11&chargeType=burl&finalAppId=380&auctionPrice=${AUCTION_PRICE}&encoding=urlencoding&burl=aHR0cDovL2IxLWV1ZGMxLnplbWFudGEuY29tL2JpZGRlci93aW4veWVhaG1vYmkvNmJlYWMwMmItYWYyNC0xMWVjLWEzYWMtZjQ1ZjFmYWUyMjNkLzAuMDExMjcvSVFSV09STEo0SFQ2TEFZM0RJWURFRU1VTU1QUVhKR00yVUJJVFNVM0lTQzJWVUtWUUhBWlRaNkg2V001NkxLTEZNNVkyWFZUSENXQUJSSUhLNkNCVzNaQjVQUE00TVpBTEVYTENMQTM0Q1pOQkhYTDJXSjc0WUVVUlJJQk1VNkxSVzZMQ0dLS1RKREpSQ0JSWFBBVlEzRUZQMldCN0lCVFlFMzZYWlpYNzNVNzRMTUZJVDdaT0ZVMkc1RkVZT0RQSVlaTzNGWExLUUtFRE5FTllFSDU3SUJCRlhBSkhWT1pKWFdVNlNBNVpBWUZZVE1ZSkI2REhXMk5TTkNYRlBQR00ySDdVMjNRTlc2M1FUNUhSS0JPQ0NNN1VTWVJIR09DRDJSQVhUWkhQNzRONkc2RkZQQ1oySE1IRzJNNkhKNEFUWkZGU1JNSUJCVkw3SjIzUEFLUlJYR05WVllXQ1NWT0hVMkRENkFMM0RCTzVUQUVXV0VLVzRXQldPN1kyTUhIU05JRVFQV0ZCRkJORVhKMjJXUlgySEU2UFhJRlNFWUtDWU1URlRENU9TV1MzWk9XVkxQMzJHNDRMREQ0T0NCTlA2U09XNUE2NkJXU08vPw==",
          "lurl": "https://gwbudgetali.iymedia.me/lostwin.php?1=1&appName=outbrain&adx=yandex&requestId=1545692916559180241&impId=4&bidId=6beac02b-af24-11ec-a3ac-f45f1fae223d&bidType=bid&region=eu-central-1&host=ali-fra109-gatewaydocker-135-248&bidUtcTime=1648533150588&bidfloor=0.0001067094&bidPrice=0.01225&gwBidPrice=0.011136&resellerPrice=0.01127&commissionRate=0.1&tagid=295403-4&ifa=&reqip=46.223.41.0&bundle=ru.swc.yaplakal&cheatingScore=0&finalAppId=380&adomain=nation.com&lossReason=${AUCTION_LOSS}",
          "adomain": [
            "nation.com"
          ],
          "cid": "15875358",
          "crid": "65839095",
          "cat": [
            "IAB5-2"
          ],
          "adm": "{\"native\":{\"assets\":[{\"id\":1,\"required\":1,\"title\":{\"text\":\"Interested in studying Psychology?\"}},{\"id\":2,\"required\":1,\"img\":{\"url\":\"https://zem.outbrainimg.com/p/srv/sha/06/b9/16/6988145239d55e2001fa397a72b83e375c.jpg?w=150\\u0026h=150\\u0026fit=crop\\u0026crop=CENTER\\u0026fm=jpg\",\"w\":150,\"h\":150}},{\"id\":4,\"required\":1,\"data\":{\"value\":\"Nation\"}},{\"id\":5,\"data\":{\"value\":\"Search for the psychology courses suited for your educational goals.\"}},{\"id\":9,\"data\":{\"value\":\"nation.com\"}},{\"id\":10,\"data\":{\"value\":\"Learn More\"}},{\"id\":11,\"img\":{\"url\":\"https://zem.outbrainimg.com/p/srv/sha/2a/81/1c/17cd665a58694172709099b508945f5068.jpg?w=50\\u0026h=50\\u0026fit=crop\\u0026crop=center\\u0026fm=jpg\",\"w\":50,\"h\":50}}],\"link\":{\"url\":\"https://r1-euc1.zemanta.com/rp2/b1_yeahmobi/15875358/65839095/UTBHQ7NL473YAIMQZUY2HAM2NS55RCKI3SHMTAJWU2NQXBDZ2GKB7TBEDUMDVOGD3JGWBCN4AHLUTFSKXUY3CT7YI4257BBJSQZXBSSK5DA7S26TQD7V36U7EK4IEC2OMI4JTFMZ5BCIXGQRA3RVLH5OKHF2JTS3GFQEQK77WJV5RJ3OK7GJSVWUUOVFHOVW5ULLJOUAB6IULIY2I5RWDBTTSHSVXDIZKXDKJC5E3VVNR5QDM5JX67EWF7HQ5NPGEVHUXO5HAIRYIYSNKFGTTHG7MW4ZSGJAEE2OSX37G7XBNJR5O5CHEDCTVE3T3TEKMKAEHAVG6RFHNVZDPJPRFLNLKXP6X2V74XSZ664JOWKI3PKKWNX3R2VAPUEBGKHGQY7EXN5IQ64OQ55WMDPC3NLGBHP3JQ7DT6ZYJ2AYFGINNRKF7X7NDKUNEGEKF4LQPWAGYIC6MC3Q6FFETQNUVZ74L7DG3NHATZLEHA6KENTROBOEZFSPOVRRFEM5MILACQCTNJYWUW45AHCZIRWM2BR2V5WVJ7EGFEMP3ZXDPSPRPDFGVPJQALAKKAKTXVSIR3AXKTOJSEYKHLP3WJQMREZREGEVCG56GI5QKQMAW6CACX7HABGS525W4DJICNZDA2T6EEP4RVTBAVNTJ7NSFHL3HMDYEVSFG37Q7GD5ACL2L6YFX7WQMOTKU2NUZRHUK6XAWLTL3GT3BK2AAP2TCCR4SG3BSRN3G62F5RYUCKY7BUXGV76D2WI5D74OM2YNVVAWMOHUG5KH4/\",\"clicktrackers\":[\"https://gwbudgetali.iymedia.me/click.php?1=1\\u0026appName=outbrain\\u0026adx=yandex\\u0026requestId=1545692916559180241\\u0026impId=4\\u0026bidId=6beac02b-af24-11ec-a3ac-f45f1fae223d\\u0026publisherId=16617488\\u0026region=eu-central-1\\u0026host=ali-fra109-gatewaydocker-135-248\\u0026bidUtcTime=1648533150588\\u0026country=DEU\\u0026impType=native\\u0026os=android\\u0026osv=11\\u0026tagid=295403-4\"]},\"eventtrackers\":[{\"event\":1,\"method\":1,\"url\":\"https://b1t-eudc1.zemanta.com/t/imp/impression/Z4HKKGW326LPMAHHY4NG3JIYOKUJGVXQZQOODUEEK334TLJP3BTMA7P36Y6IOCFP6AYSYE32L2FGLKYJHI2A5R2ASBSR7KJ4GAMUEOZIZIZ22YBXI3JXHJUVUPLXJIS4W326L7LS33BXG3QCIIIUX3IZM2DKXAHERPO2VAVAIT2PYBK53RGFZTT3D7KQ5M5CK2O2I5FYYEQ7UAUNTIAGGNWPUPL6VBJPHRXHTQ6H65ISO2JDC6AWVTP35PHELMGMUZR7GDWBNBZZVRBMSXQOLCVO4XXOM3CNENGU4JWPF2OZOKRF7B7FI2VVPYR5BAMUTQW2MED4B2J4VYIOKQTISO6IJQDS7TR6RYLCBRY/?\"}]}}",
          "adid": "0000",
          "ext": {
            "nroa": {
              "erid":"efr23i",
              "has_nroa_markup":0,
              "client":{
                "inn":"71445203",
                "name":"ООО Неваляшка",
                "legal_form":"ul"
              }
            }
          }
        }
      ]
    }
  ]
}
Copied to clipboard