JavaScript API

Duk abin da mp.js yake bayarwa ga lambar wurin: yarda, ID na abokin ciniki, abubuwan da suka faru na musamman, matakai ba tare da sauya adireshi ba, hooks da siffofin HTML. Ba a buƙatar komai a nan - snippet kaɗai yana rikodi.

1. Hanyoyin kira guda biyu

mp.js yana lodi ba tare da riƙe sauran aiki ba. Lambar da take gudana kafin ya gama lodi tana saka kiranta cikin layin window.mp_q; mp.js yana bi ta ciki da zarar ya iso. Daga baya ayyukan ɗaya suna samuwa a 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);

A rubuta window.mp_q = window.mp_q || []ko yaushe, kada a rubuta window.mp_q = []. mp.js yana ci gaba da sauraron wannan array - sabuwa za ta haɗiye kowane kira daga baya, har da janye yarda.

Snippet na girkawa yana kuma ayyana stub na mp(...) da yake saka kira a layi ta hanya ɗaya. Duka siffofin suna ɗaukar umarni ɗaya: consent, set, event, step, get, on da off.

2. Yarda

Ba tare da yarda ba ba a rikoda komai. Idan kayan yarda suna cikin waɗanda MousePlayer yake ganewa, ba a buƙatar wannan; in ba haka ba a miƙa shawarar da hannu.

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'

Janye yarda yana fara aiki a shafi nan take: ana cire masu sauraro, ana watsar da bayanan buffer, ana rufe haɗi. Duba MousePlayer da yarda.

3. ID na abokin ciniki na wurin

Da ID na wurin, duk na’urorin mutum ɗaya suna zama baƙo ɗaya a jerin, kuma ana iya neman shari’ar taimako da lambar da aka sani. Ana kuma jingina ID ga ziyarar da ta gabata ta burauza ɗaya daga kwanaki 30 na ƙarshe.

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

A yi amfani da lambar ciki, ba adireshin imel ko suna ba. MousePlayer yana nuna ID duk inda baƙo ya bayyana.

Karanta IDs daga baya

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. Abubuwan da suka faru na musamman

Abubuwan da aka aika suna bayyana a jadawalin lokacin sake kunnawa, suna iya zama manufofi da matakan funnel, kuma suna zuwa webhooks da kayan aikin da aka haɗa. Sigogi ƙimomi gajeru ne: lambobi, rubutu har haruffa 255, mabuɗai har haruffa 64.

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' }]);
  • Sunaye: ƙananan haruffa tare da underscores, iyakar haruffa 128. A yi amfani da suna ɗaya don abu ɗaya ko’ina - manufa tana daidaita sunaye daidai.
  • Kada a saka bayanan mutum cikin sigogi. Ana adana su ana nuna su kamar kowane abin da ya faru.

5. Matakai ba tare da sauya adireshi ba

Checkout ko wizard da yake sauya allonsa amma ba adireshinsa ba shafi ɗaya ne ga MousePlayer. step() yana sa kowane allo ya zama kallon shafi nasa - da hotonsa, layin taswirar zafi da matakin funnel nasa.

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

Suna yana da haruffa 1 zuwa 40 daga a-z, 0-9, _ da -; sarari yana zama layin haɗawa, ana ƙin duk sauran da gargaɗi a console. Zirga-zirga ta zahiri tana ƙare matakin.

6. Mahallin samfuri

A shafin samfuri, a sanar da MousePlayer abin da ake kallo. Waɗannan mabuɗai kaɗai ake karɓa; ana watsar da duk sauran don kada bayanan abokin ciniki su shiga bisa kuskure.

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

Lambar wurin tana iya amsawa ga abin da MousePlayer yake aunawa a shafi. A yi rajista ta layi idan hook ba zai rasa farkon lokaci ba.

// 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);
SunaLokaciFilaye
exit_risksamfurin fita ya ba kallon shafi na farko maki (sau ɗaya a ziyara)risk, reasons, session
churn_riskan yi wa baƙo mai dawowa alamar mai yiwuwar daina dawowarisk, reasons, session
offer_shownan nuna tayin fitaart, risk, grund, session
offer_clickan danna maɓallinsaart, risk, grund, session, fehler
offer_dismissan rufe shiart, risk, grund, session
survey_shownan buɗe binciken ra’ayisurvey, trigger, session
survey_answerbaƙo ya amsasurvey, type, value, option, sentiment, session
survey_textan aika rubutun bin diddigi (an riga an tace)survey, text, session
survey_dismissan rufe binciken ra’ayi ba tare da amsa basurvey, step, session

Idan gadar GTM tana kunne, abubuwan ɗaya suna kuma shiga dataLayer (mp_exit_risk da sauransu). MousePlayer.exitRisk() yana mayar da haɗarin fita na yanzu, ko null kafin a san shi.

8. Siffofin HTML

<!-- 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 (ko class na mp-masked): ana maye gurbin rubutu da shigarwa a cikin abin kafin su bar burauza - a hoton shafi, a sauye-sauye da bayanan dannawa.
  • data-mp-ignore (ko mp-ignore) a filin fom: ba a rikodin ƙimarsa kwata-kwata.
  • data-mp-role: ɗaya daga 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. Ana yin watsi da sauran ƙimomi.

9. Keɓe ziyarar wurin kansa

A buɗe gidan yanar gizo sau ɗaya da ?mp_exclude=1 kuma ba a sake rikodin wannan burauza; ?mp_exclude=0 yana warware hakan. Don cibiyar sadarwar ofis gaba ɗaya, a shigar da adiresoshin IP a saitunan aiki maimakon haka.

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. Hanya don manufar sirri

Baƙi suna iya gani da goge abin da aka rikoda game da su. privacyUrl() yana mayar da hanyar da aka shirya da ID na wannan burauza - ko null idan babu, domin ba tare da yarda ba ba a rikoda komai.

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