Edit

Integrating and Initializing the SDK

The Rokt SDK for iOS applications can be used by Rokt partners to display overlay or embedded placements, or by Rokt advertisers to record conversions for campaigns. The Rokt SDK for iOS is deployed using CocoaPod.

All use cases of the SDK will follow the same initial steps to integrate and initialize the SDK in your application. At a high level, these steps are:

  1. Set up a workspace using CocoaPod/Swift Package Manager
  2. Add the Rokt-Widget
  3. Install the pod/package
  4. Initialize the Rokt SDK

Following these steps, the execute method of the SDK can then be used in various ways to suit the required use case.

Before you begin

This guide assumes that you are familiar with CocoaPod or Swift Package Manager and know how to install dependencies for iOS development. For more information, check out CocoaPod's or Swift Package Manager's user guides.

CocoaPods

Set up a workspace using this CocoaPods tutorial.

Adding the Rokt-Widget pod to the pod file

Add the Rokt-Widget pod to the pod file:

pod 'Rokt-Widget'

Installing the pod

Install the pod:

pod install

Swift Package Manager

On Xcode:

  • Go to File > Swift Packages > Add Package Dependency
  • Add https://github.com/ROKT/rokt-sdk-ios.git
  • Select Up to Next Major with 3.5.0

or add below code to the dependencies part of Package.swift.

dependencies: [
    .package(url: "https://github.com/ROKT/rokt-sdk-ios.git", .upToNextMajor(from: "3.5.0"))
]

Note on Objective-C integration: The Rokt SDK for iOS is implemented using Swift. If you are using Objective-C, you need to import the bridging header file from the framework into the .h/.m file.

#import <Rokt_Widget/Rokt_Widget-Swift.h>

If you are having trouble installing and are receiving an error saying that the SWIFT_VERSION is not defined, please add a user-defined variable SWIFT_VERSION. This variable should be set to "5" for iOS SDK versions 2.0 and above. This variable should be set to "4.2" for iOS SDK version 1.2.1.

Initializing the Rokt SDK for iOS

Initialize the Rokt SDK for iOS prior to using it in any ViewController. We recommend calling the init method from the applicationDidFinishLaunching handler.

Contact Rokt for the Rokt Tag ID associated with your account. In order to test your integration, you can use the Rokt Tag ID below, but this needs to be replaced by your unique Rokt Tag ID before you launch in production.

Test Integration Tag ID: 222

Swift

//file => AppDelegate.swift

import Rokt_Widget

func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {  
// The following will reveal a demo integration. To view your integration, replace the integration test tag ID (222) with your unique Rokt Tag ID  
    Rokt.initWith(roktTagId: "222")  
    return true
}

Objective-C

//file => AppDelegate.m

#import <Rokt_Widget/Rokt_Widget-Swift.h>
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
      // Override point for customization after application launch.
      [Rokt initWithRoktTagId:@"222"];
      return YES;
}

Next steps

Your next steps depend on the use case of your integration. Check out these resources for more information:

← VersionLaunching an overlay placement →