Articles in this section

Adbrix Integration [Android Java]

Avatar
AdBrix Support Engineering
  • Updated
Follow

SDK Installation

 

Setting Gradle

adbrix supports SDK downloads and installation via Gradle.

Add the following to [project_name > build.gradle] file: 

allprojects {
    repositories {
        google()
        jcenter()

        flatDir {
            dirs 'libs'
        }
        maven {
            url 'https://dl.bintray.com/igaworks/AdbrixSDKQA'
        }

    }
}

 

Add the following dependency to [app > build.gradle > dependencies] file:

dependencies {    
    implementation 'com.google.android.gms:play-services-base:12.0.0'
    implementation 'com.android.installreferrer:installreferrer:1.0'
    implementation 'com.igaworks.dev.remaster:abx-common-rm:1.0.0.5'
}

* To use Google Play Install Referrer API in order to prevent fraud traffics by click injection, you MUST add the following: com.android.installreferrer:installreferrer

* To acquire Google Advertising ID, you MUST add the following: com.google.android.gms:play-service-base  

 

 

 

Setting SDK

 

Setting Log Levels

adbrix SDK does not output logs by default. However, you can check the logs by setting Debug mode. 

Set the following at [AndroidManifest.xml > manifest > application]: 

<application>
 ...
 <meta-data android:name="AdBrixRmDebugMode" android:value="enable" />  
 ...
</application>

 

 

Setting Required Permissions

adbrix SDK requires the following permissions: 

Set the following at [AndroidManifest.xml > manifest]:

<manifest>
...
    <uses-permission android:name="android.permission.INTERNET" />
    <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
    <!-- OPTIONAL -->
    <uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION" />
    ...
</manifest>

 

 

Setting Install Broadcast Receiver

To use attribution features of adbrix, Broadcast Receiver is required for INSTALL_REFERRER.

Set the following to [AndroidManifest.xml > manifest > application] 

<application>
...
    <receiver android:name="com.igaworks.v2.core.application.AbxReceiver"
        android:exported="true">
        <intent-filter>
            <action android:name="com.android.vending.INSTALL_REFERRER" />
        </intent-filter>
    </receiver>
...
</application>

* If there is another Broadcast Receiver for INSTALL_REFERRER, please refer to the article 'Setting Multiple Broadcast Receiver' for setting. 

 

 

Setting AppKey and SecretKey

Set the Adbrix AppKey and SecretKey issued from Adbrix console.

Set the following at [AndroidManifest.xml > manifest > application]:

<

<application>
...
    <meta-data android:name="AdBrixRmAppKey" android:value="your_adbrix_remaster_app_key" />
    <meta-data android:name="AdBrixRmSecretKey" android:value="your_adbrix_remaster_secret_key" />
...
</application>

 

 

SDK Initialization

Initialization of the SDK to use adbrix SDK can be completed in two ways. 

  1. Use adbrix SDK application class
  2. Use developer's custom application class

Initialize SDK according to the development environment. 

 

Using adbrix SDK Application Class

If there is no application on your own development, you can initialize the SDK quickly and easily using the application class provided by adbrix SDK. 

Set the following at [AndroidManifest.xml > application]:

<application
    android:name="com.igaworks.v2.core.application.AbxApplication"
    ...
    >

</application>

 

Using Developer's custom Application Class

If there is an application class on your own development, set onCreate() as the following for the class: 

<application
       android:name=".MyApplicationClass"
        ...
    >

</application>

public class MyApplicationClass extends Application {

    @Override
    public void onCreate() {
        super.onCreate();

        AbxActivityHelper.initializeSdk(MyApplicationClass.this, "your_adbrix_remaster_app_key", "your_adbrix_remaster_secret_key");
       
        if (Build.VERSION.SDK_INT >= 14) { 
            registerActivityLifecycleCallbacks(new AbxActivityLifecycleCallbacks());
        }
    }
}

 

 

Event uploading cycle setup

You can set the criteria for uploading cycle for events received on adbrix SDK to adbrix server. 

Event upload cycle can be set by cumulative event counts and time frame. 

* Events are uploaded based on the firs out of two criteria. 

* It is recommended to set in the activity class or application class in which the app starts. 

 

By cumulative event counts

Set event data to be uploaded to adbrix server when the preset counts of events are accumulated.

Use the following predefined values in the adbrix SDK.  

  • AdBrixRm.AdBrixEventUploadCountInterval.MIN : 10 counts
  • AdBrixRm.AdBrixEventUploadCountInterval.NORMAL : 30 counts
  • AdBrixRm.AdBrixEventUploadCountInterval.MAX : 60 counts
