Mobile SDK
iOS SDK

Introduction
Welcome to the guide on integrating AdsPostX into your iOS application. This comprehensive documentation is designed to assist developers in seamlessly incorporating AdsPostX Offers into their iOS Apps. Whether you're looking to monetize your app or enhance user engagement, AdsPostX provides a powerful solution.

Before getting started, please ensure that you already have an account with AdsPostX. If you don't have an account yet, you can easily create a new one now. Once you have your account credentials, you can proceed with the integration process outlined in this guide.

Let's dive in and explore the features and functionalities of the AdsPostX iOS SDK to unlock the full potential of AdsPostX within your iOS Application.
Requirements
Before you begin the integration process, make sure you have the following requirements in place:
iOS Build Support Tools:
You must install Xcode and the necessary build support tools. Xcode is available for download from the Mac App Store. Install Xcode and follow the installation instructions to set up the required development tools.
Cocoapods: Cocoapods is a dependency manager for iOS projects. CocoaPods simplifies the process of integrating third-party libraries into your iOS project. Install CocoaPods by running the following command in your terminal:
terminal
$ sudo gem install cocoapods
$ sudo gem install cocoapods
﻿
Quick Walkthrough
Here's a quick walkthrough from installation to showing Offers to get you started on the fastest route. 
Standard Integration through Cocoapods:
<!-- <p>paste iframe code here</p> -->
<div style="position: relative; padding-bottom: calc(53.135416666666664% + 44px); height: 0;"><iframe src="https://app.supademo.com/embed/clkmmkforpdljzg70sq2hey4i" frameborder="0" webkitallowfullscreen="true" mozallowfullscreen="true" allowfullscreen style="position: absolute; top: 0; left: 0; width: 100%; height: 100%;"></iframe></div>
<!-- <p>paste iframe code here</p> -->
<div style="position: relative; padding-bottom: calc(53.135416666666664% + 44px); height: 0;"><iframe src="https://app.supademo.com/embed/clkmmkforpdljzg70sq2hey4i" frameborder="0" webkitallowfullscreen="true" mozallowfullscreen="true" allowfullscreen style="position: absolute; top: 0; left: 0; width: 100%; height: 100%;"></iframe></div>
﻿
Minimum Deployment Target
Ensure that your XCode Project meets the minimum deployment target requirements:
The minimum deployment target for your XCode Project should be iOS 13+.
Open your client app iOS project-workspace (*.xcworkspace) in XCode.
Select your project at PROJECT level. On the Right side, Under info section, you will find Deployment Target Section. Under it, you will find iOS Deployment Target, make sure it is ≥ 13.0
﻿
      4. Select your project at TARGETS level. Under General → Minimum Deployments make sure the value for iOS is ≥ 13.0
﻿
     5. Open a Pod file, If you are using a global platform, check to make sure platform :ios, '13.0’. (OR any value above 13.0 will work) has been updated.
Having these requirements in place will allow you to proceed with the integration of the AdsPostX iOS SDK smoothly.
Latest version
version
﻿1.0.7﻿
Installation
Depending on your iOS app requirements, please follow the appropriate guide below.
﻿Manual Installation﻿﻿
﻿Using CocoaPods﻿﻿
﻿Using Swift Package Manager﻿﻿
Manual Installation
﻿Download and build the AdsPostX iOS Demo App﻿
Before integrating AdsPostX into your iOS app, we recommend that you download and build our demo app to familiarize yourself with the code and implementation methods.
Download iOS SDK Demo App
﻿
Steps to build and run the demo app:
Unzip the downloaded file
Open the DemoApp folder.
Open DemoApp.xcodeproj with Xcode.
Select either a system-connected iOS device or simulator and then select Run.
If you are running the demo app on a device, make sure a valid provision profile is selected before running the demo app on the device.
Download the AdsPostX iOS SDK
Obtain the latest version of the AdsPostX iOS SDK by using the link below:
Download AdsPostX iOS SDK
﻿
Unzip the downloaded zip file.
 Extract its contents into a directory.
 It will contain AdsPostX.xcframework. 
