JavaScript API

هر څه چې mp.js ستاسو خپل کوډ ته وړاندې کوي: رضایت، ستاسو د پېرودونکي ID، خپلې پېښې، د پتې له بدلېدو پرته پړاوونه، هوکونه او HTML ځانګړنې. دلته څه اړین نه دي؛ یوازې د کوډ ټوټه ثبت کوي.

1. د بللو دوه لارې

mp.js په ناهممهاله ډول بارېږي. هغه کوډ چې تر بارېدو مخکې چلېږي، خپلې بلنې په دې کتار کې ږدي: window.mp_q؛ mp.js چې راشي، پرې کار کوي. وروسته هماغه دندې پر دې شته: 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);

تل ولیکئ window.mp_q = window.mp_q || []، هېڅکله نه window.mp_q = []. mp.js هغې ارې ته غوږ نیولو ته دوام ورکوي؛ نوې ارې به هره راتلونکې بلنه تېر کړي، د رضایت بېرته اخیستل هم.

د نصب د کوډ ټوټه دا لنډمهالی ځای‌ناستی هم تعریفوي: mp(...) چې په هماغه ډول کتاروي. دواړه بڼې هماغه امرونه اخلي: consent، set، event، step، get، on او off.

2. رضایت

له رضایت پرته څه نه ثبتېږي. که ستاسو د رضایت وسیله MousePlayer پېژني، له دې هېڅ ته اړتیا نه لرئ؛ که نه، پرېکړه پخپله ورولېږئ.

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'

بېرته اخیستل پر پاڼه سمدستي اغېز کوي: اورېدونکي لرې کېږي، زېرمه شوي معلومات غورځېږي او نښلونه تړل کېږي. وګورئ MousePlayer او رضایت.

3. ستاسو د پېرودونکي ID

په خپل ID سره د یوه کس ټولې وسیلې په لېستونو کې یو لیدونکی کېږي، او د مرستې قضیه په هغه شمېره لټولی شئ چې پېژنئ یې. ID د هماغه براوزر د تېرو 30 ورځو پر پخوانیو لیدنو هم پلي کېږي.

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

دنننۍ شمېره وکاروئ، نه برېښنالیک پته او نه نوم. MousePlayer هر ځای چې لیدونکی ښکاري، ID ښيي.

د ID بېرته لوستل

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. خپلې پېښې

هغه پېښې چې لېږئ، د بیا غږونې په مهال‌کرښه کې ښکاري، موخې او د فنل پړاوونه کېدای شي او ستاسو وېبهوکونو او تړلو وسایلو ته ځي. پارامترونه لنډ ارزښتونه دي: عددونه، تر 255 نښو متنونه، تر 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' }]);
  • نومونه: کوچني توري له لاندې کرښو سره، تر ټولو ډېر 128 نښې. د هماغه شي لپاره هر ځای هماغه نوم وکاروئ؛ موخه نومونه په عین ډول برابروي.
  • په پارامترونو کې شخصي معلومات مه ږدئ. د بلې هرې پېښې په شان ساتل او ښودل کېږي.

5. د پتې له بدلېدو پرته پړاوونه

د پېر بشپړول یا لارښود چې پرده بدلوي خو پته نه، MousePlayer ته یوه پاڼه ده. step() هره پرده خپله د پاڼې کتنه ګرځوي، له خپل انځور، د حرارتي نقشې کرښې او د فنل پړاو سره.

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

نوم له 1 تر 40 نښو دی، له a-z، 0-9، _ او - څخه؛ تشې په نښلوونکو کرښو بدلېږي، نور هر څه د کنسول په خبرتیا ردېږي. رښتینی تګ پړاو پای ته رسوي.

6. د محصول سیاق

د محصول پر پاڼه MousePlayer ته ووایئ چې څه کتل کېږي. یوازې دا کیليانې منل کېږي؛ نور هر څه غورځېږي، څو د پېرودونکي معلومات په تصادف ورننوځي نه.

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. هوکونه

ستاسو کوډ هغه څه ته غبرګون ښودلی شي چې MousePlayer یې پر پاڼه اندازه کوي. که هوک باید لومړۍ شېبه له لاسه ورنه کړي، د کتار له لارې یې ثبت کړئ.

// 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);
نومکلهځایونه
exit_riskد وتلو ماډل د لومړۍ پاڼې کتنې ته نمره ورکړې (په هره لیدنه کې یو ځل)risk, reasons, session
churn_riskبېرته راتلونکی لیدونکی د بېرته نه راتلو د ډېر احتمال په توګه نښه کېږيrisk, reasons, session
offer_shownد وتلو وړاندیز ښودل کېږيart, risk, grund, session
offer_clickتڼۍ یې کلیک کېږيart, risk, grund, session, fehler
offer_dismissتړل کېږيart, risk, grund, session
survey_shownسروې پرانیستل کېږيsurvey, trigger, session
survey_answerلیدونکی ځواب ورکويsurvey, type, value, option, sentiment, session
survey_textتعقیبي متن لېږل کېږي (لا چاڼ شوی)survey, text, session
survey_dismissسروې له ځواب پرته تړل کېږيsurvey, step, session

چې د GTM پُل فعال وي، هماغه پېښې dataLayer ته هم ځي (mp_exit_risk او داسې نور). MousePlayer.exitRisk() د وتلو اوسنی خطر بېرته ورکوي، یا null تر هغې چې معلوم شي.

8. 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 (یا ټولګی mp-masked): د عنصر دننه متن او لیکنې تر براوزر څخه وتلو مخکې بدلېږي، په انځور، بدلونونو او د کلیک په تشریحاتو کې.
  • data-mp-ignore (یا mp-ignore) د فورم پر ځای: ارزښت یې هېڅ نه ثبتېږي.
  • 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 څخه یو. نور ارزښتونه له پامه غورځېږي.

9. خپلې لیدنې ایستل

خپله وېبپاڼه یو ځل له دې سره پرانیزئ: ?mp_exclude=1 او دا براوزر نور نه ثبتېږي؛ ?mp_exclude=0 دا بېرته لغوه کوي. د دفتر د ټولې شبکې لپاره، پر ځای یې IP پتې د پروژې په امستنو کې ولیکئ.

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. ستاسو د محرمیت تګلارې لپاره لینک

لیدونکي هغه څه لیدلی او ړنګولی شي چې په اړه یې ثبت شوي دي. privacyUrl() د دې براوزر له ID سره چمتو لینک بېرته ورکوي، یا null که هېڅ نه وي، ځکه له رضایت پرته څه نه دي ثبت شوي.

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