Getting Started with the iOS SDK

iOS SDK Quick Start Guide

Latest version: 2.8.1 (Released on September 22nd, 2020) Changelog

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 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)

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.8.1'
use_frameworks!
pod 'TaboolaSDK', '2.8.1'

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" == 2.8.1

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

Upgrading from SDK version

Special instructions

SDK 2.0.0 - 2.3.11 (including)

Change the Carthage framework filename from "TaboolaFramework.framework" to "TaboolaSDK.framework"

SDK 1.x.x

Any 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

Updated about a month ago


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.