Follow the instructions below to integrate AdsPostX with your mobile app. 
Include the SDK in your app
In the directory that contains the files that were extracted, locate the AdsPostX.xcframework file.
Drag and drop AdsPostX.xcframework into your Xcode project.
Select the project and then navigate to the General tab.
Expand the Frameworks, Libraries, and Embedded Content section.
Select Embed & Sign / Embed for AdsPostX.xcframework.
﻿
Using CocoaPods
Before you begin
This guide assumes that you are familiar with CocoaPods and know how to install dependencies for iOS development. For more information, check out CocoaPods's user guides.
Installation using CocoaPods
Make sure you have already setupCocoaPods.
Add the AdsPostX to podfile.
Install/Update the pods:
Swift
pod 'AdsPostX'
pod 'AdsPostX'
﻿
Open the Terminal, navigate to client app project root directory and type:
Shell
pod install // to install adspostx pod

OR

pod update // to update to the latest adspostx version
pod install // to install adspostx pod

OR

pod update // to update to the latest adspostx version
﻿
Using Swift Package Manager
Before you begin
This guide assumes that you are familiar with Swift Package Manager and know how to install dependencies for iOS development. For more information, check out Swift Package Manager's user guides.
Installation using Swift Package Manager
In XCode: 
Go to File > Add Packages 
Then, paste URL:https://github.com/AdsPostX/AdsPostX-iOS-Distribution-SPM.git in the search bar, it will show AdsPostX-iOS-Distribution-SPM in a list, Select Up to Next Major with 1.0.7. 
Wait for the process to finish. 
Select Add Package button.  
That's it! You should now see an AdspostX package in the project window as depicted below. 
Please note that the AdsPostX version number may be different from the image below depending upon which version you have installed.
﻿
Integration
There are two ways to integrate AdsPostX into your iOS App.
Native Ads API Integration
Native Ads API provides a highly flexible implementation method. With Native Ads API, you can retrieve Offers in a JSON response and then parse and display them according to your specific requirements. The JSON response contains individual fragments that make up an Offer, giving you full control over how the ad is rendered. This method allows for deep customization and styling to seamlessly blend the Offers into your app's UI.
Standard Integration
If you prefer a quick and straightforward way to display AdsPostX Offers without the need for extensive customization, the Standard integration is a suitable option. It offers a pre-built modal box that can be easily integrated into your iOS App. While it may not provide the same level of customization as Native Ads, the Standard integration does allow basic theming options that can be controlled through the AdsPostX dashboard. This option is ideal for those who prioritize simplicity and quick implementation.
Native Ads API Integration
Once you've installed the AdsPostX iOS SDK using the step(s) above, you can simply use the getOffers call to retrieve Offers.  You will need your SDK ID﻿ in order to do so. 
Usage
Import AdsPostX in your iOS Project.
Swift
import AdsPostX
import AdsPostX
﻿
Here is an example of a fully-formed call using the getOffers method:
swift
var sdkId: String = "<YOUR_SDK_ID>"
var parameters: [String: Any] = [:]
parameters["country"] = "USA"
parameters["firstname"] = "dev"
parameters["creative"] = "1"

AdsPostx.getOffers(sdkId: sdkId, parameters: parameters) { [weak self] result in
    switch result {
    case .success(let json):
        if let jsonObject = json as? [String: Any],
           let data = jsonObject["data"] as? [String: Any],
           let offersArray = data["offers"] as? [[String: Any]] {
            self?.offers = offersArray.compactMap { (offerData) -> Offer? in
                do {
                    let jsonData = try JSONSerialization.data(withJSONObject: offerData)
                    let decoder = JSONDecoder()
                    let offer = try decoder.decode(Offer.self, from: jsonData)
                    return offer
                } catch let error {
                    print("Error decoding offer data: \(error.localizedDescription)")
                    return nil
                }
            }
        } else {
            print("Error: Invalid JSON format")
        }
    case .failure(let error):
        print("Error getting offers: \(error.localizedDescription)")
    }
}
var sdkId: String = "<YOUR_SDK_ID>"
var parameters: [String: Any] = [:]
parameters["country"] = "USA"
parameters["firstname"] = "dev"
parameters["creative"] = "1"

AdsPostx.getOffers(sdkId: sdkId, parameters: parameters) { [weak self] result in
    switch result {
    case .success(let json):
        if let jsonObject = json as? [String: Any],
           let data = jsonObject["data"] as? [String: Any],
           let offersArray = data["offers"] as? [[String: Any]] {
            self?.offers = offersArray.compactMap { (offerData) -> Offer? in
                do {
                    let jsonData = try JSONSerialization.data(withJSONObject: offerData)
                    let decoder = JSONDecoder()
                    let offer = try decoder.decode(Offer.self, from: jsonData)
                    return offer
                } catch let error {
                    print("Error decoding offer data: \(error.localizedDescription)")
                    return nil
                }
            }
        } else {
            print("Error: Invalid JSON format")
        }
    case .failure(let error):
        print("Error getting offers: \(error.localizedDescription)")
    }
}
﻿
where Offer struct as follows:
Swift
struct Offer: Codable {
    var id: Int
    var title: String?
    var description: String?
    var clickURL: String?
    var image: String?
    var pixel: String?
    var ctaYes: String?
    var ctaNo: String?

    enum CodingKeys: String, CodingKey {
        case id
        case title
        case description
        case clickURL = "click_url"
        case image
        case pixel
        case ctaYes = "cta_yes"
        case ctaNo = "cta_no"
    }

    init(from decoder: Decoder) throws {
        let container = try decoder.container(keyedBy: CodingKeys.self)
        id = try container.decode(Int.self, forKey: .id)
        title = try container.decodeIfPresent(String.self, forKey: .title)
        description = try container.decodeIfPresent(String.self, forKey: .description)
        clickURL = try container.decodeIfPresent(String.self, forKey: .clickURL)
        image = try container.decodeIfPresent(String.self, forKey: .image)
        pixel = try container.decodeIfPresent(String.self, forKey: .pixel)
        ctaYes = try container.decodeIfPresent(String.self, forKey: .ctaYes)
        ctaNo = try container.decodeIfPresent(String.self, forKey: .ctaNo)
    }

    func encode(to encoder: Encoder) throws {
        var container = encoder.container(keyedBy: CodingKeys.self)
        try container.encode(id, forKey: .id)
        try container.encodeIfPresent(title, forKey: .title)
        try container.encodeIfPresent(description, forKey: .description)
        try container.encodeIfPresent(clickURL, forKey: .clickURL)
        try container.encodeIfPresent(image, forKey: .image)
        try container.encodeIfPresent(pixel, forKey: .pixel)
        try container.encodeIfPresent(ctaYes, forKey: .ctaYes)
        try container.encodeIfPresent(ctaNo, forKey: .ctaNo)
    }
    
}
struct Offer: Codable {
    var id: Int
    var title: String?
    var description: String?
    var clickURL: String?
    var image: String?
    var pixel: String?
    var ctaYes: String?
    var ctaNo: String?

    enum CodingKeys: String, CodingKey {
        case id
        case title
        case description
        case clickURL = "click_url"
        case image
        case pixel
        case ctaYes = "cta_yes"
        case ctaNo = "cta_no"
    }

    init(from decoder: Decoder) throws {
        let container = try decoder.container(keyedBy: CodingKeys.self)
        id = try container.decode(Int.self, forKey: .id)
        title = try container.decodeIfPresent(String.self, forKey: .title)
        description = try container.decodeIfPresent(String.self, forKey: .description)
        clickURL = try container.decodeIfPresent(String.self, forKey: .clickURL)
        image = try container.decodeIfPresent(String.self, forKey: .image)
        pixel = try container.decodeIfPresent(String.self, forKey: .pixel)
        ctaYes = try container.decodeIfPresent(String.self, forKey: .ctaYes)
        ctaNo = try container.decodeIfPresent(String.self, forKey: .ctaNo)
    }

    func encode(to encoder: Encoder) throws {
        var container = encoder.container(keyedBy: CodingKeys.self)
        try container.encode(id, forKey: .id)
        try container.encodeIfPresent(title, forKey: .title)
        try container.encodeIfPresent(description, forKey: .description)
        try container.encodeIfPresent(clickURL, forKey: .clickURL)
        try container.encodeIfPresent(image, forKey: .image)
        try container.encodeIfPresent(pixel, forKey: .pixel)
        try container.encodeIfPresent(ctaYes, forKey: .ctaYes)
        try container.encodeIfPresent(ctaNo, forKey: .ctaNo)
    }
    
}
﻿
where
Parameter Name
Parameter Type
Optional/Required
Description
sdkId
string
required
SDK ID as provided
parameters
dictionary [String: Any]
optional
User payload parameters and other filters/options
It returns a Result object with a dictionary or error details.
Parameter Name
Data Type
Description
json
dictionary [String: Any]
contains offers details.
error
error
contains error info
The getOffers method is effectively a wrapper around the AdsPostX Native Ads API which you can learn more about here.  The payload and options values can be passed through and used interchangeably with the Native Ads API.
In the example above, the parameters parameter is passing user payload information including country and firstname.  The payload parameter also includes a creatives: 1 option to instruct AdsPostX to only return Offers that have at least one creative.
The getOffers response object will contain Offers if Offers are available and can then be parsed to display them using the Offers fragments provided.
To accurately report events such as impressions, opt-outs, etc, each Offer contains beacon URL to fire based on the nature of the event.

