Articles in this section

Adbrix Integration [iOS Swift]

Avatar
SE.TEAM(ADBRIX)
  • Updated
Follow

 

Quick Start

 

System Requirement

Build Tool : Newest Xcode version required

Additional setup : Newest Swift Library required

 

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 for download and installs the external library.

We recommend using CocoaPods for installing SDK.

 

 

CocoaPods Installation

If you don't have CocoaPods on your Mac, Open the MacOS terminal and type this command.

$ sudo gem install cocoapods

 

After installation is complete, you can see these result 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

After installing CocoaPods, initialize CocoaPods.

$ pod setup

 

After CocoaPods initialization is complete you can see these result on a 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 type this commend for generating Podfile.

$ pod init

 

 

Podfile setup

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

After that press Esc, Shift+z twice for exit the editor.

$ vi Podfile

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

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

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

 

 

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 command "pod update" or "pod setup" for installing latest Adbrix SDK.

$ pod setup
$ pod update

 

 

Open XCode Project

After installation of Adbrix SDK completed, start {project_name}.xcworkspace file for open Xcode project. You can find Adbrix pods.

$ open myXcodeProject.xcworkspace

 

Add required framework

To make adbrix SDK works, it requires to add iAD frameworks.

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

 

Swift Library Setup

Adbrix SDK is using Swift language. So to use Adbrix SDK, Xcode project is required to enable the Swift library.

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

  

Apple IDFA Setup

To use adbrix Attribution SDK, Apple IDFA is required.

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

 

AppKey & SecretKey setup

Set the Adbrix AppKey and SecretKey issued from Adbrix console.

 

import AdBrixRM

func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {
    // Override point for customization after application launch.
    
    // Create AdBrixRM Instance
    let adBrix = AdBrixRM.getInstance
    
    // AdBrix AppKey / SecretKey setup
    adBrix.initAdBrix(appKey: "odhvASVRDsdf10d019fva", secretKey: "ar98LszQZUGdmSznToNBXg")
    
    return true
}

* AppKey is different from AdBrix Classic and AdBrix Remaster.

* AdBrix Remaster AppKey and SecretKey can be used on both Android and iOS platform.

 

Start from sample project

AdBrix provides Xcode project which already have installed the adbrix SDK.

You can download the project base 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

 

Log Level Setup

Seup the log level for AdBrix SDK log

There are 6 levels for Adbrix SDK log. 

  • AdBrixLogLevelNONE : No SDK log can be 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 the every SDK logs including the fatal error.
import AdBrixRM

func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {
    // Override point for customization after application launch.
    
    // Create AdBrixRM Instance
    let adBrix = AdBrixRM.getInstance
    
    // AdBrix Log Level setup
    adBrix.setLogLevel(AdBrixRM.AdBrixLogLevel.TRACE) 
    
    return true;
}

 

 

Event upload cycle setup

The developer can set Event upload counter that counts how many events have been called.

Event upload cycle can set base on how many events have been counted or base on time.

 

Event upload counter

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

AdBrix SDK have 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

func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {
        // Override point for customization after application launch.
    
    // Create AdBrixRM Instance
    let adBrix = AdBrixRM.getInstance

    // Event Upload counter API
    adBrix.setEventUploadCountInterval(AdBrixRM.AdBrixEventUploadCount.MIN)
    
    return true;
}

 

Event upload timer

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

AdBrix SDK has 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

func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {
    // Override point for customization after application launch.
    
    // Create AdBrixRM instance 
    let adBrix = AdBrixRM.getInstance
    
    // Event upload timer API
    adBrix.setEventUploadTimeInterval(AdBrixRM.AdBrixEventUploadInterval.MAX)
    
    return true
}

 

GDPR Setup

The developer can stop the adbrix SDK with the GDPR API.

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

This cannot be re-inversed unless the user deletes app.

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

 

 

 

 

 

Deeplink setup

You can count app re-open event by deeplink url. 

To do that, app must have custom url scheme.

 

Custom Url Scheme setup

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

 

 

Deeplink open event.

Add deeplink open event API on AppDelegate.swift application: openURL: delegate.

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

 

Deferred Deeplink Tracking

If you wish to send the user a certain view when the user installs the app after click tracking link, Deferred Deeplink API can send the user to a certain view.

 

 ※ Warning 1 : If you are doing certain UI process using Deferred Deeplink value, you must work on main thread.

 ※ Warning 2  : Deferred Deeplink value will send as string

