JavaScripti API

Kõik, mida mp.js teie koodile pakub: nõusolek, teie kliendi-ID, kohandatud sündmused, aadressimuutuseta sammud, haagid ja HTML-atribuudid. Miski siin pole kohustuslik – koodilõik üksi juba salvestab.

1. Kaks kutsumisviisi

mp.js laaditakse asünkroonselt. Enne selle laadimist käivituv kood lisab oma kutsed järjekorda window.mp_q; mp.js töötleb need niipea, kui on laaditud. Seejärel on samad funktsioonid saadaval objektil 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);

Kirjutage alati window.mp_q = window.mp_q || [], mitte kunagi window.mp_q = []. mp.js kuulab jätkuvalt seda massiivi – uus massiiv neelaks kõik hilisemad kutsed, sealhulgas nõusoleku tagasivõtmise.

Paigalduskood määrab ka asendusfunktsiooni mp(...), mis lisab kutsed samamoodi järjekorda. Mõlemad viisid võtavad vastu samad käsud: consent, set, event, step, get, on ja off.

2. Nõusolek

Ilma nõusolekuta ei salvestata midagi. Kui teie nõusolekutööriist kuulub MousePlayeri tuvastatavate hulka, pole teil midagi järgnevast vaja; muul juhul edastage otsus ise.

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'

Tagasivõtmine jõustub lehel kohe: kuulajad eemaldatakse, puhverdatud andmed visatakse ära ja ühendus suletakse. Vt MousePlayer ja nõusolek.

3. Teie kliendi-ID

Teie enda ID korral saavad ühe inimese kõikidest seadmetest loendites üks külastaja ning saate kasutajatoe juhtumit otsida teile teadaoleva numbri järgi. ID lisatakse ka sama brauseri varasematele külastustele viimase 30 päeva jooksul.

// 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']);

Kasutage sisemist numbrit, mitte e-posti aadressi ega nime. MousePlayer näitab ID-d kõikjal, kus külastaja kuvatakse.

ID-de lugemine

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. Kohandatud sündmused

Teie saadetud sündmused ilmuvad taasesituse ajajoonele, võivad olla eesmärgid ja lehtri sammud ning jõuavad teie veebihaakidesse ja ühendatud tööriistadesse. Parameetrid on lühikesed väärtused: arvud, kuni 255 märgi pikkused stringid ja kuni 64 märgi pikkused võtmed.

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' }]);
  • Nimed: väiketähtedega ja allkriipsudega, kuni 128 märki. Kasutage sama asja jaoks kõikjal sama nime – eesmärk võrdleb nimesid täpselt.
  • Ärge lisage parameetritesse isikuandmeid. Neid talletatakse ja kuvatakse nagu kõiki teisi sündmusi.

5. Aadressimuutuseta sammud

Ostu vormistamine või viisard, mis muudab kuva, kuid mitte aadressi, on MousePlayeri jaoks üks leht. step() muudab iga kuva eraldi lehevaatamiseks – oma hetktõmmise, soojuskaardirea ja lehtrisammuga.

// 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']);

Nimi sisaldab 1 kuni 40 märki hulgast a-z, 0-9, _ ja -; tühikud muutuvad sidekriipsudeks, kõik muu lükatakse tagasi koos konsooli hoiatusega. Tegelik navigeerimine lõpetab sammu.

6. Toote kontekst

Teatage tootelehel MousePlayerile, mida vaadatakse. Lubatud on ainult need võtmed; kõik muu visatakse ära, et kliendiandmed kogemata kaasa ei läheks.

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. Haagid

Teie kood saab reageerida sellele, mida MousePlayer lehel mõõdab. Kui haak peab tabama juba esimese hetke, registreerige see järjekorra kaudu.

// 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);
NimiMillalVäljad
exit_risklahkumismudel on hinnanud esimest lehevaatamist (üks kord külastuse jooksul)risk, reasons, session
churn_risknaasev külastaja märgitakse tõenäoliselt lahkujaksrisk, reasons, session
offer_shownlahkumispakkumist näidatakseart, risk, grund, session
offer_clickselle nuppu klõpsatakseart, risk, grund, session, fehler
offer_dismisssee suletakseart, risk, grund, session
survey_shownküsitlus avanebsurvey, trigger, session
survey_answerkülastaja vastabsurvey, type, value, option, sentiment, session
survey_textjärelvastuse tekst saadetakse (juba filtreeritud)survey, text, session
survey_dismissküsitlus suletakse vastamatasurvey, step, session

Kui GTM-i sild on sisse lülitatud, lähevad samad sündmused ka dataLayerisse (mp_exit_risk jne). MousePlayer.exitRisk() tagastab praeguse lahkumisriski või null, kui see pole veel teada.

8. HTML-atribuudid

<!-- 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 (või klass mp-masked): elemendi sees olev tekst ja sisestus asendatakse enne brauserist lahkumist – hetktõmmises, muudatustes ja klõpsukirjeldustes.
  • data-mp-ignore (või mp-ignore) vormiväljal: selle väärtust ei salvestata üldse.
  • data-mp-role: üks järgmistest väärtustest: 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. Muid väärtusi eiratakse.

9. Enda külastuste välistamine

Avage sait üks kord parameetriga ?mp_exclude=1 ning seda brauserit enam ei salvestata; ?mp_exclude=0 tühistab selle. Terve kontorivõrgu välistamiseks sisestage selle asemel IP-aadressid projekti seadistustesse.

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 teie privaatsustingimustesse

Külastajad saavad näha ja kustutada enda kohta salvestatud andmeid. privacyUrl() tagastab valmis lingi selle brauseri ID-ga või null, kui ID-d pole, sest nõusolekuta ei salvestatud midagi.

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