Game > Gamebase > Unity SDK ご利用ガイド > 初期化

Gamebase Unity SDKを使用するためには、まず初期化を行う必要があります。また、アプリID、アプリバージョン情報がNHN Cloudコンソールに必ず登録されていなければなりません。

GamebaseConfiguration

初期化する際に必要な設定は、次の通りです。

Setting value Supported Platform Mandatory(M) / Optional(O)
appID ALL M
appVersion ALL M
storeCode ALL M
displayLanguageCode ALL O
enablePopup ALL O
enableLaunchingStatusPopup ALL O
enableBanPopup ALL O
useWebViewLogin Standalone O

1. App ID

Gamebaseコンソールに登録されたプロジェクトIDです。

Game > Gamebase > コンソール使用ガイド > アプリ > App

2. appVersion

Gamebaseコンソールに登録したクライアントバージョンです。

Game > Gamebase > コンソール使用ガイド > アプリ > Client

3. storeCode

NHN Cloudの統合アプリ内決済サービスであるIAP(In-App Purchase)を初期化するために必要なストア情報です。

Store Code Description
App Store AS only iOS
Google Play GG only Android
ONE Store ONESTORE only Android
GALAXY Store GALAXY only Android
Huawei AppGallery HUAWEI only Android
My Card MYCARD only Android
Windows WIN only Unity Standalone
macOS MAC Standaloneに限る
Web WEB only Unity WebGL

4. displayLanguageCode

Gamebaseで提供するUI及びSystemDialogに表示される言語をデバイスに設定されている言語ではなく、ユーザーが設定した言語に変更することができます。

Game > Gamebase > Unity SDK使用ガイド > ETC > Additional Features > Display Language

5. enablePopup

システムメンテナンス、利用制限(ban)などゲームユーザーがゲームをプレイすることができない状況の場合、ポップアップなどで理由を表示しなければならないときがあります。 Gamebase SDKで提供する基本ポップアップを使用するかどうかに対する設定です。

  • true:enableLaunchingStatusPopup、enableBanPopupの設定によりポップアップをの表示するかどうかが決定されます。
  • false:Gamebaseで提供するすべてのポップアップが表示されません。
  • デフォルト:false

6. enableLaunchingStatusPopup

LaunchingStatusがゲームをプレイすることができない状態の場合、Gamebaseで提供する基本ポップアップを使用するかどうかに対する設定です。 LaunchingStatusは、次のLaunchingチャプターの下のState、Code部分をご参考ください。

  • デフォルト:true

7. enableBanPopup

ログインする際に該当するゲームユーザーが利用停止状態の場合、Gamebaseで提供する基本ポップアップを使用するかどうかに対する設定です。

  • デフォルト:true

8. useWebview

スタンドアローン(standalone)プラットフォームで、WebViewでログインするかどうかに対する設定です。

Debug Mode

  • Gamebaseは警告(warning)とエラーログだけを表示します。
  • 開発の参考にできるシステムログをオンにするには、Gamebase.SetDebugMode(true)を呼び出してください。

[注意]

ゲームをリリースする時は、必ずソースコードからSetDebugModeの呼び出しを削除するか、パラメータをfalseに変更してビルドしてください。

デバッグ設定はコンソールでも行えます。コンソールで設定された値を優先視します。 コンソール設定方法は、以下のガイドを参考にしてください。

API

Supported Platforms ■ UNITY_IOS ■ UNITY_ANDROID ■ UNITY_STANDALONE ■ UNITY_WEBGL ■ UNITY_EDITOR

static void SetDebugMode(bool isDebugMode)

Example

public void SetDebugModeSample(bool isDebugMode)
{
    Gamebase.SetDebugMode(isDebugMode);
}

Initialize

SDKを初期化します。

API

Supported Platforms ■ UNITY_IOS ■ UNITY_ANDROID ■ UNITY_STANDALONE ■ UNITY_WEBGL ■ UNITY_EDITOR

static void Initialize(GamebaseRequest.GamebaseConfiguration configuration, GamebaseCallback.GamebaseDelegate<GamebaseResponse.Launching.LaunchingInfo> callback)

Example