예시 : "yourscheme://your_custom_path"

 

AppDelegate.swift

func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: 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)
       }
          
        adBrix.delegateDeeplink = self
        
        return true
    }
    
    
    func didReceiveDeeplink(deeplink: String) {

        print("DEEPLink :: received - \(deeplink)")
    } 

 

 

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

By using adbrix SDK, you can analyze the in-app events and create in-app event reports from adbrix dashboard.

To analyze the in-app event, you must add adbrix event API for the point where the event is executed.

The adbrix SDK provides five 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 user login succeeds.

You can reset the UserID by send @"" empty string when user 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 success and reset UserID with @"" empty string
    adBrix.login(userId:"")
  }
}

* 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 Infomation

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 dicData : [String: Any] = [ "nickname" : "홍길동" ]
  adBrix.setUserProperties(dictionary: dicData)
}

* adbrix do not take responsibility to use user information.

* Dictionary restriction

  • The adbrix SDK cannot send more than 100 information.
  • The data type only uses string and cannot have more than 256 letters.
  • The data type cannot use capital letters and special characters.
  • The value cannot have more than 1024byt.

 

 

Location information

If you can receive user location you can sen 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 do not take responsibility to use user location.

 

 

Custom event

adbrix SDK can analyze custom named event, which not pre-defined from adbrix SDK.

@IBAction func user_custom_event(_ sender: Any) {

  // Create AdBrix Instance
  let adBrix = AdBrixRM.getInstance
    
  // Add Custom named Event "invite_button_click"
  adBrix.event("invite_button_click")
     
}

 

General Event Analysis

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

adbrix SDK provide 5 pri-define general event.

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

* If you wish to see in-app purchase report, you must integrate 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
  let UserData : [String: Any] = [ "nickname" : "my_user_id" ]
 // Signup API  
adbrix.commonSignUp(channel:AdBrixRM.AdBrixSignUpChannel.AdBrixSignUpKakaoChannel, commonAttr: UserData)
}

  

App Update

You can analyze app update event using adbrix SDK API.

@IBAction func appUpdate(_ sender: Any) { 
  // Create AdBrix instance
  let adbrix = AdBrixRM.getInstance
// User information
  let UserData : [String: Any] = [ "nickname" : "my_user_id" ]
// App update API  
adbrix.commonAppUpdate(prev_ver: "1.0.1a", curr_ver: "1.2.1a", commonAttr: UserData) 
}

 

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 UserData : [String: Any] = [ "nickname" : "my_user_id" ]
// User invitation API  
adbrix.commonInvite(channel: AdBrixRM.AdBrixInviteChannel.AdBrixInviteLineChannel, commonAttr:UserData)
}

 

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 creditData : [String: Any] = [ "credit" : 10000 ]
// Use in-appp credit API 
adbrix.commonUseCredit(commonAttr: creditData)
}

 

In-app purchase

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

In-app purchase API require 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
  
  // product option Dictionary
  let extraDic1 : [String: String] = [
      "design_no" : "9",
      "color" : "black",
      "size" : "30"
  ]

  // create product model
  let productModel1 = adBrix.createCommerceProductData(
      productId: "5385487400"
      ,productName: "Baseball player cloth"
      ,price: 10000.00
      ,quantity: 1
      ,discount: 1000.0
      ,currencyString: adBrix.getCurrencyString(AdBrixRM.AdBrixCurrencyType.KRW)
      ,category: adBrix.createCommerceProductCategoryData(category: "cloth")
      ,productAttrsMap: adBrix.createCommerceProductAttrData(dictionary: extraDic1)
  )


  // product option Dictionary
  let extraDict2 : [String: String] = [
      "design" : "2",
      "color" : "black/white",
      "size" : "95"
  ]

  // create product model
  let productModel2 = adBrix.createCommerceProductData(
      productId: "145099811"
      ,productName: "Fooball player shoes"
      ,price: 15500.00
      ,quantity: 1
      ,discount: 1200.0
      ,currencyString: adBrix.getCurrencyString(AdBrixRM.AdBrixCurrencyType.KRW)
      ,category: adBrix.createCommerceProductCategoryData(category: "shoes")
      ,productAttrsMap: adBrix.createCommerceProductAttrData(dictionary: extraDict2)
  )

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

  //In-app purchase API
  adBrix.commonPurchase(orderId: "290192012", productInfo: arr, discount: 0.00, deliveryCharge: 3500.00, paymentMethod: adBrix.getPaymentMethod(AdBrix.AdbrixPaymentMethod.CreditCard))
}

 

 

 

