JavaScript API

Kila kinachotolewa na mp.js kwa msimbo wako mwenyewe: idhini, ID yako ya mteja, matukio maalumu, hatua bila mabadiliko ya anwani, hook na sifa za HTML. Hakuna hapa kinachohitajika; kipande cha msimbo pekee hurekodi.

1. Njia mbili za kuiita

mp.js hupakiwa kwa kujitegemea. Msimbo unaoendeshwa kabla haijapakiwa huweka miito yake katika foleni ya window.mp_q; mp.js huipitia mara inapopatikana. Baadaye vitendakazi vilevile hupatikana katika window.MousePlayer kama kitu cha jumla.

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

Andika kila wakati window.mp_q = window.mp_q || [], kamwe si window.mp_q = [] kama safu mpya. mp.js huendelea kusikiliza katika safu hiyo; mpya ingemeza kila mwito wa baadaye, pamoja na kuondoa idhini.

Kipande cha msimbo cha usakinishaji pia hubainisha kitendakazi cha muda cha mp(...) kinachoweka foleni kwa njia ileile. Mifumo yote miwili hupokea amri zilezile: consent, set, event, step, get, on na off kama amri.

2. Idhini

Bila idhini hakuna kinachorekodiwa. Ikiwa zana yako ya idhini ni mojawapo inayotambuliwa na MousePlayer, huhitaji lolote kati ya haya; vinginevyo peleka uamuzi mwenyewe.

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'

Kuondoa idhini huanza kutumika katika ukurasa mara moja: visikilizaji huondolewa, data za bafa hutupwa, muunganisho hufungwa. Ona MousePlayer na idhini kwa maelezo.

3. ID yako ya mteja

Kwa ID yako mwenyewe, vifaa vyote vya mtu mmoja huwa mtembeleaji mmoja katika orodha, na unaweza kutafuta ombi la usaidizi kwa nambari unayoijua. ID pia hutumika kwa ziara za awali za kivinjari kilekile za siku 30 zilizopita.

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

Tumia nambari ya ndani, si anwani ya barua pepe au jina. MousePlayer huonyesha ID popote mtembeleaji anapoonekana.

Kusoma ID kutoka mfumo

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. Matukio maalumu

Matukio unayotuma huonekana katika mstari wa muda wa uchezaji tena, yanaweza kuwa malengo na hatua za faneli, na huenda kwenye webhook zako na zana zilizounganishwa. Vigezo ni thamani fupi: nambari, maandishi hadi herufi 255, funguo hadi herufi 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' }]);
  • Majina: herufi ndogo zenye vistari vya chini, herufi zisizozidi 128. Tumia jina lilelile kwa jambo lilelile kila mahali; lengo hulinganisha majina sawasawa.
  • Usiweke data binafsi katika vigezo. Huhifadhiwa na kuonyeshwa kama tukio lingine lolote.

5. Hatua bila mabadiliko ya anwani

Mchakato wa kukamilisha ununuzi au mchawi unaobadilisha skrini yake bila anwani yake ni ukurasa mmoja kwa MousePlayer. step() hufanya kila skrini kuwa utazamaji wake wenyewe wa ukurasa, wenye picha yake, mstari wa ramani ya joto na hatua ya faneli.

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

Jina ni herufi 1 hadi 40 kutoka a-z, 0-9, _ na -; nafasi tupu huwa vistari, kingine chochote hukataliwa kwa onyo katika konsoli. Urambazaji halisi humaliza hatua.

6. Muktadha wa bidhaa

Katika ukurasa wa bidhaa, iambie MousePlayer kinachotazamwa. Funguo hizi tu ndizo zinazokubaliwa; vingine vyote hutupwa ili data za mteja zisiingie kwa bahati mbaya.

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

Msimbo wako unaweza kuitikia kinachopimwa na MousePlayer katika ukurasa. Sajili kupitia foleni ikiwa hook haipaswi kukosa wakati wa kwanza.

// 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);
JinaWakatiSehemu
exit_riskmodeli ya kuondoka imetoa alama kwa utazamaji wa kwanza wa ukurasa (mara moja kwa ziara)risk, reasons, session
churn_riskmtembeleaji anayerejea amewekewa alama kuwa ana uwezekano wa kutorudirisk, reasons, session
offer_shownpendekezo la kuondoka linaonyeshwaart, risk, grund, session
offer_clickkitufe chake kinabofyiwaart, risk, grund, session, fehler
offer_dismisslinafungwaart, risk, grund, session
survey_shownutafiti unafungukasurvey, trigger, session
survey_answermtembeleaji anajibusurvey, type, value, option, sentiment, session
survey_textmaandishi ya kufuatilia yanatumwa (tayari yamechujwa)survey, text, session
survey_dismissutafiti unafungwa bila jibusurvey, step, session

Daraja la GTM likiwashwa, matukio yaleyale pia huingia katika dataLayer (mp_exit_risk na mengineyo). MousePlayer.exitRisk() hurudisha hatari ya sasa ya kuondoka, au null kabla haijajulikana.

8. Sifa za 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 (au darasa la mp-masked): maandishi na ingizo ndani ya kipengele hubadilishwa kabla ya kutoka katika kivinjari, katika picha ya ukurasa, mabadiliko na maelezo ya mibofyo.
  • data-mp-ignore (au mp-ignore) katika sehemu ya fomu: thamani yake hairekodiwi kabisa.
  • data-mp-role: mojawapo ya 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. Thamani nyingine hupuuzwa.

9. Kutenga ziara zako mwenyewe

Fungua tovuti yako mara moja kwa ?mp_exclude=1 na kivinjari hiki hakirekodiwi tena; ?mp_exclude=0 hutengua hilo. Kwa mtandao wa ofisi nzima, weka anwani za IP katika mipangilio ya mradi badala yake.

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. Kiungo cha sera yako ya faragha

Watembeleaji wanaweza kuona na kufuta kilichorekodiwa kuwahusu. privacyUrl() hurudisha kiungo kilicho tayari chenye ID ya kivinjari hiki, au null ikiwa hakuna, kwa sababu bila idhini hakuna kilichorekodiwa.

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