ADFOX Sites Help

Шаблоны

Описание

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

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

Тип представления/Шаблон Стандартный (iframe) Безразмерный (JavaScript) XML
Системные HTML код + + -
JavaScript код - + -
Flash с заглушкой + - -
Изображение + - -
XML-баннер - - +

Пользовательские

Предзаданные шаблоны - + +
Собственные шаблоны + + +

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

Во вкладке "Настройки" - "Типы баннеров" для каждого типа баннера есть кнопка "Шаблоны".

Нажмите кнопку "Шаблоны" откроется список предзаданных шаблонов.

Шаблоны, для которых стоит чекбокс в графе "Включен", отображаются в списке при добавлении баннера и с помощью этого шаблона можно создать баннер.
Если необходимо, чтобы какие-либо шаблоны не были видны при создании баннера, тогда выключите чекбокс возле необходимых шаблонов и нажмите "Изменить".

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

Предзаданные шаблоны

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

Подробнее о добавлении предзаданных шаблонов см. статью.

Создание шаблонов

Чтобы создать собственный шаблон к любому типу баннера откройте вкладку "Настройки" - "Типы баннеров".
Выберите Собственные или Предопределённые.
Найдите нужный тип баннера и нажмите на значок "Шаблоны" - "Добавить".

Шаблон представляет собой HTML или JavaScript код, который содержит ряд переменных.

Для Стандартных типов баннеров в шаблонах тип кода может быть только HTML.
Для Безразмерных типов баннеров в шаблонах тип кода может быть либо HTML, либо JavaScript.

Для создания шаблона пройдите несколько шагов:
1. подготовьте код баннера

<table  width=100% cellspacing=0 cellpadding=0 border=0>
<tr valign=top>
<td width=49%>
<a href="http://adfox.ru" target="_blank"><img src="http://example.com/image_left.png" width="100%" height="90px" border="0"></a><br>
</td>
<td width=2%>
<A href="http://adfox.ru" target="_blank"><img src="http://example.com/image_center.png" width="400px" height="90px" border="0"></a><br>
</td>
<td width=49%>
<a href="http://adfox.ru" target="_blank"><img src="http://example.com/image_right.png" width="100%" height="90px" border="0"></a><br>
</td>
</tr> 
</table>

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


Предопределенные переменные

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


Дополнительные переменные

Для шаблона возможно добавить 25 дополнительных переменных (%banner.userN%, где N - от 1 до 25).
Включите переменную, укажите имя для переменной, которое будет отображаться в интерфейсе добавления баннера.
Укажите:
обязательность переменной;
тип переменной: строка, текст, файл (для файла возможно указать дополнительно еще и тип файла: картинка, flash, flv);
длина значения: актуально для строки и текста;
значение по умолчанию.


События

Для шаблона возможно добавить 30 событий (%banner.eventN%, где N - от 1 до 30).
События нужны для получения информации о каких-либо действиях в баннере, например, расхлоп баннера, наведение указателя мыши на кнопку.


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

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

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

  1. Суффикс htmlenc производит эскейп символов <,>,&

    %banner.user1:htmlenc%

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

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

    Результат кодирования:

  2. Суффикс urlenc производит urlencode строки.

    %banner.user1:urlenc%

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

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

    Результат кодирования:

  3. Суффикс jsenc производит экранирование (\) кавычек, переводов строк и слэшей.

    %rbanner.user1:jsenc%

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

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

    Результат кодирования:


Список доступных переменных в шаблонах

Описание переменной Имя переменной в коде
Ссылка на flash-ролик %banner.get_url%
Ссылка на изображение %banner.image_url%
Ссылка на FLV-ролик %banner.get_flv%
URL перехода %request.reference%
Параметр передачи перехода (название переменной, которая прописана во 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 флаг был активирован при создании шаблона - то колонка будет показываться в параметрах шаблона, иначе вся колонка скрывается.

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

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

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

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

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

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

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

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

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

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

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

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

Рассмотрим пример:

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

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

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

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

Пример добавления собственных шаблонов для кодов вставки с библиотекой loader.js

Чтобы добавить шаблон, который будет корректно работать на коде вставки с библиотекой 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"><img src="https://adfox.ru/m/pic/2013/08/19/06/32/05/products_logo_1.png"></a><a href="https://adfox.ru/ru/product/adfox_sites/" target="_blank" style="text-decoration: none; color:black; padding-left: 5px;">ADFOX Sites. Размещение и управление рекламой на сайтах</a>
  </div>
   <div style="display: inline-flex; padding-left: 5px;">
     <a href="https://adfox.ru/ru/product/adfox_ssp/" target="_blank"><img src="https://adfox.ru/m/pic/2013/08/31/02/19/41/ssp-color.png"></a><a href="https://adfox.ru/ru/product/adfox_ssp/" target="_blank" style="text-decoration: none; color:black; padding-left: 5px;">Монетизация. Дополнение к ADFOX Sites - подключение к RTB-аукциону Рекламной Сети Яндекса</a>
  </div>
   <div style="display: inline-flex; padding-left: 5px;">
     <a href="https://adfox.ru/ru/product/adfox_adv/" target="_blank"><img src="https://adfox.ru/m/pic/2013/08/19/06/35/24/products_logo_2.png"></a><a href="https://adfox.ru/ru/product/adfox_adv/" target="_blank" style="text-decoration: none; color:black; padding-left: 5px;">ADFOX ADV. Независимый аудит контроль проведения кампания</a>
  </div>  
</div>

2. В коде необходимо выделить те значения, которые будут переменными, то есть могут изменяться от одного баннера к другому. Например, это могут быть размеры, картинки, ссылки для перехода, текст.

Пример кода с переменными:

<div style="max-width:500px;">
<h1 style="text-align: center;">
  <a style="text-decoration: none; color:red;" href="%banner.user25%">%banner.user2%</a>
</h1>
  <div style="display: inline-flex; padding-left: 5px;">
     <a href="%banner.reference_user5%" target="_blank"><img src="%banner.user4%"></a><a href="%banner.reference_user5%" target="_blank" style="text-decoration: none; color:black; padding-left: 5px;">%banner.user3%</a>
  </div>
   <div style="display: inline-flex; padding-left: 5px;">
     <a href="%banner.reference_user8%" target="_blank"><img src="%banner.user7%"></a><a href="%banner.reference_user8%" target="_blank" style="text-decoration: none; color:black; padding-left: 5px;">%banner.user6%</a>
  </div>
   <div style="display: inline-flex; padding-left: 5px;">
     <a href="%banner.reference_user11%" target="_blank"><img src="%banner.user10%"></a><a href="%banner.reference_user11%" target="_blank" style="text-decoration: none; color:black; padding-left: 5px;">%banner.user9%</a>
  </div>  
</div>

3. В интерфейсе ADFOX перейдите к типу баннера, в котором будет находится новый шаблон. Добавьте из предзаданных шаблон "Проброс кода [loader]".

4. В параметрах шаблона "Проброс кода [loader]" включите необходимые переменные (которые вы используете в своем HTML коде)

5. В поле Значение по умолчанию для дополнительной переменной №1 вставьте подготовленный HTML код. Рекомендуем также включить флаг "запрет на редактирование".

6. Шаблон готов, можно добавлять баннеры.