Commerce Analysis

You can analyze in-app commerce event 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 event which 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 event which user enters a certain product category using adbrix SDK API.

You can add a maximum of 5 categories on API

@IBAction func viewCategoryEvent(_ sender: Any) {

  // Create AdBrixRM Instance
  let adBrix = AdBrixRM.getInstance
    
  //Open [shoes] category
  adBrix.commerceCategoryView(category: adBrix.createCommerceProductCategoryData(category: "shoes"))
  
  //open [shoes1-1, 1-2] category
  //adBrix.commerceCategoryView(category: adBrix.createCommerceProductCategoryData(category: "shoes", category2: "shoes1-1", category3: "shoes1-2"))
}

 

 

Product view

You can analyze event which user entering certain product using adbrix SDK API

Product view API require 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 AdBrixRM Instance
  let adBrix = AdBrixRM.getInstance

  //product option Dictionary
  let extraDic : [String: String] = [
            "no" : "9",
            "color" : "black",
            "size" : "XXL"
  ]
        
  //product view api
  adBrix.commerceProductView(
    productInfo: adBrix.createCommerceProductData(
        productId: "5385487400"
        ,productName: "Baseball player cloth"
        ,price: 10000.00
        ,quantity: 1
        ,discount: 1000.0
        ,currencyString: adBrix.getCurrencyString(AdBrixRM.AdBrixCurrencyType.KRW)
        ,category: adBrix.createCommerceProductCategoryData(category: "cloth")
        ,productAttrsMap: adBrix.createCommerceProductAttrData(dictionary: dicData)
    )
  )
}

 

 

Add to cart

You can analyze event which user add a certain product to cart using adbrix SDK API

Add to cart API require 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 addToCartEvent(_ sender: Any) {

  // Create AdBrixRM Instance
  let adBrix = AdBrixRM.getInstance
 
  // product option Dictionary 
  let extraDic1 : [String: String] = [
      "design_no" : "9",
      "color" : "black",
      "size" : "30"
  ]
  
  // create product model
  let productModel1 = adBrix.createCommerceProductData(
      productId: "5385487400"
      ,productName: "Baseball player cloth"
      ,price: 10000.00
      ,quantity: 1
      ,discount: 1000.0
      ,currencyString: adBrix.getCurrencyString(AdBrixRM.AdBrixCurrencyType.KRW)
      ,category: adBrix.createCommerceProductCategoryData(category: "cloth")
      ,productAttrsMap: adBrix.createCommerceProductAttrData(dictionary: extraDic1)
  )
  
  
  // product option Dictionary 
  let extraDict2 : [String: String] = [
      "design_no" : "3",
      "color" : "gray",
      "size" : "30"
  ]
  
  // create product model
  let productModel2 = adBrix.createCommerceProductData(
      productId: "5385487400"
      ,productName: "football player shoes"
      ,price: 10000.00
      ,quantity: 1
      ,discount: 1000.0
      ,currencyString: adBrix.getCurrencyString(AdBrixRM.AdBrixCurrencyType.KRW)
      ,category: adBrix.createCommerceProductCategoryData(category: "shoes")
      ,productAttrsMap: adBrix.createCommerceProductAttrData(dictionary: extraDict2)
  )
  
  // Product list array
  var arr : Array<AdBrixRmCommerceProductModel> = Array()
  arr.append(productModel1)
  arr.append(productModel2)
  
  // dd to cart api
  adBrix.commerceAddToCart(productInfo: arr)
  
}

 

 

Add to wishlist

You can analyze event which user add a certain product to wishlist using adbrix SDK API

