AppsFlyer SDK Integration - Android V 4.3.4

This Android SDK is out of date!  For the latest version, click here.

Current Version: 4.3.4

NOTE: There was a major version change to the previous version of the SDK and it is very important that you read this document carefully to make sure you are aware of all the changes.  For details of the migration from V.3.3.x to 4.3.4 click here.

AppsFlyer's SDK provides app installation and event tracking functionality. We have developed an SDK that is highly robust (7+ billion SDK installations to date), secure, lightweight and very simple to embed.

You can track installs, updates and sessions (by following the mandatory steps below), and also track additional in-app events beyond app installs (including in-app purchases, game levels, etc.) to evaluate ROI and user engagement levels.

SDK_Integration__1_.jpg

The mandatory steps are detailed in sections 2 and 3 below, followed by additional optional features in section 4.

The AppsFlyer Android SDK is compatible with Android 2.3 and above.

The following sections are covered in this guide:

 Android SDK Download

To download the Android SDK jar, click here.

For details of AppsFlyer's Sample App, click here.

1.  What’s New in This Version?

  • Bug fixes and maintenance.

2.  Embedding the SDK into Your Application (Mandatory)

The following steps are mandatory to measure installs and sessions.

2.1  Add the AppsFlyer SDK to your Project

Add AF-Android-SDK.jar to the project's class path.

2.2  Set the Required Permissions

The AndroidManifest.xml should include the following permissions:

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

* READ_PHONE_STATE permission is optional.

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

Adding this permission enables carrier tracking of IMEI (required for tracking outside of Google Play).

2.3  Set an Install Referrer Broadcast Receiver in AndroidManifest.xml

Android apps cannot have multiple receivers with the same intent-filtered action.  

AppsFlyer provides a solution that broadcasts INSTALL_REFERRER to all other receivers automatically. In the AndroidManifest.xml, add the following receiver as the FIRST receiver for INSTALL_REFERRER, and ensure the receiver tag is within the application tag:

<receiver android:name="com.appsflyer.MultipleInstallBroadcastReceiver" android:exported="true">
  <intent-filter>
     <action android:name="com.android.vending.INSTALL_REFERRER" />
  </intent-filter>
</receiver>

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

<!—The AppsFlyer Install Receiver is first and will broadcast to all receivers placed below it -->
<receiver android:name="com.appsflyer.MultipleInstallBroadcastReceiver" 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>

For more information about how to add an additional receiver to access app install data from your app context, click here.

2.4  Embed Google Play Services into Your App

Collecting the Google Advertising ID (GAID) is essential for tracking campaigns across several channels including Facebook, Google and Twitter. 

To add Google Advertising ID:

  1. Install the Google Play Services SDK and import it into your project.  For download details, click here.
  2. Add the following entry to the AndroidManifest.xml as the last entry under application (before </application>):
<meta-data android:name="com.google.android.gms.version"
android:value="@integer/google_play_services_version" />

NOTE: AppsFlyer uses the Google Play Services library for retrieving the Google Advertising ID.

Although the library provides additional services, if you use ProGuard as part of your build process, it has a light footprint. We only use the ads packages from Google Services. If you want to optimize the size of your project you can exclude any other packages.

For more details see https://developers.google.com/android/guides/setup.

Source: https://developer.android.com/google/play-services/setup.html

3.  SDK Initialization and Installation Event (Minimum Requirement for Tracking)

NOTE:  This is the minimum requirement to begin tracking your app installs.

To initialize the SDK, add the following code to your onCreate function:

AppsFlyerLib.getInstance().startTracking(this.getApplication(),"[Dev_Key]");

Replace [Dev_Key] with your own Dev_Key (accessible from your account, see Settings >> Integrate the SDK into... in the AppsFlyer dashboard).

This API enables AppsFlyer to detect installations, sessions, and updates.

IMPORTANT NOTE:  

The sendTracking() was removed since AppsFlyer now recognizes the foreground and background automatically.  

4.  In-App Events Tracking API (Optional)

This API enables AppsFlyer to track post install events. These events are defined by the advertiser and include an event name, in addition to optional event values.

Tracking in-app events helps you measure and analyze how loyal users discover your app, and attribute them to specific campaigns/media sources. It is recommended to take the time and define the events you want to measure to allow you to track ROI (Return on Investment) and LTV (Lifetime Value).

Syntax:

public static void trackEvent(Context context, String eventName, Map eventValues)

context - use getApplicationContext()

eventName is any string to define the event name.

eventValues is a map of event parameters that comprise a rich event.  

Counting revenue as part of a rich in-app event: Use the af_revenue (constant)

AFInAppEventParameterName.REVENUE

event parameter to count revenue as part of an in-app event. You can populate it with any numeric value, positive or negative.

NOTE:  af_price 

AFInAppEventParameterName.PRICE

is not counted as revenue and is a descriptive parameter which does not affect revenue and LTV measurements.

Example 1: Level Achieved In-App Event

Map<String, Object> eventValue = new HashMap<String, Object>();
eventValue.put(AFInAppEventParameterName.LEVEL,9);
eventValue.put(AFInAppEventParameterName.SCORE,100);
AppsFlyerLib.getInstance().trackEvent(content,AFInAppEventType.LEVEL_ACHIEVED,eventValue);

This generates an event of type af_level_achieved with the following event values:

{af_level: 9, af_score: 100}

Example 2: Purchase Event

Map<String, Object> eventValue = new HashMap<String, Object>();
eventValue.put(AFInAppEventParameterName.REVENUE,200);
eventValue.put(AFInAppEventParameterName.CONTENT_TYPE,"category_a");
eventValue.put(AFInAppEventParameterName.CONTENT_ID,"1234567");
eventValue.put(AFInAppEventParameterName.CURRENCY,"USD");
AppsFlyerLib.getInstance().trackEvent(content,AFInAppEventType.PURCHASE,eventValue);

This generates an event of type af_purchase with the following event values:

{af_content_id: “1234567”, af_content_type: “category_a”, af_revenue: 200, af_currency: “USD”}

The purchase event above contains a $200 revenue, appearing as revenue in the dashboard.

NOTE: An In-app event name must be no longer than 45 characters.  Events names with more than 45 characters do not appear in the dashboard, but only in the raw Data, Pull and Push APIs.

For details of the AppsFlyer Rich In-App Events for Android, click here.

5.  Advanced Integration

The APIs below are optional and are part of the advanced integration with the AppsFlyer SDK.

5.1  Set Currency Code (Optional)

You can set a global currency code using the API below, in addition to specific currency codes that can be used as part of each in-app event sent to AppsFlyer. The global currency code is used when af_currency 

AFInAppEventParameterName.CURRENCY

is not sent as part of an in-app event.

USD is the default value. You can find acceptable ISO currency codes here.

Use the following API to set the currency code:

AppsFlyerLib.getInstance().setCurrencyCode("GBP");

5.2  Get AppsFlyer Unique ID (Optional)

An AppsFlyer proprietary unique ID is created for every new install of an app. AppsFlyer’s unique ID is the main ID used by AppsFlyer in the Reports and APIs.

Use the following API to obtain AppsFlyer’s unique ID:

String appsFlyerId = AppsFlyerLib.getInstance().getAppsFlyerUID(this);

5.3  Set Customer User ID (Optional)

Setting your own customer ID enables you to cross-reference your own unique ID with AppsFlyer’s unique ID and the other devices’ IDs. This ID is available in AppsFlyer CSV reports along with Postback APIs for cross-referencing with your internal IDs.

To set your Customer User ID:

AppsFlyerLib.getInstance().setCustomerUserId("myId");

IMPORTANT NOTES:

  • It is recommended to set your Customer User ID as soon as possible as it is only associated to events reported after setting this attribute.
  • You must set the Customer User ID using this API to use AppsFlyer’s integrations with Analytics platforms such as Mixpanel and Swrve.

5.4  Get Conversion Data (Optional)

AppsFlyer allows you to access the user attribution data in real-time directly at SDK level. It enables you to customize the landing page a user sees on the very first app open after a fresh app install.

For more information regarding this advanced functionality, read here.

5.5  Set User Email (Optional)

