JavaScript API

mp.js ඔබේම කේතයට දෙන සියල්ල: කැමැත්ත, ඔබේ පාරිභෝගික අංකය, අභිරුචි සිදුවීම්, ලිපිනය වෙනස් නොවන පියවර, hook සහ 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. ඔබේ පාරිභෝගික හඳුනාගැනීමේ අංකය

ඔබේම අංකයකින් එක් පුද්ගලයකුගේ සියලු උපාංග ලැයිස්තුවල එක් අමුත්තකු වන අතර දන්නා අංකයෙන් සහාය සිද්ධියක් සෙවිය හැකිය. එම අංකය පසුගිය දින 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 එම අංකය පෙන්වයි.

අංක ආපසු කියවීම

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. අභිරුචි සිදුවීම්

ඔබ යවන සිදුවීම් නැවත ධාවන කාලරේඛාවේ පෙනේ, ඉලක්ක සහ funnel පියවර විය හැකි අතර webhook සහ සම්බන්ධ මෙවලම් වෙත යයි. පරාමිති කෙටි අගයන්ය: සංඛ්‍යා, උපරිම අක්ෂර 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. ලිපිනය වෙනස් නොවන පියවර

තිරය වෙනස් කරන නමුත් ලිපිනය වෙනස් නොකරන checkout හෝ මඟපෙන්වීමක් MousePlayer ට එක් පිටුවකි. step() සෑම තිරයක්ම තමන්ගේ සැණරුව, තාප සිතියම් පේළිය සහ funnel පියවර සහිත වෙනම පිටු දසුනක් කරයි.

// 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. 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 bridge සක්‍රිය විට එම සිදුවීම්ම 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() මෙම බ්‍රවුසරයේ අංකය සහිත සූදානම් සබැඳිය හෝ අංකයක් නැතිනම් null ලබා දෙයි; කැමැත්ත නැතිව කිසිවක් පටිගත නොවූ නිසාය.

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