First Steps

Android Classic - First Steps

📍

You are viewing the V3 docs. (For the V2 docs, go here.)


Tips

  1. Classic integration is the preferred method of integration.
  2. While reading the documentation, take a look at our Sample App.

🚧

Updates

  1. As of May 1st, 2021, all versions of the Taboola SDK are available via Artifactory. Please make sure to update your top-level build.gradle file (see below).
  2. As of release 3.3.0, Taboola SDK requires AndroidX. For information about migrating your project to AndroidX, see this article.

📘

The following steps are common to both Classic and Web integrations.

Dependencies

  1. In your top-level build.gradle file, add the Taboola URL for Artifactory under allprojects > repositories:
buildscript {
    repositories {
        ...
    }
    dependencies {
        ...
    }
}

allprojects {
    repositories {
        ...
        maven {
            // Taboola:
            url 'https://taboolapublic.jfrog.io/artifactory/mobile-release'
        }
    }
}

🚧

Checklist

Make sure to add the Taboola URL:

  • In your top-level build.gradle file.
  • Under allprojects > repositories.
  1. In your app module build.gradle file, add the Taboola and AndroidX Browser dependencies:
dependencies {

// Always required:
implementation 'com.taboola:<<androidSDKName>>:<<androidSDKVersion>>'
  
// To open the clicked item in a new *tab*:
implementation '<<androidXBrowser>>'

// For projects based on Java 1.7, use this version *instead*: 
// implementation 'androidx.browser:browser:1.0.0'
   
}

🚧

Make sure to indicate the latest Taboola SDK version - e.g. <<androidSDKVersion>>.

🚧

AndroidX Browser

You can optionally install AndroidX Browser:

If present, Taboola SDK will use it to open the clicked item in a new tab.
If not present, Taboola SDK will use the system browser to open the clicked item in an external window.

Permissions

In AndroidManifest.xml:

  1. Make sure that the following permissions are present:
<uses-permission android:name="android.permission.INTERNET"/>
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE"/>

<!-- (Recommended) Allows Taboola SDK to use the 'IAB OM SDK': -->
<uses-permission android:name="android.permission.ACCESS_WIFI_STATE"/>

📘

IAB OM SDK

Taboola SDK uses the IAB OM SDK to utilize third-party viewability providers and unlock premium demand.

💁

🏻 Need a hand?

Go ahead! Ask a question in our Support Forum.

Tip: Provide as much detail as possible, including your platform and SDK version.

Next steps

Basic Integration

Updated 15 days ago


First Steps


Android Classic - First Steps

Suggested Edits are limited on API Reference Pages

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