Описание параметров кнопки¶

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

Другие страницы:

Badge¶

Badge представляет собой объект, который включает в себя графический элемент (логотип, эмблема, и т.д.) Пример Badge в виде логотипа «probtnad» можно видеть на картинке:

BadgeImage¶

Содержит ссылку на графический элемент Badge.

BadgePosition¶

Устанавливает положение Badge на креативе. В зависимости от значений, Badge может располагаться:

top_left - в верхней левой части
top_right - в верхней правой части
top_center - в верхней части посередине
bottom_left- в нижней части слева
bottom_right- в нижней части справа
bottom_center- в нижней части посередине.

BadgeSize¶

Устанавливает размер объекта Badge. Задается как объект { W: 64.0, H: 64.0 } Где

W - ширина в пикселях
H - высота в пикселях.

BadgeActive¶

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

true - включен
false - выключен

По умолчанию установлен в true.

ButtonShowedDurationPeriod¶

Указывает массив временных промежутков, через которые будет осуществляться отправка события ButtonShowedDurationPeriodic. По-умолчанию задан следующими значениями: ButtonShowedDurationPeriod: [1000, 1000, 1000, 2000, 2000, 3000, 3000, 3000, 4000, 5000, 5000, 10000, 20000, 30000, 60000, 90000, 240000, 480000, 1800000] Через 1000 мсек после запуска кнопки, событие будет отправлено в первый раз, затем еще через 1000 мсек - второй раз, еще через 1000 мсек - третий, затем , через 2000 мсек - четвертый и т.д.

JsImpressionCode¶

Содержит пользовательский js-скрипт, который будет исполнен после запуска кнопки. Пример использования:

'JsImpressionCode': '<script>alert("Hello World!");</script' + '>'.

VideoItemHeaderImage¶

URL изображения, которое будет использоваться для брендинга (лого на видео) для видео контента (ButtonContentType: video). Если оно пустое, то строка таблицы и img не создаются.

По умолчанию: «»

VideoPixel¶

Параметр, описывающий вызов той или иной трекинговой ссылки при попадании в разные временные интервалы при проигрывании видео. Ссылки могут вызываться многократно при прокрутке видео или перезапуске. Задается в виде JSON. Пример использования: [{"TrackingLink": "1", "StartPosition": 0.0, "EndPosition": 0.25}, {"TrackingLink": "2", "StartPosition": 0.25, "EndPosition": 0.5},{"TrackingLink": "3", "StartPosition": 0.5, "EndPosition": 0.75},{"TrackingLink": "4", "StartPosition": 0.75, "EndPosition": 1}] Где соответственно:

TrackingLink - трекинговая ссылка, которая будет вызываться
StartPosition - начало интервала, в секундах
EndPosition - окончание интервала, в секундах

По умолчанию: []

BrandingImage¶

