banner

campaignID*

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

Читайте также:

• как посмотреть список ID кампаний/флайтов;

• как создать кампанию/флайт.

templateID*

ID шаблона баннера.

Шаблон представляет собой код баннера с переменными и определяет внешний вид и функциональные возможности баннера на сайте.

Обратите внимание: если рекламная кампания (campaignID), в которую добавляется баннер, создана с методикой учета показов (impressionsMethodID=2101 или impressionsMethodID=2102), то шаблон должен иметь признак is_Ims=1.

Наличие признака у шаблона можно проверить, получив параметры шаблона (account-list-template) или список шаблонов в типе баннера (bannerType-list-template).

Как посмотреть список ID шаблонов, читайте в разделе list-template.

name

Название объекта. Может содержать русские и латинские буквы, цифры и любые символы.

targetingProfileID

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

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

Как посмотреть список ID профилей, читайте в разделе list-targetingProfile.

bannerTypeID

ID типа баннера.

Читайте также:

• создать тип баннера;

• посмотреть список ID типов баннера.

priority

Приоритет.

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

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

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

status

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

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

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

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

isEvents

Получить ссылки на события.

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

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

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

isUnplaced

Отключить размещение баннера на площадках, созданных после добавления баннера.

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

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

Функционал зависит от подключенного в аккаунте модуля «Отключение размещения баннеров».

Если модуль подключен: значение по умолчанию 1.

Если модуль не подключен: значение по умолчанию 0.

backgroundColor

Цвет фона в формате HEX, например: #FFFFFF.

width

Ширина баннера.

height

Высота баннера.

imageURL

Ссылка на изображение графических баннеров, заглушку flash-баннеров.

hitURL

Ссылка для перехода на сайт рекламодателя.

target

Значение параметра target для ссылки — определяет, в каком окне открыть ссылку.

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

• _blank — открыть страницу в новом окне браузера;
• _parent — открыть страницу в текущем окне;
• _top — открыть страницу в полном окне браузера.

alt

Значение параметра alt для тега img — альтернативный текст для изображения.

userN

Пользовательские параметры, где N — номер используемого параметра от 1 до 25.

В каждом шаблоне определен набор переменных. Получите список используемых переменных шаблона и передайте значения к этим переменным при добавлении или редактировании баннера.

Например, в шаблоне используются 2 пользовательских параметра: user1 и user3 с типом данных «строка».

Значит, при добавлении или редактировании баннера необходимо в запросе передать:

user1=text1&user3=text3

eventN

Названия событий, где N — номер события от 1 до 30.

В каждом шаблоне определен набор используемых событий. Получите список переменных шаблона и передайте названия к этим событиям при добавлении или редактировании баннера.

hitURLN

Укажите URL перехода для событий, где N в названии параметра — номер события от 1 до 30.

videoResolution

Качество видео.

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

• 240p
• 360p
• 480p
• 720p
• 1080p

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

videoDuration

Длительность видео в секундах.

Можно задать длительность до тысячных долей секунды, например 11.325.

maxImpressions

Максимальное количество показов баннера.

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

maxImpressionsPerDay

Максимальное количество показов в сутки.

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

maxImpressionsPerHour

Максимальное количество показов в час.

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

maxClicks

Максимальное количество кликов всего.

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

maxClicksPerDay

Максимальное количество кликов в сутки.

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

maxClicksPerHour

Максимальное количество кликов в час.

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

trackingURL

Ссылка на промерочный пиксель.

В ссылке на пиксель обычно присутствует переменная, ожидающая на вход случайное число. Это число помогает защитить ссылку от кеширования в браузере.

В Adfox существует макрос для подстановки случайного числа к переменной  — %random%.

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

http://ads.adfox.ru/166283/getCode?p1=borgd&p2=ezjv&
pfb=dwsey&pr=%random%

dateStart

Дата начала открутки.

Значение по умолчанию: сегодня с 00:00.

Формат передачи даты и времени: YYYY-MM-DD HH:mm

dateEnd

Дата окончания открутки.

Формат передачи даты и времени: YYYY-MM-DD HH:mm

showMenu

Показывать меню на баннере.

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

• 0 — не показывать меню;
• 1 — показывать меню.

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

adLabel

Показывать метку «Реклама» или «Соцреклама» на баннере.

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

• 0 — метка отключена;
• 1 — показывать метку «Реклама»;
• 2 — показывать метку «Соцреклама».

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

domain

Домен рядом с меткой «Реклама».

