@ingresse/trackers
v0.0.3
Published
Ingresse JS Analytics and Anti-fraud helpers for browsers
Downloads
94
Keywords
Readme
@ingresse/trackers
Facility to inject 3rd party services as Facebook Pixel, Google Analytics and Legiti inside your HTML page.
npm install
npm i -S @ingresse/trackersWill install @ingresse/injector as dependency. If you need, you can use it too.
Browser
<html>
<head>
<script>
// This isn't required, but it's a way to use
function onTrackersLoad() {
console.log('trackers can be used now', window.trackers);
// Look into #usage section below
}
</script>
<script onload="onTrackersLoad()" src="https://cdn.ingresse.com/trackers/trackers.js"></script>
</head>
<body>
...
</body>
</html>Usage
Service without ID/Key will not be injected. You can use only what you need.
// Only ES Apps
import trackers from '@ingresse/trackers';
// General Usage
trackers({
fbq : 'facebook-pixel-id',
gtag : 'google-analytics-id',
legiti: 'legiti-api-key',
})
.then(() => {
// Generic
trackers.pageView();
// Auth
trackers.auth.loginError('[email protected]');
trackers.auth.login('[email protected]', 'user-id');
trackers.auth.logout('[email protected]', 'user-id');
trackers.auth.register('[email protected]', 'user-id');
// User
trackers.user.created('[email protected]' 'user-id');
trackers.user.updated('user-id');
// Cart
trackers.cart.add({
tid: 'transaction-id',
value : 30,
currency: 'BRL',
items: [
{
id : 123,
quantity: 2,
},
{
id : 321,
quantity: 1,
},
],
});
// Conversion
trackers.purchase.created({
tid: 'transaction-id',
value : 30,
currency: 'BRL',
items: [
{
id : 123,
quantity: 2,
},
{
id : 321,
quantity: 1,
},
],
});
trackers.purchase.success({
tid: 'transaction-id',
value : 30,
tax : 3,
coupon : 'discount-coupon-used-if-existent',
currency: 'BRL',
items: [
{
id : 123,
quantity: 2,
},
{
id : 321,
quantity: 1,
},
],
});
// Simplified Usage
trackers.fbq('track', 'AddToCart', { ... });
trackers.gtag('event', 'an awesome action', { ... });
trackers.legiti('trackUserLogin', '[email protected]', 'user-id');
// Root Usage
window.fbq('track', 'AddToCart', { ... });
window.gtag('event', 'an awesome action', { ... });
window.legiti.sharedInstance().trackUserLogin('[email protected]', 'user-id');
})
.catch((error) => {
console.warn('Trackers Injection failed', error);
});More usage details
Our code is written to be easy to read and understand.
Be comfortable to navigate into src folder and discover.
Folder src/methods may help to find some pre-existing method.