Ответ DSP

Заявка на участие в аукционе передается методом POST в формате json (Content-Type: application/json).

В теле запроса содержится объект Bid Response, показанный ниже.

Внимание.
  1. Bid Response не может содержать параметры view_notice и view_notices одновременно.
  2. Ссылки на пиксели статистики записываются без протокола: «//www.domain.com».
  3. Пиксели статистики должны поддерживать HTTPS.
{  /* obj:Bid Response object */
   "bidid": (int),
   "id": (int),
   "cur": (string),
   "units": (int),
   "setuserdata": (string),
   "bidset": [
      {  /* obj:Bid Set object */
         "bid": [
            {  /* obj:Bid object */
               "id": (int),
               "adid": (int),
               "adomain": (array of string),
               "price": (int),
               "adm": (string),
               "properties": (string),
               "token": (string),
               "view_notice": (string),
               "banner": {
                  /* obj:Banner object */
                  "w": (int),
                  "h": (int),
                  "setskiptoken": (string)
               },
               "dsp_params": {
                  /* obj:DSP Params object */
                  "url_paramN": (string)
               },
               "nurl": (string),
               "view_notices": (array of string)
            }
         ]
      }
   ]
}
Параметры ответа
Параметр Описание Обязат.
Bid Response object
bidid Идентификатор заявки на участие в аукционе по внутренней нумерации DSP. да
id Идентификатор аукциона, полученный из RTB-хоста. да
cur
Валюта, в которой указана ставка – параметр price. Возможные варианты:
  • RUB — российский рубль;
  • USD — американский доллар;
  • EUR — евро;
  • CHF — швейцарский франк;
  • TRY — турецкая лира;
  • UAH — украинская гривна;
  • KZT — казахстанский тенге.
 да
units

Размерность ставки (количество показов):

  • 0 — ставка указана за сто тысяч показов;
  • 1 — ставка указана за тысячу показов;
  • 2 — ставка указана за миллион показов.

Если параметр отсутствует, подразумевается 0.

 нет
setuserdata

Данные, которые необходимо связать с потребителем и вернуть на DSP в следующем цикле показа рекламы этому потребителю (не более 22 символов). Данные связываются, только если DSP выигрывает аукцион.

Формат данных определяет DSP (см. Маркировка пользователей).

 нет
bidset

Массив объектов Bid Set. В текущей реализации содержит один объект.

 да
Bid Set object
bid Массив объектов Bid. Каждый объект содержит параметры баннера и ставку за показ. да
Bid object
id Идентификатор рекламного блока на HTML-странице, полученный из RTB-хоста. да
adid Идентификатор баннера в DSP. да
adomain Домен рекламодателя, чью рекламу содержит ответ DSP. Допустимо только одно значение в массиве. да
price

Ставка — цена показа, устраивающая DSP (целое число). Указывается за количество показов в соответствии с параметром units.

 да
adm

Фрагмент HTML для встраивания баннера на страницу (обвязка) 1 в формате Plain text без кодирования в Base64.

Обвязка может содержать макросы. Их значения необходимо передавать в объекте DSP Params.

 да
properties Строка свойств баннера в кодировке Base64 1 . да
token Цифровая подпись баннера 1 . да
view_notice
Пиксель для подсчета показанных баннеров.
Примечание. В статистику попадают только просмотренные пользователем баннеры.
 нет
banner Объект Banner с размерами рекламного блока. да
dsp_params

Объект DSP Params со значениями макросов.

Содержит до двадцати параметров url_param.

 нет
nurl

Содержит информацию о победе в аукционе.

 нет
view_notices
Массив пикселей для подсчета показанных баннеров.
Примечание. В статистику попадают только просмотренные пользователем баннеры.
 нет
Banner object
w

Ширина блока в пикселях.

 да
h

Высота блока в пикселях.

 да
setskiptoken

Любая текстовая информация. Указанное значение передается в параметр skiptoken (запрос из RTB-хоста).

 нет
DSP Params object
url_paramN

Значения макроса ${url_paramN}, где N — число от 1 до 20.

Значение подставляется в обвязку на место одноименного макроса. Перед подстановкой значение кодируется методом urlencode.

нет

Примечания

  1. Обвязку, свойства баннера и подпись (adm, properties, token) получают из Хранилища медиафайлов (см. документ REST API Хранилища медиафайлов).
Параметры ответа
Параметр Описание Обязат.
Bid Response object
bidid Идентификатор заявки на участие в аукционе по внутренней нумерации DSP. да
id Идентификатор аукциона, полученный из RTB-хоста. да
cur
Валюта, в которой указана ставка – параметр price. Возможные варианты:
  • RUB — российский рубль;
  • USD — американский доллар;
  • EUR — евро;
  • CHF — швейцарский франк;
  • TRY — турецкая лира;
  • UAH — украинская гривна;
  • KZT — казахстанский тенге.
 да
units

Размерность ставки (количество показов):

  • 0 — ставка указана за сто тысяч показов;
  • 1 — ставка указана за тысячу показов;
  • 2 — ставка указана за миллион показов.

Если параметр отсутствует, подразумевается 0.

 нет
setuserdata

Данные, которые необходимо связать с потребителем и вернуть на DSP в следующем цикле показа рекламы этому потребителю (не более 22 символов). Данные связываются, только если DSP выигрывает аукцион.

Формат данных определяет DSP (см. Маркировка пользователей).

 нет
bidset

Массив объектов Bid Set. В текущей реализации содержит один объект.

 да
Bid Set object
bid Массив объектов Bid. Каждый объект содержит параметры баннера и ставку за показ. да
Bid object
id Идентификатор рекламного блока на HTML-странице, полученный из RTB-хоста. да
adid Идентификатор баннера в DSP. да
adomain Домен рекламодателя, чью рекламу содержит ответ DSP. Допустимо только одно значение в массиве. да
price

Ставка — цена показа, устраивающая DSP (целое число). Указывается за количество показов в соответствии с параметром units.

 да
adm

Фрагмент HTML для встраивания баннера на страницу (обвязка) 1 в формате Plain text без кодирования в Base64.

Обвязка может содержать макросы. Их значения необходимо передавать в объекте DSP Params.

 да
properties Строка свойств баннера в кодировке Base64 1 . да
token Цифровая подпись баннера 1 . да
view_notice
Пиксель для подсчета показанных баннеров.
Примечание. В статистику попадают только просмотренные пользователем баннеры.
 нет
banner Объект Banner с размерами рекламного блока. да
dsp_params

Объект DSP Params со значениями макросов.

Содержит до двадцати параметров url_param.

 нет
nurl

Содержит информацию о победе в аукционе.

 нет
view_notices
Массив пикселей для подсчета показанных баннеров.
Примечание. В статистику попадают только просмотренные пользователем баннеры.
 нет
Banner object
w

Ширина блока в пикселях.

 да
h

Высота блока в пикселях.

 да
setskiptoken

Любая текстовая информация. Указанное значение передается в параметр skiptoken (запрос из RTB-хоста).

 нет
DSP Params object
url_paramN

Значения макроса ${url_paramN}, где N — число от 1 до 20.

Значение подставляется в обвязку на место одноименного макроса. Перед подстановкой значение кодируется методом urlencode.

нет

Примечания

  1. Обвязку, свойства баннера и подпись (adm, properties, token) получают из Хранилища медиафайлов (см. документ REST API Хранилища медиафайлов).

Пример ответа

{
    "bidset": [{
        "bid": [{
            "view_notice": "//domain.com/view?&price=${AUCTION_PRICE}",
            "price": 1100,
            "properties": "cXdlcnR5dWlvcA==",
            "dsp_params": {
                "url_param3": "&id=123"
            },
            "token": "QWERTY1234",
            "adid": "123456",
            "adomain":["domain.com"],
            "adm": "<script type=\"text/javascript\" src=\"//awaps.yandex.ru/0/s0216a158070p1v2/awcdnlib.js\"><\/script>  <script type=\"text/javascript\" >   if (typeof( CAwCdnCode) != \"undefined\") (new CAwCdnCode()).write(    {    'width' : 240,    'height' : 400,      'swf_src' : \"\" === \"0\" ? null : '${url_param1}',    'gif_src' : 'https://an.yandex.ru/media/qwerty.gif${url_param2}',      'gif_click' : 'http://domain.com/landing${url_param3}',    'swf_click' : 'http://domain.com/landing${url_param4}',       'pixel_stat1' : '${url_param5}',    'pixel_stat2' : '',      'alt' : 'alt_text',    'gif_tizer' : 0,      'flashvars' : '${url_param7}'   }  );  <\/script>",
            "banner": {
                "h": 400,
                "w": 240
            },
            "id": "2"
        }]
    }],
    "bidid": 12345678910,
    "units": 2,
    "id": "5916234851088814081",
    "cur": "RUB"
}