Android Integration 0.5.0 - OXYGEN-MARKET/oxygen-market.github.io GitHub Wiki

This page refers to integration samples for Android Tracker v0.5.4. This assumes you have already successfully gone through the Setup Guide for setting up all the dependencies for the tracker.

The following example classes are using the bare minimum of settings for building a Tracker. It is encouraged to flesh out the options for the Tracker and Emitter builders.

For previous versions:

Contents

1. Classic Tracker

You will need to have imported the following library into your project:

dependencies {
    ...
    // Snowplow Android Tracker Classic
    compile 'com.snowplowanalytics:snowplow-android-tracker-classic:0.5.4'
}

Example class to return an Android Classic Tracker:

import com.snowplowanalytics.snowplow.tracker.*;
import android.content.Context;

public class TrackerBuilderClassic {

    public static Tracker getClassicTracker(Context context) {
        Emitter emitter = getClassicEmitter(context);
        Subject subject = getSubject(context);  // Optional

        return new Tracker
            .TrackerBuilder(emitter, "your-namespace", "your-appid", context,
                com.snowplowanalytics.snowplow.tracker.classic.Tracker.class)
            .subject(subject) // Optional
            .build();
    }

    private static Emitter getClassicEmitter(Context context) {
        return new Emitter
            .EmitterBuilder("notarealuri.fake.io", context,
                com.snowplowanalytics.snowplow.tracker.classic.Emitter.class)
            .build();
    }

    private static Subject getSubject(Context context) {
        return new Subject
            .SubjectBuilder()
            .context(context)
            .build();
    }
}

Back to top

2. RxJava tracker

You will need to have imported the following library into your project:

dependencies {
    ...
    // Snowplow Android Tracker Rx
    compile 'com.snowplowanalytics:snowplow-android-tracker-rx:0.5.4'
}

Example class to return an Android RxJava Tracker:

import com.snowplowanalytics.snowplow.tracker.*;
import android.content.Context;

public class TrackerBuilderRx {

    public static Tracker getRxTracker(Context context) {
        Emitter emitter = getRxEmitter(context);
        Subject subject = getSubject(context); // Optional

        return new Tracker
            .TrackerBuilder(emitter, "your-namespace", "your-appid", context,
                com.snowplowanalytics.snowplow.tracker.rx.Tracker.class)
            .subject(subject) // Optional
            .build();
    }

    private static Emitter getRxEmitter(Context context) {
        return new Emitter
            .EmitterBuilder("notarealuri.fake.io", context,
                com.snowplowanalytics.snowplow.tracker.rx.Emitter.class)
            .build();
    }

    private static Subject getSubject(Context context) {
        return new Subject
            .SubjectBuilder()
            .context(context)
            .build();
    }
}

Back to top

3. Tracking Events

Once you have successfully built your Tracker object you can track events with calls like the following:

Tracker tracker = getClassicTracker(context);
tracker.track(ScreenView.builder().name("screenName").id("screenId").build());

For an outline of all available tracking combinations have a look here.

Back to top

4. Application Focus

The Tracker Session object can be tuned to timeout in foreground and background scenarios, but you are required to tell us when your application is in these states. Unfortunately it is not possible to do so from a library standpoint.

The current implementation we are using is to override the onPause() and onResume() functions of an application activity to notify the session when we change states.

@Override
protected void onPause() {
    super.onPause();
    tracker.getSession().setIsBackground(true);
}

@Override
protected void onResume() {
    super.onResume();
    tracker.getSession().setIsBackground(false);
}

If you know of a better way please do not hesitate to let us know!

Back to top

⚠️ **GitHub.com Fallback** ⚠️