DFINERY SDK integration: Pre-checklist (FAQs)

Overview

This document summarizes the precautions and FAQ to consider when integrating the Definery (AdBrix) SDK.

common

1. Confirm SDK installation

_ Android can be downloaded from gradle.
_ iOS can be downloaded from Cocoapods.

Once the SDK download is complete, you can verify it as follows.

(1) Android
In Android Studio, check if the following is added under the External Libraries section in the project:
Gradle: com.igaworks.adbrix:abx-common-rm:version-name@aar

(2) iOS
Check if the AdBrixRemastered framework is installed within Pods as shown in the screenshot below on the Xcode project.

2. Deep Link / Deferred Deep Link Event Analysis

Definery provides both Deeplink and Deferred deeplink features and analyzes the results. ( View All-Link feature )
Please complete the analysis of deeplink / deferred deeplink events within the integration guide.
: Java / Kotlin / Swift / Objective-C
_ When using deeplinks , please make sure to complete the analysis of deeplink / deferred deeplink events.
_ When running Facebook ads , be sure to set up in-app deeplink and complete the analysis of deeplink / deferred deeplink events.

3. Unable to download SDK via Gradle / Cocoapods

The Definery (Adbrix) SDK can only be downloaded via Gradle and Cococapods due to Definery (Adbrix)'s own security regulations.
If you are unable to download the Definery (Adbrix) SDK through Gradle / Cocoapods, please leave an inquiry.
_ Submit Inquiry (Select 'I have an SDK integration and technical inquiry.')

4. Check attrModel data format

* Data added as Dictionary in Unity

The data added with attrModel is composed of key and value.
Among them, the key is restricted by the definer (Adbrix) SDK to only allow data of a specific format to be transmitted to our server.
If the data added with attrModel cannot be checked in the Adbrix report, please check the following restrictions.

_ Key usage restrictions: Only lowercase English letters and numbers are allowed. Special characters allowed are underscore (_) and dash (-).
_ Uppercase English letters and other characters (Korean, Chinese characters, Hiragana, Katakana, etc.), and other special characters cannot be used.

Example

void userCustomEvent() {

    // Set additional event information
    AdBrixRm.AttrModel eventAttr = new AdBrixRm.AttrModel()
            .setAttrs("address","경기도 안양시 동안구")   // Can be sent
            .setAttrs("Age", 27)                          // Cannot be sent (Use of uppercase English letters)
            .setAttrs("전화번호","010-1234-56789")         // Cannot be sent (Use of Korean)
            .setAttrs("10years?",true);                   // Cannot be sent (Use of special character ?)
}

Android SDK

5. Check the normal connection of InstallReferrer

In the case of InstallReferrer provided by Google, it can be integrated just by adding it to build.gradle as shown below.

dependencies {
    implementation 'com.android.installreferrer:installreferrer:1.0'
}

Apart from this method, you can verify whether the InstallReferrer has been added correctly by using the following method.

How to check
1. Build as apk in Android Studio.
2. Decompile the apk and open the AndroidManifest.xml file in the decompiled folder.
3. Check if the following content is in the permissions section of AndroidManifest.xml.

iOS SDK

6. Apple Review - IDFA Usage Survey

After the integration of the Definery (AdBrix) SDK is complete, you must check the use of IDFA when submitting the app review to Apple.
Once the Definery (AdBrix) SDK is integrated, please check the following items and submit the review.

7. Swift version support unavailable alert display (Xcode)

The Definery (AdBrix) SDK is updated whenever Apple updates Xcode and Swift versions.
If you receive an alert that the Definery (AdBrix) SDK does not support the Swift version after updating Xcode, please update the SDK via Cocoapods.

Please proceed with the SDK update as follows.

How to Update SDK
a. Open the terminal and navigate to the project folder.
b. Enter the ' pod update ' command in the terminal to update the Definer (AdBrix) SDK registered in cocoapods to the latest version.

※ If you are using an older version of Xcode and Swift
Since the Definery (AdBrix) SDK is written in Swift, if Apple updates the Swift version, the Definery (AdBrix) SDK must also be updated to the latest version to function properly on the latest version of Xcode.
If you must use an older version of Xcode and Swift, please seek guidance from the Definery (AdBrix) support engineering team.

If you must use older versions of Xcode and Swift, please seek guidance from the support engineering team at Defineary (Adbrix).

_ Submit Inquiry ('There is an SDK integration and technical inquiry.' select)