public class LauncherActivity extends Activity {

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_launcher);

        // Event uploading cycle setting : Upload event to adbrix server when 10 cumulative events are counted
        AdBrixRm.setEventUploadCountInterval(AdBrixRm.AdBrixEventUploadCountInterval.MIN);

    }
}

 

 

Event upload timer

Set event data to be uploaded to adbrix server after the preset time has elapsed.

Use the following predefined values in the adbrix SDK.

  • AdBrixRm.AdBrixEventUploadTimeInterval.MIN : 30 seconds
  • AdBrixRm.AdBrixEventUploadTimeInterval.NORMAL : 60 seconds
  • AdBrixRm.AdBrixEventUploadTimeInterval.MAX : 120 seconds
public class LauncherActivity extends Activity {

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_launcher);

        // Event uploading cycle setting : Upload event to adbrix server every 120 seconds
        AdBrixRm.setEventUploadTimeInterval(AdBrixRm.AdBrixEventUploadTimeInterval.MAX);
    }
}

 

 

 

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 Analytics

 

Login / Logout Event

You can analyze your app users' login and logout events. 

When login is successful, send user ID (user defining parameter) as following. 

When logout is successful, initialize the user login data by passing an empty string such as "".

void loginAndLogoutEvent() {

    if(isLogin){
        // When login is successful, send user ID like "user_1234"
        AdBrixRm.login("user_1234");
    }else{
        // When logout is successful, send empty string "".
        AdBrixRm.login("");
    }
 
}

* Please be careful not to include any personal information in the user ID being sent. If personal information such as email or phone number is included, it is recommended to properly encrypt the data by BASE64, MD5, SHA1, and etc. 

 

 

User Properties

You can analyze user properties such as age, gender, and others. 

void userPropertyUpdate() {
        
    // Age
    AdBrixRm.setAge(30);

    // Gender
    AdBrixRm.setGender(AdBrixRm.AbxGender.MALE);

    // Other user properties
    AdBrixRm.UserProperties userProperties = new AdBrixRm.UserProperties();
    userProperties.setProperty("nickname", "J.Smith");
    AdBrixRm.saveUserProperties(userProperties);
    
}

* UserProprety constraints passed to other user properties 

  • 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 1024byt

 

 

Location Data

You can analyze location data if you can gather geographic information.

void locationUpdate() {
    
    // Update latitude longitude data
    AdBrixRm.setEnableLocationListening(true);
            
}

* To receive geographic information, you need to add the permission of android.permission.ACCESS_COARSE_LOCATION to [AndroidManifest > manifest]. 

 

 

Custom Event

All general in-app events except purchase related events can be analyzed. 

You can analyze most of in-app user actions such as 'Button click', 'Character creation', 'Tutorial completion', 'Level achievement', and so on. 

void userCustomEvent() {

    // Click a button "Invite a friend"
    AdBrixRm.event("invite_button_click");

    // Complete "Character creation" 
    AdBrixRm.event("create_character_complete");

    // Complete "Tutorial view"
    AdBrixRm.event("tutorial_complete");

    // Achieve "Level 10"
    AdBrixRm.event("level_10");

}

 

 

Deep link event analytics

You can analyze app-open event via deep link.

Set the following for all activities that are opened via deep links: 

public class DeeplinkOpenedActivity extends Activity {

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);        
        onNewIntent(DeeplinkOpenedActivity.this.getIntent()); 
   }
 
    @Override
    protected void onNewIntent(Intent intent) {
        super.onNewIntent(intent);
        // Do something with Deeplink Intent Data
        setIntent(intent);
        AdBrixRm.deeplinkEvent(DeeplinkOpenedActivity.this); 
    } 
}

* Note: All the functions of onNewIntent(), setIntent(), deeplinkEvent() should be set in the same order as above.

 

Deep link setting is required to enable app open via deep link. 

Set the deep link at the activities registered at [AndroidManifest.xml > manifest > application] as follows. 

<intent-filter>
    <action android:name="android.intent.action.VIEW" />
    <category android:name="android.intent.category.DEFAULT" />
    <category android:name="android.intent.category.BROWSABLE" />
    <data android:scheme="your_scheme" android:host="your_host"  />
</intent-filter>

* Deep link is not tracked if LaunchMode of an activity opened by a deep link is Normal.
You need to change to another LaunchMode, such as SingleTask, or use AdbrixDeeplinkGateway activity. [AdBrixDeeplinkGateway Activity Setting Guide]

 

Common/ General Event Analytics

You can analyze a common in-app event, purchase. 

adbrix provides the following type of common event: 

  • Registration/ Sign Up
  • App Update
  • User Invitation
  • Credit Usage
  • Payment

* To measure purchase data by media, it is required to integrate 'Purchase.' 

 

