Atlas tracking library for general web site
- ATJ is a tracking SDK for Atlas
- ATJ transmits beacons for general purpose of web analytics
- ATJ utilizes web-browser's modern features such as sendBeacon, requestAnimationFrame and Navigation Timing
- Some features uses Event Delegation mechanism
- A rich variety of auto tracking options available
- README in Japanese is available. （日本語の説明 はこちら）
- Configuration Guide describes all customizable features managed through c2p.js.
- Some utility functions are available within ATJ core. You will find useful methods from a List of Methods
- FAQ is here but is still under enhancement.
- ATJ is published under MIT License
- Special thanks to all contributors in this project.
- As of today, we won't merge pull-requests from outside of Nikkei due to operational policy. Please create an issue on GitHub if you find any problems.
docker build \
--platform linux/x86_64 \
--tag atj \
./
docker run \
--platform linux/x86_64 \
--name ATJ \
--env SDK_API_KEY=your_sdk_api_key \
--env DEFAULT_ENDPOINT=your.atlas.endpoint \
--env SDK_NAMESPACE=atlasTracking \
--volume ${PWD##}:/var/atj \
-it \
atj| Variable | Purpose | Default | Example |
|---|---|---|---|
| SDK_API_KEY | For the authentication at Atlas Endpoint which is a destination to put data to | test_api_key |
abc123xyz789 |
| DEFAULT_ENDPOINT | A default endpoint. If you don't specify the endpoint in config variables in c2p.js, ATJ fall backs to the endpoint to this value | atlas.local |
atlas-endpoint.your.domain |
| SDK_NAMESPACE | A namespace which will contains all methods and variables for ATJ, so ATJ consumes just one global namespace. | atlasTracking |
atlasTracking |
npm install- You can lint the code by
npm run eslint - For the unit test, run
npm run test
- For the standalone ATJ,
npm run build:dist(In general, this will fit with most use cases) - For generating NPM module,
npm run build:npm
- One variable in global namespace is required to store ATJ related variables and methods. You can specify the name for this when you build ATJ.
- ATJ uses one Cookie to identify unique browser. A Cookie name is defined in c2p.js but the default is
atlasId - ATJ dispatch a custom event named
atlasVisibilityStatusto detect visibility status of each elements for Scroll Depth, Read Through and Viewable Impression. Dispatch frequency depends on the combination ofrequestAnimationFrameand throttling. - ATJ supports many browsers as possible without polyfill, but it doesn't work with old Internet Explorer older than IE9
- Build your ATJ by following Readme and then you will have
atj.min.jsin./distdirectory. - Create a config file named
c2p.jsbased on a sample file in./distdirectory. Read Config Guide carefully to customize ATJ. - Load both files
atj.min.jsandc2p.jswithin<body>...</body>on each page in your web site.- You can call these files by embedding
scripttags like<script src='{path/to/file}'></script>directly. - Also, you can deploy ATJ files through Tag Management tools such as Adobe Dynamic Tag Management, Google Tag Manager and other tag management tools.
- You can call these files by embedding
- Check your web site to confirm that there is no script errors and ATJ is sending beacons.
- c2p.js fires methods as below step:
- Configure ATJ core by calling
config() - Initialize the page data by calling
initPage() - Then, send a beacon for tracking pageview by
trackPage()
- Configure ATJ core by calling
- Also, c2p.js is able to have some custom codes to retrieve and/or prepare data.
- If your web site is SPA (Single Page Application), you can call
initPage()andtrackPage()each times when screen has been changed. (no need to re-initialize ATJ itself)
ATJ has a built-in method to add "opt-out from tracking" feature in your service. This is strongly recommended at any cases from the privacy perspective. It's necessary to consider the opt-out feature if your service is used from countries which is applied GDPR.
- Create or modify your opt-out page or modal to add an "opt-out from tracking" button.
- Write a few code to call
atlasTracking.optout('enable')when user clicks the opt-out button.
- Opt-outed user can opt-in by
atlasTracking.optout('disable'); - To protect user's privacy perfectly within ATJ, you should place the opt-out feature before sending the first beacon, thus
initPage()andtrackPage()must be triggered once user has accepted tracking.