modify

Редактировать параметры кампании (флайта).

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

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

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

Тип кампании. Устаревший параметр. Рекомендуем использовать стандартный тип.

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

  • 0 — упрощенная кампания позволяет использовать ограниченный набор таргетирований (по времени, по частоте, по географии) и отчетов;
  • 1 — стандартная кампания позволяет использовать весь набор таргетирований и получать все доступные в аккаунте отчета.

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

kind_id

Определяет вид кампании.

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

  • 1 — вид «Гарантия», используется для кампаний с гарантированными продажами, по которым есть обязательства по открутке. Включает зависимость двух параметров:
    • level может принимать значения только в диапазоне от 1 до 10. Если level не передан, будет установлено значение по умолчанию 1.
    • cpm не требуется. Если параметр был передан, то его значение игнорируется.
  • 2 — вид «Динамическая монетизация», дает возможность издателю получать наибольший доход от показа, разрешая Рекламной Сети Яндекса конкурировать за показы негарантированных рекламных кампаний. Приоритезация кампаний происходит по CPM. Включает зависимость двух параметров:
    • level должен быть равен 11. Если level не передан, будет установлено значение по умолчанию 11.
    • cpm обязателен и должен быть > 0.
  • 3 — вид «Промо», используется для кампаний собственного промоутирования, заглушек. Включает зависимость двух параметров:
    • level может принимать значения только в диапазоне от 12 до 20. Если level не передан, будет установлено значение по умолчанию 12.
    • cpm не требуется. Если параметр был передан, то его значение игнорируется.

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

level

Уровень кампании.

В зависимости от подключения в аккаунте модуля «Виды кампаний», будет доступно разное количество уровней для рекламных кампаний.

Допустимые значения, если модуль «Виды кампаний» выключен:

  • с 1 по 10 включительно

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

Допустимые значения, если модуль «Виды кампаний» включен:

  • с 1 по 10 включительно — для кампаний вида «Гарантия» (kind_id=1).
  • 11 - для кампаний вида «Динамическая монетизация» (kind_id=2).
  • с 12 по 20 - для кампаний вида «Промо» (kind_id=3).

Обратите внимание на зависимость значений параметров kind_id и cpm.

priority

Приоритет.

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

  • 1≤N≤1000, где N — от 1 до 1000 включительно.

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

status

Статус объекта. Могут быть показаны только объекты, находящиеся в статусе «активный».

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

  • 0 — активный — объект готов к началу открутки;
  • 1 — приостановленный — предполагается, что объект временно отключен. По умолчанию фильтры в веб-интерфейсе ADFOX показывают приостановленные объекты в списке;
  • 2 — завершенный — предполагается, что объект завершил свою открутку. По умолчанию фильтры в веб-интерфейсе ADFOX скрывают завершенные объекты.

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

sectorID

Отрасль.

См. также:

rotationMethodID

Метод ротации кампании.

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

  • 0 — по приоритетности — использовать значения параметров «уровень» и «приоритет» для оценки вероятности показа рекламной кампании;
  • 1 — по % от трафика — использовать значение параметра процент от трафика для оценки вероятности показа рекламной кампании.

    Параметр trafficPercents обязателен.

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

trafficPercents

Процент от трафика.

Обязателен, если используется метод ротации по % от трафика (rotationMethodID=1).

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

targetingProfileID

ID профиля таргетирования.

Профиль таргетирования позволяет объединить настройки нескольких видов таргетирования. При создании кампании или баннера можно указывать профиль, чтобы не тратить время на настройку каждого таргетирования в отдельности.

См. также:

sequenceГруппа.
tracingTypeID

Для продукта ADFOX.ADV. Учет действий.

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

  • 0— не вести учет действий пользователя на сайте рекламодателя;
  • 1 — postClick — считать количество загрузок точек учета действия в течение суток с момента перехода по рекламному объявлению;
  • 2 — postClick и postView — считать количество загрузок точек учета действия как после переход, так и после просмотра рекламного объявления;
  • 3 — postView — считать количество загрузок точек учета действия после просмотра рекламного объявления или после суток с момента перехода по рекламному объявлению.

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

isSession

Сессионные показы.

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

  • 0 — выключено;
  • 1 — включено.

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

outerMarkID

Включить автоматическую подстановку меток к ссылкам для перехода.

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

  • 0 — выключено;
  • 1 — Openstat.ru;
  • 2 — Google Analytics.

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

isSimplifiedBanners

Упрощенные баннеры (дополнительный модуль).

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

  • 0 — выключено;
  • 1 — включено.

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

bannerSequence

