Datové feedy

This post is also available in:

Pro správně fungující analýzu dat a chytrou personalizaci potřebuje Samba tyto datové zdroje:

• produktový feed
• zákaznický feed
• objednávkový feed
• feed kategorií – nepovinný

V případě, že váš e-shop byl vytvořen jednou z aktuálně podporovaných platforem, nemusíte vytváření feedů vůbec dále řešit a stačí postupovat dle návodu integrace pro příslušnou platformu. Pokud využíváte jinou platformu, nezoufejte, Samba pracuje na integraci dalších nejpoužívanějších platforem. Do té doby využijte integraci vlastního e-shopu podle specifikace v následujícím textu.

Odkazy (veřejně přístupné, případně obsahující přístupové údaje ve formátu https://username:password@vaseshop.cz/adresafeedu.xml) na tyto feedy následně uvedete v sekci Nastavení – Integrace – Datová integrace – Nastavení připojení v Sambě.

Pro uložení změn stiskněte Uložit konfiguraci.

Jakmile máte všechny údaje vyplněné, stiskněte Zkontrolovat. Samba ihned stáhne feedy dle vašeho nastavení. Obvykle do několika minut uvidíte také výstup z naší kontroly, abyste mohli nedostatky opravit.
Datové feedy se standardně aktualizují 1x denně.

Obecně vyžadujeme od všech feedů:

• formát XML 
• kódování UTF-8LE,
• nepoužívání unicode řídících znaků (kromě CR a LF).

Produktový feed

Produktový feed obsahuje veškerou databázi produktů, které kdy byly na vašem e-shopu prodávány. Pro plnou funkčnost systému  doporučujeme poskytnout co nejvíce nepovinných parametrů. Díky tomuto feedu rozpoznáme vlastnosti produktů (typ produktu, značka, kategorie, cenová kategorie) a můžeme dynamicky vybírat ty správné produkty pro vaše zákazníky. Dále zjistíme, které produkty můžeme propagovat (díky informaci o naskladnění), můžeme zvýrazňovat zlevněné produkty a dále optimalizovat predikce vzhledem k očekávanému přínosu.

Podporované parametry produktu

Podporovány jsou tyto elementy:

Každý produkt může mít neomezené množství různých variant, tj. stejných produktů s některými odlišnými parametry např. barvou nebo velikostí. Tyto varianty jsou seskupené do jednoho rodičovského produktu, tzv. master produkt. Toto označení zaručí, že se zákazníkovi nebudou doporučovat v jednom reklamním sdělení např. různé varianty téhož produktu.

• Produkt uvedený jako master je typicky jednou z variant, nebo se může jednat o tzv. rozcestník k variantám (dle implementace vašeho eshopu)
• Kritérium výběru
  • Master produkt musí splňovat:
    • PRICE > 0
    • STOCK > 0
    • existuje IMAGE
    • existuje URL
  • Jako master produkt se automaticky zpracovává produkt s PRODUCT_ID, který není zanořený v tagu VARIANT.
    • Jestliže takový produkt ale nesplňuje výše zmíněná kritéria, je automaticky jako master produkt vybrána první varianta, která dané kritérium splňuje.
    • Jestliže žádná varianta kritéria nesplňuje, vybere se jako master produkt ten původně určený, tj. produkt nezanořený v tagu VARIANT.

Příklad produktového feedu

<?xml version="1.0" encoding="utf-8"?>
<PRODUCTS>
           <PRODUCT>
                     <PRODUCT_ID>D45S8741545SD</PRODUCT_ID>
                     <BRAND>Značka</BRAND>
                     <TITLE>Název produktu</TITLE>
                     <DESCRIPTION>Detailní popis produktu</DESCRIPTION>
                     <PRICE>40.1</PRICE>
                     <PRICE_BEFORE_DISCOUNT>42.1</PRICE_BEFORE_DISCOUNT>
                     <STOCK>60</STOCK>
                     <URL>http://www.mujeshop.cz/cesta/k/produktu</URL>
                     <IMAGE>http://www.mujeshop.cz/cesta/k/obrazku.jpg</IMAGE>
                     <CATEGORYTEXT>Oblečení | Dámské | Kalhoty</CATEGORYTEXT>
                     <PARAMETERS>
                               <PARAMETER>
                                         <NAME>Barva</NAME>
                                         <VALUE>Bílá</VALUE>
                               </PARAMETER>
                     </PARAMETERS>
                     <VARIANT>
                              <PRODUCT_ID>D45S8741545SD-XXL</PRODUCT_ID>
                              <TITLE>Název produktu</TITLE>
                               <DESCRIPTION>Detailní popis produktu</DESCRIPTION>
                               <PARAMETERS>
                                         <PARAMETER>
                                                   <NAME>Velikost</NAME>
                                                   <VALUE>XXL</VALUE>
                                         </PARAMETER>
                                         <PARAMETER>
                                                   <NAME>EAN</NAME>
                                                   <VALUE>467891186861118</VALUE>
                                         </PARAMETER>
                               </PARAMETERS>
                               <PRICE>40.1</PRICE>
                               <STOCK>10</STOCK>
                               <IMAGE>http://www.mujeshop.cz/cesta/k/produktuXXL.jpg</IMAGE>
                               <URL>http://www.mujeshop.cz/cesta/k/produktu?variant=xxl</URL>
                     </VARIANT>
                     <VARIANT>
                              <PRODUCT_ID>D45S8741545SD-L</PRODUCT_ID>
                              <TITLE>Název produktu</TITLE>
                               <DESCRIPTION>Detailní popis produktu</DESCRIPTION>
                               <PARAMETERS>
                                         <PARAMETER>
                                                   <NAME>Velikost</NAME>
                                                   <VALUE>L</VALUE>
                                         </PARAMETER>
                                         <PARAMETER>
                                                   <NAME>EAN</NAME>
                                                   <VALUE>467891186861118</VALUE>
                                         </PARAMETER>
                               </PARAMETERS>
                               <PRICE>40.1</PRICE>
                               <STOCK>10</STOCK>
                               <IMAGE>http://www.mujeshop.cz/cesta/k/produktuL.jpg</IMAGE>
                               <URL>http://www.mujeshop.cz/cesta/k/produktu?variant=l</URL>
                     </VARIANT>
           </PRODUCT>
 </PRODUCTS>

Zákaznický feed

Zákaznický feed by měl obsahovat celou databázi vašich zákazníků. Díky tomu Samba může přizpůsobit personalizaci na základě dalších metaparametrů jako je pohlaví nebo doba od registrace.

Samba podporuje 3 úrovně přihlášení k odběru newsletteru:

• every day – odběr denních novinek,
• special occasions –  odběr speciálních akcí, např. týdenní, měsíční,
• never –  uživatel je odhlášen od newsletterů.

Podporované parametry zákazníka

Název tagu	Typ	Povinný	Popis
CUSTOMER_ID	String	ano	zákaznické ID
NEWSLETTER_FREQUENCY	Enum: every day | special occasions | never	ano	informace o odběru newsletteru (never = odhlášen)
NLF_TIME	Datetime (as string)	ne	datetime ve formátu YYYY-MM-DDThh:mm:ss.sTZD (více informací) Čas změny stupně přihlášení
EMAIL	String	ne	validní emailová adresa. Jedná se o povinný prvek v případě, že na zákazníka budete odesílat newslettery.
REGISTRATION	Datetime (as string)	ne	datetime registrace zákazníka ve formátu YYYY-MM-DDThh:mm:ss.sTZD (více informací), výchozí hodnota: "1. 1. 1970"
FIRST_NAME	String	ne	křestní jméno
LAST_NAME	String	ne	příjmení
ZIP_CODE	String	ne	PSČ
PHONE	String	ne	telefonní číslo ve formátu odpovídajícím International Telecommunication Union. Mělo by obsahovat symbol plus ("+") jako mezinárodní předponu, kód státu a samotné číslo, například"+420777123456" pro Českou Republiku
SMS_FREQUENCY	Enum: every day | special occasions | never	ne	informace o odběru novinek formou SMS (never = odhlášen), výchozí hodnota: "never"
DATA_PERMISSION	Enum: full | do_not_personalize | anonymized_only	ne	výchozí hodnota: "full"
PARAMETERS	[par1,par2]	ne	další parametry zákazníka,NAME nemusí být unikátní, vizte příklad

V případě vícenásobného výskytu parametru se stejným NAME, jsou zpracovány všechny příslušné VALUE. V rámci filtrování tedy lze prohledávat mezi všemi hodnotami. Při použití v šabloně pomocí vkládání dynamické proměnné se použije náhodně jedna z hodnot.

Příklad zákaznického feedu

<?xml version="1.0" encoding="utf-8"?>
<CUSTOMERS>
           <CUSTOMER>
                     <CUSTOMER_ID>D45S8741545SD</CUSTOMER_ID>
                     <EMAIL>jan.novak@email.cz</EMAIL>
                     <REGISTRATION>2014-12-31T03:53:43.962Z</REGISTRATION>
                     <FIRST_NAME>Jan</FIRST_NAME>
                     <LAST_NAME>Novák</LAST_NAME>
                     <NEWSLETTER_FREQUENCY>every day</NEWSLETTER_FREQUENCY>
                     <NLF_TIME>2014-12-31T03:56:43.962Z</NLF_TIME>
                     <ZIP_CODE>15000</ZIP_CODE>
                     <PARAMETERS>
                               <PARAMETER>
                                         <NAME>Bonusové body</NAME>
                                         <VALUE>100</VALUE>
                               </PARAMETER>
                               <PARAMETER>
                                         <NAME>Gender</NAME>
                                         <VALUE>female</VALUE>
                               </PARAMETER>
                     </PARAMETERS>
           </CUSTOMER>
 </CUSTOMERS>

Objednávkový feed

Objednávkový feed by měl ideálně obsahovat historii všech objednávek na vašem eshopu (doporučujeme historii za poslední 2 roky, ale můžete nahrát i celou historii případně v zápětí využít inkrementálního datového feedu – viz níže). Tento feed Sambě slouží k analýze nákupních vzorů vašich zákazníků, které poté dále aplikuje v personalizaci. Veškeré produkty v tomto feedu musí být obsaženy v produktovém feedu, jinak budou nevalidní objednávky systémem automaticky ignorovány.

Samba podporuje 3 stavy objednávek:

• finished – dokončená objednávka, kdy zákazník zaplatil nebo převzal zboží. Pouze tyto objednávky jsou aktuálně systémem Samba zpracovávány,
• created – právě vytvořená objednávka čekající na dokončení (provedení platby, doručení atd.),
• canceled – zrušená nebo smazaná objednávka ze strany zákazníka nebo e-shopu.

Při volbě zpracování kompletního objednávkového feedu platí následující: Pokud je vašim zákazníkům umožněno vytvářet objednávky bez registrace, vkládejte do tohoto feedu namísto CUSTOMER_ID element EMAILa pokud máte k dispozici, doplňte i PHONE a ZIP_CODE. Samba z těchto údajů vytvoří zákazníky, na které budete moci ve svých kampaních cílit.

Detailně: Pokud je uvedené u objednávky neznámé CUSTOMER_ID (nebo není uvedeno vůbec) a přitom v zákaznickém feedu existuje zákazník s daným EMAIL, je tato objednávka automaticky přiřazena zákazníkovi s tímto EMAILze zákaznického feedu. Pokud ale neexistuje ani EMAIL v zákaznickém feedu, tak bude hodnota v EMAIL dočasně použita jako nové zákaznické ID, aby mohla být objednávka zpracována. Objednávky bez uvedeného EMAIL i CUSTOMER_ID nebudou zpracovány.

Podle znění vašich obchodních podmínek vyberte volbu v nastavení připojení (u Datové integrace) pro takto vytvořené zákazníky:

Podporované parametry objednávky

Název tagu	Typ	Povinný	Popis
ORDER_ID	String	ano	ID objednávky
CUSTOMER_ID	String	ne	ID zákazníka
CREATED_ON	Datetime (as String)	ano	datetime vytvoření objednávky ve formátu YYYY-MM-DDThh:mm:ss.sTZD (více informací).
ITEMS		ano	produkty v objednávce
FINISHED_ON	Datetime (as String)	ne	datetime dokončení objednávky ve formátu YYYY-MM-DDThh:mm:ss.sTZD (více informací). Nepoužívejte nebo ponechte prázdné, pokud dosud nebyla objednávka dokončena.
STATUS	String	ne	stav objednávky. Povolené hodnoty: created, finished, canceled.
EMAIL	String	ne	validní emailová adresa
PHONE	String	ne	telefonní číslo ve formátu odpovídajícím International Telecommunication Union. Mělo by obsahovat symbol plus ("+") jako mezinárodní předponu, kód státu a samotné číslo, například"+420777123456" pro Českou Republiku
ZIP_CODE	String	ne	PSČ adresy doručení
COUNTRY_CODE	String	ne	Mezinárodní identifikace země adresy doručení dle ISO 3166-1 alpha-2, např. "CZ"

ITEMS – položky objednávky

Každá objednávka musí obsahovat všechny produkty z dané zakázky. Cena produktu zde určuje prodejní cenu, kterou zákazník zaplatil (bez dopravného a balného, včetně DPH).

Název tagu	Typ	Povinný	Popis
PRODUCT_ID	String	ano	ID produktu nebo produktové varianty
AMOUNT	Number (integer, >0)	ne	počet kusů objednaného produktu (default: 1)
PRICE	Number (>=0)	ne	sumární cena všech kusů daného produktu včetně DPH.

Příklad objednávkového feedu

<?xml version="1.0" encoding="utf-8"?>
<ORDERS>
       <ORDER>
             <ORDER_ID>5ds465d</ORDER_ID>
             <CUSTOMER_ID>d4s5a6sd6as</CUSTOMER_ID>
             <CREATED_ON>2014-12-31T03:53:43.962Z</CREATED_ON>
             <FINISHED_ON>2015-01-05T03:53:43.962Z</FINISHED_ON>
             <STATUS>finished</STATUS>
             <ZIP_CODE>15500</ZIP_CODE>
             <COUNTRY_CODE>CZ</COUNTRY_CODE>
             <ITEMS>
                    <ITEM>
                          <PRODUCT_ID>DAS656</PRODUCT_ID>
                          <AMOUNT>6</AMOUNT>
                          <PRICE>36</PRICE>
                    </ITEM>
              </ITEMS>
        </ORDER>
        <ORDER>
             <ORDER_ID>35DS45</ORDER_ID>
             <EMAIL>jan.novak@email.cz</EMAIL>
             <CREATED_ON>2014-12-31T03:53:43.962Z</CREATED_ON>
             <FINISHED_ON>2015-01-05T03:53:43.962Z</FINISHED_ON>
             <STATUS>finished</STATUS>
             <ZIP_CODE>15500</ZIP_CODE>
             <COUNTRY_CODE>CZ</COUNTRY_CODE>
             <ITEMS>
                    <ITEM>
                          <PRODUCT_ID>DAS656</PRODUCT_ID>
                          <AMOUNT>6</AMOUNT>
                          <PRICE>36</PRICE>
                    </ITEM>
              </ITEMS>
         </ORDER>

 </ORDERS>

Inkrementální objednávkový feed

Samba podporuje tzv. inkrementální datový feed, to znamená, že tento feed obsahuje jen ty objednávky, u kterých došlo za poslední dobu k nějaké změně. Díky tomu snížíte zátěž serverů, kdy postačí jen pro prvotní update nagenerovat kompletní historii a každý další den už jen zmíněný inkrement.

Postup

1. Iniciální import historie
   1. Nastavte objednávkový feed na typ Kompletní.
   2. Vložte URL adresu kompletního feedu.
   3. Proveďte datový update v Sambě.
2. Inkrementální zpracování
   1. Nastavte objednávkový feed na typ Inkrementální.
   2. Vložte URL adresu inkrementálního feedu.
   3. Proveďte datový update v Sambě.

Celý proces funguje tak, že jakmile přepnete typ na Inkrementální, tak Samba automaticky udržuje dosud nasbíranou historii objednávek a každý nový inkrement do této historie agreguje metodou upsert. Dokud nepřepnete nastavení zpět na typ Kompletní, tak Samba drží tuto akumulovanou historii ve své databázi.

Typ inkrementu

Samba podle způsobu dynamizace URL rozslišuje tyto typy inkrementů:

• Statická URL
  • Použijte v případě, kdy na jedné určité a neměnné URL adrese generujete vždy všechny objednávky, u kterých za nějaké vybrané období (délka období je na vás, typicky 7 dní) došlo ke změně.
  • Např. https://samba.ai/export/orders/orders_increment.xml
• Specifické datum
  • Použijte v případě, kdy periodicky generujete nový soubor pro určitou časovou periodu – například každý den generujete nový denní inkrement.
  • Např. https://samba.ai/export/orders/orders_increment_{date}.xml
• Datum Od – Do
  • Použijte v případě, kdy máte na své straně připravenou službu vracet exporty objednávek podle atributů from/to.
  • Samba automaticky volí from jako datum posledního úspěšného běhu, to se volí jako „dnes“. Při dalším běhu tak dochází k opětovnému přenačtení hraničních dat, která mohla být v době zpracování ještě nekompletní.
  • Např. https://samba.ai/export/orders/orders_increment_{from}_{to}.xml

Pomocí volby „Nejnovější inkrement dostupný X dní zpět“ můžete nastavit, aby Samba např. stahovala inkrement s 1 denním zpožděním (např. dne 17.3.2021 bude Samba stahovat nanejvýš inkrement s datem 16.3.2021 a ne novější). Tím lze předejít tomu, aby celý datový update selhával kvůli nedostupnosti dat na vaší straně.

Doporučujeme nastavit logiku takovou, aby se v inkrementu objevily všechny objednávky, u kterých došlo v dané období k nějaké změně. Pokud nastavíte logiku jen na datu vytvoření objednávky, tak mohou chybět v Sambě informace o stornovaných objednávkách a vratkách.

Informace ke zpracování

Zpracovány a akumulovány do historie jsou jen ty objednávky z inkrementu, které jsou v danou chvíli validní – jsou správně všechny povinné atributy. Samba pak pro daný datový update vyčte jen ty objednávky, které jsou plně určené z hlediska existence zákazníka v zákaznickém feedu a existence produktu v produktovém feedu.

Zákazník v objednávce

Pokud je uvedené u objednávky neznámé CUSTOMER_ID (nebo není uvedeno vůbec) a přitom v zákaznickém feedu existuje zákazník s daným EMAIL, je tato objednávka automaticky přiřazena zákazníkovi s tímto EMAILze zákaznického feedu.

Pokud ale neexistuje ani dané EMAIL v zákaznickém feedu, tak bude hodnota v EMAIL dočasně použita pro nagenerování virtuálního zákazníka s ID rovno hodnotě EMAIL a tato objednávka je zahrnuta do akumulované databáze. Zpracována je však jen po dobu, kdy je objednávka součástí inkrementu. Kdykoli později již není zákazník generován a ani objednávka proto není zpracována, dokud se v zákaznickém feedu neobjeví zákazník s CUSTOMER_ID  rovným EMAILa tím může být objednávka z akumulované historie opět zpracována.

Jestliže někdy v průběhu času zmizí zákazník CUSTOMER_ID uvedený u objednávky, která prošla inkrementálním zpracování a byla uloženo do akumulované databáze, nebude v Sambě zpracován a vyčten dokud se opět v zákaznickém feedu zmíněné CUSTOMER_ID neobjeví.

Objednávky bez uvedeného EMAILi CUSTOMER_ID nebudou zpracovány.

Produkt v objednávce

Při využití inkrementů lze obecně říci, že (analogicky jako výše pro zákazníka v objednávce) se zpracují pouze ty produktové položky, které obsahují produkty uvedené v produktovém datovém feedu. V případě inkrementálního datového feedu funguje si předveďme fungování na následujícím příkladě:

• Předpokládejme, že proběhlo jednorázové načtení kompletních dat v rámci datového feedu a nyní jsou v rámci stejného účtu využívány jednodenní inkrementy.
• V rámci příkladu je v objednávkovém inkrementu obsažena objednávka „Obj1“ z 1. 1., která obsahuje produkt „Prod1“.

1. Nejprve se 1. 1. stáhne inkrement objednávkového feedu, který obsahuje objednávku „Obj1“ a zároveň je v produktovém feedu ve stejný den obsažen produkt „Prod1“. Objednávka se v takovém případ zpracuje.
2. Den poté (tedy 2. 1.) se již objednávka „Obj1“ v inkrementu nenachází a produkt „Prod1“ se nenachází ani v produktovém datovém feedu. Objednávka se v takovém případě nezpracuje, ale bude stále uložena v akumulované historii objednávek.
3. Následující den (tedy 3. 1.) se objednávka „Obj1“ v inkrementu nadále nenachází, ale produkt „Prod1“ se objevil v produktovém datovém feedu. Objednávka se v tomto případě znovu zpracuje.

Rozhodující tedy pro Sambu je, zda se produkt nachází v produktovém datovém feedu v okamžik posledního zpracování objednávky z inkrementu – v takovém případě totiž dochází k jejímu správnému uložení do akumulované historie objednávek. Následující dny se pak v Sambě objednávka zpracuje v případě, že se daný produkt aktuálně v produktovém datovém feedu nachází.

Feed kategorií

Feed kategorií by měl obsahovat strom kategorií produktů použitých v produktovém feedu. TITLE musí být konzistentní s názvy kategorií CATEGORYTEXT v produktovém feedu. Tento feed je nezbytný, pokud chcete, aby Samba zpracovávala také návštěvy samotných kategorií a bylo možné upravovat jejich personalizaci.

Podporované parametry kategorií

Příklad feedu kategorií

<?xml version="1.0" encoding="utf-8"?>
<CATEGORY>
     <ITEM>
          <TITLE>Nadkategorie</Title>
          <URL>http://www.mujeshop.cz/cesta/k/nadkategorii</URL>
          <ITEM>
               <TITLE>Podkategorie</Title>
               <URL>http://www.mujeshop.cz/cesta/k/podkategorii</URL>
          </ITEM>
     </ITEM>
     <ITEM>
          <TITLE>Nadkategorie A</Title>
          <URL>http://www.mujeshop.cz/cesta/k/nadkategoriia</URL>
          <ITEM>
               <TITLE>Podkategorie A</Title>
               <URL>http://www.mujeshop.cz/cesta/k/podkategoriia</URL>
               <ITEM>
                    <TITLE>Podkategorie B</Title>
                    <URL>http://www.mujeshop.cz/cesta/k/podkategoriib</URL>
               </ITEM>
          </ITEM>
     </ITEM>
</CATEGORY>

Zaokrouhlování cen

Do newsletteru se propisují ceny uvedené v produktovém feedu. Pokud ale máte některé ceny nastaveny na hodnoty typu 419,72 Kč, je možné Sambě říci, aby takovouto cenu zaokrouhlila na vámi požadovaný počet desetinných míst.

Toto nastavení naleznete v sekci Nastavení – Integrace – Datová integrace – Nastavení připojení, kde si zvolíte zda-li a na kolik desetinných míst chcete ceny zaokrouhlovat.

Například toto nastavení by zaokrouhlovalo ceny na celá čísla. Cena 419,72 Kč by se tedy zaokrouhlila na hodnotu 420 Kč.

This post is also available in: