Usando templates Liquid

Os templates Liquid expandem significativamente as capacidades de personalização da Pushwoosh, implementando uma lógica sofisticada além do uso regular do Conteúdo Dinâmico.

A personalização de mensagens na Pushwoosh é baseada em Tags (dados do usuário). A Pushwoosh oferece uma variedade de Tags padrão e Tags personalizadas. Usando-as, você pode especificar o primeiro nome do usuário, cidade, histórico de compras, etc., para enviar uma mensagem mais personalizada, por exemplo: Olá {Primeiro_nome}, obrigado por pedir {item}.

Os templates Liquid adicionam mais lógica ao conteúdo dinâmico. Por exemplo, se a tag de assinatura de um usuário contiver “gratuito”, você pode enviar a ele uma mensagem: “Aproveite seu desconto de 10%.”

Modificar o conteúdo da mensagem de acordo com os IDs, comportamentos e preferências dos usuários é a maneira mais eficiente de aumentar a relevância e obter resultados mais impressionantes de suas campanhas de marketing.

Sintaxe

Os templates de conteúdo baseados no Liquid da Shopify usam uma combinação de tags, objetos e filtros para carregar conteúdo dinâmico. Os templates de conteúdo permitem que você acesse certas variáveis de dentro de um template e exiba seus dados sem precisar saber nada sobre os dados em si.

Nota

Para saber mais sobre a sintaxe, consulte a documentação do Liquid.

Objetos

objetos definem o conteúdo que será exibido para um usuário. objetos devem ser colocados entre chaves duplas: {{ }}

Por exemplo, ao personalizar uma mensagem, envie {{Name}} em seu corpo para adicionar os nomes dos usuários ao conteúdo da mensagem. O nome do usuário (valor da tag Name) substituirá o objeto Liquid em uma mensagem que o usuário verá.

Entrada

Olá {{Name}}! Que bom que você voltou!

Saída

Olá Anna! Que bom que você voltou!

Tags

tags criam a lógica e o fluxo de controle para os templates. Os delimitadores de chave e porcentagem {% e %} e o texto que eles envolvem não produzem nenhuma saída visível quando o template é renderizado. Isso permite que você atribua variáveis e crie condições ou laços sem mostrar nenhuma lógica do Liquid para o usuário.

Por exemplo, usando a tag if, você pode variar o idioma da mensagem com base no idioma definido no dispositivo do usuário:

Entrada

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

Saída (fr)

Salut!

Saída (es)

Hello!

Operadores de tags

Operador	Descrição
==	igual a
!=	não é igual a
>	maior que
<	menor que
>=	maior ou igual a
<=	menor ou igual a
or	ou lógico
and	e lógico
contains	verifica a presença de uma substring dentro de uma string ou array de strings

Nota

Em tags com mais de um operador and ou or, os operadores são verificados em ordem da direita para a esquerda. Você não pode alterar a ordem das operações usando parênteses — parênteses são caracteres inválidos no Liquid e impedirão que suas tags funcionem.

Filtros

filtros modificam a saída de um objeto ou variável Liquid. Eles são usados dentro de chaves duplas {{ }} e na atribuição de variáveis, e são separados por um caractere de pipe |. Vários filtros podem ser usados em uma única saída e são aplicados da esquerda para a direita.

Entrada

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

Saída

Hello Anna

Usando templates Liquid em mensagens enviadas via API

Use a sintaxe Liquid em suas solicitações createMessage para implementar os templates Liquid. Os templates estão disponíveis para o parâmetro “content” da solicitação createMessage, bem como para qualquer outro parâmetro que suporte Conteúdo Dinâmico, em particular, os parâmetros específicos da plataforma “title”, “subtitle” e “image”.

Ao usar templates de conteúdo, você pode especificar os dados em suas solicitações de API (passando o parâmetro “template_bindings”) ou obter os dados dos valores de Tag armazenados nos dispositivos dos usuários (não usando o parâmetro “template_bindings”). Dessa forma, você pode criar campanhas de push baseadas no usuário contendo conteúdo extremamente relevante.

Nota