Registration/ Sign Up

You can analyze in-app registration/sign up event. 

void userRegister() { 
     try {
                // Registered user information            
AdBrixRm.CommonProperties.SignUp signupUserInfo = new AdBrixRm.CommonProperties.SignUp()
                .setProperties(new JSONObject()
                .put("userid","my_user_id"));

           //Call registration API                
AdBrixRm.Common.signUp(AdBrixRm.CommonSignUpChannel.Google,signupUserInfo);

         } catch (JSONException e) {
           e.printStackTrace();
         }
}

  

App Update

You can analyze app update event. 

void appUpdate() { 
      try {
                    
           // App update information
           AdBrixRm.CommonProperties.AppUpdate updateInfo = new AdBrixRm.CommonProperties.AppUpdate()
                   .setPrevVersion("1.0.0a")
                   .setCurrVersion("1.0.1a")
                   .setProperties(new JSONObject()
                         .put("userid", "my_user_id"));

          //Call app update API
           AdBrixRm.Common.appUpdate(updateInfo);

           } catch (JSONException e){
             e.printStackTrace();
           }
}

 

User Invitation

You can analyze in-app user invitation event. 

void userInvite() { 
      try {
                    
           // User invitation information
           AdBrixRm.CommonProperties.Invite inviteInfo = new AdBrixRm.CommonProperties.Invite()
                   .setProperties(new JSONObject()
                         .put("userid", "my_user_id"));

          //Call user invitation API
           AdBrixRm.Common.invite(AdBrixRM.CommonInviteChannel.Facebook,inviteInfo);

           } catch (JSONException e){
             e.printStackTrace();
           }
}

 

Credit Usage

You can analyze event for the usage of cashable credit. 

void usingCredit() { 
      try {
                    
           // Credit usage information
           AdBrixRm.CommonProperties.UseCredit userCreditInfo = new AdBrixRm.CommonProperties.UseCredit()
                   .setProperties(new JSONObject()
                         .put("credit", 10000));

          //Call credit usage
           AdBrixRm.Common.useCredit(userCreditInfo);

           } catch (JSONException e){
             e.printStackTrace();
           }
}

 

 

Payment

You can analyze in-app payment/ purchase event. 

The following product and order related data are sent in the form of arrayList.

  • order id : (required) Order ID
  • product id : (required) Product ID
  • product name : (required) Product Name
  • price : (required) Product Price
  • quantity : (required) Purchase Quantity
  • discount : (optional) Discounted Amount
  • currency string : (optional) Purchase Currency Unit
  • category : (optional) Product Category 
  • extra attr json : (optional) Product Details and Options
  • delivery charge : (optional) Delivery Charge
  • payment method : (optional) Payment Method 
 
void purchaseEvent() {

    try {

        /*
            [1 product from "Sale- 10 Slacks designs, 1 product from "Season off - Printed sweatshirts ] = Total 2 products
            Get total KRW 3,500 discount including delivery fee coupon
            Discounts based on products is applied respecitvely.
        */

        // Create JSON OBJECT for Product Options
        JSONObject extraAttr_1 =
                new JSONObject().put("design_no", "9")
                        .put("color", "black")
                        .put("size", "30");
        // Create Product Detail Model
        AdBrixRm.CommerceProductModel productModel_1 =
                new AdBrixRm.CommerceProductModel().setProductID("5385487400")
                        .setProductName("Sale- 10 Slacks designs")
                        .setPrice(10000.00)
                        .setQuantity(1)
                        .setDiscount(1000.00)
                        .setCurrency(AdBrixRm.Currency.KR_KRW)
                        .setCategory(new AdBrixRm.CommerceCategoriesModel().setCategory("Sale- Pants and Skirts"))
                        .setExtraAttrs(extraAttr_1);

        // Create JSON OBJECT for Product Options
        JSONObject extraAttr_2 =
                new JSONObject().put("design_no", "2")
                        .put("color", "black/white")
                        .put("size", "95");
        // Create Product Detail Model
        AdBrixRm.CommerceProductModel productModel_2 =
                new AdBrixRm.CommerceProductModel().setProductID("145099811")
                        .setProductName("[Season off] Printed sweatshirts")
                        .setPrice(15500.00)
                        .setQuantity(1)
                        .setDiscount(1200.00)
                        .setCurrency(AdBrixRm.Currency.KR_KRW)
                        .setCategory(new AdBrixRm.CommerceCategoriesModel().setCategory("Sale- Tops"))
                        .setExtraAttrs(extraAttr_2);

        // Create Product Detail Model ArrayList
        ArrayList productModelArrayList = new ArrayList<>();
        productModelArrayList.add(productModel_1);
        productModelArrayList.add(productModel_2);

        // Payment - Mobile Payment
        AdBrixRm.Common.purchase("290192012", productModelArrayList, 0.00, 3500.00, AdBrixRm.CommercePaymentMethod.MobilePayment);
        
    } catch (JSONException e) {
        e.printStackTrace();
    }

}

 

 

 

