API JavaScript

Popeth mae mp.js yn ei gynnig i’ch cod eich hun: cydsyniad, eich ID cwsmer, digwyddiadau personol, camau heb newid cyfeiriad, bachau a phriodoleddau HTML. Nid oes angen dim yma – mae’r pyt ar ei ben ei hun yn recordio.

1. Dwy Ffordd i’w Alw

Mae mp.js yn llwytho’n anghydamserol. Mae cod sy’n rhedeg cyn iddo lwytho yn rhoi ei alwadau yn y ciw window.mp_q; mae mp.js yn gweithio drwyddo cyn gynted ag y bydd yno. Wedyn mae’r un swyddogaethau ar gael 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);

Ysgrifennwch window.mp_q = window.mp_q || [] bob amser, byth window.mp_q = []. Mae mp.js yn dal i wrando ar yr arae honno – byddai un newydd yn llyncu pob galwad ddiweddarach, gan gynnwys tynnu cydsyniad yn ôl.

Mae’r pyt gosod hefyd yn diffinio bonyn mp(...) sy’n rhoi mewn ciw yr un ffordd. Mae’r ddwy ffurf yn cymryd yr un gorchmynion: consent, set, event, step, get, on a off.

2. Cydsyniad

Heb gydsyniad ni recordir dim. Os yw eich offeryn cydsynio yn un y mae MousePlayer yn ei adnabod, nid oes angen dim o hyn arnoch; fel arall trosglwyddwch y penderfyniad eich hun.

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'

Mae tynnu’n ôl yn dod i rym ar y dudalen ar unwaith: tynnir gwrandawyr, taflir data yn y byffer, caeir y cysylltiad. Gweler MousePlayer a chydsyniad.

3. Eich ID Cwsmer

Gydag ID eich hun, daw holl ddyfeisiau un person yn un ymwelydd yn y rhestrau, a gallwch chwilio am achos cymorth drwy’r rhif rydych yn ei wybod. Cymhwysir yr ID hefyd i ymweliadau cynharach yr un porwr o’r 30 diwrnod diwethaf.

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

Defnyddiwch rif mewnol, nid cyfeiriad e-bost nac enw. Mae MousePlayer yn dangos yr ID lle bynnag mae’r ymwelydd yn ymddangos.

Darllen IDs yn Ôl

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. Digwyddiadau Personol

Mae digwyddiadau rydych yn eu hanfon yn ymddangos yn llinell amser yr ailchwarae, gallant fod yn nodau a chamau twndis, ac maent yn mynd i’ch webhooks a’ch offer cysylltiedig. Gwerthoedd byr yw paramedrau: rhifau, llinynnau hyd at 255 nod, allweddi hyd at 64 nod.

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' }]);
  • Enwau: llythrennau bach â thanlinellau, hyd at 128 nod. Defnyddiwch yr un enw am yr un peth ym mhobman – mae nod yn paru enwau’n union.
  • Peidiwch â rhoi data personol mewn paramedrau. Cânt eu storio a’u dangos fel unrhyw ddigwyddiad arall.

5. Camau Heb Newid Cyfeiriad

Mae desg dalu neu ddewin sy’n newid ei sgrin ond nid ei gyfeiriad yn un dudalen i MousePlayer. step() sy’n gwneud pob sgrin yn olwg tudalen ei hun – gyda’i chiplun, rhes map gwres a cham twndis ei hun.

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

Mae enw yn 1 i 40 nod o a-z, 0-9, _ a -; daw bylchau’n gysylltnodau, gwrthodir unrhyw beth arall gyda rhybudd yn y consol. Mae llywio go iawn yn dod â’r cam i ben.

6. Cyd-destun Cynnyrch

Ar dudalen cynnyrch, dywedwch wrth MousePlayer beth sy’n cael ei weld. Dim ond yr allweddi hyn a dderbynnir; taflir popeth arall fel nad oes data cwsmer yn llithro i mewn ar ddamwain.

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. Bachau

Gall eich cod ymateb i’r hyn mae MousePlayer yn ei fesur ar y dudalen. Cofrestrwch drwy’r ciw os na ddylai’r bachyn fethu’r foment gyntaf.

// 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);
EnwPrydMeysydd
exit_riskmae’r model gadael wedi sgorio’r olwg tudalen gyntaf (unwaith fesul ymweliad)risk, reasons, session
churn_riskmae ymwelydd sy’n dychwelyd wedi’i farcio’n debygol o beidio â dychwelydrisk, reasons, session
offer_showndangosir y cynnig gadaelart, risk, grund, session
offer_clickclicir ei fotwmart, risk, grund, session, fehler
offer_dismisscaiff ei gauart, risk, grund, session
survey_shownmae arolwg yn agorsurvey, trigger, session
survey_answermae’r ymwelydd yn atebsurvey, type, value, option, sentiment, session
survey_textanfonir y testun dilynol (eisoes wedi’i hidlo)survey, text, session
survey_dismisscaiff yr arolwg ei gau heb atebsurvey, step, session

Pan fydd y bont GTM ymlaen, mae’r un digwyddiadau hefyd yn mynd i’r dataLayer (mp_exit_risk ac yn y blaen). MousePlayer.exitRisk() sy’n dychwelyd y risg o adael bresennol, neu null cyn ei bod yn hysbys.

8. Priodoleddau 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 (neu’r dosbarth mp-masked): disodlir testun a mewnbwn y tu mewn i’r elfen cyn gadael y porwr – yn y ciplun, mewn newidiadau ac mewn disgrifiadau cliciau.
  • data-mp-ignore (neu mp-ignore) ar faes ffurflen: ni recordir ei werth o gwbl.
  • data-mp-role: un o 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. Anwybyddir gwerthoedd eraill.

9. Eithrio Eich Ymweliadau Eich Hun

Agorwch eich gwefan unwaith gyda ?mp_exclude=1 ac ni recordir y porwr hwn mwyach; ?mp_exclude=0 sy’n ei ddadwneud. Ar gyfer rhwydwaith swyddfa gyfan, rhowch y cyfeiriadau IP yng ngosodiadau’r prosiect yn lle hynny.

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. Dolen ar gyfer Eich Polisi Preifatrwydd

Gall ymwelwyr weld a dileu’r hyn a recordiwyd amdanynt. privacyUrl() sy’n dychwelyd y ddolen barod gydag ID y porwr hwn – neu null os nad oes un, gan na recordiwyd dim heb gydsyniad.

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