История изменений

20.06.2025

При получении списка кампаний:

• Добавлены параметры ответа:

  • kind_id
  • sectorID
  • rotationMethodID
  • trafficPercents
  • logicType
  • cpm
  • cpc

• C 23.06.2025 будут передаваться со значением 0 (для okveds — пустое значение), с 01.07.2025 не будут передаваться в ответе параметры:

  • type
  • tracingPointsType
  • outerMarkID
  • bannerSequence
  • sequence
  • scenarioPeriodID
  • mainPointID
  • okveds
  • pricingModelID
  • pricingTypeID
  • paymentMethodID
  • pricingModel
  • itemCost
  • itemQty

03.03.2025

Удалены устаревшие параметры запроса impressionsPerNPerHour и impressionsPerN для таргетирования по времени:

• баннера и кампании;
• размещения кампании на сайте, разделе, площадке.

10.02.2025

• Добавлены параметры запроса при создании и редактировании баннера:

  • markingKktu
  • markingCommonDescription
  • markingSendRegionsType
  • markingSelectedRegions

• Добавлены методы работы с маркировкой рекламы для получения списков:

  • кодов и названий справочника ККТУ;
  • регионов показа рекламы ЕРИР.

23.01.2025

• Добавлены параметры запроса при создании и редактировании баннера:

  • sendToErirContentType<ParameterN>
  • sendToErirDescription<ParameterN>

• Расширен список допустимых значений для параметра creativeContentType при создании и редактировании баннера.

• Удален параметр запроса okveds[] при создании и редактировании баннера.

20.12.2024

• Удалены параметры при создании, редактировании и получении списка суперкампаний:

  • level
  • priority
  • maxUniqueClicks
  • datePeriod
  • frequencyTypeClicks
  • uniquePeriodClicks
  • clicksPerPeriod
  • minimalPeriodClicks
  • maxActiveEvents
  • maxActiveEventsPerDay
  • maxActiveEventsPerHour

• Добавлены параметры при создании, редактировании и получении списка суперкампаний:

  • sendToErir
  • contractID
  • publisherContractID
  • costType

• Добавлен параметр publisherContractID и обновлен параметр contractID при создании, редактировании и получении списка кампаний.

• Добавлен параметр cpc при создании кампаний.

04.12.2024

Добавлен параметр запроса videoDuration при добавлении, редактировании и получении списка баннеров.

22.11.2024

Удалено:

• устаревший параметр запроса isClientTime для таргетирования кампании и баннера по времени;

• параметр okved — начиная с версии API v5 ЕРИР больше не нужно передавать ОКВЭД при добавлении кампаний и баннеров и редактировании их параметров.

Добавлено:

• параметр maxClicksPerHour при добавлении и редактировании параметров кампаний.

21.11.2024

Добавлен параметр запроса videoResolution при создании и редактировании баннера.

01.10.2024

Удалены устаревшие параметры запроса tracingTypeID и isSimplifiedBanners при добавлении и редактировании параметров кампаний.

27.09.2024

Удалены устаревшие параметры ответа outerMarkID и sequence при добавлении, редактировании параметров и получении списка кампаний.

06.10.2023

Добавлена валидация значения для стороннего токена.

07.07.2023

Изменен способ авторизации: теперь авторизоваться в API Adfox можно с помощью OAuth-токена Яндекса.

05.07.2023

Добавлена возможность указать сторонний токен при создании или редактировании баннера.

08.06.2023

Удалены устаревшие параметры:

• type, bannerSequence, scenarioPeriodID при добавлении и редактировании параметров кампаний;

• scenarioImpressions при создании и редактировании баннера.

24.11.2022

Добавлены методы API для работы с маркировкой рекламы:

• создание, редактирование, получение списка, удаление контрагентов;

• создание, редактирование, получение списка, удаление договоров;

Добавлены параметры для маркировки в методах:

• создание, получение списка сайтов;

• получение списка шаблонов;

• создание, редактирование, получение списка кампаний;

• создание, редактирование, получение списка баннеров.

15.04.2022

Добавлена возможность таргетирования по URL на уровне кампании, размещения кампании на сайте, разделе и площадке, а также на баннере.

02.02.2022

