!githubbanner

![Maintenance]()  

ng-at-internet

AT Internet tracking js library wrapper for AngularJS.

Install

$3

``bash
$ bower install ng-at-internet --save
`

$3

Available soon

Get the sources

`bash
$ git clone https://github.com/ovh-ux/ng-at-internet.git
$ cd ng-at-internet
$ npm install
$ bower install
`

Getting Started

Before using this component please make sure that ATInternet JS library : smarttag.js is linked in your project.

`html



`


Documentation

Please see : http://developers.atinternet-solutions.com/accueil/

Provider configuration

Example simple provider configuration

`javascript
app.config(["atInternetProvider", function(provider) {
provider.setEnabled(true); // enable tracking
//provider.setDebug(true);
provider.setDefaults({ level2: "1"}); // it is recommended to specify the level2 attribute as a default value
// since it is global to your project and it must be send allong with
// every tracking data
}])
`

Please note that the level2 attribute must be your project ID ; configured in ATInternet manager.

Exemple provider configuration with identifiedVisitor set.

`javascript
app.config(["atInternetProvider", function(provider) {
provider.setEnabled(true); // enable tracking
//provider.setDebug(true);
provider.setDefaults({ level2: "1",
visitorId: "123"
});
}])
`

Notice that visitorId is optional and set identifiedVisitor.id ATInternet Tag.

Page tracking

Example of tracking a single page.

`javascript
atInternet.trackPage({
name: "my-page", // page name
level2: "1", // (optional) if not configured in defaults you must specify your project id
visitorId: "123" // (optional) set identifiedVisitor.id sent with each hit
});
`

Click tracking

Example of tracking a click action.

`javascript
atInternet.trackClick({
name: "my-click", // name of action
type: "action", // event type (optional) Possible values : action/navigation/download/exit
level2: "1", // (optional) if not configured in defaults you must specify your project id
visitorId: "123" // (optional) set identifiedVisitor.id sent with each hit
});
`
Tracking using the directive :

Attributes
- track-on : event to track (click, onFinish, onchange, etc)
- track-name : Name of action (optional) Id will be used if absent
- track-type : event type (optional) Possible values : action/navigation/download/exit


`html

Tracking result: {name: "btnAction-click", type: "action"...}


Tracking result: {name: "MyAction", type: "navigation"...}

`

Order tracking

Example of tracking a successfull order.

`javascript
/**
* Please note that you must supply a product price with one of the following attributes : 'price', 'priceTaxFree' (you can also supply both price values, with and without taxes if you want).
*/
atInternet.trackOrder({
page: "pageName", // page of the order
name: "my-product", // name of your product
price: 42, // taxes included product price (required only if priceTaxFree is not supplied)
//priceTaxFree: 42, // price tax free (required only if price is not supplied)
quantity: 1, // amount of product (default is 1)
status: 3, // status of the order (default is 3 : validated)
level2: "1", // (optional) if not configured in defaults you must specify your project id
visitorId: "123" // (optional) set identifiedVisitor.id sent with each hit
});
`

Event tracking

Example of tracking a custom event.

`javascript
atInternet.trackEvent({
page: "pageName", // page that raised the event
event: "eventName", // raised event
level2: "1", // (optional) if not configured in defaults you must specify your project id
visitorId: "123" // (optional) set identifiedVisitor.id sent with each hit
});
`


You can use:
------------

- grunt : to build.
- grunt watch : will rebuild your project when a file change. Also re-launch Karma when a spec file change.
- grunt test : to test specs files with Karma/Jasmine.
- grunt release --type=major|minor|patch : to release your module.

Contributing

You've developed a new cool feature ? Fixed an annoying bug ? We'd be happy
to hear from you !

Have a look in CONTRIBUTING.md

Run the tests

`
$ npm test
``

Related links

* Contribute: https://github.com/ovh-ux/ng-at-internet/blob/master/CONTRIBUTING.md
* Report bugs: https://github.com/ovh-ux/ng-at-internet/issues
* Get latest version: https://github.com/ovh-ux/ng-at-internet

License

See https://github.com/ovh-ux/ng-at-internet/blob/master/LICENSE