Skip to content

Latest commit

 

History

History
158 lines (137 loc) · 6.35 KB

README.md

File metadata and controls

158 lines (137 loc) · 6.35 KB
Raw

Tulo Engage Tracker - SDK Android

Tulo Engage Tracker SDK for Android is used for tracking events in Tulo Engage Data Platform.

Installation

The Tulo Engage Tracker SDK supports projects with minimum SDK version 19 (Android 4.4+).

Dependencies

Tulo Engage Tracker has the following external dependencies

implementation 'com.google.code.gson:gson:2.8.5'

Gradle

Add the JitPack repository to your settings.gradle and add the tracker as a dependency to your project. Replace with the latest release.

dependencyResolutionManagement {
    repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
    repositories {
        google()
        mavenCentral()
        maven { url 'https://jitpack.io' }
    }
}
dependencies {
  implementation 'com.github.adeprimo:tulo-engage-tracker-sdk-android:<latest-version>'
  // Required dependency
  implementation 'com.google.code.gson:gson:2.8.5'
  }

Usage

Permissions

In order to be able to send tracking events you must allow network access in your AndroidManifest.xml.

<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE"/>

Setup

In order to be able to send tracking events you must initialize the tracker with TrackerBuilder. You will need the organizationId, productId and the URL to the event service. Afterwards the tracker is available by calling Tracker.instance(). It is recommended to create the tracker in the Application class.

public class MyApp extends Application {
  @Override
      public void onCreate() {
          super.onCreate();

          Tracker.init(new Tracker.TrackerBuilder("myorganisation", "http://user-event-service.com/api/v1/events", this.getApplicationContext())
                .productId("MYPRODUCT")
                .level(LogLevel.VERBOSE)
                .build()
        );
      }

Do not forget to add the application name (in this example MyApp) to your AndroidManifest.xml.

<application android:name=".MyApp">
        <!-- activities goes here -->
    </application>

Session

A new session is started every time the app is started. If you want to start a new session, e.g. when the app enters foreground you can use the startSession function.

Tracker.instance().startSession();

Opt Out

If the user of the app does not want to be tracked you can set optOut on Tulo Engage Tracker. If set, the tracker won't send any events.

Tracker.instance().setOptOut(true);

Tracking

All tracking in Tulo Engage Tracker is done by sending different events. You can either use predefined or custom events. In addition to the data sent together with the event you can enrich the data by setting user and/or content data. The events are sent straight away and no queuing is implemented at the moment.

Setting User Data

When set, the user data is always sent together with all events. User data contains the following properties: userId, paywayId, states, products, positionLon, positionLat, location. If you want to save and persist the user data properties in your app so it is available after restarting the app, you can do so by setting persist to true. To delete a property you can set it to null. The properties positionLon and positionLat will not be persisted.

// create a user and set user properties and save them in app
User user = User.builder()
    .userId("123")
    .paywayId("001")
    .build();

Tracker.instance().setUser(user,true);

To remove all properties you can use the function removeUser()

Setting Content Data

Content data is used to provide more data related to the article that triggers the event. When set, the content data is always sent together with all predefined events, except when sending a custom event. If you want to send content data with a custom event you can do so by using trackEventWithContentData.

It is important to always set the content data when the content changes, e.g. when an article is shown. The properties are: state, type, articleId, publishDate, title, section, keywords, authorId, articleLon, articleLat. To delete a property you can set it to null.

// the article has loaded so set the content and send a pageview event
Content content = Content.builder()
    .state("open")
    .type("free")
    .articleId("123")
    .title("My first article")
    .section("News")
    .keywords(new String[] {"news"})
    .authorId(new String[] {"John Doe", "Jane Doe"})
    .build();

Tracker.instance().setContent(content);
Tracker.instance().trackPageView("/news",null, null);

Events

All events are prefixed with app: but if you for some reason want to specify a different prefix you can do so by setting the eventPrefix when sending the event.

Page Views

Tracks an app:pageview event. Input is url with optional referrer, referrerProtocol and eventPrefix

Tracker.instance().trackPageView("/sports/football", null, null, null);

Article Events

Predefined article related events

Tracks an app:pageview event. Input is customData formatted as JSON

Tracker.instance().trackArticleView(customData: "{\"category\": \"sports/football\"}", null);

Tracks an app:article.interaction of the specified type. Input type of interaction

Tracker.instance().trackArticleInteraction("open_image", null);

Tracks an app:article.purchase. Input is customData formatted as JSON

Tracker.instance().trackArticlePurchase("{\"transaction\": {\"id\": \"abc123\",\"revenue\": \"99.90\"}}", null);

Tracks an app:activetime event. Input is startTime and endTime formatted as Date

Date now = new Date();
Tracker.instance().trackArticleActiveTime(now, new Date(now.getTime() + 10000), null);

Tracks an app:article.read event. Input is customData formatted as JSON

Tracker.instance().trackArticleRead("{\"category\": \"sports/football\"}", null);

Custom Events

Custom events can be used to track e.g. features or actions in the app

Tracks an event of type name. Input name and optional customData formatted as JSON

Tracker.instance().trackEvent("screenshot", "{\"article\": \"123\"}, null);

Tracks an event of type name and includes content data if set. Input name and optional customData formatted as JSON, url, referrer, referrerProtocol

Tracker.instance().trackEventWithContentData("screenshot", "/sports/football", null);