Динамический контент

Динамический контент позволяет использовать скриптовый язык (JavaScript), чтобы изменять содержимое каждого сообщения. Используя динамический контент, вы сможете показать различное содержание для разных пользователей в зависимости от выбранных условий. Также вы сможете вставить системные или пользовательские переменные.

Примеры самых популярных данных для вывода в сообщение:

• имя и фамилия контакта
• значения полей данных
• содержимое корзины или избранного
• просмотренные или купленные товары

Полный список данных для вывода в сообщение представлен ниже.

Данные для персонализации и постановки динамического контента хранятся в карточке контакта.

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

{{fieldname_example}}

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

Основные поля

Системные ссылки

Дата отправки письма

Информация о сообщении

Информация об отправителе

Все функции динамического контента, обёрнутые в {% %}, рекомендуем дополнительно оборачивать в комментарии <!-- -->, так как символы сравнения и прочие символы в динамическом контенте конфликтуют с тегами HTML. Текст или значение, которые необходимо вывести в качестве результата, должны находиться вне комментариев.

Подстановка значения поля данных

{{extraField.Name}}

Проверить существование поля данных подписчика

{{IsExtraFieldExists('Системное имя поля данных')}}

Сравнение двух полей данных

<!--{% 
if (extraField.Name1 >= extraField.Name2) { %}--> 
  Какой-либо текст
<!--{% }; %}-->

Изменение значения поля данных при отправке письма

{{SetExtraField('Name', value)}}

Изменение значения поля данных при клике по ссылке в письме

<a href="{{SetExtraFieldByClick('https://link.com', 'EF_system_name', 'EF_value')}}">клик</a>

Отписка персоны от конкретных групп рассылок

{{Unsubscribe('groupname', 'groupname2')}}

Отписка от конкретных групп рассылок с редиректом на указанный URL

{{UnsubscribeRedirect('link', 'groupName', 'groupName2')}}

Подписка персоны на конкретные группы рассылок

{{Subscribe('groupname', 'groupname2')}}

Подписка на конкретные группы рассылок с редиректом на указанный URL

{{SubscribeRedirect('link', 'groupName', 'groupName2')}}

Ссылка подтверждение DOI с редиректом на указанный URL

{{ConfirmRedirect('http://mysite.com/')}}

Подстановка значения поля сценария

{{scenarioField.Name}}

Доступно только в сценарных сообщениях того сценария, в котором эти поля создаются.

Преобразование типа поля данных к другому типу данных

{% 
   var a = extraField.weight;
   var value = String(a);
   if (value === '60') { %}
     Вы весите 60 кг 
{% }; %}

Возвращает текущее время в в формате unix timestamp

{{TimeNow()}}

Возвращает переданное время в формате unix timestamp

{{TimeParse('2020-11-25 15:31')}}

Прибавляет к указанному времени нужное количество времени. Первый параметр - время в формате unix timestamp (можно получить из TimeNow() или TimeParse()). Второй параметр - единица времени, возможные значения 'sec', 'min', 'hour', 'day'. Третий параметр - количество времени (может быть отрицательным)

{{AddTime(1603459057, 'min', 3)}}

Форматирует полученное время в формате unix timestamp к переданному формату. Первый параметр - время, второй - формат. В формате передается пример того, как нужно вернуть дату или время. Формат работает по константам, например: Mon Jan 2 15:04:05 MST 2006, 2020-01-02 18:24:05 и т.д.

{{TimeFormat(1603459057, '2006-01-02 15:04:05')}}

Возвращает закодированную в Base64 строку

{{Base64Encode('Текст')}}

Декодирует строку

{{Base64Decode('0KLQtdC60YHRggoK')}}

Парсит XML в JSON

{{ParseXML('XMLcontents')}}

Забирает данные с любого внешнего источника по указанной ссылке

{{HttpGet('https://link.com')}}

Сниппет - это фрагмент кода или текста, который передается в транзакционные сообщения с помощью API-запросов. Значения сниппетов, используемых в транзакционных сообщениях, также можно получить с помощью функций динамического контента.

