Шаблоны

Шаблон — это код (JSON, JavaScript, HTML, XML), определяющий внешний вид и функциональность для отображения баннера на сайте. Код шаблона содержит переменные, значения которых будут подставлены из параметров баннера, выбранного для показа.

Для одного типа баннера можно добавить несколько разных шаблонов. Это значит, что, допустим, на площадке с типом баннера 240x400 могут быть показаны баннеры с шаблоном Картинка или Баннер с видео.

Шаблоны бывают двух видов:

  • Системные — по умолчанию присутствуют в типе баннера.
  • Пользовательские — шаблоны, которые к типу баннера добавляет администратор аккаунта. Пользовательские шаблоны бывают:

Как добавить предзаданные шаблоны

  1. Откройте Настройки → Типы баннеров → Собственные → Безразмерные/XML.
  2. Создайте новый тип баннера или выберите уже существующий, для которого нужно добавить шаблон.
  3. Перейдите к добавлению шаблона. Для этого нажмите (Шаблоны).
  4. Нажмите Использовать предзаданные.

    У предзаданных шаблонов в названии есть теги, которые подсказывают, для каких кодов вставки шаблон будет работать:

    Рекомендуем использовать асинхронные коды вставки с библиотекой loader.js, то есть шаблоны с тегом [loader].

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

При добавлении одного и того же предзаданного шаблона к типу баннера более одного раза, к названию шаблона будет автоматически добавляться подпись: копия N, где N — номер копии шаблона.

Если шаблон отсутствует в предзаданных, обратитесь в службу технической поддержки.

Как создать собственный шаблон

  1. Добавление собственного шаблона
  2. Макросы для шаблонов
  3. Кодирование значений переменных
  4. Запрет на редактирование

Добавление собственного шаблона

Чтобы добавить шаблон, который будет корректно работать на коде вставки с библиотекой loader.js, необходимо:

  1. Напишите HTML-код баннера.
    Например:
    <div style="max-width:500px;">
        <h1 style="text-align: center;"><a style="text-decoration: none; color:red;" href="https://adfox.ru/ru/">ADFOX</a></h1>
        <div style="display: inline-flex; padding-left: 5px;">
            <a href="https://adfox.ru/ru/product/adfox_sites/" target="_blank" style="text-decoration: none; color:red; padding-left: 5px;">
            <img src="https://adfox.ru/m/pic/2013/08/19/06/32/05/products_logo_1.png">ADFOX Sites. Размещение и управление рекламой на сайтах</a>
        </div>
    </div>                       
  2. В интерфейсе ADFOX перейдите к типу баннера, в котором будет находится новый шаблон. Добавьте из предзаданных шаблон Проброс кода [loader].
  3. Откройте параметры шаблона.
  4. В поле Значение по умолчанию для дополнительной переменной №1 HTML код вставки вставьте HTML-код баннера.
  5. Рекомендуем включить флаг Запрет на редактирование.
  6. Далее замените в HTML-коде значения, которые могут изменяться от одного баннера к другому (например, размеры, ссылки на изображения, ссылки для перехода, тексты), на специальные макросы ADFOX, одновременно включая используемые переменные.
    Например:
    • Заменим в HTML-коде слово «ADFOX» на макрос %banner.user2%, включим дополнительную переменную №2, сделаем ее обязательной с типом «Строка».
    • Заменим в HTML-коде ссылку на файл с логотипом на макрос %banner.user3%, включим дополнительную переменную №3, сделаем ее обязательной с типом «Файл».
  7. После замены всех необходимых значений на макросы, сохраните изменения в шаблоне. Можно добавлять баннеры.

Макросы для шаблонов

Описание переменной Имя переменной в коде
Ссылка на flash-ролик. %banner.get_url%
Ссылка на изображение. %banner.image_url%
Ссылка на FLV-ролик. %banner.get_flv%
URL перехода (предопределенная переменная). %request.reference%
URL перехода (дополнительная переменная), где N — номер переменной от 1 до 25. Данный макрос производит подсчет кликов и редирект на сайт рекламодателя. %banner.reference_userN%
Параметр передачи перехода (название переменной, которая прописана во flash-ролике и принимает значение переменной "URL перехода"). %banner.flash_parameter_name%
Параметр передачи "target". %banner.target_parameter_name%
Ширина (в пикселях. Для указания ширины в % необходимо использовать дополнительную переменную). %banner.width%
Высота (в пикселях. Для указания высоты в % необходимо использовать дополнительную переменную). %banner.height%
Текст "ALT" изображения. %banner.alt%
"TARGET" ссылки. Значение подставляется либо из параметров баннера, либо из запроса в параметре p3. %banner.target%
Цвет фона. %banner.background_color%
Ссылка на промерочный пиксель. Если в баннере значение параметра не задано, то по умолчанию будет подставлено значение "https://banners.adfox.ru/transparent.gif". %banner.tracking_url%
Дополнительная переменная, где N — номер переменной от 1 до 25. %banner.userN%
Событие, где N — номер события от 1 до 30. События нужны для получения информации о каких-либо действиях в баннере, например, расхлоп баннера, наведение указателя мыши на кнопку. %banner.eventN%
Идентификатор баннера, который выбран для показа. %banner.id%
Идентификатор рекламной кампании, которая выбрана для показа. %campaign.id%
Идентификатор площадки, на которой размещен выбранный для показа баннер. %place.id%
Идентификатор сайта, на котором размещен выбранный для показа баннер. %site.id%
Идентификатор аккаунта. %owner.id%
Число, полученное из запроса в параметре pr. %request.page_random%
Ключевые слова, полученные из запроса в параметре pk. %request.keywords%
Генератор случайного числа. %system.random%
Протокол запроса за баннером. Например, http или https. %request.protocol%
Значение, полученное из запроса в параметре puidN, где N — номер дополнительной характеристики от 1 до 63. %request.puidN%
Значение, полученное из запроса в параметре eidN, где N — номер переменной от 1 до 2. %request.eidN%
Время запроса за баннером в uts, формат — количество секунд since unix epoch. %request.timestamp%
Идентификатор рекламного места, полученный из запроса в параметре phid. %request.placeholder_id%
Случайное число, сгенерированное на площадке для асинхронных кодов. Приходит в запросе в параметре pr1. %request.place_random%

