Summary

The native Android SDK for Tenjin. To learn more about Tenjin and our product offering, please visit https://www.tenjin.com.

Please see our Release Notes to see detailed version history of changes.
We recommend using the latest version of Android Studio.
For Unity integration, please visit https://github.com/tenjin/tenjin-unity-sdk.
For any issues or support, please contact: support@tenjin.com.

Initial setup
- Google Play or Amazon store
- Android other store
Proguard settings
Integration
Impression Level Ad Revenue Integration
Testing

Initial setup

Android Studio

Download the latest Android SDK from here.
Add the Tenjin SDK into your Android Studio project. Go to the Project Navigator in Android Studio. Select the option Project in the Project Navigator. You will find the libs folder under the app module of your Android Studio project.
You need to add the file tenjin.jar or tenjin.aar to the libs folder.

In your Android Studio project under app module, select the build.gradle file, and add the following under the dependencies block:

dependencies {
 implementation fileTree(dir: 'libs', include: ['*.jar', '*.aar'])
 implementation files('libs/tenjin.aar')
}

We have a demo project - tenjin-android-sdk-demo that demonstrates the integration of tenjin-android-sdk. You can this project as example to understand how to integrate the tenjin-android-sdk.

Google Play or Amazon store

If you distribute your apps on Google Play Store or Amazon store, implement the following initial setups.

Permission

The Tenjin SDK requires the following permissions:

<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" /> <!-- Required to get network connectivity (i.e. wifi vs. mobile) -->

Later this year, Google Play Services will require all API level 32 (Android 13) apps using the advertising_id(Android Advertising ID (AAID)) to declare the Google Play Services AD_ID permission (shown below) in their manifest file. Please add this permission as soon as possible. You are also required to update the tenjin-android-sdk to version 1.12.8 in order to use the below permission.

<uses-permission android:name="com.google.android.gms.permission.AD_ID"/>

Android Advertising ID (AAID) and Install Referrer

Add Android Advertising ID (AAID) and Install Referrer libraries, add it to your build.gradle file.

dependencies {
  implementation 'com.google.android.gms:play-services-ads-identifier:{version}'
  implementation 'com.android.installreferrer:installreferrer:{version}'
}

App Store

By default, unspecified is the default App Store. Update the app store value to either googleplay or amazon, depending on your app.

AndroidManifest.xml:

<meta-data
    android:name="TENJIN_APP_STORE"
    android:value="googleplay" />

setAppStore():

TenjinSDK instance = TenjinSDK.getInstance(this, "<API_KEY>");

instance.setAppStore(TenjinSDK.AppStoreType.googleplay);

Other Android store

If you distribute your apps outside of Google Play Store or Amazon store(Other Android store), implement the following initial setups.

Permission

The Tenjin SDK requires the following permissions:

<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" /> <!-- Required to get network connectivity (i.e. wifi vs. mobile) -->

<uses-permission android:name="com.google.android.gms.permission.AD_ID"/>

Android Advertising ID (AAID) and Install Referrer

Add Android Advertising ID (AAID) and Install Referrer libraries, add it to your build.gradle file.

dependencies {
  implementation 'com.google.android.gms:play-services-ads-identifier:{version}'
  implementation 'com.android.installreferrer:installreferrer:{version}'
}

If you are using an Ad Network that targets the IMEI, you will need to add the following permissions enabled.

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

OAID

Tenjin supports promoting your app on other Android App Stores using the Android OAID. We have the following requirements for integrating OAID libraries.

MSA OAID

MSA OAID is an advertising ID for devices manufactured in China that the MSA (Mobile Security Alliance) provides. For integration with the MSA library, download the following oaid_sdk_1.0.25.aar and supplierconfig.json.

Add the following to your project gradle file:

implementation files('libs/oaid_sdk_1.0.25.aar')

Be sure to copy the supplierconfig.json file to the assets folder of your project.

Huawei OAID

