Использование шаблонов Liquid

Шаблоны Liquid значительно расширяют возможности персонализации Pushwoosh, реализуя сложную логику в дополнение к обычному использованию динамического контента.

Персонализация сообщений в Pushwoosh основана на тегах (данных пользователя). Pushwoosh предлагает множество тегов по умолчанию и пользовательских тегов. С их помощью вы можете указать имя пользователя, город, историю покупок и т. д., чтобы отправить более персонализированное сообщение, например: Привет, {First_name}, спасибо за заказ {item}.

Шаблоны Liquid добавляют больше логики в динамический контент. Например, если тег подписки пользователя содержит «free», вы можете отправить ему сообщение: «Получите скидку 10%».

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

Синтаксис

Шаблоны контента, основанные на Liquid от Shopify, используют комбинацию тегов, объектов и фильтров для загрузки динамического контента. Шаблоны контента позволяют вам получать доступ к определенным переменным из шаблона и выводить их данные, не зная ничего о самих данных.

Примечание

Чтобы узнать больше о синтаксисе, обратитесь к документации Liquid.

Объекты

objects (объекты) определяют контент, который будет отображаться пользователю. objects должны быть заключены в двойные фигурные скобки: {{ }}

Например, при персонализации сообщения отправьте {{Name}} в его теле, чтобы добавить имена пользователей в содержимое сообщения. Имя пользователя (значение тега Name) заменит объект Liquid в сообщении, которое увидит пользователь.

Входные данные

Hi {{Name}}! We're glad you're back!

Выходные данные

Привет, Анна! Мы рады, что вы вернулись!

Теги

tags (теги) создают логику и управляют потоком для шаблонов. Разделители в виде фигурных скобок и процентов {% и %} и текст, который они окружают, не создают видимого вывода при рендеринге шаблона. Это позволяет вам назначать переменные и создавать условия или циклы, не показывая пользователю никакой логики Liquid.

Например, используя тег if, вы можете изменять язык сообщения в зависимости от того, какой язык установлен на устройстве пользователя:

Входные данные

{% if Language == 'fr' %}
Salut!
{% else %}
Hello!
{% endif %}

Выходные данные (fr)

Salut!

Выходные данные (es)

Hello!

Операторы тегов

Оператор	Описание
==	равно
!=	не равно
>	больше чем
<	меньше чем
>=	больше или равно
<=	меньше или равно
or	логическое или
and	логическое и
contains	проверяет наличие подстроки в строке или массиве строк

Примечание

В тегах с более чем одним оператором and или or операторы проверяются в порядке справа налево. Вы не можете изменить порядок операций с помощью скобок — скобки являются недопустимыми символами в Liquid и помешают работе ваших тегов.

Фильтры

filters (фильтры) изменяют вывод объекта или переменной Liquid. Они используются в двойных фигурных скобках {{ }} и при присваивании переменных и разделяются символом вертикальной черты |. К одному выводу можно применить несколько фильтров, и они применяются слева направо.

Входные данные

{{ Name | capitalize | prepend:"Hello " }}

Выходные данные

Hello Anna

Использование шаблонов Liquid в сообщениях, отправляемых через API

Используйте синтаксис Liquid в ваших запросах createMessage для реализации шаблонов Liquid. Шаблоны доступны для параметра «content» запроса createMessage, а также для любого другого параметра, поддерживающего динамический контент, в частности, для специфичных для платформы параметров «title», «subtitle» и «image».

Используя шаблоны контента, вы можете либо указать данные в своих API-запросах (передавая параметр «template_bindings»), либо получить данные из значений тегов, хранящихся на устройствах пользователей (не используя параметр «template_bindings»). Таким образом, вы можете создавать push-кампании на основе пользователей, содержащие чрезвычайно релевантный контент.

Примечание

Обратите внимание, что в отличие от динамического контента, переменные в шаблонах должны быть заключены в двойные фигурные скобки следующим образом: {{myVariable}}.

Чтобы определить логику шаблона с использованием тегов с пробелами в их именах, используйте следующий метод:

Пример

{% capture my_tag %}{{My Tag}}{% endcapture %}
{% if my_tag == 'value' %}
Контент для отправки в этом случае
{% else %}
Контент для отправки в противном случае
{% endif %}

Примеры использования шаблонов Liquid

Здесь вы найдете несколько примеров использования шаблонов Liquid.

Многоязычные push-уведомления

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

Входные данные Liquid

{% if Language == 'es' %}
¡Hola!
{% else %}
Hello!
{% endif %}

API-запрос

{
  "request": {
    "application": "XXXXX-XXXXX", // Pushwoosh app code
    "auth": "yxoPUlw.....IyEX4H", // API access token from Pushwoosh Control Panel
    "notifications" : [ // push message parameters
      {
       "content": "{% raw %}
{% if language == 'es' %}¡Hola!{% else %}hello!{% endif %}
{% endraw %}",
        "template_bindings": { // optional. When no template_bindings are passed in a request, Tag values from the device are used.
         "language" : "es"
        }
      }
    ]
  }
}

