IMG-LOGO
XAds SDK 연동 가이드

Version : 1.1.1

Last Update : 2020. 06. 15

XAds SDK는 Maven 저장소를 통해 aar 형태로 배포되고 있습니다. 샘플 앱을 참조하실 경우 보다 쉽게 SDK를 연동하실 수 있습니다.


1. build.gradle(Project:) 설정

XAds SDK를 연동하기 위하여 build.gradle(Project:)파일을 실행 후 아래의 코드와 같이 maven 저장소 정보를 입력합니다.

...

allprojects{
	repositories{

		google()
		jcenter()
		
		maven{
			name "XAdsSDK"
			url "http://sdk.qwertlab.com/repository/internal"
		}
		
	}
}

...

			

2. build.gradle(Module:app) 설정

build.gradle(Module:app) 파일 실행 후 아래의 코드와 같이 XAds SDK 및 관련 라이브러리를 추가합니다.


dependencies{

	implementation fileTree(dir: 'libs', include: ['*.jar'])
	
	implementation 'androidx.legacy:legacy-support-v4:1.0.0'
	implementation 'androidx.recyclerview:recyclerview:1.1.0'
	implementation 'com.google.android.gms:play-services-ads:19.1.0'
	implementation 'com.xads.platform:XAdsSDK:1.1.1'
	

}

			

만약 귀사의 앱 프로젝트가 android x 버전을 지원하지 않을 경우 관리자에게 문의하시길 바랍니다.


3. AndroidManifest.xml 설정

API 레벨 29(Android 10) 이상을 타겟팅하는 경우 application 영역에 requestLegacyExternalStorage 속성 추가.


<application
	android:requestLegacyExternalStorage="true"
	android:allowBackup="true"
	android:icon="@mipmap/ic_launcher"
	android:label="@string/app_name"
	android:supportsRtl="true"
	android:theme="@style/AppTheme" 
	/>
			

항상 귀사의 앱이 실행될 수 있도록
MainActivity에 launchModeclearTaskOnLaunch 속성 추가.


<activity
	android:name=".MainActivity"
	android:launchMode="singleInstance"
	android:clearTaskOnLaunch="true"
	>
			


4. 연동 API 호출.

귀사의 메인 액티비티의 onCreate() Method에 파일 읽고/쓰기 권한이 있는지 확인 후 권한이 없을 경우 권한을 요청합니다.

@Override
protected void onCreate(Bundle savedInstanceState) {
	super.onCreate(savedInstanceState);
	setContentView(R.layout.activity_main);
	
	if(!XAdsPlatformManager.isXAdsPermission(this)) {
		XAdsPlatformManager.requestXAdsPermission(this);
	}
	
}
			

귀사의 메인 액티비티의 onResume() Method에서 권한이 있을 경우 연동 API를 호출

@Override
protected void onResume() {
	super.onResume();
	
	if(XAdsPlatformManager.isXAdsPermission(this)) {
		XAdsPlatformManager.initXAdsPlatform(this, "ChangeYourAgentKey");
	}
	
}
			

연동 API에 관한 보다 자세한 사항이나, XAds SDK에서 제공하고있는 다양한 API 정보는 API Document 페이지를 통해 확인하실 수 있습니다.
Agent key 정보를 발급 받지 못하셨다면 회원 가입 후 Agent Key 정보를 발급 받으셔야 합니다. (Agent Key 발급 방법)


5. 프로가드 설정

만약 귀사의 앱 프로젝트에서 프로가드를 사용중이시면 proguard-rules.pro 파일 실행 후 아래의 코드와 같이 예외처리를 진행합니다.

-keep com.xads.platform.**{*;}

6. 연동 확인.

App 프로젝트를 실행하여 아래의 그림과 같이 파일 읽고/쓰기 권한 획득 후 XAds SDK 이용 동의창 팝업이 정상적으로 출력되는지 확인합니다.

이용 동의창 출력 후 확인 버튼 선택 시 아래의 그림과 같이 Quick-Bar가 정상적으로 알림 창에 출력되는지 확인합니다.

이용 동의창이 출력되지 않거나, Quick-Bar가 정상적으로 생성되지 않을 경우 오류 해결 페이지를 통해 오류를 해결하실 수 있습니다.
연동 과정에 어려움 있거나 문의 사항이 있을 경우 관리자에게 문의 부탁드립니다.


* 담당자 김지훈 팀장
* email yahweh@qwertlab.com
* phone 010-8556-0220