For impressions, use the pixel attribute.

For other events, refer to the beacons attribute to handle.  For example, if the user presses "No thanks" on the offer, fire the no_thanks_click beacon URL.
getOffers Response Example
Success
A successful call to getOffers would return a JSON response (in a dictionary form) as follows:
JSON
{
  "data": {
    "offers": [
      {
        "id": 4053,
        "mini_text_html": "<p>Sample Mini Text here</p>",
        "description": "<p>Upgrade your headwear game by grabbing this Texas Rangers Chrome 59FIFTY Fitted Hat from New Era. Highlighting your loyalty to the team will be super easy thanks to the distinctive Texas Rangers graphics embroidered on the crown.</p><p>Upgrade your headwear game Now. Don't just wait. </p>",
        "creatives": [
          {
            "url": "https://adpx.b-cdn.net/campaigns/1330/2c893d4226891cc160dd6658a660bbeb.png",
            "type": "png",
            "width": 900,
            "id": 1009,
            "is_primary": true,
            "aspect_ratio": 1,
            "height": 900
          },
          {
            "url": "https://adpx.b-cdn.net/campaigns/1330/e4ea32bf3c8f2c6434d59df46a986dc1/avif",
            "type": "heif",
            "width": 900,
            "id": 1010,
            "is_primary": false,
            "aspect_ratio": 1,
            "height": 900
          }
        ],
        "image": "https://adpx.b-cdn.net/campaigns/1330/2c893d4226891cc160dd6658a660bbeb.png",
        "adv_pixel_url": "",
        "cta_no": "No, Thanks",
        "title": "Texas Rangers New Era Chrome 59FIFTY Fitted Hat - Stone/Black",
        "beacons": {
          "no_thanks_click": "https://track.adspostx.com/event/record/no_thanks_click?oid=4053&cid=1330&pid=800&sess_id=e7ff9c17a762751520be3315ba22fe9e7be8323f",
          "close": "https://track.adspostx.com/event/record/close?oid=4053&cid=1330&pid=800&sess_id=e7ff9c17a762751520be3315ba22fe9e7be8323f"
        },
        "click_url": "https://track.adspostx.com/sdk/offer-click?o_id=4053&c_id=1330&p_id=800&sess_id=e7ff9c17a762751520be3315ba22fe9e7be8323f",
        "useraction_url": "https://www.adspostx.com/get-started?click={click_id}",
        "useraction_cta": "Buy Now",
        "cta_yes": "Yes, please",
        "pixel": "https://track.adspostx.com/sdk/v2/impression/p.png?o_id=4053&c_id=1330&p_id=800&sess_id=e7ff9c17a762751520be3315ba22fe9e7be8323f&cbuster={CBUSTER}"
      }
    ],
    "styles": {    //styles settings for the template associated with the account used by the Standard Integration. Can be ignored.
      "offerText": {
        "fontSize": 14,
        "font": null,
        "buttonYes": {
          "hover": "#1A56DB",
          "stroke": "#1C64F2",
          "background": "#1C64F2",
          "color": "#ffffff"
        },
        "buttonNo": {
          "hover": "#E5E7EB",
          "stroke": "#9CA3AF",
          "background": "#ffffff",
          "color": "#6B7280"
        },
        "textColor": "#000"
      },
      "footer": {
        "publisher_name": "Ansh LLC",
        "privacy": "https://www.adspostx.com/privacy-policy",
        "text": "Powered by AdsPostX",
        "publisher_privacy_policy": "https://www.enefits.co/privacy",
        "disclaimer": ""
      },
      "header": {
        "text": "Your order is complete",
        "lead_in_text_color": "#000000",
        "lead_in_text": "Here are some offers from brands you love!",
        "textColor": "#ffffff",
        "fontSize": 16,
        "background": "#1A56DB"
      },
      "settings": {
        "screen_margin": 0,
        "darken_bg_non_centered": false,
        "show_disclaimer": false,
        "ad_position": "center",
        "ad_animation": "bottom-top",
        "enable_vertical_offset": false,
        "button_order": "neg_first",
        "delay": 0,
        "mobile_vertical_offset": null,
        "darken_bg": true,
        "fixed_progress_bar": false
      },
      "popup": {
        "shadow": "#8f8f8f",
        "borderRadius": {
          "bottom_right": "5",
          "top_right": "5",
          "top_left": "5",
          "bottom_left": "5"
        },
        "background": "#ffffff",
        "lightBox": "#000"
      }
    },
    "count": 1    //number of Offers returned by the getOffers method determined in the AdsPOstX dashboard via Settings/Behaviour.
  }
}

