Game > Gamebase > Android SDK 사용 가이드 > 초기화

Gamebase Android SDK를 사용하려면 먼저 초기화를 진행해야 합니다.

onActivityResult

Gamebase의 정상적인 동작을 위해 반드시 Activity#onActivityResult(int, int, Intent)에서 Gamebase.onActivityResult(int, int, Intent)를 호출해야 합니다.

API

+ (void)Gamebase.onActivityResult(int requestCode, int resultCode, Intent data);

Initialization Flow

게임이 시작되면 Debug Mode 를 설정하고, Gamebase 를 초기화하여 Launching Status Code 에 따라 게임 진입여부를 결정하도록 아래 Flow 와 같이 구현하시면 됩니다.

initialization flow

Configuration Settings

Gamebase를 초기화할 때, GamebaseConfiguration.Builder 객체로 Gamebase 설정을 변경할 수 있습니다.

API Mandatory(M) / Optional(O) Description
newBuilder(String appId, String appVersion, String storeCode) M GamebaseConfiguration.Builder 객체는 newBuilder() 함수를 통해 생성할 수 있습니다.

appId는 NHN Cloud Project로 발급 받은 앱 ID를 입력합니다.
appVersion은 게임이 서비스 상태, 업데이트 상태 혹은 점검 상태 등에 해당하는지 판단하는 곳에 쓰입니다. 게임 버전을 지정해 주세요.
storeCode는 APK가 배포되는 스토어를 의미합니다. 스토어별 코드는 다음 가이드를 참고하시기 바랍니다. Purchase - Initialization
build() M 설정을 마친 Builder를 Configuration 객체로 변환합니다.
Gamebase.initialize() API에서 필요합니다.
enablePopup(boolean enable) O [UI]
시스템 점검, 이용 제재(ban) 등 게임 유저가 게임을 플레이할 수 없는 상황에서 팝업 창 등으로 사유를 표시해야 할 때가 있습니다.
true로 설정하면 Gamebase가 해당 상황에서 정보 팝업 창을 자동으로 표시합니다.
기본값은 false입니다.
false 상태에서는 론칭 결과를 통해 정보를 획득한 후 자체 UI를 구현해 게임을 플레이할 수 없는 이유를 표시해 주시기 바랍니다.
enableLaunchingStatusPopup(boolean enable) O [UI]
론칭 결과에 따라 로그인할 수 없는 상태에서(주로 점검 상태) Gamebase가 자동으로 팝업 창을 표시할지 여부를 변경할 수 있습니다.
enablePopup(true) 상태에서만 동작합니다.
기본값은 true입니다.
enableBanPopup(boolean enable) O [UI]
게임 유저가 이용 제재를 당한 상태일 때 Gamebase가 자동으로 제재 사유를 팝업 창으로 표시할지 여부를 변경할 수 있습니다.
enablePopup(true) 상태에서만 동작합니다.
기본값은 true입니다.

Debug Mode

  • Gamebase는 경고(warning)와 오류 로그만을 표시합니다.
  • 개발에 참고할 수 있는 시스템 로그를 켜려면 Gamebase.setDebugMode(true)를 호출하시기 바랍니다.

[주의]

게임을 릴리스할 때는 반드시 소스 코드에서 setDebugMode 호출을 제거하거나 파라미터를 false로 바꿔서 빌드하세요.

디버그 설정은 콘솔에서도 가능하며 콘솔에서 설정된 값을 우선시합니다. 콘솔 설정 방법은 아래 가이드를 참고하십시오.

Initialize

Activity#onCreate(Bundle)에서 Gamebase#initialize(Activity, GamebaseConfiguration, GamebaseDataCallback)을 호출하여 Gamebase SDK를 초기화합니다.

API

+ (void)Gamebase.initialize(Activity activity, GamebaseConfiguration configuration, GamebaseDataCallback<LaunchingInfo> callback);

Example

