--- metadata: - name: generator content: Diplodoc Platform v5.52.0 alternate: - https://www.yandex.com/support/adfox/en/ad-inventory/settings/template.md - https://www.yandex.com/support/adfox/ru/ad-inventory/settings/template.md - href: ru/ad-inventory/settings/template.md type: text/markdown title: Markdown version - href: ../../llms.txt type: text/markdown title: llms.txt --- > **Documentation Index:** Fetch the complete configuration index at https://www.yandex.com/support/adfox/ru/llms.txt # Шаблоны Шаблон — это код (JSON, JavaScript, HTML, XML), определяющий внешний вид и функциональность для отображения баннера на сайте. Код шаблона содержит переменные, значения которых подставляются из параметров выбранного баннера. Для одного типа баннера можно добавить несколько разных шаблонов. Например, на площадке с типом баннера **240 × 400** могут быть показаны баннеры с шаблоном **Картинка** или **Баннер с видео**. Шаблоны бывают: - Предзаданные — уже созданы в Adfox и готовы к использованию. Для корректной работы для таких шаблонов разработаны [технические требования](https://www.yandex.com/support/adfox/ru/banners/specs/index.md). - Собственные — добавлены пользователями Adfox самостоятельно с помощью кода. {% note info %} Шаблоны для типа баннера может добавить администратор аккаунта или ассистент, если администратор выдал такие права. Подробнее о настройках прав читайте в разделе [Права пользователей](https://www.yandex.com/support/adfox/ru/settings/users/index.md#access). {% endnote %} ## Добавление предзаданных шаблонов {#predefined-template} 1. Откройте вкладку **Настройки** → **Типы баннеров** → **Собственные**. Выберите [Безразмерные](*non-dim) или [XML](*xml). 1. Создайте новый тип баннера или выберите уже существующий, для которого нужно добавить шаблон. 1. Для добавления шаблона нажмите ![](../../_images/banner-types.svg)**Шаблоны** около нужного типа баннера. 1. Нажмите **Использовать предзаданный**. 1. Выберите нужный предзаданный шаблон из списка и нажмите ![стрелка вправо](../../_images/choose.png). {% note warning %} Для баннера в рекламной кампании с методикой подсчета показов **Показ (IMS)**, **Видимый показ (IMS)** и **Видимые показы, Яндекс (IMS)** будут доступны шаблоны c пометкой IMS ![](../../_images/ims.svg). Такие шаблоны позволяют реализовать [учет видимости](https://www.yandex.com/support/adfox/ru/campaigns/impressions-method.md#viewability) и проводить расширенную проверку показов и переходов инструментами [антифрода](https://www.yandex.com/support/adfox/ru/statistics/ims-compliance.md#fraud). {% endnote %} 1. Внизу открывшейся страницы нажмите кнопку **Добавить**. {% note info %} При добавлении одного и того же предзаданного шаблона к типу баннера более одного раза его название будет автоматически дополнено подписью: **копия N**, где `N` — номер копии шаблона. {% endnote %} Во всех предзаданных шаблонах параметры креатива автоматически передаются в ЕРИР при [включенной маркировке рекламы](https://www.yandex.com/support/adfox/ru/labeling/token.md#step-5). При добавлении баннеров с таким шаблоном рядом с полем для креатива будет значок ![](../../_images/erir-on.png =25x). Чтобы отключить передачу данных в баннере, нажмите на значок — он станет серого цвета: ![](../../_images/erir-off.png =25x). При копировании баннера с активной маркировкой на дочернем баннере она выключается. Если вам нужно включить маркировку, сделайте это вручную. {% cut "Как отключить передачу данных о креативе на уровне шаблона" %} В параметрах шаблона в строке с дополнительной переменной, отвечающей за файл или код креатива, для параметра **Маркировка** выберите значение `Не использовать в маркировке`. ![](../../_images/template-erir.png =500x) {% endcut %} ## Создание собственных шаблонов {#custom-template} Чтобы добавить шаблон, который будет корректно работать на коде вставки с библиотекой context.js: 1. Напишите HTML-код баннера, например: ```html

Adfox

Adfox. Размещение и управление рекламой на сайтах
``` 1. В интерфейсе Adfox перейдите к типу баннера, в котором будет находится новый шаблон: откройте вкладку **Настройки** → **Типы баннеров** → **Собственные**. Выберите **Безразмерные** или **XML**. 1. Нажмите ![](../../_images/banner-types.svg)**Шаблоны** около нужного типа баннера. Затем нажмите **Использовать предзаданный** и рядом с шаблоном **Проброс кода [context]** нажмите ![стрелка вправо](../../_images/choose.png). 1. В параметрах шаблона найдите внизу раздел **Дополнительные переменные**. В поле **Значение по умолчанию** для дополнительной переменной № 1 **HTML код вставки** вставьте HTML-код баннера. 1. Рекомендуем включить флаг **Запрет на редактирование**. 1. Если с помощью этого шаблона вы планируете размещать рекламу с маркировкой через ОРД Яндекса, советуем включить [автоматическую передачу данных о креативе в ЕРИР](#auto-transfer-erir). 1. Далее замените в HTML-коде значения, которые могут изменяться от одного баннера к другому (например, размеры, ссылки на изображения, ссылки для перехода, тексты), на специальные [макросы Adfox](#variable-adfox), одновременно включая используемые переменные. Например: - Заменим в HTML-коде слово «Adfox» на макрос `%banner.user2%`, включим дополнительную переменную № 2, сделаем ее обязательной с типом «Строка». - Заменим в HTML-коде ссылку на файл с логотипом на макрос `%banner.user3%`, включим дополнительную переменную № 3, сделаем ее обязательной с типом «Файл». - Заменим в HTML-коде ссылку на сайт рекламодателя на макрос `%request.reference_mrc%`, включим предопределенную переменную **URL перехода**. ```html

%banner.user2%

Adfox. Размещение и управление рекламой на сайтах
``` Если баннер имеет [sticky](*sticky)-формат, добавьте вручную в код своего блока верстку для метки «Реклама». Не рекомендуем включать метку «Реклама» в параметрах баннера в Adfox. 1. После замены всех необходимых значений на макросы сохраните изменения в шаблоне. Теперь можно добавлять баннеры. ### Добавление шаблона для видеорекламы {#add-video-template} Чтобы добавить шаблон с поддержкой мультиформатного видео: 1. Откройте **Настройки** → **Типы баннеров** → **Собственные** → **XML**. Добавьте новый тип баннера или откройте список шаблонов существующего баннера. 1. Нажмите **Добавить**. 1. Введите название шаблона. Выберите **Формат описания мультиформатного видео**. ![](../../_images/multiformat-video-checkbox.png =400x){style="border: solid 1px #cccccc"} При выборе значения `нет` в качестве основного будет использоваться формат MP4 высотой до 480 пикселей. Если в шаблоне указан макрос `%template.media_files%`, он будет заменен на пустую строку. 1. В блоке **Код шаблона** введите XML-код баннера с макросом `%template.media_files%`. При показе баннера, созданного по такому шаблону, макрос `%template.media_files%` будет заменяться на код со списком сгенерированных видеофайлов в разных форматах. Этот список формируется только при загрузке видеофайлов через интерфейс Adfox. Если в баннере указать ссылку на видео с внешнего источника, макрос заменится пустой строкой. При необходимости в тег `MediaFiles` можно добавлять свои описания форматов в виде XML или JSON, в зависимости от выбранного формата описания мультиформатного видео. При добавлении своего формата в JSON нужно указать, до или после макроса стоят прописанные вами теги. Для этого используются расширения: - `%template.media_files:delimiter_after%` — запятая ставится после макроса; - `%template.media_files:delimiter_before%` — запятая ставится перед макросом; - `%template.media_files%` — запятая не ставится. Разделитель ставится, только если будут найдены сконвертированные файлы и в JSON будут добавлены их описания. В противном случае шаблон заменяется на пустую строку. Таким образом, корректный шаблон будет формироваться из макроса, когда есть собственное описание и когда может появиться описание сконвертированных форматов в JSON. {% cut "Пример кода шаблона для описания мультиформатного видео в формате XML" %} ```xml %template.media_files% ``` При показе баннера будет отдаваться следующий код: ```xml ``` {% endcut %} {% cut "Пример кода шаблона для описания мультиформатного видео в формате JSON" %} ```xml ``` При показе баннера будет отдаваться следующий код: ```xml ``` {% endcut %} [ Пример шаблона VAST с макросом для мультиформатного видео в формате XML](https://doc-static.yandex.net/support/Adfox/vast.xsd) {% note info %} Если вы используете шаблон с макросом мультиформатного видео, то при создании баннера в поле **Качество видеоролика** по умолчанию будет установлено **Выбирается автоматически** — в этом случае выбрать качество не получится. Если макрос не используется, в поле **Качество видеоролика** по умолчанию будет установлено 480p. Вы можете выбрать другое значение из списка. При изменении значение поля сохранится и будет использоваться для баннеров, созданных с помощью этого шаблона. {% endnote %} 1. Нажмите **Добавить**. ### Макросы для шаблонов {#variable-adfox} Вашу таблицу можно преобразовать в следующую форму согласно вашим инструкциям: {% cut "Переменные в коде" %} #| || **Описание переменной** | **Имя переменной в коде** || || Ссылка на flash-ролик | `%banner.get_url%` || || Ссылка на изображение | `%banner.image_url%` || || URL перехода (предопределенная переменная) | `%request.reference_mrc%` || || URL перехода (дополнительная переменная), где `N` — номер переменной от 1 до 25. Данный макрос производит подсчет кликов и редирект на сайт рекламодателя | `%banner.reference_mrc_userN%` || || Параметр передачи перехода (название переменной, которая прописана во flash-ролике и принимает значение переменной «URL перехода») | `%banner.flash_parameter_name%` || || Включение [метки **Реклама**](https://www.yandex.com/support/adfox/ru/labeling/ad-label.md) на баннерах. Принимает значения `1` (метка отображается) или `0` (метка не отображается) | `%banner.ad_label%` || || Указание на рекламодателя в метке **Реклама**. Отображается, если `%banner.ad_label%` принимает значение `1` и в параметрах баннера заполнено поле **Домен** | `%banner.domain:jsenc%` || || Ссылка на [мультиформатное видео](#add-video-template). Доступна для баннеров с видеорекламой, загруженной напрямую в интерфейс Adfox | `%template.media_files%` || || Параметр передачи «target» | `%banner.target_parameter_name%` || || Ширина (в пикселях. Для указания ширины в % необходимо использовать дополнительную переменную) | `%banner.width%` || || Высота (в пикселях. Для указания высоты в % необходимо использовать дополнительную переменную) | `%banner.height%` || || Текст «ALT» изображения | `%banner.alt%` || || «TARGET» ссылки. Значение подставляется либо из параметров баннера, либо из запроса в параметре `p3` | `%banner.target%` || || Цвет фона | `%banner.background_color%` || || Длительность видео в секундах | `%banner.video_duration%` || || Ссылка на промерочный пиксель. Если в баннере значение параметра не задано, по умолчанию будет подставлено значение "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%` || || Идентификатор раздела, на котором размещен выбранный для показа баннер | `%section.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%` || |# {% endcut %} ### Кодирование значений переменных {#coding-variables} Значения из параметров баннера или полученные из запроса в каком-либо параметре, подставляются в код шаблона без изменений. Но для некоторых переменных может потребоваться кодирование значений. Кодирование значений производится с помощью суффиксов, которые подставляются через двоеточие к макросу в шаблоне. Есть три вида кодирования: 1. **htmlenc** преобразует символы `<`,`>`,`&`. ``` %banner.user1:htmlenc% ``` Исходное значение: ``` hello// "world", & hello 'world'! + Good morning! < Good afternoon! ``` После кодирования: ``` hello// "world", & hello 'world'! + Good morning! < Good afternoon! ``` 1. **urlenc** производит URL-кодирование строки. ``` %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 ``` 1. **jsenc** экранирует с помощью символа `\` кавычки, переносы строк и слеши. ``` %banner.user1:jsenc% ``` Исходное значение: ``` hello// "world", & hello 'world'! + Good morning! < Good afternoon! ``` После кодирования: ``` hello// \"world\", & hello \'world\'! + Good morning! < Good afternoon! ``` ### Автоматическая передача данных о креативе в ЕРИР {#auto-transfer-erir} Если для [маркировки рекламы](https://www.yandex.com/support/adfox/ru/labeling/about.md) вы используете инструменты Adfox, то рекомендуем на уровне шаблона включить передачу данных в ЕРИР для переменных, являющихся креативом. Это позволит при создании баннера добавить креатив в параметрах баннера (как обычно) и не заполнять данные о креативе повторно в разделе **Маркировка рекламы: медиаданные креатива**. В предазаданных шаблонах автоматическая передача данных включена по умолчанию. Вы можете самостоятельно включать или отключать передачу данных в ЕРИР как в предзаданных, так и в собственных шаблонах. Чтобы настроить передачу данных о креативе в ЕРИР: 1. Откройте параметры шаблона. 1. В строке с переменной, отвечающей за файл креатива, для параметра **Маркировка** выберите значение: - **Использовать как URL** — если в эту переменную загружаете файл (изображение или видео); - **Использовать как текстовые данные** — если в переменной будет текст (заголовок или текст на баннере). Для переменной **HTML-код** тоже выбирайте значение **Использовать как текстовые данные**. {% note info %} Для переменной **URL перехода** включать передачу данных в ЕРИР не нужно. {% endnote %} 1. Нажмите **Изменить** внизу страницы. Теперь при добавлении баннеров с таким шаблоном рядом с полем для креатива будет значок ![](../../_images/erir-on.png): это значит, что данные из этого поля будут автоматически переданы в ЕРИР. В каждом конкретном баннере передачу данных можно отключить: для этого нажмите значок ![](../../_images/erir-on.png) рядом с полем для креатива — он станет серого цвета (![](../../_images/erir-off.png)). При копировании баннера дочерний баннер наследует настройки передачи данных в ЕРИР из родительского баннера. ### Запрет на редактирование {#edit-ban} Для расширения функциональности шаблонов к дополнительным переменным добавлен флаг **Запрет на редактирование**, который доступен для настройки только при добавлении из предзаданных или создании нового шаблона. {% note info %} Если при создании шаблона был активирован хотя бы один флаг, колонка будет показываться в параметрах шаблона. В противном случае вся колонка скрывается. {% endnote %} Переменные без флага «Запрет на редактирование» (по умолчанию): - в шаблоне — при изменении значения по умолчанию в шаблоне для этой переменной, новое значение не применяется к ранее созданным баннерам, но будет применяться к новым баннерам. - в баннере — при добавлении баннера поле для этой переменной заполняется значением по умолчанию из шаблона и может быть изменено (в том числе при редактировании баннера). При отключении переменной в шаблоне: - в шаблоне — значение, указанное в поле **Значение по умолчанию**, будет удалено; - в баннерах — переменная вместе со своим значением полностью будет удалена во всех ранее созданных баннерах. При повторном включении переменной в шаблоне: - в шаблоне — возможно указание нового значения в поле **Значение по умолчанию**, которое будет применяться только к вновь созданным баннерам; - в баннерах — переменная появится во всех ранее созданных баннерах либо со старым значением, которое было указано в поле **Значение по умолчанию** на уровне шаблона до отключения переменной, либо с измененным, если оно было переопределено на уровне баннера. Переменные с флагом «Запрет на редактирование»: - в шаблоне — можно редактировать значение по умолчанию, и изменения будут применяться в том числе и ко всем ранее созданным баннерам. - в баннере — поле для этой переменной заполняется значением по умолчанию из шаблона и недоступно для редактирования. При отключении переменной в шаблоне: - в шаблоне — значение, указанное в поле **Значение по умолчанию**, будет удалено. Флаг **Запрет на редактирование** останется активированным; - в баннерах — переменная вместе со своим значением полностью будет удалена во всех ранее созданных баннерах. При повторном включении переменной в шаблоне: - в шаблоне — возможно указание нового значения в поле **Значение по умолчанию**; - в баннерах — переменная появится во всех ранее созданных баннерах либо с пустым значением, либо с новым значением, указанным в поле **Значение по умолчанию** на уровне шаблона. #### Пример запрета на редактирование {#example} > В шаблоне включены две дополнительные переменные: > > - user1: **Ширина**, значение по умолчанию: `100 px`, запрет на редактирование: `нет`. > - user2: **Текст на плашке**: значение по умолчанию `Реклама`, запрет на редактирование: `включен`. > > Создадим баннер, в котором для каждой переменной будут применены значения по умолчанию, но при этом значение переменной **Текст на плашке** остается недоступным для редактирования. > > Теперь в шаблоне изменим значения по умолчанию: > > - user1: **Ширина**, значение по умолчанию: `200 px`, запрет на редактирование: `нет`. > - user2: **Текст на плашке**: значение по умолчанию `Реклама в сети`, запрет на редактирование: `включен`. > > В баннере будет автоматически изменено значение только для переменной user2 **Текст на плашке**, а значение для переменной user1 осталось без изменения: ## Настройка видимости шаблонов {#viewability-template} Чтобы открыть список шаблонов, на вкладке **Настройки** → **Типы баннеров** нажмите ![](../../_images/banner-types.svg)**Шаблоны** напротив нужного типа баннера. Включенные шаблоны отображаются в списке доступных при добавлении баннера. Чтобы некоторые шаблоны не были видны при создании новых баннеров, выключите шаблон и нажмите кнопку **Изменить**. При этом ранее добавленные баннеры продолжат показываться на сайте. ## Удаление шаблонов {#delete-template} {% note alert %} После удаления баннеры, созданные с помощью шаблона, перестанут показываться на сайте. {% endnote %} Чтобы удалить шаблон, на вкладке **Настройки** → **Типы баннеров** нажмите ![](../../_images/delete-1.svg)**Удалить** напротив его названия. ## Обратиться в службу поддержки Написать в чат Написать письмо [*sticky]: Баннер фиксируется в окне браузера и сопровождает пользователя при прокрутке страницы. [*non-dim]: Код такого баннера может быть выгружен в JSON-формате (или JavaScript/HTML). [*xml]: [Код вставки](https://www.yandex.com/support/adfox/ru/ad-inventory/codes/code-loader.md#xml-code) представляет собой лишь строку запроса, в ответ на запрос возвращается XML-код.