Спецификация платформы AdRiver SSP
Процесс интеграции DSP-платформы с продуктом AdRiver SSP описан в разделе «Подключение DSP».
Так же рекомендуем ознакомиться с форматами рекламных материалов участников RTB-торгов и требованиями, предъявляемыми к ним.
1. Параметры платформы AdRiver SSP
1.1. Общие параметры платформы
| Параметр | Значение | Описание |
| Протокол | OpenRTB v2.0 | Спецификация протокола |
| Валюта аукциона | RUB | Российский рубль |
| Модель ставок | CPM (Cost-per-thousand impressions) |
Значение ставки за лот переводится в значение стоимости за тысячу показов рекламного блока |
| Тип аукциона | Аукцион второй цены |
Аукцион выигрывает DSP с максимальную ставкой. При этом покупка осуществляется по второй максимальной ставке (используется алгоритм «аукциона второй цены») плюс 1/100 единицы валюты аукциона. Например, на лот поступило три ставки: 10, 15 и 20 рублей. Выигрывает лот участник, сделавший ставку в 20 рублей, но покупка лота при этом происходит по стоимости 15,01 рубля. В случае, если ставки совпали — победитель выбирается случайно среди участников с одинаковыми ставками |
| Время отклика | 100 мс | Время отклика DSP-платформы не должно превышать 100 миллисекунд |
| Объект показа | banner | Баннер |
| Метод передачи рекламного блока | Через атрибуты adm или nurl |
Тело рекламного блока передаётся в атрибуте adm объекта bid. Если атрибута adm не задан — рекламный блок ожидается при вызове ссылки из атрибута nurl объекта bid. Поддерживается использование атрибута nurl для оповещения о победе в аукционе. В случае отказа от участия в аукционе, DSP-платформа должна ответить кодом 204 |
1.2. Макросы, поддерживаемые AdRiver SSP
| Параметр | Пример | Описание |
| ${AUCTION_PRICE} |
http://mydsp.ru/ ?winnotice=1 &aid=![reqid] &aprice=${AUCTION_PRICE} |
Выигрышная цена |
|
//![rhost]/ cgi-bin/eclick.cgi ?xpid=![xpid] |
“nurl”: “http://dsp.domain.ru/ winnoticeurl &click=//![rhost]/ cgi-bin/eclick.cgi ?xpid=![xpid]” |
Отслеживании кликов в случае, когда DSP осуществляет перенаправление пользователя на целевой рекламный материал (ссылка для перехода) самостоятельно: AdRiver SSP информирует DSP-платформу о победе в аукционе. В посылаемом bid-запросе значение атрибута nurl содержит переменную click (имя переменной может отличаться), значение которой содержит макрос оповещения. DSP вызывает макрос из переменной, тем самым оповещая систему AdRiver о клике |
|
//![rhost]/ cgi-bin/click.cgi ?xpid=![xpid] ?rleurl=url |
“nurl”: “http://dsp.domain.ru/ winnoticeurl &click=//![rhost]/ cgi-bin/click.cgi ?xpid=![xpid] ?rleurl=http://mydsp.ru” |
Отслеживании кликов в случае, когда перенаправление на целевой рекламный материал осуществляет AdRiver SSP: При получении оповещения о победе в аукционе DSP вызывает макрос из переменной click с дополнительным параметром rleurl, содержащим ссылку для перехода. AdRiver осуществляет перенаправление посетителя по указанному в параметре rleurl адресу при вызове макроса |
| ![reqid] | “id”: “12345” | Уникальный идентификатор запроса |
| ![pos] | “pos”: 1 |
Положение рекламного блока на странице: 0 — неизвестно 1 — верх 2 — середина (в зависимости от разрешения экрана может быть виден или скрыт от посетителя) 3 – низ (скрыт от посетителя) |
| ![dsp_id] |
http://ssp.adriver.ru/ cgi-bin/sync.cgi ?dsp_id= YOUR_ID &external_id=USER_ID |
Идентификатор вашей DSP-платформы, назначенный AdRiver SSP. Необходим для синхронизации кук |
2. Синхронизация кук
База синхронизации кук всегда находится на стороне Adriver SSP. В случае наличия идентификатора и у SSP, и у DSP — оба параметра передаются в bid-запросе от AdRiver SSP. В случае отсутствия идентификатора у DSP — передаётся только идентификатор SSP.
Поддерживается как инициированная DSP, так и инициированная SSP синхронизация.
2.1. Синхронизация кук, инициированная DSP
Синхронизация кук осуществляется через следующий запрос:
http://ssp.adriver.ru/cgi-bin/sync.cgi?dsp_id=YOUR_ID&external_id=USER_ID
где:
- dsp_id=YOUR_ID — Идентификатор вашей DSP-платформы, назначенный AdRiver SSP
-
external_id=USER_ID — DSP-кука
Кука может содержать только буквенно-цифровые символы. В случае наличия в куке символов отличных от букв и цифр, external_id должен быть закодирован при помощи escape-последовательности
Пример кода синхронизации:
<img width="0" height="0" src="http://ssp.adriver.ru/cgi-bin/sync.cgi?dsp_id=999&external_id=332244"/>
От ssp.adriver.ru будет получен ответ HTTP 204.
2.2. Синхронизация кук, инициированная AdRiver SSP
AdRiver SSP инициирует процесс синхронизации кук для каждого нового пользователя системы.
Синхронизация происходит следующим образом:
- AdRiver SSP запрашивает от DSP ссылку синхронизации
- В полученной ссылке заменяет значение переменной ![cuid] на макрос
- Посылает запрос к DSP с подставленным значением
- Ожидает 302 ответа
- Осуществляет редирект на сервис синхронизации AdRiver SSP
3. Параметры bid-запроса
3.1. Bid-запрос
| Атрибут | Тип | Описание |
| id | string | Уникальный идентификатор bid-запроса |
| imp | array of objects | Массив баннеров. В одном bid-запросе может быть указано несколько объектов. Наличие по крайней мере одного баннера — обязательно. |
| device | object | Описание устройства отображения баннера (например, мобильные устройства, десктоп и другие) и параметры отображения (например, поддержка flash) |
| user | object | Описание пользователя. Может включать уникальные идентификаторы пользователей |
| site | object | Объект сайта или мобильного приложения. Может содержать только одно из двух значений |
| bcat | array of strings | Заблокированные рекламные категории* |
| cur | array of strings | Валюта аукциона |
3.2. Impression
| Атрибут | Тип | Описание |
| id | string | Уникальный идентификатор показа в контексте bid-запроса |
| banner | object | Ссылка на объект баннера |
| bidfloor | float | Минимальная стоимость показа в CPM* |
| bidfloorcur | string | Валюта минимальной стоимости показа |
3.3. Banner
| Атрибут | Тип | Описание |
| w | integer | Ширина баннера в пикселях |
| h | integer | Высота баннера в пикселях |
| pos | integer | Позиция на странице |
| battr | array of integer | Типы баннеров, заблокированных пользователем* |
3.4. Site
| Атрибут | Тип | Описание |
| id | string | Идентификатор сайта |
| ref | optional | Ссылка реферера, с которого произошел переход на страницу сайта |
| page | string | Полная ссылка страницы, где произошел показ* |
| cat | array of strings | Массив категорий по стандарту IAB (5 на весь сайт) |
| sectioncat | array of strings | Массив категорий по стандарту IAB (5 на весь сайт) |
3.5. Device
| Атрибут | Тип | Описание |
| ua | string | Строка браузера посетителя |
| ip | string | Язык браузера; стандарт alpha-2/ISO 639-1 |
| geo | object | * |
| language | string | * |
3.6. Geo
| Атрибут | Тип | Описание |
| country | string | Страна, стандарт ISO 3166-1* |
| region | string | Регион, стандарт ISO 3166-2* |
| city | string | MaxMind GeoCity* |
| zip | string | Индекс* |
3.7. User
| Атрибут | Тип | Описание |
| id | string | Уникальный идентификатор пользователя |
| buyeruid | string | * |
| Атрибут | Тип | Описание |
| id | string | Идентификатор bid-ответа |
| seatbid | array of objects | Массив seatbid объектов |
4.2. Seatbid
| Атрибут | Тип | Описание |
| bid | array of objects | Идентификатор bid-запроса. Массив bid-объектов, каждый из которых соотносится с impression-объектом (объектом показа) bid-запроса. Каждый impression-объект может содержать несколько bid-объектов |
4.3. Bid
| Атрибут | Тип | Описание |
| id | string | Идентификатор bid-объекта |
| impid | string | Идентификатор impression-объекта, к которому относится bid-объект |
| price | float | Ставка в CPM |
| adid | string | Идентификатор рекламного блока, который будет показан в случае, если аукцион будет выигран |
| adomain | array of strings | Основной домен/домен верхнего уровня для проверки рекламодателя |
| nurl | string | Ссылка оповещения о выигрыше лота |