Dokumentácia - zástupcovia pre konverzné kódy
Základné informácie ku konverzným kódom nájdete v nápovede Konverzné kódy.
Dynamickí zástupcovia
Dokumentácia nových dynamických zástupcov pre konverzné kódy. Všetci dynamickí zástupcovia sú globálne javascriptové premenné. Je možné teda využiť akékoľvek funkcie z javascriptu.
Objekt upgates je javascriptový objekt, ktorý je globálne dostupný a vytvára sa v hlavičke stránky. Je teda možné k nemu pristúpiť z akéhokoľvek javascriptu. Či už je vložený do vlastných konverzných kódov alebo do editora kódu.
Pre zistenie aktuálnych údajov obsiahnutých v upgates je možné použiť funkciu console.log(upgates);.
Ako skontrolovať funkčnosť udalostí?
Napríklad, povedzme, že chcem skontrolovať, či je udalosť dostupná v DataLayer stránky po pridaní do košíka.
- V časti Doplnky / Vlastné konverzné kódy.
- Nájdite prvú časť Kód je umiestnený medzi značkami <head> a </head>.
- Vložte zapis:
<script>upgates.on('cart.add', function(product) {alert('xxx');});</script> - Uložte.
- Otvorte svoju stránku a pridajte produkt do košíka. Ak sa na vašej stránke vyskytne udalosť add_to_cart, prehliadač otvorí informačné okno a položka, ktorú ste uviedli, bude xxx.
Vysvetlenie:
- cart.add - udalosť vytvorená spoločnosťou Upgates. Môžete ju zmeniť na vlastnú uvedenú nižšie. cart.add nájdete napríklad priamo tu.
- xxx - Označuje text, ktorý sa zobrazí na stránke po jej spustení. V príklade sa teda napríklad zobrazí okno prehliadača s textom xxx. Môžete ho zmeniť na ľubovoľnú hodnotu, ale pri jeho písaní si dajte mimoriadny pozor a ponechajte zátvorky a úvodzovky na svojom mieste. V opačnom prípade skript nebude fungovať.
Dynamickí zástupcovia stránky
upgates.language- Jazyk aktuálnej stránky.upgates.currency- Mena aktuálnej stránky.upgates.pageType- Typ aktuálnej stránky. Možné hodnoty:advisor.detailadvisor.listarticlecategorycomparecustomer.communicationcustomer.favouritescustomer.orderscustomer.orders.detailcustomer.logincustomer.passwordcustomer.profilecustomer.ratingcustomer.reviewcustomer.registrationcustomer.watchdoghomepagemanufacturernews.detailnews.listnewsletterorder.cartorder.checkoutorder.recievedorder.shipmentorder.summarypageproductsearchsitemap
Dynamickí zástupcovia produktu
upgates.product- Informácie o produkte. Dostupné len na stránke detailu produktu. Inde jenull.upgates.product.id- ID produktu.upgates.product.code- Kód produktu.upgates.product.title- Názov produktu.upgates.product.manufacturer- Výrobca produktu.upgates.product.price.withVat- Cena (s DPH).upgates.product.price.withoutVat- Cena (bez DPH).upgates.product.price.vat- DPH (hodnota).upgates.product.price.vatRate- DPH (hodnota v percentách).upgates.product.options[]- Pole variantov produktu.upgates.product.options[].id- ID variantu.upgates.product.options[].code- Kód variantu.upgates.product.options[].price- Informácie o cene variantu (východiskové alebo podľa aktuálne prihláseného zákazníka).upgates.product.options[].price.withVat- Cena (s DPH).upgates.product.options[].price.withoutVat- Cena (bez DPH).upgates.product.options[].price.vat- DPH (hodnota).upgates.product.options[].price.vatRate- DPH (percentá).
Dynamickí zástupcovia kategórie
upgates.category- Informácie o kategórii. Dostupné len na hlavnej stránke a v detaile kategórie. Inde jenull.upgates.category.id- ID kategórie.upgates.category.code- Kód kategórie.upgates.category.title- Názov kategórie.upgates.category.path[]- Pole s jednotlivými prvkami cesty ku kategórii. Napr. produkt zanorený do kategórií Hodinky / Pánské / Kovové bude obsahovať pole s 3 prvkami. Každý prvok je názov jednej z týchto kategórií.
Dynamickí zástupcovia objednávky
upgates.order- Informácie o objednávke. Dostupné len na stránke dokončenia objednávky. Inde jenull.upgates.order.number- Číslo objednávky.upgates.order.id- ID objednávky.upgates.order.currency- Mena objednávky.upgates.order.paid- Príznak, či už je objednávka zaplatená (true|false).upgates.order.customer.email- Email zákazníka z objednávky.upgates.order.customer.phone- Telefón zákazníka z objednávky (môže byť null, pokiaľ nie je v objednávke povinný).upgates.order.customer.firstName- Meno zákazníka z objednávky (môže byť null, pokiaľ nie je v objednávke povinný).upgates.order.customer.lastName- Priezvisko zákazníka z objednávky (môže byť null, pokiaľ nie je v objednávke povinný).upgates.order.customer.billingAddress- Fakturačná adresa zákazníka z objednávky (môže byť null, pokiaľ nie sú adresy v objednávke povinné, inak obsahuje nasledujúce položky):upgates.order.customer.billingAddress.street- Fakturačná ulica (vrátane popisného/orientačného čísla) zákazníka z objednávky.upgates.order.customer.billingAddress.city- Fakturačné mesto zákazníka z objednávky.upgates.order.customer.billingAddress.zip- Fakturačné PSČ zákazníka z objednávky.upgates.order.customer.billingAddress.country- Fakturačná krajina zákazníka z objednávky (dvojmiestna skratka podľa ISO 3166-1 alpha-2).
upgates.order.customer.shippingAddress- Poštová adresa zákazníka z objednávky (môže byť null, pokiaľ nie sú adresy v objednávke povinné alebo je rovnaká ako fakturačná, inak obsahuje nasledujúce položky):upgates.order.customer.shippingAddress.firstName- Poštové meno zákazníka z objednávky.upgates.order.customer.shippingAddress.lastName- Poštové priezvisko zákazníka z objednávky.upgates.order.customer.shippingAddress.street- Poštová ulica (vrátane popisného/orientačného čísla) zákazníka z objednávky.upgates.order.customer.shippingAddress.city- Poštové mesto zákazníka z objednávky.upgates.order.customer.shippingAddress.zip- Poštové PSČ zákazníka z objednávky.upgates.order.customer.shippingAddress.country- Poštová krajina zákazníka z objednávky (dvojmiestna skratka podľa ISO 3166-1 alpha-2).
upgates.order.payment- Detaily platby z objednávky.upgates.order.payment.name- Názov platby z objednávky.upgates.order.payment.price.withVat- Cena platby z objednávky (s DPH).upgates.order.payment.price.withoutVat- Cena platby z objednávky (bez DPH).upgates.order.payment.price.vat- DPH platby z objednávky (hodnota).upgates.order.payment.price.vatRate- DPH platby z objednávky (percentá).
upgates.order.shipment- Detaily dopravy z objednávky.upgates.order.shipment.name- Názov dopravy z objednávky.upgates.order.shipment.price.withVat- Cena dopravy z objednávky (s DPH).upgates.order.shipment.price.withoutVat- Cena dopravy z objednávky (s DPH).upgates.order.shipment.price.vat- DPH dopravy z objednávky (hodnota).upgates.order.shipment.price.vatRate- DPH dopravy z objednávky (percentá).
upgates.order.prices.shipping- Súčet ceny dopravy a platby objednávky.upgates.order.prices.shipping.withVat- S DPH.upgates.order.prices.shipping.withoutVat- Bez DPH.upgates.order.prices.shipping.vat- DPH.
upgates.order.uuid- Unikátny identifikátor objednávky. Konvertovaný zupgates.cart.uuidpo dokončení objednávkyupgates.order.prices.products- Súčet cien produktov objednávky bez zliav.upgates.order.prices.products.withVat- S DPH.upgates.order.prices.products.withoutVat- Bez DPH.upgates.order.prices.products.vat- DPH.
upgates.order.prices.items- Súčet cien produktov a zliav objednávky.upgates.order.prices.items.withVat- S DPH.upgates.order.prices.items.withoutVat- Bez DPH.upgates.order.prices.items.vat- DPH.
upgates.order.prices.total- Súčet cien produktu, zliav, ceny dopravy, ceny platby (výsledná cena).upgates.order.prices.total.withVat- S DPH.upgates.order.prices.total.withoutVat- Bez DPH.upgates.order.prices.total.vat- DPH.upgates.order.prices.total.rounding- Zaokrúhlenie výslednej ceny
upgates.order.discounts.voucher.code- Kód zľavového kupónu.upgates.order.discounts.voucher.prices[]- Hodnota zľavového kupónu sa rozpočítava medzi všetky DPH v objednávke. Preto je to pole. Možné hodnoty:upgates.order.discounts.voucher.prices[].withVatupgates.order.discounts.voucher.prices[].withoutVatupgates.order.discounts.voucher.prices[].vatupgates.order.discounts.voucher.prices[].vatRate
- Pole s objednanými produktmi:
upgates.order.products[].uuid- Unikátny identifikátor objednaného produktu. Prenesie sa zupgates.cart.products[].uuid. Je tiež dostupný v API.upgates.order.products[].id- ID objednaného produktu.upgates.order.products[].code- Kód objednaného produktu|variantu.upgates.order.products[].title- Názov objednaného produktu|variantu.upgates.order.products[].quantity- Počet jednotiek objednaného produktu|variantu.upgates.order.products[].category- Informácie o kategórii objednaného produktu|variantu.upgates.order.products[].category.id- ID kategórie objednaného produktu|variantu.upgates.order.products[].category.code- Kód kategórie objednaného produktu|variantu.upgates.order.products[].category.title- Názov kategórie objednaného produktu|variantu.upgates.order.products[].category.path[]- Pole s jednotlivými prvkami cesty ku kategórii objednaného produktu|variantu. Napr. produkt zanorený do kategórií Hodinky / Pánské / Kovové bude obsahovať pole s 3 prvkami. Každý prvok je názov jednej z týchto kategórií.
upgates.order.products[].price- Informácie o cene objednaného produktu|variantu.upgates.order.products[].price.withVat- Cena objednaného produktu|variantu (s DPH).upgates.order.products[].price.withoutVat- Cena objednaného produktu|variantu (bez DPH).upgates.order.products[].price.vat- DPH objednaného produktu|variantu (hodnota).upgates.order.products[].price.vatRate- DPH objednaného produktu|variantu (percentá).upgates.order.products[].price.discount- Informácie o započítanej zľave v cene objednaného produktu|varianty (ak u toho produktu nebola započítaná zľava tak bude null).upgates.order.products[].price.discount.withVat- Hodnota započítanej zľavy s DPH.upgates.order.products[].price.discount.withoutVat- Hodnota započítanej zľavy bez DPH.upgates.order.products[].price.discount.vat- Hodnota DPH započítanej zľavy.
upgates.order.products[].option- Informácie o variante objednaného produktu (pokiaľ bol objednaný variant).upgates.order.products[].option.id- ID variantu objednaného produktu.
Dynamickí zástupcovia zákazníka
upgates.customer- Informácie o prihlásenom zákazníkovi. Dostupné len pokiaľ je zákazník prihlásený. Inak je hodnotanull.upgates.customer.email- Email prihláseného zákazníka.upgates.customer.groups- Skupiny, do ktorých príslušný zákazník spadáupgates.customer.groups.id- ID danej skupinyupgates.customer.groups.name- Názov danej skupiny
Dynamickí zástupcovia košíka
upgates.cart- Informácie o košíku.upgates.cart.products[].uuid- Unikátny identifikátor produktu v košíku.upgates.cart.products[].id- ID produktu v košíku.upgates.cart.products[].option- Informácie o variante objednaného produktu (pokiaľ bol objednaný variant).upgates.cart.products[].option.id- ID variantu objednaného produktu.
upgates.cart.products[].code- Kód objednaného produktu|variantu.upgates.cart.products[].title- Názov objednaného produktu|variantu.upgates.cart.products[].quantity- Počet jednotek objednaného produktu|variantu.upgates.cart.products[].price- Informácie o ceně objednaného produktu|variantu.upgates.cart.products[].price.withVat- Cena objednaného produktu|variantu (s DPH).upgates.cart.products[].price.withoutVat- Cena objednaného produktu|variantu (bez DPH).upgates.cart.products[].price.vat- DPH objednaného produktu|variantu (hodnota).upgates.cart.products[].price.vatRate- DPH objednaného produktu|variantu (procenta).
upgates.cart.products[].category- Informácie o kategórii produktu v košíku.upgates.cart.products[].category.id- ID kategórie produktu v košíku.upgates.cart.products[].category.code- Kód kategórie produktu v košíku.upgates.cart.products[].category.title- Názov kategórie produktu v košíku.upgates.cart.products[].category.path[]- Pole s jednotlivými prvkami cesty ku kategórii produktu v košíku. Napr. produkt zanorený do kategórií Hodinky / Pánske / Kovové bude obsahovať pole s 3 prvkami. Každý prvok je názov jednej z týchto kategórií.
upgates.cart.products[].categories_ids- Informácie o kategóriich produktu v košíku.upgates.cart.uuid- Unikátny identifikátor košíka. Potom sa prevedie doupgates.order.uuidpo dokončení objednávky.
Dynamickí zástupcovia vyhľadávania
upgates.search- Informácie o vyhľadávaní. Dostupné len pokiaľ je stránka vyhľadávania. Inak je hodnotanull.upgates.search.phrase- Vyhľadaná fráza.
Dynamickí zástupcovia udalosti
page.view- Zavolá sa pri zobrazení každej stránky. V kombinácii supgates.pageTypeje možno určovat specifické možnosti.
{} page.view JAVASCRIPT
upgates.on('page.view', function() {
});
upgates.on('page.view', function() {
if (upgates.pageType === 'order.cart') {
/* ViewCart */
}
});
upgates.on('page.view', function() {
if (upgates.pageType === 'product') {
/* ViewContent */
}
});
upgates.on('page.view', function() {
if (upgates.pageType === 'search') {
/* Search */
alert(upgates.search.phrase);
}
});
cart.add- Zavolá sa pri pridaní produktu do košíka (informácie o pridanom produkte sa pošlú do funkcie ako parameter).
{} cart.add JAVASCRIPT
upgates.on('cart.add', function(product) {
product.id // ID produktu pridaného do košíka.
product.code // Kód produktu|variantu pridaného do košíka.
product.title // Název produktu|variantu pridaného do košíka.
product.quantity // Počet jednotiek pridaného produktu|variantu.
product.price // Informácie o cene přidaného produktu|variantu.
product.price.withVat // Cena pridaného produktu|variantu (s DPH).
product.price.withoutVat // Cena pridaného produktu|variantu (bez DPH).
product.price.vat // DPH pridaného produktu|variantu (hodnota).
product.price.vatRate // DPH pridaného produktu|variantu (procenta).
product.option // Informácie o variante pridaného produktu (pokiaľ bol pridaný variant).
product.option.id // ID varianty pridaného produktu.
});
cart.remove- Zavolá sa pri odobratí produktu z košíka (informácie o odobratom produkte sa pošlú do funkcie ako parameter).
{} cart.remove JAVASCRIPT
upgates.on('cart.remove', function(product) {
product.id // ID produktu pridaného do košíka.
product.code // Kód produktu|variantu pridaného do košíka.
product.title // Názov produktu|variantu pridaného do košíka.
product.quantity // Počet jednotiek pridaného produktu|variantu.
product.price // Informácie o cene pridaného produktu|variantu.
product.price.withVat // Cena pridaného produktu|variantu (s DPH).
product.price.withoutVat // Cena pridaného produktu|variantu (bez DPH).
product.price.vat // DPH pridaného produktu|variantu (hodnota).
product.price.vatRate // DPH pridaného produktu|variantu (percentá).
product.option // Informácie o variante pridaného produktu (pokiaľ bol pridaný variant).
product.option.id // ID variantu pridaného produktu.
});
checkout.initiate- Zavolá sa po prechode z košíka na výber dopravy a platby.
{} checkout.initiate JAVASCRIPT
upgates.on('checkout.initiate', function() {
});
checkout.shipment.select- Zavolá sa pri výbere dopravy.
{} checkout.shipment.select JAVASCRIPT
upgates.on('checkout.shipment.select', function(shipment) {
shipment.name // Názov vybranej dopravy.
});
checkout.payment.select- Zavolá sa pri výbere platby.
{} checkout.payment.select JAVASCRIPT
upgates.on('checkout.payment.select', function(payment) {
payment.name // Názov vybranej platby.
});
login- Zavolá sa po prihlásení.
{} login JAVASCRIPT
upgates.on('login', function() {
});
signup- Zavolá sa po registrácii.
{} signup JAVASCRIPT
upgates.on('signup', function() {
});
subscribe- Zavolá sa po prihlásení do newslettera.
{} subscribe JAVASCRIPT
upgates.on('subscribe', function(email) {
email // E-mail, ktorý bol prihlásený do newslettera.
});
Dynamickí zástupcovia cookies
upgates.cookies- Informácie o cookies.upgates.cookies.defaults.functional- východisková hodnota true/false pre funkčné cookies (toto sú nevyhnutné cookies, preto bude vždy true).upgates.cookies.defaults.analytics- východisková hodnota true/false pre analytické cookies (podľa nastavení v administrácii e-shopu).upgates.cookies.defaults.ads- východisková hodnota true/false pre reklamné cookies (podľa nastavení v administrácii e-shopu).upgates.cookies.defaults.personalized- východisková hodnota true/false pre personalizované cookies (podľa nastavení v administrácii e-shopu).upgates.cookies.functional- hodnota true/false pre funkčné cookies podľa toho, čo si nastaví užívateľ (toto sú nevyhnutné cookies, preto bude vždy true).upgates.cookies.analytics- hodnota true/false pre analytické cookies podľa toho, čo si nastaví užívateľ (dokiaľ sa nič nenastaví, tak je tu východisková hodnota podľaupgates.cookies.defaults.analytics).upgates.cookies.ads- hodnota true/false pre reklamné cookies podľa toho, čo si nastaví užívateľ (dokiaľ sa nič nenastaví, tak je tu východisková hodnota podľaupgates.cookies.defaults.ads).upgates.cookies.personalized- hodnota true/false pre personalizované cookies podľa toho, čo si nastaví užívateľ (dokiaľ sa nič nenastaví, tak je tu východisková hodnota podľaupgates.cookies.defaults.personalized).
- Pridáva sa event
'cookies', ktorý sa zavolá vždy, keď užívateľ zmení nastavenia cookies (odsúhlasí, odmietne, zmení jednotlivé nastavenia v okne).
{} cookies JAVASCRIPT
upgates.on('cookies', function() {
// V týchto premenných už budú zmenené hodnoty
upgates.cookies.functional
upgates.cookies.analytics
upgates.cookies.ads
upgates.cookies.personalized
});
