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.
Při vložení tracking kódů, které namísto javascriptu využívají např. obrázky, je potřeba kód vypsat přes funkci document.write. Např:
<script>
document.write('<img id="abc" src="https://URL.adresa&orderId=' + upgates.order.number + '&orderAmount=' + upgates.order.prices.items.withVat + '" width="1" height="1" />');
</script>
Pro zjištění aktuálních údajů obsažených v upgates
lze použít funkci console.log(upgates);
.
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.detail
advisor.list
article
category
compare
customer.communication
customer.favourites
customer.orders
customer.orders.detail
customer.login
customer.password
customer.profile
customer.rating
customer.review
customer.registration
customer.watchdog
homepage
manufacturer
news.detail
news.list
newsletter
order.cart
order.checkout
order.recieved
order.shipment
order.summary
page
product
search
sitemap
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.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.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.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.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[].withVat
upgates.order.discounts.voucher.prices[].withoutVat
upgates.order.discounts.voucher.prices[].vat
upgates.order.discounts.voucher.prices[].vatRate
- Pole s objednanými produkty:
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[].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.
Dynamičtí zástupci košíku
upgates.cart
- Informace o 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).
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.pageType
možno určovat specifické možnosti.
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).
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).
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.
});
login
- Zavolá se po přihlášení.
upgates.on('login', function() {
});
signup
- Zavolá se po registraci.
upgates.on('signup', function() {
});
subscribe
- Zavolá se po přihlášení do newsletteru.
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 relamní 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 relamní 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ě).
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
});
Nahrazení původních dynamických zástupců
Ve stávajících konverzních kódech je potřeba všechny staré dynamické zástupce {$...}
nahradit novými dynamickými zástupci pro javascript. Viz následující ukázka.
- Zápis využívající staré dynamické zástupce:
'amount':{$order_total_without_shipment_payment_vat},
'orderNum':{$order_number},
'promoCode': {$voucher_code}
- Zápis využívající nové dynamické zástupce:
'amount': upgates.order.prices.items.withVat,
'orderNum': upgates.order.number,
'promoCode': upgates.order.discounts.voucher.code