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తో ఒక వ్యక్తి పరికరాలన్నీ జాబితాల్లో ఒకే సందర్శకుడిగా మారతాయి; మీకు తెలిసిన సంఖ్యతో సహాయ కేసును వెతకవచ్చు. గత 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. అనుకూల ఈవెంట్‌లు

మీరు పంపే ఈవెంట్‌లు రీప్లే టైమ్‌లైన్‌లో కనిపిస్తాయి, లక్ష్యాలు, ఫన్నెల్ దశలు కావచ్చు; మీ వెబ్‌హుక్‌లు, అనుసంధానించిన సాధనాలకు వెళ్తాయి. పారామీటర్‌లు చిన్న విలువలు: సంఖ్యలు, గరిష్ఠంగా 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తో సిద్ధంగా ఉన్న లింక్‌ను ఇస్తుంది - ID లేకపోతే null; ఎందుకంటే సమ్మతి లేకుండా ఏమీ రికార్డ్ కాలేదు.

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