Выходные данные

Язык ‘es’: ¡Hola!

Язык ‘en’: Hello!

Предложение обновить подписку

Поощряйте ваших клиентов обновлять подписку в зависимости от их текущего плана.

Входные данные Liquid

{% if Subscription == 'Basic' %}
    Upgrade to Silver for getting more product features and 24/7 support.
{% elsif Subscription == 'Silver' %}
    Upgrade to Gold for priority support and advanced features.
{% else %}
    Please contact your manager to renew your subscription.
{% endif %}

API-запрос

{
  "request": {
    "application": "XXXXX-XXXXX", // Pushwoosh app code
    "auth": "yxoPUlw.....IyEX4H", // API access token from Pushwoosh Control Panel
    "notifications" : [ // push message parameters
      {
       "content": "{% raw %}
{% if Subscription == 'Basic' %}Upgrade to Silver for getting more product features and 24/7 support.{% elsif Subscription == 'Silver' %}Upgrade to Gold for priority support and advanced features.{% else %}Please contact your manager to renew your subscription. {% endif %}
{% endraw %}",
        "template_bindings": { // optional. When no template_bindings are passed in a request, Tag values from the device are used.
         "language" : "es"
        }
      }
    ]
  }
}

Выходные данные

Для пользователей с планом подписки Basic: Обновитесь до Silver, чтобы получить больше функций продукта и поддержку 24/7.

Для пользователей с планом подписки Silver: Обновитесь до Gold для приоритетной поддержки и расширенных функций.

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

Теги типа List

Шаблоны контента очень полезны для обработки тегов типа List.

Размер переменной

Один из возможных вариантов использования — доставка разного контента в зависимости от количества значений, содержащихся в теге. Например, вы можете предоставлять разные скидки клиентам с разным поведением. Допустим, у клиента есть несколько товаров в списке желаний — поощряйте его к покупке с наиболее подходящей скидкой в зависимости от того, сколько товаров он собирается купить!

Входные данные Liquid

{% if WishList.size >= 3 %}
Get 20% off your next purchase!
{% elsif WishList.size == 2 %}
Get a 10% discount on your next purchase!
{% else %}
Hey, take a look at new outwears!
{% endif %}

API-запрос

{
  "request": {
    "application": "XXXXX-XXXXX", // Pushwoosh app code
    "auth": "yxoPUlw.....IyEX4H", // API access token from Pushwoosh Control Panel
    "notifications" : [ // push message parameters
      {
       "content": "{% raw %}
{% if WishList.size >= 3 %}Get 20% off your next purchase!{% elsif WishList.size == 2 %}Get a 10% discount on your next purchase!{% else %}Hey, take a look at new outwears!{% endif %}
{% endraw %}",
        "template_bindings": {
         "WishList" : ["Skinny Low Ankle Jeans", "Linen Trenchcoat", "High Waisted Denim Skirt", "Strappy Tiered Maxi Dress"]
        }
      }
    ]
  }
}

Размер WishList ≥ 3

Размер WishList = 2

Переменная содержит

Еще один случай, который вам может понадобиться, — это работа со значениями тегов типа List и доставка наиболее релевантного контента в зависимости от того, какие значения содержит тег.

Входные данные Liquid

{% if WishList contains 'Skinny Low Ankle Jeans' %}
Get 20% off products in your wishlist!
{% else %}
Hey, take a look at the brand new Skinny Low Ankle Jeans!
{% endif %}

API-запрос

{
  "request": {
    "application": "C90C0-0E786",
    "auth": "yxoPUlw.....IyEX4H", // API access token from Pushwoosh Control Panel
    "notifications" : [ // push message parameters
      {
       "content": "{% raw %}
{% if WishList contains 'Skinny Low Ankle Jeans' %}Get 20% off your next purchase!{% else %}Hey, take a look at the brand new Skinny Low Ankle Jeans!{% endif %}
{% endraw %}",
        "template_bindings": {
         "WishList" : ["Skinny Low Ankle Jeans", "Linen Trenchcoat", "High Waisted Denim Skirt", "Strappy Tiered Maxi Dress"]
        }
      }
    ]
  }
}

Переменная содержит данные

Переменная не содержит данные

Множественное число

Используя шаблоны контента, вы можете настраивать содержимое сообщения в соответствии с поведением пользователей. Например, вы можете изменять текст сообщения, чтобы он содержал слова во множественном числе, если тег типа List содержит более одного значения.

Входные данные Liquid

    Get 20% off item
{% if WishList.size > 1 %}
    s in your WishList!
{% else %}
    in your Wishlist!
{% endif %}

API-запрос

{
  "request": {
    "application": "C90C0-0E786",
    "auth": "yxoPUlw.....IyEX4H", // API access token from Pushwoosh Control Panel
    "notifications" : [ // push message parameters
      {
       "content": "Get 20% off item{% raw %}
{% if WishList.size > 1 %}s in your WishList!{% else %} in your Wishlist!{% endif %}
{% endraw %}",
        "template_bindings": { // optional. When no template_bindings are passed in a request, Tag values from the device are used.
         "WishList" : ["Skinny Low Ankle Jeans", "Linen Trenchcoat", "High Waisted Denim Skirt", "Strappy Tiered Maxi Dress"]
        }
      }
    ]
  }
}

