banner

Склонировать баннер.

Новый баннер создается в результате клонирования, и может унаследовать от исходного баннера разный набор параметров:

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

Отличия нового баннера от баннера-родителя:

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

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

https://api.adfox.ru/v1/API.php
 ? loginAccount=<string>
 & loginPassword=<string>
 & object=campaign
 & action=clone
 & actionObject=banner
 & objectID=<integer>
 & listIDs=<integer>
 & targetCampaignID=<integer>
 & cloneTypeID=<integer>
 & [name{BANNERID}=<string>]
Query-параметры
objectID *

ID кампании, из которой необходимо склонировать баннер.

listIDs *

ID баннера, который нужно склонировать.

Для передачи списка ID объектов используйте разделитель — запятую.

targetCampaignID *

ID кампании, в которую баннер будет склонирован.

См. также:

cloneTypeID *

Тип клонирования объекта.

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

  • 0 — клонируется только содержимое баннера. Остальные настройки сбрасываются и будут унаследованы от кампании;
  • 1 — клонируется содержимое баннера и настройки размещения. Остальные настройки сбрасываются и будут унаследованы от кампании;
  • 2 — клонируется содержимое баннера, настройки размещения и таргетирования. Ограничения по показам и переходам сбрасываются и будут унаследованы от кампании;
  • 3 — клонируется содержимое баннера, настройки размещения, таргетирования и ограничения.
name{BANNERID}

В названии параметра {BANNERID} — идентификатор исходного баннера, а значение параметра — название нового баннера.

Если название не передано, то новому баннеру будет присвоено название исходного баннера.

При клонировании нескольких баннеров передавайте для каждого нового баннера свой параметр name{BANNERID}.

Например: name1111=clone1&name1112=clone2

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

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

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

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

code

Статус обработки запроса. Расшифровку смотрите в разделе Обработка ошибок.

message

Only banners with templates marked as "For insertion code with loader.js" are successfully copied: "ID". Banners: "ID" are not copied because only marked banners can be added in campaign with Impression method "Viewable impression".

При клонировании нескольких баннеров, часть из которых создана с шаблонами, не поддерживающими работу на кодах с loader.js, будут скопированы только баннеры с размеченными шаблонами, а остальные проигнорированы. Наличие тега message свидетельствует о частичном выполнении запроса.

Чтобы проверить, поддерживает ли шаблон работу на кодах вставки с loader.js, воспользуйтесь методом получения данных о шаблоне. Параметр isLoaderJs должен быть равен 1.

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

Запрос:

https://api.adfox.ru/v1/API.php?loginAccount={your_login}&loginPassword={sha256_your_password}&object=campaign&action=clone&actionObject=banner&objectID=562830&listIDs=1642949,1642950&targetCampaignID=562831&cloneTypeID=3&name1642949=clone1&name1642950=clone2

Ответ:

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

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

См. также другие действия с объектом campaign: