Articles in this section

Adbrix Integration [iOS Swift]

Avatar
ADBRIX
  • Updated

 

Quick Start

 

Xcode 12 and iOS 14 Support

 

[[인용:위험:작게]] On15th March 2021, the latest adbrix SDK(1.6.5400) is released on Cocoapods to deal with iOS14.
Adbrix updates SDK on Cocoapods to deal with ATT(App Tracking Transparency) prompt. After this version, adbrix uses IDFV as a device identifier. Execute "pod update" command on your terminal.

 

 

System Requirement

Build Tool: Latest Xcode version required

Additional setup: Because Adbrix SDK is written with the latest version of Swift, your project requires the latest version of Swift Library. (Current version of Swift: Swift 5.3)

 

SDK Installation and App setup

If you have an existing Xcode project, follow these steps for SDK installation.

 

 

Ready for CocoaPods 

CocoaPods is a tool to download and install an external library.

We recommend using CocoaPods for SDK installation.

 

 

CocoaPods Installation

If you don't have CocoaPods on your Mac, open a Mac OS terminal and execute this command.

$ sudo gem install cocoapods

 

After CocoaPods installation is complete, you can see these results on your terminal.

...
Parsing documentation for cocoapods-1.5.0
Installing ri documentation for cocoapods-1.5.0
Done installing documentation for cocoapods-core, cocoapods-downloader, molinillo, nanaimo, xcodeproj, cocoapods after 9 seconds
6 gems installed

 

 

Initialize CocoaPods

Initialize CocoaPods.

$ pod setup

 

After CocoaPods initialization is complete, you can see these results on the terminal.

...
  Resolving deltas: 100% (518/518), completed with 177 local objects.
  From https://github.com/CocoaPods/Specs
     8369a675212..ceea3be18e7  master     -> origin/master
  $ /usr/bin/git -C /Users/username/.cocoapods/repos/master rev-parse --abbrev-ref HEAD
  master
  $ /usr/bin/git -C /Users/username/.cocoapods/repos/master reset --hard origin/master
  HEAD is now at ceea3be18e7 [Add] YTX_iOS_IM_SDK 0.0.7
Setup completed

 

 

Create Podfile 

Go to your Xcode project folder and open the terminal and execute this command for generating Podfile.

$ pod init

 

 

Podfile setup

Open the vi editor on your terminal and type this command on your Podfile.

After editing your Podfile, press Esc and Shift+z twice to exit the editor.

$ vi Podfile

platform :ios, '8.0'
target "myXcodeProject" do
pod 'AdBrixRemastered'
end

* platform number is the minimum version of iOS for the current Xcode project.

* There may be some errors when you use a normal text editor.

*. After version 1.2.9 we changed our pod name to AdBrixRemastered.

 

 

Install SDK Pod

Type this command on the terminal for installing adbrix SDK.

$ pod install

* TroubleShooting!!! When pod install error occurs, execute command "pod setup".

 

 

Update SDK Pod

If you install adbrix SDK already, type the following commands "pod update" or "pod setup" for installing the latest adbrix SDK.

$ pod setup
$ pod update

 

 

Open XCode Project

After adbrix SDK installation, start {project_name}.xcworkspace file to open Xcode project. You can find adbrix pods on Xcode navigator like the below screenshot.

$ open myXcodeProject.xcworkspace

 

Add required framework

Adbrix SDK requires iAD frameworks.

Move to [General > Linked Frameworks and Libraries] and click the (+) button and add "iAd.framework".

 

Swift Library Setup

Because adbrix SDK is made of Swift, you should set the Xcode project to enable the Swift library.

Go to [Build Settings > Always Embed Swift Standard Libraries] and set 'yes'.

  

Apple IDFA Setup

Adbrix Attribution SDK requires Apple IDFA.

Please set IDFA at [AppDelegate.swift> application: didFinishLaunchingWithOptions:].

import AdSupport
import AdBrixRM

@UIApplicationMain
class AppDelegate: UIResponder, UIApplicationDelegate {

    var window: UIWindow?

    func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {
        // Override point for customization after application launch.
        
        // Create AdBrixRM instance
        let adBrix = AdBrixRM.getInstance
        
        if ((NSClassFromString("ASIdentifierManager")) != nil) {
            let ifa :UUID = ASIdentifierManager.shared().advertisingIdentifier;
              
            // Send IDFA to adbrix SDK
            adBrix.setAppleAdvertisingIdentifier(ifa.uuidString)
        }
                
        return true
    }
}

 

After version 1.6.5330, you can set whether to get IDFA or not.

import AdSupport
import AdBrixRM

@UIApplicationMain
class AppDelegate: UIResponder, UIApplicationDelegate {

    var window: UIWindow?

    func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {
        // Override point for customization after application launch.

        // Create AdBrixRM Instance
        let adBrix = AdBrixRM.getInstance
        
        adBrix.stopGettingIDFA() // Stop using IDFA
        
        adBrix.startGettingIDFA() // Start Using IDFA
        
        return true
    }

 

 

 

AppKey & SecretKey setup

Set adbrix AppKey and SecretKey issued from the adbrix console.

import AdBrixRM

//Swift Version < 4.2
func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {

    // Create AdBrixRM Instance
    let adBrix = AdBrixRM.getInstance

    // Set adbrix appKey & secretKey
    adBrix.initAdBrix(appKey: "odhvASVRDsdf10d019fva", secretKey: "ar98LszQZUGdmSznToNBXg")

    return true
}

//Swift Version >= 4.2
func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
    // Create AdBrixRM Instance
    let adBrix = AdBrixRM.getInstance

    // Set adbrix appKey & secretKey
    adBrix.initAdBrix(appKey: "odhvASVRDsdf10d019fva", secretKey: "ar98LszQZUGdmSznToNBXg")

    return true
}

 

* AppKey is different from adbrix Classic and adbrix Remastered.

* adbrix Remastered AppKey and SecretKey can be used on both Android and iOS platforms.

 

Start from the sample project

adbrix can provide an Xcode project that already installs the adbrix SDK.

You can download the project based on your project language.

 

[adbrix Swift Sample Project link]

[adbrix Objective-C Sample Project link]

 

 

 

Additional SDK setup

 

After adbrix SDK setup is complete, you can add additional SDK set up

  1. Log level setup
  2. Event upload cycle setup
  3. GDPR setup
  4. Deeplink setup

 

Log Level Setup

You can set up a log level for adbrix SDK log. There are 6 levels for adbrix SDK log. 

  • AdBrixLogLevelNONE: No SDK log is shown on the terminal.
  • AdBrixLogLevelTRACE: General SDK logs are shown on the terminal.
  • AdBrixLogLevelDEBUG: Including TRACE, debug SDK logs are shown on the terminal.
  • AdBrixLogLevelINFO: Including DEBUG, Saving, loading, and uploading data logs are shown on the terminal
  • AdBrixLogLevelWARNING: Including INFO, it shows the SDK error like Exception or non-fatal error.
  • AdBrixLogLevelERROR: Including WARNING, it shows every single SDK log including the fatal error.
import AdBrixRM

//Swift Version < 4.2
func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {

    // Create AdBrixRM Instance
    let adBrix = AdBrixRM.getInstance

    // Set adbrix Log Level
    adBrix.setLogLevel(AdBrixRM.AdBrixLogLevel.TRACE)

    return true
}
// Swift Version >= 4.2
func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
    // Create AdBrixRM Instance
    let adBrix = AdBrixRM.getInstance

    // Set adbrix Log Level
    adBrix.setLogLevel(AdBrixRM.AdBrixLogLevel.TRACE)

    return true
}

 

 

