website

Получить код вставки с уровня сайта. Код вставки с уровня сайта необходимо получить один раз для площадки и установить на все страницы сайта.

  1. Формат запроса
  2. Формат ответа
  3. Параметры ответа
  4. Другие действия с объектом

При загрузке страницы сайта код вставки отправит запрос в ADFOX вместе с информацией об адресе страницы сайта.

ADFOX по шаблонам страниц разделов определит, к какому разделу принадлежит страница, с которой был отправлен запрос, и найдет в этом разделе площадку. Если на площадке есть баннеры из коммерческих рекламных кампаний, то система будет выбирать наиболее подходящий для показа баннер. Если же коммерческих рекламных кампаний для показа нет, то будет показан либо баннер по умолчанию с уровня площадки, либо баннер по умолчанию с уровня типа баннера.

Формат запроса

https://api.adfox.ru/v1/API.php
 ? loginAccount=<string>
 & loginPassword=<string>
 & object=placement
 & action=info
 & mode=website
 & websiteID=<integer>
 & bannerTypeID=<integer>
 & positionID=<integer>
 & synchronousFactor=<integer>
 & parametersDivider=<integer>
 & [nonRepeatingPlaces=<integer>]
Query-параметры
websiteID *

ID сайта.

См. также:

bannerTypeID *

ID типа баннера, который присвоен площадке.

См. также:

positionID *

ID расположения площадки.

См. также:

synchronousFactor *

Вид кода.

Допустимые значения:

  • 0 — синхронный;
  • 1 — асинхронный;
  • 2 — асинхронный с проверкой скролла;
  • 3 — адаптивный.
parametersDivider *

Разделитель параметров запроса, не используется в кодах вставки с библиотекой loader.js.

Допустимые значения:

  • 0 — &amp;
  • 1 — &.
nonRepeatingPlaces

Получить указанное количество кодов вставки для неповторяющихся площадок.

Допустимые значения: от 1 до 20.

Значение по умолчанию: 1.

*  Обязательный параметр

Формат ответа

<response>
  <status>
   <code>0</code>
  </status>
  <result>
    {string}
  </result>
</response>

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

code

Статус обработки запроса. Расшифровку смотрите в разделе Обработка ошибок.

HTML

HTML-код вставки.

mobileSDK_iOS

Код вставки для мобильного приложения в iOS.

mobileSDK_Android

Код вставки для мобильного приложения в Android.

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

Запрос:

https://api.adfox.ru/v1/API.php?loginAccount={your_login}&loginPassword={sha256_your_password}&object=placement&action=info&mode=website&websiteID=3453&bannerTypeID=123&positionID=3

Ответ:

<response>
  <status>
   <code>0</code>
  </status>
  <result>
   <HTML>
     <!--В head сайта один раз подключите библиотеку--> <script src="https://yastatic.net/pcode/adfox/loader.js"></script> <!--AdFox START--> <!--o.maximova--> <!--Площадка: 4416 / * / *--> <!--Тип баннера: Rich Media--> <!--Расположение: <верх страницы>--> <div id="adfox_1481217653719914"></div> <script> window.Ya.adfoxCode.create({ ownerId: 166283, containerId: 'adfox_1481217653719914', params: { pp: 'g', ps: 'cgdy', p2: 'p', puid1: '', puid2: '', puid6: '', puid8: '' } }); </script>
   </HTML>
  </result>
</response>

Другие действия с объектом

См. также другие действия с объектом website: