Запрос из OpenRTB-хоста

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

Тело запроса

В теле запроса содержится объект Bid Request. Его параметры характеризуют приложение, конечное устройство, потребителя. Эти характеристики помогают DSP подобрать рекламу и ставку.

{
  "source": {
    "fd": "(int)",
    "sourcetype": "(int)",
    "tid": "(string)",
    "ext": {
      "schain": {
        "complete": "(int)",
        "nodes": [
          {
            "asi": "(string)",
            "sid": "(string)",
            "hp": "(int)",
            "rid": "(string)"
          }
        ],
        "ver": "(string)"
      }
    }
  },
  "id": "(string)",
  "user": {
    "buyeruid": "(string)",
    "id": "(string)",
    "ext": {
      "consent": "(string)"
    }
  },
  "imp": [
    {
      "bidfloor": "(float)",
      "bidfloorcur": "(string)",
      "displaymanager": "(string)",
      "id": "(string)",
      "instl": "(int)",
      "ext": {
        "unmoderated": "(int)",
        "skadn": {
          "version": "(string)",
          "versions": ["(array of strings)"],
          "sourceapp": "(int)",
          "skadnetids": [
            "(array of strings)"
          ],
          "fidelities": [
            "(array of strings)"
          ]
        }
      },
      "secure": "(int)",
      "tagid": "(string)",
      "native": {
        "request": "{ \"native\": {\"ver\": \"(string)\",\"aurlsupport\": (int),\"privacy\": (int),\"plcmtcnt\": (int),\"assets\": [{\"required\":(int),\"title\": {\"len\": (int)},\"id\": (int)}, {\"required\": (int),\"img\": {\"wmin\": (int),\"type\": (int),\"hmin\": (int)},\"id\": (int)},{\"required\": (int),\"data\": {\"len\": (int),\"type\": (int)},\"id\": (int)},{\"required\": (int),\"data\": {\"len\": (int),\"type\": (int)},\"id\": (int)},{\"required\": (int),\"data\":{\"len\":(int),\"type\": (int)},\"id\": (int)},{\"required\": (int),\"img\":{\"wmin\": (int),\"type\": (int),\"hmin\": (int)},\"id\": (int)}],\"eventtrackers\":[{\"methods\":[(int)],\"event\": (int)}]}}",
        "ver": "(string)"
      },
      "displaymanagerver": "(string)",
      "clickbrowser": "(int)"
    }
  ],
  "tmax": "(int)",
  "app": {
    "bundle": "(string)",
    "id": "(string)",
    "publisher": {
      "id": "(string)"
    },
    "storeurl": "(string)",
    "content": {
      "language": "(string)"
    }
  },
  "bcat": [
    "(array of strings)"
  ],
  "cur": [
    "(array of strings)"
  ],
  "device": {
    "lmt": "(int)",
    "geo": {
      "country": "(string)"
    },
    "carrier": "(string)",
    "mccmnc": "(string)",
    "connectiontype": "(int)",
    "os": "(string)",
    "ip": "(string)",
    "ipv6": "(string)",
    "dnt": "(int)",
    "ifa": "(string)",
    "ua": "(string)",
    "devicetype": "(int)",
    "make": "(string)",
    "model": "(string)",
    "osv": "(string)",
    "h": "(int)",
    "w": "(int)",
    "language": "(string)",
    "dpidsha1": "(string)",
    "dpidmd5": "(string)",
    "ext": {
      "oaid": "(string)",
      "gaid": "(string)",
      "idfa": "(string)"
    }
  },
  "ext": {
    "notifications": {
      "lurl": "(int)",
      "nurl": "(int)"
    }
  },
  "regs": {
    "coppa": "(int)",
    "ext": {
      "gdpr": "(int)",
      "nroa": {
        "version": "(string)",
        "mandatory": "(bool)"
      }
    }
  },
  "at": "(int)",
  "test": "(int)"
}

Параметры запроса

Параметр

Описание

Обязательность

Bid Request object

source

Информация о источнике запроса в объекте Source.

да

id

Идентификатор аукциона, присвоенный RTB-хостом. DSP возвращает этот идентификатор в ответе.

да

user

Информация о покупателе рекламы в объекте User.

да

cur

Список валют для ставок. Передаются следующие параметры:

  • RUB — российский рубль;
  • USD — американский доллар;
  • EUR — евро;
  • CHF — швейцарский франк;
  • TRY — турецкая лира;
  • UAH — украинская гривна;
  • KZT — казахстанский тенге.

да

bcat

Категории заблокированных рекламодателей согласно классификации IAB.

нет

imp

Массив объектов Imp, которые содержат параметры визуализации баннера. Каждый объект соответствует одному рекламному блоку на HTML-странице. В текущей реализации передается один объект.

