Модуль "Контекстная реклама" (cn.advertisement)

Многие web-ресурсы размещают рекламные объявления, привязанные к заранее определенным ключевым словам. Модуль "Контекстная реклама" (cn.advertisement) предназначен для настройки автоматического показа контекстных рекламных объявлений на сайте, работающем под управлением CMS "1С-Битрикс".

Модуль устанавливается и удаляется из системы "1С-Битрикс" штатными средствами (см. Настройки — Настройки продукта — Модули), для своей работы требует наличие установленного модуля «Управление лицензиями :: CodeNails.com».

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

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

Работа с модулем контекстной рекламы

1. Установка

Когда модуль установлен в систему через средства модуля cn_codenails, в списке модулей присутствует новый модуль — модуль контекстной рекламы.



Нажимаем на кнопку «установить». У нас выведется сообщение, что модуль успешно установлен. Далее: 

a) Открываем настройки модуля, щёлкнув по элементу с именем модуля в дереве «Настройки модулей».





Отобразится окно с настройками.  Если установлен глобальный поиск/замена, то это значит, что всё содержимое текущей страницы (замещающее плейсхолдер #WORK_AREA# текущего шаблона сайта) будет анализироваться на наличие слов/словосчетаний, указанных в правиле.

Для того чтобы это работало, нужно в настройках текущего шаблона (шаблона сайта используемого для текущей страницы) обрамить плейсхолдер #WORK_AREA# двумя тегами :

<advertisement_generator>
  #WORK_AREA#
</advertisement_generator>




Далее заводим необходимые правила (как их устанавливать будет показано ниже). И смотрим результат.

b) Если флаг «На сайте работает глобальный поиск/замена» не установлен, это означает, что замена слов будет происходить только в шаблонах компонентов.

Чтобы механизм работал, необходимо подключить в шаблоне сайта библиотеку jQuery и jQuery.UI. Достаточно перед закрывающим тегом вписать следующий текст:
<link rel="stylesheet" href="/bitrix/js/cn.advertisement/UI/css/ui-lightness/jquery-ui-1.8.14.custom.css" type="text/css" />
<script type="text/javascript" src="/bitrix/js/cn.advertisement/jquery-1.6.2.min.js"></script>
<script type="text/javascript" src="/bitrix/js/cn.advertisement/UI/js/jquery-ui-1.8.14.custom.min.js"></script>

Так же подключение необходимых библиотек можно сделать через component_epilog.php, расположенный в шаблоне компонента. Для этого нужно использовать методы $APPLICATION->AddHeadScript() — для подключения js-файлов и $APPLICATION->AddHeadString() для подключения css-файлов.

Так же нужно отметить две опции в настройках модуля — На сайте уже используется jQuery 1.62 и интерфейс пользователя 1.8.4. Если эти флажки установлены, то модуль не будет подставлять в секцию js- и css-файлы, поставляемые вместе с модулем. Это относится только для глобального поиска/замены.

В режиме редактирования шаблона компонента (в данном случае компонент news.list) нужно указать после него вызов соответствующих функций, показанных на скриншотах:





CModule::IncludeModule('cn.advertisement');
CNAdvertisements::StartSearch();
?>
СОДЕРЖИМОЕ

Желательно поставить условие
If(CModule::IncludeModule('cn.advertisement'))
{
        CNAdvertisements::StartSearch();   
};
и
If(CModule::IncludeModule('cn.advertisement'))
{
        CNAdvertisements::StopSearch();
};

2. Настройка правил показа рекламы

Под этим термином подразумеваем определение слов или словосочетаний, которые будут выделяться в тексте и при наведении на которые будут отображаться рекламные объявления.
Правила устанавливаются в административной части: СЕРВИСЫ->Модуль контекстной рекламы->Правила



Сейчас в нашем примере определены 4 правила. Для добавления правил нажимаем кнопку «добавить». Большинство полей ввода интуитивно понятны.
Сделаем акцент на полях, которые требуют пояснения:
Группа – позволяет логически группировать правила (для внутренних операций). По умолчанию можно не заполнять.
Подсказка – текст. который будет подставляться в атрибут title html тега.
Сортировка – свойство внутренних операций, оно также позволяет упорядочить элементы в соответствии с этим числовым полем.
Стиль – в этом свойстве устанавливается значение атрибута style html тега. Свойство необходимо заполнять без кавычек и слова style: color: #457673; border-bottom: 2px dashed #457673;.
Размеры всплывающего окна, где будет отображаться информация, можно задавать самостоятельно. Размеры указываются только в пикселях(и окончание px указывать не надо): например 251. Поле «содержимое» содержит ту информацию, которая будет отображаться при всплывании окна. Здесь можно ввести просто текст или html-код. 

На скриншоте приводится заполненное правило:



Пример отображения рекламного объявления по заданному нами правилу: