Articles in this section

Adbrix Integration [iOS Objective-C]

Avatar
AdBrix Support Engineering
  • Updated
Follow

SDK Installation

 

Start from Existing Project

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 commend.

$ 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 'AdBrixRemaster'
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 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 require to enable the Swift library. 

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

 

 

Start from Sample Project

AdBrix can provide Xcode project that already installs the Adbrix SDK.

You can download the project base on your project language.

[AdBrix Swift Sample Project link]

[AdBrix Objective-C Sample Project link]

 

 

 

Initialize SDK

 

To use Adbrix SDK, it requires these setup on xcode project.

  1. Apple IDFA setup
  2. Log level setup
  3. Event upload cycle setup
  4. Setup the Adbrix AppKey
  5. Deeplink setup

* Adbrix SDK Initialization works at AppDelegate.m only.

 

 

Apple IDFA Setup

To use AdBrix Attribution SDK require Apple IDFA.

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

#import "AppDelegate.h"
#import <AdSupport/AdSupport.h>
#import <AdBrixRM/AdBrixRM.h>

@interface AppDelegate ()
@end

@implementation AppDelegate

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
    // Override point for customization after application launch.

    // Create AdBrixRM Instance
    AdBrixRM *adBrix = [AdBrixRM sharedInstance];

    if ((NSClassFromString(@"ASIdentifierManager")) != nil) {
        NSUUID *ifa =[[ASIdentifierManager sharedManager]advertisingIdentifier];

        [adBrix setAppleAdvertisingIdentifier:[ifa UUIDString]];
    }

    return YES;
}

 

 

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/AdBrixRM.h>

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
    // Override point for customization after application launch.

    // AdBrixRM Instance
    AdBrixRM *adBrix = [AdBrixRM sharedInstance];

    // AdBrix Log Level setup
    [adBrix setLogLevel:AdBrixLogLevelERROR];

    return YES;
}

 

 

Event upload cycle setup

The developer can set Event upload cycle. 

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 has 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/AdBrixRM.h>

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
    // Override point for customization after application launch.

    // Create AdBrixRM Instance
    AdBrixRM *adBrix = [AdBrixRM sharedInstance];

    // Event Upload counter API
    [adBrix setEventUploadCountInterval:AdBrixEventUploadCountIntervalMIN];

    return YES;
}

 

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/AdBrixRM.h>

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
    // Override point for customization after application launch.

    // Create AdBrixRM instance 
    AdBrixRM *adBrix = [AdBrixRM sharedInstance];

    // Event upload timer API
    [adBrix setEventUploadTimeInterval:AdBrixEventUploadTimeIntervalMAX];

    return YES;
}

 

 

 

AppKey & SecretKey setup

Set the Adbrix AppKey and SecretKey issued from Adbrix Homepage

 

#import <AdBrixRM/AdBrixRM.h>

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
    // Override point for customization after application launch.

    // Create AdBrixRM Instance
    AdBrixRM *adBrix = [AdBrixRM sharedInstance];

    // AdBrix AppKey / SecretKey setup
    [adBrix initAdBrixWithAppKey:@"odhvASVRDsdf10d019fva" secretKey:@"ar98LszQZUGdmSznToNBXg"];

    return YES;
}

* AppKey is different from AdBrix Classic and AdBrix Remaster.

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

 

 

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.m  application: openURL: delegate.

#if __IPHONE_OS_VERSION_MAX_ALLOWED < __IPHONE_9_0
- (BOOL)application:(UIApplication *)application openURL:(NSURL *)url sourceApplication:(NSString *)sourceApplication annotation:(id)annotation
{
    // Create AdBrixRM Instance
    AdBrixRM *adBrix = [AdBrixRM sharedInstance];

    // Deeplink open API
    [adBrix deepLinkOpenWithUrl:url];


    return YES;
}
#else

- (BOOL)application:(UIApplication *)app openURL:(NSURL *)url options:(NSDictionary *)options
{
    // Creating AdBrixRM Instance
    AdBrixRM *adBrix = [AdBrixRM sharedInstance];

    // Deeplink open API
    [adBrix deepLinkOpenWithUrl:url];

    return YES;

}
#endif

 

 

 

 

SDK Initialization Example

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

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {

    AdBrixRM *adBrix = [AdBrixRM sharedInstance];

    //1) Apple IDFA
    if (NSClassFromString(@"ASIdentifierManager")){
        NSUUID *ifa =[[ASIdentifierManager sharedManager]advertisingIdentifier];
        BOOL isAppleAdvertisingTrackingEnalbed = [[ASIdentifierManager sharedManager]isAdvertisingTrackingEnabled];
        [adBrix setAppleAdvertisingIdentifier:[ifa UUIDString] :isAppleAdvertisingTrackingEnalbed];
    }

    //2) SDK Log leven
    [adBrix setLogLevel:AdBrixLogLevelTRACE];

    //3) Event upload frequency : counter / timer
    [adBrix setEventUploadCountInterval:AdBrixEventUploadCountIntervalMIN];
    [adBrix setEventUploadTimeInterval:AdBrixEventUploadTimeIntervalMAX];

    //4) AppKey and SecretKey
    [adBrix initAdBrixWithAppKey:@"odhvASVRDsdf10d019fva" secretKey:@"ar98LszQZUGdmSznToNBXg"];

    return YES;
}

#if __IPHONE_OS_VERSION_MAX_ALLOWED < __IPHONE_9_0
- (BOOL)application:(UIApplication *)application openURL:(NSURL *)url sourceApplication:(NSString *)sourceApplication annotation:(id)annotation
{
    // Creating AdBrixRM Instance
    AdBrixRM *adBrix = [AdBrixRM sharedInstance];

    // Deeplink Open API
    [adBrix deepLinkOpenWithUrl:url];


    return YES;
}
#else

- (BOOL)application:(UIApplication *)app openURL:(NSURL *)url options:(NSDictionary *)options
{
    // Creating AdbrixRM Instance
    AdBrixRM *adBrix = [AdBrixRM sharedInstance];

    // Deeplink Open API
    [adBrix deepLinkOpenWithUrl:url];

    return YES;

}
#endif

 

GDPR Setup

The developer can stop the Adbrix SDK working using GDPR API.

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

This cannot be re-inversed unless user delete app.

- (IBAction)click_gdprForgetMe:(id)sender {
    // Creating AdBrixRM instance
    AdBrixRM *adBrix = [AdBrixRM sharedInstance];
    [adBrix gdprForgetMe];
}

 

 

 

 

App Event Analysis

Using Adbrix SDK, you can analyze In-app event and create In-app event report at Adbrix dashboard. 

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

Adbrix SDK provides 5 different type of In-app event API

  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. 

- (void)loginAndLogoutEvent {

    // Create AdBrix Instance
    AdBrixRM *adBrix = [AdBrixRM sharedInstance];

    if(isSuccessLogin) {
        // Login success with userid user_1234
        [adBrix loginWithUserId:@"user_1234"];
    } else {
        // Logout success and reset UserID with @"" empty string
        [adBrix loginWithUserId:@""];
    }

}

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

- (void)userPropertyUpdate {

    // Create AdBrix instance
    AdBrixRM *adBrix = [AdBrixRM sharedInstance];

    // Age
    NSInteger age = 30;
    [adBrix setAgeWithInt:age];

    //  Gender
    [adBrix setGenderWithAdBrixGenderType:AdBrixGenderTypeFemale];

    // other information
    NSDictionary *dict = [NSDictionary dictionaryWithObjectsAndKeys:_UITextField_propKey.text,_UITextField_propValue.text, nil];
    [adBrix setUserPropertiesWithDictionary:dict];
}

* Adbrix do not take responsibility to use user information.

* NSDictionary restriction

  • Adbrix SDK cannot send more than 100 information.
  • The data type is only use string and cannot have more than 256 letter.
  • The data type cannot use Capital letter, special character.
  • The value cannot have more than 1024byte

 

 

Location information

If you can receive user location you can sen user location by Adbrix SDK.

- (void)locationUpdate {

    // Create AdBrix Instance
    AdBrixRM *adBrix = [AdBrixRM sharedInstance];
    double lat = 37.541;
    double lon = 126.986;

    // Adbrix location API
    [adBrix setLocationWithLatitude:lat longitude:lon];
}

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

 