URL изображения, которое будет использоваться для брендинга страницы при перемещении кнопки. (Изображение будет использоваться как background-image для #probtn_wrapper элемента).

По умолчанию: «»

CorrectPositionBeforeMove¶

Параметр, отвечающий за то корректировать ли положение кнопки до ее первого перемещения или нет. Если установлен в true, то в случае изменения ориентации устройства или же изменения размера окна бразуера позиция кнопки будет обновления в соответствии со стартовой позицией ButtonPosition

По умолчанию: true

OnNoShowPixel¶

Пиксель вызываемый если кнопка НЕ показывается (в админке задается для всего аппа).

OnShowPixel¶

Пиксель вызываемый если кнопка показывается (в админке задается для всего аппа).

LocationPoints¶

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

Массив состоит из обхектов формата {"rad": 500, "lat": 33.33, "lon": 55.55}

Где соответственно:

rad - радиус от точки, азадется в метрах
lat - широта
lon - долгота

RequireLocation¶

Требуется ли для работы кнопки данные геолокации.

По умолчанию: false

ButtonInjectPath¶

Путь по которому будет добавляться #probtn_wrapper блок кнопки, а также код модального окна.

По умолчанию: body

waitIframeLoadedMsg¶

Ожидать сообщения от креатива о завершении загрузки и инициализации креатива, в частности probtn_creative_loaded_message сообщение.

Управление кнопкой посредстовм postMessage сообщений из iframe

По умолчанию: false

waitContentLoadedMsg¶

animationData¶

Дополнительные данные для анимации, в частности используется для добавления описания пути анимации кнопки (генерируется редактором http://probtn-animation-service.azurewebsites.net/ )

RoundButton¶

Формат: <режим>_<доп-параметр>_<цвет-заливки>

Варианты режима:

none - ничего не делать, по умолчанию
auto - автоматическое приведение формата кнопки до круга или элипса. Также возможно указать заливку свободного места, к примеру auto_fill_#121212
manual - ручное указание «закругления» (указывается как второй параметр, к примеру manual_30)

LockBody¶

Если включено, то мы применяем css стили для body для установки ширины и высоты равной 100%, а также скрытие полос прокрутки. Требуется для тех случаев, когда в модальном окне необходим ввод данных на ios во избежание смещения положения модального окна.

По умолчанию: false

CloseButtonShowDelay¶

Время в ms до показа области закрытия, в случаях если AlwaysShowCloseButton == true (то есть область закрытия показывается всегда).

По умолчанию: 0

SoundURL¶

URL до звукового файла, который будет воспроизведен на странице. Если поле пусто, то никакие действия производится не будут.

По умолчанию: «»

SoundMode¶

Режим воспроизведения аудио.

По умолчанию: «»

Варианты:

autoStart - автозапуск (за исключением ios, где данный режим работает аналогично режиму по умолчанию)
«» - запуск звука после взаимодействия пользователя со страницей

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

Варианты: * cycle - циклическое воспроизведение аудио до ее ручной остановки.

Пример:

autoStart_cycle

Заметка: Воспроизведение звука вручную останавливается если кнопка будет закрыта.

UseExternalDataAboutUser¶

Использовать или нет дополнительные данные по пользователям из внешних систем (в настоящее время Amber data)

По умолчанию: false

FancyboxcloseMethod¶

Анимация закрытия модального окна

По умолчанию: «zoomOut»

FancyboxCloseSpeed¶

Длительность анимации закрытия модального окна

По умолчанию: 0

CreativeId¶

Идентификатор креатива для обязательного показа

По умолчанию: «»

PassbackCustomCode¶

В данном параметре возможно указать код, который будет вызываться в случае, если кнопка будет выключена (когда от admin.probtn.com придет {"ButtonVisible":false,"ButtonEnabled":false})

Внимание - желательно предварительно тестировать желаемый код до использования.

По умолчанию «».

ModalWindowMode¶

Параметр, описывающий дополнительное поведение модального окна (показываемого при клике на кнопку).

Варианты:

(пустое) - ничего не происходит отличного от поведения по умолчанию
sidebarLeft
sidebarRight
sidebarTop
sidebarBottom

По умолчанию «».

ExtrusionMode¶

Параметр, отвечающий за режим «выдавливания» страницы.

Варианты:

(пустое) - ничего не происходит отличного от поведения по умолчанию
topButton - body страницы будет сдвинуто вниз на высоту кнопки

По умолчанию «».

AdditionalTargetingParam¶

Дополнительный кастомный параметр для таргетинга, позволяющий гибко настроит таргетинг admin.probtn.com в зависимости от задач.

По умоланию «».

isAnimation¶

Варианты анимации кнопки.

Значения параметра:

opacity
rollout
lookout
forwardAndBack
forwardStopAndAway
anim1
anim2
upToDown
topToBottomAndStop
lookoutAndOut

Анимация opacity¶

Изменяет прозрачность кнопки с указанной в ButtonOpacity прозрачности кнопки до 0.55 по умолчанию. Также возможно задать конечную прозрачность, указав в качестве параметра opacity_<конечная прозрачность> к примеру opacity_0.4

Анимация rollout¶

Выдвижение кнопки по мере скролла страницы.

Возможно указать сторону из которой будет «выдвигаться» кнопка и максимальную ширину «выдвижения» (в процентах), в частности rollout_<сторона>_<ширина> к примеру rollout, rollout_left, rollout_left_60

Анимация lookout¶

Постоянное выдвижение и скрытие кнопки около края страницы.

Возможно указать сторону из которой будет «выдвигаться» кнопка, в частности lookout_<сторона> к примеру lookout, lookout_left, lookout_right

Анимация forwardAndBack¶

Кнопка перемещается от левого края до правого, затем обратно до левого.

Анимация forwardStopAndAway¶

Кнопка перемещается из-за левого края до середины, останавливается и затем перемещается за правый край. Длительность каждого этапа задается параметром animationDuration

Анимация upToDown¶

Перемещение кнопки сверху к низу экрана (либо наоборот, указав дополнительный параметр направления анимации)

upToDown_<сторона_up_или_down>_<длительность_ожидания_перед_запуском_анимации_в_мс>

topToBottomAndStop¶

Перемещение кнопки сверху к низу экрана (либо наоборот, указав дополнительный параметр направления анимации). В последствии topToBottomAndStop и upToDown будут объеденины для исключения дублирования.

animationDuration¶

Длительность анимации, задается в мс.

MenuTemplateVariant¶

Параметр предназначен для выбора шаблона отображения меню. (предназначен для ButtonType==menu)

Варианты значений параметра:

list - шаблон по умолчанию, список
radialcorner - частичное радиальное меню (кнопка находится в углу, и пункты меню выстроены в зоне от 0 до 90 градусов)
circularCenter - круговое меню

VideoType¶

Тип видео.

Варианты:

mp4 - по умолчанию
youtube - видео с youtube

false

waitForIframeButtonLoaded¶

Ждать ли пока загрузится контент iframe кнопки

По умолчанию:

true

ButtonIframeInitialSize¶

Размер кнопки. Задается как объект { W: 0, H: 0 } Где W и H соответственно ширина и высота в px.

В случае, когда значения равны нулю, для iframe кнопки не применяется «масштабирование».

Если указаны размеры, то iframe от этих размеров будет подгонятся под размеры, указанные в ButtonSize параметре соответственно.

ButtonImageType¶

Тип содержимого кнопки. По умолчанию image

Варианты:

image
iframe

ClickOnCloseButton¶

Скрытие кнопки по клику на кнопку. По умолчанию false

AlwaysShowCloseButton¶

Всегда показывать область закрытия. По умолчанию false

FullscreenClickLink¶

(Для режима ButtonType=='fullscreen')

HideWithoutInteractionTime¶

По умолчанию 0 (не скрывать).

Время, спустя которое кнопка скрывается, если не было с ней взаимодействия

cssEaseDuration¶

Длительность анимации (в мс) для jquery.pep - по умолчанию 300.

ChangeScrollButtonAtFullSiteHeight¶

Меняется ли изображение кнопки в scroll режиме на основе высоты сайта (true), или размера window (false)

ControlInIframeFromParent¶

Управляется ли кнопка из родителя - по умолчанию false

isAddUtmSource¶

Добавлять ли к ContentURL параметр utm_source. По умолчанию false

UtmSourceUseOnlyDomain¶

По умолчанию false. Использовать ли по умолчанию в utm_source. В случае false - используется полный url, в случае true - использует только домен.

UtmCampaign¶

Значение параметра utm_campaign, если пустая строка, то не указывается. По умолчанию «»

UtmSource¶

Значение параметра utm_source, если пустая строка, то используется текущий url страницы (или домен, в зависимости от параметра UtmSourceUseOnlyDomain). По умолчанию «»

IframeScale¶

Параметр для применения к iframe для transform: scale(value) По умолчанию 1. В случае если указан iframeScaleMinWidth !=0 рассчитывается исходя из данного параметра.

ButtonInitDelay¶

Задержка перед показом кнопки (в мс), по умолчанию 0

VideoClickURL¶

Ссылка, по которой переходит пользователь по нажатию на видео. (В случае если VideoClickURL ==““ , то для этого подставляется строка из VideoPoster. Когда параметр пуст, ссылку на видео не добавляем)

ButtonOnClick¶

событие по нажатию на кнопку (добавляется в onclick, необходимо для запуска видео под мобильными браузерами) По умолчанию: function start1() { var video = $(«#video»).get(0); video.play(); }; start1(); setTimeout(start1 , 1500);

ButtonType¶

тип кнопки По умолчанию button - поведение кнопки по умолчанию.

Текущие варианты ButtonType:

button - кнопка с iframe в fancybox
menu - floating menu режим
smartbanner - показ смартбаннера
fullscreen - автозапуск содержимого после инициализации скрипта
button_and_active_zones - кнопка с использованием активных зон
button_and_scroll_zones - кнопка со сменой изображений с различными изображениями в разных зонах экрана (по высоте)
fullscreen_fancybox - автозапуск содержимого в fancybox после инициализации скрипта
fullscreen_and_button - одновременный показ кнопки и модального окна
expansionVideo - расширяющаяся кнопка после нажатия (для mp4 плеера)
expansionButton - расширяющаяся кнопка после нажатия

ButtonContentType¶

Тип содержимого кнопки

По умолчанию

iframe - показ страницы в iframe

Текущие варианты ButtonContentType

iframe - страница в iframe
video - показ видео
anchor - переход на указанный якорь на странице (варианты ContentURL - полная ссылка или якорь на странице, к примеру #someAnchor - переход к якорю или ссылке происходит в той же вкладке

VideoSize¶

Размер видео (необходим для корректного перерасчета размера видео, в связи с тем что некоторые мобильные браузеры по некоторой причине не сохраняют пропорции видео) Сам параметр - объект, который состоит из X и Y параметров (ширина и высота соответственно). Пример (оно же значение по умолчанию): VideoSize: { X: 1920, Y: 1080 }

VideoPoster¶

Постер для видео Представляет собой url (до картинки).

TrackingLink¶

Ссылка на изображение, которое будет применено как background для wrapper’а кнопки. Введен в связи с необходимостью предоставить возможность указывать свое изображение-«пиксель» для сбора статистики о пользователе.

MinimizeWrapperTime¶

Время (в мс), спустя которое уменьшается размер wrapper’а кнопки. Применен в связи с проблемами некорректной анимации в ряде случаев на мобильных устройствах

OpenExternal¶

Параметр, отвечающий за то, как именно должна открываться ссылка (соответственно для ButtonType = button ) false - содержимое открывается в fancybox true - контент открывается в новой вкладке (применяется в случае, если сайт не может быть показан в iframe по тем или иным причинам)

CampaignID¶

Идентификатор кампании

NeverClose¶

При true убирает область закрытия для кнопки Применимо при ButtonType = button

domain¶

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

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

fancyboxJsPath¶

Url до расположения fancybox js библиотеки.

fancyboxCssPath¶

Url до расположения fancybox css

jqueryPepPath¶

Url до расположения jquery.pep библиотеки

buttonAnimationTimeAfterFancybox¶

Длительность анимации кнопки после закрытия fancybox, в мс

HideAfterFirstShow¶

Возможность скрыть кнопку после первого показа пользователю

true - после первого показа кнопка скрывается (до тех пор, пока HideAfterFirstShow не будет установлен в true, либо не истечет срок действия cookie)
false - кнопка показывается каждый раз (естественно в зависимости от настроек сервера и таргетинга на стороне сервера)

Применимо при ButtonType = button

LoadFancyboxCSS¶

Загружать или нет css по-умолчанию для fancybox

true - загружать
false - не загружать (к примеру в случае если на сайте уже используется fancybox)

ContentURL¶

Url на контент, показываемый кнопкой. Для разных ButtonContentType

iframe - любая ссылка на сайт или иной контент, показываемый в iframe
video - ссылка на видео (формата, поддерживаемого HTML5 video)

ButtonEnabled¶

Включена / выключена

ButtonVisible¶

Видна / не видна

ButtonPosition¶

Позиция кнопки. Задается как объект {X:0.5, Y:.5} Где X и Y указывается от 0 до 1 (от 0 до 1, где 1 - ширина или высота window соответственно) Применимо при ButtonType = button

ButtonSize¶

Размер кнопки. Задается как объект { W: 64.0, H: 64.0 } Где W и H соответственно ширина и высота в px Применимо при ButtonType = button

ButtonDragSize¶

Размер кнопки во время перетаскивания. Задается как объект { W: 64.0, H: 64.0 } Где W и H соответственно ширина и высота в px.

Применимо при uttonType = button