Commerce Event Analytics

You can analyze purchase-related in-app events, e.g. product detail view and add to cart.  

adbrix provides the following type of commerce events: 

  • Home/ Main page view
  • Category page/ event page view
  • Product detail view 
  • Add to cart
  • Add to wishlist 
  • View an order
  • Cancel an order
  • Search a product 
  • View product list
  • View cart
  • Fill in payment information

 

 

 

Home/ Main Page View

You can analyze the event that users view home/ main page.

void viewHomeEvent(){

    // Analyze the event that users view home/ main page
    AdBrixRm.Commerce.viewHome();

}

 

 

Category / Event Page View

You can analyze the event that users view category/ event page.

The product data displayed when users view category are sent in the form of the following:

  • product id : (required) Product ID
  • product name : (required) Product Name
  • price : (required) Product Price
  • quantity : (required) Purchase Quantity
  • discount : (optional) Discounted Amount
  • currency string : (optional) Purchase Currency Unit
  • category : (optional) Product Category 
  • extra attr json : (optional) Product Details and Options
void viewCategoryEvent(){

    // Create category model
    AdBrixRm.CommerceCategoriesModel categoriesModel =
            new AdBrixRm.CommerceCategoriesModel().setCategory("Sale- Pants and Skirts");
    // Create product detail model
    AdBrixRm.CommerceProductModel productModel_1 =
            new AdBrixRm.CommerceProductModel().setProductID("5385487400")
                    .setProductName("Sale- 10 Slacks designs")
                    .setPrice(10000.00)
                    .setQuantity(1)
                    .setDiscount(1000.00)
                    .setCurrency(AdBrixRm.Currency.KR_KRW)
                    .setCategory(new AdBrixRm.CommerceCategoriesModel().setCategory("Sale- Pants and Skirts"));
   // Create product detail model 
    AdBrixRm.CommerceProductModel productModel_2 =
            new AdBrixRm.CommerceProductModel().setProductID("837246401")
                    .setProductName("Capri pants collection")
                    .setPrice(14000.00)
                    .setQuantity(1)
                    .setDiscount(0.00)
                    .setCurrency(AdBrixRm.Currency.KR_KRW)
                    .setCategory(new AdBrixRm.CommerceCategoriesModel().setCategory("Sale- Pants and Skirts"));
     // Create product detail model
    AdBrixRm.CommerceProductModel productModel_3 =
            new AdBrixRm.CommerceProductModel().setProductID("3567289101")
                    .setProductName("New easy-to-wear jogger- 3 designs")
                    .setPrice(8800.00)
                    .setQuantity(1)
                    .setDiscount(0.00)
                    .setCurrency(AdBrixRm.Currency.KR_KRW)
                    .setCategory(new AdBrixRm.CommerceCategoriesModel().setCategory("Sale- Pants and Skirts"));

    // Create Product Detail Model ArrayList 
    ArrayList productModelArrayList = new ArrayList<>();
    productModelArrayList.add(productModel_1);
    productModelArrayList.add(productModel_2);
    productModelArrayList.add(productModel_3);


    // Analyze category view events
    AdBrixRm.Commerce.categoryView(categoriesModel, productModelArrayList);
        
}

 

 

Product Detail View

You can analyze the event that users view product details.

The following product-related data are sent.

  • product id : (required) Product ID
  • product name : (required) Product Name
  • price : (required) Product Price
  • quantity : (required) Purchase Quantity
  • discount : (optional) Discounted Amount
  • currency string : (optional) Purchase Currency Unit
  • category : (optional) Product Category 
  • extra attr json : (optional) Product Details and Options
void viewProductDetailEvent(){

        try {

            // Create category model
            AdBrixRm.CommerceCategoriesModel categoriesModel =
                    new AdBrixRm.CommerceCategoriesModel().setCategory("Sale");

            // Create product detail option JSON OBJECT
            JSONObject extraAttr_1 =
                    new JSONObject().put("design_no", "9")
                            .put("color", "black")
                            .put("size", "30");
            // Create product detail model
            AdBrixRm.CommerceProductModel productModel =
                    new AdBrixRm.CommerceProductModel().setProductID("5385487400")
                            .setProductName("Sale- 10 Slacks designs")
                            .setPrice(10000.00)
                            .setQuantity(1)
                            .setDiscount(1000.00)
                            .setCurrency(AdBrixRm.Currency.KR_KRW)
                            .setCategory(new AdBrixRm.CommerceCategoriesModel().setCategory("Sale- Pants and Skirts"))
                            .setExtraAttrs(extraAttr_1);
            // Analyze product detail view event
            AdBrixRm.Commerce.productView(productModel);

        }catch (JSONException e){
            e.printStackTrace();;
        }
    }

 

 

