Android

We have built an official Android SDK that uses our API’s common methods, and some specific to the Android platform.

Releases

Releases · kissmetrics/KISSmetrics-Android-SDKGitHub

Setup

Within your game subclass or main activity's onCreate method:

// Initialize the API
KISSmetricsAPI.sharedAPI(<api key="">, <application context="">);

Initializing with Development and Production Keys

boolean isDebuggable =  ( 0 != ( getApplicationInfo().flags & ApplicationInfo.FLAG_DEBUGGABLE ) );
if (isDebuggable) {
    KISSmetricsAPI.sharedAPI("yourDevelopmentProductKeyHere", getApplicationContext());
}else{
    KISSmetricsAPI.sharedAPI("yourProductionProductKeyHere", getApplicationContext());
}

Examples

// Track Event
KISSmetricsAPI.sharedAPI().record("Activated");
KISSmetricsAPI.sharedAPI().recordEvent("Activated");    // recordEvent() is being deprecated
// Track Event with Properties
HashMap<string, string=""> properties = new HashMap<string, string="">();
properties.put("Item", "Potion");
properties.put("Amount", "10");
KISSmetricsAPI.sharedAPI().record("Purchase", properties);
// Set Properties
HashMap<string, string=""> properties = new HashMap<string, string="">();
properties.put("Item", "Potion");
properties.put("Amount", "10");
KISSmetricsAPI.sharedAPI().set(properties);
KISSmetricsAPI.sharedAPI().setProperty(properties);    // setProperty() is being deprecated
/* New Functions as of v2 */
// Track an event only once per set identity. After an identity is cleared or a new 
// identity is set, the condition will pass once again.
KISSmetricsAPI.sharedAPI().record("Viewed feature", KISSmetricsAPI.RecordCondition.RECORD_ONCE_PER_IDENTITY); 
// Track an event only once per install
KISSmetricsAPI.sharedAPI().record("Installed App", KISSmetricsAPI.RecordCondition.RECORD_ONCE_PER_INSTALL); 
// Set user properties only if they have changed on the device
HashMap<string, string=""> properties = new HashMap<string, string="">();
properties.put("OS version", "7.1");
KISSmetricsAPI.sharedAPI().setDistinct(properties);

Optional Automated Tracking

• Installed App

• Updated App autoSetAppProperties() - Calling this sets the following properties:

• App Version : 1.0.0 (aka: versionName)

• App Build : 1 (aka: versionCode) autoSetHardwareProperties() - Calling this sets the following properties:

• Device Manufacturer : asus

• Device Model: Nexus 7 (but this may also just be a cryptic model #. This depends on the manufacturer.)

• System Name : Android (hard-coded)

• System Version : 4.2.2

autoRecordInstalls() - Calling this records two events:

Performance

In the new SDK, all calls to record events, properties, identities and aliases are immediately passed onto a background thread for processing and delivery.

In our unofficial SDK (v1), the processing of these calls was handled by the same thread that made the call to record before being delivered asynchronously. This wasn’t optimal as an application’s main thread is responsible for view updates and user interactions.

As a third party addition to our customers’ apps, we should use as little of the main thread as possible to ensure that our SDK doesn’t contribute to any lag in the users’ experience of their apps.

Android SDK Specs

• Size (compiled): 41kb

• Memory Overhead

  • idle: 21kb

  • per avg. event with properties: estimated at < 500 bytes (< 200 for required params plus assumed < 300 bytes for average event with properties). During archiving of each event with properties, approximately 6kb of memory is allocated.

• Android version support: 2.2 (Froyo) (>99% of Android devices)