public class MainActivity extends AppCompatActivity {
    ...
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);

        /**
         * Show gamebase debug message.
         *
         * CAUTION!
         * Set 'false' when build RELEASE.
         */
        Gamebase.setDebugMode(true);

        /**
         * Gamebase Configuration.
         */
        String appId = "T0aStC1d";
        String appVersion = "1.0.0";
        String storeCode = "GG";
        GamebaseConfiguration configuration = GamebaseConfiguration.newBuilder(appId, appVersion, storeCode)
                .enablePopup(true)
                .build();
        /**
         * Gamebase Initialize.
         */
        Gamebase.initialize(activity, configuration, new GamebaseDataCallback<LaunchingInfo>() {
            @Override
            public void onCallback(final LaunchingInfo data, GamebaseException exception) {
                if (Gamebase.isSuccess(exception)) {
                    // 게임 진입을 허용할지 여부를 론칭 코드에 따라 판단하십시오.
                    ...
                } else {
                    // 초기화에 실패하면 Gamebase SDK를 이용할 수 없습니다.
                    // 오류를 표시하고 게임을 재시작 또는 종료해야 합니다.
                    Log.e(TAG, "Initialize failed- "
                            + "errorCode: " + exception.getCode()
                            + "errorMessage: " + exception.getMessage());
                }
            }
        });

        ...
    }
    ...

    @Override
    protected void onActivityResult(int requestCode, int resultCode, Intent data) {
        super.onActivityResult(requestCode, resultCode, data);

        /**
         * Pass onActivityResult event to the Gamebase.
         */
        Gamebase.onActivityResult(requestCode, resultCode, data);
        ...
    }
}

Launching Information

Gamebase#initialize 호출 결과로 론칭 상태를 확인할 수 있습니다.
론칭 코드에 따라 게임 플레이 여부를 판단하시기 바랍니다.

Gamebase.initialize(activity, configuration, new GamebaseDataCallback<LaunchingInfo>() {
    @Override
    public void onCallback(final LaunchingInfo data, GamebaseException exception) {
        if (Gamebase.isSuccess(exception)) {
            // 론칭 상태를 확인합니다.
            boolean canPlay = true;
            String errorLog = "";
            switch (launchingInfo.getStatus().getCode()) {
                case LaunchingStatus.IN_SERVICE:
                    break;
                case LaunchingStatus.RECOMMEND_UPDATE:
                    Log.d(TAG, "There is a new version of this application.");
                    break;
                case LaunchingStatus.IN_SERVICE_BY_QA_WHITE_LIST:
                case LaunchingStatus.IN_TEST:
                case LaunchingStatus.IN_REVIEW:
                case LaunchingStatus.IN_BETA:
                    Log.d(TAG, "You logged in because you are developer.");
                    break;
                case LaunchingStatus.REQUIRE_UPDATE:
                    canPlay = false;
                    errorLog = "You have to update this application.";
                    break;
                case LaunchingStatus.BLOCKED_USER:
                    canPlay = false;
                    errorLog = "You are blocked user!";
                    break;
                case LaunchingStatus.TERMINATED_SERVICE:
                    canPlay = false;
                    errorLog = "Game is closed!";
                    break;
                case LaunchingStatus.INSPECTING_SERVICE:
                case LaunchingStatus.INSPECTING_ALL_SERVICES:
                    canPlay = false;
                    errorLog = "Under maintenance.";
                    break;
                case LaunchingStatus.INTERNAL_SERVER_ERROR:
                default:
                    canPlay = false;
                    errorLog = "Unknown internal error.";
                    break;
            }
            if (canPlay) {
                // 게임 플레이를 시작합니다.
            } else {
                // 게임 불가 사유를 밝히고 게임을 중지합니다.
            }
        }
        ...
    }
});

getLaunchingInformations() API를 이용하면 초기화 이후에도 LaunchingInfo 객체를 획득할 수 있습니다.

[주의]