да

tmax

Максимальное время ответа в миллисекундах, в течение которого нужно сделать ставку, с учетом задержки в интернете.

да

app

Информация о приложении в объекте App.

да

ext

Объект Ext с дополнительными параметрами.

нет

device

Информация о конечном устройстве в объекте Device.

да

regs

Отраслевые, правовые или правительственные нормативные акты, действующие для всех показов в запросе, в объекте Regs.

нет

at

Тип аукциона. Возможные значения:

  • 1 — аукцион первой цены;
  • 2 — аукцион второй цены.

нет

test

Индикатор тестового режима. Возможные значения:

  • 0 — отправка реального трафика;
  • 1 — отправка тестового трафика.

нет

Ext object

notifications

Объект Ext.Notifications с URL-адресами уведомлений о выигрыше или проигрыше ставки.

нет

Ext.Notifications object

lurl

Вероятность вызова ссылки-уведомления о проигрыше. Возможные статусы:

  • 0 — нет;
  • 1 — да;
  • 2 — возможно.

нет

nurl

Вероятность вызова ссылки-уведомления о выигрыше. Возможные статусы:

  • 0 — нет;
  • 1 — да;
  • 2 — возможно.

нет

Imp object

bidfloor

Минимальная стоимость показа для текущего аукциона, указанная в формате CPM.

да

bidfloorcur

Буквенный код валюты в формате ISO-4217. Может отличаться от валюты предложения, возвращенной участником торгов, если это разрешено биржей.

да

displaymanager

Название монетизатора или SDK.

нет

id

Идентификатор рекламного блока на HTML-странице.

да

instl

Тип рекламы. Возможные варианты:

  • 0 — неполноэкранная реклама;
  • 1 — полноэкранная реклама.

да

ext

Объект Imp.Ext с дополнительными параметрами.

нет

secure

Тип соединения. Возможные варианты:

  • 0 — незащищенное соединение (HTTP);
  • 1 — защищенное соединение (HTTPS).

нет

tagid

Идентификатор места размещения объявления.

да

native

Объект Imp.Native с параметрами рекламного блока.

да

displaymanagerver

Версия монетизатора или SDK.

да

clickbrowser

Тип браузера, открываемого при нажатии на креатив в приложении. Возможные значения:

  • 0 — встроенный браузер;
  • 1 — нативный браузер.

да

Imp.Native object

ver

Версия Native Markup.

нет

request

Содержит закодированную строку с объектом Native. См. пример запроса.

да

aurlsupport

Флаг, указывающий на поддержку опции возврата ссылки на объект.

  • 0 — опция не поддерживается;
  • 1 — опция поддерживается.

нет

privacy

Условия конфиденциальности.

  • 1 — нативная реклама содержит уведомление о конфиденциальности для пользователя;
  • 0 — нет уведомлений о конфиденциальности.

нет

plcmtcnt

Количество блоков размещения рекламы.

нет

assets

Объект Native.Request.Native.Assets с параметрами ассетов.

да

eventtrackers

Объект Imp.Native.Request.Native.Eventtrackers с параметрами отслеживания событий.

нет

Imp.Native.Request.Native.Assets object

id

Идентификатор ассета.

да

required

Флаг, указывающий на обязательность ассета.

  • 1 — обязательный ассет;
  • 0 — необязательный ассет.

нет

title

Объект Imp.Native.Request.Native.Assets.Title с параметрами заголовка ассета.

да

img

Объект Imp.Native.Request.Native.Assets.Img с параметрами изображения в ассете.

нет

data

Объект Imp.Native.Request.Native.Assets.Data с параметрами содержимого ассете.

нет

Imp.Native.Request.Native.Assets.Title object

len

Длина заголовка баннера.

да

Imp.Native.Request.Native.Assets.Img object

wmin

Минимальная ширина изображения.

да

type

Тип изображения.

да

hmin

Минимальная высота изображения.

да

Imp.Native.Request.Native.Assets.Data object

len

Максимальная длина текста в ответе.

нет

type

Тип данных в ассете.

да

Imp.Native.Request.Native.Eventtrackers object

type

Тип отслеживаемых событий.

да

method

Способ отслеживания событий.

да

Imp.Ext object

unmoderated

Статус модерации аукциона. Возможные значения:

  • 0 — немодерируемый аукцион.
  • 1 — модерируемый аукцион.

да

Imp.Ext.skadn object

version

Самая старшая версия из поддерживаемых на запросе.

нет

versions

Список поддерживаемых версий (в зависимости от версии SDK и версии iOS).

нет

sourceapp

Идентификатор приложения (совпадает с полем app.bundle).

нет

skadnetids

Список идентификаторов, получаемый из SDK.

