Getting Started with the iOS SDK

iOS SDK Quick Start Guide

Latest version: 2.1.6 (Released on June 5th, 2019)

You can choose to install the SDK via CocoaPods or Carthage

Important

  • Taboola SDK size is dynamic and changes according to the integration type
  • Taboola SDK support iOS 6.0 and above (for native apps), and iOS 7.0 and above (for hybrid apps)

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', '2.1.6'
use_frameworks!
pod 'TaboolaSDK', '2.1.6'

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/Carthage.json" == 2.1.6

Step 3: Run "carthage update" to build the framework, and drag the built TaboolaFramework.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/TaboolaFramework.framework

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

$(BUILT_PRODUCTS_DIR)/$(FRAMEWORKS_FOLDER_PATH)/TaboolaFramework.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.

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/Carthage.json" == [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 iOS SDK


iOS SDK Quick Start Guide

Suggested Edits are limited on API Reference Pages

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