@ridi/ridi-event-tracker
    TypeScript icon, indicating that this package has built-in type declarations

    0.1.3 • Public • Published

    @ridi/ridi-event-tracker

    npm

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

    Install

    NPM

    $ npm install @ridi/ridi-event-tracker

    Browser

    # local
    <script src="./node_modules/@ridi/event-tracker/dist/umd/bundle.min.js"></script>
    
    # In GTM
    <script src="https://unpkg.com/@ridi/ridi-event-tracker@{{EVENT_TRACKER_VERSION}}/dist/umd/bundle.min.js"></script>
    <script>
      var beaconSrc = 'https://s3.ap-northeast-2.amazonaws.com/beacon-ridibooks-2/beacon_ridibooks_2.gif';
      window.ret = new Tracker({
        deviceType: '{{DeviceType}}',
        uId: '{{UserID}}',
        beaconOptions: {
          beaconSrc: beaconSrc
        }
      });
      window.ret.initialize();
    </script>

    Usage

    import { Tracker, DeviceType } from "@ridi/event-tracker";
    
    const tracker = new Tracker({
      deviceType: DeviceType.PC,
      uId: 123456,
      debug: false,
      throttleWait: 1000,
      beaconOptions: {
        beaconSrc: "http://beacon.com",
      },
    
    });
    
    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
    uId false number Logged user's identifier.
    deviceType true DeviceType Type of connected user's device. Please refer DeviceType type
    beaconOptions false BeaconOptions Options related with Beacon tracking module
    beaconOptions.beaconSrc false string Source of the image to be used as a beacon

    Tracker.initialize()

    To use this library correctly, you need to call this method least once either before calling other methods or after.

    written event records before calling initialize, this records flush after initialized.

    Develop

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

    Test

    $ npm run test

    Publish

    $ npm login
    $ npm run deploy
    $ # or
    $ npm run build && npm publish --access public

    LICENSE

    MIT

    Keywords

    none

    Install

    npm i @ridi/ridi-event-tracker

    DownloadsWeekly Downloads

    290

    Version

    0.1.3

    License

    MIT

    Unpacked Size

    998 kB

    Total Files

    44

    Last publish

    Collaborators

    • mando212
    • khinenw
    • davin.ahn
    • ridicorp
    • m0ai
    • limeburst
    • minq
    • ridi-junhee
    • hw.choi