modify

Редактировать параметры суперкампании.

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

https://adfox.yandex.ru/api/v1
  ? object=superCampaign
  & action=modify
  & objectID=<integer>
  & [name=<string>]
  & [advertiserID=<integer>]
  & [assistantID=<integer>]
  & [status=<integer>]
  & [sectorID=<integer>]
  & [maxImpressions=<integer>]
  & [maxImpressionsPerDay=<integer>]
  & [maxImpressionsPerHour=<integer>]
  & [maxClicks=<integer>]
  & [maxClicksPerDay=<integer>]
  & [maxClicksPerHour=<integer>]
  & [maxUniqueImpressions=<integer>]
  & [frequencyTypeImpressions=<integer>]
  & [uniquePeriodImpressions=<HH:mm>]
  & [impressionsPerPeriod=<integer>]
  & [minimalPeriodImpressions=<HH:mm:ss>]
  & [dateStart=<YYYY-MM-DD HH:mm>]
  & [dateEnd=<YYYY-MM-DD HH:mm>]
  & [sendToErir=<integer>]
  & [contractID=<integer>]
  & [publisherContractID=<integer>]
  & [costType=<integer>]

`objectID`*	ID суперкампании, параметры которой необходимо редактировать.
`name`	Название суперкампании. Может содержать русские и латинские буквы, цифры и любые символы.
`advertiserID`	ID рекламодателя. Читайте также: добавить рекламодателя; получить список рекламодателей.
`assistantID`	ID ассистента, которому будет разрешен доступ к объекту в соответствии с его правами доступа. Читайте также: создать ассистента; получить список ассистентов.
`status`	Статус объекта. Могут быть показаны только объекты, находящиеся в статусе активный. Допустимые значения: `0` — активный — объект готов к началу открутки; `1` — приостановленный — предполагается, что объект временно отключен. По умолчанию фильтры в веб-интерфейсе Adfox показывают приостановленные объекты в списке; `2` — завершенный — предполагается, что объект завершил свою открутку. По умолчанию фильтры в веб-интерфейсе Adfox скрывают завершенные объекты. Значение по умолчанию: `0`.
`sectorID`	Отрасль. Как получить список отраслей, читайте в разделе utility-sector.
`maxImpressions`	Максимальное количество показов баннера. Допустимые значения: `целое число от 1 до 2147483647`.
`maxImpressionsPerDay`	Максимальное количество показов в сутки. Допустимые значения: `целое число от 1 до 2147483647`.
`maxImpressionsPerHour`	Максимальное количество показов в час. Допустимые значения: `целое число от 1 до 2147483647`.
`maxClicks`	Максимальное количество кликов всего. Допустимые значения: `целое число от 1 до 2147483647`.
`maxClicksPerDay`	Максимальное количество кликов в сутки. Допустимые значения: `целое число от 1 до 2147483647`.
`maxClicksPerHour`	Максимальное количество кликов в час. Допустимые значения: `целое число от 1 до 2147483647`.
`maxUniqueImpressions`	Частота контакта пользователя с рекламной кампанией. Максимальное количество показов посетителю. Допустимые значения: `целое число от 1 до 2147483647`.
`frequencyTypeImpressions`	Частота контакта пользователя с рекламной кампанией. Период частоты показов. Допустимые значения: `0` — не задано; `1` — час; `2` — 4 часа; `3` — 6 часов; `4` — 12 часов; `5` — сутки; `6` — неделя; `7` — месяц; `8` — другой период; `9` — 14 дней. Значение по умолчанию: `0`.
`uniquePeriodImpressions`	Частота контакта пользователя с рекламной кампанией. Если период частоты показов выбран как «другой период» (`frequencyTypeImpressions=8`), то укажите собственный период для показов баннеров уникальному пользователю в часах и минутах. Формат передачи времени: `HH:mm`
`impressionsPerPeriod`	Частота контакта пользователя с рекламной кампанией. Количество показов за период.
`minimalPeriodImpressions`	Частота контакта пользователя с рекламной кампанией. Минимальный период между показами баннеров уникальному пользователю (часы:минуты:секунды). Формат передачи времени с секундами: `HH:mm:ss`
`dateStart`	Дата начала открутки. Значение по умолчанию: сегодня с 00:00. Формат передачи даты и времени: `YYYY-MM-DD HH:mm`
`dateEnd`	Дата окончания открутки. Формат передачи даты и времени: `YYYY-MM-DD HH:mm`
`sendToErir`	Передавать данные в ЕРИР. Возможные значения: `0` — не передавать данные в ЕРИР; `1` — передавать данные в ЕРИР (маркировка включена).
`contractID`	Идентификатор прямого или первичного договора. Обязательно для заполнения, если значение `sendToErir=1`. Подробнее о получении списка договоров.
`publisherContractID`	Идентификатор конечного договора. Обязательный параметр, если в `contractID` указан первичный договор.
`costType`	Тип кампании. Возможные значения: `0` — другое; `1` — CPM; `2` — CPC; `3` — CPA. Значение по умолчанию: `0`.

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

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

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

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

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

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

Запрос:

https://adfox.yandex.ru/api/v1?object=superCampaign&action=modify&objectID=39377&name=April_16_coffee&advertiserID=456&dateStart=2021-12-21 06:30&dateEnd=2021-12-30 22:30

Ответ:

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

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

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

Была ли статья полезна?

deleteAssistant

tracingPoint