getLaunchingInformations() API 는 실시간으로 서버에서 정보를 가져오는 비동기 API가 아닙니다. 2분 주기로 업데이트 되는 캐시 정보를 반환하므로, 실시간으로 현재의 점검 여부를 판단하는 용도로는 적합하지 않습니다. 이런 경우에는 Launching Status Code가 변경되었을때 이벤트가 동작하는 GamebaseEventHandler 를 활용하시기 바랍니다. Game > Gamebase > Android SDK 사용 가이드 > ETC > Additional Features > Gamebase Event Handler > Observer

API

+ (LaunchingInfo)Gamebase.Launching.getLaunchingInformations();

LaunchingInfo 객체에는 Gamebase 콘솔에 설정한 값들과 게임 상태 등이 포함돼 있습니다.

1. launching

Gamebase 론칭 정보입니다.

1.1 status

Gamebase Android SDK 초기화 설정에 입력한 앱 버전의 게임 상태 정보입니다.

  • code: 게임 상태 코드(점검 중, 업데이트 필수, 서비스 종료 등)
  • message: 게임 상태 메시지

상태 코드는 아래 표를 참고하십시오.

Launching Status Code
Status Code Description
IN_SERVICE 200 정상 서비스 중
RECOMMEND_UPDATE 201 업데이트 권장
IN_SERVICE_BY_QA_WHITE_LIST 202 점검 중에는 서비스를 이용할 수 없지만 QA 단말기로 등록된 경우에는 점검과 상관없이 서비스에 접속해 테스트할 수 있습니다.
IN_TEST 203 테스트 중
IN_REVIEW 204 심사 중
IN_BETA 205 베타 서버 환경
REQUIRE_UPDATE 300 업데이트 필수
BLOCKED_USER 301 접속 차단으로 등록된 단말기(디바이스 키)로 서비스에 접속한 경우입니다.
TERMINATED_SERVICE 302 서비스 종료
INSPECTING_SERVICE 303 서비스 점검 중
INSPECTING_ALL_SERVICES 304 전체 서비스 점검 중
INTERNAL_SERVER_ERROR 500 내부 서버 오류

Game > Gamebase > 콘솔 사용 가이드 > 앱 > App

1.2 app

Gamebase 콘솔에 등록된 앱 정보입니다.

  • accessInfo
    • serverAddress: 서버 주소
  • customerService
    • accessInfo : 고객 센터 연락처
    • type : 고객 센터 유형
    • url : 고객 센터 URL
  • relatedUrls
    • termsUrl: 이용 약관
    • personalInfoCollectionUrl: 개인 정보 동의
    • punishRuleUrl: 이용 정지 규정
  • install: 설치 URL
  • idP: 인증 정보

Game > Gamebase > 콘솔 사용 가이드 > 앱 > Client

1.3 maintenance

Gamebase 콘솔에 등록된 점검 정보입니다.

  • url: 점검 페이지 URL
  • timezone: 표준 시간대(timezone)
  • beginDate: 시작 시간
  • endDate: 종료 시간
  • message: 점검 사유
  • hideDate: 점검 시작, 종료 시간을 표시할 것인지 여부

Game > Gamebase > 콘솔 사용 가이드 > 운영 > Maintenance

Change Default Maintenance HTML

enablePopup과 enableLaunchingStatusPopup 값이 모두 true인 경우, 게임이 점검 상태라면 자동으로 점검 팝업 창이 표시됩니다.

여기서 자세히 보기 버튼을 클릭하면 점검 정보가 자동으로 웹뷰로 표시됩니다.

이때 표시되는 html 파일을 수정하고 싶다면 다음 링크의 html 파일을 다운로드하여 원하는 대로 수정한 후 'assets/Gamebase' 폴더에 두면 Gamebase SDK에 내장된 기본 html 파일 대신 해당 html 파일을 사용하여 점검 정보를 표시하게 됩니다. html 파일 다운로드 LINK

1.4 notice

Gamebase 콘솔에 등록된 공지 정보입니다.

  • message: 메시지
  • title: 제목
  • url: 점검 URL