Подставить значение сниппета

{{Snippet('snippetName')}}

Проверить существование сниппета

{{IsSnippetExists('название сниппета')}}

Использование сниппета в выражении с условием

{% 
   var value = Snippet('snippetName');
   if (value === '10') { 
%}
     Значение сниппета snippetName 10 
{% 
} else { 
     Abort()
   }
%}

Парсинг XML из сниппета

Значение сниппета:

<Products>
  <Product>
    <product_id>12345</product_id>
  </Product>
</Products>

{% 
    var xmlSnippet = Snippet('xml');
    var xmlTpJson = ParseXML(xmlSnippet);
    //Вывод результата
    for(let key in xmlTpJson[0].Products.Product){
%}
    {{xmlTpJson[0].Products.Product[key]['product_id']}}
{% 
    }
%}

<a href="{{DoNotTrackLink('https://link.com')}}">клик</a>

С помощью JavaScript

{% 
   if ('Какое-либо условие') { %} 
     Какое-либо значение 
{% 
   } else { 
     Abort()
   }
%}

С помощью динамического контента

  {{Abort()}}

Ниже приведен список всех доступных на данный момент функций для работы с триггерными механиками.

Подставить все товары из корзины

{% 
var str = GetCart.Products;
    str.forEach(function(item, i, arr) { 
%} 
   {{item.productId}} 
{% 
   }); 
%}

Подставить все товары из избранного

{%
var str = GetFavourite.Products;
    str.forEach(function(item, i, arr) { 
%} 
  {{item.productId}} 
{% 
   }); 
%}

Подставить N последних или все товары из сравнения

{% 
var str = GetComparison(N).Products;
    str.forEach(function(item, i, arr) { 
%} 
   {{item.productId}} 
{% 
   }); 
%}

, где N - количество необходимых для вывода в письмо товаров (для вывода всех товаров из сравнения используйте GetComparison().Products)

Подставить N товаров из последних M просмотренных категорий

{% 
 var str = OpenedCategoryItems(N, M).Get();
    str.forEach(function(item, i, arr)
%} 
   {{item.productId}}    
{% 
   }); 
%}

, где:

• N - количество необходимых для вывода в письмо товаров
• M - количество последних просмотренных категорий (от самой недавно_просмотренной к самой давно_просмотренной)

При этом, полученные товары можно:

• фильтровать по параметрам из товарного фида (число фильтров не ограничено, все фильтры работают через логическое И)
• сортировать по числовым параметрам из товарного фида (максимум 1 сортировка)

Пример использования:

OpenedCategoryItems(10, 4).FilterBy("price", >, "1500").OrderBy("price",ASC).FilterBy("color", equal, "blue").FilterBy("size", equal, "S").OrderBy("rate",DESC).Get();

, где:

• 10 - кол-во товаров
• 4 - кол-во последних просмотренных категорий (от самой недавно_просмотренной к самой давно_просмотренной)
• FilterBy(«price», >, «1500») - фильтр по цене > 1500
• OrderBy(«price»,ASC) - сортировка по цене от низкой к высокой
• FilterBy(«color», equal, «blue») - фильтр по цвету = голубой
• FilterBy(«size», equal, «S») - фильтр по размеру = S
• OrderBy(«rate»,DESC) - сортировка по рейтингу от высшего к низшему (не сработает, т.к. будет применена первая сортировка - по цене)

Вернуть массив открытий подписчика

Принимает 3 и более параметров. Первый параметр - максимальное количество получаемых записей (максимум 100, если передать ноль, то будет 100). Второй параметр - сортировка по дате (возможные значения - DESC, ASC, Newest, Oldest). Третий параметр - фильтр по дате (должен выглядеть как строка с оператором и датой в формате unix timestamp. Возможные операторы >,>=,<,⇐,!=,=. Время можно получить методами работы со временем). Можно передавать несколько фильтров, например: GetOpens(10, Newest, '!= 1603459057', '!= 1603459058'), все фильтры работают через логическое и. Третий параметр может работать как период: возможные варианты - 'between 1603459057 and 1603459059', 'from 1603459057 to 1603459059'. 'from 1603459057 and 1603459059' тоже будет работать, нечувствителен к регистру, так же можно добавлять несколько таких параметров.

