Integration

Requirements 

Implementation SDK

CocoaPods (recommended)

Open your project's Podfile and add this line to your app's target build configuration:

pod 'TappxSDK'

In a terminal, run:

pod install --repo-update

If you're new to CocoaPods, see their official documentation for info on how to create and use Podfiles.

Swift Package Manager

The Tappx SDK supports Swift Package Manager starting in version 9.0.0. Follow these steps to import the Swift package:

Note: If migrating from a CocoaPods-based project, run pod deintegrate to remove CocoaPods from your Xcode project. The CocoaPods-generated .xcworkspace file can safely be deleted afterward. If you're adding the Tappx SDK to a project for the first time, this step can be ignored.

1. In Xcode, install the Tappx SDK Swift Package by navigating to File > Add Packages....

2. In the prompt that appears, search for the Tappx SDK Swift Package GitHub repository:

https://github.com/tappx-com/TappxSDK-swift-package-manager.git

3. Select the version of the Tappx SDK Swift Package you want to use. For new projects, we recommend using the Up to Next Major Version.

Once you're finished, Xcode will begin resolving your package dependencies and downloading them in the background. For more details on how to add package dependencies, see Apple's article.

Manual Implementation

Step 1

Download the latest version of the SDK: 

Step 2

Drag the "TappxFramework.framework" and "OMSDK_Tappx.xcframework" files inside the Xcode Project Frameworks folder.

Step 3

Once it’s done, in the options screen check the options as in the below screenshot and click finish:

Step 4

Go to “Frameworks, Libraries, and Embedded Content” and make sure that the “embed” value for each added Tappx framework library is set to Embed & Sign.

Step 5

Go to Build Settings in your project and add the -ObjC linker flag to “Other Linker Flags”

iOS 9 Considerations

App Transport Security

In order to prevent your application being affected by the new measures implemented by Apple, add the following lines to your “Info.plist” file:

If you want to learn more about this aspect, see App Transport Security (ATS).

Initialization

Initiating the SDK 

To initiate the SDK you will need to call the initialization method with your Tappx Key in the AppDelegate file:

[TappxFramework addTappxKey:@"**YOUR-APP-KEY**"];

TappxFramework.add(tappxKey:"**YOUR-APP-KEY**")

TappxFramework.add(tappxKey:"**YOUR-APP-KEY**")

Setting up the Endpoint

Please, if you don’t have an Endpoint contact our supply team at sdk@tappx.com.

Add the following lines:

[TappxFramework setEndpoint: @"ENDPOINT"];

TappxFramework.set(endpoint: "ENDPOINT")

TappxFramework.set(endpoint: "ENDPOINT")

COPPA flagging

In the application of the COPPA regulations, to indicate that the content of your app is intended for children under 13 years of age, you must use the following code:

[TappxFramework setCoppaCompliance:YES];

TappxFramework.setCoppaCompliance(coppa: true)

TappxFramework.setCoppaCompliance(coppa: true)

The value declared (true or false)  in the argument of the setCoppaCompliance function will determine whether advertising restrictions will be activated or not.

Select an Ad Format

The Tappx SDK is now imported and you're ready to implement an ad. Tappx offers a number of different ad formats, so you can choose the one that best fits your app's user experience.

Banner/MREC

Banner ad units display rectangular ads that occupy a portion of an app's layout. They can refresh automatically after a set period of time. This means users view a new ad at regular intervals, even if they stay on the same screen in your app. They're also the simplest ad format to implement.

Interstitial

Interstitial ad units show full-page ads in your app. Place them at natural breaks and transitions in your app's interface, such as after level completion in a gaming app.

Rewarded

Rewarded ad units enable users to play games, take surveys, or watch videos to earn in-app rewards, such as coins, extra lives, or points. You can set different rewards for different ad units, and specify the reward values and items the user received.