JavaScript API

Sve što mp.js nudi vašem kodu: privola, vaš ID kupca, prilagođeni događaji, koraci bez promjene adrese, hookovi i HTML atributi. Ništa od ovoga nije obavezno – sam isječak snima.

1. Dva načina pozivanja

mp.js učitava se asinkrono. Kod koji se izvršava prije učitavanja dodaje pozive u red window.mp_q; mp.js obrađuje ga čim stigne. Poslije su iste funkcije dostupne na window.MousePlayer.

// Before mp.js has loaded - the queue keeps every call: (window.mp_q = window.mp_q || []).push(['consent', true]); // After mp.js has loaded - the same, directly: MousePlayer.setConsent(true);

Uvijek pišite window.mp_q = window.mp_q || [], nikad window.mp_q = []. mp.js nastavlja osluškivati to polje – novo bi progutalo svaki kasniji poziv, uključujući povlačenje privole.

Instalacijski isječak definira i privremenu funkciju mp(...) koja jednako dodaje u red. Oba oblika prihvaćaju iste naredbe: consent, set, event, step, get, on i off.

2. Privola

Bez privole ništa se ne snima. Ako vaš alat za privolu MousePlayer prepoznaje, ništa od ovoga ne trebate; inače sami proslijedite odluku.

MousePlayer.setConsent(true); // the visitor agreed MousePlayer.setConsent(false); // withdrawn: recording stops on this page MousePlayer.getConsentState(); // e.g. 'WAITING', 'GRANTED', 'GRANTED_LATE', 'DENIED', 'WITHDRAWN'

Povlačenje privole odmah djeluje na stranici: osluškivanje se uklanja, podaci iz međuspremnika odbacuju se i veza se zatvara. Pogledajte MousePlayer i privola.

3. Vaš ID kupca

Uz vlastiti ID svi uređaji jedne osobe postaju jedan posjetitelj na popisima, a slučaj podrške možete tražiti prema poznatom broju. ID se primjenjuje i na ranije posjete istog preglednika iz posljednjih 30 dana.

// After login - your own customer number, not an e-mail address: MousePlayer.setUserId('customer-4711'); // or through the queue (window.mp_q = window.mp_q || []).push(['set', 'user_id', 'customer-4711']);

Koristite interni broj, a ne adresu e-pošte ili ime. MousePlayer prikazuje ID svugdje gdje se posjetitelj pojavljuje.

Čitanje ID-jeva

MousePlayer.getSessionUrl(); // replay link of the running session MousePlayer.getSessionId(); MousePlayer.getVisitorId(); // null without consent // Through the queue, with a callback: (window.mp_q = window.mp_q || []).push(['get', 'session_url', function (url) { // e.g. attach it to a support ticket }]);

4. Prilagođeni događaji

Poslani događaji pojavljuju se na vremenskoj crti reprodukcije, mogu biti ciljevi i koraci lijevka te odlaze u webhookove i povezane alate. Parametri su kratke vrijednosti: brojevi, tekstovi do 255 znakova, ključevi do 64 znaka.

MousePlayer.trackEvent('newsletter_signup', { source: 'footer' }); MousePlayer.trackEvent('purchase', { value: 129.90, currency: 'EUR' }); (window.mp_q = window.mp_q || []).push(['event', 'add_to_cart', { sku: 'SKU-123' }]);
  • Nazivi: mala slova s podvlakama, najviše 128 znakova. Svugdje koristite isti naziv za istu stvar – cilj se točno podudara s nazivom.
  • Ne stavljajte osobne podatke u parametre. Pohranjuju se i prikazuju kao svaki drugi događaj.

5. Koraci bez promjene adrese

Dovršavanje kupnje ili čarobnjak koji mijenja zaslon, ali ne i adresu, za MousePlayer je jedna stranica. step() pretvara svaki zaslon u zaseban prikaz stranice – s vlastitom snimkom stanja, retkom toplinske karte i korakom lijevka.

// A wizard that keeps its address: MousePlayer.step('shipping'); MousePlayer.step('payment'); MousePlayer.step(''); // back to the page itself (window.mp_q = window.mp_q || []).push(['step', 'payment']);