AppsFlyer enables you to report one or more of the device’s associated email addresses. You must collect the email addresses and report it to AppsFlyer according to your required encryption method.

The following encryption methods are available: Sha1, MD5 and plain.

Example:

AppsFlyerLib.getInstance().setUserEmails(AppsFlyerProperties.EmailsCryptType.MD5, "email1@domain.com","email2@domain.com", ….);

5.6  Reporting Deeplinks for Re-Targeting Attribution (Optional)

To support deeplinking for multiple activities, add the following line in the OnCreate():

AppsFlyerLib.getInstance().sendDeepLinkData(this);

5.7  In-App Purchase Validation (Optional)

AppsFlyer’s SDK provides server verification for in‐app purchases. To set purchase validation tracking, call the validateAndTrackInAppPurchase method inside the onActivityResult function.

This call automatically generates an af_purchase in‐app event.

public static void validateAndTrackInAppPurchase(Context context,
String publicKey, String signature, String purchaseData, String price,
String currency, HashMap<String, String> additionalParameters);

This call has two callback blocks, one for ‘Success’ and one for ‘Failure’ (for any reason, including validation fail).

AppsFlyerLib.getInstance().registerValidatorListener(this,new AppsFlyerInAppPurchaseValidatorListener() {
          public void onValidateInApp() {
              Log.d(TAG, "Purchase validated successfully");
          }
          public void onValidateInAppFailure(String error) {
              Log.d(TAG, "onValidateInAppFailure called: " + error);
          }
      });

5.8  End User Opt-Out (Optional)

AppsFlyer provides you a method to opt‐out specific users from AppsFlyer analytics. This method complies with the latest privacy requirements and complies with Facebook data and privacy policies. Default is NO, meaning tracking is enabled by default.

Use this API during the SDK initialization in Section 4 to explicitly opt-out:

AppsFlyerLib.getInstance().setDeviceTrackingDisabled(true);

5.9  Track App Installs Out of Google Play (Optional)

IMPORTANT NOTE: Google Play is the default store. If you are publishing your app only on Google Play, skip this section.

To track installs out of Google Play, set the channel/store at the appAndroidManifest.xml with a unique channel or any store name for each APK. TheCHANNEL value is case sensitive.

Examples:

Amazon:

<meta-data android:name="CHANNEL" android:value="Amazon" />

Standalone:

<meta-data android:name="CHANNEL" android:value="Standalone"/>

Verizon (Pre-Installed):

<meta-data android:name="CHANNEL" android:value="Verizon" />

NOTE:  You must configure the CHANNEL value at the AppsFlyer dashboard when setting up the app.

Place the meta-data tag before the </application> tag.

For more details on how to track installs for out-of-store apps, read here.

5.10 Track App Uninstalls

AppsFlyer enables you to track app uninstalls.

Add the following permissions to the manifest.  (Apps using push notifications should already have these permissions)

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

    <permission android:name="<your-package-name>.permission.C2D_MESSAGE"
        android:protectionLevel="signature" />
    <uses-permission android:name="<your-package-name>.permission.C2D_MESSAGE" /> <uses-permission android:name="com.google.android.c2dm.permission.RECEIVE" />
Add the following receiver before the </application> tag:
<receiver
android:name="com.google.android.gms.gcm.GcmReceiver"
android:exported="true">
<intent-filter>
<action android:name="com.google.android.c2dm.intent.RECEIVE" />
</intent-filter>
</receiver>
Set the GCM Project Number on your main activity: Add this line immediately after the call to the startTracking().
 
For more information regarding this advanced functionality, read here.
 

5.11 Implementing Deeplinking with OneLink (Optional)

OneLink triggers an app to open at the deeplink location by mentioning the scheme under the af_dp parameter.

You must implement the callback onAppOpenAttribution called by the AppsFlyer SDK.  It returns the Onelink parameters used to trigger the app open. Then, you can parse the values and apply the logic to trigger the relevant app page.

void onAppOpenAttribution(Map<String,String> attributionData); //android
For more information, click here.

6.  Testing the SDK Integration

To learn how to test the SDK integration before submitting to the Google Play Store click hereafter submitting to the Google Play Store click here.

 

Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request
Powered by Zendesk