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 and content links (images) must support HTTPS.
{
"bidid": "(string)",
"cur": "(string)",
"id": "(string)",
"seatbid": [
{
"bid": [
{
"adid": "(string)",
"adm": "{\"native\":{\"ver\":\"(string)\",\"link\":{\"url\":\"(string)\"},\"assets\":[{\"id\":(int),\"title\":{\"text\":\"(string)\"}},{\"id\":int,\"img\":{\"url\":\"(string)\",\"w\":int,\"h\":int}},{\"id\":int,\"data\":{\"value\":\"(string)\"}},{\"id\":int,\"data\":{\"value\":\"(string)\"}},{\"id\":int,\"data\":{\"value\":\"(string)\"}},{\"id\":int,\"img\":{\"url\":\"(string)\",\"w\":int,\"h\":int}}],\"eventtrackers\":[{\"event\":int,\"method\":int,\"url\":\"(string)\"},{\"event\":int,\"method\":int,\"url\":\"(string)\"}]}}",
"adomain": [
"(array of string)"
],
"bundle": "(string)",
"cat": [
"(string)"
],
"cid": "(string)",
"crid": "(string)",
"id": "(string)",
"impid": "(string)",
"iurl": "(string)",
"price": "(float)",
"ext": {
"nroa": {
"erid":"(string)",
"has_nroa_markup":"(int)",
"client":{
"inn":"(string)",
"name":"(string)",
"legal_form":"(string)"
}
},
"skadn": {
"campaign": "(string)",
"fidelities": [
{
"fidelity": "(int)",
"nonce": "(string)",
"signature": "(string)",
"timestamp": "(string)"
}
],
"itunesitem": "(string)",
"network": "(string)",
"sourceapp": "(string)",
"version": "(string)"
},
"storeurl": "(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 |
||
seat |
ID of the auction participant making a bid. |
yes |
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 |
nurl |
URL called when winning an auction. |
no |
attr |
A set of asset parameters. |
no |
burl |
URL called when debiting funds for a paid event. |
no |
adm |
Contains an encoded string with the |
no |
ext |
Object with additional parameters. |
no |
Seatbid.Bid.Adm.Native object |
||
ver |
Native Markup version. |
no |
assets |
The |
no |
eventtrackers |
The |
no |
link |
The |
yes |
privacy |
Privacy terms. |
no |
ext |
The |
no |
Seatbid.Bid.Adm.Native.Assets object |
||
id |
Asset ID. |
yes |
required |
Flag indicating whether the asset is mandatory. |
no |
title |
The |
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. |
yes |
url |
A link to an image. |
yes |
h |
Image height. |
yes |
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 |
skadn |
The parent object for the SKAdNetwork. |
no |
storeurl |
Initial app store url for the app to which a transition will be made. |
no |
nroa object |
||
erid |
ERID |
no |
has_nroa_markup |
Whether the creative includes labeling according to the legislation. Possible values: |
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 |
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 |
skadn object |
||
campaign |
Campaign ID compatible with Apple’s spec. As of version 2.0, this must be an integer between 1 and 100, formatted as a string. |
no |
fidelities |
Supports multiple fidelity types introduced in SKAdNetwork v2.2. |
no |
itunesitem |
Advertiser app ID in Apple’s App Store. This must match |
no |
network |
Ad network identifier used in signature. This must match one of the items in the |
no |
sourceapp |
ID of publisher app in Apple’s App Store. This must match |
no |
version |
Version of desired SKAdNetwork. |
no |
fidelities object |
||
fidelity |
The fidelity-type of the attribution to track. |
no |
nonce |
An ID that is unique to each ad response. Refer to Apple's documentation for the proper UUID format requirements. |
no |
signature |
SKAdNetwork signature specified by Apple. |
no |
timestamp |
Unix time in milliseconds at the time the signature was generated. |
no |
Asset parameters
Asset ID |
Asset Name |
Description |
Data Type |
Asset Type |
Restriction |
1 |
Title |
A title with a description related to the advertised product or service |
String |
Mandatory |
up to 140 characters |
2 |
Main image |
The primary banner to be displayed |
Img |
Mandatory |
minimum 150x150 |
5 |
Description |
Additional text related to the advertised product or service |
String |
Recommended |
up to 140 characters |
9 |
display_url |
The display domain or bundle to which a transition will be made. |
String |
Recommended |
up to 50 characters |
10 |
CTA |
Call to Action placed on a clickable button |
String |
Recommended |
up to 15 characters |
11 |
Icon |
An additional icon (favicon) for the advertisement of mobile applications. Often matches the icon from the app store. |
Img |
Recommended |
minimum 50x50 |
Response example
{
"bidid": "353776",
"cur": "USD",
"id": "4413312110307915961",
"seatbid": [
{
"bid": [
{
"adid": "native_123",
"adm": "{\"native\":{\"ver\":\"1.2\",\"link\":{\"url\":\"https://app.name.com/somepath\"},\"assets\":[{\"id\":1,\"title\":{\"text\":\"Покупай только у нас!\"}},{\"id\":2,\"img\":{\"url\":\"https://content.com/somepath.png\",\"w\":150,\"h\":150}},{\"id\":5,\"data\":{\"value\":\"Скидка 450 ₽ на первый заказ от 1 500 ₽ по промо «PROMO»\"}},{\"id\":9,\"data\":{\"value\":\"play.google.com\"}},{\"id\":10,\"data\":{\"value\":\"Установить\"}},{\"id\":11,\"img\":{\"url\":\"https://content.com/somepath/icon.png\",\"w\":50,\"h\":50}}],\"eventtrackers\":[{\"event\":1,\"method\":1,\"url\":\"https://dspname.com/imp/somepath\"},{\"event\":1,\"method\":1,\"url\":\"https://impression.appsflyer.com/somepath\"}]}}",
"adomain": [
"sbermarket.ru"
],
"bundle": "ru.instamart",
"cat": [
"IAB8"
],
"cid": "native_1",
"crid": "native_123",
"id": "353776",
"impid": "178",
"iurl": "https://content.com/somepath.png",
"price": 0.27445,
"ext": {
"nroa": {
"erid":"efr23i",
"has_nroa_markup":0,
"client":{
"inn":"71445203",
"name":"ООО Неваляшка",
"legal_form":"ul"
}
},
"skadn": {
"campaign": "11",
"fidelities": [
{
"fidelity": 0,
"nonce": "f9f8be1b-a396-4ff6-95e5-b50508caa18",
"signature": "MDUCGQD4bhRqyMk2lcz3/mi0943580485038Owgcz9tcS8acHhxMxqJ0K6P968spxQ==",
"timestamp": "1730704281000"
},
{
"fidelity": 1,
"nonce": "a5914e5b-4f06-4278-bc39-d0550678ff72",
"signature": "MDUCGH9mfWRIErBnitWx2/Vsx809485034858340VSXgsVCh2BHUXXvq54XcT/2qyaBYkw==",
"timestamp": "1730704280000"
}
],
"itunesitem": "911804296",
"network": "w9q455wk68.skadnetwork",
"sourceapp": "6471572249",
"version": "3.0"
},
"storeurl": "https://apps.apple.com/app/id1579364157"
}
}
]
}
]
}