Přiřazení tagů k odběrateli

Avatar

Podle Petr Hebký

aktualizováno před 5 měsíci

Tagy („značky“) jsou jednou z nejdůležitějších funkcí aplikace Vilf.io. Pomocí tagů můžete:

  •  Posílat návštěvníkům personalizované zprávy na základě jejich chování – např. je upozornit na opuštěný košík, poslat jim slevu na specifický produkt nebo článek z oblasti, která je zajímá. 
  • Tvořit složitější segmenty uživatelů pro lepší cílení notifikací – např. vyfiltrovat uživatele, kteří poslední měsíc v e-shopu nic nekoupili a mají zájem o dámské oblečení.
  • Personalizovat obsah samotných notifikací – např. místo univerzálního oslovení „přejeme krásný den“ použít osobnější „přejeme krásný den, Petro“. Do textu zprávy můžete např. vložit i název zboží, které uživatel zapomněl v košíku.


Tagy můžete přiřazovat ke kontaktům, u kterých jste získali souhlas se zasíláním notifikací. Jeden web může využívat maximálně 30 tagů.

Pro vývojáře jsme vytvořili vlastní dokumentaci pro JS API a REST API.

 

1) Tagování pomocí JS API

1a) Inicializace JS API

Před přiřazením prvního tagu je potřeba inicializovat rozhraní JS API aplikace Vilf.io. Inicializace se provádí příkazem VilfIo.setUp s parametrem id aplikace.

ID aplikace (1) naleznete na uvítací stránce Vilf.io (2).


Kód pro inicializaci Javascript API:

1
2
3
4
5
6
7
8
9
10
11
12
13
14


<script type="text/javascript" src="https://vilf.io/api/api.js" async></script>
<script type="application/javascript">
    var VilfIo = window.VilfIo || [];
    VilfIo.push(()=>{
        VilfIo.setUp(APP_ID).then(()=>{
            // Zde můžete začít používat vilf.io
            // VilfIo.setTags([{...}]);
        });
    });
    VilfIo.push(()=>{
        // Nebo zde můžete začít používat vilf.io
        // VilfIo.setTags([{...}]);
    });
</script>





Kód pro inicializaci je součástí všech ukázek níže. Doporučujeme jej v kódu vždy ponechat.

1b) Přiřazení tagu

Tagy (značky) se k uživatelům přiřazují pomocí příkazu setTags (1) na základě určité události, např. při návštěvě určité stránky nebo kliknutí na tlačítko. Parametrem tohoto příkazu je tzv. pole objektů, přes které se přiřazuje tag (2) s určitou hodnotou (value ) (3).

Název tagu zpravidla popisuje událost, při jaké se značka k uživateli přiřadí. V příkladu níže se k uživateli při načtení stránky přiřadí tag s názvem „name“ a hodnotou (value) „Tomáš“ (3).

Příkazem setTags můžete také nastavit datum expirace určitého tagu. Namísto hodnoty (value) se použije příkaz expire s termínem, kdy se tag u uživatele smaže (4).

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17


<script type="text/javascript" src="https://vilf.io/api/api.js" async></script>
<script type="application/javascript">
    var VilfIo = window.VilfIo || [];
    VilfIo.push(()=>{
        VilfIo.setUp(APP_ID).then(()=>{
            VilfIo.setTags([ // 1
                {
                    "tag": "name", // 2
                    "value": "Tomáš", // 3
                },{
                    "tag": "registred",
                    "expire": "2019-10-7T8:36:50+0200", // 4
                }
            ]);
        });
    });
</script>





1c) Smazání tagu

Smazání tagů, přiřazených k určitému uživateli, můžete podmínit určitou událostí – např. po načtení stránky jako v příkladu níže. 

Ke smazání značek slouží příkaz removeTags (1). Parametrem tohoto příkazu je tzv. pole řetězců, ve které jsou tagy určené ke smazání (2). Konkrétně v příkladu níže se po načtení stránky (spuštění příkazu pro smazání tagů) smažou tagy „name“ a „registered“ – včetně všech hodnot (value), které k nim byly přiřazené.

1
2
3
4
5
6
7
8
9


<script type="text/javascript" src="https://vilf.io/api/api.js" async></script>
<script type="application/javascript">
    var VilfIo = window.VilfIo || [];
    VilfIo.push(()=>{
        VilfIo.setUp(APP_ID).then(()=>{
            VilfIo.removeTags(["name", "registred"]);
        }); //                    1         2
    });
</script>





2) Tagování pomocí REST API

Pro tagování pomocí REST API je potřeba nejdříve autorizovat API token a poté v Javascriptu získat id odběratele a uložit jej na svůj server. Teprve poté je možné využívat tagování skrze REST API.

Upozornění – REST API je určené pro komunikaci mezi servery.

2a) Inicializace REST API

REST API se inicializuje přístupovým tokenem, který najdete v administraci aplikaci. V menu klikněte na „nastavení webu“ (1) a poté na „nastavení API“ (2). Přístupový token zkopírujte z formulářového pole (3).

Pokud potřebujete vytvořit nový token, klikněte na tlačítko „vygenerovat nový klíč“ (4).


Autorizaci tokenu zajišťuje autorizační parametr v hlavičce HTTP dotazu prostřednictvím Authorization: Bearer .

2b) Získání id odběratele

Pro získání id odběratele můžete buď použít metodu loadSubscriberId, která vrátí id odběratele. Pokud uživatel není odběratel, vrátí metoda hodnotu null.

Popř. je možné využít metodu setOnSubscribe, která se zavolá při odběru s parametrem id odběratele.

1
2
3
4
5
6
7
8
9
10
11
12


<script type="text/javascript" src="https://vilf.io/api/api.js" async></script>
<script type="application/javascript">
    var VilfIo = window.VilfIo || [];
    VilfIo.push(()=>{
        VilfIo.setUp(APP_ID);
        VilfIo.setOnSubscribe(onSubscriber)
    });

    const onSubscriber=(subscribeId)=>{
        // Uložte subscribeId na váš server
    }
</script>




2c) Práce s tagy v REST API

URL pro práci s tagy je https://vilf.io/rest-api/subscriber/</id>/tags, kde hodnota id značí id odběratele.

End-point autorizačního parametru používá tři metody:

  • GET pro vypsání tagů u uživatele, 
  • POST pro přiřazení tagů 
  • DELETE pro odebrání tagů. 

Detailní popis jednotlivých end-pointů najdete zde.

Odpovědělo to na vaši otázku?