Add to Cart

You can analyze the event that users add products to cart.

The following product-related data are sent.

 

  • product id : (required) Product ID
  • product name : (required) Product Name
  • price : (required) Product Price
  • quantity : (required) Purchase Quantity
  • discount : (optional) Discounted Amount
  • currency string : (optional) Purchase Currency Unit
  • category : (optional) Product Category 
  • extra attr json : (optional) Product Details and Options
void addToCartEvent(){
        
    try {

        // Create product option JSON OBJECT
        JSONObject extraAttr_1 =
                new JSONObject().put("design_no", "9")
                        .put("color", "black")
                        .put("size", "30");
        // Create product detail model
        AdBrixRm.CommerceProductModel productModel_1 =
                new AdBrixRm.CommerceProductModel().setProductID("5385487400")
                        .setProductName("Sale- 10 Slacks designs")
                        .setPrice(10000.00)
                        .setQuantity(1)
                        .setDiscount(1000.00)
                        .setCurrency(AdBrixRm.Currency.KR_KRW)
                        .setCategory(new AdBrixRm.CommerceCategoriesModel().setCategory("Sale- Pants and Skirts"))
                        .setExtraAttrs(extraAttr_1);

        // Create product option JSON OBJECT
        JSONObject extraAttr_2 =
                new JSONObject().put("design_no", "2")
                        .put("color", "black/white")
                        .put("size", "95");
        // Create product detail model
        AdBrixRm.CommerceProductModel productModel_2 =
                new AdBrixRm.CommerceProductModel().setProductID("145099811")
                        .setProductName("[Season off] Printed sweatshirts")
                        .setPrice(15500.00)
                        .setQuantity(1)
                        .setDiscount(1200.00)
                        .setCurrency(AdBrixRm.Currency.KR_KRW)
                        .setCategory(new AdBrixRm.CommerceCategoriesModel().setCategory("Sale- Tops"))
                        .setExtraAttrs(extraAttr_2);

        // Create product detail model ArrayList
        ArrayList productModelArrayList = new ArrayList<>();
        productModelArrayList.add(productModel_1);
        productModelArrayList.add(productModel_2);
        
        // Analyze add-to-cart event
        AdBrixRm.Commerce.addToCartBulk(productModelArrayList);

    }catch (JSONException e){
        e.printStackTrace();
    }
}

 

 

Add to Wishlist

You can analyze the event that users add products to wishlist.

The following product-related data are sent.

  • product id : (required) Product ID
  • product name : (required) Product Name
  • price : (required) Product Price
  • quantity : (required) Purchase Quantity
  • discount : (optional) Discounted Amount
  • currency string : (optional) Purchase Currency Unit
  • category : (optional) Product Category 
  • extra attr json : (optional) Product Details and Options
void addToWishListEvent(){
    try {

        // Create category model
        AdBrixRm.CommerceCategoriesModel categoriesModel =
                new AdBrixRm.CommerceCategoriesModel().setCategory("Sale");

        // Create product option JSON OBJECT
        JSONObject extraAttr_1 =
                new JSONObject().put("design_no", "9")
                        .put("color", "black")
                        .put("size", "30");
        // Create product detail model
        AdBrixRm.CommerceProductModel productModel =
                new AdBrixRm.CommerceProductModel().setProductID("5385487400")
                        .setProductName("Sale- 10 Slacks designs")
                        .setPrice(10000.00)
                        .setQuantity(1)
                        .setDiscount(1000.00)
                        .setCurrency(AdBrixRm.Currency.KR_KRW)
                        .setCategory(new AdBrixRm.CommerceCategoriesModel().setCategory("Sale- Pants and Skirts"))
                        .setExtraAttrs(extraAttr_1);

        // Analyze add-to-wishlist event
        AdBrixRm.Commerce.addToWishList(productModel);

    }catch (JSONException e){
        e.printStackTrace();
    }
}

 

 

View an Order

You can analyze the event that users view an order for final review.

The following product and order related data are sent. 

 

  • order id : (required) Order ID
  • product id : (required) Product ID
  • product name : (required) Product Name
  • price : (required) Product Price
  • quantity : (required) Purchase Quantity
  • discount : (optional) Discounted Amount
  • currency string : (optional) Purchase Currency Unit
  • category : (optional) Product Category 
  • extra attr json : (optional) Product Details and Options
  • delivery charge : (optional) Delivery Charge
void reviewOrderEvent(){
    try {

        // Create product option JSON OBJECT
        JSONObject extraAttr_1 =
                new JSONObject().put("design_no", "9")
                        .put("color", "black")
                        .put("size", "30");
        // Create product detail model
        AdBrixRm.CommerceProductModel productModel_1 =
                new AdBrixRm.CommerceProductModel().setProductID("5385487400")
                        .setProductName("Sale- 10 Slacks designs")
                        .setPrice(10000.00)
                        .setQuantity(1)
                        .setDiscount(1000.00)
                        .setCurrency(AdBrixRm.Currency.KR_KRW)
                        .setCategory(new AdBrixRm.CommerceCategoriesModel().setCategory("Sale- Pants and Skirts"))
                        .setExtraAttrs(extraAttr_1);

        // Create product option JSON OBJECT
        JSONObject extraAttr_2 =
                new JSONObject().put("design_no", "2")
                        .put("color", "black/white")
                        .put("size", "95");
        // Create product detail model
        AdBrixRm.CommerceProductModel productModel_2 =
                new AdBrixRm.CommerceProductModel().setProductID("145099811")
                        .setProductName("[Season off] printed sweatshirt")
                        .setPrice(15500.00)
                        .setQuantity(1)
                        .setDiscount(1200.00)
                        .setCurrency(AdBrixRm.Currency.KR_KRW)
                        .setCategory(new AdBrixRm.CommerceCategoriesModel().setCategory("Sale- Tops"))
                        .setExtraAttrs(extraAttr_2);

        // Create product detail model ArrayList
        ArrayList productModelArrayList = new ArrayList<>();
        productModelArrayList.add(productModel_1);
        productModelArrayList.add(productModel_2);

        // Analyze view-an-order event
        AdBrixRm.Commerce.reviewOrderBulk("290192012", productModelArrayList, 0.00, 3500.00);

    } catch (JSONException e) {
        e.printStackTrace();
    }

}

 

 

Cancel an Order / Refund

You can analyze the event that users cancel an order or claim refund.

The following product and order related data are sent. 

  • order id : (required) Order ID
  • product id : (required) Product ID
  • product name : (required) Product Name
  • price : (required) Product Price
  • quantity : (required) Purchase Quantity
  • discount : (optional) Discounted Amount
  • currency string : (optional) Purchase Currency Unit
  • category : (optional) Product Category 
  • extra attr json : (optional) Product Details and Options
  • penalty charge :  (optional) Fee for the Cancelation/ Refund
void refundOrderEvent(){
    try {

        // Create product option JSON OBJECT 
        JSONObject extraAttr_1 =
                new JSONObject().put("design_no", "9")
                        .put("color", "black")
                        .put("size", "30");
        // Create product detail model
        AdBrixRm.CommerceProductModel productModel_1 =
                new AdBrixRm.CommerceProductModel().setProductID("5385487400")
                        .setProductName("Sale- 10 Slacks designs")
                        .setPrice(10000.00)
                        .setQuantity(1)
                        .setDiscount(1000.00)
                        .setCurrency(AdBrixRm.Currency.KR_KRW)
                        .setCategory(new AdBrixRm.CommerceCategoriesModel().setCategory("Sale- Pants and Skirts"))
                        .setExtraAttrs(extraAttr_1);

        // Create product option JSON OBJECT 
        JSONObject extraAttr_2 =
                new JSONObject().put("design_no", "2")
                        .put("color", "black/white")
                        .put("size", "95");

        AdBrixRm.CommerceProductModel productModel_2 =
                new AdBrixRm.CommerceProductModel().setProductID("145099811")
                        .setProductName("[Season off] Printed sweatshirts")
                        .setPrice(15500.00)
                        .setQuantity(1)
                        .setDiscount(1200.00)
                        .setCurrency(AdBrixRm.Currency.KR_KRW)
                        .setCategory(new AdBrixRm.CommerceCategoriesModel().setCategory("Sale- Tops"))
                        .setExtraAttrs(extraAttr_2);

        // Create product detail model ArrayList
        ArrayList productModelArrayList = new ArrayList<>();
        productModelArrayList.add(productModel_1);
        productModelArrayList.add(productModel_2);

        // Analyze order cancelation/ refund event
        AdBrixRm.Commerce.refundBulk("290192012", productModelArrayList, 0.00);

    } catch (JSONException e) {
        e.printStackTrace();
    }
}

 

 

Search a Product

You can analyze the event that users search a product

