Dokumentace - zástupci pro konverzní kódy
Základní informace ke konverzním kódům najdete v nápovědě Konverzní kódy.
Dynamičtí zástupci
Dokumentace nových dynamických zástupců pro konverzní kódy. Všichni dynamičtí zástupci jsou globální javascriptové proměnné. Lze tedy využít jakékoliv funkce z javascriptu.
Objekt upgates je javascriptový objekt, který je globálně dostupný a vytváří se v hlavičce stránky. Je tedy možné k němu přistoupit z jakéhokoliv javascriptu. Ať je vložený do vlastních konverzních kódů, nebo do editoru kódu.
Pro zjištění aktuálních údajů obsažených v upgates lze použít funkci console.log(upgates);.
Jak si ověřit funkčnost eventů?
Například řekněme, že budu chtít ověřit, zda-li v dataLayeru stránky je k dispozici event po přidání do košíku.
- Do sekce Doplňky / Vlastní konverzní kódy.
- Najděte první sekci Kód je umístěn mezi tagy <head> a </head>.
- Vložte zápis:
<script>upgates.on('cart.add', function(product) {alert("xxx");});</script> - Uložte.
- Otevřete vaše stránky a vložte nějaký produkt do košíku. Pokud se na vašich stránkách vyskytuje event add_to_cart prohlížeč otevře informativní okno a v něm bude zápis xxx, který máte uveden v zápisu.
Vysvětlivky:
- cart.add - Event vytvořený ze strany Upgates. Můžete jej změnit na vlastní, které jsou vypsány níže. cart.add najdete například přímo zde.
- xxx - Označuje textaci, která se vám na stránce zobrazí po spuštění. Tedy v příkladu například vyskočí okno prohlížeče, ve kterém bude textace xxx. Změnit jí můžete na libovolnou hodnotu, avšak dbejte zvýšené opatrnosti při zápisu a ponechejte závorky a uvozovky na svém místě. Jinak script nebude fungovat.
Dynamičtí zástupci stránky
upgates.language- Jazyk aktuální stránky.upgates.currency- Měna aktuální stránky.upgates.pageType- Typ aktuální 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
Dynamičtí zástupci produktu
upgates.product- Informace o produktu. Dostupné pouze na stránce detailu produktu. Jinde jenull.upgates.product.id- ID produktu.upgates.product.code- Kód produktu.upgates.product.title- Název produktu.upgates.product.manufacturer- Výrobce 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 procentech).upgates.product.options[]- Pole variant produktu.upgates.product.options[].id- ID varianty.upgates.product.options[].code- Kód varianty.upgates.product.options[].price- Informace o ceně varianty (výchozí nebo podle aktuálně přihlášené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 (procenta).
Dynamičtí zástupci kategorie
upgates.category- Informace o kategorii. Dostupné pouze na hlavní stránce a v detailu kategorie. Jinde jenull.upgates.category.id- ID kategorie.upgates.category.code- Kód kategorie.upgates.category.title- Název kategorie.upgates.category.path[]- Pole s jednotlivými prvky cesty ke kategorii. Např. produkt zanořený do kategorií Hodinky / Pánské / Kovové bude obsahovat pole se 3 prvky. Každý prvek je název jedné z těchto kategorií.
Dynamičtí zástupci objednávky
upgates.order- Informace o objednávce. Dostupné pouze na stránce dokončení objednávky. Jinde jenull.upgates.order.number- Číslo objednávky.upgates.order.id- ID objednávky.upgates.order.currency- Měna objednávky.upgates.order.paid- Příznak, zda už je objednávka zaplacena (true|false).upgates.order.customer.email- Email zákazníka z objednávky.upgates.order.customer.phone- Telefon zákazníka z objednávky (může být null, pokud není v objednávce povinný).upgates.order.customer.firstName- Jméno zákazníka z objednávky (může být null, pokud není v objednávce povinné).upgates.order.customer.lastName- Přijmení zákazníka z objednávky (může být null, pokud není v objednávce povinné).upgates.order.customer.billingAddress- Fakturační adresa zákazníka z objednávky (může být null, pokud nejsou adresy v objednávce povinné, jinak obsahuje následující položky):upgates.order.customer.billingAddress.street- Fakturační ulice (včetně popisného/orientačního čísla) zákazníka z objednávky.upgates.order.customer.billingAddress.city- Fakturační město 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í země zákazníka z objednávky (dvoumístná zkratka podle ISO 3166-1 alpha-2).
upgates.order.customer.shippingAddress- Poštovní adresa zákazníka z objednávky (může být null, pokud nejsou adresy v objednávce povinné nebo je stejná jako fakturační, jinak obsahuje následující položky):upgates.order.customer.shippingAddress.firstName- Poštovní jméno zákazníka z objednávky.upgates.order.customer.shippingAddress.lastName- Poštovní příjmení zákazníka z objednávky.upgates.order.customer.shippingAddress.street- Poštovní ulice (včetně popisného/orientačního čísla) zákazníka z objednávky.upgates.order.customer.shippingAddress.city- Poštovní město zákazníka z objednávky.upgates.order.customer.shippingAddress.zip- Poštovní PSČ zákazníka z objednávky.upgates.order.customer.shippingAddress.country- Poštovní země zákazníka z objednávky (dvoumístná zkratka podle ISO 3166-1 alpha-2).
upgates.order.payment- Detaily platby z objednávky.upgates.order.payment.name- Název 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 (procenta).
upgates.order.shipment- Detaily dopravy z objednávky.upgates.order.shipment.name- Název 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 (procenta).
upgates.order.prices.shipping- Souč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átní identifikátor objednávky. Převedený zupgates.cart.uuidpo dokončení objednávky.upgates.order.prices.products- Součet cen produktů objednávky beze slev.upgates.order.prices.products.withVat- S DPH.upgates.order.prices.products.withoutVat- Bez DPH.upgates.order.prices.products.vat- DPH.
upgates.order.prices.items- Součet cen produktů a slev 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- Součet cen produktu, slev, 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- Zaokrouhlení výsledné ceny
upgates.order.discounts.voucher.code- Kód slevového kupónu.upgates.order.discounts.voucher.prices[]- Hodnota slevového kupónu se rozpočítává mezi všechna DPH v objednávce. Proto 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 produkty:
upgates.order.products[].uuid- Unikátní identifikátor objednaného produktu. Přenese se zupgates.cart.products[].uuid. Je také dostupný v API.upgates.order.products[].id- ID objednaného produktu.upgates.order.products[].code- Kód objednaného produktu|varianty.upgates.order.products[].title- Název objednaného produktu|varianty.upgates.order.products[].quantity- Počet jednotek objednaného produktu|varianty.upgates.order.products[].category- Informace o kategorii objednaného produktu|varianty.upgates.order.products[].category.id- ID kategorie objednaného produktu|varianty.upgates.order.products[].category.code- Kód kategorie objednaného produktu|varianty.upgates.order.products[].category.title- Název kategorie objednaného produktu|varianty.upgates.order.products[].category.path[]- Pole s jednotlivými prvky cesty ke kategorii objednaného produktu|varianty. Např. produkt zanořený do kategorií Hodinky / Pánské / Kovové bude obsahovat pole se 3 prvky. Každý prvek je název jedné z těchto kategorií.
upgates.order.products[].price- Informace o ceně objednaného produktu|varianty.upgates.order.products[].price.withVat- Cena objednaného produktu|varianty (s DPH).upgates.order.products[].price.withoutVat- Cena objednaného produktu|varianty (bez DPH).upgates.order.products[].price.vat- DPH objednaného produktu|varianty (hodnota).upgates.order.products[].price.vatRate- DPH objednaného produktu|varianty (procenta).upgates.order.products[].price.discount- Informace o započítané slevě v ceně objednaného produktu|varianty (pokud u toho produktu nebyla započítána sleva tak bude null).upgates.order.products[].price.discount.withVat- Hodnota započítané slevy s DPH.upgates.order.products[].price.discount.withoutVat- Hodnota započítané slevy bez DPH.upgates.order.products[].price.discount.vat- Hodnota DPH započítané slevy.
upgates.order.products[].option- Informace o variantě objednaného produktu (pokud byla objednána varianta).upgates.order.products[].option.id- ID varianty objednaného produktu.
Dynamičtí zástupci zákazníka
upgates.customer- Informace o přihlášeném zákazníkovi. Dostupné pouze pokud je zákazník přihlášený. Jinak je hodnotanull.upgates.customer.email- Email přihlášeného zákazníka.upgates.customer.groups- Skupiny, do kterých příslušný zákazník spadáupgates.customer.groups.id- ID dané skupinyupgates.customer.groups.name- Název dané skupiny
Dynamičtí zástupci košíku
upgates.cart- Informace o košíku.upgates.cart.products[].uuid- Unikátní identifikátor produktu v košíku.upgates.cart.products[].id- ID produktu v košíku.upgates.cart.products[].option- Informace o variantě objednaného produktu (pokud byla objednána varianta).upgates.cart.products[].option.id- ID varianty objednaného produktu.
upgates.cart.products[].code- Kód objednaného produktu|varianty.upgates.cart.products[].title- Název objednaného produktu|varianty.upgates.cart.products[].quantity- Počet jednotek objednaného produktu|varianty.upgates.cart.products[].price- Informace o ceně objednaného produktu|varianty.upgates.cart.products[].price.withVat- Cena objednaného produktu|varianty (s DPH).upgates.cart.products[].price.withoutVat- Cena objednaného produktu|varianty (bez DPH).upgates.cart.products[].price.vat- DPH objednaného produktu|varianty (hodnota).upgates.cart.products[].price.vatRate- DPH objednaného produktu|varianty (procenta).
upgates.cart.products[].category- Informace o kategorii produktu v košíku.upgates.cart.products[].category.id- ID kategorie produktu v košíku.upgates.cart.products[].category.code- Kód kategorie produktu v košíku.upgates.cart.products[].category.title- Název kategorie produktu v košíku.upgates.cart.products[].category.path[]- Pole s jednotlivými prvky cesty ke kategorii produktu v košíku. Např. produkt zanořený do kategorií Hodinky / Pánské / Kovové bude obsahovat pole se 3 prvky. Každý prvek je název jedné z těchto kategorií.
upgates.cart.products[].categories_ids- Informace o kategoriích produktu v košíku.upgates.cart.uuid- Unikátní identifikátor košíku. Převede se poté doupgates.order.uuidpo dokončení objednávky.
Dynamičtí zástupci vyhledávání
upgates.search- Informace o vyhledávání. Dostupné pouze pokud je stránka vyhledávání. Jinak je hodnotanull.upgates.search.phrase- Vyhledaná fráze.
Dynamičtí zástupci události
page.view- Zavolá se při zobrazení každé stránky. V kombinaci 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á se při přidání produktu do košíku (informace o přidaném produktu se pošlou do funkce jako parametr).
{} cart.add JAVASCRIPT
upgates.on('cart.add', function(product) {
product.id // ID produktu přidaného do košíku.
product.code // Kód produktu|varianty přidaného do košíku.
product.title // Název produktu|varianty přidaného do košíku.
product.quantity // Počet jednotek přidaného produktu|varianty.
product.price // Informace o ceně přidaného produktu|varianty.
product.price.withVat // Cena přidaného produktu|varianty (s DPH).
product.price.withoutVat // Cena přidaného produktu|varianty (bez DPH).
product.price.vat // DPH přidaného produktu|varianty (hodnota).
product.price.vatRate // DPH přidaného produktu|varianty (procenta).
product.option // Informace o variantě přidaného produktu (pokud byla přidána varianta).
product.option.id // ID varianty přidaného produktu.
});
cart.remove- Zavolá se při odebrání produktu z košíku (informace o oderaném produktu se pošlou do funkce jako parametr).
{} cart.remove JAVASCRIPT
upgates.on('cart.remove', function(product) {
product.id // ID produktu přidaného do košíku.
product.code // Kód produktu|varianty přidaného do košíku.
product.title // Název produktu|varianty přidaného do košíku.
product.quantity // Počet jednotek přidaného produktu|varianty.
product.price // Informace o ceně přidaného produktu|varianty.
product.price.withVat // Cena přidaného produktu|varianty (s DPH).
product.price.withoutVat // Cena přidaného produktu|varianty (bez DPH).
product.price.vat // DPH přidaného produktu|varianty (hodnota).
product.price.vatRate // DPH přidaného produktu|varianty (procenta).
product.option // Informace o variantě přidaného produktu (pokud byla přidána varianta).
product.option.id // ID varianty přidaného produktu.
});
checkout.initiate- Zavolá se po přechodu z košíku na výběr dopravy a platby.
{} checkout.initiate JAVASCRIPT
upgates.on('checkout.initiate', function() {
});
checkout.shipment.select- Zavolá se při výběru dopravy.
{} checkout.shipment.select JAVASCRIPT
upgates.on('checkout.shipment.select', function(shipment) {
shipment.name // Název vybrané dopravy.
});
checkout.payment.select- Zavolá se při výběru platby.
{} checkout.payment.select JAVASCRIPT
upgates.on('checkout.payment.select', function(payment) {
payment.name // Název vybrané platby.
});
login- Zavolá se po přihlášení.
{} login JAVASCRIPT
upgates.on('login', function() {
});
signup- Zavolá se po registraci.
{} signup JAVASCRIPT
upgates.on('signup', function() {
});
subscribe- Zavolá se po přihlášení do newsletteru.
{} subscribe JAVASCRIPT
upgates.on('subscribe', function(email) {
email // Email, který byl přihlášený do newsletteru
});
Dynamičtí zástupci cookies
upgates.cookies- Informace o cookies.upgates.cookies.defaults.functional- výchozí hodnota true/false pro funkční cookies (toto jsou nezbytné cookies, proto bude vždy true).upgates.cookies.defaults.analytics- výchozí hodnota true/false pro analytické cookies (podle nastavení v administraci e-shopu).upgates.cookies.defaults.ads- výchozí hodnota true/false pro reklamní cookies (podle nastavení v administraci e-shopu).upgates.cookies.defaults.personalized- výchozí hodnota true/false pro personalizované cookies (podle nastavení v administraci e-shopu).upgates.cookies.functional- hodnota true/false pro funkční cookies podle toho, co si nastaví uživatel (toto jsou nezbytné cookies, proto bude vždy true).upgates.cookies.analytics- hodnota true/false pro analytické cookies podle toho, co si nastaví uživatel (dokud se nic nenastaví, tak je tady výchozí hodnota podleupgates.cookies.defaults.analytics).upgates.cookies.ads- hodnota true/false pro reklamní cookies podle toho, co si nastaví uživatel (dokud se nic nenastaví, tak je tady výchozí hodnota podleupgates.cookies.defaults.ads).upgates.cookies.personalized- hodnota true/false pro personalizované cookies podle toho, co si nastaví uživatel (dokud se nic nenastaví, tak je tady výchozí hodnota podleupgates.cookies.defaults.personalized).
- Přidává se event
'cookies', který se zavolá vždy, když uživatel změní nastavení cookies (odsouhlasí, odmítne, změní jednotlivá nastavení v okně).
{} cookies JAVASCRIPT
upgates.on('cookies', function() {
// V těchto proměnných už budou změněné hodnoty
upgates.cookies.functional
upgates.cookies.analytics
upgates.cookies.ads
upgates.cookies.personalized
});
