zone

Добавить раздел сайта.

Если к аккаунту в ADFOX подключены продукты: ADFOX.Sites, ADFOX.Mobile, или ADFOX.Exchange, то используйте объекты: website, zone, place (так как в системе используются объекты «сайт», «раздел» и «площадка» для разметки площадок и размещения баннеров).

Если к аккаунту в ADFOX подключен продукт ADFOX.Nets — то используйте объекты adNetwork, adNetworkWebsite (так как в системе используются объекты «рекламная сеть» и «сайт рекламной сети» для разметки площадок и размещения баннеров).

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

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

https://api.adfox.ru/v1/API.php
 ? loginAccount=<string>
 & loginPassword=<string>
 & object=account
 & action=add
 & actionObject=zone
 & name=<string>
 & siteID=<integer>
 & [categoryID=<integer>]
 & [isAutoReferer=<integer>]
 & [templateTypeID=<integer>]
 & [template=<string>]
 & [templateExcluded=<string>]
Query-параметры
name *Название объекта. Может содержать русские и латинские буквы, цифры и любые символы.
siteID *

ID сайта, в котором создается раздел.

См. также:

categoryID

ID категории.

См. также:

isAutoReferer

Динамическое определение раздела сайта по referer.

Каждый запрос за баннером содержит информацию об адресе страницы (referer), откуда идет запрос.

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

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

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

  • 1 — включено;
  • 0 — выключено;
Значение по умолчанию: 1.
templateTypeID

Тип шаблонов страниц. Подробнее о типах шаблонов см. Шаблоны referer.

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

  • 0 — стандартный;
  • 1 — POSIX.2.

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

template

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

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

  • для стандартного типа шаблонов:
    ٭site.ru/index.php
  • Для POSIX.2:
    homer-simpson-tv\.blog4ever\.com|forum\.rojadirecta\.org|^hidan\.eklablog\.com.٭|^aniworld\.spb\.ru\/.٭\/adfox\/.٭s$

Может содержать русские и латинские буквы, цифры и любые символы.

templateExcluded

Шаблоны страниц, которые не должны относиться к данному разделу сайта.

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

  • для стандартного типа шаблонов:
     http://٭website.ru

    Под такой шаблон попадут адреса: http://website.ru, http://example.website.ru

  • Для POSIX.2:
    homer-simpson-tv\.blog4ever\.com|forum\.rojadirecta\.org|^hidan\.eklablog\.com.٭|^aniworld\.spb\.ru\/.٭\/adfox\/.٭s$

    Под такой шаблон попадут адреса: homer-simpson-tv.blog4ever.com, http://homer-simpson-tv.blog4ever.com/?a=1212, forum.rojadirecta.org, https://www.forum.rojadirecta.org/?b=123, hidan.eklablog.com/?b=123, aniworld.spb.ru/123/adfox/s

Может содержать русские и латинские буквы, цифры и любые символы.

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

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

<response>
 <status>
  <code>{integer}</code>
  <ID>{integer}</ID>
</status>
</response>

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

code

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

ID

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

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

Запрос:

https://api.adfox.ru/v1/API.php?loginAccount={your_login}&loginPassword={sha256_your_password}&object=account&action=add&actionObject=zone&name=news&siteID=39939&isAutoReferer=1&templateTypeID=0&template=http://site.ru&templateExcluded=http://*site.ru/*

Ответ:

<response>
            <status>
            <code>0</code>
            <ID>84438</ID>
            </status>
            </response>

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

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