Getting Started with the Android SDK

Getting started with the Taboola Android SDK

Step 1: Add the library dependency to your project

Latest version: 2.3.7 (Released on October 24th, 2019) Changelog

//Include the Taboola SDK binary
implementation 'com.taboola:android-sdk:2.3.7'

//Include the following dependencies (mandatory)
implementation 'com.android.support:customtabs:27.+'
  
//Note: It is advised to use the same version for Custom Tabs
//and your project's compileSdkVersion. For example: 
//For 'compileSdkVersion' 27 use 'com.android.support:customtabs:27.+'

Important

  • Taboola SDK supports Android API 14 and above
  • The SDK size is 398.24 KB

Step 2: Verify the AndroidManifest.xml

Include this line in your app’s AndroidManifest.xml to allow Internet access and read the network state

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

Step 3: Proguard rules

Consumed Proguard Rules

Starting from Android SDK version 2.3.7, Taboola SDK will automaticly add the Proguard rules to the project. If you wish to work manually, you can use the following rules.

Add the following Proguard rules (relevant for Android SDK version 2.3.3 (including) and above)

###---------- Begin: proguard configuration for Taboola Android SDK 2.3.3 and above  ----------
-dontwarn com.taboola.android.api.**
-keepnames class com.taboola.android.integration_verifier.testing.tests.proguard_stub.ProguardVerificationStub
-keep class com.taboola.android.TaboolaContextProvider { *; }
###---------- End: proguard configuration for Taboola Android SDK 2.3.3 and above  ------------

For the PG rule for Android SDK versions 2.1.1 until SDK version 2.3.0 (including) - click here

For the PG rules for Android SDK versions before 2.1.0 - click here

Step 4: Allowing HTTP traffic (optional)

Starting with Android 9.0 (API level 28), HTTP traffic (non-secured) is disabled by default. We recommend allowing HTTP traffic to support Taboola's advertisers who are not using secure landing pages.

If you can allow HTTP traffic, please add the android:usesCleartextTraffic="true" setting to your AndroidManifest.xml file

<?xml version="1.0" encoding="utf-8"?>
<manifest ...>
    <uses-permission android:name="android.permission.INTERNET" />
    <application
        ...
        android:usesCleartextTraffic="true"
        ...>
    </application>
</manifest>

Step 5: Updating the SDK (optional)

We encourage developers to use the latest SDK version. To stay up-to-date, please check our announcements and change log. We highly recommend updating to the latest SDK version once a quarter.

When upgrading the SDK please update your build.gradle file with the latest version - replace the [LATEST_SDK_VERSION_HERE] with the latest version number

implementation 'com.taboola:android-sdk:[LATEST_SDK_VERSION_HERE]'

What's Next

Choose the type of Taboola asset you would like to integrate

Taboola Widget
Taboola Feed

Getting Started with the Android SDK


Getting started with the Taboola Android SDK

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.