modify
Редактировать параметры кампании (флайта).
Формат запроса
https://api.adfox.ru/v1/API.php
? loginAccount=<string>
& loginPassword=<string>
& object=campaign
& action=modify
& objectID=<integer>
& [name=<string>]
& [advertiserID=<integer>]
& [assistantID=<integer>]
& [type=<integer>]
& [kind_id=<integer>]
& [level=<integer>]
& [priority=<integer>]
& [status=<integer>]
& [sectorID=<integer>]
& [rotationMethodID=<integer>]
& [trafficPercents=<integer>]
& [targetingProfileID=<integer>]
& [sequence=<integer>]
& [tracingTypeID=<integer>]
& [isSession=<integer>]
& [outerMarkID=<integer>]
& [isSimplifiedBanners=<integer>]
& [bannerSequence=<integer>]
& [scenarioPeriodID=<integer>]
& [impressionsSmoothTypeID=<integer>]
& [clicksSmoothTypeID=<integer>]
& [isTrafficSmooth=<integer>]
& [pricingModelID=<integer>]
& [pricingTypeID=<integer>]
& [paymentMethodID=<integer>]
& [maxImpressions=<integer>]
& [maxImpressionsPerDay=<integer>]
& [maxImpressionsPerHour=<integer>]
& [maxClicks=<integer>]
& [maxClicksPerDay=<integer>]
& [dateStart=<YYYY-MM-DD HH:mm>]
& [dateEnd=<YYYY-MM-DD HH:mm>]
& [logicType=<integer>]
& [pricingModel=<integer>]
& [itemCost=<integer>]
& [itemQty=<integer>]
& [cpm=<integer>]
Query-параметры | |
objectID * | ID кампании, параметры которой необходимо редактировать. |
name | Имя кампании. Может содержать русские и латинские буквы, цифры и любые символы. |
advertiserID | ID рекламодателя. Для кампании, находящейся внутри суперкампании, идентификатор рекламодателя игнорируется. См. также: |
assistantID | ID ассистента, которому будет разрешен доступ к объекту в соответствии с его правами доступа. Для кампании, находящейся внутри суперкампании, идентификатор ассистента игнорируется. См. также: |
type | Тип кампании. Устаревший параметр. Рекомендуем использовать стандартный тип. Допустимые значения:
Значение по умолчанию: 1. |
kind_id | Определяет вид кампании. Допустимые значения:
Значение по умолчанию: 1. |
level | Уровень кампании. В зависимости от подключения в аккаунте модуля «Виды кампаний», будет доступно разное количество уровней для рекламных кампаний. Допустимые значения, если модуль «Виды кампаний» выключен:
Значение по умолчанию: 1. Допустимые значения, если модуль «Виды кампаний» включен:
Обратите внимание на зависимость значений параметров |
priority | Допустимые значения:
Значение по умолчанию: 100. |
status | Статус объекта. Могут быть показаны только объекты, находящиеся в статусе «активный». Допустимые значения:
Значение по умолчанию: 0. |
sectorID | См. также: |
rotationMethodID | Допустимые значения:
Значение по умолчанию: 0. |
trafficPercents | Процент от трафика. Обязателен, если используется метод ротации по % от трафика ( Допустимые значения: от 1 до 100. |
targetingProfileID | Профиль таргетирования позволяет объединить настройки нескольких видов таргетирования. При создании кампании или баннера можно указывать профиль, чтобы не тратить время на настройку каждого таргетирования в отдельности. См. также: |
sequence | Группа. |
tracingTypeID | Для продукта ADFOX.ADV. Учет действий. Допустимые значения:
Значение по умолчанию: 0. |
isSession | Допустимые значения:
Значение по умолчанию: 0. |
outerMarkID | Включить автоматическую подстановку меток к ссылкам для перехода. Допустимые значения:
Значение по умолчанию: 0. |
isSimplifiedBanners | Упрощенные баннеры (дополнительный модуль). Допустимые значения:
Значение по умолчанию: 0. |
bannerSequence | Последовательность показов баннеров. Допустимые значения:
Значение по умолчанию: 0. |
scenarioPeriodID | Период сценария — определяет периодичность повтора показов баннеров этой рекламной кампании для уникального пользователя. Обязателен, если последовательность показа — по сценарию ( Допустимые значения:
|
impressionsSmoothTypeID | Скорость открутки показов. Допустимые значения:
Значение по умолчанию: 0. |
clicksSmoothTypeID | Скорость открутки переходов. Допустимые значения:
Значение по умолчанию: 0. |
isTrafficSmooth | Равномерное распределение суточного объема. Допустимые значения:
|
pricingModelID | Для продукта ADFOX.Nets. Способ расчета выплат владельцам сайтов. Допустимые значения:
Значение по умолчанию: 0. |
pricingTypeID | Для продукта ADFOX.Nets. Стоимость и выплаты. Допустимые значения:
Значение по умолчанию: 0. |
paymentMethodID | Для продукта ADFOX.Nets. Тип выплат владельцам сайтов. Допустимые значения:
Значение по умолчанию: 0. |
maxImpressions | Максимальное количество показов баннера. Допустимые значения: целое число от 1 до 2147483647. |
maxImpressionsPerDay | Максимальное количество показов в сутки. Допустимые значения: целое число от 1 до 2147483647. |
maxImpressionsPerHour | Максимальное количество показов в час. Допустимые значения: целое число от 1 до 2147483647. |
maxClicks | Максимальное количество кликов всего. Допустимые значения: целое число от 1 до 2147483647. |
maxClicksPerDay | Максимальное количество кликов в сутки. Допустимые значения: целое число от 1 до 2147483647. |
dateStart | Дата начала открутки. Значение по умолчанию: сегодня с 00:00. Формат передачи даты и времени: YYYY-MM-DD HH:mm |
dateEnd | Дата окончания открутки. Формат передачи даты и времени: YYYY-MM-DD HH:mm |
logicType | Вид кампании. Для кампании внутри суперкампании — не требуется. Допустимые значения:
Значение по умолчанию: 0. |
pricingModel | Для продукта ADFOX.Nets. Финансовые показатели размещения. Модель ценообразования: Допустимые значения:
Значение по умолчанию: 0. |
itemCost | Для продукта ADFOX.Nets. Финансовые показатели размещения. Стоимость единицы. Допустимые значения: целое число от 1 до 2147483647. |
itemQty | Для продукта ADFOX.Nets. Финансовые показатели размещения. Количество единиц. Допустимые значения: целое число от 1 до 2147483647. |
cpm | Пороговое значение CPM для рекламной кампании вида «Динамическая монетизация». Для Для Допустимые значения: целое число больше 0. |
Query-параметры | |
objectID * | ID кампании, параметры которой необходимо редактировать. |
name | Имя кампании. Может содержать русские и латинские буквы, цифры и любые символы. |
advertiserID | ID рекламодателя. Для кампании, находящейся внутри суперкампании, идентификатор рекламодателя игнорируется. См. также: |
assistantID | ID ассистента, которому будет разрешен доступ к объекту в соответствии с его правами доступа. Для кампании, находящейся внутри суперкампании, идентификатор ассистента игнорируется. См. также: |
type | Тип кампании. Устаревший параметр. Рекомендуем использовать стандартный тип. Допустимые значения:
Значение по умолчанию: 1. |
kind_id | Определяет вид кампании. Допустимые значения:
Значение по умолчанию: 1. |
level | Уровень кампании. В зависимости от подключения в аккаунте модуля «Виды кампаний», будет доступно разное количество уровней для рекламных кампаний. Допустимые значения, если модуль «Виды кампаний» выключен:
Значение по умолчанию: 1. Допустимые значения, если модуль «Виды кампаний» включен:
Обратите внимание на зависимость значений параметров |
priority | Допустимые значения:
Значение по умолчанию: 100. |
status | Статус объекта. Могут быть показаны только объекты, находящиеся в статусе «активный». Допустимые значения:
Значение по умолчанию: 0. |
sectorID | См. также: |
rotationMethodID | Допустимые значения:
Значение по умолчанию: 0. |
trafficPercents | Процент от трафика. Обязателен, если используется метод ротации по % от трафика ( Допустимые значения: от 1 до 100. |
targetingProfileID | Профиль таргетирования позволяет объединить настройки нескольких видов таргетирования. При создании кампании или баннера можно указывать профиль, чтобы не тратить время на настройку каждого таргетирования в отдельности. См. также: |
sequence | Группа. |
tracingTypeID | Для продукта ADFOX.ADV. Учет действий. Допустимые значения:
Значение по умолчанию: 0. |
isSession | Допустимые значения:
Значение по умолчанию: 0. |
outerMarkID | Включить автоматическую подстановку меток к ссылкам для перехода. Допустимые значения:
Значение по умолчанию: 0. |
isSimplifiedBanners | Упрощенные баннеры (дополнительный модуль). Допустимые значения:
Значение по умолчанию: 0. |
bannerSequence | Последовательность показов баннеров. Допустимые значения:
Значение по умолчанию: 0. |
scenarioPeriodID | Период сценария — определяет периодичность повтора показов баннеров этой рекламной кампании для уникального пользователя. Обязателен, если последовательность показа — по сценарию ( Допустимые значения:
|
impressionsSmoothTypeID | Скорость открутки показов. Допустимые значения:
Значение по умолчанию: 0. |
clicksSmoothTypeID | Скорость открутки переходов. Допустимые значения:
Значение по умолчанию: 0. |
isTrafficSmooth | Равномерное распределение суточного объема. Допустимые значения:
|
pricingModelID | Для продукта ADFOX.Nets. Способ расчета выплат владельцам сайтов. Допустимые значения:
Значение по умолчанию: 0. |
pricingTypeID | Для продукта ADFOX.Nets. Стоимость и выплаты. Допустимые значения:
Значение по умолчанию: 0. |
paymentMethodID | Для продукта ADFOX.Nets. Тип выплат владельцам сайтов. Допустимые значения:
Значение по умолчанию: 0. |
maxImpressions | Максимальное количество показов баннера. Допустимые значения: целое число от 1 до 2147483647. |
maxImpressionsPerDay | Максимальное количество показов в сутки. Допустимые значения: целое число от 1 до 2147483647. |
maxImpressionsPerHour | Максимальное количество показов в час. Допустимые значения: целое число от 1 до 2147483647. |
maxClicks | Максимальное количество кликов всего. Допустимые значения: целое число от 1 до 2147483647. |
maxClicksPerDay | Максимальное количество кликов в сутки. Допустимые значения: целое число от 1 до 2147483647. |
dateStart | Дата начала открутки. Значение по умолчанию: сегодня с 00:00. Формат передачи даты и времени: YYYY-MM-DD HH:mm |
dateEnd | Дата окончания открутки. Формат передачи даты и времени: YYYY-MM-DD HH:mm |
logicType | Вид кампании. Для кампании внутри суперкампании — не требуется. Допустимые значения:
Значение по умолчанию: 0. |
pricingModel | Для продукта ADFOX.Nets. Финансовые показатели размещения. Модель ценообразования: Допустимые значения:
Значение по умолчанию: 0. |
itemCost | Для продукта ADFOX.Nets. Финансовые показатели размещения. Стоимость единицы. Допустимые значения: целое число от 1 до 2147483647. |
itemQty | Для продукта ADFOX.Nets. Финансовые показатели размещения. Количество единиц. Допустимые значения: целое число от 1 до 2147483647. |
cpm | Пороговое значение CPM для рекламной кампании вида «Динамическая монетизация». Для Для Допустимые значения: целое число больше 0. |
* Обязательный параметр
Формат ответа
<response>
<status>
<code>{integer}</code>
</status>
</response>
Параметры ответа
code
Статус обработки запроса. Расшифровку смотрите в разделе Обработка ошибок.
Пример запроса и ответа
Запрос:
https://api.adfox.ru/v1/API.php?loginAccount={your_login}&loginPassword={sha256_your_password}&object=campaign&action=modify&objectID=39377&advertiserID=4567
Ответ:
<response>
<status>
<code>0</code>
</status>
</response>
Другие действия с объектом
См. также другие действия с объектом campaign
:
- добавить кампанию
- получить список кампаний;
- удалить кампанию;
- получить список баннеров рекламной кампании;
- разместить кампанию на сайте, разделе, площадке;
- разместить кампанию на рекламной сети, категории сети, сайте.