{{GetOpens(10, Newest, '< 1609888844')}}

Метод GetOpens возвращает массив объектов с полями:

• count
• productId
• lastUpdate

Вернуть массив заказов подписчика (аналогично GetOpens)

{{GetOrderList(100, DESC, 'between 1603459057 and 1603459059')}}

Метод GetOrderList возвращает массив объектов с полями:

• items
• order
• orderId
• orderDate

Вернуть информацию о заказе со всеми товарам и параметрами по ID заказа

{{GetOrder('orderId')}}

Получить N пользовательских событий с параметрами за период

{% 
  var str = GetCustomEvent('eventname',10,'between 1603459057 and 1603459059'); 
  str.forEach(function(item, i, arr) { 
%} 
  Параметр 1 - {{item.params.param1}} <br>
  Параметр 2 - {{item.params.param2}} <br>
{% 
  }); 
%}

где:

• eventname - системное имя пользовательского события. Обязательный параметр,
• 10 - количество пользовательских событий, которое необходимо получить. Необязательный фильтр:
  • максимум 100 событий;
  • при попытке запросить более 100 событий - в ответе придут только первые 100;
  • если по фильтру событий в базе 5, а вы запрашиваете, например, 10 - в ответе придут 5 событий;
  • если запросить 0 событий или совсем не передать фильтр событий - вернется 100;
• between 1603459057 and 1603459059 - период, за который необходимо получить события. Необязательный фильтр:
  • возможные варианты использования:
    • 'between 1603459057 and 1603459059';
    • 'from 1603459057 to 1603459059';
    • 'from 1603459057 and 1603459059';
    • нечувствителен к регистру;
  • в ответе будут получены N самых последних событий, отсортированных по дате записи (от самых недавних к самым старым) за указанный период, учитывая лимит. Например: если в фильтре лимита вы указали 10 событий, а за запрашиваемый период есть 100 событий, то в ответе вернутся самые последние 10;
  • если указать в фильтре будущее время - метод отработает без ошибок, но ответ не вернется;
  • можно не указывать период - вернутся последние N событий.

Чтобы начать использовать функции для таблиц данных, нужно создать объект/структуру, которая будет основой для запроса:

{% var rows = Rows(); %}

Чтобы исполнить запрос в таблицу данных, все запросы в динамическом контенте всегда нужно заканчивать функцией Execute()

{% var rows = Rows().Execute(); %}

Добавить таблицу можно методом

Table('TableName')

Если этот метод будет вызван больше одного раза к одному объекту Row, произойдет ошибка.

Для работы с таблицами доступны следующие методы:

• Get() - забирает одну или несколько строк (со всеми столбцами). Максимальный лимит и дефолтное значение 500.
• GetAndDelete() - забирает одну строку и удаляет её из таблицы.
• Update() - обновляет строку или несколько строк, принимает как аргумент название столбца и значение, которые нужно изменить. Можно несколько.
• Delete() - удаляют строки по условию.
• Insert() - добавляют строку или несколько строк.
• Upsert() - добавляют строку или несколько строк, если строки существуют - обновляют их.
• IsExist() - возвращает булево значение существования строки по условиям.

Вспомогательные функции:

• Limit(10) - ограничивает количество возвращаемых строк. Работает только с методом Get, в остальных ничего не сделает, но и ничего не сломает
• Offset(3) - Смещает поиск на указанное количество строк. Аналогия slq. Работает только с методом Get, в остальных ничего не сделает, но и ничего не сломает
• OrderBy('colName', DESC) - сортировка. Значения сортировки описаны ниже. Аналогия slq. Работает только с методом Get, в остальных ничего не сделает, но и ничего не сломает
• Where('colName', 'operator', 'val') - Условия. Принимает в себя параметры - название колонки, оператор, значения. Список операторов ниже.

