SDK DocumentationRecipesAnnouncementsSupport Forum
AndroidiOSAnnouncementsSupport Forum


SDK version

ο»Ώ[**SDK V3**](πŸ”—ο»Ώ) is the _preferred_ **Taboola SDK** version.


ο»Ώ

_All versions_ of the **Taboola SDK** are available via **Artifactory**.

Android 13

As of **August 31, 2023**, Google requires all Android apps to target **Android 13**.

If you are using **SDK 2.x**, you **must** use **SDK 2.10.0** or higher.


ο»Ώ

For more information, see the <a href="https://developer.android.com/google/play/requirements/target-sdk" target="_blank">Google announcement</a>.

## Step 1: Add the Repository URL

There are 2 options, depending on how you configure your project repositories.

### build.gradle

If you are using `build.gradle` to configure your repositories, add the **Taboola URL** in your **top-level** `build.gradle` file, under `allprojects` > `repositories`:

ο»Ώ

ο»Ώ

Add the **Taboola** URL:

  • In your **top-level** `build.gradle` file.

  • **Under** `allprojects` > `repositories`.

### settings.gradle

If you are using `settings.gradle` to configure your repositories, add the **Taboola URL** in `settings.gradle`:

ο»Ώ

## Step 2: Add the library dependency to your project

In your **app module** `build.gradle` file, add the **Taboola SDK** _dependencies_:

ο»Ώ

ο»Ώ

Make sure to indicate the latest [**Taboola SDK version**](πŸ”—ο»Ώ) - e.g. `<<androidV2Version>>` for **SDK V2**.

Gradle plugin version

If you get an _`Android resource linking failed`_ Gradle error, see this [link](πŸ”—ο»Ώ).

## Step 3: For Publishers who use AndroidX

Taboola recommends using Android SDK 2.7.0 and above if you're using AndroidX in your project.

Please follow these two steps to make sure the SDK and your AndroidX works well:

  1. Taboola SDK requires to enable the "Jetifier". Please add the following lines to your `gradle.properties` file:

ο»Ώ
  1. In your **app module** `build.gradle` file, add the `androidx.browser` dependency, _in place of_ `com.android.support:customtabs`.

ο»Ώ

## Step 4: Verify the AndroidManifest.xml

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

ο»Ώ

## Step 5: Proguard rules

Consumed Proguard Rules

Starting from Android SDK version 2.3.7, **Taboola SDK** will automatically 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)

ο»Ώ

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 6: 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

ο»Ώ

## How to update 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.

### How to upgrade?

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

ο»Ώ

### Special Instructions for upgrading from a specific Android SDK versions

Upgrading from SDK versionnSpecial instructions
2.0.0 until 2.2.1 (including)When using Widget via Native (SDK Standard), the SDK will update the widget height more than once
1.x.xAny upgrade from SDK 1.x.x to SDK 2.x.x should be considered as a new integration. Please go over all of the steps outlined on this documentation

SDK Size

  • Taboola SDK supports Android API 14 and above

  • The SDK size is 441.89 KB