Developers » Windows » Getting started » Operating principle
Operating principle
General principles
The AT Internet tag allows you to follow your users activity throughout your applications lifecycle.
To help you, the tag makes available classes (helpers) enabling the quick implementation of tracking for different application events (screen loads, gestures, video plays ).
These helpers enable you to define or add different types of tagging and put them in a queue. This queue can be emptied by calling the Dispatch method, available in the Tracker class.
List of available classes
Name | Description |
---|---|
Screen | Class enabling the tagging of screens |
DynamicScreen | Class enabling the tagging of screens whose name can vary (e.g: news feed) |
Gesture | Class enabling the tagging of gestures |
Campaign | Class enabling the addition of campaign information on your screen hits |
Publisher | Class enabling the tagging of your ads |
SelfPromotion | Class enabling the tagging of your self-promotion campaigns |
Aisle | Class enabling the tagging of your aisles (in the case of SalesTracker tagging) |
Cart | Class enabling the tagging of your product cart (in the case of SalesTracker tagging) |
Order | Class enabling the tagging of your orders (in the case of SalesTracker tagging) |
Location | Class enabling the addition of geolocation information on your screen hits |
CustomObject | Class enabling the addition of custom objects on your hits |
CustomVar | Class enabling the addition of custom variables on your screen hits |
IdentifiedVisitor | Class enabling the management of user identification |
InternalSearch | Class enabling the tagging of your internal search engine |
MediaPlayer | Class enabling the tagging of your audio and video feed |
Product | Class enabling the tagging of your products |
CustomTreeStructure | Class enabling the tagging of your custom tree |
Advanced tagging
Aside from using helpers, it is also possible to manually tag your application via the SetParam method of the Tracker.
The SetParam method allows you to add a parameter that will be sent on the next hit or on all following hits (volatile or persistent).
This method can take as a parameter the object ParamOption allowing for definition of the following information:
- relativePosition: Parameters position in the hit with regards to another parameter
- relativeParameterKey: Relative parameter key
- append: Allows concatenation of several values in the same variable
- separator: In the case of a table-type variable, defines the separator shown in the URL. When the append option is used, the separator will be used to separate the concatenated values.
- encode: Allows encoding of the variables value (true by default)
- persistent: Indicates if the variable must be present in all hits, or only in the following hit..
In order to send the defined variables, you must then call the Trackers Dispatch method.
Advanced tagging example
- Tagging a screen:
public MainPage () { this.InitializeComponent(); // Set screen home SmartTag.Instance.defaultTracker.SetParam("p", "Home"); // Set level 2 ID for screen ParamOption s2ParamOption = new ParamOption(); s2ParamOption.Persistent = true; SmartTag.Instance.defaultTracker.SetParam("s2", 1, s2ParamOption); // Send hit SmartTag.Instance.defaultTracker.Dispatch(); }
- Sending a hit with a custom object:
The hit will be considered as screen tagging
public MainPage() { this.InitializeComponent(); Dictionary<string, object> myCustomObject = new Dictionary<string, object>() { { "myLanguage" , "fr" }, { "myDevice" , "Lumia" } }; SmartTag.Instance.defaultTracker.SetParam("stc", myCustomObject); }
Default variables
When a hit is sent, the AT Internet tracker will automatically add variables to feed basic analyses:
Name | Description |
---|---|
vtag | Gets the SDK version |
ptag | Gets the platform where the SDK is integrated (e.g.: iOS, Android ) |
lng | Gets the user language |
mfmd | Gets the device make and model |
os | Gets the name and version of the devices operating system |
apvr | Gets the application version |
apid | Gets the application package name |
hl | Gets the devices local time |
car | Gets the devices operator/carrier |
cn | Gets the connection type |
ts | Gets a timestamp indicating the time of hit creation |
idclient | Gets the user ID |
stc | Gets the JSON containing the application lifecycle data, crash information if applicable, or custom objects |