JavaScript API

mp.js-iň öz koduňyza berýän ähli zady: razylyk, müşderi ID-ňiz, ýörite wakalar, salgy üýtgemezden ädimler, hook-lar we HTML häsiýetleri. Bu ýerde hiç zat hökmany däl - diňe kod böleginiň özi ýazga alýar.

1. Çagyrmagyň iki ýoly

mp.js asinkron ýüklenýär. Ýüklenmezden öň işleýän kod çagyryşlaryny şu nobata goýýar: window.mp_q; mp.js gelen badyna olary işleýär. Soň şol funksiýalar şu obýektde elýeterli: 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);

Hemişe şuny ýazyň: window.mp_q = window.mp_q || [], hiç haçan şuny däl: window.mp_q = []. mp.js şol massiwde diňlemegini dowam etdirýär - täzesi soňraky ähli çagyryşlary, şol sanda razylygy yzyna almagy ýuwudardy.

Gurnama kod bölegi şu wagtlaýyn funksiýany hem kesgitleýär: mp(...) , ol şol bir usulda nobata goýýar. Iki görnüş hem şol bir buýruklary alýar: consent, set, event, step, get, on we off.

2. Razylyk

Razylyksyz hiç zat ýazylmaýar. Razylyk guralyňyz MousePlayer-iň tanaýanlarynyň biri bolsa, bu zatlar gerek däl; ýogsam karary özüňiz geçiriň.

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'

Razylygy yzyna almak sahypada derrew täsir edýär: diňleýjiler aýrylýar, bufer maglumatlary taşlanýar, birikme ýapylýar. Serediň: MousePlayer we razylyk.

3. Müşderi ID-ňiz

Öz ID-ňiz bilen bir adamyň ähli enjamlary sanawlarda bir myhmana öwrülýär we goldaw işini bilýän belgiňiz boýunça gözläp bilersiňiz. ID şol brauzeriň soňky 30 gündäki öňki saparlaryna hem ulanylýar.

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

E-poçta ýa-da at däl-de, içerki belgi ulanyň. MousePlayer myhman görünýän her ýerde ID-ni görkezýär.

ID-leri yzyna okamak

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. Ýörite wakalar

Iberýän wakalaryňyz ýazgynyň wagt çyzygynda görünýär, maksat we guýguç ädimi bolup biler, webhook-laryňyza we birikdirilen gurallara gidýär. Parametrler gysga bahalardyr: sanlar, 255 nyşana çenli setirler, 64 nyşana çenli açarlar.

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' }]);
  • Atlar: aşaky çyzykly kiçi harplar, iň köp 128 nyşan. Şol bir zat üçin hemme ýerde şol bir ady ulanyň - maksat atlary takyk gabatlaşdyrýar.
  • Parametrlere şahsy maglumat goşmaň. Olar beýleki wakalar ýaly saklanýar we görkezilýär.

5. Salgy üýtgemezden ädimler

Ekranyny üýtgedip, salgysyny üýtgetmeýän töleg ýa-da kömekçi MousePlayer üçin bir sahypadyr. step() her ekrany öz suraty, ýylylyk karta setiri we guýguç ädimi bolan aýratyn sahypa görnüşine öwürýär.

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

At 1-den 40-a çenli nyşan bolup, a-z, 0-9, _ we - ulanylýar; boşluklar defise öwrülýär, beýleki zatlar konsolda duýduryş bilen ret edilýär. Hakyky nawigasiýa ädimi tamamlaýar.

6. Önüm konteksti

Önüm sahypasynda nämä seredilýändigini MousePlayer-e aýdyň. Diňe şu açarlar kabul edilýär; müşderi maglumatlary tötänden girmez ýaly galan zatlar taşlanýar.

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. Hook-lar

Koduňyz MousePlayer-iň sahypada ölçeýän zatlaryna jogap berip biler. Hook ilkinji pursady sypdyrmaly däl bolsa, nobat arkaly bellige alyň.

// 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);
AtHaçanMeýdanlar
exit_riskçykmak modeli ilkinji sahypa görnüşine bal berdi (her sapara bir gezek)risk, reasons, session
churn_riskgaýdyp gelen myhman gaýdyp gelmezligi ähtimal hökmünde bellendirisk, reasons, session
offer_shownçykmak teklibi görkezilýärart, risk, grund, session
offer_clickonuň düwmesine basylýarart, risk, grund, session, fehler
offer_dismissol ýapylýarart, risk, grund, session
survey_shownpikir soraşma açylýarsurvey, trigger, session
survey_answermyhman jogap berýärsurvey, type, value, option, sentiment, session
survey_textgoşmaça tekst iberilýär (eýýäm süzülen)survey, text, session
survey_dismisspikir soraşma jogapsyz ýapylýarsurvey, step, session

GTM köprüsi açyk bolsa, şol wakalar dataLayer-e hem gidýär (mp_exit_risk we ş.m.). MousePlayer.exitRisk() häzirki çykmak töwekgelçiligini ýa-da entek belli däl bolsa null gaýtarýar.

8. HTML häsiýetleri

<!-- 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 (ýa-da şu synp: mp-masked): elementiň içindäki tekst we giriş brauzerden çykmazdan öň çalşylýar - suratda, üýtgeşmelerde we basyş düşündirişlerinde.
  • data-mp-ignore (ýa-da mp-ignore) forma meýdanynda: onuň bahasy asla ýazylmaýar.
  • data-mp-role: 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 bahalarynyň biri. Beýleki bahalar äsgerilmeýär.

9. Öz saparlaryňyzy aýyrmak

Saýtyňyzy bir gezek şu parametr bilen açyň: ?mp_exclude=1 we bu brauzer indi ýazylmaýar; ?mp_exclude=0 muny ýatyrýar. Tutuş ofis tory üçin ýerine IP salgylaryny taslama sazlamalaryna giriziň.

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. Gizlinlik syýasatyňyz üçin baglanyşyk

Myhmanlar özleri barada ýazylan zady görüp we pozup biler. privacyUrl() şu brauzeriň ID-si bilen taýýar baglanyşygy ýa-da ID ýok bolsa null gaýtarýar, sebäbi razylyksyz hiç zat ýazylmady.

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