The following product-related data included in search result are sent. 

  • keyword : (required) Word used to search a product
  • product id : (required) Product ID
  • product name : (required) Product Name
  • price : (required) Product Price
  • quantity : (required) Purchase Quantity
  • discount : (optional) Discounted Amount
  • currency string : (optional) Purchase Currency Unit
  • category : (optional) Product Category 
void searchProductEvent(){

    // Create product detail model
    AdBrixRm.CommerceProductModel productModel_1 =
            new AdBrixRm.CommerceProductModel().setProductID("5385487400")
                    .setProductName("Sale- 10 Slacks designs")
                    .setPrice(10000.00)
                    .setQuantity(1)
                    .setDiscount(1000.00)
                    .setCurrency(AdBrixRm.Currency.KR_KRW)
                    .setCategory(new AdBrixRm.CommerceCategoriesModel().setCategory("Sale- Pants and Skirts"));

    // Create product detail model
    AdBrixRm.CommerceProductModel productModel_2 =
            new AdBrixRm.CommerceProductModel().setProductID("837246401")
                    .setProductName("Capri pants collection")
                    .setPrice(14000.00)
                    .setQuantity(1)
                    .setDiscount(0.00)
                    .setCurrency(AdBrixRm.Currency.KR_KRW)
                    .setCategory(new AdBrixRm.CommerceCategoriesModel().setCategory("Sale- Pants and Skirts"));

    // Create product detail model
    AdBrixRm.CommerceProductModel productModel_3 =
            new AdBrixRm.CommerceProductModel().setProductID("3567289101")
                    .setProductName("New easy-to-wear jogger- 3 designs")
                    .setPrice(8800.00)
                    .setQuantity(1)
                    .setDiscount(0.00)
                    .setCurrency(AdBrixRm.Currency.KR_KRW)
                    .setCategory(new AdBrixRm.CommerceCategoriesModel().setCategory("Sale- Pants and Skirts"));


    // Create product detail model ArrayList
    ArrayList productModelArrayList = new ArrayList<>();
    productModelArrayList.add(productModel_1);
    productModelArrayList.add(productModel_2);
    productModelArrayList.add(productModel_3);

    // Analyze product-search event
    AdBrixRm.Commerce.search("Casual pants", productModelArrayList);

}

 

 

Share a Product

 You can analyze the event that users share a product.

The following shared-product data are sent.

  • product id : (required) Product ID
  • product name : (required) Product Name
  • price : (required) Product Price
  • quantity : (required) Purchase Quantity
  • discount : (optional) Discounted Amount
  • currency string : (optional) Purchase Currency Unit
  • category : (optional) Product Category 
  • extra attr json : (optional) Product Details and Options
void shareProductEvent(){
        
    // Create product detail model
    AdBrixRm.CommerceProductModel productModel =
            new AdBrixRm.CommerceProductModel().setProductID("5385487400")
                    .setProductName("Sale- 10 Slacks designs")
                    .setPrice(10000.00)
                    .setQuantity(1)
                    .setDiscount(1000.00)
                    .setCurrency(AdBrixRm.Currency.KR_KRW)
                    .setCategory(new AdBrixRm.CommerceCategoriesModel().setCategory("Sale- Pants and Skirts "));

    // Analyze share-a-product event
    AdBrixRm.Commerce.share(AdBrixRm.CommerceSharingChannel.KakaoTalk,  productModel);

}

 

View a Product List

You can analyze the event that users view a product list.

The following data of viewing product list are sent.

  • product id : (required) Product ID
  • product name : (required) Product Name
  • price : (required) Product Price
  • quantity : (required) Purchase Quantity
  • discount : (optional) Discounted Amount
  • currency string : (optional) Purchase Currency Unit
  • category : (optional) Product Category 
  • extra attr json : (optional) Product Details and Options
void listViewProductsEvent(){
        
    // Create product detail model
    final AdBrixRm.CommerceCategoriesModel product = new AdBrixRm.CommerceCategoriesModel().setCategory("Sports wear/ Athletic Shoes");

    ArrayList resultProductModels = new ArrayList() {{
      add(new AdBrixRm.CommerceProductModel()
            .setProductID("n24jsda922")
            .setProductName("[Nike] NIKE WMNS AIR MAX THEA WHITEwomens 599409-103")
            .setPrice(94300)
            .setCurrency(AdBrixRm.Currency.KR_KRW)
            .setCategory(product));
      add(new AdBrixRm.CommerceProductModel()
            .setProductID("saf323dsa23d4f")
            .setProductName("[Nike] NIKE WMNS AIR MAX THEA WHITEwomens 599409-104")
            .setPrice(106650)
            .setCurrency(AdBrixRm.Currency.KR_KRW)
            .setCategory(product));
      add(new AdBrixRm.CommerceProductModel()
            .setProductID("hh5j34dz")
            .setProductName("[Nike] NIKE WMNS AIR MAX THEA WHITEwomens 599409-105")
            .setPrice(111150)
            .setCurrency(AdBrixRm.Currency.KR_KRW)
            .setCategory(product));
    }};

    //Analyze view a product list event
    AdBrixRm.Commerce.listView(resultProductModels);
}

 

