Install the SDK

Download the latest Android Native SDK from the link below:

 mTraction Android SDK

Note: Please refer to the Android SDK Change log for details about the changes/upgrades on the latest SDK version from previous versions.

The mTracktion SDK should contain the following files:

1. mTractionSDK.jar: This is the main SDK library for integrating your Application.
2. MTractionSingleInstallReceiver.java: This is a sample file provided to track installs from single tracker.
3. MTractionMultipleInstallReceivers.java: This is a sample file provided to track installs from multiple tracker.
   
   

The step-by-step integration process has been described in detail in the coming sections.

1. Basic Integration Settings
2. Installs Tracking
3. App Session Tracking (Optional)
4. In App Events Integration (Optional)
5. CRM Integration - Android SDK

1. Basic Integration Settings

Add mTractionSDK.jar to your project as a project library.

• If you’re using Eclipse, modify your Java Build Path, and choose Add External JAR.
• If you’re using the SDK tools directly, drop it into your libs folder and the ant task will pick it up.
• If you’re using the Android Studio tools directly, drop it into your libs folder ,Right click on it and choose Add as Library option for adding it into project.

1. Open the AndroidManifest.xml file in your project and add the following:

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

     This is to grant permission to access Internet and Network State.
    Optionally, you can also grant Phone State access (as shown below) for our SDK to receive device IMEI & Network Operator related information of your App Users.  

   <uses-permission android:name=”android.permission.READ_PHONE_STATE” />

    
2. Put the following lines of code in the first place of your app run. This must be place it in the onCreate() method of Application. 

   MTractionDownloadTracker mTractionDownloadTracker = new MTractionDownloadTracker();
   mTractionDownloadTracker.trackDownload(getApplicationContext(), null);

    
3. To enable Debug logs, the following setting should be enabled. 

   <application>
   // mTraction Debug Mode
   <meta-data
   android:name=”mt_DebugMode”
   android:value=”true”/>
   </application>

    Note: Please ensure that the mt_DebugMode should be set to “false” before going live.
4. Add google-play-services_ads dependency library into your project module setting.
5. Add google_play_services_version in Project’s Manifest file inside Application tag. 

   <application>
   // Application Version
   <meta-data
   android:name=”com.google.android.gms.version”
   android:value=”@integer/google_play_services_version” />
   </application>

    

2. Installs Tracking

We have provided two different methods to handle download conversions, both single and multiple. Use multiple if you plan to use other methods for download conversion tracking. Choose one of the methods below:

• Single Install Tracking SDK:
  1. Copy the MTractionSingleInstallReceiver.java file to your applications main Package folder. Change the Package Name at the top of the file, to the package name of the main project.
  2. Open the AndroidManifest.xml file in your project and add the following Receiver settings. 

     <receiver android:name=”.MTractionSingleInstallReceiver” android:exported=”true”>
     <intent-filter>
     <action android:name=”com.android.vending.INSTALL_REFERRER” />
     </intent-filter>
     </receiver>

      
  3. Do the following settings in the AndroidManifest.xml under the Application section. The App_Token is provided to you as a part of the Application Registration process on the mTraction Platform. 

     <application>
     // mTraction App Token
     <meta-data
     android:name=”appToken”
     android:value=”App_Token”/>
     </application>

      

At this point in time, you can validate your install tracking with our mTraction Testing Applciation. Please refer to this documentation and follow the steps as mentioned: mTraction Android SDK Testing

• Multiple Installs Tracking SDK:
  1. If your Android app has multiple receivers for INSTALL_REFERRER, you will need to write a custom receiver that will call these receivers.
      We recommend to use MTractionMultipleInstallReceivers.java class included in SDK suite. Alternatively, you can create your custom class as per the below sample code: 

     package com.test.sample; //Application Package Name
     import android.content.BroadcastReceiver;
     import android.content.Context;
     import android.content.Intent;
     import com.mtraction.mtractiondownloadtracker.MTractionDownloadTracker;
     
     public class MTractionMultipleInstallReceivers extends BroadcastReceiver {
     @Override
     public void onReceive(Context context, Intent intent) {
      
         // Call MTractionDownloadTracker\
         MTractionDownloadTracker mTractionDownloadTracker = new MTractionDownloadTracker();
         mTractionDownloadTracker.onReceive(context, intent);
     
         // Initialize and call onReceive for other receivers
     
     }
     }

  2. Then place the receiver in your AndroidManifest.xml file like shown below: 

     <receiver android:name=”.MTractionMultipleInstallReceivers” android: exported=”true”>
     <intent-filter>
     <action android:name=”com.android.vending.INSTALL_REFERRER” />
     </intent-filter>
     </receiver>

      Note: Make sure that you change the receiver name to the one as you created above.

At this point in time you can validate your install tracking with our mTraction Testing Applciation. Please refer to this documentation and follow the steps as mentioned: mTraction Android SDK Testing

 -         

3. App Session Tracking (Optional)

Note: App Session implementation is optional for your Application. However, for Active Sessions and Session duration related data - this needs to be configured in your Application. Also note that this can generate a lot of traffic and hence cost if the request is large.

We have provided two different solutions, Standard Solution & Alternate Solution to handle Session tracking in your Application based on the supported Android versions. Use the alternate solution if your Application supports Android versions 4.0 or below (i.e, Ice Cream Sandwich - API Level 14 or below). Choose one of the solutions below:

• The Standard Solution is supported by most of the applications and works in a manner that lets the SDK listen to and track the various state changes that happens inside the Application (For example: App moving to foreground/background). Please follow the below steps:                                                
  1. If you don't have a custom Application class, create one and specify the name in your AndroidManifest.xml as follows. 

     <application
     android:name=".MyApplication">

      
  2. Make the following modifications to your Application class.                                                
     • Import the MTractionActivityLifecycleCallbacks package. 

       import com.mtraction.mtractioninapptracker.MTractionActivityLifecycleCallbacks;

     • Register MTractionActivityLifecycleCallbacks. 

       @Override
       
       public void onCreate()
       {
        super.onCreate();
        registerActivityLifecycleCallbacks(
                 new MTractionActivityLifecycleCallbacks(this));
       }

• The Alternate Solution is built in such a way that it tries to achieve the same result as the standard solution through initializing the SDK. In every Activity of your app, override onResume() and onPause() to manage the sessions as below:                                                
  • In onResume, call onActivityResumed. 

    MTractionInAppTracker.onActivityResumed(context);

  • In onPause, call onActivityPaused. 

    MTractionInAppTracker.onActivityPaused(context);

4. In App Events (Optional)

• At this stage, you might be interested in implementing certain In App events that needs to be tracked in order to measure your Application’s User Engagement after being installed. We have provided a list of generic events that you may need to implement depending on its necessity to your Application. Please follow the documentation (with examples) to implement them on your Application: Generic In App Events Setup
• We have also provided sets of predefined In App events along with their respective keys setup (with example usage) based on the Industry or Vertical your Application is associated with. Please refer to the link to the various Vertical based Events integration guides: Vertical Specific Events Setup Guides
• Additionally, you can implement custom events to track specific behavior on your application. Please follow the documentation (with example): Custom Events Setup Guide

5. CRM Integration - Android SDK