{
  "data": {
    "offers": [
      {
        "id": 4053,
        "mini_text_html": "<p>Sample Mini Text here</p>",
        "description": "<p>Upgrade your headwear game by grabbing this Texas Rangers Chrome 59FIFTY Fitted Hat from New Era. Highlighting your loyalty to the team will be super easy thanks to the distinctive Texas Rangers graphics embroidered on the crown.</p><p>Upgrade your headwear game Now. Don't just wait. </p>",
        "creatives": [
          {
            "url": "https://adpx.b-cdn.net/campaigns/1330/2c893d4226891cc160dd6658a660bbeb.png",
            "type": "png",
            "width": 900,
            "id": 1009,
            "is_primary": true,
            "aspect_ratio": 1,
            "height": 900
          },
          {
            "url": "https://adpx.b-cdn.net/campaigns/1330/e4ea32bf3c8f2c6434d59df46a986dc1/avif",
            "type": "heif",
            "width": 900,
            "id": 1010,
            "is_primary": false,
            "aspect_ratio": 1,
            "height": 900
          }
        ],
        "image": "https://adpx.b-cdn.net/campaigns/1330/2c893d4226891cc160dd6658a660bbeb.png",
        "adv_pixel_url": "",
        "cta_no": "No, Thanks",
        "title": "Texas Rangers New Era Chrome 59FIFTY Fitted Hat - Stone/Black",
        "beacons": {
          "no_thanks_click": "https://track.adspostx.com/event/record/no_thanks_click?oid=4053&cid=1330&pid=800&sess_id=e7ff9c17a762751520be3315ba22fe9e7be8323f",
          "close": "https://track.adspostx.com/event/record/close?oid=4053&cid=1330&pid=800&sess_id=e7ff9c17a762751520be3315ba22fe9e7be8323f"
        },
        "click_url": "https://track.adspostx.com/sdk/offer-click?o_id=4053&c_id=1330&p_id=800&sess_id=e7ff9c17a762751520be3315ba22fe9e7be8323f",
        "useraction_url": "https://www.adspostx.com/get-started?click={click_id}",
        "useraction_cta": "Buy Now",
        "cta_yes": "Yes, please",
        "pixel": "https://track.adspostx.com/sdk/v2/impression/p.png?o_id=4053&c_id=1330&p_id=800&sess_id=e7ff9c17a762751520be3315ba22fe9e7be8323f&cbuster={CBUSTER}"
      }
    ],
    "styles": {    //styles settings for the template associated with the account used by the Standard Integration. Can be ignored.
      "offerText": {
        "fontSize": 14,
        "font": null,
        "buttonYes": {
          "hover": "#1A56DB",
          "stroke": "#1C64F2",
          "background": "#1C64F2",
          "color": "#ffffff"
        },
        "buttonNo": {
          "hover": "#E5E7EB",
          "stroke": "#9CA3AF",
          "background": "#ffffff",
          "color": "#6B7280"
        },
        "textColor": "#000"
      },
      "footer": {
        "publisher_name": "Ansh LLC",
        "privacy": "https://www.adspostx.com/privacy-policy",
        "text": "Powered by AdsPostX",
        "publisher_privacy_policy": "https://www.enefits.co/privacy",
        "disclaimer": ""
      },
      "header": {
        "text": "Your order is complete",
        "lead_in_text_color": "#000000",
        "lead_in_text": "Here are some offers from brands you love!",
        "textColor": "#ffffff",
        "fontSize": 16,
        "background": "#1A56DB"
      },
      "settings": {
        "screen_margin": 0,
        "darken_bg_non_centered": false,
        "show_disclaimer": false,
        "ad_position": "center",
        "ad_animation": "bottom-top",
        "enable_vertical_offset": false,
        "button_order": "neg_first",
        "delay": 0,
        "mobile_vertical_offset": null,
        "darken_bg": true,
        "fixed_progress_bar": false
      },
      "popup": {
        "shadow": "#8f8f8f",
        "borderRadius": {
          "bottom_right": "5",
          "top_right": "5",
          "top_left": "5",
          "bottom_left": "5"
        },
        "background": "#ffffff",
        "lightBox": "#000"
      }
    },
    "count": 1    //number of Offers returned by the getOffers method determined in the AdsPOstX dashboard via Settings/Behaviour.
  }
}
﻿
Failure
A failed call to getOffers would return an error response similar to the following:
Swift
Error:

