JavaScript API

Sve što mp.js pruža vašem kodu: saglasnost, vaš ID kupca, prilagođene događaje, korake bez promene adrese, okidače i HTML atribute. Ništa od ovoga nije obavezno — sam isečak snima.

1. Dva načina pozivanja

mp.js se učitava asinhrono. Kôd koji radi pre učitavanja stavlja pozive u red window.mp_q; mp.js ga obrađuje čim stigne. Nakon toga iste funkcije su 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);

Uvek pišite window.mp_q = window.mp_q || [], nikada window.mp_q = []. mp.js nastavlja da osluškuje taj niz — novi bi progutao svaki kasniji poziv, uključujući povlačenje saglasnosti.

Instalacioni isečak definiše i zamensku funkciju mp(...) koja na isti način stavlja u red. Oba oblika primaju iste komande: consent, set, event, step, get, on i off.

2. Saglasnost

Bez saglasnosti ništa se ne snima. Ako MousePlayer prepoznaje vaš alat za saglasnost, ovo vam nije potrebno; inače sami prosledite 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 odmah deluje na stranici: osluškivači se uklanjaju, podaci bafera odbacuju, veza zatvara. Pogledajte MousePlayer i saglasnost.

3. Vaš ID kupca

Uz vaš ID, svi uređaji jedne osobe postaju jedan posetilac na listama i možete da tražite slučaj podrške po poznatom broju. ID se primenjuje i na ranije posete istog pregledača iz poslednjih 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, ne imejl adresu ili ime. MousePlayer pokazuje ID svuda gde se posetilac 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

Događaji koje šaljete pojavljuju se na vremenskoj liniji snimka, mogu biti ciljevi i koraci levka i idu vašim webhook-ovima i povezanim alatima. Parametri su kratke vrednosti: brojevi, tekst 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 sa donjim crtama, najviše 128 znakova. Koristite isti naziv za istu stvar svuda — cilj tačno poklapa nazive.
  • Ne stavljajte lične podatke u parametre. Čuvaju se i prikazuju kao svaki drugi događaj.

5. Koraci bez promene adrese

Naplata ili čarobnjak koji menja ekran, ali ne i adresu, za MousePlayer je jedna stranica. step() pravi od svakog ekrana zaseban prikaz stranice — sa sopstvenim snimkom, redom toplotne mape i korakom levka.

// 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 1 do 40 znakova iz 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 recite MousePlayer-u šta se gleda. Prihvataju se samo ovi ključevi; sve ostalo se odbacuje da podaci kupca ne prođu slučajno.

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. Okidači

Vaš kôd može da reaguje na ono što MousePlayer meri na stranici. Registrujte preko reda čekanja ako okidač ne sme da propusti 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 izlaska je bodovao prvi prikaz stranice (jednom po poseti)risk, reasons, session
churn_riskpovratni posetilac označen je kao sklon trajnom odlaskurisk, reasons, session
offer_shownponuda pri izlasku se prikazujeart, risk, grund, session
offer_clicknjeno dugme je kliknutoart, risk, grund, session, fehler
offer_dismisszatvorena jeart, risk, grund, session
survey_shownanketa se otvarasurvey, trigger, session
survey_answerposetilac odgovarasurvey, type, value, option, sentiment, session
survey_textdodatni tekst se šalje (već filtriran)survey, text, session
survey_dismissanketa se zatvara bez odgovorasurvey, step, session

Kada je GTM most uključen, isti događaji idu i u dataLayer (mp_exit_risk i tako dalje). MousePlayer.exitRisk() vraća trenutni rizik od izlaska ili null pre nego što je 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 menjaju se pre napuštanja pregledača — u snimku, promenama i opisima klikova.
  • data-mp-ignore (ili mp-ignore) na polju obrasca: njegova vrednost se uopšte ne snima.
  • data-mp-role: jedno 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. Ostale vrednosti se zanemaruju.

9. Isključivanje sopstvenih poseta

Otvorite sajt jednom sa ?mp_exclude=1 i ovaj pregledač se više ne snima; ?mp_exclude=0 poništava to. Za celu kancelarijsku mrežu umesto toga unesite IP adrese u podešavanja 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. Link za vašu politiku privatnosti

Posetioci mogu da vide i obrišu ono što je o njima snimljeno. privacyUrl() vraća gotov link sa ID-jem ovog pregledača — ili null ako ga nema jer bez saglasnosti ništa nije snimljeno.

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