JavaScript API

mp.js توهان جي ڪوڊ کي جيڪي ڏئي ٿو: رضامندي، گراهڪ ID، پنهنجي ٺاهيل واقعا، پتو بدلائڻ کان سواءِ قدم، hook ۽ HTML attribute. هتي ڪجهه به ضروري ناهي — اڪيلو سنيپٽ رڪارڊ ڪري ٿو.

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 انهيءَ array تي ٻڌندو رهي ٿو — نئين array هر پوئين ڪال ڳڙڪائي ڇڏيندي، رضامندي واپس وٺڻ به.

انسٽاليشن سنيپٽ هي stub به ٺاهي ٿو 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'

واپس وٺڻ صفحي تي فوري لاڳو ٿئي ٿو: listener هٽن، بفر جي ڊيٽا رد ٿئي ۽ رابطو بند ٿئي ٿو. ڏسو MousePlayer ۽ رضامندي.

3. توهان جو گراهڪ ID

پنهنجي ID سان هڪ ماڻهو جا سڀ اوزار فهرستن ۾ هڪ مهمان ٿين ٿا، ۽ ڄاتل نمبر سان مدد جو ڪيس ڳولي سگهو ٿا. ساڳئي برائوزر جي گذريل 30 ڏينهن جي اڳين آمدن تي به ID لاڳو ٿئي ٿو.

// 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. پنهنجي ٺاهيل واقعا

موڪليل واقعا ٻيهر پلے جي ٽائم لائن ۾ اچن ٿا، مقصد ۽ فنل قدم ٿي سگهن ٿا، ۽ webhook ۽ ڳنڍيل اوزارن ڏانهن وڃن ٿا. پيراميٽر مختصر قدر آهن: انگ، 255 اکرن تائين متن، 64 اکرن تائين key.

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' }]);
  • نالا: ننڍا اکر ۽ underscore، وڌ ۾ وڌ 128 اکر. ساڳي شيءِ لاءِ هر هنڌ ساڳيو نالو رکو — مقصد نالا بلڪل ملائي ٿو.
  • پيراميٽرن ۾ ذاتي ڊيٽا نه رکو. ٻين واقعن وانگر محفوظ ۽ ڏيکارجن ٿا.

5. پتو بدلائڻ کان سواءِ قدم

چيڪ آئوٽ يا wizard اسڪرين بدلائي پر پتو نه، ته 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']);

نالو a-z مان 1 کان 40 اکرن جو، 0-9، _ ۽ - سان آهي؛ خالي جايون hyphen ٿين ٿيون، ٻيو ڪجهه ڪنسول جي خبرداري سان رد ٿئي ٿو. حقيقي نيويگيشن قدم ختم ڪري ٿي.

6. پراڊڪٽ جو پس منظر

پراڊڪٽ صفحي تي MousePlayer کي ٻڌايو ته ڇا ڏٺو پيو وڃي. رڳو هي key قبول آهن؛ ٻيو سڀ رد ٿئي ٿو ته گراهڪ جي ڊيٽا اتفاق سان نه اچي.

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

توهان جو ڪوڊ صفحي تي MousePlayer جي ماپيل شيءِ تي ردعمل ڏئي سگهي ٿو. Hook پهريون لمحو نه وڃائي ته قطار مان رجسٽر ڪريو.

// 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 attribute

<!-- 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 (يا هي class 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;