Domain=NSURLErrorDomain
Code=-1009
Description=The Internet connection appears to be offline.
UserInfo={
    _kCFStreamErrorCodeKey=50,
    NSUnderlyingError=0x600000debed0 {
        Error Domain=kCFErrorDomainCFNetwork Code=-1009
        UserInfo={
            _NSURLErrorNWPathKey=unsatisfied (No network route),
            _kCFStreamErrorCodeKey=50,
            _kCFStreamErrorDomainKey=1
        }
    },
    _NSURLErrorFailingURLSessionTaskErrorKey=LocalDataTask <D5949346-516D-4218-9B89-17D2A17177C1>.<1>,
    _NSURLErrorRelatedURLSessionTaskErrorKey=(
        "LocalDataTask <D5949346-516D-4218-9B89-17D2A17177C1>.<1>"
    ),
    NSErrorFailingURLStringKey=https://api.adspostx.com/native/v1/offers.json,
    NSErrorFailingURLKey=https://api.adspostx.com/native/v1/offers.json,
    _kCFStreamErrorDomainKey=1
}

Error:

Domain=NSURLErrorDomain
Code=-1009
Description=The Internet connection appears to be offline.
UserInfo={
    _kCFStreamErrorCodeKey=50,
    NSUnderlyingError=0x600000debed0 {
        Error Domain=kCFErrorDomainCFNetwork Code=-1009
        UserInfo={
            _NSURLErrorNWPathKey=unsatisfied (No network route),
            _kCFStreamErrorCodeKey=50,
            _kCFStreamErrorDomainKey=1
        }
    },
    _NSURLErrorFailingURLSessionTaskErrorKey=LocalDataTask <D5949346-516D-4218-9B89-17D2A17177C1>.<1>,
    _NSURLErrorRelatedURLSessionTaskErrorKey=(
        "LocalDataTask <D5949346-516D-4218-9B89-17D2A17177C1>.<1>"
    ),
    NSErrorFailingURLStringKey=https://api.adspostx.com/native/v1/offers.json,
    NSErrorFailingURLKey=https://api.adspostx.com/native/v1/offers.json,
    _kCFStreamErrorDomainKey=1
}
﻿
Standard Integration
Integration consists of three steps:
Initializing the SDK
Loading Offers
Displaying Offers
Initializing the SDK
Include the AdsPostX initialization code anywhere in the app, but make sure to call it before loading and showing offers. 
Also, make sure to import AdsPostX.
Swift
 public static func initWith(sdkId: String,
                                completion: @escaping (Result<Void, Error>) -> Void)
 public static func initWith(sdkId: String,
                                completion: @escaping (Result<Void, Error>) -> Void)
﻿
where
Parameter Name
Parameter Type
Required/Optional
Description
sdkId
string 
required
SDK ID as provided
completion
Escaping closure
required
A callback will be sent on this closure with the type Result.
Example:
Swift
// values used here are for demo purposes; please use actual values when integrating SDK.

 AdsPostx.initWith(sdkId: "25") { result in
            switch result {
            case .success():
                print("SDK init success")
            case .failure(let error):
                if let error = error as? AdsPostxError {
                    print("Init sdk failed with \(error.description)")
                }
            }
        }        
// values used here are for demo purposes; please use actual values when integrating SDK.

 AdsPostx.initWith(sdkId: "25") { result in
            switch result {
            case .success():
                print("SDK init success")
            case .failure(let error):
                if let error = error as? AdsPostxError {
                    print("Init sdk failed with \(error.description)")
                }
            }
        }        
﻿
Loading Offers
Once the SDK is initialized successfully, call the load function to load Offers. 
The load function must be called at least once before showing Offers.
Swift
 public static func load(attributes: Dictionary<String, Any>? = nil,
                                completion: @escaping (Result<Void, Error>) -> Void)
 public static func load(attributes: Dictionary<String, Any>? = nil,
                                completion: @escaping (Result<Void, Error>) -> Void)
﻿
﻿where﻿
Parameter Name
Parameter Type
Required/Optional
Description
attributes
 Dictionary
