- 인쇄
- PDF
Android SDK
- 인쇄
- PDF
Classic/VPC 환경에서 이용 가능합니다.
Android에서 게임을 개발하기 위한 GAMEPOT Android SDK 사용법에 대해 설명합니다. SDK를 설치하고 환경을 구성함으로써 게임과 대시보드를 연동할 수 있습니다.
요구 사양
Android용 GAMEPOT SDK를 사용하기 위한 요구 사양은 다음과 같습니다.
- 최소 사양: Android Level 24 이상
(하위 버전의 Android 지원이 필요하면 문의채널로 문의해 주시기 바랍니다. )
SDK 설치 및 환경 구성
Android SDK를 설치한 후 환경을 구성하여 GAMEPOT 대시보드와 게임을 연동하고 게임 개발에 필요한 기능을 사용할 수 있습니다.
GAMEPOT SDK에서 지원하는 언어는 아래와 같습니다.
- 한국어, 영어, 이탈리아어, 태국어 ,베트남어, 일본어, 중국어(간체/번체), 인도네시아어, 독일어, 스페인어, 프랑스어
앱 실행 시 디바이스 언어에 따라 SDK 내 지원 언어로 표기되며 미지원 언어는 영어로 표기됩니다.
SDK 설치
GAMEPOT Android SDK를 설치하고 프로젝트를 구성하는 방법은 다음과 같습니다.
- 관리자 계정으로 대시보드에 로그인해 주십시오.
- bundle.gradle 혹은 bundle.gradle.kts 파일에 Nbase SDK 를 추가해 주십시오.
- 게임팟 3.0 부터는 Gradle 설정을 통해 간단하게 외부 라이브러리와 통합이 가능합니다.
Kotlin Gradle 설정
- 프로젝트의 settings.gradle.kts 파일에 아래 정의를 추가합니다.
dependencyResolutionManagement {
repositories {
...
google()
// nbase repo
maven(url = "https://repo.nbase.io/repository/nbase-releases")
}
}
- 프로젝트에 (Module : app)의 build.gradle.kts 파일에 SDK 종속성을 추가합니다.
dependencies {
...
implementation("io.nbase:nbasesdk:latest.release")
}
예) 구글 로그인과 구글 스토어 결제를 사용하는 경우
dependencies {
...
implementation("io.nbase:nbasesdk:latest.release")
implementation("io.nbase:nbase-adapter-provider-google:latest.release")
implementation("io.nbase:nbase-adapter-billing-googleplay:latest.release")
}
Java Gradle 설정
- 프로젝트에 (Module : project)의 build.gradle 파일에 정의를 추가합니다.
allprojects {
repositories {
...
google()
// nbase repo
maven { url "https://repo.nbase.io/repository/nbase-releases" }
}
}
- 프로젝트에 (Module : app)의 build.gradle 파일에 SDK 종속성을 추가합니다.
dependencies {
...
implementation("io.nbase:nbasesdk:latest.release")
}
예) 구글 로그인과 구글 스토어 결제를 사용하는 경우
dependencies {
...
implementation("io.nbase:nbasesdk:latest.release")
implementation("io.nbase:nbase-adapter-provider-google:latest.release")
implementation("io.nbase:nbase-adapter-billing-googleplay:latest.release")
}
라이브러리 리스트
Name | Version | Description | Dependeny modules |
---|---|---|---|
io.nbase:nbasesdk | 3.0.84 | 게임팟 기본 모듈 | X |
io.nbase:nbase-adapter-provider-google | 3.0.8 | 구글 로그인 | X |
io.nbase:nbase-adapter-provider-apple | 3.0.4 | 애플 로그인 | |
io.nbase:nbase-adapter-provider-facebook | 3.0.4 | 페이스북 로그인 | com.facebook.android:facebook-login:latest.release |
io.nbase:nbase-adapter-provider-naver | 3.0.1 | 네이버 로그인 | |
io.nbase:nbase-adapter-provider-line | 3.0.1 | 라인 로그인 | |
io.nbase:nbase-adapter-provider-x | 3.0.1 | 트위터 로그인 | |
io.nbase:nbase-adapter-billing-googleplay | 3.0.5 | 구글 스토어 | com.android.billingclient:billing-ktx:6.1.0 |
io.nbase:nbase-adapter-billing-one | 3.0.1 | 원스토어 | |
io.nbase:nbase-adapter-billing-galaxy | 3.0.1 | 갤럭시 스토어 |
게스트 로그인의 경우 기본 모듈에 적용되어 있습니다.
사전 준비
- 프로젝트ID 와 프로젝트 키는 대시보드 > 프로젝트 설정에서 복사해 주십시오.
- 로그인, 스토어, 연동에 대한 환경 설정은 대시보드 > 프로젝트 설정에서 수행해 주십시오.
- 로그인별로 로그인 수단별 환경 설정을 참조하여, 콘솔에 설정하고 대시보드에 추가해 주십시오.
- 인앱 결제 시에 스토어별 환경 설정을 참조하여, 콘솔에 설정하고 대시보드에 추가해 주십시오.
- 인앱 결제를 위한 스토어마다 아이템을 등록해 주십시오. 대시보드 > 결제 > 인앱에서 추가해 주십시오.
초기화
초기화를 수행하려면 게임을 시작할 때 로드되는 첫 장면에 사용되는 개체에 아래 코드를 추가해 주십시오.
Kotlin:
import com.nbase.sdk.NBase
import com.nbase.sdk.Store
NBase.initialize(activity, projectId, projectKey, [StoreId], [language], [region]) { init, e ->
if (e != null) {
Log.e("NBase", e.message)
} else {
Log.e("NBase", init)
}
}
Java:
import com.nbase.sdk.NBase;
import com.nbase.sdk.Store;
NBase nBase = NBase.INSTANCE;
nBase.initialize(activity, projectId, projectKey, Store.GOOGLE, language, region, (init, e) -> {
if (e != null) {
Log.e("NBase", "initialize fail: " + e.getMessage());
} else {
Log.e("NBase", "initialize success: " + init.toString());
}
return null;
});
- Parameter
Key | Type | Description | Required |
---|---|---|---|
projectId | String | 프로젝트 ID (대시보드 → 프로젝트 설정) | O |
projectKey | String | 프로젝트 키 (대시보드 → 프로젝트 설정) | O |
storeId | String | 스토어 ID (아래 표 참고) | O |
language | String | 언어 (en,ko,jp...) | O |
region | String | 리전명 (kr, jp, sg, us, eu, preview) | O |
Key | Description |
---|---|
Store.GOOGLE | 구글 스토어 |
Store.ONE | 원스토어 |
Store.GALAXY | 갤럭시 스토어 |
Store.AMAZON | 아마존 스토어 |
Store.HUAWEI | 화웨이 스토어 |
- Callback
Key | Type | Description |
---|---|---|
status | Boolean | 상태 |
language | String | 언어 |
country | String | 국가 |
remote_ip | String | IP |
platform | String | 플랫폼 |
sandbox | Boolean | 샌드박스 여부 |
로그인
개발사에서 구현한 로그인 UI에 따라 로그인 버튼을 클릭했을 때 동작하는 SDK 로그인 기능을 사용하려면 아래 코드를 사용해 주십시오.
Kotlin:
import com.nbase.sdk.Provider
NBase.signIn(activity, Provider.GOOGLE.toString()) { user, e ->
if (e != null) {
Log.e("NBase", e.message)
} else {
Log.e("NBase", user)
}
}
override fun onActivityResult(requestCode: Int, resultCode: Int, data: Intent?) {
super.onActivityResult(requestCode, resultCode, data)
NBase.onActivityResult(requestCode, resultCode, data)
}
Java:
import com.nbase.sdk.Provider;
NBase nBase = NBase.INSTANCE;
nBase.signIn(activity, Provider.GOOGLE.toString(), (user, e) -> {
if (e != null) {
Log.e("NBase", "signIn fail: " + e.getMessage());
} else {
Log.e("NBase", "signIn success: " + user.toString());
}
return null;
});
@Override
protected void onActivityResult(int requestCode, int resultCode, Intent data) {
super.onActivityResult(requestCode, resultCode, data);
nBase.onActivityResult(requestCode, resultCode, data);
}
- Parameter
Key | Description |
---|---|
Provider.GOOGLE | 구글 |
Provider.ANONYMOUS | 게스트 |
Provider.FACEBOOK | 페이스북 |
Provider.APPLE | 애플 |
Provider.KAKAO | 카카오 |
Provider.PLAYGAME | 플레이게임 |
Provider.STEAM | 스팀 |
Provider.X | X |
Provider.LINE | 라인 |
Provider.NAVER | 네이버 |
Provider.GITHUB | 깃헙 |
Provider.MICROSOFT | 마이크로소프트 |
Provider.HUAWEI | 화웨이 |
- Callback
Key | Type | Description |
---|---|---|
id | String | 사용자 ID |
socialId | String | 소셜 ID |
name | String | 이름 |
nickname | String | 닉네임 |
String | 이메일 | |
token | String | 토큰 |
age | Int | 나이 |
birth | String | 생년월일 |
sex | String | 성별 |
profile | String | 프로필 URL |
mobile | String | 휴대폰 번호 |
customField | String | 사용자 정의 필드 |
자동 로그인 (옵션)
초기화 한 후에 마지막으로 로그인한 인증 수단으로 자동 로그인을 시도합니다.
Kotlin:
NBase.signInLastLoggedIn(activity) { user, e ->
if (e != null) {
Log.e("NBase", e.message)
} else {
Log.e("NBase", user)
}
}
Java:
NBase nBase = NBase.INSTANCE;
nBase.signInLastLoggedIn(activity, (user, e) -> {
if (e != null) {
Log.e("NBase", "signInLastLoggedIn fail: " + e.getMessage());
} else {
Log.e("NBase", "signInLastLoggedIn success: " + user.toString());
}
return null;
});
자체 아이디 비밀번호 인증하기 (옵션)
사용자가 이메일 주소와 비밀번호를 사용하여 로그인할 수 있게 하는 인증 메서드입니다. 사용자의 이메일 주소와 비밀번호를 기반으로 사용자 인증을 수행합니다. 이 기능은 전통적인 이메일/비밀번호 기반의 인증 시스템에서 중요한 역할을 합니다.
Kotlin:
NBase.signInWithPassword(activity, username, password) { user, e ->
if (e != null) {
Log.e("NBase", e.message)
} else {
Log.e("NBase", user)
}
}
Java:
NBase nBase = NBase.INSTANCE;
nBase.signInWithPassword(activity, username, password, (user, e) -> {
if (e != null) {
Log.e("NBase", "signInWithPassword fail: " + e.getMessage());
} else {
Log.e("NBase", "signInWithPassword success: " + user.toString());
}
return null;
});
자격 증명으로 로그인하기 (옵션)
다양한 인증 방법(이메일 및 비밀번호, 소셜 미디어 계정, 전화번호 등)을 통해 얻은 인증 자격 증명(credentials)으로 사용자 로그인을 처리하는 데 사용됩니다. 다양한 인증 방식을 쉽게 구현할 수 있도록 도와주며 게임팟에 로그인할 수 있도록 합니다.
Kotlin:
NBase.signInWithCredential(activity, Provider.GOOGLE.ToString(), providerToken) { user, e ->
if (e != null) {
Log.e("NBase", e.message)
} else {
Log.e("NBase", user)
}
}
Java:
NBase nBase = NBase.INSTANCE;
nBase.signInWithCredential(activity, Provider.GOOGLE.toString(), providerToken, (user, e) -> {
if (e != null) {
Log.e("NBase", "signInWithCredential fail: " + e.getMessage());
} else {
Log.e("NBase", "signInWithCredential success: " + user.toString());
}
return null;
});
로그아웃
SDK 로그아웃 기능을 사용하려면 아래 코드를 사용해 주십시오.
Kotlin:
NBase.signOut() { status, e ->
if (e != null) {
Log.e("NBase", e.message)
} else {
Log.e("NBase", status)
}
}
Java:
NBase nBase = NBase.INSTANCE;
nBase.signOut((status, e) -> {
if (e != null) {
Log.e("NBase", "signOut fail: " + e.getMessage());
} else {
Log.e("NBase", "signOut success: " + status);
}
return null;
});
- Callback
Key | Type | Description |
---|---|---|
status | Boolean | 성공 여부 |
결제
결제 전에 스토어별 환경 설정 에 해당 스토어에 맞도록 설정해야 합니다.
또한, 대시보드 > 결제 > 인앱에 아이템이 추가되지 않았을 있을 경우 'ProductID not found' 라는 오류가 발생됩니다.
인앱 정보 가져오기
결제하실 때에 화면에 결제 정보와 현지 통화 정보를 표시해야 합니다. 아래 함수를 통해서 현재 결제 통화나 이름 등을 가져올 수 있습니다. 만일 정상적으로 가져오지 못하는 경우 콘솔 세팅을 확인해 주시기 바랍니다.
Kotlin:
import com.nbase.sdk.Store
NBase.getProductItems() {products, e ->
if (e != null) {
Log.e("NBase", e.message)
} else {
// 인앱 아이템 정보
Log.e("NBase", products)
}
}
Java:
NBase nBase = NBase.INSTANCE;
nBase.getProductItems((products, e) -> {
if (e != null) {
Log.e("NBase", "getProductItems fail: " + e.getMessage());
} else {
if (products != null) {
Log.e("NBase", "getProductItems success: " + products.toString());
}
}
return null;
});
- Callback
Key | Type | Description |
---|---|---|
id | String | ID |
productName | String | 제품 이름 |
price | Float | 제품 가격 |
productId | String | 제품 고유 ID |
productType | String | 제품 타입 |
productDescription | String | 제품 설명 |
currency | String | 통화 단위 |
결제 요청
가져온 인앱 정보에 productId 로 결제를 요청하실 수 있습니다.
Kotlin:
import com.nbase.sdk.Store
NBase.purchase(activity, Store.GOOGLE, [productId], [metadata], [options]) { purchase, e ->
if (e != null) {
Log.e("NBase", e.message)
} else {
Log.e("NBase", purchase)
}
}
Java:
import com.nbase.sdk.Store;
NBase nBase = NBase.INSTANCE;
nbase.purchase(activity, Store.GOOGLE, productId, metadata, options, (purchase, e) -> {
if (e != null) {
Log.e("NBase", "purchase fail: " + e.getMessage());
} else {
if (purchase != null) {
Log.e("NBase", "purchase success: " + purchase.toString());
}
}
return null;
});
- Parameter
Key | Type | Description | Required |
---|---|---|---|
ProductId | String | 상품ID (대시보드 → 결제 → 인앱 아이템) | O |
Metadata | String | Metadata | X |
Options | String | 결제 옵션 기능 | X |
Key | Description |
---|---|
Store.GOOGLE | 구글 스토어 |
Store.ONE | 원 스토어 |
Store.GALAXY | 갤럭시 스토어 |
Store.AMAZON | 아마존 스토어 |
Store.HUAWEI | 화웨이 스토어 |
- Callback
Key | Type | Description |
---|---|---|
id | String | ID |
orderId | String | 주문 ID |
storeId | String | 스토어 ID |
productId | String | 상품 ID |
billingKey | String | 결제 키 |
signature | String | 서명 |
originalJson | String | 원본 JSON |
developerPayload | String | 개발자 페이로드 |
packageName | String | 패키지명 |
isAcknowledged | bool | 확인 여부 |
purchaseState | String | 구매 상태 |
purchaseTime | String | 구매 시간 |
quantity | String | 수량 |
recurringState | String | 반복 결제 상태 |
currency | String | 통화 |
country | String | 국가 |
paymentId | String | 결제 ID |
price | Float | 가격 |
iapVersion | String | 인앱결제 버전 |
playerId | String | 플레이어 ID |
serverId | String | 서버 ID |
level | Int | 레벨 |
userdata | String | 사용자 데이터 |
metadata | String | 메타데이터 |
options | String | 옵션 |
authCode | String | 인증 코드 |
문제 해결
Q. 안드로이드에서 아래와 같은 오류가 발생됩니다.
Caused by: java.lang.ClassNotFoundException: Didn't find class "androidx.security.crypto.MasterKeys" on path: DexPathList[[zip file "/data/app/~~KKBtt9efgPjpqDSP6o3P1g==/com.nbase.je_beta-6fz3RrA1gqu27fSFW0ehcQ==/base.apk"],nativeLibraryDirectories=[/data/app/~~KKBtt9efgPjpqDSP6o3P1g==/com.nbase.je_beta-6fz3RrA1gqu27fSFW0ehcQ==/lib/arm64, /system/lib64, /system/system_ext/lib64]]
A. MasterKeys 클래스를 찾지 못해서 발생한 오류로 아래 코드를 build.gradle 혹은 build.gradle.kt 파일에 입력 해주셔야 합니다.
implementation("androidx.security:security-crypto:1.0.0")
Q. 구글 로그인 시 아래와 같은 오류가 발생됩니다.
10: Developer console is not set up correctly.
A. 구글 Cloud 콘솔에 등록되어 있는 웹 어플리케이션의 OAuth 2.0 Client ID, Client Secret 가 모두 게임팟 대시보드에 정상적으로 기입되었을지 확인이 필요합니다.
Q. 구글 로그인 시 아래와 같은 오류가 발생됩니다.
16: Cannot find a matching credential.
A. 구글 Cloud 콘솔에 등록되어 있는 OAuth 2.0 안드로이드로 등록된 패키지와 앱의 SHA-1 값이 상이할 경우에도 발생합니다.