Прекращена поддержка Adfox.nets. Запросы для рекламных сетей с объектами adNetwork и adNetworkWebsite больше не поддерживаются.

10.12.2021

• Cкрыты устаревшие методы таргетирования по географии targetingGeo. Рекомендуем использовать метод targetingGeobase.

• Удалено упоминание передачи account и password в параметрах запроса после перехода на авторизацию через OAuth-токен и регистрацию пользователей через Яндекс ID. Также теперь не обязательно передавать password при создании нового пользователя или изменении существующего.

• При добавлении типа баннера параметр presentationTypeID стал обязательным и больше не принимает на вход значение 0 (стандартный тип баннера).

• Если при добавлении баннера не указан ID шаблона баннера, то в параметре contentType может быть передано только значение xml. Остальные значения (graphics — Графический баннер; flash — Flash-баннер; HTML — HTML-баннер; floatingJS — JavaScript код (Безразмерный); floatingHTML — HTML код (Безразмерный); floatingFlash2 — Flash без заглушки; FloatingImage — Изображение) не поддерживаются.

23.11.2017

Добавлен новый вид пользователей — ассистенты API с разным набором прав доступа к методам API.

14.09.2017

Добавлено:

• логическое таргетирование для баннера, кампании, размещения кампании на сайте, разделе, площадке;

• значения возраста 6 (от 45 до 54) и 7 (старше 55) для параметра ageValue в таргетировании баннера и кампании по возрасту. Значение 5 (старше 45) устарело, при его использовании автоматически будут включены значения 6 и 7.

15.08.2017

Добавлена возможность устанавливать и редактировать параметры «тип кода» (pct) и «ограничение по частоте показов» (plp, pli, pop) для площадки.

22.05.2017

Добавлено:

• новый метод получения данных о шаблоне;

• редактирование параметра CPM для кампаний с видом «Динамическая монетизация».

12.04.2017

• Добавлено описание ошибок при загрузке .zip-архивов в параметры баннера.

• Добавлено значение 1001 («Видимый показ») для параметра impressionMethodID при добавлении кампании.

• Исправлено описание указания версии при формировании запроса API.

• Добавлен новый метод клонирования баннеров.

24.12.2016

Прекращена поддержка метода code. Используйте метод placement для получения кода вставки.

05.08.2016

Добавлен дополнительный параметр showMode для параметра show со значением targetingUser при получении списка кампаний. Параметр позволяет вывести список разрешенных и запрещенных значений пользовательской характеристики.

18.07.2016

Добавлен параметр resetProfile для установки режима «только чтение» в таргетировании по географии для кампании и баннера.

01.06.2016

Исправлено в тексте документации: для настройки таргетирования targetingUser — v{ID значения характеристики}, где ID указывается без фигурных скобок, например: v534.

26.05.2016

Добавлена возможность получения сводной информации для кампании по таргетированию по географии.

25.05.2016

Добавлено:

• получение справочника по географии NEW;

• настройка таргетирования по географии NEW на уровне кампании и баннера;

• получение сводной информации по объектам, старгетированным по географии NEW;

• получение сводной информации по таргетированию у конкретной рекламной кампании.

26.10.15

Добавлена возможность просмотра настроек таргетирования на уровне кампании по targetingGender, targetingAge, targetingRevenue.

28.03.2015

Добавлено таргетирование на уровне кампании по:

• полу;

• возрасту;

• уровню дохода.

Добавлено таргетирование на уровне баннера по:

• полу;

• возрасту;

• уровню дохода.

Исправлено в тексте документации:

• примечание о формате записи даты и времени;

• описание передачи параметров в XML-файле.

27.03.2015

• Разработана новая версия с хостом запроса https://api.adfox.ru/v1/API.php?.

• Добавлена новая возможность пагинации.

21.06.2014

Добавлено:

• копирование кампании;

• получение справочников по:

  • браузерам;
  • производителям мобильных устройств;
  • операторам сотовых сетей;
  • операционным системам;
  • отраслям.

19.06.2014

В связи с усилением требований безопасности паролей Adfox вводит изменения в процедуру авторизации через API. Пароль в открытом виде можно передавать до 24.06.14, 14:00. После 14:00 все запросы по API будут проходить авторизацию корректно, только если пароль передан в закрытом виде с использованием функции хэш sha256 от пароля.

