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.0 (Released on July 2nd, 2019) Changelog

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

//Include the following dependencies (mandatory)
implementation 'com.android.support:customtabs:27.+'
implementation 'com.squareup.retrofit2:converter-gson:2.5.0' 
  
//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 342.18 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

Please make sure to add the following Proguard rules

For SDK versions 2.1.1 and above:

###---------- Begin: proguard configuration for Taboola Android SDK 2.1.1 and above  ----------

-dontwarn com.taboola.android.api.**
-keepnames class com.taboola.android.integration_verifier.testing.tests.proguard_stub.ProguardVerificationStub

###---------- End: proguard configuration for Taboola Android SDK  ----------

For all Android SDK versions before 2.1.0:

###---------- Begin: proguard configuration for Taboola Android SDK  ----------

-keep class com.taboola.android.monitor.** {*;}
-dontwarn com.taboola.android.api.**
-dontwarn com.google.gson.annotations.**
-dontwarn com.taboola.android.mediation.DfpCustomEventBanner
-dontwarn com.taboola.android.mediation.MoPubCustomEventBanner

###---------- End: proguard configuration for Taboola Android SDK  ----------

Step 4: 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.