Install

Requirements

• Android Studio
• Android (KitKat/4.4+ / API Level 19+)
• Mobile Profile (if using Tealium iQ)
• Universal Data Hub account (if using Tealium UDH)

Sample Apps

To help to familiarize yourself with our library, tracking methods, and best practice implementation, explore the Tealium for Android sample apps.

Get the Code

Clone the Tealium Android library. Cloning the library, rather than downloading, makes it easier to update to future releases.

See the Tealium API for a complete listing of Tealium classes and methods for Android.

Install

Install the Tealium SDK for Android with Maven, or manually.

Maven

To install Tealium for Android library with Maven (recommended):

1. Add the Tealium Maven URL to your project’s top-level build.gradle file:

   allprojects {
     repositories {
       jcenter()
       maven {
         url "https://maven.tealiumiq.com/android/releases/"
       }
     }
   }

2. In your project module’s build.gradle file, add the following Maven dependency:

   dependencies {
     implementation 'com.tealium:library:5.5.5'
   }

Manual

To install Tealium for Android library manually:

1. Add flatDir to your project root build.gradle file:

   allprojects {
     repositories {
        jcenter()
        flatDir {
            dirs 'libs'
        }
     }
   }

2. Add tealium-5.x.x.aar to <PROJECT_ROOT>/<MODULE>/libs.

3. Add the Tealium library dependency to your build.gradle file:

   dependencies {
     implementation(name:'tealium-5.5.5', ext:'aar')
   }

Initialize

To initialize, make the following changes in app’s onCreate() method:

1. Create instance of the Tealium.Config object:

   Tealium.Config tealConfig = Tealium.Config.create(
       this,
       "ACCOUNT",
       "PROFILE",
       "ENVIRONMENT");

2. Call any additional needed methods to set the configuration data such as setDatasourceId():

   tealConfig.setDatasourceId("DATASOURCE_ID");

3. Call the setupInstance() method to setup the app’s lifecycle instance:

   LifeCycle.setupInstance("INSTANCE_NAME", config, true);

4. Call the createInstance() method to create the Tealium instance, passing the configuration instance as a constructor argument:

   tealium = Tealium.createInstance("INSTANCE_NAME", tealConfig);

When Collect is enabled in versions 5.5.1+, data is sent to the profile provided in Tealium.Config object. In previous versions, data is sent to the default profile ("main")

Log Level

The log level is controlled by the remote publish settings and is inferred from the environment set in the initialization.

In versions 5.3.1+, it is possible to override the log level locally with the setForceOverrideLogLevel() method as shown in the following example:

tealConfig.setForceOverrideLogLevel("LOG_LEVEL");

Cookies

Enabling cookies is required if you have enabled Tag Management in your mobile profile.

Add the following code, after the initialization statement, to activate cookie management.

config.getEventListeners().add(createCookieEnablerListener());
private static WebViewCreatedListener createCookieEnablerListener() {
    return new WebViewCreatedListener() {
        @Override
        public void onWebViewCreated(WebView webView) {
            final CookieManager mgr = CookieManager.getInstance();
            // Accept all cookies
            mgr.setAcceptCookie(true);
            if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.LOLLIPOP) {
                mgr.setAcceptThirdPartyCookies(webView, true);
            }
            if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.HONEYCOMB_MR1) {
                CookieManager.setAcceptFileSchemeCookies(true);
            }
            Log.d(TAG, "WebView " + webView + " created and cookies enabled.");
        }
    };
}

This code allows the tag management Webview to accept first-party, third-party, and file scheme cookies.

In versions 5.1.0+, CookieManager is enabled by default. In versions 5.0.4 and below, CookieManager is disabled by default.

Multiprocess Apps

Android 9+ Multiprocess Applications

Android 9 introduced a behavior change around WebView data directories in multiprocess applications. In this change, a WebView no longer shares a single data directory across multiple processes. Typically, you’ll want to have all your Activities that use a WebView in the same process.

If implementing more instances of WebView in more than one process, and you’re using Tealium’s Tag Management solution, we recommend calling setDataDirectorySuffix before creating an instance of Tealium to prevent the app from crashing.

If you need to access Tealium’s tag management cookies and web data, copy it between processes using the getCookie() and setCookie() methods of the CookieManager class.

Addition Reading: Web-based data directories separated by process