Add to wishlist API require 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 addToWishListEvent(_ sender: Any) {

  // Create AdBrixRM Instance
  let adBrix = AdBrixRM.getInstance
 
  // product option Dictiona
        let extraDic : [String: String] = [
            "design_no" : "9",
            "color" : "black",
            "size" : "30"
        ]
        
  // create product model
  let productModel = adBrix.createCommerceProductData(
      productId: "5385487400"
      ,productName: "baseball player cloth"
      ,price: 10000.00
      ,quantity: 1
      ,discount: 1000.0
      ,currencyString: adBrix.getCurrencyString(AdBrixRM.AdBrixCurrencyType.KRW)
      ,category: adBrix.createCommerceProductCategoryData(category: "cloth")
      ,productAttrsMap: adBrix.createCommerceProductAttrData(dictionary: extraDic)
  )
  
  // Add to wishlist api
  adBrix.commerceAddToWishList(productInfo: productModel)
  
}

 

 

Review Order

You can analyze event which user reviewing user's product order  using adbrix SDK API

Review Order API require information that API already pre-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) 
  • delivery charge : (optional)
@IBAction func reviewOrderEvent(_ sender: Any) {

  // Create AdBrixRM Instance
  let adBrix = AdBrixRM.getInstance
 
  // product option Dictionary
  let extraDic1 : [String: String] = [
      "design_no" : "9",
      "color" : "black",
      "size" : "30"
  ]
  
  // create product model
  let productModel1 = adBrix.createCommerceProductData(
      productId: "5385487400"
      ,productName: "Baseball player cloth"
      ,price: 10000.00
      ,quantity: 1
      ,discount: 1000.0
      ,currencyString: adBrix.getCurrencyString(AdBrixRM.AdBrixCurrencyType.KRW)
      ,category: adBrix.createCommerceProductCategoryData(category: "cloth")
      ,productAttrsMap: adBrix.createCommerceProductAttrData(dictionary: extraDic1)
  )
  
  
  // product option Dictionary
  let extraDict2 : [String: String] = [
      "design_no" : "3",
      "color" : "gray",
      "size" : "30"
  ]
  
  // create product model
  let productModel2 = adBrix.createCommerceProductData(
      productId: "5385487400"
      ,productName: "football player shoes"
      ,price: 10000.00
      ,quantity: 1
      ,discount: 1000.0
      ,currencyString: adBrix.getCurrencyString(AdBrixRM.AdBrixCurrencyType.KRW)
      ,category: adBrix.createCommerceProductCategoryData(category: "shoes")
      ,productAttrsMap: adBrix.createCommerceProductAttrData(dictionary: extraDict2)
  )
  
  // Product list Array
  var arr : Array<AdBrixRmCommerceProductModel> = Array()
  arr.append(productModel1)
  arr.append(productModel2)
  
  // Review order api
  adBrix.commerceReviewOrder(orderId: "30290121", productInfo: arr, discount: 0.00, deliveryCharge: 3500.00)
}

 

 

Refund

You can analyze event which user cancel product order using adbrix SDK API.

Refund API require information that API already pre-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 AdBrixRM Instance
  let adBrix = AdBrixRM.getInstance
 
  // product option Dictionary
  let extraDic1 : [String: String] = [
      "design_no" : "9",
      "color" : "black",
      "size" : "30"
  ]
  
  // create product model
  let productModel1 = adBrix.createCommerceProductData(
      productId: "5385487400"
      ,productName: "슬랙스 10종 특가"
      ,price: 10000.00
      ,quantity: 1
      ,discount: 1000.0
      ,currencyString: adBrix.getCurrencyString(AdBrixRM.AdBrixCurrencyType.KRW)
      ,category: adBrix.createCommerceProductCategoryData(category: "하의 기획전")
      ,productAttrsMap: adBrix.createCommerceProductAttrData(dictionary: extraDic1)
  )
  
  
  // product option Dictionary
  let extraDict2 : [String: String] = [
      "design_no" : "3",
      "color" : "gray",
      "size" : "30"
  ]
  
  // create product model
  let productModel2 = adBrix.createCommerceProductData(
      productId: "5385487400"
      ,productName: "슬랙스 10종 특가"
      ,price: 10000.00
      ,quantity: 1
      ,discount: 1000.0
      ,currencyString: adBrix.getCurrencyString(AdBrixRM.AdBrixCurrencyType.KRW)
      ,category: adBrix.createCommerceProductCategoryData(category: "하의 기획전")
      ,productAttrsMap: adBrix.createCommerceProductAttrData(dictionary: extraDict2)
  )
  
  // product list Array
  var arr : Array<AdBrixRmCommerceProductModel> = Array()
  arr.append(productModel1)
  arr.append(productModel2)
  
  //Refund API
  adBrix.commerceRefund(orderId: "290192012", productInfo: arr, penaltyCharge: 0.00)
  
}

 

 