Event upload cycle setup

A developer can set the event upload cycle. 

The event upload cycle can be set based on how many events have been counted or base on time.

 

Event upload counter

The developer can set an event upload counter that how many events have been called.

adbrix SDK has a pre-defined API.

  • AdBrixEventUploadCountIntervalMIN : If 10 events are counted, SDK will upload your event.
  • AdBrixEventUploadCountIntervalNORMAL : If 30 events are counted, SDK will upload your event.
  • AdBrixEventUploadCountIntervalMAX : If 60 events are counted, SDK will upload your event.
import AdBrixRM

//Swift Version < 4.2
func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {

    // Create AdBrixRM Instance 
    let adBrix = AdBrixRM.getInstance

    // If accumulated event count is 10, upload event to adbrix server
    adBrix.setEventUploadCountInterval(AdBrixRM.AdBrixEventUploadCount.MIN)

    return true
}

//Swift Version >= 4.2
func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
    // Create AdBrixRM Instance 
    let adBrix = AdBrixRM.getInstance

    // If accumulated event count is 10, upload event to adbrix server
    adBrix.setEventUploadCountInterval(AdBrixRM.AdBrixEventUploadCount.MIN)

    return true
}

 

Event upload timer

The developer can set the timer for uploading adbrix SDK event.

adbrix SDK has a pre-defined API.

  • AdBrixEventUploadTimeIntevalMIN : Every 30 seconds adbrix SDK will upload events.
  • AdBrixEventUploadTimeIntevalNORMAL : Every 60 seconds adbrix SDK will upload events
  • AdBrixEventUploadTimeIntevalMAX :Every 120 seconds adbrix SDK will upload events
import AdBrixRM

//Swift Version < 4.2
func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {

    // Create AdBrixRM Instance 
    let adBrix = AdBrixRM.getInstance

    // Event upload timer API
    adBrix.setEventUploadTimeInterval(AdBrixRM.AdBrixEventUploadTimeInteval.MAX)

    return true
}
//Swift Version >= 4.2
func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
    // Create AdBrixRM Instance
    let adBrix = AdBrixRM.getInstance

    // Event upload timer API(Every 30 second, 
    adBrix.setEventUploadTimeInterval(AdBrixRM.AdBrixEventUploadTimeInteval.MIN)

    return true
}

 

GDPR Setup

The developer can stop the adbrix SDK from working using GDPR API.

If the GDPR API is called, adbrix SDK will stop working including saving, uploading events.

This cannot be re-inverted unless a user deletes the app. 

@IBAction func adbrixGdpr(_ sender: Any) {
    // Creating AdBrixRM instance
 let adBrix = AdBrixRM.getInstance
 adBrix.gdprForgetMe;
}

 

  

 

 

Deeplink and DefferdDeeplink

 

You can analyze app reopen events by deep link URL. 

Set a custom deep link URL scheme on your app.

 

Custom Url Scheme setup

Move to [General > Target > Info > URL Types] and set URL Scheme.

 

Universal link

Go to [General > Target > Capablities> Associated Domains] and set your universal link like the following screenshot.

mceclip1.png

 [[인용:경고:보통]] When you add a universal link, you have to type applinks:your_appkey.adtouch.adbrix.io. Set your Appkey at the "your_appkey" part.

 

Add the following code within AppDelegate.swift.

    // over iOS 9
    
    func application(_ application: UIApplication,continue userActivity: NSUserActivity, restorationHandler: @escaping ([Any]?) -> Void) -> Bool {
    
        guard userActivity.activityType == NSUserActivityTypeBrowsingWeb,
            let incomingURL = userActivity.webpageURL
        
            else {
                return false
        }
        
        print("DEEPLINK :: UniversialLink was clicked !! incomingURL - \(incomingURL)")
        NSLog("UNIVERSAL LINK OPEN!!!!!!!!!!!!!!!!!")
​
        let adBrix = AdBrixRM.getInstance
        adBrix.deepLinkOpen(url: incomingURL)
                
        return true
    
}
    
    // iOS 12
    
    func application(_ application: UIApplication, continue userActivity: NSUserActivity, restorationHandler: @escaping ([UIUserActivityRestoring]?) -> Void) -> Bool {
        guard userActivity.activityType == NSUserActivityTypeBrowsingWeb,
            let incomingURL = userActivity.webpageURL
        
            else {
                return false
        }
        
        print("DEEPLINK :: UniversialLink was clicked !! incomingURL - \(incomingURL)")
        NSLog("UNIVERSAL LINK OPEN!!!!!!!!!!!!!!!!!")
        let adBrix = AdBrixRM.getInstance
        adBrix.deepLinkOpen(url: incomingURL)
        
        return true
    }

 

 

 

Deeplink open event.

Open AppDelegate.swift. Add 'application(_ app: open URL: options: ) delegate and set an adbrix deep link open API.

//Swift Version < 4.2
@available(iOS 9.0, *)
func application(_ app: UIApplication, open url: URL, options: [UIApplicationOpenURLOptionsKey : Any] = [:]) -> Bool {
    // Create AdBrixRM Instance
    let adBrix = AdBrixRM.getInstance

    // Call AdBrix Deeplink Open Event
    adBrix.deepLinkOpen(url: url)

    // You have to do optional binding or guard, in case of reprocessing your deep link URL(e.g. changing deep link URL to string) 
    if let urlModified = URL(string: "reprocessed URL string") {
        adBrix.deepLinkOpen(url: urlModified)
    }

   return false
}

//Swift Version >= 4.2
func application(_ app: UIApplication, open url: URL, options: [UIApplication.OpenURLOptionsKey : Any] = [:]) -> Bool {
    // Create AdBrixRM Instance
    let adBrix = AdBrixRM.getInstance

    // Call AdBrix Deeplink Open Event
    adBrix.deepLinkOpen(url: url)

    // You have to do optional binding or guard, in case of reprocessing your deep link URL(e.g. changing deep link URL to string) 
    if let urlModified = URL(string: "reprocessed URL string") {
        adBrix.deepLinkOpen(url: urlModified)
    }

    return false
}

//under ios 8.0
func application(_ application: UIApplication, open url: URL, sourceApplication: String?, annotation: Any) -> Bool {
    // Create AdBrixRM Instance
    let adBrix = AdBrixRM.getInstance

    // Call AdBrix Deeplink Open Event
    adBrix.deepLinkOpen(url: url)

    // You have to do optional binding or guard, in case of reprocessing your deep link URL(e.g. changing deep link URL to string) 
    if let urlModified = URL(string: "reprocessed URL string") {
        adBrix.deepLinkOpen(url: urlModified)
    }

    return false
}

 

If you are using UIScene from iOS13 use this code at sceneDelegate.swift.

import AdBrixRM


   func scene(_ scene: UIScene, willConnectTo session: UISceneSession, options connectionOptions: UIScene.ConnectionOptions) {
    
    // Create AdBrixRM Instance
    let adBrix = AdBrixRM.getInstance
    
    if connectionOptions.urlContexts.first?.url != nil {
       
      let urlinfo = connectionOptions.urlContexts.first?.url
      
      // Deeplink tracking code
      adBrix.deepLinkOpen(url:urlinfo!)
    }
    
   }
   
   
   func scene(_ scene: UIScene, openURLContexts URLContexts: Set<UIOpenURLContext>) {
       
       let url = URLContexts.first!.url as NSURL
       
        // AdBrixRM instance
       let adBrix = AdBrixRM.getInstance
       
       // Deeplink tracking code
       adBrix.deepLinkOpen(url:url)
       
   }

 

 

 