Множественное число

Единственное число

Часовой пояс

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

Входные данные Liquid

{{ MyDate | timezone: MyTimezone | date: \"%Y-%m-%d %H:%M\" }}

API-запрос

Example

{
  "request" : {
    "auth" : "3H9bk8w3.....Acge2RbupTB", // API access token from Pushwoosh Control Panel
    "application" : "XXXXX-XXXXX", // Pushwoosh app code
    "notifications" : [ // push message parameters
      {
        "content": "Current Date: {{ MyDate | timezone: MyTimezone | date: \"%Y-%m-%d %H:%M\" }}",
        "template_bindings": { // optional. When no template_bindings are passed in a request, Tag values from the device are used.
         "MyDate" : "2019-07-23 15:00",
         "MyTimezone" : "Asia/Dubai"
        }
      }
    ]
  }
}

Выходные данные

Связанный контент

Связанный контент — это функция в шаблонах Liquid, которая позволяет динамически извлекать и использовать данные из внешнего источника, например, веб-сервиса, непосредственно в ваших email-сообщениях или push-уведомлениях. Эта функция обеспечивает персонализацию в реальном времени, извлекая JSON-данные по указанному URL и сохраняя их в переменную, которую можно использовать в вашем контенте.

Ключевые сценарии использования

• Рекомендации продуктов: Отображение персонализированных списков продуктов, адаптированных для каждого пользователя.

• Промокоды: Вставка уникальных промокодов, сгенерированных бэкенд-сервисом.

Предварительные требования

• Для использования связанного контента у вас должен быть собственный бэкенд-сервис, который генерирует и предоставляет необходимые данные (например, промокоды, рекомендации продуктов) на основе User ID, HWID или пользовательских тегов. Pushwoosh затем извлекает эти данные перед отправкой сообщения.

Пошаговое руководство по внедрению

Шаг 1. Настройте бэкенд-сервис

Бэкенд-сервис должен:

• Принимать запрос, содержащий параметры, специфичные для пользователя (например, userId). Связанный контент поддерживает UserID, HWID или любые пользовательские теги, которые вы настроили в своем проекте.
• Возвращать JSON-ответ с необходимыми данными. Этот контент затем можно динамически вставлять в сообщения.

Как это работает

Бэкенд-сервис выступает в качестве поставщика данных, отвечая на HTTP-запросы с информацией, специфичной для пользователя.

1. Pushwoosh отправляет запрос на ваш бэкенд, передавая идентификаторы пользователя в качестве параметров запроса.
2. Ваш бэкенд обрабатывает запрос и извлекает запрошенные данные.
3. Ваш бэкенд возвращает JSON-ответ.
4. Перед отправкой сообщения Pushwoosh извлекает JSON-ответ от бэкенд-сервиса и динамически использует возвращенные значения (например, code) в содержимом сообщения.

Пример ответа

{ "code": "SPECIALOFFERFORUSER12345" }

Шаг 2. Создайте пресет со связанным контентом в Pushwoosh

1. В редакторе push-уведомлений или редакторе email-сообщений вставьте синтаксис связанного контента в поле сообщения.

Пример

{% connected_content http://your-backend-url.com?userId={{ ${userid} }} :save result %}

Разбор синтаксиса

connected_content	Извлекает JSON-данные с указанного URL бэкенда.
http://your-backend-url.com	Эндпоинт бэкенда, который возвращает необходимые данные в формате JSON.
userId={{ ${userid} }}	Динамический параметр запроса, который передает ID пользователя на бэкенд.
:save result	Сохраняет полученный JSON-ответ в переменной result для использования в шаблонах Liquid

Аутентификация (необязательно)

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

{% connected_content http://your-backend-url.com?userId={{ ${userid} }}&auth=YOUR_API_KEY :save result %}

Использование тегов в связанном контенте

Чтобы включить пользовательские теги, вставьте их в качестве параметров запроса в запрос связанного контента ({{ tag_name }}).

{% connected_content http://your-backend-url.com?userId={{ ${userid} }}{{ Language }} :save result %}

2. Далее добавьте текст сообщения, включающий полученные данные, например так:

Hey, {{userid}}, grab your personal promo code - {{result.code}}

3. После завершения работы с содержимым сообщения и настройки параметров пресета сохраните его для повторного использования в кампаниях.

Шаг 3. Отправьте сообщение, используя настроенный пресет

Отправьте сообщение с этим пресетом, используя форму разового push-уведомления, форму email-сообщения или Customer Journey.

Важно

Если сервис возвращает статус, отличный от HTTP 200 OK, email или push-уведомление не будет отправлено. Это гарантирует, что ваше сообщение будет отправлено только в том случае, если необходимые данные будут успешно получены.