public class SampleInitialization
{
    public void Initialize()
    {
        /**
         * Show gamebase debug message.
         * set 'false' when build RELEASE.
         */
        Gamebase.SetDebugMode(true);

        /**
         * Gamebase Configuration.
         */
        var configuration = new GamebaseRequest.GamebaseConfiguration();
        configuration.appID = "appID";
        configuration.appVersion = "appVersion;"
        configuration.displayLanguageCode = GamebaseDisplayLanguageCode.English;
    #if UNITY_ANDROID
        configuration.storeCode = GamebaseStoreCode.GOOGLE;
    #elif UNITY_IOS
        configuration.storeCode = GamebaseStoreCode.APPSTORE;
    #elif UNITY_WEBGL
        configuration.storeCode = GamebaseStoreCode.WEBGL;
    #elif UNITY_EDITOR_OSX || UNITY_STANDALONE_OSX
        configuration.storeCode = GamebaseStoreCode.MACOS;
    #else
        configuration.storeCode = GamebaseStoreCode.WINDOWS;
    #endif

        /**
         * Gamebase Initialize.
         */
        Gamebase.Initialize(configuration, (launchingInfo, error) =>
        {
            if (Gamebase.IsSuccess(error) == true)
            {
                Debug.Log("Initialization succeeded.");

                //Following notices are registered in the Gamebase Console
                var notice = launchingInfo.launching.notice;
                if (notice != null)
                {
                    if (string.IsNullOrEmpty(notice.message) == false)
                    {
                        Debug.Log(string.Format("title:{0}", notice.title));
                        Debug.Log(string.Format("message:{0}", notice.message));
                        Debug.Log(string.Format("url:{0}", notice.url));
                    }
                }

                //Status information of game app version set in the Gamebase Unity SDK initialization.
                var status = launchingInfo.launching.status;

                // Game status code (e.g. Under maintenance, Update is required, Service has been terminated)
                // refer to GamebaseLaunchingStatus
                if (status.code == GamebaseLaunchingStatus.IN_SERVICE)
                {
                    // Service is now normally provided.
                }
                else
                {
                    switch (status.code)
                    {
                        case GamebaseLaunchingStatus.RECOMMEND_UPDATE:
                        {
                            // Update is recommended.
                            break;
                        }
                        // ... 
                        case GamebaseLaunchingStatus.INTERNAL_SERVER_ERROR:
                        {
                            // Error in internal server.
                            break;
                        }
                    }
                }
            }
            else
            {
                // Check the error code and handle the error appropriately.
                Debug.Log(string.Format("Initialization failed. error is {0}", error));

                if (error.code == GamebaseErrorCode.LAUNCHING_UNREGISTERED_CLIENT)
                {
                    GamebaseResponse.Launching.UpdateInfo updateInfo = GamebaseResponse.Launching.UpdateInfo.From(error);
                    if (updateInfo != null)
                    {
                        // Update is require.
                    }
                }
            }
        });
    }
}

Launching Information

InitializeAPIを使用してGamebase Unity SDKを初期化すると、LaunchingInfoの客体が結果値として送られます。 このLaunchingInfoの客体には、Gamebaseコンソールに設定した値やゲーム状態などが含まれています。

1. launching

Gamebaseの起動情報です。

1.1 status

Gamebase Unity SDKの初期化の設定に入力したアプリバージョンのゲームステータス情報です。

  • code:ゲームステータスコード(サービスをメンテナンス中です、アップデートが必ず必要です、サービスが終了しましたなど)
  • message:ゲームステータスメッセージ

ステータスコードは、次の表をご参考ください。

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:サーバーアドレス
    • csInfo:カスタマーセンターの情報
  • relatedUrls
    • termsUrl:利用規約
    • personalInfoCollectionUrl:個人情報同意
    • punishRuleUrl:利用停止規定
    • csUrl:カスタマーセンター
  • 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の場合、ゲームがメンテナンス状態の時、自動的にメンテナンスポップアップが表示されます。

ここで詳細表示ボタンをクリックするとメンテナンス情報が自動的にWebビューで表示されます。

この時に表示されるhtmlファイルを修正したい場合は、次のリンクのhtmlファイルをダウンロードして自由に修正した後、'Assets > StreamingAssets > Gamebase'フォルダに追加するとGamebase SDKに内蔵された基本htmlファイルの代わりにそのhtmlファイルを使用してメンテナンス情報を表示します。 htmlファイルダウンロードLINK

1.4 notice