Deferred Deeplink Tracking

If you want to show users a certain view when the user installs the app after clicking the tracking link, the deferred deep link API will work.

 

[[인용:위험:작게]] - Deferred Deeplink API will send scheme data in String after the user installs the app with a tracking link.
example : yourscheme://your_custom_path

 

import UIKit
import AdBrixRM
import AdSupport

@UIApplicationMain
class AppDelegate: UIResponder, UIApplicationDelegate, AdBrixRMDeferredDeeplinkDelegate{

    var window: UIWindow?


    func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {
        // Override point for customization after application launch.

        let adBrix = AdBrixRM.getInstance

        if ((NSClassFromString("ASIdentifierManager")) != nil){
            let ifa : UUID = ASIdentifierManager.shared().advertisingIdentifier;
            adBrix.setAppleAdvertisingIdentifier(ifa.uuidString)
        }

        // Add DeferredDeepLink delegate 
        adBrix.delegateDeferredDeeplink = self

        return true
   }


    // Deferred Deep Link Tracking 
    func didReceiveDeferredDeeplink(deeplink: String) {

        print("DEEPLINK :: received - \(deeplink)")
        // Set your Landing Page Using Data from Listener

    }

 *. Caution: If you want to do something on UI using data from a deferred deep link listener, you have to work on the main thread.

[[인용:경고:보통]] If your DeferredDeeplink Listener Doesn't Work 
If you cannot call a deferred deep link listener, check the following.
1. Check if a conversion has occurred by the tracking link.
2. Check if you set a deep link at your tracking link.

[[인용:위험:작게]] IF you cannot use Facebook SDK 'fetchDeferredAppLinkData API'
If you want to integrate adbrix DeferredDeeplink API, you have to delete Facebook SDK fetchDeferredAppLinkData API. 

SDK Initialization Example

If you add all 5 SDK initialization process AppDelegate.swift will show like this

import UIKit
import AdBrixRM
import AdSupport

func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {
        let adBrix = AdBrixRM.getInstance

        if ((NSClassFromString("ASIdentifierManager")) != nil) {
            let ifa :UUID = ASIdentifierManager.shared().advertisingIdentifier
            let isAppleAdvertisingTrackingEnalbed :Bool = ASIdentifierManager.shared().isAdvertisingTrackingEnabled
            adBrix.setAppleAdvertisingIdentifier(ifa.uuidString, isAppleAdvertisingTrackingEnalbed)
       }

        adBrix.setLogLevel(AdBrixRM.AdBrixLogLevel.TRACE)
        adBrix.setEventUploadCountInterval(AdBrixRM.AdBrixEventUploadCountInterval.MIN)
        adBrix.setEventUploadTimeInterval(AdBrixRM.AdBrixEventUploadTimeInterval.MIN)
        adBrix.initAdBrix(appKey: "odhvASVRDsdf10d019fva", secretKey:"ar98LszQZUGdmSznToNBXg")
        return true
    }


func application(_ app: UIApplication, open url: URL, options: [UIApplicationOpenURLOptionsKey : Any] = [:]) -> Bool {
        let adBrix = AdBrixRM.getInstance
        adBrix.deepLinkOpen(url: url)
        return false
}

 

 

 

App Event Analysis

Using adbrix SDK, you can analyze In-app events and create In-app event reports at adbrix dashboard.

To analyze the In-app event, you must add adbrix event API when the event is executed.

adbrix SDK provides 5 different types of In-app event APIs