Если значений будет несколько, они будут идти через логическое ИЛИ, пример: Where('colName', 'operator', 'val', 'pal', 'cal'). Если сделать два условия к одному объекту Row, то они будут идти через логическое И, пример: Where('colName', 'operator', 'val').Where('colName2', 'operator', 'pal'). Работает со всеми функциями, кроме Insert и Upsert.

• Set('colName', 'val') - устанавливает значение столбца. Можно передавать больше одной пары. Но если количество входящих данных будет не четным, последний элемент будет отсечен, чтобы сохранился порядок (название столбца/значение). Используется с методами Insert, Upsert, Update
• NewRow() - команда, которая позволяет сохранять больше одной строки. Чтобы понять, как это работает, разберем пример:

Rows().Insert().Table('someTable').Set('colName', 'val').Execute() - объявляем метод добавления строки и говорим, чтобы он добавил значение val в столбец colName. Допустим, мы хотим сохранить еще одну строку, но чтобы в столбце colName было другое значение. Rows().Insert().Table('someTable').Set('colName', 'val').NewRow().Set('colName', 'val2').Execute() - таким образом у нас в таблице окажется две строки.

Особенности работы с таблицами данных:

• Все функции можно добавлять в разном порядке, но только Rows должна быть на первом месте, а Execute на последнем.
• Можно дублировать функции Where, Set, NewRow
• Можно дублировать функции Limit, Offset, OrderBy, но актуальным будет только последнее значение
• В функции, которые изменяют данные Insert, Update, Upsert можно сразу писать пары название столбца/значения, минуя функцию Set: Rows().Insert('colName', 'val').Table('someTable')
• При получении строк методами Get или GetAndDelete можно указать, какие именно столбцы требуется получить (если нужны не все). Для этого в эти функции можно передать названия столбцов: Get('col1', 'col2'…). Если ничего не передать, то вернутся все столбцы. Можно передать символ *, в это случае так же вернутся все столбцы. Пример: Get('*') - обязательно в кавычках, иначе компилятор расценит это как знак умножения.
• Дату нужно передавать в timestamp. Для этого можно использовать функцию TimeParse(), DateParse(). Например, Where('date',inthisday,DateParse('2021-05-27')))
• При добавлении строк в таблицы в функции Insert, Upsert, Set обязательно должен присутствовать первичный ключ, если он есть в таблице (например, Rows().Insert().Table('new_norm_table').Set('text', 'Независимые СМИ потому и независимы, что в провинциях ещё есть чем поживиться', 'num', 1000).Execute(), где num - primary key)
• Операторы и сортировки, записываются без кавычек

Сортировки

• ASC - сортирует от низких значений к высоким. OrderBy('num', ASC) или OrderBy('num', asc)
• DESC - сортирует от высоких значений к низким. OrderBy('num', DESC) или desc - OrderBy('num', desc)
• oldest - самое низкое значение. OrderBy('num', oldest)
• newest - самое высокое значение. OrderBy('num', newest)

Операторы

