Uninstall Insights Android SDK

Uninstall SDK helps you understand the reasons for your app uninstalls, reduce the uninstall rate using a powerful predictive engine and also get app Re-installs through a unique actionable channel (Android version 4.0 and above).

This guide will provide you step by step details on how to integrate the SDK in few minutes. Following steps outline the integration process in detail.

Steps to integrate the sdk to your Android project.

1. Include gradle dependency or download the zipped file.
2. Set the SDK “Token and Secret” in your project's string.xml file.
3. Configure SDK settings in the your project's AndroidManifest.xml file.
4. Initialize the SDK in the MainActivity class.
5. Pass information to SDK from the App.
6. Ignore GCM message from Uninstall.io
7. Uninstall permission requirements

1.Include gradle dependency or download the zipped file.

Implement SDK using gradle dependency.

add following code to build.gradle(app) file.

dependencies {
  ...
compile 'com.songline.uninstall:app:12.3.+'
  ...
}

OR

#####Download And Add UninstalliO_12.3.jar SDK file to project.

https://github.com/uninstallio/android-sdk/archive/master.zip

Unzip the "android-sdk-master.zip" file.

If you are using Eclipse, then follow the below steps to add the jar file.
How to add a jar file

If you are using Android Studio, then follow the below steps to add the jar file.
How to add a jar file

2.Set the SDK “Token and Secret” in your project's string.xml file.

In eclipse, goto project's root folder --> res folder --> values folder --> strings.xml file. Add the following lines in the file.

<string name="uninstall_token">TOKEN_GIVEN_BY_UNINSTALL_SEPARATELY</string>
<string name="uninstall_secret">APP_SECRET_GIVEN_BY_UNINSTALL_SEPARATELY</string>

Note: If you do not have the token and secret then please drop a mail with name and email to sdk_integration@uninstall.io to get these credentials for your app.

3.Configure SDK settings in the Your project's AndroidManifest.xml file.

After adding the JAR into your project, modify your AndroidManifest.xml file as mentioned below:

1. Permissions: Add the following permissions in the file and replace YOUR_PACKAGE_NAME with your application's package name.

<permission android:name="YOUR_PACKAGE_NAME.permission.C2D_MESSAGE"
     android:protectionLevel="signature" />
<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="com.google.android.c2dm.permission.RECEIVE" />
<uses-permission android:name="YOUR_PACKAGE_NAME.permission.C2D_MESSAGE" />
<uses-permission android:name="android.permission.WAKE_LOCK" />

Optional Permissions

<uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION" />
<uses-permission android:name="android.permission.GET_ACCOUNTS" />
<uses-permission android:name="android.permission.READ_PHONE_STATE" />
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
<uses-permission android:name="android.permission.ACCESS_WIFI_STATE" />

2. Uninstall Service and Receivers: Add the following xml code inside "application" tag and replace YOUR_PACKAGE_NAME with your application’s package name

<!- Uninstall.io  provides a solution that broadcasts INSTALL_REFERRER to all other receivers automatically. add the following receiver as the FIRST receiver for INSTALL_REFERRER -->
<receiver
    android:name="com.songline.uninstall.receivers.InstallReferrerReceiver"
    android:exported="true" >
    <intent-filter>
	<action android:name="com.android.vending.INSTALL_REFERRER" />
    </intent-filter>
</receiver>

If you want to use multiple receivers, the AndroidManifest.xml must appear, as follows:

<!—Uninstall.io Install Receiver is first and will broadcast to all receivers placed below it -->

<receiver android:name="com.songline.uninstall.receivers.InstallReferrerReceiver" android:exported="true">
  <intent-filter>
     <action android:name="com.android.vending.INSTALL_REFERRER" />
  </intent-filter>
</receiver>

<!—All other receivers should follow right after --> 

<receiver android:name="com.google.android.apps.analytics.AnalyticsReceiver" android:exported="true">
 <intent-filter>
      <action android:name="com.android.vending.INSTALL_REFERRER" />
 </intent-filter>
</receiver>
<receiver android:name="com.admob.android.ads.analytics.InstallReceiver" android:exported="true">
      <intent-filter>
          <action android:name="com.android.vending.INSTALL_REFERRER" />
      </intent-filter>
</receiver>

Add below Receiver and Services to your AndroidManifest.xml .

<receiver
    android:name="com.songline.uninstall.receivers.UninstallGCMReceiver"
    android:permission="com.google.android.c2dm.permission.SEND" >
    <intent-filter>				
	<action android:name="com.google.android.c2dm.intent.RECEIVE" />
	<category android:name="YOUR_PACKAGE_NAME" />
    </intent-filter>
</receiver>

<service android:name="com.songline.uninstall.services.GCMInformService" />
<service android:name="com.songline.uninstall.services.UninstallGCMIntentService" />
<service android:name="com.songline.uninstall.services.UninstallInstanceIdService" android:exported="false">
            <intent-filter>
                <action android:name="com.google.android.gms.iid.InstanceID"/>
            </intent-filter>
        </service>

Note : Both, your push notifications and Uninstall.io push configuration shall work swiftly in parallel with no conflicts.

3. Google Play Services Library Configuration .
   a) Add Google Play Services to Eclipse.
   b) Add Google Play Services to Android Studio.

Note:: Google Play Services must be compiled against version 6.5 or above.

4.Initialize the SDK In the MainActivity class.

a) Add the below import statement in your Launcher Activity of your application

import com.songline.uninstall.UninstallSession;

b) Add the below code inside the onCreate method of your Launcher Activity

@Override
protected void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);
    UninstallSession.init(context, 1);   // context is you activity context.
}

c) Capture email id : If you do not wish to fetch email id using the SDK, please add the below code snippet before the SDK is initialized -> i.e. before this line UninstallSession.init(context, 1);

UninstallSession.fetchEmailId(false);

Note : By default, this feature is enabled.

5.Passing information to SDK from the App.

You could pass various types of information to our backend systems e.g. Email id, your backend system's Userid or In App Events through our SDK's efficient event-capturing ability.

1) Unique System User ID and Email ID -

Please pass the User ID assigned by your backend system for this user. Also pass the email (if available). This data will be used to synchronize the various ID’s between our and your backend systems and also to take relevant actions. This information has to be passed only once in the lifetime of the app and not everytime.

Please pass the UserID and Email using the sample code shown below:

SharedPreferences sharedPreferences = getSharedPreferences(Constants.UNINSTALL_SHARED_PREFERENCES, Context.MODE_PRIVATE);
boolean isFirstTimeInstall = sharedPreferences.getBoolean("isFirstTimeInstall", true);
if (isFirstTimeInstall) {

   //Send email-id
   UninstallAnalytics.with(context).identify(new Traits().putEmail("YOUR_EMAIL_ID"));    
   //send user-id
   UninstallAnalytics.with(context).identify(new Traits().putUsername("YOUR_USER_ID"));
   
   // NOTE: context is your activity context.
   
Editor editor = sharedPreferences.edit();
editor.putBoolean("isFirstTimeInstall", false);
editor.commit();
}       

2) In-App Events -

You could pass the In App events using the following code snippet.

UninstallAnalytics.with(context).track("Viewed Product", new Properties().putValue("Shirt", "Shirt_ID"));
// NOTE: context is your activity context.

####6.Ignore GCM message from Uninstall.io

Add below code snippet at beginning of the following functions, Class which handle the Push Notification extending IntentService or GCMListenerService or BroadcastReceiver.
a) onHandleIntent(Intent intent)

@Override
protected void onHandleIntent(Intent intent) {

	 if (intent.getStringExtra("is_notiphi") != null) {
		return;
 	}
 	// Your code 
 }

b) onMessageReceived(String s, Bundle data)

@Override
    public void onMessageReceived(String s, Bundle data) {
        if (data.containsKey("is_notiphi")) {
            return;
        }
        // Your code
    }

c) onReceive(Context context, Intent intent)

 @Override
   public void onReceive(Context context, Intent intent) {
   	 if (intent.getStringExtra("is_notiphi") != null) {
   	return;
	}
	// Your code  
   
   }

If you’re using GCM for registration then you have to put below snippet code to the receiver which will receive the token.

@Override
  public void onReceive(Context context, Intent intent) {
    if (intent.getStringExtra("registration_id").contains("|ID|")) {
      return;
    }
    // Your Code 
  }

7.UNINSTALL permission requirements

Our SDK requires the following permissions in order to function correctly. We have outlined the reasons why we need each of these permissions.

#####Must have permissions

 <tr>
    <td>"com.google.android.c2dm.permission.RECEIVE"
    </td>
    <td>App has permission to register for and receive GCM 
        tokens from GCM server.
    </td>
 </tr>
 <tr>
    <td>“android.permission.INTERNET"
    </td>
    <td>Internet permission is required to communicate
       with the server.
    </td>
 </tr>

  <tr>
    <td>“android.permission.WAKE_LOCK”
    </td>
    <td>Required so the application can keep the processor
        from sleeping when a message is received.
    </td>
 </tr>

"YOUR_PACKAGE_NAME.permission.C2D_MESSAGE”

This permission ensures that Our SDK can use GCM facility.

#####Good to have permission (Optional)

"android.permission.ACCESS_COARSE_LOCATION"	Required to access user's location.
"android.permission.READ_PHONE_STATE"	Required to get details about phone and sim network. eg.IMEI, Phone type, sim operator, etc..
“android.permission.ACCESS_NETWORK_STATE”	Network state permission to detect network status.
"android.permission.ACCESS_WIFI_STATE"	Required to access user's basic wifi data.
"android.permission.GET_ACCOUNTS"	GCM requires a Google account if the device is running a version lower than Android 4.0.4.

Support or Contact

Having trouble with integration? Please contact us with name & email to sdk_integration@uninstall.io and we’ll help you sort it out in a jiffy.