Запрос

API размещения рекламы можно вызвать либо с клиентской стороны или с серверной стороны.

При использовании клиентской реализации на стороне, браузер может выполнить предварительный запрос. Если вы хотите избежать этого, в заголовке запроса используйте Content-Type: text/plain. Это гарантирует, что браузер классифицирует запрос как «простой» и, следовательно, пропустит предварительный запрос.

Также, при вызове API на клиентской стороне, IP-адреса на самом деле не требуются так как обнаружить IP с помощью фронтенда и JavaScript может быть сложно. Вместо этого наше API определяет IP по соединению в момент отправки запроса.

При использовании серверной реализации на стороне, чтобы обеспечить корректное таргетирование, нужно явно передавать корректный IP-адрес пользователя. В противном случае реклама будет таргетироваться по местоположению сервера, и позже это может привести к тому, что показы будут аннулированы из-за несоответствия IP.

Независимо от того, используется клиент или сервер, если IP передан, он будет иметь приоритет над тем, который мы определим.

Чтобы выполнить запрос к API размещения рекламы, нужно передать два объекта: user и zones. Запрос выполняется в формате JSON с использованием HTTP POST.

user

Параметр	Обязательно?	Описание
id	Нет	ID пользователя
ip	Рекомендуется	IP-адрес пользователя.
ua	Да	User Agent: строка, содержащая браузер/приложение пользователя и его устройство/ОС.
language	Нет	Устанавливает язык запроса с использованием стандартного двухсимвольного кода ISO плюс необязательный двухсимвольный код региона. Например en-us для американского английского.
referer	Нет	Адрес сайта, на котором будет показана реклама.
el	Нет	Email пользователя, закодированный в Base64.
screen_resolution	Нет	Разрешение экрана устройства, используемого пользователем
window_orientation	Нет	Это должно быть "portrait", если сайт имеет мобильную верстку, и "landscape", если это десктопная версия.
gdpr	Нет	Рекомендуемые расширения, связанные с конфиденциальностью (объект).

user.gdpr

Параметр	Описание
gdpr	Это должно быть 0 если вызывающая сторона считает, что пользователь не подпадает под GDPR, и 1 если пользователь подпадает под GDPR.
consent	Это строка согласия, требуемая стандартами IAB.

zones

Параметр	Обязательно?	Описание
id	Да	ID рекламной зоны
sub	Нет	Sub ID рекламной зоны
keywords	Нет	Любые keywords связанные с трафиком, которые могут соответствовать определённому типу рекламы. Если ключевых слов нет, для сопоставления будет использоваться URL сайта
custom_targeting	Нет	Пользовательские значения зоны (объект)

zones.custom_targeting

Параметр	Описание
ex_av	Это должно быть 0 если не определено, 1 если возраст подтверждён и 2 если возраст не подтверждён

Пример

Можно запросить множество рекламных зон одним запросом. У каждой зоны будет свой ID, как вы можете видеть в примере ниже.

{
  "user": {
    "id": "abdef8u9",
    "ip": "10.42.0.1",
    "ua": "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.63 Safari/537.36",
    "language": "en-US",
    "referer": "https://blabla.com",
    "gdpr": {
      "gdpr": 1,
      "consent": "CPAoZRHPArq3hBcADBENBJCgAAAAAAAAAAqIHKQAAOUgAAAA"
    }
  },
  "zones": [
    {
      "id": 4031007,
      "sub": 111,
      "keywords": "humour, general"
    },
    {
      "id": 4031015,
      "sub": 222
    },
    {
      "id": 4031019,
      "sub": 222
    }
  ]
}