For outside of China, you can collect OAID using the library provided by Huawei. For integration with the Huawei OAID library, add the following to your project:

In your build.gradle file, add the Maven address for the Huawei SDKs:

allprojects {
    repositories {
        google()
        maven { url 'https://developer.huawei.com/repo/' }
    }
}

dependencies {
    implementation 'com.huawei.hms:ads-identifier:{version}'
}

Huawei Install Referrer

If you are marketing your app with Huawei App Gallery, add both the Huawei OAID SDK from above and the Install Referrer library.

dependencies {

    implementation 'com.huawei.hms:ads-identifier:{version}'
    implementation 'com.huawei.hms:ads-installreferrer:{version}'

}

App Store

By default, unspecified is the default App Store. Update the app store value to other.

AndroidManifest.xml:

<meta-data
    android:name="TENJIN_APP_STORE"
    android:value="other" />

setAppStore():

TenjinSDK instance = TenjinSDK.getInstance(this, "<API_KEY>");

instance.setAppStore(TenjinSDK.AppStoreType.other);

Proguard Settings

-keep class com.tenjin.** { *; }
-keep public class com.google.android.gms.ads.identifier.** { *; }
-keep public class com.google.android.gms.common.** { *; }
-keep public class com.android.installreferrer.** { *; }
-keep class * extends java.util.ListResourceBundle {
    protected Object[][] getContents();
}
-keepattributes *Annotation*

Do not obfuscate oaid classes:

-keep class XI.CA.XI.**{*;}
-keep class XI.K0.XI.**{*;}
-keep class XI.XI.K0.**{*;}
-keep class XI.xo.XI.XI.**{*;}
-keep class com.asus.msa.SupplementaryDID.**{*;}
-keep class com.asus.msa.sdid.**{*;}
-keep class com.bun.lib.**{*;}
-keep class com.bun.miitmdid.**{*;}
-keep class com.huawei.hms.ads.identifier.**{*;}
-keep class com.samsung.android.deviceidservice.**{*;}
-keep class com.zui.opendeviceidlibrary.**{*;}
-keep class org.json.**{*;}
-keep public class com.netease.nis.sdkwrapper.Utils {public <methods>;}

If you are using Huawei libraries, you can to use these setttings:

-keep class com.huawei.hms.ads.** { *; }
-keep interface com.huawei.hms.ads.** { *; }

Integration

App Initialization

Get your <API_KEY> from your Tenjin dashboard.
In your Activity, import Tenjin: import com.tenjin.android.TenjinSDK;
In the onResume method of your main Activity class, add the following line of code:

TenjinSDK instance = TenjinSDK.getInstance(this, "<API_KEY>");

instance.connect();

NOTE: Please ensure you implement this code on every onResume, not only on the first app open of the app. If we notice that you don't follow our recommendation, we can't give you proper support or your account might be suspended.

As part of GDPR compliance, with Tenjin's SDK you can opt-in, opt-out devices/users, or select which specific device-related params to opt-in or opt-out. optOut() will not send any API requests to Tenjin, and we will not process any events.

To opt-in/opt-out:

import com.tenjin.android.TenjinSDK;

public class TenjinDemo extends ActionBarActivity {
    @Override
    public void onResume() {
        //standard code
        super.onResume()

        //Integrate TenjinSDK connect call
        String apiKey = "<API_KEY>";
        TenjinSDK instance = TenjinSDK.getInstance(this, apiKey);

        boolean userOptIn = checkOptInValue();

        if (userOptIn) {
            instance.optIn();
        }
        else {
            instance.optOut();
        }

        instance.connect();

        //Your other code...
        //...

    }

    protected boolean checkOptInValue(){
        // check opt-in value
        // return true; // if user opted-in
        return false;
    }
}

To opt-in/opt-out specific device-related parameters, you can use optInParams() or optOutParams().

