API JavaScript

Gach rud a chuireann mp.js ar fáil do do chód féin: toiliú, d’aitheantas custaiméara, imeachtaí saincheaptha, céimeanna gan athrú seolta, crúcaí agus tréithe HTML. Níl aon rud anseo riachtanach — taifeadann an blúire cóid leis féin.

1. Dhá bhealach lena ghlaoch

Lódálann mp.js go haisioncrónach. Cuireann cód a ritheann sula mbíonn sé lódáilte a ghlaonna sa scuaine window.mp_q; próiseálann mp.js í a luaithe a bhíonn sé ar fáil. Ina dhiaidh sin tá na feidhmeanna céanna ar fáil ar 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);

Scríobh i gcónaí window.mp_q = window.mp_q || [], agus ná scríobh riamh window.mp_q = []. Leanann mp.js ag éisteacht leis an eagar sin — shlogfadh eagar nua gach glao níos déanaí, aistarraingt toilithe san áireamh.

Sainmhíníonn an blúire suiteála feidhm ionaid freisin, mp(...) a chuireann glaonna sa scuaine ar an mbealach céanna. Glacann an dá fhoirm leis na horduithe céanna: consent, set, event, step, get, on agus off.

2. Toiliú

Gan toiliú ní thaifeadtar aon rud. Má aithníonn MousePlayer d’uirlis toilithe, ní theastaíonn aon rud de seo uait; murach sin, cuir an cinneadh ar aghaidh tú féin.

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'

Bíonn éifeacht láithreach ag aistarraingt ar an leathanach: baintear éisteoirí, caitear amach sonraí sa mhaolán agus dúntar an nasc. Féach MousePlayer agus toiliú.

3. D’aitheantas custaiméara

Le haitheantas de do chuid féin, déantar cuairteoir amháin sna liostaí de ghléasanna uile duine amháin, agus is féidir cás tacaíochta a chuardach leis an uimhir atá ar eolas agat. Cuirtear an t-aitheantas i bhfeidhm freisin ar chuairteanna roimhe sin ón mbrabhsálaí céanna le 30 lá anuas.

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

Úsáid uimhir inmheánach, seachas seoladh ríomhphoist nó ainm. Taispeánann MousePlayer an t-aitheantas cibé áit a mbíonn an cuairteoir le feiceáil.

Aitheantais a léamh ar ais

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. Imeachtaí saincheaptha

Bíonn imeachtaí a sheolann tú le feiceáil in amlíne an athsheinnte, is féidir iad a úsáid mar spriocanna agus céimeanna tonnadóra, agus téann siad chuig do Webhooks agus uirlisí nasctha. Is luachanna gearra iad paraiméadair: uimhreacha, teaghráin suas le 255 carachtar, eochracha suas le 64 carachtar.

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' }]);
  • Ainmneacha: litreacha beaga le fostríocanna, 128 carachtar ar a mhéad. Úsáid an t-ainm céanna don rud céanna i ngach áit — meaitseálann sprioc ainmneacha go beacht.
  • Ná cuir sonraí pearsanta i bparaiméadair. Stóráiltear agus taispeántar iad mar aon imeacht eile.

5. Céimeanna gan athrú seolta

Measann MousePlayer gur leathanach amháin é seiceáil amach nó draoi a athraíonn a scáileán ach nach n-athraíonn a sheoladh. step() déanann sé amharc leathanaigh ar leith de gach scáileán — lena léargas, ró sa léarscáil teasa agus céim tonnadóra féin.

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

Bíonn idir 1 agus 40 carachtar in ainm, as a-z, 0-9, _ agus -; déantar fleiscíní de spásanna, agus diúltaítear d’aon rud eile le rabhadh sa chonsól. Críochnaíonn nascleanúint iarbhír an chéim.

6. Comhthéacs táirge

Ar leathanach táirge, inis do MousePlayer cad atá á bhreathnú. Ní ghlactar ach leis na heochracha seo; caitear amach gach rud eile ionas nach sleamhnaíonn sonraí custaiméara isteach trí thimpiste.

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. Crúcaí

Is féidir le do chód freagairt don mhéid a thomhaiseann MousePlayer ar an leathanach. Cláraigh tríd an scuaine más gá don chrúca an chéad nóiméad a ghabháil.

// 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);
AinmCathainRéimsí
exit_risktá scór tugtha ag an tsamhail imeachta don chéad amharc leathanaigh (uair amháin sa chuairt)risk, reasons, session
churn_riskmarcáiltear cuairteoir atá ag filleadh mar dhuine ar dócha go n-imeodh sérisk, reasons, session
offer_showntaispeántar an tairiscint imeachtaart, risk, grund, session
offer_clickcliceáiltear a cnaipeart, risk, grund, session, fehler
offer_dismissdúntar íart, risk, grund, session
survey_shownosclaítear suirbhésurvey, trigger, session
survey_answerfreagraíonn an cuairteoirsurvey, type, value, option, sentiment, session
survey_textseoltar an téacs leantach (scagtha cheana)survey, text, session
survey_dismissdúntar an suirbhé gan freagrasurvey, step, session

Nuair atá droichead GTM ar siúl, téann na himeachtaí céanna isteach sa dataLayer freisin (mp_exit_risk agus mar sin de). MousePlayer.exitRisk() tugann sé an riosca imeachta reatha ar ais, nó null sula mbíonn sé ar eolas.

8. Tréithe 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 (nó an rang mp-masked): athsholáthraítear téacs agus ionchur laistigh den eilimint sula bhfágann siad an brabhsálaí — sa léargas, sna hathruithe agus sna tuairiscí cliceála.
  • data-mp-ignore (nó mp-ignore) ar réimse foirme: ní thaifeadtar a luach ar chor ar bith.
  • data-mp-role: ceann de 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. Déantar neamhaird de luachanna eile.

9. Do chuairteanna féin a eisiamh

Oscail do shuíomh uair amháin le ?mp_exclude=1 agus ní thaifeadtar an brabhsálaí seo a thuilleadh; ?mp_exclude=0 cuireann sé sin ar ceal. I gcás líonra oifige iomláin, cuir na seoltaí IP isteach i socruithe an tionscadail ina ionad.

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. Nasc do do pholasaí príobháideachais

Is féidir le cuairteoirí an méid a taifeadadh fúthu a fheiceáil agus a scriosadh. privacyUrl() tugann sé an nasc réidh ar ais le haitheantas an bhrabhsálaí seo — nó null mura bhfuil ceann ann, toisc nár taifeadadh aon rud gan toiliú.

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