Последовательность показов баннеров.

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

  • 0 — весовая. Выбор баннера осуществляется на основании его приоритета;
  • 1по сценарию. Сценарий представляет собой указание для баннера порядкового номера и количества его показов пользователю.

    Параметр «Период сценария» (scenarioPeriodID) обязателен.

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

scenarioPeriodID

Период сценария — определяет периодичность повтора показов баннеров этой рекламной кампании для уникального пользователя.

Обязателен, если последовательность показа — по сценарию (bannerSequence=1).

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

  • 0 — однократный сценарий;
  • 1 — 1 час;
  • 2 — 4 часа;
  • 3 — 6 часов;
  • 4 — 12 часов;
  • 5 — 1 день;
  • 6 — 1 неделя;
  • 7 — 1 месяц;
  • 11 — постоянное повторение сценария.
impressionsSmoothTypeID

Скорость открутки показов.

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

  • 0 — максимальная скорость открутки. Баннеры кампании будут показываться с максимальной возможной скоростью, пока не сработают ограничения по показам (если таковые имеются). Максимальная скорость открутки не требует указания лимитов и дат начала и окончания рекламной кампании.
  • 1 — равномерное распределение суточного ограничения. Показы будут равномерно распределены в течение суток.

    Обязательно укажите максимальное количество показов в сутки (maxImpressionsPerDay).

  • 2 — равномерное распределение общего ограничения. Система распределит показы кампании равномерно на весь период, используя статистические данные по аккаунту.

    Обязательно укажите максимальное количество показов (maxImpressions) и дату окончания (dateEnd) для рекламной кампании.

  • 3 — равномерное распределение общих ограничений (автоматическое продление). Система распределит показы кампании равномерно на весь период, используя статистические данные по аккаунту. Если на момент завершения кампании по дате окончания еще остались невыполненные показы, то кампания автоматически продлевается на 1 день и откручивается в этот день с максимальной скоростью.

    Обязательно укажите максимальное количество показов (maxImpressions) и дату окончания (dateEnd) для рекламной кампании.

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

clicksSmoothTypeID

Скорость открутки переходов.

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

  • 0 — максимальная скорость открутки. Баннеры кампании будут показываться с максимальной возможной скоростью, пока не сработают ограничения по переходам (если таковые имеются). Максимальная скорость открутки не требует указания лимитов и дат начала и окончания рекламной кампании.
  • 1 — равномерное распределение суточного ограничения. Показы будут равномерно распределены в течение суток.

    Обязательно укажите максимальное количество переходов в сутки (maxClicksPerDay).

  • 2 — равномерное распределение общего ограничения. Система распределит показы кампании равномерно на весь период, используя статистические данные по аккаунту.

    Обязательно укажите максимальное количество переходов (maxClicks) и дату окончания (dateEnd) для рекламной кампании.

  • 3 — равномерное распределение общих ограничений (автоматическое продление). Система распределит показы кампании равномерно на весь период, используя статистические данные по аккаунту. Если на момент завершения кампании по дате окончания еще остались невыполненные переходы, то кампания автоматически продлевается на 1 день и откручивается в этот день с максимальной скоростью.

    Обязательно укажите максимальное количество переходов (maxClicks) и дату окончания (dateEnd) для рекламной кампании.

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

isTrafficSmooth

Равномерное распределение суточного объема.

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

  • 0 — выключить;
  • 1 — включить.
pricingModelID

Для продукта ADFOX.Nets. Способ расчета выплат владельцам сайтов.

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

  • 0 — за 1000 показов;
  • 1 — за переход;
  • 2 — за событие (если подключено).

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

pricingTypeID

Для продукта ADFOX.Nets. Стоимость и выплаты.

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

  • 0 — по всей сети (RON);
  • 1 — по категориям (channel);
  • 2 — по конкретным сайтам (site).

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

paymentMethodID

Для продукта ADFOX.Nets. Тип выплат владельцам сайтов.

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

  • 0 — фиксированные выплаты;
  • 1 — revenue share (если к аккаунту подключен модуль «Модель Profit Share для рекламных сетей» ).

Значение по умолчанию: 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 — не задано;
  • 1 — статика (стоимость за сутки);
  • 2 — CPM (стоимость за 1000 показов);
  • 3 — CPC (стоимость за 1 клик);
  • 4 — CPA (стоимость за 1 действие).

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

itemCost

Для продукта ADFOX.Nets.

Финансовые показатели размещения. Стоимость единицы.

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

itemQty

Для продукта ADFOX.Nets.

Финансовые показатели размещения. Количество единиц.

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

cpm

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

Для kind_id=2 - обязательный параметр.

Для kind_id=1|3 - необязательный, но если передается, то значение игнорируется.

Допустимые значения: целое число больше 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: