@ridi/event-tracker

Provides tracking API that helps to send events to various logging services like Google Analytics, RIDI beacon system

Install

NPM

$ npm install @ridi/event-tracker

Browser

<script src="./node_modules/@ridi/event-tracker/dist/umd/bundle.min.js"></script>

Usage

import { Tracker, DeviceType } from "@ridi/event-tracker";
 
const tracker = new Tracker({
  deviceType: DeviceType.PC,
  userId: "ridi",
  beaconOptions: {
    use: true
  },
  gaOptions: {
    trackingId: "UA-XXXXXXXX-X",
    pathPrefix: "/PAPERSHOP",
    fields: {
      contentGroup5: "PAPERSHOP"
    }
  },
  pixelOptions: {
    pixelId: "1000000000"
  },
  tagManagerOptions: {
    trackingId: "GTM-XXXX00"
  }
});
 
tracker.initialize();
 
tracker.sendPageView(location.href);
 
tracker.sendEvent("Purchased", {
  t_id: "201808180210135",
  value: 29000
});

API

`new Tracker(MainTrackerOptions)`

MainTrackerOptions

Key	Required	Type	Description
`debug`	false	`boolean`	Defaults to `false` If set to `true`, All fired events are logged to browser via `console.log`
`development`	false	`boolean`	Represents the state of the system environment your application
`userId`	false	`string`	Logged user's identifier.
`deviceType`	true	`DeviceType`	Type of connected user's device. Please refer `DeviceType` type
`gaOptions`	false	`GAOptions`	Options related with Google Analytics tracking module
`gaOptions.trackingId`	true	`string`	GA Tracking ID like `UA-000000-01`.
`gaOptions.pathPrefix`	flase	`string`	Pathname prefix for manual content grouping.
`gaOptions.fields`	false	`GAFields`	GA configurable create only fields.
`beaconOptions`	false	`BeaconOptions`	Options related with Beacon tracking module
`beaconOptions.use`	false	`boolean`	Defaults to `true`, Specifies whether to send log data to beacon system
`beaconOptions.beaconSrc`	false	`string`	Source of the image to be used as a beacon
`pixelOptions`	false	`PixelOptions`	Options related with Pixel tracking module
`pixelOptions.pixelId`	true	`string \| Array<string>`	Facebook Pixel Tracking ID like `1000000000`.
`tagManagerOptions`	false	`TagManagerOptions`	Options related with Google Tag Manager tracking module
`tagManagerOptions.trackingId`	true	`string`	Google Tag Manager Tracking ID like `GTM-XXXX00`
`gTagOptions`	false	`GTagOptions`	Options related with GTag tracking module
`gTagOptions.trackingId`	true	`string`	GTag Tracking ID like `AW-XXXX00`

`Tracker.initialize()`

@ridi/event-tracker must be initialized by using this method before any of the other tracking functions will record any data.

`Tracker.sendPageView(href, referrer)`

Key	Required	Type	Description
`href`	true	string	e.g `https://example.com/path?key=value#hash`
`referrer`	false	string	e.g `https://google.com/search?q=example`

`Tracker.sendEvent(name, data)`

Key	Required	Type	Description
`name`	true	string	Indicating what the given event is
`data`	false	object	Data object to be sent with the event. e.g `{ color: 'red' }`

`Tracker.set(ChangeableTrackerOptions)`

Allow to set (change) MainTrackerOptions's attributes

ChangeableTrackerOptions

Key	Required	Type	Description
`userId`	false	`string`
`deviceType`	false	`DeviceType`

Development

$ git clone https://github.com/ridi/event-tracker && cd tracking
$ npm install
$ npm run watch

Test

$ npm run test

LICENSE

MIT

npm

@ridi/event-tracker

@ridi/event-tracker

Install

NPM

Browser

Usage

API

`new Tracker(MainTrackerOptions)`

MainTrackerOptions

`Tracker.initialize()`

`Tracker.sendPageView(href, referrer)`

`Tracker.sendEvent(name, data)`

`Tracker.set(ChangeableTrackerOptions)`

ChangeableTrackerOptions

Development

Test

LICENSE

Keywords

Install

Weekly Downloads

Version

License

Unpacked Size

Total Files

Homepage

Repository

Last publish

Collaborators

@ridi/event-tracker

@ridi/event-tracker

Install

NPM

Browser

Usage

API

new Tracker(MainTrackerOptions)

MainTrackerOptions

Tracker.initialize()

Tracker.sendPageView(href, referrer)

Tracker.sendEvent(name, data)

Tracker.set(ChangeableTrackerOptions)

ChangeableTrackerOptions

Development

Test

LICENSE

Keywords

Install

DownloadsWeekly Downloads

Version

License

Unpacked Size

Total Files

Homepage

Repository

Last publish

Collaborators

`new Tracker(MainTrackerOptions)`

`Tracker.initialize()`

`Tracker.sendPageView(href, referrer)`

`Tracker.sendEvent(name, data)`

`Tracker.set(ChangeableTrackerOptions)`

Weekly Downloads