Кодирование значений переменных

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

Кодирование значений производится с помощью суффиксов, которые подставляются через двоеточие к макросу в шаблоне.

Есть три вида кодирования:

  1. htmlenc производит эскейп символов <,>,&
    %banner.user1:htmlenc%
    Исходное значение:
    hello// "world", & hello 'world'! + Good morning! < Good afternoon!
    После кодирования:
    hello// "world", &amp; hello 'world'! + Good morning! &lt; Good afternoon!
  2. urlenc производит urlencode строки.
    %banner.user1:urlenc%

    Исходное значение:

    hello// "world", & hello 'world'! + Good morning! < Good afternoon!

    После кодирования:

    hello%2F%2F%20%22world%22%2C%20%26%20hello%20%27world%27%21%20%2B%20Good%20morning%21%20%3C%20Good%20afternoon%21
  3. jsenc производит экранирование (\) кавычек, переводов строк и слэшей.
    %rbanner.user1:jsenc%

    Исходное значение:

    hello// "world", & hello 'world'! + Good morning! < Good afternoon!

    После кодирования:

    hello// \"world\", & hello \'world\'! + Good morning! < Good afternoon!

Запрет на редактирование

Для расширения функциональности шаблонов к дополнительным переменным добавлен флаг Запрет на редактирование, который доступен для настройки только при добавлении из предзаданных или создании нового шаблона.

Примечание. Если при создании шаблона был активирован хотя бы 1 флаг, колонка будет показываться в параметрах шаблона. В противном случае вся колонка скрывается.

Переменные без флага "Запрет на редактирование" (по умолчанию):

  • в шаблоне — при изменении значения по умолчанию в шаблоне для этой переменной, новое значение не применяется к ранее созданным баннерам, но будет применяться к новым баннерам.
  • в баннере — при добавлении баннера поле для этой переменной заполняется значением по умолчанию из шаблона и может быть изменено (в том числе при редактировании баннера).

При отключении переменной в шаблоне:

  • в шаблоне — значение, указанное в поле Значение по умолчанию будет удалено;
  • в баннерах — переменная вместе со своим значением полностью будет удалена во всех ранее созданных баннерах.

При повторном включении переменной в шаблоне:

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

Переменные с флагом "Запрет на редактирование":

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

При отключении переменной в шаблоне:

  • в шаблоне — значение, указанное в поле Значение по умолчанию будет удалено. Флаг Запрет на редактирование останется активированным;
  • в баннерах — переменная вместе со своим значением полностью будет удалена во всех ранее созданных баннерах.

При повторном включении переменной в шаблоне:

  • в шаблоне — возможно указание нового значения в поле Значение по умолчанию;
  • в баннерах — переменная появится во всех ранее созданных баннерах либо с пустым значением, либо с новым значением, указанным в поле Значение по умолчанию на уровне шаблона.

Пример запрета на редактирование

В шаблоне включены две дополнительные переменные:

  • user1: Ширина, значение по умолчанию: 100px, запрет на редактирование: нет.
  • user2: Текст на плашке: значение по умолчанию Реклама, запрет на редактирование: включен.

Создадим баннер, в котором для каждой переменной будут применены значения по умолчанию, но при этом значение переменной Текст на плашке остается недоступным для редактирования.

Теперь в шаблоне изменим значения по умолчанию:

  • user1: Ширина, значение по умолчанию: 200px, запрет на редактирование: нет.
  • user2: Текст на плашке: значение по умолчанию Реклама в сети, запрет на редактирование: включен.

В баннере будет автоматически изменено значение только для переменной user2 Текст на плашке, а значение для переменной user1 осталось без изменения:

Настройка видимости шаблонов

Чтобы открыть список шаблонов, на вкладке Настройки → Типы баннеров нажмите напротив нужного типа баннера.

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

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

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