optional
attributes and their values you want to send to AdsPostX. 
Note: All attributes must be passed based on the supported list below. 
completion
Escaping closure
required
A callback will be sent on this closure with type Result.
Currently, the following attributes are supported
Name
Data Type
email
String
firstname
String
lastname
String
mobile
String
confirmationref
String
amount
double
currency
String
paymentType
String
ccbin
String
language
String
country
String
zipcode
String
orderid
String
offerid
String
subid
String
Example:
Load()  with Attributes:
Swift
// values used here are just for demo purpose, use actual values when you are integrating SDK.

        var attributes: [String: Any] = [:]
        attributes["firstname"] = "john"
        attributes["lastname"] = "dev"

        AdsPostx.load(attributes: attributes) { result in           
            switch result {
            case .success():
                print("Offers loaded successfully.")
            case .failure(let error):
                if let error = error as? AdsPostxError {
                    print("Failed to load Offers with Error: \(error.description)")
                }
            }
        }
// values used here are just for demo purpose, use actual values when you are integrating SDK.

        var attributes: [String: Any] = [:]
        attributes["firstname"] = "john"
        attributes["lastname"] = "dev"

        AdsPostx.load(attributes: attributes) { result in           
            switch result {
            case .success():
                print("Offers loaded successfully.")
            case .failure(let error):
                if let error = error as? AdsPostxError {
                    print("Failed to load Offers with Error: \(error.description)")
                }
            }
        }
﻿
Load() without Attributes:
Swift
// values used here are just for demo purpose, use actual values when you are integrating SDK.

AdsPostx.load() { result in
    switch result {
        case .success():
            print("Offers loaded successfully.")
        case .failure(let error):
            if let error = error as? AdsPostxError {
                print("Failed to load Offers with Error: \(error.description)")
            }
    }
}    
    
// values used here are just for demo purpose, use actual values when you are integrating SDK.

AdsPostx.load() { result in
    switch result {
        case .success():
            print("Offers loaded successfully.")
        case .failure(let error):
            if let error = error as? AdsPostxError {
                print("Failed to load Offers with Error: \(error.description)")
            }
    }
}    
    
﻿
Displaying offers
Once initWith and load calls are successful, call showOffers to display offers in your app.
Swift
// values used here are just for demo purpose, use actual values when you are integrating SDK.

public static func showOffers(                   
                    presentationStyle: OfferPresentationStyle, 
                    transparent: Bool = true, 
                    margins: (top: UInt, bottom: UInt, left: UInt, right: UInt) = (5,5,5,5), 
                    onShow: @escaping () -> Void, 
                    onError: @escaping (AdsPostxError) -> Void, 
                    onDismiss: @escaping () -> Void
                    )


// values used here are just for demo purpose, use actual values when you are integrating SDK.

public static func showOffers(                   
                    presentationStyle: OfferPresentationStyle, 
                    transparent: Bool = true, 
                    margins: (top: UInt, bottom: UInt, left: UInt, right: UInt) = (5,5,5,5), 
                    onShow: @escaping () -> Void, 
                    onError: @escaping (AdsPostxError) -> Void, 
                    onDismiss: @escaping () -> Void
                    )

﻿
where
Parameter Name
Parameter Type
Required/Optional
Description
presentationStyle
OfferPresentationStyle
required
can be either fullScreen or popup
transparent
boolean
optional
can be either true or false
the default value is true
﻿
if transparent = true, the background will be transparent.
﻿
if transparent = false, the background will be non-transparent.
margins
tuple(UInt, UInt, UInt, UInt) optional
﻿
1st parameter: describes top margin in %. 
2nd parameter: describes bottom margin in %. 
3rd parameter: describes left margin in %. 
4th parameter: describes right margin in %. 
﻿margin values must be >= 0 and <= 15﻿
Default margin values for top margin, bottom margin, left margin, right margin is 5 (ie. 5%).
onShow
Escaping closure
﻿
Callback to run each time an offer is displayed
onError
Escaping closure
﻿
Callback that runs when there is an error. Provides a error info.
onDismiss
Escaping closure
﻿
Callback to run each time an offer is dismissed
The margin will be calculated based on the orientation. If the device is in landscape orientation, the margin will be calculated considering the device height. If the device is in portrait orientation, the margin will be calculated considering the device width.
If margin value is > 15 then it will consider only 15.
After displaying offers, the load function must be called again before displaying offers again.  
Example: 
Showing Offers along with margins and transparency:
Swift
// values used here are just for demo purpose, use actual values when you are integrating SDK.
   
   AdsPostx.showOffers(presentationStyle: .popup,
                                transparent: true,
                                margins: (
                                    top: 5,
                                    bottom: 5,
                                    left: 5,
                                    right: 5
                                )
            ) {
                print("on load")
            } onError: { error in
                print(error.description)
            } onDismiss: {
                print("on dismiss")
            }