optInParams() will only send device-related parameters that are specified. optOutParams() will send all device-related parameters except ones that are specified.
Kindly note that we require the following parameter to properly track devices in Tenjin's system. If the mandatory parameter is missing, the event will not be processed or recorded.
- advertising_id
If you are targeting IMEI and/or OAID Ad Networks, these params are required:
- imei
- oaid
If you intend to use Google AdWords, these params are required:
- platform
- os_version
- locale
- device_model
- build_id

If you want to only get specific device-related parameters, use optInParams(). In example below, we will only these device-related parameters: ip_address, advertising_id, limit_ad_tracking, and referrer.

String apiKey = "<API_KEY>";
TenjinSDK instance = TenjinSDK.getInstance(this, apiKey);

String[] optInParams = {"ip_address", "advertising_id", "limit_ad_tracking", "referrer"};
instance.optInParams(optInParams);

instance.connect();

If you want to send ALL parameters except specific device-related parameters, use optOutParams(). In the example below, we will send ALL device-related parameters except:

String apiKey = "<API_KEY>";
TenjinSDK instance = TenjinSDK.getInstance(this, apiKey);

String[] optOutParams = {"locale", "timezone", "build_id"};
instance.optOutParams(optOutParams);

instance.connect();

Param	Description	Reference
ip_address	IP Address
advertising_id	Device Advertising ID	Android
limit_ad_tracking	limit ad tracking enabled	Android
oaid	Open Advertising ID	Android
imei	Device IMEI	Android
platform	Platform	Android
referrer	Google Play Install Referrer	Android
os_version	operating system version	Android
device	device name	Android
device_manufacturer	device manufacturer	Android
device_model	device model	Android
device_brand	device brand	Android
device_product	device product	Android
carrier	phone carrier	Android
connection_type	cellular or wifi	Android
screen_width	device screen width	Android
screen_height	device screen height	Android
os_version_release	operating system version	Android
build_id	build ID	Android
locale	device locale	Android
country	locale country	Android
timezone	timezone	Android

Purchase Events

To understand user revenue and purchase behavior, developers can send transaction events to Tenjin. Tenjin will validate transaction receipts for you. Kindly note that we currently only support IAP transactions from Google Play.

IMPORTANT: You will need to add your app's public key in the Tenjin dashboard > Your Android App > Edit. You can retrieve your Base64-encoded RSA public key from the Google Play Developer Console > Select your app > Development Tools > Services & APIs.

After entering your Public Key into the Tenjin dashboard for your app, you can use the Tenjin SDK method below:

public void transaction(String productId, String currencyCode, int quantity, double unitPrice, String purchaseData, String dataSignature)

Example:


public void sendPurchaseEvent(Purchase purchase, Double price, String currencyCode) {
    String sku = purchase.getSku();
    String purchaseData = purchase.getOriginalJson();
    String dataSignature = purchase.getSignature();

    TenjinSDK instance = getTenjinInstance();
    instance.transaction(sku, currencyCode, 1, price, purchaseData, dataSignature);
}

You can verify if the IAP validation is working through our Live Test Device Data Tool. You should see a live event come in:

Disclaimer: If you are implementing purchase events on Tenjin for the first time, make sure to verify the data with other tools you’re using before you start scaling up your user acquisition campaigns using purchase data.

Custom Events

NOTE: The initialization event connect() must come before sending any custom events.

You can use the Tenjin SDK to pass a custom event: eventWithName(String name).

The custom interactions with your app can be tied to level cost from each acquisition source that you use through Tenjin's service. Here is an example of usage:

String apiKey = <API_KEY>;
TenjinSDK instance = TenjinSDK.getInstance(this, apiKey);

//Integrate a custom event with a distinct name - ie. swiping right on the screen
instance.eventWithName("swipe_right");

Custom Events with values:

You can use the Tenjin SDK to pass a custom event with an integer value: eventWithNameAndValue(String name, String value) or eventWithNameAndValue(String name, int value).

