modify

Редактировать параметры раздела сайта.

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

https://adfox.yandex.ru/api/v1
  ? object=zone
  & action=modify
  & objectID=<integer>
  & [name=<string>]
  & [categoryID=<integer>]
  & [isAutoReferer=<integer>]
  & [templateTypeID=<integer>]
  & [template=<string>]
  & [templateExcluded=<string>]

objectID*

ID объекта, над которым производится действие.

name

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

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>
</status>
</response>

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

code

Статус обработки запроса. Значение 0 — запрос выполнен успешно. Расшифровку смотрите в разделе Обработка ошибок.

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

Запрос:

https://adfox.yandex.ru/api/v1?object=zone&action=modify&objectID=543&name=site.ru/news

Ответ:

<response>
<status>
  <code>0</code>
</status>
</response>

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

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

Предыдущая
Следующая