// values used here are just for demo purpose, use actual values when you are integrating SDK.
   
   AdsPostx.showOffers(presentationStyle: .popup,
                                transparent: true,
                                margins: (
                                    top: 5,
                                    bottom: 5,
                                    left: 5,
                                    right: 5
                                )
            ) {
                print("on load")
            } onError: { error in
                print(error.description)
            } onDismiss: {
                print("on dismiss")
            }
﻿
Showing Offers without  margins and transparency:
Swift
// values used here are just for demo purpose, use actual values when you are integrating SDK.

  AdsPostx.showOffers(presentationStyle: .popup) {
      print("on load")
  } onError: { error in
      print(error.description)
  } onDismiss: {
      print("on dismiss")
  }

// values used here are just for demo purpose, use actual values when you are integrating SDK.

  AdsPostx.showOffers(presentationStyle: .popup) {
      print("on load")
  } onError: { error in
      print(error.description)
  } onDismiss: {
      print("on dismiss")
  }
﻿
Set Environment
The default value for Environment is .live.
We recommend using .test only in development, not in production. 
Make sure to call this method before the initWith() call.
Swift
AdsPostx.SetEnvironment(.live) // it will load offers from live environment

// OR

 AdsPostx.SetEnvironment(.test) // it will load offers from test environment.
AdsPostx.SetEnvironment(.live) // it will load offers from live environment

// OR

 AdsPostx.SetEnvironment(.test) // it will load offers from test environment.
﻿
Set Debug Log
By default, Debug Log is disabled. 
Enabling Debug Log will give you more debug information related to offers. 
We recommend enabling logs only in development, not in production. 
Make sure to call this method before the initWith() call.
Swift
AdsPostx.EnableDebugLog(true) // enable debug logs

// OR 

AdsPostx.EnableDebugLog(false) // disable debug logs
AdsPostx.EnableDebugLog(true) // enable debug logs

// OR 

AdsPostx.EnableDebugLog(false) // disable debug logs
﻿
Orientation Related
Also, add the following code to the client application's 'AppDelegate' method supportedInterfaceOrientationsFor window
Swift
func application(_ application: UIApplication, supportedInterfaceOrientationsFor window: UIWindow?) -> UIInterfaceOrientationMask {
        return AdsPostx.supportedInterfaceOrientations(.all)
    }
func application(_ application: UIApplication, supportedInterfaceOrientationsFor window: UIWindow?) -> UIInterfaceOrientationMask {
        return AdsPostx.supportedInterfaceOrientations(.all)
    }
﻿
where
Value
description
.all
if the client app supports all orientations.
.portrait
if the client app supports only portrait orientation.
.landscape
if the client app supports only landscape orientation.
.allButUpsideDown
if client app supports all orientations except UpsideDown.
Need Help?
If you're running into any issues while going through the integration process, feel free to contact us at help@adspostx.com.
Mobile SDK
Android SDK
Parameter Name	Parameter Type	Optional/Required	Description
sdkId	string	required	SDK ID as provided
parameters	dictionary [String: Any]	optional	User payload parameters and other filters/options
Parameter Name	Data Type	Description
json	dictionary [String: Any]	contains offers details.
error	error	contains error info
Parameter Name	Parameter Type	Required/Optional	Description
sdkId	string	required	SDK ID as provided
completion	Escaping closure	required	A callback will be sent on this closure with the type Result.
Name	Data Type
email	String
firstname	String
lastname	String
mobile	String
confirmationref	String
amount	double
currency	String
paymentType	String
ccbin	String
language	String
country	String
zipcode	String
orderid	String
offerid	String
subid	String
Value	description
.all	if the client app supports all orientations.
.portrait	if the client app supports only portrait orientation.
.landscape	if the client app supports only landscape orientation.
.allButUpsideDown	if client app supports all orientations except UpsideDown.
iOS SDK

Introduction

Requirements

Quick Walkthrough

Minimum Deployment Target

Latest version

Installation

Manual Installation

﻿Download and build the AdsPostX iOS Demo App﻿

Download the AdsPostX iOS SDK

Include the SDK in your app

Using CocoaPods

Before you begin

Installation using CocoaPods

Using Swift Package Manager

Before you begin

Installation using Swift Package Manager

Integration

Native Ads API Integration

Usage

getOffers Response Example

Standard Integration

Initializing the SDK

Loading Offers

Displaying offers

Set Environment

Set Debug Log

Orientation Related

Need Help?

Download and build the AdsPostX iOS Demo App