Game > Gamebase > 콘솔 사용 가이드 > 운영 > Notice

1.5 user

Gamebase 초기화를 실행한 사용자 정보입니다.

  • testDevice: 테스트 단말기 정보(Status가 200대일 경우에만 전달)
    • matchingFlag: 사용자 단말기가 Gamebase 콘솔에 설정된 테스트 단말기의 정보와 동일한지 여부
    • matchingTypes
      • 테스트 단말기 정보와 매칭된 타입
      • matchingFlag가 true일 경우에만 전달

2. tcProduct

Gamebase와 연계된 NHN Cloud 서비스의 앱키(Appkey)입니다.

  • gamebase
  • tcLaunching
  • iap
  • push

3. tcIap

NHN Cloud 콘솔에 등록된 IAP 스토어 정보입니다.

  • id: App ID
  • name: App Name
  • storeCode: Store Code

Game > Gamebase > 콘솔 사용 가이드 > 결제

4. tcLaunching

NHN Cloud Launching 콘솔에서 사용자가 입력한 정보입니다.

  • 사용자가 입력한 값을 JSON string으로 전달합니다.
  • NHN Cloud Launching 상세 설정은 아래 가이드를 참고하시기 바랍니다.

Game > Gamebase > 콘솔 사용 가이드 > 관리 > Config

Handling Unregistered Version

Gamebase 콘솔에 등록되지 않은 GameClientVersion 을 초기화를 하면 LAUNCHING_UNREGISTERED_CLIENT(2004) 에러가 발생합니다. enablePopup(true), enableLaunchingStatusPopup(true) 상태라면 강제 업데이트 팝업 창이 표시되고, 마켓으로 이동할 수 있습니다. Gamebase 팝업 창을 사용하지 않을 경우에는 UpdateInfo를 GamebaseException 객체로부터 얻어 사용자가 마켓으로 이동할 수 있도록 게임에서 직접 UI를 구현할 수 있습니다.

VO

class UpdateInfo {
    // 최신 버전을 다운로드 할 수 있는 스토어 설치 URL.
    String installUrl;
    // 사용자에게 노출할 수 있는 메시지로 사용자의 단말기 언어에 맞게 전달됩니다.
    // 만일 언어가 'en'인 경우 메시지는 아래와 같습니다.
    // 'The version is not supported. Please get the latest update version.'
    String message;
}

API

+ (UpdateInfo)UpdateInfo.from(GamebaseException exception);

Example

Gamebase.initialize(activity, configuration, new GamebaseDataCallback<LaunchingInfo>() {
    @Override
    public void onCallback(final LaunchingInfo data, GamebaseException exception) {
        if (Gamebase.isSuccess(exception)) {
            // Gamebase initialization succeeded.
        } else {
            // Gamebase initialization failed.

            UpdateInfo updateInfo = UpdateInfo.from(exception);
            if (updateInfo != null) {
                // Unregistered game client version.
                // Open market url to update application.
                updateInfo.installUrl; // Market URL.
                updateInfo.message;    // Message from launching server.
                return;
            }

            // Another initialization error.
            ...
        }
        ...
    }
});

Error Handling

Error Error Code Description
NOT_INITIALIZED 1 Gamebase 초기화돼 있지 않습니다.
NOT_LOGGED_IN 2 로그인이 필요합니다.
INVALID_PARAMETER 3 잘못된 파라미터입니다.
INVALID_JSON_FORMAT 4 JSON 포맷 오류입니다.
USER_PERMISSION 5 권한이 없습니다.
NOT_SUPPORTED 10 지원하지 않는 기능입니다.
NOT_SUPPORTED_ANDROID 11 Android에서 지원하지 않는 기능입니다.
ANDROID_ACTIVEAPP_NOT_CALLED 32 activeApp API가 호출되지 않았습니다.
  • 전체 오류 코드는 다음 문서를 참고하시기 바랍니다.
목차
TOP