Observe que, ao contrário do Conteúdo Dinâmico, as variáveis nos templates devem ser colocadas entre chaves duplas da seguinte forma: {{myVariable}}.

Para definir a lógica do template usando Tags com espaços em seus nomes, use a seguinte técnica:

Exemplo

{% capture my_tag %}{{My Tag}}{% endcapture %}
{% if my_tag == 'value' %}
Conteúdo a ser enviado neste caso
{% else %}
Conteúdo a ser enviado caso contrário
{% endif %}

Casos de uso de templates Liquid

Aqui você encontrará vários casos de uso em que os templates Liquid são úteis.

Push multi-idioma

Os templates Liquid permitem especificar definitivamente em que idioma os usuários devem receber suas mensagens de push. Veja o exemplo simples da solicitação de API e a mensagem recebida dependendo dos template bindings usados na solicitação.

Entrada Liquid

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

Solicitação de API

{
  "request": {
    "application": "XXXXX-XXXXX", // Código do aplicativo Pushwoosh
    "auth": "yxoPUlw.....IyEX4H", // Token de acesso à API do Painel de Controle Pushwoosh
    "notifications" : [ // parâmetros da mensagem de push
      {
       "content": "{% raw %}
{% if language == 'es' %}¡Hola!{% else %}hello!{% endif %}
{% endraw %}",
        "template_bindings": { // opcional. Quando nenhum template_bindings é passado em uma solicitação, os valores de Tag do dispositivo são usados.
         "language" : "es"
        }
      }
    ]
  }
}

Saída

Idioma é ‘es’: ¡Hola!

Idioma é ‘en’: Hello!

Aviso para upgrade de assinatura

Incentive seus clientes a fazerem upgrade de sua assinatura com base em seu plano atual.

Entrada Liquid

{% if Subscription == 'Basic' %}
    Faça upgrade para o Silver para obter mais recursos do produto e suporte 24/7.
{% elsif Subscription == 'Silver' %}
    Faça upgrade para o Gold para suporte prioritário e recursos avançados.
{% else %}
    Entre em contato com seu gerente para renovar sua assinatura.
{% endif %}

Solicitação de API

{
  "request": {
    "application": "XXXXX-XXXXX", // Código do aplicativo Pushwoosh
    "auth": "yxoPUlw.....IyEX4H", // Token de acesso à API do Painel de Controle Pushwoosh
    "notifications" : [ // parâmetros da mensagem de push
      {
       "content": "{% raw %}
{% if Subscription == 'Basic' %}Faça upgrade para o Silver para obter mais recursos do produto e suporte 24/7.{% elsif Subscription == 'Silver' %}Faça upgrade para o Gold para suporte prioritário e recursos avançados.{% else %}Entre em contato com seu gerente para renovar sua assinatura. {% endif %}
{% endraw %}",
        "template_bindings": { // opcional. Quando nenhum template_bindings é passado em uma solicitação, os valores de Tag do dispositivo são usados.
         "language" : "es"
        }
      }
    ]
  }
}

Saída

Para usuários com plano de assinatura Básico: Faça upgrade para o Silver para obter mais recursos do produto e suporte 24/7.

Para usuários com plano de assinatura Silver: Faça upgrade para o Gold para suporte prioritário e recursos avançados.

Para usuários com outros planos: Entre em contato com seu gerente para renovar sua assinatura.

Tags de lista

Os templates de conteúdo são bastante úteis para lidar com Tags do tipo Lista.

Tamanho da variável

Um dos possíveis casos de uso é entregar conteúdo diferente dependendo do número de valores que a Tag contém. Por exemplo, você pode oferecer descontos diferentes para clientes com comportamentos diferentes. Digamos que o cliente tenha alguns itens em sua Lista de Desejos — incentive-o a comprar com o desconto mais adequado com base em quantos produtos ele vai comprar!

Entrada Liquid

{% if WishList.size >= 3 %}
Obtenha 20% de desconto na sua próxima compra!
{% elsif WishList.size == 2 %}
Obtenha 10% de desconto na sua próxima compra!
{% else %}
Ei, dê uma olhada nos novos agasalhos!
{% endif %}

