디파이너리 SDK 연동 : 사전 체크리스트(FAQs)
개요
본 문서는 디파이너리(애드브릭스) SDK 를 연동 시 주의해야 할 사항 및 FAQ를 정리합니다.
공통
1. SDK 정상 설치 확인
_ Android는 gradle에서 다운로드 받을 수 있습니다.
_ iOS는 Cocoapods에서 다운로드 받을 수 있습니다.
SDK 다운로드가 완료되면 아래와 같이 확인이 가능합니다.
(1) 안드로이드
안드로이드 스튜디오에서 프로젝트 내 External Libraries 항목에
아래와 같이 Gradle: com.igaworks.adbrix:abx-common-rm:버전명@aar 추가되어 있는지 확인합니다.
(2) iOS
Xcode 프로젝트 상 아래 스크린샷과 같이 Pods 내 AdBrixRemastered 프레임워크가 설치되어 있는지 확인합니다.
2. 딥링크 / 디퍼드 딥링크 이벤트 분석
디파이너리는 딥링크(Deeplink)와 지연된 딥링크(Deferred deeplink) 기능을 모두 제공하며 그 결과를 분석합니다. (All-Link 기능 보기)
연동 가이드 내 딥링크 / 디퍼드 딥링크 이벤트 분석을 완료해주시기 바랍니다.
: Java / Kotlin / Swift / Objective-C
_ 딥링크를 사용하는 경우에는 반드시 딥링크 / 디퍼드 딥링크 이벤트 분석을 완료 해주세요.
_ 페이스북 광고를 운영하는 경우 반드시 앱 내 딥링크 설정 및 딥링크 / 디퍼드 딥링크 이벤트 분석을 완료 해주세요.
3. Gradle / Cocoapods을 통한 SDK 다운로드 불가
디파이너리(애드브릭스) SDK 는 디파이너리(애드브릭스) 자체 보안 규정상 Gradle 과 Cococapods 를 통해서만 다운로드 받을 수 있습니다.
Gradle / Cocoapods 를 통해 디파이너리(애드브릭스) SDK 다운로드가 불가능한 경우 문의를 남겨주시기 바랍니다.
_ 문의 등록 ('SDK 연동 및 기술 문의가 있습니다.' 선택)
4. attrModel 데이터 양식 확인
* Unity 의 경우 Dictionary 로 추가한 데이터
attrModel 로 추가하는 데이터는 key 와 value 로 구성되어 있습니다.
이중 key 는 디파이너리(애드브릭스) SDK에서 특정 포멧의 데이터만 저희 서버로 전송할 수 있게 제한을 두고 있습니다.
attrModel 로 추가한 데이터를 Adbrix 리포트에서 확인이 불가능하다면 아래 제한사항을 체크해 주시길 바랍니다.
_ key 사용 제한사항 : 영문 소문자, 숫자만 사용 가능. 특수문자는 언더바(_), 대시 (-) 만 사용 가능.
_ 영문 대문자 및 기타 문자(한글, 한자, 히라가나, 가타가나 등등), 기타 특수문자는 사용할 수 없음
Example
void userCustomEvent() {
// 이벤트 추가 정보 설정
AdBrixRm.AttrModel eventAttr = new AdBrixRm.AttrModel()
.setAttrs("address","경기도 안양시 동안구") // 전송가능
.setAttrs("Age", 27) // 전송불가 (영문대문자 사용)
.setAttrs("전화번호","010-1234-56789") // 전송불가 (한글 사용)
.setAttrs("10years?",true); // 전송불가 (? 특수문자 사용)
}
Android SDK
5. InstallReferrer 정상 연동 확인
Google 에서 제공하는 InstallReferrer 의 경우 아래와 같이 build.gradle 에 추가하는 것만으로도 연동이 됩니다.
dependencies {
implementation 'com.android.installreferrer:installreferrer:1.0'
}
이 방법 이외에 InstallReferrer 가 정상적으로 추가되었는지 확인하기 위해서는 아래와 같은 방법으로 확인이 가능합니다.
확인 방법
1. Android Studio 에서 apk 로 build.
2. apk 를 디컴파일 하고 디컴파일된 폴더에서 AndroidManifest.xml 파일을 엽니다.
3. AndroidManifest.xml 에 권한 부분에 아래 내용이 있는지 확인 합니다.
iOS SDK
6. Apple 리뷰 - IDFA 사용 설문
디파이너리(애드브릭스) SDK 연동이 완료되고 Apple 에 앱 리뷰 제출 시 IDFA 사용 여부를 체크해야 합니다.
디파이너리(애드브릭스) SDK 연동된 후에는 아래의 사항을 체크하고 리뷰를 제출해 주시길 바랍니다.
7. Swift 버전 지원 불가 알람 노출 (Xcode)
디파이너리(애드브릭스) SDK 는 Apple 에서 Xcode 및 Swift 버전이 업데이트 될 때마다 SDK 를 업데이트하고 있습니다.
Xcode 를 업데이트한 후 디파이너리(애드브릭스) SDK 에서 Swift 버전을 지원하지 않는다는 알람이 노출된다면 Cocoapods 를 통해 SDK 를 업데이트 해 주시길 부탁드립니다.
SDK 업데이트는 아래와 같이 진행해 주시길 바랍니다.
SDK 업데이트 방법
a. 터미널을 열고 프로젝트 폴더로 이동합니다.
b. 터미널에 'pod update' 명령어를 입력하여 cocoapods 에 등록된 디파이너리(애드브릭스) SDK 를 최신 버전으로 업데이트 합니다.
※ 과거 버전의 Xcode 및 Swift 를 사용하는 경우
디파이너리(애드브릭스) SDK 는 Swift 를 통해 작성된 만큼 Apple 에서 Swift 버전을 업데이트 했다면, 디파이너리(애드브릭스) SDK 역시 최신 버전으로 업데이트해야 최신 버전의 Xcode 에서도 정상 동작합니다.
부득이하게 과거 버전의 Xcode 및 Swift 를 사용해야 한다면 디파이너리(애드브릭스) 의 서포트 엔지니어링 팀을 통해 가이드 받으시길 바랍니다.
_ 문의 등록 ('SDK 연동 및 기술문의가 있습니다.' 선택)