Product search

You can analyze event which user search certain product using adbrix SDK API.

Product search API require information that API already pre-defined.

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

  // Create AdBrixRM Instance
  let adBrix = AdBrixRM.getInstance
 
  // create product model
  let productModel1 = adBrix.createCommerceProductData(
      productId: "5385487400"
      ,productName: "Baseball player cloth"
      ,price: 10000.00
      ,quantity: 1
      ,discount: 0.00
      ,currencyString: adBrix.getCurrencyString(AdBrixRM.AdBrixCurrencyType.KRW)
      ,category: adBrix.createCommerceProductCategoryData(category: "cloth")
      ,productAttrsMap: nil
  )
          
  // create product model
  let productModel2 = adBrix.createCommerceProductData(
      productId: "837246401"
      ,productName: "Football player shoes"
      ,price: 14000.00
      ,quantity: 1
      ,discount: 0.00
      ,currencyString: adBrix.getCurrencyString(AdBrixRM.AdBrixCurrencyType.KRW)
      ,category: adBrix.createCommerceProductCategoryData(category: "shoes")
      ,productAttrsMap: nil
  )
  
  // create product model
  let productModel3 = adBrix.createCommerceProductData(
      productId: "3567289101"
      ,productName: "Basketball player pants"
      ,price: 8800.00
      ,quantity: 1
      ,discount: 0.0
      ,currencyString: adBrix.getCurrencyString(AdBrixRM.AdBrixCurrencyType.KRW)
      ,category: adBrix.createCommerceProductCategoryData(category: "pants")
      ,productAttrsMap: nil
  )
  
  // product list Array
  var arr : Array<AdBrixRmCommerceProductModel> = Array()
  arr.append(productModel1)
  arr.append(productModel2)
  arr.append(productModel3)

  // product search api
  adBrix.commerceSearch(productInfo: arr, keyword: "sport player wear")
  
}

 

 

Product Share

You can analyze event which user share certain product using adbrix SDK API.

Product share API require 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 shareEvent(_ sender: Any) {

    // Create AdBrixRM Instance
    let adBrix = AdBrixRM.getInstance
   
    // create product model
    let productModel1 = adBrix.createCommerceProductData(
        productId: "5385487400"
        ,productName: "Baseball player cloth"
        ,price: 10000.00
        ,quantity: 1
        ,discount: 0.00
        ,currencyString: adBrix.getCurrencyString(AdBrixRM.AdBrixCurrencyType.KRW)
        ,category: adBrix.createCommerceProductCategoryData(category: "cloth")
        ,productAttrsMap: nil
    )       
      
    // Product share API
    adBrix.commerceShare(channel: AdBrixRM.AdBrixSharingChannel.AdBrixSharingKakaoTalk, productInfo: productModel)
    
  }

 

List view

You can analyze event which user viewing product list using adbrix SDK API.

List view API require 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)
func listViewEvent() {

    // Create AdBrixRM Instance
    let adBrix = AdBrixRM.getInstance
   
    // create product model
    let productModel1 = adBrix.createCommerceProductData(
      productId: "5385487400"
      ,productName: "Baseball player cloth"
      ,price: 10000.00
      ,quantity: 1
      ,discount: 0.00
      ,currencyString: adBrix.getCurrencyString(AdBrixRM.AdBrixCurrencyType.KRW)
      ,category: adBrix.createCommerceProductCategoryData(category: "cloth")
      ,productAttrsMap: nil
  )
          
  // create product model
  let productModel2 = adBrix.createCommerceProductData(
      productId: "837246401"
      ,productName: "Football player shoes"
      ,price: 14000.00
      ,quantity: 1
      ,discount: 0.00
      ,currencyString: adBrix.getCurrencyString(AdBrixRM.AdBrixCurrencyType.KRW)
      ,category: adBrix.createCommerceProductCategoryData(category: "shoes")
      ,productAttrsMap: nil
  )
  
  // create product model
  let productModel3 = adBrix.createCommerceProductData(
      productId: "3567289101"
      ,productName: "Basketball player pants"
      ,price: 8800.00
      ,quantity: 1
      ,discount: 0.0
      ,currencyString: adBrix.getCurrencyString(AdBrixRM.AdBrixCurrencyType.KRW)
      ,category: adBrix.createCommerceProductCategoryData(category: "pants")
      ,productAttrsMap: nil
  )
  
  // product list array
  var arr : Array = Array()
  arr.append(productModel1)
  arr.append(productModel2)
  arr.append(productModel3)
      
    // list view API
    adBrix.commerceListView(productInfo:arr)
    
  }

 