нет

fidelities

Список поддерживаемых типов fidelity, зависит от версии SKAdNetwork и SDK.

нет

App object

bundle

Идентфикатор приложения в AppStore или GooglePlay.

нет

publisher

Информация о площадке в объекте App.Publisher.

да

storeurl

URL-адрес магазина приложений для установленного приложения.

нет

id

Идентификатор приложения.

да

content

Объект App.Content с информацией о содержимом приложения.

нет

App.Publisher object

id

Идентификатор площадки.

да

App.Content object

language

Язык приложения.

нет

Device object

lmt

Ограничение отслеживания рекламы, заданное производителем конечного устройства.

  • 0 — отслеживание не ограничено;
  • 1 — отслеживание ограничено.

да

geo

Объект Device.Geo с описанием местоположения конечного устройства.

да

carrier

Оператор связи или интернет-провайдер.

нет

connectiontype

Тип сетевого соединения.

  • 0 — не определено;
  • 1 — Ethernet (локальная сеть);
  • 2 — WI-FI;
  • 3 — сотовая связь;
  • 4 — сотовая связь 2G;
  • 5 — сотовая связь 3G;
  • 6 — сотовая связь 4G.

нет

os

Операционная система.

да

ip

IP-адрес конечного устройства.

да

ipv6

IPv6-адрес конечного устройства.

да

dnt

Ограничение отслеживания рекламы, заданное пользователем конечного устройства.

  • 0 — отслеживание не ограничено;
  • 1 — отслеживание ограничено.

да

ua

Значение HTTP-заголовка User-Agent — название приложения на конечном устройстве.

да

ifa

Рекламный идентификатор конечного устройства.

да

devicetype

Тип устройства:

  • 1 — телефон;
  • 3 — смартфон;
  • 4 — планшет;
  • 5 — десктоп.

нет

make

Производитель устройства.

нет

mccmnc

Уникальный идентификатор оператора мобильной связи, получаемый объединением кодов MCC и MNC через дефис.

нет

model

Модель устройства.

нет

osv

Версия операционной системы устройства.

нет

h

Высота устройства.

нет

w

Ширина устройства.

нет

language

Язык, выбранный в браузере. Используемый формат — ISO-639-1-alpha-2.

нет

dpidsha1

Идентификатор платформы устройства (например, идентификатор Android), хешированный по алгоритму SHA1.

нет

dpidmd5

Идентификатор платформы устройства (например, идентификатор Android), хешированный по алгоритму MD5.

нет

ext

Объект Device.Ext с дополнительными параметрами.

нет

Device.Geo object

country

Геокод страны по классификации ISO-3166-1 Alpha-3.

да

Device.Ext object

oaid

Идентификатор устройства.

нет

gaid

Идентификатор Android-устройств.

нет

idfa

Идентификатор iOS-устройств.

нет

User object

id

Биржевой идентификатор пользователя.

нет

buyeruid

Идентификатор покупателя.

нет

ext

Объект User.Ext с дополнительными параметрами.

нет

User.Ext object

consent

Согласие на передачу сведений о покупателе. Возможные значения:

  • 0 — не согласен;
  • 1 — согласен.

нет

Regs object

coppa

Флаг, указывающий, попадает ли запрос под действие закона о защите конфиденциальности детей в Интернете (COPPA).

  • 0 — нет;
  • 1 — да.

да

ext

Объект Regs.Ext с дополнительными параметрами.

нет

Regs.Ext object

gdpr

Флаг, указывающий, попадает ли запрос под действие общего положения о защите данных (GDPR).

  • 0 — нет;
  • 1 — да.

да

nroa

Родительский объект для расширения.

нет

Ext.nroa object

version

Номер версии. Текущую версию см. в приложении.

нет

mandatory

При значении true сообщает о том, что ответы DSP без полной и корректной информации о договорах будут не допущены к аукциону.

нет

Source object

fd

Финальное решение о показе объявления.

  • 0 — биржа;
  • 1 — исходный источник.

да

sourcetype

Источник запроса.

  • 1 — запрос исходит не от аукциона Header bidding;
  • 2 — запрос исходит c клиентской стороны аукциона;
  • 3 — запрос исходит со стороны сервера.

да

tid

Идентификатор показа.

да

ext

Объект Source.Ext с дополнительными параметрами.

нет

Source.Ext object

schain

Объект Source.Ext.Schain с указанием всех участников цепочки продажи инвентаря.

нет

Source.Ext.Schain object

complete

Флаг указывает на то, содержит ли цепочка все ноды до первоначального источника инвентаря. Возможные значения:

  • 0 — нет;
  • 1 — да.

да

nodes

Массив объектов Source.Ext.Schain.Nodes с порядком расположения участников в цепочке.

