Getting Started with the iOS SDK

📘

SDK V2 vs SDK V3

On June 15, 2021, we released SDK V3 - the preferred SDK version for new integrations.

Publishers using SDK V2 should continue to do so, until instructed otherwise.

---

Make sure to indicate the latest version in Cocoapods or Carthage - e.g. <<iosV2Version>> for SDK V2.

🚧

Xcode 13 and iOS 15 (2021-10-07)

We recently became aware of a minor bug in Xcode 13 and iOS 15. When making fast-fling gestures, this issue may prevent smooth scrolling through the Taboola Feed.

This affects:

• Apps built with Xcode 13.0 that are running on iOS 15 devices.
• iOS Classic Integration (Taboola SDK 2 and SDK 3).

Our team is working with Apple Support to address this issue. In the meantime, if you do encounter it, we recommend using the latest version of Xcode 12 to build your App.

📘

Xcode 11

If you are using Xcode 11, add the following line to your .xcodeproj/project.pbxproj file.
This line should be added under both <DEVELOPMENT_TEAM> entries:

"EXCLUDED_ARCHS[sdk=iphonesimulator*]" = "";

📘

Important Guidelines

• Taboola SDK size is dynamic and changes according to the integration type
• Taboola SDK support iOS 9.0 and above (deployment target: iOS 9)
• The maximum supported Base SDK is iOS 14
• Minimum xCode version - 9.2
• The compiled iOS SDK size is 121KB (framework file is 2.1MB)

Overview

You can install the SDK via Cocoapods or Carthage, as explained below.

Installation with CocoaPods

CocoaPods is a dependency manager for Xcode, which automates and simplifies the process of using third-party libraries, like Taboola, in your projects.

Step 1: Install CocoaPods with the following command:

$ gem install cocoapods

Step 2: Edit the Podfile
To integrate Taboola into your Xcode project using CocoaPods, specify it in your Podfile:

pod 'TaboolaSDK', '<<iosV2Version>>'

use_frameworks!
pod 'TaboolaSDK', '2.8.3'

🚧

Make sure to indicate the latest version - e.g. <<iosV2Version>> for V2.

Step 3: Run pod install.

$ pod install

Installation with Carthage

Carthage is a decentralized dependency manager that builds your dependencies and provides you with binary frameworks. This requires a minimum deployment target of iOS 8.0.

Step 1: You can install Carthage with Homebrew using the following command:

$ brew update
$ brew install carthage

Step 2: To integrate Taboola into your Xcode project using Carthage, specify it in your Cartfile:

binary "https://cdn.taboola.com/taboola-mobile-sdk/ios/carthage/TaboolaSDK.json" == <<iosV2Version>>

🚧

Make sure to indicate the latest version - e.g. <<iosV2Version>> for V2.

Step 3: Run "carthage update" to build the framework, and drag the built TaboolaSDK.framework into your Xcode project.

Step 4: On your application target Build Phases settings tab, click the + icon and select New Run Script Phase.
a. Create a Run Script in which you specify your shell (ex: /bin/sh)
b. Add the following contents to the script area below the shell:

/usr/local/bin/carthage copy-frameworks

c. Add the paths to the frameworks you want to use under “Input Files". For example:

$(SRCROOT)/Carthage/Build/iOS/TaboolaSDK.framework

d. Add the paths to the copied frameworks to the “Output Files”. For example:

$(BUILT_PRODUCTS_DIR)/$(FRAMEWORKS_FOLDER_PATH)/TaboolaFramework.framework

🚧

Important!

As of iOS SDK version 2.4.0 and above, the Carthage framework name is changed to "TaboolaSDK.framework"

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.

How to upgrade?

When upgrading the SDK please update your Podfile or Cartfile file with the latest version - replace the [LATEST_SDK_VERSION_HERE] with the latest version number

//Podfile:
pod 'TaboolaSDK', '[LATEST_SDK_VERSION_HERE]'

//Cartfile
binary "https://cdn.taboola.com/taboola-mobile-sdk/ios/carthage/TaboolaSDK.json" == [LATEST_SDK_VERSION_HERE]

Special Instructions for upgrading from a specific iOS SDK versions