Solicitação de API

{
  "request": {
    "application": "XXXXX-XXXXX", // Código do aplicativo Pushwoosh
    "auth": "yxoPUlw.....IyEX4H", // Token de acesso à API do Painel de Controle Pushwoosh
    "notifications" : [ // parâmetros da mensagem de push
      {
       "content": "{% raw %}
{% if WishList.size >= 3 %}Obtenha 20% de desconto na sua próxima compra!{% elsif WishList.size == 2 %}Obtenha 10% de desconto na sua próxima compra!{% else %}Ei, dê uma olhada nos novos agasalhos!{% endif %}
{% endraw %}",
        "template_bindings": {
         "WishList" : ["Skinny Low Ankle Jeans", "Linen Trenchcoat", "High Waisted Denim Skirt", "Strappy Tiered Maxi Dress"]
        }
      }
    ]
  }
}

Tamanho da WishList ≥ 3

Tamanho da WishList = 2

Variável contém

Outro caso que você pode precisar cobrir é lidar com os valores das Tags de Lista e entregar o conteúdo mais relevante com base nos valores que a Tag contém.

Entrada Liquid

{% if WishList contains 'Skinny Low Ankle Jeans' %}
Obtenha 20% de desconto nos produtos da sua lista de desejos!
{% else %}
Ei, dê uma olhada nos novíssimos Skinny Low Ankle Jeans!
{% endif %}

Solicitação de API

{
  "request": {
    "application": "C90C0-0E786",
    "auth": "yxoPUlw.....IyEX4H", // Token de acesso à API do Painel de Controle Pushwoosh
    "notifications" : [ // parâmetros da mensagem de push
      {
       "content": "{% raw %}
{% if WishList contains 'Skinny Low Ankle Jeans' %}Obtenha 20% de desconto na sua próxima compra!{% else %}Ei, dê uma olhada nos novíssimos Skinny Low Ankle Jeans!{% endif %}
{% endraw %}",
        "template_bindings": {
         "WishList" : ["Skinny Low Ankle Jeans", "Linen Trenchcoat", "High Waisted Denim Skirt", "Strappy Tiered Maxi Dress"]
        }
      }
    ]
  }
}

Variável contém dados

Variável não contém dados

Plurais

Ao usar os templates de conteúdo, você pode ajustar o conteúdo da mensagem de acordo com o comportamento dos usuários. Por exemplo, você pode modificar o texto da mensagem para conter palavras no plural caso a Tag de Lista contenha mais de um valor.

Entrada Liquid

    Obtenha 20% de desconto no item
{% if WishList.size > 1 %}
    s da sua Lista de Desejos!
{% else %}
    da sua Lista de Desejos!
{% endif %}

Solicitação de API

{
  "request": {
    "application": "C90C0-0E786",
    "auth": "yxoPUlw.....IyEX4H", // Token de acesso à API do Painel de Controle Pushwoosh
    "notifications" : [ // parâmetros da mensagem de push
      {
       "content": "Obtenha 20% de desconto no item{% raw %}
{% if WishList.size > 1 %}s da sua Lista de Desejos!{% else %} da sua Lista de Desejos!{% endif %}
{% endraw %}",
        "template_bindings": { // opcional. Quando nenhum template_bindings é passado em uma solicitação, os valores de Tag do dispositivo são usados.
         "WishList" : ["Skinny Low Ankle Jeans", "Linen Trenchcoat", "High Waisted Denim Skirt", "Strappy Tiered Maxi Dress"]
        }
      }
    ]
  }
}

Plural

Singular

Fuso horário

O template para fusos horários converte a data e a hora de acordo com o fuso horário especificado.

Entrada Liquid

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

Solicitação de API

Exemplo