• equal, eq, EQ - равенство. Where('num', equal, '111'), Where('num', eq, '111'), Where('num', EQ, '111')
• notequal, ne, NE - неравенство. Where('num', notequal, '111')
• beginwith - начинается с. Where('email', beginwith, 'qwe')
• endwith - оканчивается на. Where('email', endwith, 'qwe')
• contains - содержит. Where('email', contains, 'qwe')
• notcontains - не содержит. Where('email', notcontains, 'qwe')
• morethan - больше, чем. Where('num', morethan, '111')
• moreorequalthan - больше или равно, чем. Where('num', moreorequalthan, '111')
• lessthan - меньше, чем. Where('num', lessthan, '111')
• lessorequalthan - меньше или равно, чем. Where('num', lessorequalthan, '111')
• between - между. Where('num', between, '111', '11111')
• isNull - равен нулю. Where('num',isNull,'')
• today - текущий день. Where('date',today,'') - значение указывать не надо
• inthisday - в конкретный день. Where('date',inthisday,DateParse('2021-05-27') - условие по дню, равному 27
• inthisyear - текущий год. Where('date',inthisyear,'') - значение указывать не надо
• inthismonth - текущий месяц. Where('date',inthisday,'') - значение указывать не надо

Операторы арифметических операций записываются в кавычках, их тоже можно использовать (Where('num', '=', '1'))

• '='
• '<'
• '<='
• '>'
• '>='
• '!='

Примеры:

Rows().Get('*').Table('norm_table').Where('num', lessthan, '111').Execute();
Rows().Get('*').Table('norm_table').Limit(10).Where('num', '=', '1').Execute();
Rows().Get('*').Table('norm_table').Where('num', between, '111', '11111').Execute();
Rows().Get('*').Table('norm_table').Where('email', startwith, 'qwe').Execute();
Rows().Get('*').Table('norm_table').Where('email', notcontains, 'yopmail').Where('email', ne, 'qwe@qwe.ru').Execute();
Rows().Insert().Table('new_norm_table').Set('text', 'Независимые СМИ потому и независимы, что в провинциях ещё есть чем поживиться', 'num', 1000).Execute();
Rows().Get('*').Table('norm_table').Where('email', equal, 'qwerty@qwe.ru', 'qwe@qwe.ru').Execute();
Rows().Delete().Table('new_norm_table').Where('num', '=', '2').Execute(); 

Вывод строки/поля в письме

Вывод результата записывается в следующем виде:

{{название переменной[номер строки].название столбца}}

Пример для переменной rows и первой строки столбца value:

{{rows[0].value}}

В емейл-сообщениях вы можете использовать SQL-шаблоны для динамического контента (подробнее об их создании в этом разделе).

Для использования созданного шаблона в письме необходимо обратиться к шаблону и записать информацию, которую он возвращает в переменную. Сделать это можно следующим образом:

{% var name = GetByTemplate(123); %}

где:

• name - название переменной;
• 123 - id SQL-шаблона.

Для шаблона с параметром код будет выглядеть так:

{% var name = GetByTemplate(123,{'param':value}); %}

где:

• name - название переменной;
• 123 - id SQL-шаблона;
• param - название параметра в SQL-шаблоне;
• value - значение, которое необходимо подставить в параметр.

Вывод значения в письме будет стандартным :

{{name[0].field}}

где:

• name - название переменной;
• 0 - номер (индекс) строки;
• field - название поля.

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

GetProducts('productid1', 'productid2')

где

• productid1 и productid2 - идентификаторы товаров в каталоге

Пример для получение товаров 3FF144 и 341FFDW с параметрами

{%
var str = GetProducts('3FF144', '341FFDW');
    str.forEach(function(item, i, arr) { 
%} 
  Идентификатор товара {{item.id}}
  Название товара {{item.name}}
  Категория товара {{item.category}}
  Любой другой параметр товара {{item.param}}
{% 
   }); 
%}

Для получения и подстановки в емейл-сообщение товарных рекомендаций используйте метод

GetRecoms('scriptId', 'productId')

где

• scriptId - id блока рекомендаций в сервисе (обязательно)
• productId - идентификатор товара, к которому необходимо подобрать рекомендации для алгоритмов похожих или сопутствующих товаров (необязательно)

Чтобы получить параметры товара, необходимые для подстановки в письмо, используйте конструкцию вида

{{item.info.param}}

где

• param - название необходимого параметра из товарного фида

Для записи в переменную значений, а также последовательного вывода в письмо товаров, получаемых с помощью метода, используйте конструкцию

{%
  var str = GetRecoms('scriptId', '');
  str.forEach(function(item, i, arr) { 
%}
Идентификатор товара {{item.id}}
Название товара {{item.info.name}}
Категория товара {{item.info.category}}
Любой другой параметр товара {{item.info.param}}
{%
  });
%}

где

• scriptId - идентификатор блока рекомендаций
• {{item.id}}, {{item.info.name}}, {{item.info.category}}, {{item.info.param}} - параметры товара, подставляемые в емейл-сообщение