  1. User Analysis
    1. Login / Logout Event
    2. User information
    3. Location information
  2. Custom Analysis
  3. General Analysis
    1. Signup
    2. App update
    3. User invitation
    4. Use in-app credit
    5. In-Purchase
  4. Commerce Analysis
    1. Home view
    2. Category view
    3. Product view
    4. Add to cart
    5. Add to wishlist
    6. Review order
    7. Refund
    8. Product search
    9. Product share
    10. Product listview
    11. Cart view
    12. Payment information
  5. Game Analysis
    1. Tutorial complete
    2. Create character
    3. Stage complete
    4. Level up

 

 

User Analysis

 

Login / Logout Event

Analyze Login / Logout event.

You can send UserID when a user login or logout.

@IBAction func login_and_logout_event(_ sender: Any) {
  
  // Creating adbrix Instance
  let adBrix = AdBrixRM.getInstance

  if(isLoginSuccess) {
    // Login success with userid user_1234
    adBrix.login(userId:"user_1234")
  } else {
     // Logout
     adBrix.logout()
  } 
}

* Warning: Do not send personal information like e-mail, phone number, etc. on loginWithUserID API. If you have personal information on loginWithUserID API, We strongly recommend encrypting with BASE64, MD5, SHA1

 

 

User Information

You can analyze a user's age, gender, and other information using adbrix SDK API.

@IBAction func user_property_update(_ sender: Any) {
  
  // Create adbrix instance
  let adBrix = AdBrixRM.getInstance                                      

  //Age
  adBrix.setAge(int: 30)
    
  //Gender
  adBrix.setGender(adBrixGenderType: AdBrixRM.AdBrixGenderType.Male)
    
  //other information
  let attrModel = AdBrixRmAttrModel()
        attrModel.setAttrDataString("nickname", "peter")
        attrModel.setAttrDataInt("age", 36)
        attrModel.setAttrDataBool("married", true)
        
  adBrix.setUserPropertiesWithAttr(attrModel: attrModel)

}

[[인용:위험:보통]]Constraints of user and event data using AttrModel
1. You can send up to 100 data.
2. The Key should be String and up to 256 letters with lowercase alphabetic characters and numbers only.  
3. The Value data only should be less than 1024byte. 

 

Location information

If you can receive user location you can send user location by adbrix SDK.

@IBAction func location_update(_ sender: Any) {

  // Create adBrix Instance
  let adBrix = AdBrixRM.getInstance                                      

  // adbrix location API
  adBrix.setLocation(latitude: 32.514, longitude: 126.986)
}

* adbrix does not take responsibility to use user location.

 

 

Custom event

adbrix SDK can analyze a custom event, which is not pre-defined by adbrix SDK.

@IBAction func user_custom_event(_ sender: Any) {

  // Create adbrix Instance
  let adBrix = AdBrixRM.getInstance
    
  // Addtional event parameter
  let attrModel = AdBrixRmAttrModel()
       attrModel.setAttrDataString(“userid”, “peterPark")
       attrModel.setAttrDataString(“gender”, “male”)
       attrModel.setAttrDataInt(“age”, 36)  

  // Click a button "Invite a friend"
  adBrix.eventWithAttr("invite_button_click"”, value: attrModel)

  // Complete "Character creation" 
  adBrix.eventWithAttr("create_character_complete"”, value: attrModel)

  // Complete "Tutorial view"
  adBrix.eventWithAttr("tutorial_complete"”, value: attrModel)

  // Achieve "Level 10"
  adBrix.eventWithAttr("level_10"”, value: attrModel)
     
}

 

 

※ Caution 

If you set up a custom event name in every single situation like the following example, this will create tons of events. 

  // Create adbrix Instance
  let adBrix = AdBrixRM.getInstance
  
  adBrix.event("custom:Lev-37 cleared,clearTime:00:00:39.2343535")

 

Please use an additional event parameter API(AdBrixRm.AttrModel) to manage the event.

  // Create adbrix Instance
  let adBrix = AdBrixRM.getInstance
  
  // Additional event parameter
  let attrModel = AdBrixRmAttrModel()
       attrModel.setAttrDataInt(“level”, 37)  
       attrModel.setAttrDataInt(“clear_time_mile”, 39238)  

  // Custom event API with event parameter
  AdBrixRm.eventWithAttr("level_clear", value: attrModel)

 

 

 

 

 

 

 

General Event Analysis

adbrix SDK can analyze general events like user registration, app update, etc.

adbrix SDK provides 5 pre-defined general events.

  • Signup
  • App update
  • User invitation
  • Using in-app credit
  • In-app purchase

* If you wish to see an in-app purchase report, you must integrate an in-app purchase API.

 

Signup

You can analyze app registration event using adbrix SDK API

@IBAction func userRegister(_ sender: Any) {
  
  // Create adbrix Instance
  let adBrix = AdBrixRM.getInstance  // User information
  
  // User information
  let attrModel = AdBrixRmAttrModel()
        attrModel.setAttrDataString("nickname", "peter")
        attrModel.setAttrDataInt("age", 36)
        attrModel.setAttrDataBool("married", true)
        
  // Signup API  
  adBrix.commonSignUpWithAttr(channel: AdBrixRM.AdBrixRmSignUpChannel.AdBrixRmSignUpGoogleChannel, commonAttr: attrModel)

}

  

App Update

You can analyze app update events using adbrix SDK API.

@IBAction func appUpdate(_ sender: Any) { 

// Create adbrix instance
  let adBrix = AdBrixRM.getInstance
  
// User information
  let attrModel = AdBrixRmAttrModel()
        attrModel.setAttrDataString("nickname", "peter")
        attrModel.setAttrDataInt("age", 36)
        attrModel.setAttrDataBool("married", true)

// App update API  
  adBrix.commonAppUpdateWithAttr(prev_ver: "1.0.1", curr_ver: "1.0.3", commonAttr: attrModel)

}

 

User invitation

You can analyze the user invitation event using adbrix SDK API.

@IBAction func userInvite(_ sender: Any) {
  
  // Create adbrix Instance
  let adBrix = AdBrixRM.getInstance

  // User information
  let attrModel = AdBrixRmAttrModel()
        attrModel.setAttrDataString("nickname", "peter")
        attrModel.setAttrDataInt("age", 36)
        attrModel.setAttrDataBool("married", true)
   
   // User invitation API  
   adBrix.commonInviteWithAttr(channel: AdBrixRM.AdBrixRmInviteChannel.AdBrixRmInviteLineChannel, commonAttr: attrModel)

}

 

Use in-app credit

You can analyze user using in-app credit event, using adbrix SDK API

@IBAction func useCredit(_ sender: Any) { 
 
  // Create adbrix Instance
  let adbrix = AdBrixRM.getInstance
 
  // User information
  let attrModel = AdBrixRmAttrModel()
        attrModel.setAttrDataString("nickname", "peter")
        attrModel.setAttrDataInt("age", 36)
        attrModel.setAttrDataInt("credit", 10000)       
        attrModel.setAttrDataBool("married", true)
  
  // Use in-app credit API 
  adBrix.commonUseCreditWithAttr(commonAttr: attrModel)
  
}

 

In-app purchase

You can analyze the in-app purchase event using adbrix SDK API

In-app purchase API requires information that API already pre-defined.

  • order id (required) 
  • product id (required)
  • product name (required)
  • price (required)
  • quantity (required)
  • discount (optional)
  • currency (optional)
  • category (optional)
  • product attr map (optional) 
  • delivery charge (optional)
  • payment method (optional)
@IBAction func purchase_event(_ sender: Any) {

  // Create adbrix Instance
  let adBrix = AdBrixRM.getInstance
  
  // event AttrModel
  let attrModel = AdBrixRmAttrModel()
      attrModel.setAttrDataString("nickname", "peter")
      attrModel.setAttrDataInt("age", 36)
      attrModel.setAttrDataInt("credit", 10000)       
      attrModel.setAttrDataBool("married", true)
  
  // product option AttrModel
  let productAttr1 = AdBrixRmAttrModel()
      productAttr1.setAttrDataString("product_type", "computer")
      productAttr1.setAttrDataString("color", "black")
      productAttr1.setAttrDataInt("size", 36)
      productAttr1.setAttrDataInt("current_point", 123456)
      productAttr1.setAttrDataBool("promotion", true)

  // create product model
  let productModel1 =  adBrix.createCommerceProductDataWithAttr(
            productId: "productID_1",
            productName: "productname 1",
            price: 123456.00,
            quantity: 1,
            discount: 2500.00,
            currencyString: adBrix.getCurrencyString(AdBrixRM.AdBrixRmCurrencyType.KRW.rawValue),
            category: adBrix.createCommerceProductCategoryData(category: "computer", category2: "PC", category3: "cd-rom", category4: "software", category5: "game"),
            productAttrsMap: productAttr1)

  // product option AttrModel
 let productAttr2 = AdBrixRmAttrModel()
        productAttr2.setAttrDataString("product_type", "pants")
        productAttr2.setAttrDataString("color", "blue")
        productAttr2.setAttrDataInt("size", 42)
        productAttr2.setAttrDataInt("current_point", 234423)
        productAttr2.setAttrDataBool("promotion", false)

  // create product model
 let productModel2 =  adBrix.createCommerceProductDataWithAttr(
            productId: "productID_2",
            productName: "product 2",
            price: 700000.00,
            quantity: 1,
            discount: 3500.00,
            currencyString: adBrix.getCurrencyString(AdBrixRM.AdBrixRmCurrencyType.KRW.rawValue),
            category: adBrix.createCommerceProductCategoryData(category: "clothes", category2: "pants", category3: "jean", category4: "longpants", category5: "sales"),
            productAttrsMap: productAttr2)

  // Product list array
  var proArr : Array<AdBrixRmCommerceProductModel> = Array()
  arr.append(productModel1)
  arr.append(productModel2)

  //In-app purchase API
  adBrix.commonPurchaseWithAttr(orderId: "orderid_1",
                                productInfo: proArr,
                                discount: 1500.00,
                                deliveryCharge: 2500.00,
                                paymentMethod: AdBrixRM.AdbrixRmPaymentMethod.CreditCard,
                                orderAttr: attrModel)

}

 

 

 

Commerce Analysis

You can analyze in-app commerce events like product view, add to cart, etc using adbrix SDK API.

adbrix SDK provides 12 pre-defined commerce API

  • Home view
  • Category view
  • Product view
  • Add to cart
  • Add to wishlist
  • Review order
  • Refund
  • Product search
  • Product share
  • Product listview
  • Cart view
  • Payment information

 

 

Home view

You can analyze events when a user views the main screen on your app, using adbrix SDK API.

@IBAction func viewHomeEvent(_ sender: Any) {

  // Create adbrix Instance
  let adBrix = AdBrixRM.getInstance
    
  // Home view API
  adBrix.commerceViewHome()
}

 

 

Category view

You can analyze events when a user enters a product category using adbrix SDK API.

You can add a maximum of 5 categories to API

@IBAction func viewCategoryEvent(_ sender: Any) {

  // Create adbrix Instance
  let adBrix = AdBrixRM.getInstance
  
  // event AttrModel
  let attrModel = AdBrixRmAttrModel()
      attrModel.setAttrDataString("nickname", "peter")
      attrModel.setAttrDataInt("age", 36)
      attrModel.setAttrDataInt("credit", 10000)       
      attrModel.setAttrDataBool("married", true)
  
  // product option AttrModel
  let productAttr1 = AdBrixRmAttrModel()
      productAttr1.setAttrDataString("product_type", "computer")
      productAttr1.setAttrDataString("color", "black")
      productAttr1.setAttrDataInt("size", 36)
      productAttr1.setAttrDataInt("current_point", 123456)
      productAttr1.setAttrDataBool("promotion", true)

  // create product model
  let productModel1 =  adBrix.createCommerceProductDataWithAttr(
            productId: "productID_1",
            productName: "productname 1",
            price: 123456.00,
            quantity: 1,
            discount: 2500.00,
            currencyString: adBrix.getCurrencyString(AdBrixRM.AdBrixRmCurrencyType.KRW.rawValue),
            category: adBrix.createCommerceProductCategoryData(category: "computer", category2: "PC", category3: "cd-rom", category4: "software", category5: "game"),
            productAttrsMap: productAttr1)

  // product option AttrModel
  let productAttr2 = AdBrixRmAttrModel()
        productAttr2.setAttrDataString("product_type", "pants")
        productAttr2.setAttrDataString("color", "blue")
        productAttr2.setAttrDataInt("size", 42)
        productAttr2.setAttrDataInt("current_point", 234423)
        productAttr2.setAttrDataBool("promotion", false)

  // create product model
  let productModel2 =  adBrix.createCommerceProductDataWithAttr(
            productId: "productID_2",
            productName: "product 2",
            price: 700000.00,
            quantity: 1,
            discount: 3500.00,
            currencyString: adBrix.getCurrencyString(AdBrixRM.AdBrixRmCurrencyType.KRW.rawValue),
            category: adBrix.createCommerceProductCategoryData(category: "clothes", category2: "pants", category3: "jean", category4: "longpants", category5: "sales"),
            productAttrsMap: productAttr2)

  // Product list array
  var proArr : Array<AdBrixRmCommerceProductModel> = Array()
  arr.append(productModel1)
  arr.append(productModel2)
  
  //open category
  adBrix.commerceCategoryViewWithAttr(category: adBrix.createCommerceProductCategoryData(category: "clothes", category2: "skirt", category3: "female", category4: "dress", category5: "spring"),
                                      productInfo: proArr,
                                      orderAttr: attrModel)

}

 

 

Product view

You can analyze event when a user enters a certain product using adbrix SDK API

Product view API requires information that API already pre-defined.

  • product id : (required)
  • product name : (required)
  • price : (required)
  • quantity : (required)
  • discount : (optional)
  • currency string : (optional)
  • category : (optional)
  • product attr map : (optional) 
@IBAction func viewProductDetailEvent(_ sender: Any) {

  // Create adbrix Instance
  let adBrix = AdBrixRM.getInstance
  
  // event AttrModel
  let attrModel = AdBrixRmAttrModel()
      attrModel.setAttrDataString("nickname", "peter")
      attrModel.setAttrDataInt("age", 36)
      attrModel.setAttrDataInt("credit", 10000)       
      attrModel.setAttrDataBool("married", true)
  
  // product option AttrModel
  let productAttr1 = AdBrixRmAttrModel()
      productAttr1.setAttrDataString("product_type", "computer")
      productAttr1.setAttrDataString("color", "black")
      productAttr1.setAttrDataInt("size", 36)
      productAttr1.setAttrDataInt("current_point", 123456)
      productAttr1.setAttrDataBool("promotion", true)

  // create product model
  let productModel1 =  adBrix.createCommerceProductDataWithAttr(
            productId: "productID_1",
            productName: "productname 1",
            price: 123456.00,
            quantity: 1,
            discount: 2500.00,
            currencyString: adBrix.getCurrencyString(AdBrixRM.AdBrixRmCurrencyType.KRW.rawValue),
            category: adBrix.createCommerceProductCategoryData(category: "computer", category2: "PC", category3: "cd-rom", category4: "software", category5: "game"),
            productAttrsMap: productAttr1)

  //productView API
  adBrix.commerceProductViewWithAttr(productInfo: productModel1, orderAttr: attrModel)

}

 

 

Add to cart

You can analyze event when a user adds a certain product to the cart using adbrix SDK API

"Add to cart API" requires information that adbrix already defined.

  • product id : (required)
  • product name : (required)
  • price : (required)
  • quantity : (required)
  • discount : (optional)
  • currency string : (optional)
  • category : (optional)
  • product attr map : (optional)
@IBAction func addToCartEvent(_ sender: Any) {

  // Create adbrix Instance
  let adBrix = AdBrixRM.getInstance
  
  // event AttrModel
  let attrModel = AdBrixRmAttrModel()
      attrModel.setAttrDataString("nickname", "peter")
      attrModel.setAttrDataInt("age", 36)
      attrModel.setAttrDataInt("credit", 10000)       
      attrModel.setAttrDataBool("married", true)
  
  // product option AttrModel
  let productAttr1 = AdBrixRmAttrModel()
      productAttr1.setAttrDataString("product_type", "computer")
      productAttr1.setAttrDataString("color", "black")
      productAttr1.setAttrDataInt("size", 36)
      productAttr1.setAttrDataInt("current_point", 123456)
      productAttr1.setAttrDataBool("promotion", true)

  // create product model
  let productModel1 =  adBrix.createCommerceProductDataWithAttr(
            productId: "productID_1",
            productName: "productname 1",
            price: 123456.00,
            quantity: 1,
            discount: 2500.00,
            currencyString: adBrix.getCurrencyString(AdBrixRM.AdBrixRmCurrencyType.KRW.rawValue),
            category: adBrix.createCommerceProductCategoryData(category: "computer", category2: "PC", category3: "cd-rom", category4: "software", category5: "game"),
            productAttrsMap: productAttr1)

  // product option AttrModel
  let productAttr2 = AdBrixRmAttrModel()
        productAttr2.setAttrDataString("product_type", "pants")
        productAttr2.setAttrDataString("color", "blue")
        productAttr2.setAttrDataInt("size", 42)
        productAttr2.setAttrDataInt("current_point", 234423)
        productAttr2.setAttrDataBool("promotion", false)

  // create product model
  let productModel2 =  adBrix.createCommerceProductDataWithAttr(
            productId: "productID_2",
            productName: "product 2",
            price: 700000.00,
            quantity: 1,
            discount: 3500.00,
            currencyString: adBrix.getCurrencyString(AdBrixRM.AdBrixRmCurrencyType.KRW.rawValue),
            category: adBrix.createCommerceProductCategoryData(category: "cloth", category2: "pants", category3: "jean", category4: "longpants", category5: "sales"),
            productAttrsMap: productAttr2)

  // Product list array
  var proArr : Array<AdBrixRmCommerceProductModel> = Array()
  arr.append(productModel1)
  arr.append(productModel2)
  
  // add to cart api
  adBrix.commerceAddToCartWithAttr(productInfo: proArr, orderAttr: attrModel)
  
}

 

 

Add to wishlist

You can analyze event when a user adds a certain product to the wishlist using adbrix SDK API

"Add to wishlist API" requires information that adbrix already defined.

  • product id : (required)
  • product name : (required)
  • price : (required)
  • quantity : (required)
  • discount : (optional)
  • currency string : (optional)
  • category : (optional)
  • product attr map : (optional)
@IBAction func addToWishListEvent(_ sender: Any) {

  // Create adbrix Instance
  let adBrix = AdBrixRM.getInstance
  
  // event AttrModel
  let attrModel = AdBrixRmAttrModel()
      attrModel.setAttrDataString("nickname", "peter")
      attrModel.setAttrDataInt("age", 36)
      attrModel.setAttrDataInt("credit", 10000)       
      attrModel.setAttrDataBool("married", true)
  
  // product option AttrModel
  let productAttr1 = AdBrixRmAttrModel()
      productAttr1.setAttrDataString("product_type", "computer")
      productAttr1.setAttrDataString("color", "black")
      productAttr1.setAttrDataInt("size", 36)
      productAttr1.setAttrDataInt("current_point", 123456)
      productAttr1.setAttrDataBool("promotion", true)

  // create product model
  let productModel1 =  adBrix.createCommerceProductDataWithAttr(
            productId: "productID_1",
            productName: "productname 1",
            price: 123456.00,
            quantity: 1,
            discount: 2500.00,
            currencyString: adBrix.getCurrencyString(AdBrixRM.AdBrixRmCurrencyType.KRW.rawValue),
            category: adBrix.createCommerceProductCategoryData(category: "computer", category2: "PC", category3: "cd-rom", category4: "software", category5: "game"),
            productAttrsMap: productAttr1)
  
  // Add to wishlist api
  adBrix.commerceAddToWishListWithAttr(productInfo: productModel1, orderAttr: attrModel)
  
}

 

 

Review Order

You can analyze event when user review the product order using adbrix SDK API

Review Order API requires specific information.

  • order id : (required) 
  • product id : (required) 
  • product name : (required) 
  • price : (required) 
  • quantity : (required) 
  • discount : (optional) 
  • currency string : (optional) 
  • category : (optional) 
  • product attr map : (optional) 
  • delivery charge : (optional)
@IBAction func reviewOrderEvent(_ sender: Any) {

  // Create adbrix Instance
  let adBrix = AdBrixRM.getInstance
  
  // event AttrModel
  let attrModel = AdBrixRmAttrModel()
      attrModel.setAttrDataString("nickname", "peter")
      attrModel.setAttrDataInt("age", 36)
      attrModel.setAttrDataInt("credit", 10000)       
      attrModel.setAttrDataBool("married", true)
  
  // product option AttrModel
  let productAttr1 = AdBrixRmAttrModel()
      productAttr1.setAttrDataString("product_type", "computer")
      productAttr1.setAttrDataString("color", "black")
      productAttr1.setAttrDataInt("size", 36)
      productAttr1.setAttrDataInt("current_point", 123456)
      productAttr1.setAttrDataBool("promotion", true)

  // create product model
  let productModel1 =  adBrix.createCommerceProductDataWithAttr(
            productId: "productID_1",
            productName: "productname 1",
            price: 123456.00,
            quantity: 1,
            discount: 2500.00,
            currencyString: adBrix.getCurrencyString(AdBrixRM.AdBrixRmCurrencyType.KRW.rawValue),
            category: adBrix.createCommerceProductCategoryData(category: "computer", category2: "PC", category3: "cd-rom", category4: "software", category5: "game"),
            productAttrsMap: productAttr1)

  // product option AttrModel
  let productAttr2 = AdBrixRmAttrModel()
        productAttr2.setAttrDataString("product_type", "pants")
        productAttr2.setAttrDataString("color", "blue")
        productAttr2.setAttrDataInt("size", 42)
        productAttr2.setAttrDataInt("current_point", 234423)
        productAttr2.setAttrDataBool("promotion", false)

  // create product model
  let productModel2 =  adBrix.createCommerceProductDataWithAttr(
            productId: "productID_2",
            productName: "product 2",
            price: 700000.00,
            quantity: 1,
            discount: 3500.00,
            currencyString: adBrix.getCurrencyString(AdBrixRM.AdBrixRmCurrencyType.KRW.rawValue),
            category: adBrix.createCommerceProductCategoryData(category: "cloth", category2: "pants", category3: "jean", category4: "longpants", category5: "sales"),
            productAttrsMap: productAttr2)

  // Product list array
  var proArr : Array<AdBrixRmCommerceProductModel> = Array()
  arr.append(productModel1)
  arr.append(productModel2)
  
  // Review order api
  adBrix.commerceReviewOrderWithAttr(orderId: "orderID_2",
                                     productInfo: proArr,
                                     discount: 2500.00,
                                     deliveryCharge: 3000.00,
                                     orderAttr: attrModel)

}

 

 

Refund

You can analyze events when a user cancels a product order using adbrix SDK API.

Refund API requires information that API already defined.

  • order id : (required) 
  • product id : (required) 
  • product name : (required) 
  • price : (required) 
  • quantity : (required) 
  • discount : (optional) 
  • currency string : (optional) 
  • category : (optional) 
  • product attr map : (optional)
  • penalty charge : (optional)
func refundOrderEvent() {

  // Create adbrix Instance
  let adBrix = AdBrixRM.getInstance
  
  // event AttrModel
  let attrModel = AdBrixRmAttrModel()
      attrModel.setAttrDataString("nickname", "peter")
      attrModel.setAttrDataInt("age", 36)
      attrModel.setAttrDataInt("credit", 10000)       
      attrModel.setAttrDataBool("married", true)
  
  // product option AttrModel
  let productAttr1 = AdBrixRmAttrModel()
      productAttr1.setAttrDataString("product_type", "computer")
      productAttr1.setAttrDataString("color", "black")
      productAttr1.setAttrDataInt("size", 36)
      productAttr1.setAttrDataInt("current_point", 123456)
      productAttr1.setAttrDataBool("promotion", true)

  // create product model
  let productModel1 =  adBrix.createCommerceProductDataWithAttr(
            productId: "productID_1",
            productName: "productname 1",
            price: 123456.00,
            quantity: 1,
            discount: 2500.00,
            currencyString: adBrix.getCurrencyString(AdBrixRM.AdBrixRmCurrencyType.KRW.rawValue),
            category: adBrix.createCommerceProductCategoryData(category: "computer", category2: "PC", category3: "cd-rom", category4: "software", category5: "game"),
            productAttrsMap: productAttr1)

  // product option AttrModel
  let productAttr2 = AdBrixRmAttrModel()
        productAttr2.setAttrDataString("product_type", "pants")
        productAttr2.setAttrDataString("color", "blue")
        productAttr2.setAttrDataInt("size", 42)
        productAttr2.setAttrDataInt("current_point", 234423)
        productAttr2.setAttrDataBool("promotion", false)

  // create product model
  let productModel2 =  adBrix.createCommerceProductDataWithAttr(
            productId: "productID_2",
            productName: "product 2",
            price: 700000.00,
            quantity: 1,
            discount: 3500.00,
            currencyString: adBrix.getCurrencyString(AdBrixRM.AdBrixRmCurrencyType.KRW.rawValue),
            category: adBrix.createCommerceProductCategoryData(category: "cloth", category2: "pants", category3: "jean", category4: "longpants", category5: "sales"),
            productAttrsMap: productAttr2)

  // Product list array
  var proArr : Array<AdBrixRmCommerceProductModel> = Array()
  arr.append(productModel1)
  arr.append(productModel2)
  
  //Refund API
  adBrix.commerceRefundWithAttr(orderId: "orderID_3",
                                productInfo: proArr,
                                penaltyCharge: 250000.00,
                                orderAttr: attrModel)
  
}

 

 

Product search

You can analyze events when a user searches a certain product using adbrix SDK API.

Product search API requires sepcific information.

  • keyword : (required) 
  • product id : (required) 
  • product name : (required) 
  • price : (required) 
  • quantity : (required) 
  • discount : (optional) 
  • currency string : (optional) 
  • category : (optional) 
@IBAction func searchResultEvent() {

  // Create adbrix Instance
  let adBrix = AdBrixRM.getInstance
  
  // event AttrModel
  let attrModel = AdBrixRmAttrModel()
      attrModel.setAttrDataString("nickname", "peter")
      attrModel.setAttrDataInt("age", 36)
      attrModel.setAttrDataInt("credit", 10000)       
      attrModel.setAttrDataBool("married", true)
  
  // product option AttrModel
  let productAttr1 = AdBrixRmAttrModel()
      productAttr1.setAttrDataString("product_type", "computer")
      productAttr1.setAttrDataString("color", "black")
      productAttr1.setAttrDataInt("size", 36)
      productAttr1.setAttrDataInt("current_point", 123456)
      productAttr1.setAttrDataBool("promotion", true)

  // create product model
  let productModel1 =  adBrix.createCommerceProductDataWithAttr(
            productId: "productID_1",
            productName: "productname 1",
            price: 123456.00,
            quantity: 1,
            discount: 2500.00,
            currencyString: adBrix.getCurrencyString(AdBrixRM.AdBrixRmCurrencyType.KRW.rawValue),
            category: adBrix.createCommerceProductCategoryData(category: "computer", category2: "PC", category3: "cd-rom", category4: "software", category5: "game"),
            productAttrsMap: productAttr1)

  // product option AttrModel
  let productAttr2 = AdBrixRmAttrModel()
        productAttr2.setAttrDataString("product_type", "pants")
        productAttr2.setAttrDataString("color", "blue")
        productAttr2.setAttrDataInt("size", 42)
        productAttr2.setAttrDataInt("current_point", 234423)
        productAttr2.setAttrDataBool("promotion", false)

  // create product model
  let productModel2 =  adBrix.createCommerceProductDataWithAttr(
            productId: "productID_2",
            productName: "product 2",
            price: 700000.00,
            quantity: 1,
            discount: 3500.00,
            currencyString: adBrix.getCurrencyString(AdBrixRM.AdBrixRmCurrencyType.KRW.rawValue),
            category: adBrix.createCommerceProductCategoryData(category: "cloth", category2: "pants", category3: "jean", category4: "longpants", category5: "sales"),
            productAttrsMap: productAttr2)

  // Product list array
  var proArr : Array<AdBrixRmCommerceProductModel> = Array()
  arr.append(productModel1)
  arr.append(productModel2)

  // product search api
  adBrix.commerceSearchWithAttr(productInfo: proArr,
                                keyword: "This is a search keyword.",
                                orderAttr: attrModel)
  
}

 

 

Product Share

You can analyze events when a user shares a certain product using adbrix SDK API.

Product share API requires information that API already defined.

  • product id : (required)
  • product name : (required)
  • price : (required)
  • quantity : (required)
  • discount : (optional)
  • currency string : (optional) 
  • category : (optional) 
  • product attr map : (optional) 
@IBAction func shareEvent(_ sender: Any) {

  // Create adbrix Instance
  let adBrix = AdBrixRM.getInstance
  
  // event AttrModel
  let attrModel = AdBrixRmAttrModel()
      attrModel.setAttrDataString("nickname", "peter")
      attrModel.setAttrDataInt("age", 36)
      attrModel.setAttrDataInt("credit", 10000)       
      attrModel.setAttrDataBool("married", true)
  
  // product option AttrModel
  let productAttr1 = AdBrixRmAttrModel()
      productAttr1.setAttrDataString("product_type", "computer")
      productAttr1.setAttrDataString("color", "black")
      productAttr1.setAttrDataInt("size", 36)
      productAttr1.setAttrDataInt("current_point", 123456)
      productAttr1.setAttrDataBool("promotion", true)

  // create product model
  let productModel1 =  adBrix.createCommerceProductDataWithAttr(
            productId: "productID_1",
            productName: "productname 1",
            price: 123456.00,
            quantity: 1,
            discount: 2500.00,
            currencyString: adBrix.getCurrencyString(AdBrixRM.AdBrixRmCurrencyType.KRW.rawValue),
            category: adBrix.createCommerceProductCategoryData(category: "computer", category2: "PC", category3: "cd-rom", category4: "software", category5: "game"),
            productAttrsMap: productAttr1)     
      
    // Product share API
    adBrix.commerceShareWithAttr(channel: AdBrixRM.AdBrixRmSharingChannel.AdBrixRmSharingKakaoStory,
                                 productInfo: productModel1,
                                 orderAttr: attrModel)
    
}

 

List view

You can analyze events when a user views a list of products using adbrix SDK API.

List view API requires specific information.

  • product id : (required) 
  • product name : (required) 
  • price : (required) 
  • quantity : (required) 
  • discount : (optional) 
  • currency string : (optional) 
  • category : (optional) 
  • product attr map : (optional)
@IBAction func listViewEvent() {

  // Create adbrix Instance
  let adBrix = AdBrixRM.getInstance
  
  // event AttrModel
  let attrModel = AdBrixRmAttrModel()
      attrModel.setAttrDataString("nickname", "peter")
      attrModel.setAttrDataInt("age", 36)
      attrModel.setAttrDataInt("credit", 10000)       
      attrModel.setAttrDataBool("married", true)
  
  // product option AttrModel
  let productAttr1 = AdBrixRmAttrModel()
      productAttr1.setAttrDataString("product_type", "computer")
      productAttr1.setAttrDataString("color", "black")
      productAttr1.setAttrDataInt("size", 36)
      productAttr1.setAttrDataInt("current_point", 123456)
      productAttr1.setAttrDataBool("promotion", true)

  // create product model
  let productModel1 =  adBrix.createCommerceProductDataWithAttr(
            productId: "productID_1",
            productName: "productname 1",
            price: 123456.00,
            quantity: 1,
            discount: 2500.00,
            currencyString: adBrix.getCurrencyString(AdBrixRM.AdBrixRmCurrencyType.KRW.rawValue),
            category: adBrix.createCommerceProductCategoryData(category: "computer", category2: "PC", category3: "cd-rom", category4: "software", category5: "game"),
            productAttrsMap: productAttr1)

  // product option AttrModel
  let productAttr2 = AdBrixRmAttrModel()
        productAttr2.setAttrDataString("product_type", "pants")
        productAttr2.setAttrDataString("color", "blue")
        productAttr2.setAttrDataInt("size", 42)
        productAttr2.setAttrDataInt("current_point", 234423)
        productAttr2.setAttrDataBool("promotion", false)

  // create product model
  let productModel2 =  adBrix.createCommerceProductDataWithAttr(
            productId: "productID_2",
            productName: "product 2",
            price: 700000.00,
            quantity: 1,
            discount: 3500.00,
            currencyString: adBrix.getCurrencyString(AdBrixRM.AdBrixRmCurrencyType.KRW.rawValue),
            category: adBrix.createCommerceProductCategoryData(category: "cloth", category2: "pants", category3: "jean", category4: "longpants", category5: "sales"),
            productAttrsMap: productAttr2)

  // Product list array
  var proArr : Array<AdBrixRmCommerceProductModel> = Array()
  arr.append(productModel1)
  arr.append(productModel2)
      
  // list view API
  adBrix.commerceListViewWithAttr(productInfo: proArr, orderAttr: attrModel)
    
}

 

Cart view

You can analyze events when a user views the cart using adbrix SDK API.

Cart view API requires specific information.

  • product id : (required) 
  • product name : (required)
  • price : (required)
  • quantity : (required)
  • discount : (optional)
  • currency string : (optional) 
  • category : (optional) 
  • product attr map : (optional) 
@IBAction func cartViewEvent() {

  // Create adbrix Instance
  let adBrix = AdBrixRM.getInstance
  
  // event AttrModel
  let attrModel = AdBrixRmAttrModel()
      attrModel.setAttrDataString("nickname", "peter")
      attrModel.setAttrDataInt("age", 36)
      attrModel.setAttrDataInt("credit", 10000)       
      attrModel.setAttrDataBool("married", true)
  
  // product option AttrModel
  let productAttr1 = AdBrixRmAttrModel()
      productAttr1.setAttrDataString("product_type", "computer")
      productAttr1.setAttrDataString("color", "black")
      productAttr1.setAttrDataInt("size", 36)
      productAttr1.setAttrDataInt("current_point", 123456)
      productAttr1.setAttrDataBool("promotion", true)

  // create product model
  let productModel1 =  adBrix.createCommerceProductDataWithAttr(
            productId: "productID_1",
            productName: "productname 1",
            price: 123456.00,
            quantity: 1,
            discount: 2500.00,
            currencyString: adBrix.getCurrencyString(AdBrixRM.AdBrixRmCurrencyType.KRW.rawValue),
            category: adBrix.createCommerceProductCategoryData(category: "computer", category2: "PC", category3: "cd-rom", category4: "software", category5: "game"),
            productAttrsMap: productAttr1)

  // product option AttrModel
  let productAttr2 = AdBrixRmAttrModel()
        productAttr2.setAttrDataString("product_type", "pants")
        productAttr2.setAttrDataString("color", "blue")
        productAttr2.setAttrDataInt("size", 42)
        productAttr2.setAttrDataInt("current_point", 234423)
        productAttr2.setAttrDataBool("promotion", false)

  // create product model
  let productModel2 =  adBrix.createCommerceProductDataWithAttr(
            productId: "productID_2",
            productName: "product 2",
            price: 700000.00,
            quantity: 1,
            discount: 3500.00,
            currencyString: adBrix.getCurrencyString(AdBrixRM.AdBrixRmCurrencyType.KRW.rawValue),
            category: adBrix.createCommerceProductCategoryData(category: "cloth", category2: "pants", category3: "jean", category4: "longpants", category5: "sales"),
            productAttrsMap: productAttr2)

  // Product list array
  var proArr : Array<AdBrixRmCommerceProductModel> = Array()
  arr.append(productModel1)
  arr.append(productModel2)
      
  // cart view api
  adBrix.commerceCartViewWithAttr(productInfo: proArr, orderAttr: attrModel)
    
  }

 

Payment information

You can analyze user payment information using adbrix SDK API.

@IBAction func paymentInfoAddedEvent(_ sender: Any) {

  // Create adbrix Instance
  let adBrix = AdBrixRM.getInstance
  
  // event AttrModel
  let attrModel = AdBrixRmAttrModel()
      attrModel.setAttrDataString("nickname", "peter")
      attrModel.setAttrDataString("creditcard", "kbcard")
      attrModel.setAttrDataInt("age", 36)
      attrModel.setAttrDataInt("credit", 10000)       
      attrModel.setAttrDataBool("married", true)
   
  // payment view api
  adBrix.commercePaymentInfoAddedWithAttr(paymentInfoAttr: attrModel)
  
}

 

 

Game analysis

You can analyze in-game events like level up, stage complete, etc using adbrix SDK API.

adbrix SDK provides 4 pre-defined game APIs

  • Tutorial complete
  • Character create
  • Stage complete
  • Level up

 

Tutorial complete

You can analyze events when users complete game tutorials using adbrix SDK API.

Tutorial complete API requires information that API already pre-defined.

  • isSkip : (required) set which user complete tutorial or skip the tutorial
@IBAction func tutorialCompleteEvent(){
 
 // Create adbrix Instance
  let adBrix = AdBrixRM.getInstance
  
  // event AttrModel
  let attrModel = AdBrixRmAttrModel()
      attrModel.setAttrDataString("nickname", "peter")
      attrModel.setAttrDataInt("age", 36)
      attrModel.setAttrDataInt("credit", 10000)       
      attrModel.setAttrDataBool("married", true)

  //Tutorial complete API
  adBrix.gameTutorialCompletedWithAttr(isSkip: true, gameInfoAttr: attrModel)

}

 

Create Character

You can analyze an event when a user creates a game character using adbrix SDK API.

@IBAction func characterCreatedEvent(){
 
  // Create adbrix Instance
  let adBrix = AdBrixRM.getInstance
  
  // event AttrModel
  let attrModel = AdBrixRmAttrModel()
      attrModel.setAttrDataString("nickname", "peter")
      attrModel.setAttrDataInt("age", 36)
      attrModel.setAttrDataInt("credit", 10000)       
      attrModel.setAttrDataBool("married", true)

  //Create character API
  adBrix.gameCharacterCreatedWithAttr(gameInfoAttr: attrModel)

}

 

Stage complete

You can analyze events when a user completes a certain game stage using adbrix SDK API.

Stage complete API requires information that API already defined.

  • StageName : (required) Name of complete stage
@IBAction func stageClearedEvent(){
 
  // Create adbrix Instance
  let adBrix = AdBrixRM.getInstance
  
  // event AttrModel
  let attrModel = AdBrixRmAttrModel()
      attrModel.setAttrDataString("nickname", "peter")
      attrModel.setAttrDataInt("age", 36)
      attrModel.setAttrDataInt("credit", 10000)       
      attrModel.setAttrDataBool("married", true)

  //Stage complete API
  adBrix.gameStageClearedWithAttr(stageName: "1-5", gameInfoAttr: attrModel)
  
}

Level up

You can analyze events when a user achieves a certain level in the game using adbrix SDK API.

Level up API requires information that API already defined.

  • Level : (required) 
@IBAction func levelAchievedEvent(){
 
  // Create adbrix Instance
  let adBrix = AdBrixRM.getInstance
  
  // event AttrModel
  let attrModel = AdBrixRmAttrModel()
      attrModel.setAttrDataString("nickname", "peter")
      attrModel.setAttrDataInt("age", 36)
      attrModel.setAttrDataInt("credit", 10000)       
      attrModel.setAttrDataBool("married", true)

  //level up API
  adBrix.gameLevelAchievedWithAttr(level: 55, gameInfoAttr: attrModel)
  
}

Related articles

Comments

0 comments

Please sign in to leave a comment.

INDEX