Naziv ima od 1 do 40 znakova iz skupa a-z, 0-9, _ i -; razmaci postaju crtice, sve ostalo odbija se uz upozorenje u konzoli. Stvarna navigacija završava korak.

6. Kontekst proizvoda

Na stranici proizvoda javite MousePlayeru što se pregledava. Prihvaćaju se samo ovi ključevi; sve ostalo odbacuje se kako podaci kupaca ne bi slučajno ušli.

MousePlayer.setContext({ page_type: 'product', product_id: 'SKU-123', variant_id: 'SKU-123-42', price: 89.90, currency: 'EUR', category: 'running-shoes', in_stock: true, cart_value: 0, cart_items: 0 });

7. Hookovi

Vaš kod može reagirati na ono što MousePlayer mjeri na stranici. Registrirajte putem reda ako hook ne smije propustiti prvi trenutak.

// Register early - exit_risk fires once, a few seconds after the visit starts: (window.mp_q = window.mp_q || []).push(['on', 'exit_risk', function (e) { console.log(e.risk, e.reasons, e.session); }]); function onAnswer(e) { /* e.survey, e.value, e.sentiment */ } MousePlayer.on('survey_answer', onAnswer); MousePlayer.off('survey_answer', onAnswer);
NazivKadaPolja
exit_riskmodel odlaska ocijenio je prvi prikaz stranice (jednom po posjetu)risk, reasons, session
churn_riskpovratni posjetitelj označen je kao vjerojatan trajni odlazakrisk, reasons, session
offer_shownponuda pri odlasku prikazana jeart, risk, grund, session
offer_clicknjezin gumb je kliknutart, risk, grund, session, fehler
offer_dismisszatvorena jeart, risk, grund, session
survey_shownanketa se otvarasurvey, trigger, session
survey_answerposjetitelj odgovarasurvey, type, value, option, sentiment, session
survey_textdodatni tekst šalje se (već filtriran)survey, text, session
survey_dismissanketa se zatvara bez odgovorasurvey, step, session

Kad je GTM most uključen, isti događaji odlaze i u dataLayer (mp_exit_risk i tako dalje). MousePlayer.exitRisk() vraća trenutačni rizik odlaska ili null dok nije poznat.

8. HTML atributi

<!-- Nothing typed in here leaves the browser as text --> <section data-mp-mask> ... </section> <!-- The value of this field is never recorded --> <input name="voucher" data-mp-ignore> <!-- Tell MousePlayer what an element is --> <span class="amount" data-mp-role="price">89,90 EUR</span>
  • data-mp-mask (ili klasa mp-masked): tekst i unos unutar elementa zamjenjuju se prije napuštanja preglednika – u snimci stanja, promjenama i opisima klikova.
  • data-mp-ignore (ili mp-ignore) na polju obrasca: njegova se vrijednost uopće ne snima.
  • data-mp-role: jedan od price, price_old, cta_cart, cta_checkout, product_image, variant, shipping_info, returns_info, reviews, rating, stock, coupon, payment_methods, search, filter, heading, article_body, nav, media, form_field, contact_info. Druge se vrijednosti zanemaruju.

9. Isključivanje vlastitih posjeta

Jednom otvorite web-mjesto s ?mp_exclude=1 i ovaj se preglednik više ne snima; ?mp_exclude=0 to poništava. Za cijelu uredsku mrežu umjesto toga unesite IP adrese u postavke projekta.

https://www.your-shop.com/?mp_exclude=1 <!-- this browser is not recorded any more --> https://www.your-shop.com/?mp_exclude=0 <!-- recorded again -->

10. Poveznica za pravila privatnosti

Posjetitelji mogu vidjeti i izbrisati što je o njima snimljeno. privacyUrl() vraća gotovu poveznicu s ID-jem ovog preglednika – ili null ako ga nema jer se bez privole ništa nije snimilo.

var link = MousePlayer.privacyUrl(); // language from <html lang>, or e.g. privacyUrl('de') if (link) document.getElementById('my-data').href = link;