Check list cần chú ý khi tích hợp SDK

Tóm tắt: Nội dung dưới đây liệt kê một số điểm cần chú ý khi tích hợp SDK và các câu hỏi thường gặp FAQ trong quá trình tích hợp.

Các hạng mục kiểm tra chung

1. Kiểm tra xem SDK đã được cài đặt chính xác chưa

_ Android: có thể download từ gradle
_ iOS: có thể download từ Cocoapods

Sau khi download SDK từ các nguồn trên, chúng ta cần tiến hành kiểm tra một số hạng mục sau:

(1) Đối với Android
Tại External Libraries trong project ở Android studio kiểm tra xem Gradle: com.igaworks.adbrix:abx-common-rm: version name@aar đã được thêm vào như minh họa dưới đây hay chưa.

(2) Đối với iOS
Trên Xcode project, kiểm tra xem AdBrixRemastered framework trong Pods đã được cài đặt như minh hoạt dưới đây chưa.

2. Phân tích Deep-link/ Deferred deep-link event

Adbrix hỗ trợ cả Deep-link và Deferred deep-link đồng thời cho phép phân tích kết quả từ các link này. (Tham khảo: giải thích về All-link). Chú ý hoàn thiện phần tích hợp phần phân tích Deep-link/ Deferred deep-link event theo hướng dẫn tích hợp.
: Java / Kotlin / Swift / Objective-C
_ Trong trường hợp sử dụng Deep-link: bắt buộc phải tích hợp phần phân tích Deep-link/ Deferred deep-link event.
_ Trong trường hợp tiến hành quảng cáo trên Facebook ad: bắt buộc phải tích hợp tính năng Deep-link cũng như phần phân tích Deep-link/ Deferred deep-link event.

3. Trong trường hợp không thể download SDK thông qua Gradle/ Cocoapods

Theo quy định về bảo mật của adbrix, adbrix SDK chỉ có thể download từ Gradle và Cocoapods. Trường hợp xảy ra lỗi hoặc không thể download từ 2 nguồn này, xin liên hệ bộ phận hỗ trợ theo link (chọn Request type: About SDK integration)

4. Kiểm tra format của attrModel 

* Trường hợp của Unity: Dữ liệu đã thêm vào qua Dictionary

Dữ liệu được thêm vào qua attrModel có cấu trúc gồm key và value. Trong đó đối với key, chỉ những dữ liệu có format theo quy định với được gửi tới server của adbrix. Nếu dữ liệu thêm vào qua attrModel không được hiển thị trên các báo cáo của adbrix, để đảm bảo format đúng với quy định, hãy kiểm tra các điều kiện sau.

_ key được sử dụng các yếu tố sau : chữ cái tiếng Anh viết thường, chữ số, dấu gạch dưới (_) và dấu gạch ngang (-)
_ Các ký tự khác (chữ cái tiếng Hàn, Trung, ... các ký tự đặc biệt khác) đều không được chấp nhận.

Example

void userCustomEvent() {

    // 이벤트 추가 정보 설정
    AdBrixRm.AttrModel eventAttr = new AdBrixRm.AttrModel()
            .setAttrs("address","District 1, Hochiminh City, Vietnam")   // OK
            .setAttrs("Age", 27)                          // unusable (key sử dụng chữ cái viết hoa)
            .setAttrs("전화번호","010-1234-56789")         // unusable(key sử dụng tiếng Hàn) 
            .setAttrs("10years?",true);                   // unusable(key sử dụng dấu "?")
}

Android SDK

5. Kiểm tra xem InstallReferrer đã được tích hợp chính xác chưa

InstallReferrer được Google cung cấp: chỉ cần thêm vào build.gradle như minh họa dưới đây

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

Ngoài phương pháp trên, để kiểm tra xem InstallReferrer  đã được thêm vào chính xác chưa, chúng ta có thể thử các phương án sau:
1. build từ apk trong Android Studio
2. Tiến hành compile apk và mở file AndroidManifest.xml trong file de-compile
3. Kiểm tra xem trong AndroidManifest.xml đã có nội dung như minh họa dưới đây hay chưa.

iOS SDK

6. Apple Review - tích để đồng ý sử dụng IDFA

Sau khi tích hợp adbrix SDK và submit app review trên Apple, cần tích vào lựa chọn có sử dụng IDFA hay không. Vì vậy khi tiến hành submit sau khi tích hợp SDK cần chú ý tích Yes vào hạng mục sử dụng IDFA như hình mình họa dưới đây.

7. Hiển thị thông báo không thể hỗ trợ Swift version (Xcode)

Adbrix SDK sẽ tiến hành update SDK mỗi khi Xcode và Swift version được update. Nếu sau khi update Xcode mà thông báo không hỗ trợ Swift version hiển thị trong adbrix SDK thì cần update lại SDK thông qua Cocoapods. Quá trình update SDK có thể thực hiện theo hướng dẫn sau:

Phương pháp update SDK
a. Mở Terminal và di chuyển tới project folder.
b. Nhập lệnh 'pod update' trong Terminal và update version mới nhất của adbrix SDK trên Cocoapods.

※ Trường hợp sử dụng Xcode và Swift version cũ
Trong trường hợp bắt buộc phải sử dụng Xcode và Swift của các version cũ, có thể liên hệ với đội ngũ hỗ trợ của adbrix để được hướng dẫn cụ thể. Đề nghị hỗ trợ tại: request link  (request type: about SDK integration)