Cart view

You can analyze event which user viewing cart using adbrix SDK API.

Cart view API require 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) 
func cartViewEvent() {

    // Create AdBrixRM Instance
    let adBrix = AdBrixRM.getInstance
   
    // create product model
    let productModel1 = adBrix.createCommerceProductData(
      productId: "5385487400"
      ,productName: "Baseball player cloth"
      ,price: 10000.00
      ,quantity: 1
      ,discount: 0.00
      ,currencyString: adBrix.getCurrencyString(AdBrixRM.AdBrixCurrencyType.KRW)
      ,category: adBrix.createCommerceProductCategoryData(category: "cloth")
      ,productAttrsMap: nil
  )
          
  // create product model
  let productModel2 = adBrix.createCommerceProductData(
      productId: "837246401"
      ,productName: "Football player shoes"
      ,price: 14000.00
      ,quantity: 1
      ,discount: 0.00
      ,currencyString: adBrix.getCurrencyString(AdBrixRM.AdBrixCurrencyType.KRW)
      ,category: adBrix.createCommerceProductCategoryData(category: "shoes")
      ,productAttrsMap: nil
  )
  
  // create product model
  let productModel3 = adBrix.createCommerceProductData(
      productId: "3567289101"
      ,productName: "Basketball player pants"
      ,price: 8800.00
      ,quantity: 1
      ,discount: 0.0
      ,currencyString: adBrix.getCurrencyString(AdBrixRM.AdBrixCurrencyType.KRW)
      ,category: adBrix.createCommerceProductCategoryData(category: "pants")
      ,productAttrsMap: nil
  )
  
  // product list array
  var arr : Array = Array()
  arr.append(productModel1)
  arr.append(productModel2)
  arr.append(productModel3)
      
    // cart view api
    adBrix.commerceCartView(productInfo:arr)
    
  }

 

Payment information

You can analyze event which user reviewing payment information using adbrix SDK API.

@IBAction func paymentInfoAddedEvent(_ sender: Any) {

    // Create AdBrixRM instance
    let adBrix = AdBrixRM.getInstance
   
    // payment view api
    adBrix.commercePaymentInfoAdded(paymentInfoAttr: [
            "creditcard" : "kbcard"])
    
}

 

 

Game analysis

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

AdBrix SDK provides 4 pre-defined game API

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

 

Tutorial complete

You can analyze event which user complete game tutorial using adbrix SDK API.

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

  • isSkip : (required) set which user complete tutorial or skip the tutorial
func tutorialCompleteEvent(){
         // Create AdBrixRM instance
         let adBrix = AdBrixRM.getInstance

        //Tutorial complete API
        adBrix.gameTutorialCompleted(isSkip: true)
}

 

Create Character

You can analyze event which user create a game character using adbrix SDK API.

func characterCreatedEvent(){
        // Create AdBrixRM instance
         let adBrix = AdBrixRM.getInstance

        //Create character API
        adBrix.gameCharacterCreated()
}

 

Stage complete

You can analyze event which user complete game certain stage using adbrix SDK API.

Stage complete API require information that API already pre-defined.

  • StageName : (required) Name of complete stage
func stageClearedEvent(){
        // Create AdBrixRM instance
        let adBrix = AdBrixRM.getInstance

        //Stage complete API
        adBrix.gameStageCleared(stageName: "1-1")
}

Level up

You can analyze event which user level up in game using adbrix SDK API.

Level up API require information that API already pre-defined.

  • Level : (required) 
func levelAchievedEvent(){
        // Create AdBrixRM instance
        let adBrix = AdBrixRM.getInstance

        //level up API
        adBrix.gameLevelAchieved(level: 15)
}

Related articles

Comments

0 comments

Please sign in to leave a comment.

INDEX