да

ver

Версия спецификации supply chain. На данный момент существует только версия 1.0.

да

Source.Ext.Schain.Nodes object

asi

Канонический домен организации, должен совпадать с доменом из ads.txt, если такой существует.

да

sid

Тот же идентификатор seller_id для издателя, что и в файле sellers.json.

да

hp

Указывает, должен ли этот нод быть включен в цепочку участников оплаты за инвентарь. Если значение равно 1, то организация, указанная в поле asi, платит продавцу, указанному в поле sid. Продавец — организация, которая отвечает за оплату предыдущему ноду в цепочке. Для версии 1.0 значение всегда должно быть равно 1.

да

rid

OpenRTB RequestId, отправленный продавцом.

нет

name

Официальное наименование организации, поле не должно присутствовать в объекте, если организация указана в sellers.json.

нет

domain

Официальный домен организации, поле не должно присутствовать в объекте, если организация указана в sellers.json.

нет

Пример запроса

{
    "app": {
        "bundle": "com.avito.android",
        "content": {
            "language": "ru"
        },
        "id": "131313",
        "publisher": {
            "id": "2424224"
        },
        "storeurl": "https://play.google.com/store/apps/details?id=com.avito.android",
        "ver": "183.6"
    },
    "at": 1,
    "cur": [
        "RUB",
        "USD",
        "EUR",
        "TRY",
        "UAH",
        "KZT",
        "CHF"
    ],
    "device": {
        "carrier": "Beeline",
        "connectiontype": 6,
        "devicetype": 4,
        "dnt": 0,
        "dpidmd5": "",
        "dpidsha1": "",
        "ext": {
            "gaid": "",
            "oaid": ""
        },
        "geo": {
            "country": "RUS",
            "latitude": 59.34,
            "longitude": 29.61,
            "region": "RU-LEN",
            "type": 2
        },
        "h": 713,
        "ifa": "e7ae-e7ae-e7ae-e7ae-08d5f943e89a",
        "ip": "176.15.167.236",
        "language": "ru",
        "lmt": 0,
        "make": "HUAWEI",
        "mccmnc": "250-99",
        "model": "ELE-L29",
        "os": "Android",
        "osv": "10",
        "ua": "Dalvik/2.1.0 (Linux; U; Android 10; ELE-L29 Build/HUAWEIELE-L29)",
        "w": 360
    },
    "ext": {
        "notifications": {
            "lurl": 1,
            "nurl": 1
        }
    },
    "id": "5327799747007558846",
    "imp": [
        {
            "bidfloor": 0.5211128635,
            "bidfloorcur": "USD",
            "clickbrowser": 1,
            "displaymanager": "Yandex Mobile Ads SDK",
            "displaymanagerver": "6.0.1",
            "ext": {
                "unmoderated": 0
            },
            "id": "166",
            "instl": 0,
            "native": {
                "request": "{\"native\":{\"ver\":\"1.2\",\"aurlsupport\":0,\"privacy\":0,\"plcmtcnt\":1,\"assets\":[{\"required\":1,\"title\":{\"len\":140},\"id\":1},{\"required\":1,\"img\":{\"wmin\":150,\"type\":3,\"hmin\":150},\"id\":2},{\"required\":0,\"data\":{\"len\":140,\"type\":2},\"id\":5},{\"required\":0,\"data\":{\"len\":10,\"type\":3},\"id\":6},{\"required\":0,\"data\":{\"len\":20,\"type\":4},\"id\":7},{\"required\":0,\"data\":{\"len\":20,\"type\":6},\"id\":8},{\"required\":0,\"data\":{\"len\":50,\"type\":11},\"id\":9},{\"required\":0,\"data\":{\"len\":15,\"type\":12},\"id\":10},{\"required\":0,\"img\":{\"wmin\":50,\"type\":1,\"hmin\":50},\"id\":11}],\"eventtrackers\":[{\"methods\":[1],\"event\":1}]}}",
                "ver": "1.2"
            },
            "secure": 1,
            "tagid": "134783-166"
        }
    ],
    "regs": {
        "coppa": 0,
        "ext": {
            "gdpr": 0,
            "nroa": {
                "mandatory": true,
                "version": "2"
            }
        }
    },
    "source": {
        "ext": {
            "schain": {
                "complete": 1,
                "nodes": [
                    {
                        "asi": "yandex.com",
                        "hp": 1,
                        "sid": "2412782"
                    }
                ],
                "ver": "1.0"
            }
        },
        "fd": 0,
        "sourcetype": 3,
        "tid": ""
    },
    "tmax": 500,
    "user": {
        "ext": {
            "consent": ""
        },
        "id": "90994348844570239403757"
    }
}
Предыдущая
Следующая