{
  "request" : {
    "auth" : "3H9bk8w3.....Acge2RbupTB", // Token de acesso à API do Painel de Controle Pushwoosh
    "application" : "XXXXX-XXXXX", // Código do aplicativo Pushwoosh
    "notifications" : [ // parâmetros da mensagem de push
      {
        "content": "Data Atual: {{ MyDate | timezone: MyTimezone | date: \"%Y-%m-%d %H:%M\" }}",
        "template_bindings": { // opcional. Quando nenhum template_bindings é passado em uma solicitação, os valores de Tag do dispositivo são usados.
         "MyDate" : "2019-07-23 15:00",
         "MyTimezone" : "Asia/Dubai"
        }
      }
    ]
  }
}

Saída

Conteúdo conectado

Conteúdo conectado é um recurso nos templates Liquid que permite recuperar e usar dados dinamicamente de uma fonte externa, como um serviço web, diretamente em suas mensagens de e-mail ou notificação push. Esse recurso permite a personalização em tempo real, buscando dados JSON de uma URL especificada e salvando-os em uma variável que pode ser utilizada em seu conteúdo.

Principais casos de uso

• Recomendações de produtos: Exiba listas de produtos personalizadas para cada usuário.

• Códigos promocionais: Insira códigos promocionais exclusivos gerados por um serviço de backend.

Pré-requisitos

• Para usar o Conteúdo Conectado, você deve ter seu próprio serviço de backend que gera e fornece os dados necessários (por exemplo, códigos promocionais, recomendações de produtos) com base no User ID, HWID ou tags personalizadas. A Pushwoosh então busca esses dados antes de enviar uma mensagem.

Guia de implementação passo a passo

Passo 1. Configure o serviço de backend

O serviço de backend deve:

• Aceitar uma solicitação contendo parâmetros específicos do usuário (por exemplo, userId). O Conteúdo Conectado suporta UserID, HWID ou quaisquer tags personalizadas que você tenha configurado em seu projeto.
• Retornar uma resposta JSON com os dados necessários. Este conteúdo pode então ser inserido dinamicamente nas mensagens

Como funciona

O serviço de backend atua como um provedor de dados, respondendo a solicitações HTTP com informações específicas do usuário.

1. A Pushwoosh envia uma solicitação ao seu backend, passando identificadores específicos do usuário como parâmetros de consulta.
2. Seu backend processa a solicitação e recupera os dados solicitados.
3. Seu backend retorna uma resposta JSON.
4. Antes de enviar uma mensagem, a Pushwoosh busca a resposta JSON do serviço de backend e usa os valores retornados (por exemplo, o code) no conteúdo da mensagem dinamicamente.

Exemplo de resposta

{ "code": "SPECIALOFFERFORUSER12345" }

Passo 2. Crie um preset com Conteúdo Conectado na Pushwoosh

1. No editor de conteúdo de Push ou E-mail, insira a sintaxe de Conteúdo Conectado no campo da mensagem.

Exemplo

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

Detalhamento da sintaxe

connected_content	Busca dados JSON da URL de backend especificada.
http://your-backend-url.com	O endpoint de backend que retorna os dados necessários no formato JSON.
userId={{ ${userid} }}	Um parâmetro de consulta dinâmico que passa o ID do usuário para o backend.
:save result	Armazena a resposta JSON buscada na variável result para uso em templates Liquid

Autenticação (opcional)

Se o seu serviço de backend exigir autenticação, você pode incluir uma chave de API ou token na solicitação de Conteúdo Conectado para garantir o acesso seguro.

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

Usando tags no Conteúdo Conectado

Para incluir tags personalizadas, insira-as como parâmetros de consulta na solicitação de Conteúdo Conectado ({{ tag_name }}).

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

2. Em seguida, adicione o texto da mensagem incorporando os dados recuperados, assim:

Ei, {{userid}}, pegue seu código promocional pessoal - {{result.code}}

3. Após finalizar o conteúdo da mensagem e configurar as definições do preset, salve-o para reutilização em campanhas.

Passo 3. Envie uma mensagem usando o preset configurado

Envie uma mensagem com este preset usando o formulário de push único ou e-mail ou jornada do cliente.

Importante

Se o serviço retornar um status diferente de HTTP 200 OK, o e-mail ou a notificação push não será enviado. Isso garante que sua comunicação só seja enviada se os dados necessários forem recuperados com sucesso.