Gamebaesコンソールに登録されたお知らせ情報です。

  • 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 Consoleでユーザーが入力した情報です。

  • ユーザーが入力した値をJSON stringで伝達します。
  • NHN Cloud Launchingの詳細設定は、下記のガイドを参照してください。

Game > Gamebase > コンソール使用ガイド > 管理 > Config

Get Launching Information

GetLaunchingInformations APIを利用すると、Initialize後もLaunchingInfoオブジェクトを取得できます。

[注意]

GetLaunchingInformations APIは、リアルタイムでサーバーから情報を取得する非同期APIではありません。 2分毎にアップデートされるキャッシュ情報を返すめ、リアルタイムで現在のメンテナンス状況を判断する用途には適していません。 このような場合にはLaunching Status Codeが変更されれ時にイベントが動作するGamebaseEventHandlerを活用してください。 Game > Gamebase > Unity SDK使用ガイド > ETC > Additional Features > Gamebase Event Handler > Observer

API

Supported Platforms ■ UNITY_IOS ■ UNITY_ANDROID ■ UNITY_STANDALONE ■ UNITY_WEBGL ■ UNITY_EDITOR

static GamebaseResponse.Launching.LaunchingInfo GetLaunchingInformations()

Example

public GamebaseResponse.Launching.LaunchingInfo GetLaunchingInformations()
{
    return Gamebase.Launching.GetLaunchingInformations();
}

Handling Unregistered Version

Gamebaseコンソールに登録されていないGameClientVersionを初期化するとLAUNCHING_UNREGISTERED_CLIENT(2004)エラーが発生します。 enablePopup(true), enableLaunchingStatusPopup(true)状態の場合、強制アップデートポップアップが表示され、マーケットに移動します。 Gamebaseポップアップを使用しない場合はマーケットURLのようなアップデート情報をGamebaseErrorオブジェクトから取得できます。

VO

public class UpdateInfo {
    // 最新バージョンをダウンロードできるストアインストールURL
    string installUrl;
    // ユーザーに表示されるメッセージで、ユーザーの端末言語に合わせて伝達されます。
    // 言語が「ja」の場合、メッセージは下記のとおりです。
    // 'サポートしないバージョンです。最新バージョンへアップデートしてください。'
    string message;
}

API

Supported Platforms ■ UNITY_IOS ■ UNITY_ANDROID ■ UNITY_STANDALONE ■ UNITY_WEBGL ■ UNITY_EDITOR

GamebaseResponse.Launching.UpdateInfo GamebaseResponse.Launching.UpdateInfo.From(GamebaseError error);

Example

public class SampleInitialization
{
    public void Initialize()
    {
        var configuration = new GamebaseRequest.GamebaseConfiguration();
        configuration.appID = "appID";
        configuration.appVersion = "appVersion;"
        configuration.displayLanguageCode = GamebaseDisplayLanguageCode.English;
    #if UNITY_ANDROID
        configuration.storeCode = GamebaseStoreCode.GOOGLE;
    #elif UNITY_IOS
        configuration.storeCode = GamebaseStoreCode.APPSTORE;
    #elif UNITY_WEBGL
        configuration.storeCode = GamebaseStoreCode.WEBGL;
    #elif UNITY_EDITOR_OSX || UNITY_STANDALONE_OSX
        configuration.storeCode = GamebaseStoreCode.MACOS;
    #else
        configuration.storeCode = GamebaseStoreCode.WINDOWS;
    #endif

        Gamebase.Initialize(configuration, (launchingInfo, error) =>
        {
            if (Gamebase.IsSuccess(error) == true)
            {
                // Gamebase initialization succeeded.
            }
            else
            {
                // Check the error code and handle the error appropriately.
                Debug.Log(string.Format("Initialization failed. error is {0}", error));

                if (error.code == GamebaseErrorCode.LAUNCHING_UNREGISTERED_CLIENT)
                {
                    GamebaseResponse.Launching.UpdateInfo updateInfo = GamebaseResponse.Launching.UpdateInfo.From(error);
                    if (updateInfo != null)
                    {
                        // Unregistered game client version.
                        // Open market url to update application.
                        string installUrl = updateInfo.installUrl; // Market URL.
                        string message updateInfo.message; // Message from launching server.
                    }
                }
            }
        });
    }
}

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 サポートしていない機能です。
  • エラーコードの一覧は、次の文書を参照してください。
目次
TOP