sendToErir

Передавать данные в ЕРИР.

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

• 0 — не передавать данные в ЕРИР;
• 1 — передавать данные в ЕРИР (маркировка включена).

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

token

Токен баннера, который был получен от стороннего ОРД, в том числе в ОРД Яндекса по API (не через стандартный механизм маркировки в Adfox).

Вы можете задать значение параметра token только в том случае, если sendToErir=0.

В поле Токен можно добавить только значение токена. Не добавляйте другие символы.

creativeContentType

Форма распространения рекламы.

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

• 1 — баннер;
• 2 — текстово-графический блок;
• 3 — текстовый блок;
• 4 — видеоролик;
• 5 — видеотрансляция в прямом эфире;
• 6 — аудиотрансляция в прямом эфире;
• 7 — аудиозапись;
• 8 — текстовый блок с видео;
• 9 — текстово-графический блок с видео;
• 10 — текстовый блок с аудио;
• 11 — текстово-графический блок с аудио;
• 12 — текстовый блок с аудио и видео;
• 13 — текстово-графический блок с аудио и видео;
• 14 — HTML5-баннер.

markingDescription

Описание креатива.

markingKktu

Kод справочника ККТУ. Обязательный параметр, если включена маркировка. Если в параметре markingKktu указано значение 30.15.1, то параметр markingCommonDescription становится обязательным.

Список кодов можно получить с помощью метода bannerKktu.

markingCommonDescription

Общее описание объекта рекламирования. Обязательный параметр, если в параметре markingKktu указано значение 30.15.1.

markingSendRegionsType

Регион показа рекламы.

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

• none — значение Не передавать — информация о регионах показа не будет передаваться в ЕРИР;
• all — значение Вся Россия — баннер показывается на всей территории России;
• selected — значение Указать регионы вручную. При передаче selected обязательно укажите ID выбранных регионов в параметре markingSelectedRegions.

markingSelectedRegions

ID региона показа рекламы. Обязательный параметр, если в параметре markingSendRegionsType выбрано значение selected.

Если нужно задать несколько регионов, добавьте несколько markingSendRegionsType в параметрах запроса. Пример для регионов показа рекламы с кодами 9, 21 и 63:

&markingSendRegionsType=9&markingSendRegionsType=21&markingSendRegionsType=63

Список регионов можно получить с помощью метода erirRegions.

targetURL

Целевая ссылка (URL).

textData[]

Массив с текстовыми данными креативов. Поле обязательно для заполнения, если не были указаны параметры mediaData и sendToErir<ParameterN>.

mediaData[]

Массив с медиаданными креативов. Поле обязательно для заполнения, если не были указаны параметры textData и sendToErir<ParameterN>.

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

description — необязательно для заполнения.

Пример заполнения:

mediaData[]={"url": "https://avatars.mds.yandex.net/
get-adfox-content/example.jpeg/example.we
bp", "description": "Text_string"}

sendToErir<ParameterN>

Включение/отключение для определенной переменной передачи значения параметра (креатива) в ЕРИР. Где <ParameterN> — название переменной.

Если вы передаете предопределенные переменные, используйте следующие названия параметров:

• sendToErirImageURL — для переменной Изображение;
• sendToErirGetFLV — для переменной FLV-ролик.

Чтобы включить пользовательские переменные (user1-user25), используйте <ParameterN>. Где N — значение от 1 до 25. Например, sendToErirParameter2 — для дополнительной переменной user2.

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

• 0 — отключить передачу данных в ЕРИР для переменной;
• 1 — включить передачу данных в ЕРИР для переменной.

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

Поле обязательно для заполнения, если не были указаны параметры mediaData и textData.

Если опция передачи параметров не включена на шаблоне (в столбце Маркировка выбрана опция Не использовать в маркировке), параметр передать не получится (ошибка Incorrect value (-6)). Чтобы управлять передачей данных при создании баннера, перейдите в интерфейс Adfox и включите опцию в шаблоне.

sendToErirContentType<ParameterN>

Тип файла, загруженного в переменную с включенной передачей в ЕРИР.

Список возможных значений:

• image;

• video;

• audio;

• zip.

При выборе image параметр с описанием объекта креатива sendToErirDescription<ParameterN> становится обязательным.

sendToErirDescription<ParameterN>

Описание объекта креатива для той переменной, в которую загружен файл. Обязательный параметр, если в параметре sendToErirContentType<ParameterN> указано значение image.

code

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

ID

Идентификатор объекта.