Passing an integer value with an event's name allows marketers to sum up and track averages of the values passed for that metric in the Tenjin dashboard. If you plan to use DataVault, these values can be used to derive additional metrics that can be useful.

String apiKey = <API_KEY>;
TenjinSDK.instance = TenjinSDK.getInstance(this, apiKey);

//Integrate a custom event with a distinct name and value - ie. paying 100 virtual coins for an item
instance.eventWithNameAndValue("item", 100);

Using the example above, the Tenjin dashboard will sum and average the values for all events with the name item.

Keep in mind that this event will not work if the value passed not an integer.

Deferred Deeplink

Tenjin supports the ability to direct users to a specific part of your app after a new attributed installation via Tenjin's campaign tracking URLs. You can utilize the getDeeplink method and callback to access the deferred deeplink through the data object.

:warning: NOTE: Deferred Deeplink is a paid feature, so please contact your Tenjin account manager if you are interested in.

Server-to-server integration

Tenjin offers server-to-server integration, which is a paid feature. If you want to access to the documentation, please send email to support@tenjin.com and discuss the pricing.

App Subversion parameter for A/B Testing (requires DataVault)

If you are running A/B tests and want to report the differences, we can append a numeric value to your app version using the appendAppSubversion() method. For example, if your app version 1.0.1, and set appendAppSubversion(8888), it will report app version as 1.0.1.8888.

This data will appear within DataVault, where you will be able to run reports using the app subversion values.

TenjinSDK instance = TenjinSDK.getInstance(this, "<API_KEY>");
instance.appendAppSubversion(8888);
instance.connect();

Attribution Info

Tenjin supports retrieving of attributes, which are required for developers to get analytics installation id (previously known as tenjin reference id). This parameter can be used when there is no advertising id.

:warning: NOTE: Attribution Info is a paid feature, so please contact your Tenjin account manager if you are interested in.

Impression Level Ad Revenue Integration

Tenjin supports the ability to integrate with the Impression Level Ad Revenue (ILRD) feature from,

AppLovin
IronSource
HyperBid
AdMob
TopOn

This feature allows you to receive events which correspond to your ad revenue is affected by each advertisement show to a user. To enable this feature, follow the below instructions.

:warning: NOTE: ILRD is a paid feature, so please contact your Tenjin account manager to discuss the price at first before sending ILRD events.

Testing

You can verify if the integration is working through our Live Test Device Data Tool. Add your advertising_id or IDFA/GAID to the list of test devices. You can find this under Support -> Test Devices. Go to the SDK Live page and send the test events from your app. You should see live events come in:

Android SDK

Summary

Table of contents

Initial setup

Android Studio

Google Play or Amazon store

Permission

Android Advertising ID (AAID) and Install Referrer

App Store

Other Android store

Permission

Android Advertising ID (AAID) and Install Referrer

OAID

MSA OAID

Huawei OAID

Huawei Install Referrer

App Store

Proguard Settings

Integration

App Initialization

Purchase Events

Custom Events

Custom Events with values:

Deferred Deeplink

Server-to-server integration

App Subversion parameter for A/B Testing (requires DataVault)

Attribution Info

Impression Level Ad Revenue Integration

Testing

results matching ""

No results matching ""

Summary

Table of contents

Initial setup

Android Studio

Google Play or Amazon store

Permission

Android Advertising ID (AAID) and Install Referrer

App Store

Other Android store

Permission

Android Advertising ID (AAID) and Install Referrer

OAID

MSA OAID

Huawei OAID

Huawei Install Referrer

App Store

Proguard Settings

Integration

App Initialization

GDPR

Device-Related Parameters

Purchase Events

Custom Events

Custom Events with values:

Deferred Deeplink

Server-to-server integration

App Subversion parameter for A/B Testing (requires DataVault)

Attribution Info

Impression Level Ad Revenue Integration

Testing

results matching ""

No results matching ""