View a Cart

You can analyze the event that users view cart.

The following data of viewing cart are sent. 

  • product id : (required) Product ID
  • product name : (required) Product Name
  • price : (required) Product Price
  • quantity : (required) Purchase Quantity
  • discount : (optional) Discounted Amount
  • currency string : (optional) Purchase Currency Unit
  • category : (optional) Product Category 
  • extra attr json : (optional) Product Details and Options
void cartViewProductsEvent(){
        
    // Create product detail model
    final AdBrixRm.CommerceCategoriesModel product = new AdBrixRm.CommerceCategoriesModel().setCategory("Sports wear/ Athletic Shoes");

    ArrayList resultProductModels = new ArrayList() {{
      add(new AdBrixRm.CommerceProductModel()
            .setProductID("n24jsda922")
            .setProductName("[Nike] NIKE WMNS AIR MAX THEA WHITEwomens 599409-103")
            .setPrice(94300)
            .setCurrency(AdBrixRm.Currency.KR_KRW)
            .setCategory(product));
      add(new AdBrixRm.CommerceProductModel()
            .setProductID("saf323dsa23d4f")
            .setProductName("[Nike] NIKE WMNS AIR MAX THEA WHITEwomens 599409-104")
            .setPrice(106650)
            .setCurrency(AdBrixRm.Currency.KR_KRW)
            .setCategory(product));
      add(new AdBrixRm.CommerceProductModel()
            .setProductID("hh5j34dz")
            .setProductName("[Nike] NIKE WMNS AIR MAX THEA WHITEwomens 599409-105")
            .setPrice(111150)
            .setCurrency(AdBrixRm.Currency.KR_KRW)
            .setCategory(product));
    }};

    //Analyze cart viewing event
    AdBrixRm.Commerce.cartView(resultProductModels);
}

 

Fill in Payment Information

You can analyze the event that users fill in payment information.

void paymentInfoAddedEvent(){
        JSONObject paymentAttr =
                new JSONObject().put("card", "kbcard");
        //Event of filling in payment information
        AdBrixRm.Commerce.paymentInfoAdded(paymentAttr);
}

 

Gaming Event Analytics

You can analyze in-app events related to game such as tutorial and stage.

adbrix provides the following types of gaming event:

  • Tutorial completion
  • Character creation 
  • Stage cleared
  • Level achieved

 

Tutorial Completion

You can analyze the event that users completed in-app tutorial .

The following tutorial completion data is to be formed in GameProperies.TutorialComplete values and sent. 

  • setIsSkip : (required) Check whether the completion is done with skip button.
void tutorialCompleteEvent(){
        AdBrixRm.GameProperties.TutorialComplete gameProperties 
                  = new AdBrixRm.GameProperties.TutorialComplete().setIsSkip(true);

        //Call tutorial completion event
        AdBrixRm.Game.tutorialComplete(gameProperties);
}

 

Character Creation

You can analyze the in-app event that users create characters.

The following character creation data is to be formed in GameProperies.CharacterCreated values and sent. 

void characterCreatedEvent(){
        AdBrixRm.GameProperties.CharacterCreated gameProperties 
                  = new AdBrixRm.GameProperties.CharacterCreated();

        //Call character creation event
        AdBrixRm.Game.characterCreated(gameProperties);
}

 

Stage Cleared

You can analyze the in-app event that users clear stages.

The following stage clear data is to be formed in GameProperies.StageCleared values and sent. 

  • setStageName : (required) Name of Cleared Stage 
void stageClearedEvent(){
        AdBrixRm.GameProperties.StageCleared gameProperties 
                  = new AdBrixRm.GameProperties.StageCleared().setStageName("1-1");

        //Call stage clear event
        AdBrixRm.Game.stageCleared(gameProperties);
}

Level Achieved

You can analyze the in-app event that users achieved certain levels. 

The following achieved level data is to be formed in GameProperies.LevelAchieved values and sent.

  • setLevel : (required) Level Achieved (1~10000) 
void levelAchievedEvent(){
        AdBrixRm.GameProperties.LevelAchieved gameProperties 
                  = new AdBrixRm.GameProperties.LevelAchieved().setLevel(1);

        //Call level achieved event
        AdBrixRm.Game.levelAchieved(gameProperties);
}

Related articles

Comments

0 comments

Please sign in to leave a comment.

INDEX