- (void)userCustomEvent {

    // Create AdBrix Instance
    AdBrixRM *adBrix = [AdBrixRM sharedInstance];

    // Add Custom named Event "invite_button_click"
    [adBrix eventWithEventName:@"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.

- (void) registerEvent {
    // Creating AdBrix Instance
    AdBrixRM *adbrix = [AdBrixRM sharedInstance];

    // User information
    NSDictionary *userData =[NSDictionary dictionaryWithObjectsAndKeys:
        @"userid",@"my_user_id", nil];

    // Signup API 
    [adbrix commonSignUpWithChannel:AdBrixSignUpChannelAdBrixSignUpNaverChannel commonAttr:userData];
}

  

App Update

You can analyze app update event using Adbrix SDK API.

- (void) appUdate {
    // Creating AdBrix instance
    AdBrixRM *adbrix = [AdBrixRM sharedInstance];

    // User information
    NSDictionary *userData =[NSDictionary dictionaryWithObjectsAndKeys:
        @"userid",@"my_user_id", nil];

    // App update API
    [adbrix commonAppUpdateWithPrev_ver:@"1.0.1a" curr_ver:@"1.2.2a" commonAttr:userData];
}

 

User invitation

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

- (void) userInvite {
    // Create AdBrix Instance
    AdBrixRM *adbrix = [AdBrixRM sharedInstance];

    // User Information
    NSDictionary *userData =[NSDictionary dictionaryWithObjectsAndKeys:
        @"userid",@"my_user_id", nil];

    // User invitation API
    [adbrix commonInviteWithChannel:AdBrixInviteChannelAdBrixInviteGoogleChannel commonAttr:userData];
}

 

Use in-app credit

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

- (void) useCredit {
    // Create AdBrix Instance
    AdBrixRM *adbrix = [AdBrixRM sharedInstance];
    // User Information
    NSDictionary *creditData =[NSDictionary dictionaryWithObjectsAndKeys:
            @"credit",10000, nil];
    // Use in-appp credit API 
    [adbrix commonUseCreditWithCommonAttr: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)
- (void)purchaseEvent {

    // Create AdBrix Instance
    AdBrixRM *adBrix = [AdBrixRM sharedInstance];


    AdBrixRmCommerceProductModel *productModel1 =
    [adBrix createCommerceProductDataWithProductId:@"983147450"
        productName:@"Baseball player cloth"
        price:10000.00
        quantity:1
        discount:5000.0
        currencyString:[adBrix getCurrencyString:AdBrixCurrencyTypeKRW]
        category:[adBrix createCommerceProductCategoryDataWithCategory:@"cloth"]
        productAttrsMap:[adBrix createCommerceProductAttrDataWithDictionary:
        [NSDictionary dictionaryWithObjectsAndKeys:
            @"1-3", @"model",
            @"grey", @"color",
            @"M", @"size"
            ,nil
            ]
        ]
    ];

    AdBrixRmCommerceProductModel *productModel2 =
    [adBrix createCommerceProductDataWithProductId:@"145099811"
        productName:@"Fooball player shoes"
        price:15500.00
        quantity:1
        discount:1200.0
        currencyString:[adBrix getCurrencyString:AdBrixCurrencyTypeKRW]
        category:[adBrix createCommerceProductCategoryDataWithCategory:@"shoes"]
        productAttrsMap:[adBrix createCommerceProductAttrDataWithDictionary:
            [NSDictionary dictionaryWithObjectsAndKeys:
                @"2", @"design",
                @"white", @"color",
                @"95", @"size"
                ,nil
            ]
        ]
    ];

    // Product list array
    NSMutableArray *productArray = [NSMutableArray array];
    [productArray addObject:productModel1];
    [productArray addObject:productModel2];

    //In-app purchase API
    [adBrix commonPurchaseWithOrderId:@"201804010934994811"
        productInfo:productArray
        discount:0.00
        deliveryCharge:3500.00
        paymentMethod:[_adBrix getPaymentMethod:AdbrixPaymentMethodMobilePayment]
    ];

}

 

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 viewing the main screen on your app, using Adbrix SDK API.

- (void)viewHomeEvent {

    // Create Adbrix Instance
    AdBrixRM *adBrix = [AdBrixRM sharedInstance];

    // Home view API
    [adBrix commerceViewHome];
}

 

 

Category view

You can analyze event which user entering certain product category using Adbrix SDK API.

You can add maximum 5 categories on API

- (void)viewCategoryEvent {
    // Create AdBrixRM Instance
    AdBrixRM *adBrix = [AdBrixRM sharedInstance];

    //Open [shoes] category
    [adBrix commerceCategoryViewWithCategory:[adBrix createCommerceProductCategoryDataWithCategory:@"shoes"]];

    //open [shoes1-1, 1-2] category
    //[adBrix commerceCategoryViewWithCategory:[adBrix createCommerceProductCategoryDataWithCategory:@"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) 
- (void)viewProductDetailEvent {

  // Create AdBrixRM Instance
  AdBrixRM *adBrix = [AdBrixRM sharedInstance];

  //product option Dictionary
  NSDictionary *extraDict = [NSDictionary dictionaryWithObjectsAndKeys:
                                 @"9", @"no",
                                 @"black", @"color",
                                 @"XXL", @"size"
                                  , nil];

    //product view api
    [adBrix commerceProductViewWithProductInfo:
        [adBrix createCommerceProductDataWithProductId:@"5385487400"
            productName:@"Baseball player cloth"
            price:10000.00
            quantity:1
            discount:1000.00
            currencyString:[adBrix getCurrencyString:AdBrixCurrencyTypeKRW]
            category:[adBrix createCommerceProductCategoryDataWithCategory:@"cloth"]
            productAttrsMap:[adBrix createCommerceProductAttrDataWithDictionary:extraDict]
        ]
    ];
}

 

 

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)
- (void)addToCartEvent {

    // Create AdBrixRM Instance
    AdBrixRM *adBrix = [AdBrixRM sharedInstance];

    // product option Dictionary 
    NSDictionary *extraDict_1 = [NSDictionary dictionaryWithObjectsAndKeys:
                                @"9", @"design_no",
                                @"black", @"color",
                                @"30", @"size"
                                , nil];

    // create product model
    AdBrixRmCommerceProductModel *productModel_1 =
    [adBrix createCommerceProductDataWithProductId:@"5385487400"
        productName:@"Baseball player cloth"
        price:10000.00
        quantity:1
        discount:1000.00
        currencyString:[adBrix getCurrencyString:AdBrixCurrencyTypeKRW]
        category:[adBrix createCommerceProductCategoryDataWithCategory:@"cloth"]
        productAttrsMap:[adBrix createCommerceProductAttrDataWithDictionary:extraDict_1]
    ];

    // product option Dictionary
    NSDictionary *extraDict_2 = [NSDictionary dictionaryWithObjectsAndKeys:
                                @"3", @"design_no",
                                @"grey", @"color",
                                @"30", @"size"
                                , nil];
    // creating product model
    AdBrixRmCommerceProductModel *productModel_2 =
    [adBrix createCommerceProductDataWithProductId:@"5385487400"
        productName:@"football player shoes"
        price:10000.00
        quantity:1
        discount:1000.00
        currencyString:[adBrix getCurrencyString:AdBrixCurrencyTypeKRW]
        category:[adBrix createCommerceProductCategoryDataWithCategory:@"shoes"]
        productAttrsMap:[adBrix createCommerceProductAttrDataWithDictionary:extraDict_2]
    ];

    // Product list array
    NSMutableArray *productArray = [NSMutableArray array];
    [productArray addObject:productModel_1];
    [productArray addObject:productModel_2];

    // add to cart api
    [adBrix commerceAddToCartWithProductInfo:productArray];

}

 

 

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)
- (void)addToWishListEvent {

  // Create AdBrixRM Instance
  AdBrixRM *adBrix = [AdBrixRM sharedInstance];

  // product option Dictionary 
  NSDictionary *extraDict = [NSDictionary dictionaryWithObjectsAndKeys:
                             @"9", @"design_no",
                             @"black", @"color",
                             @"30", @"size"
                             , nil];

  // Create product model
  AdBrixRmCommerceProductModel *productModel =
    [adBrix createCommerceProductDataWithProductId:@"5385487400"
      productName:@"baseball player cloth"
      price:10000.00
      quantity:1
      discount:1000.00
      currencyString:[adBrix getCurrencyString:AdBrixCurrencyTypeKRW]
      category:[adBrix createCommerceProductCategoryDataWithCategory:@"cloth"]
      productAttrsMap:[adBrix createCommerceProductAttrDataWithDictionary:extraDict]
    ];

  // Add to wishlist api
  [adBrix commerceAddToWishListWithProductInfo: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)
- (void)reviewOrderEvent {

  // Create AdBrixRM Instance
  AdBrixRM *adBrix = [AdBrixRM sharedInstance];

  // product option Dictionary
  NSDictionary *extraDict_1 = [NSDictionary dictionaryWithObjectsAndKeys:
                             @"9", @"design_no",
                             @"black", @"color",
                             @"30", @"size"
                             , nil];

  // create product model
  AdBrixRmCommerceProductModel *productModel_1 =
    [adBrix createCommerceProductDataWithProductId:@"5385487400"
      productName:@"Baseball player cloth"
      price:10000.00
      quantity:1
      discount:1000.00
      currencyString:[adBrix getCurrencyString:AdBrixCurrencyTypeKRW]
      category:[adBrix createCommerceProductCategoryDataWithCategory:@"cloth"]
      productAttrsMap:[adBrix createCommerceProductAttrDataWithDictionary:extraDict_1]
    ];

  // product option Dictionary
  NSDictionary *extraDict_2 = [NSDictionary dictionaryWithObjectsAndKeys:
                             @"3", @"design_no",
                             @"grey", @"color",
                             @"30", @"size"
                             , nil];
  // create product model
  AdBrixRmCommerceProductModel *productModel_2 =
    [adBrix createCommerceProductDataWithProductId:@"5385487400"
      productName:@"football player shoes"
      price:10000.00
      quantity:1
      discount:1000.00
      currencyString:[adBrix getCurrencyString:AdBrixCurrencyTypeKRW]
      category:[adBrix createCommerceProductCategoryDataWithCategory:@"shoes"]
      productAttrsMap:[adBrix createCommerceProductAttrDataWithDictionary:extraDict_2]
    ];

  // Product list Array
  NSMutableArray *productArray = [NSMutableArray array];
  [productArray addObject:productModel_1];
  [productArray addObject:productModel_2];

  // Review order api
  [adBrix commerceReviewOrderWithOrderId:@"30290121" productInfo:productArray 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)
- (void)refundOrderEvent {

  // Create AdBrixRM Instance
  AdBrixRM *adBrix = [AdBrixRM sharedInstance];

  // product option Dictionary
  NSDictionary *extraDict_1 = [NSDictionary dictionaryWithObjectsAndKeys:
                             @"9", @"design_no",
                             @"black", @"color",
                             @"30", @"size"
                             , nil];

  // create product model
  AdBrixRmCommerceProductModel *productModel_1 =
    [adBrix createCommerceProductDataWithProductId:@"5385487400"
      productName:@"Baseball player cloth"
      price:10000.00
      quantity:1
      discount:1000.00
      currencyString:[adBrix getCurrencyString:AdBrixCurrencyTypeKRW]
      category:[adBrix createCommerceProductCategoryDataWithCategory:@"cloth"]
      productAttrsMap:[adBrix createCommerceProductAttrDataWithDictionary:extraDict]
    ];

  // product option Dictionary
  NSDictionary *extraDict_2 = [NSDictionary dictionaryWithObjectsAndKeys:
                             @"3", @"design_no",
                             @"grey", @"color",
                             @"30", @"size"
                             , nil];
  // create product model AdBrixRmCommerceProductModel *productModel_2 = [adBrix createCommerceProductDataWithProductId:@"5385487400" productName:@"Football player shoes" price:10000.00 quantity:1 discount:1000.00 currencyString:[adBrix getCurrencyString:AdBrixCurrencyTypeKRW] category:[adBrix createCommerceProductCategoryDataWithCategory:@"shoes"] productAttrsMap:[adBrix createCommerceProductAttrDataWithDictionary:extraDict] ]; // product list Array NSMutableArray *productArray = [NSMutableArray array]; [productArray addObject:productModel_1]; [productArray addObject:productModel_2]; // Refund API [adBrix commerceRefundWithOrderId:@"290192012" productInfo:productArray 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) 
- (void)searchResultEvent {

    // Create AdBrixRM Instance
    AdBrixRM *adBrix = [AdBrixRM sharedInstance];

    // create product model
    AdBrixRmCommerceProductModel *productModel_1 =
    [adBrix createCommerceProductDataWithProductId:@"5385487400"
      productName:@"Baseball player cloth"
      price:10000.00
      quantity:1
      discount:1000.00
      currencyString:[adBrix getCurrencyString:AdBrixCurrencyTypeKRW]
      category:[adBrix createCommerceProductCategoryDataWithCategory:@"cloth"]
      productAttrsMap:nil
    ];

    // creating product model
    AdBrixRmCommerceProductModel *productModel_2 =
    [adBrix createCommerceProductDataWithProductId:@"837246401"
      productName:@"Football player shoes"
      price:14000.00
      quantity:1
      discount:0.00
      currencyString:[adBrix getCurrencyString:AdBrixCurrencyTypeKRW]
      category:[adBrix createCommerceProductCategoryDataWithCategory:@"shoes"]
      productAttrsMap:nil
    ];

    // creating product model
    AdBrixRmCommerceProductModel *productModel_3 =
    [adBrix createCommerceProductDataWithProductId:@"3567289101"
      productName:@"Basketball player pants"
      price:8800.00
      quantity:1
      discount:0.00
      currencyString:[adBrix getCurrencyString:AdBrixCurrencyTypeKRW]
      category:[adBrix createCommerceProductCategoryDataWithCategory:@"pants"]
      productAttrsMap:nil
    ];

    // product list Array
    NSMutableArray *productArray = [NSMutableArray array];
    [productArray addObject:productModel_1];
    [productArray addObject:productModel_2];
    [productArray addObject:productModel_3];

    // product search api
    [adBrix commerceSearchWithProductInfo:productArray 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) 
- (void)shareEvent() {

    // Create AdBrixRM Instance
    AdBrixRM *adBrix = [AdBrixRM sharedInstance];

    // create product model
    AdBrixRmCommerceProductModel *productModel1 =
    [adBrix createCommerceProductDataWithProductId:@"5385487400"
                                       productName:@"Baseball player cloth"
                                             price:10000.00
                                          quantity:1
                                          discount:1000.00
                                    currencyString:[adBrix getCurrencyString:AdBrixCurrencyTypeKRW]
                                          category:[adBrix createCommerceProductCategoryDataWithCategory:@"cloth"]
                                     productAttrsMap:nil
     ];

    // Product share API
    [adBrix commerceShareWithChannel:AdBrixSharingChannelAdBrixSharingKakaoTalk productInfo:productModel1];

}

 

 

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)
- (void)listViewEvent() {

    // Create AdBrixRM Instance
    AdBrixRM *adBrix = [AdBrixRM sharedInstance];

    // create product model
    AdBrixRmCommerceProductModel *productModel_1 =
    [adBrix createCommerceProductDataWithProductId:@"5385487400"
      productName:@"Baseball player cloth"
      price:10000.00
      quantity:1
      discount:1000.00
      currencyString:[adBrix getCurrencyString:AdBrixCurrencyTypeKRW]
      category:[adBrix createCommerceProductCategoryDataWithCategory:@"cloth"]
      productAttrsMap:nil
    ];

    // create product model
    AdBrixRmCommerceProductModel *productModel_2 =
    [adBrix createCommerceProductDataWithProductId:@"837246401"
      productName:@"Football player shoes"
      price:14000.00
      quantity:1
      discount:0.00
      currencyString:[adBrix getCurrencyString:AdBrixCurrencyTypeKRW]
      category:[adBrix createCommerceProductCategoryDataWithCategory:@"shoes"]
      productAttrsMap:nil
    ];

    // create product model
    AdBrixRmCommerceProductModel *productModel_3 =
    [adBrix createCommerceProductDataWithProductId:@"3567289101"
      productName:@"Basketball player pants"
      price:8800.00
      quantity:1
      discount:0.00
      currencyString:[adBrix getCurrencyString:AdBrixCurrencyTypeKRW]
      category:[adBrix createCommerceProductCategoryDataWithCategory:@"pants"]
      productAttrsMap:nil
    ];

    // product list array
    NSMutableArray *productArray = [NSMutableArray array];
    [productArray addObject:productModel_1];
    [productArray addObject:productModel_2];
    [productArray addObject:productModel_3];

    // list view API
    [adBrix commerceListViewWithProductInfo:productArray];

}

 

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) 
- (void)cartViewEvent() {

    // Create AdBrixRM instance
    AdBrixRM *adBrix = [AdBrixRM sharedInstance];

    // create product model
    AdBrixRmCommerceProductModel *productModel_1 =
    [adBrix createCommerceProductDataWithProductId:@"5385487400"
      productName:@"Baseball player cloth"
      price:10000.00
      quantity:1
      discount:1000.00
      currencyString:[adBrix getCurrencyString:AdBrixCurrencyTypeKRW]
      category:[adBrix createCommerceProductCategoryDataWithCategory:@"cloth"]
      productAttrsMap:nil
    ];

    // create product model
    AdBrixRmCommerceProductModel *productModel_2 =
    [adBrix createCommerceProductDataWithProductId:@"837246401"
      productName:@"Football player shoes"
      price:14000.00
      quantity:1
      discount:0.00
      currencyString:[adBrix getCurrencyString:AdBrixCurrencyTypeKRW]
      category:[adBrix createCommerceProductCategoryDataWithCategory:@"shoes"]
      productAttrsMap:nil
    ];

    // create product model
    AdBrixRmCommerceProductModel *productModel_3 =
    [adBrix createCommerceProductDataWithProductId:@"3567289101"
      productName:@"Basketball player pants"
      price:8800.00
      quantity:1
      discount:0.00
      currencyString:[adBrix getCurrencyString:AdBrixCurrencyTypeKRW]
      category:[adBrix createCommerceProductCategoryDataWithCategory:@"pants"]
      productAttrsMap:nil
    ];

   // product list Array
    NSMutableArray *productArray = [NSMutableArray array];
    [productArray addObject:productModel_1];
    [productArray addObject:productModel_2];
    [productArray addObject:productModel_3];

    // cart view api
    [adBrix commerceCartViewWithProductInfo:productArray];

}

 

Payment information

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

- (void)paymentInfoAddedEvent() {

    // Create AdBrixRM instance
    AdBrixRM *adBrix = [AdBrixRM sharedInstance];

    // payment Dictionary 
    NSDictionary *extraDict = [NSDictionary dictionaryWithObjectsAndKeys:
                             @"kbcard", @"creditcard"
                             , nil];

    // payment view api
    [adBrix commercePaymentInfoAddedWithPaymentInfoAttr:extraDict];

}

 

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 
-(void) tutorialCompleteEvent {
         // create AdBrixRM instance
         AdBrixRM *adBrix = [AdBrixRM sharedInstance];

        //Tutorial complete API
        [adBrix gameTutorialCompletedWithIsSkip:false];
}

 

Create Character

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

-(void) characterCreatedEvent {
        // creating AdBrixRM instance
        AdBrixRM *adBrix = [AdBrixRM sharedInstance];

        //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
-(void) stageClearedEvent {
        // Create AdBrixRM instance AdBrixRM *adBrix = [AdBrixRM sharedInstance]; //Stage complete API [adBrix gameStageClearedWithStageName:@"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) 
-(void) levelAchievedEvent {
        // Create AdBrixRM instance AdBrixRM *adBrix = [AdBrixRM sharedInstance]; //level up API [adBrix gameLevelAchievedWithLevel:15]; }

Related articles

Comments

0 comments

Please sign in to leave a comment.

INDEX