28.04.2014

Добавлено таргетирование на уровне баннера по:

• времени;

• частоте;

• поведению;

• ключевым словам.

22.04.2014

Добавлено таргетирование по полу и возрасту на уровне кампании.

25.03.2014

Добавлено:

• просмотр сводной информации по таргетированию на уровне кампании и баннера;

• значение short для параметра show при просмотре списка суперкампаний, кампаний и баннеров.

11.03.2014

Добавлено усиление сложности пароля при создании пользователей и смене паролей.

20.12.2013

Добавлено:

• дополнительное таргетирование на уровне баннера;

• включение и выключение в рекламных сетях шаблона referer по URL;

• таргетирование по географии на уровне баннера.

01.10.2013

• Выключены типы баннеров PopUp и PopUnder.

• Доступ к API Adfox разрешен только по протоколу https. При запросе по http вернется ошибка 999.

29.04.2013

Добавлена возможность указания ссылки на промерочный пиксель.

15.03.2013

Добавлено переопределение метода ротации на уровне размещения.

20.02.2013

Добавлено таргетирование по ключевым словам или фразам.

31.01.2013

При редактировании параметров кампании параметр priority не обязателен.

16.01.2013

Изменено:

• получение геобазы для работы с API;

• указание метода ротации по приоритетности (уровень, приоритет) и по проценту от трафика (% трафика) для кампании;

• при редактировании параметров кампании параметр priority стал обязательным;

• пользовательское таргетирование;

• переопределение таргетирования на уровне размещения (сайта, раздела, площадки).

28.12.2012

Реализовано добавление и редактирование отрасли для суперкампании и кампании.

14.08.2012

Добавлено описание параметра impressionsMethodID (методика подсчета показов) при добавлении суперкампании и кампании.

23.04.2012

Добавлено:

• метод bannerPlaceReport — получение статистики по кампаниям, баннерам и площадкам за день;

• параметр encoding;

• методы для установки дополнительных ассистентов и рекламодателей;

• метод advertiser-availableReports;

• параметр availableReports при получении списка рекламодателей;

• автоматическое продление для параметров impressionsSmoothTypeID и clicksSmoothTypeID;

• параметры pricingModel, itemCost и itemQty для суперкампаний и кампаний;

• методы для добавления, получения списка, удаления, редактирования параметров суперкампании и получения списка баннеров;

• метод tracingPoint2;

• методы пользовательского таргетинга;

• вывод настроек таргетирования;

• описание метода таргетирования по ключевым словам.

Изменено:

• информация по установке пользовательского таргетирования для кампании;

• исправлена ошибка в параметре pricingModel;

• модифицированы методы добавления, получения списка, редактирования параметров кампании;

• модифицированы методы таргетирования: получение списка и редактирование характеристик пользовательского таргетинга, таргетирование кампании по времени;

• модифицированы методы размещения кампании на сайте, в разделе и на площадке сайта, а также метод получения информации о размещении кампании;

• откорректированы настройки геотаргетирования, вывод настроек кампании и баннера;

• уточнено описание методов работы с категориями.

27.05.2011

Добавлено:

• описание методов таргетирования по времени, частоте, поведению и географии;

• параметры impressionsSmoothTypeID и clicksSmoothTypeID для кампаний;

• параметр campaignID для метода tracingPoint.

Изменено:

• список доступных шаблонов для типа баннера и точки учета действий;

• баннер по умолчанию для площадок;

• отчет о показах и переходах по дням по активным кампаниям за период;

• листинг списка разделов с фильтрацией по сайту.

26.07.2010

Изменено:

• получение отчета за сутки: все баннеры на всех площадках;

• изменение шаблонов страниц у разделов;

• информация о параметрах imageURL и getURL при создании баннера;

• получение списка системных площадок для типов баннеров у сайтов рекламных сетей;

• отчет по сайту рекламной сети по часам за сутки;

• отчет по кампании по часам за указанную дату;

• получение кода вставки с типом кода;

• удаление площадок;

• шаблон запроса;

• отчет по показам и переходам на всех площадках.

29.01.2010

Добавлено:

• получение кодов вставки;

• получение отчетов.

Изменено:

• отчет по площадкам по дням.