ログイン・ログアウト

認証におけるログインは、次の順序で構成されます。

ログイン¶

認証におけるログインは、次の順序で構成されます。

1. 自動ログインおよび暗黙的ログイン
2. 明示的ログイン
3. デバイスにログインしているIdPアカウントの確認
4. ゲストログイン

Authv4Helper はログインに関連する一連のプロセスを実行し、応答値に応じて適切な画面に移動するように構成されたクラスです。 ログイン構成時には次の事項を参考にしてください。

自動ログインおよび暗黙的ログイン¶

自動ログイン¶

インプリシットログインは、ユーザーがログイン手段を選択せず、iOSのApple Game CenterアカウントまたはAndroidのGoogle Play Gamesアカウントに自動的にログインする方法です。自動ログインが失敗した後に実行されるインプリシットログインを実装します。

iOS環境で自動ログインを使用するには、Game Centerの権限を追加する必要があります。Unityでは、'Apple GameCenter'の依存関係をチェックしている場合、Unity PostProcessを通じて自動的に権限が追加されます。iOS Nativeでは、Xcodeが自動的にGame Centerの権限を追加します。

オフラインモード¶

Hive SDK v4 23.1.0 以上は、ユーザーのデバイスがネットワークに接続されていない場合でも、自動ログイン機能（AuthV4.signIn を ProviderType.AUTO で使用するか、または AuthV4.Helper.signIn）を提供します。オフラインモードを使用するには、以下の指示に従ってください:

1. アプリは少なくとも一度オンラインモードで実行され、明示的、暗黙的、ゲスト、またはカスタムログインが成功し、その結果、playerIdとplayerTokenが発行される必要があります。
   アプリ開発者の観点からは、オンライン状態でAuthV4.Helper.signIn、AuthV4.showSignIn、またはAuthV4.signInWithAuthKeyが少なくとも一度成功裏に実行され、コールバックを通じてplayerIdとplayerTokenが受信されている必要があります。ユーザーの観点からは、デバイスがネットワークに接続されている間にアプリに少なくとも一度成功裏にログインしている必要があります。ただし、ユーザーのアカウントがオンラインモードでの最後のログイン試行中に停止または制限されていた場合、オフラインモードでログインすることはできません。

2. Hiveコンソールでオフラインモードを有効にします。アプリセンター > プロジェクト管理 > ゲーム詳細 > Hive製品設定の下で。

Windowsでの自動ログイン¶

Windows環境では自動ログインがサポートされており、Hive コンソールアプリセンターで有効/無効を切り替えることができます。Windowsの自動ログインは、モバイル環境の自動ログインとは異なる動作をします。違いは次のとおりです:

• モバイル環境では、ユーザーは自動ログインによってログイン状態が維持されますが、Windowsでは「ログイン状態を保持する」チェックボックスを有効にした場合のみ保持されます（ログインUIのIdPリストの下に表示されます）。他の状況では、ログイン状態は継続しません。
• モバイル環境では、AuthV4Helper.Connectを実行して別のアカウントに切り替えると、新しくログインしたアカウントも自動ログインによってログイン状態が維持されますが、Windowsではそうではありません。

インプリシットログイン¶

• インプリシットログインのログインフロー

AuthV4.Helper.signInは、PlayerIDの認証トークンキーを使用して自動ログインを試みます。以前のログインから生成されたトークンキーが存在しない場合、ゲームはiOS用のApple Game CenterおよびAndroid用のGoogle Play Gamesに自動的にサインインします。サインインに失敗した場合、レスポンスに応じた適切なログインページを表示します。

自動ログインを実行するためのサンプルコードは以下の通りです。

// Attempt Hive SDK login (signIn)
AuthV4.Helper.signIn (delegate (ResultAPI result, AuthV4.PlayerInfo playerInfo) {

if (result.isSuccess()) {
// ログイン成功
} else if (result.needExit()) {
// TODO: アプリ終了機能を実装する
// 例) Application.Quit();
} else {
switch(result.code) {
case ResultAPI.Code.AuthV4ConflictPlayer:
// アカウントの競合
break;
case ResultAPI.Code.AuthV4HelperImplifiedLoginFail:
// 暗黙のログイン失敗
// 例) AuthV4.showSignIn(...);
break;
default:
// その他の例外
break;
}
}
});

#include "HiveAuthV4.h"

// 試み Hive SDK ログイン (サインイン)
FHiveAuthV4::Helper::SignIn(FHiveAuthV4HelperDelegate::CreateLambda([this](const FHiveResultAPI& Result, const TOptional<FHivePlayerInfo>& PlayerInfo) {
        if (Result.IsSuccess()) {
                //ログイン成功
        } else if (Result.NeedExit()) {
    // TODO: アプリ終了機能を実装する
// Cocos2d-xエンジンのユーザー
// 例) exit(0);
// Unrealエンジンのユーザー
// 例) UKismetSystemLibrary::QuitGame(GetWorld(), nullptr, EQuitPreference::Quit, false);
        } else {
                switch (Result.Code) {
                        case FHiveResultAPI::ECode::AuthV4ConflictPlayer:
                                // アカウントの競合
                                break;
                        case FHiveResultAPI::ECode::AuthV4HelperImplifiedLoginFail:
                                // 暗黙のログイン失敗
                                // 例) AuthV4.showSignIn(...);)
                                break;
                        default:
                                // その他の例外
                                break;
                }
        }
}));

// Attempt Hive SDK login (signIn)
AuthV4::Helper::signIn([=](ResultAPI const & result, std::shared\_ptr playerInfo) {

if (result.isSuccess()) {
// ログイン成功
} else if (result.needExit()) {
// TODO: アプリ終了機能を実装する
// Cocos2d-xエンジンのユーザー
// 例) exit(0);
// Unrealエンジンのユーザー
// 例) UKismetSystemLibrary::QuitGame(GetWorld(), nullptr, EQuitPreference::Quit, false);
} else {
switch(result.code) {
case ResultAPI::AuthV4ConflictPlayer:
// アカウントの競合
break;
case ResultAPI::AuthV4HelperImplifiedLoginFail:
// 暗黙のログインに失敗しました
// 例) AuthV4.showSignIn(...);
break;
default:
break;
}
}
});

// Attempt Hive SDK login (signIn)
AuthV4.Helper.signIn(object : AuthV4.Helper.AuthV4HelperListener {
    override fun onAuthV4Helper(result: ResultAPI, playerInfo: AuthV4.PlayerInfo?) {
        if (result.isSuccess) {
            // log-in succeed
        } else if (result.needExit()) {
            // TODO: implement app exit functionality
            // ex) exitProcess(0)
        } else {
            when (result.code) {
                ResultAPI.Code.AuthV4ConflictPlayer -> {
                    // account conflict
                }
                ResultAPI.Code.AuthV4HelperImplifiedLoginFail -> {
                    // implicit login failed
                    // ex) AuthV4.showSignIn(...);
                }
                else -> {
                    // other exceptions
                }
            }
        }
    }
})

// Attempt Hive SDK login (signIn)
AuthV4.Helper.signIn(new AuthV4.Helper.AuthV4HelperListener() {
    @Override
    public void onAuthV4Helper(ResultAPI result, AuthV4.PlayerInfo playerInfo) {

        if (result.isSuccess()) {
            // ログイン成功
        } else if (result.needExit()) {
            // TODO: アプリ終了機能を実装する
            // 例) System.exit(0);
        } else {
            switch(result.code) {
                case AuthV4ConflictPlayer:
                    // アカウントの競合
                    break;
                case AuthV4HelperImplifiedLoginFail:
                    // 暗黙のログインに失敗しました
                    // 例) AuthV4.showSignIn(...);
                    break;
                default:
                    // その他の例外
                    break;
            }
        }
    }
});

// Attempt Hive SDK ログイン (signIn)
AuthV4Interface.helper().signIn() { (result, playerInfo) in

    if result.isSuccess() {
        // ログイン成功
    }
    else if result.needExit() {
        // TODO: アプリ終了機能を実装
        // ex) exit(0)
    }
    else {
        switch result.getCode() {
        case .authV4ConflictPlayer:
            // アカウントの競合
        case .authV4HelperImplifiedLoginFail:
            // 暗黙のログイン失敗
            // ex) AuthV4Interface.showSignIn() { (result, playerInfo)
            // // 何かをする...
            // }
        default:
            // その他の例外
            break
        }
    }
}

// Attempt Hive SDK login (signIn)
[[HIVEAuthV4 helper] signIn:^(HIVEResultAPI *result, HIVEPlayerInfo *playerInfo) {

    if (result. isSuccess) {
        // ログイン成功
    }
    else if (result. needExit) {
        // TODO: アプリ終了機能を実装する
        // ex) exit(0);
    }
    else {
        switch(result.code) {
            case kAuthV4ConflictPlayer:
                // アカウントの競合
                break;
            case kAuthV4HelperImplifiedLoginFail:
                // 暗黙のログイン失敗
                // ex) [HIVEAuthV4 showSignIn:^(HIVEResultAPI *result, HIVEPlayerInfo *playerInfo) {
                // // 何かをする...
                // }];
                break;
            default:
                // その他の例外
                break;
        }
    }
}];

インプリシットログインの動作: モバイル¶

モバイルプラットフォーム（Hive SDK Unity Androidなど、Android/iOS）では、暗黙のログイン（AuthV4.Helper.signIn）がアカウントの競合を引き起こし、初回ログイン後に最後にログインしたアカウントでログインするかどうかを尋ねるダイアログをユーザーに表示します。

暗黙のログイン動作: PC¶

PCプラットフォーム（Hive SDK Unity Windowsなど、Windows）では、暗黙のログイン（AuthV4.Helper.signIn）が初回ログイン後に最後にログインしたアカウントで自動的にログインし、アカウントの競合を引き起こすことはありません。

明示的なログイン¶

明示的ログインとは、ユーザーが認証を進めるためにIdPを選択するプロセスを意味します。プレイヤーが自動ログインと暗黙のログインの両方を実行できなかった場合、ゲームを実装してプレイヤーをゲームタイトル画面に移動させ、タイトルをタップしたときに明示的ログインを実行させます。

明示的ログインは、認証に使用されるHive SDKを初期化した後に返されるIdPリストを使用して、Hive SDKによって提供されるUIまたはゲーム内でカスタマイズされたUIで構成されています。UIをカスタマイズする場合は、明示的ログインUIのカスタマイズを参照してください。

Hive プラットフォームは、各国のポリシーに従ってIdPリストを制御および提供します。例えば、Google Play Games、Facebook、ゲストログインは中国では利用できません。

明示的なログインの例画面¶

Hive SDKによって提供されるIdP選択UI

Hive SDKによって提供されたUIで関数を実装する際¶

Windows環境での自動ログイン¶

Windows環境でも自動ログインをサポートしており、Hive コンソールアプリセンターで有効化/無効化できます。ただし、Windowsの自動ログインはモバイルとは異なる動作をします。Windowsでの自動ログインには次のような違いがあります。

• モバイルではログイン後に必ず自動ログインでログイン状態を維持しますが、Windowsではユーザーがログイン維持チェックボックス（ログインUI上でIdPリストの下に表示）を有効にした場合にのみログインを維持します。それ以外の状況ではログインを維持しません。
• AuthV4Helper.Connect 実行時にモバイルでは新しいアカウントに切り替える場合、新しいアカウントも自動ログイン状態を維持しますが、Windowsでは新しいアカウントに切り替える場合、新しいアカウントは自動ログイン状態を維持しません。

暗黙のログイン¶

• 暗黙のログインフロー

AuthV4.Helper.signInはPlayerIDの認証トークンキーを利用して自動ログインを試みます。既にログインしていた認証トークンキーがない場合、iOSの場合はApple Game Centerに、Androidの場合はGoogle Playゲームに自動的にログインします。ログインに失敗した場合は、応答値に応じて適切なログイン画面を構成します。

次は自動ログインを実行する例のコードです。

// Hive SDK 로그인(signIn) 시도    
    AuthV4.Helper.signIn (delegate (ResultAPI result, AuthV4.PlayerInfo playerInfo) {    

    if (result.isSuccess()) {    
        // ログイン成功    
    } else if (result.needExit()) {    
        // TODO: アプリ終了機能を実装してください    
        // 例) Application.Quit();    
    } else {    
        switch (result.code) {    
            case ResultAPI.Code.AuthV4ConflictPlayer:    
                // アカウントの衝突    
                break;    
            case ResultAPI.Code.AuthV4HelperImplifiedLoginFail:    
                // 暗黙的なログインに失敗                   
                // 例) AuthV4.showSignIn(...);    
                break;    
            default:    
                // その他の例外状況    
                break;    
        }    
    }    
});

#include "HiveAuthV4.h"

// Hive SDK ログイン(signIn) 試行
FHiveAuthV4::Helper::SignIn(FHiveAuthV4HelperDelegate::CreateLambda([this](const FHiveResultAPI& Result, const TOptional<FHivePlayerInfo>& PlayerInfo) {
        if (Result.IsSuccess()) {
                // ログイン成功
        } else if (Result.NeedExit()) {
                // TODO: アプリ終了機能を実装してください
                // 例) UKismetSystemLibrary::QuitGame(GetWorld(), nullptr, EQuitPreference::Quit, false);
        } else {
                switch (Result.Code) {
                        case FHiveResultAPI::ECode::AuthV4ConflictPlayer:
                                // アカウントの衝突
                                break;
                        case FHiveResultAPI::ECode::AuthV4HelperImplifiedLoginFail:
                                // 暗黙のログインに失敗
                                // ex) FHiveAuthV4::ShowSigIn()
                                break;
                        default:
                                // その他の例外状況
                                break;
                }
        }
}));

// Hive SDK 로그인(signIn) 시도    
    AuthV4::Helper::signIn([=](ResultAPI const & result, std::shared_ptr playerInfo) {    

    if (result.isSuccess()) {    
        // ログイン成功    
    } else if (result.needExit()) {    
        // TODO: アプリ終了機能を実装してください              
        // Cocos2d-x エンジンユーザー    
        // 例) exit(0);    
        // Unreal エンジンユーザー    
        // 例) UKismetSystemLibrary::QuitGame(GetWorld(), nullptr, EQuitPreference::Quit, false);    
    } else {    
        switch (result.code) {    
            case ResultAPI::AuthV4ConflictPlayer:    
                // アカウント衝突    
                break;    
            case ResultAPI::AuthV4HelperImplifiedLoginFail:    
                // 暗黙的ログインに失敗    
                // 例) AuthV4.showSignIn(...);    
                break;    
            default:    
                break;    
        }    
    }    
});

// Hive SDK ログイン(signIn) 試行    
 AuthV4.Helper.signIn(object : AuthV4.Helper.AuthV4HelperListener {
    override fun onAuthV4Helper(result: ResultAPI, playerInfo: AuthV4.PlayerInfo?) {
            if (result.isSuccess) {
                    // ログイン成功
            } else if (result.needExit()) {
                    // TODO: アプリ終了機能を実装してください
                    // 例) exitProcess(0)
            } else {
                    when (result.code) {
                            ResultAPI.Code.AuthV4ConflictPlayer -> {
                                    // アカウントの衝突
                            }
                            ResultAPI.Code.AuthV4HelperImplifiedLoginFail -> {
                                    // 暗黙のログインに失敗
                                    // 例) AuthV4.showSignIn(...);
                            }
                            else -> {
                                    // その他の例外状況
                            }
                    }
            }
    }
    })

// Hive SDK AuthV4 인증 UI 요청    
    AuthV4.showSignIn(new AuthV4.AuthV4SignInListener() {    
    @Override    
    public void onAuthV4SignIn(ResultAPI result, AuthV4.PlayerInfo playerInfo) {    

        if (result.isSuccess()) {    
            // 認証成功    
            // playerInfo: 認証されたユーザー情報    
            // メール情報取得の例    
            if(playerInfo != null) {    
                for (Map.Entry<AuthV4.ProviderType, AuthV4.ProviderInfo> entry : playerInfo.getProviderInfoData().entrySet()) {    
                    AuthV4.ProviderInfo providerInfo = entry.getValue();    
                    if (providerInfo.getProviderEmail() != "") {    
                        String email = providerInfo.getProviderEmail();    
                        break;    
                    }    
                }    
            }    
        }    
        else if (result.needExit()) {    
            // TODO: アプリ終了機能を実装してください    
            // 例) System.exit(0);    
        }    
    }    
});

var email = String()    
    // Hive SDK AuthV4 인증 UI 요청    
    AuthV4Interface.showSignIn { (result, playerInfo) in    

    if result.isSuccess() {    
        // 認証成功    
        // playerInfo: 認証されたユーザー情報    
        // メール情報取得の例    
        if let playerInfo = playerInfo {    
            // providerEmailが存在するproviderInfoを探索 (現在ログイン中のprovider)    
            for key in playerInfo.providerInfoData.keys {    
                if let providerInfo = playerInfo.providerInfoData[key],    
                    providerInfo.providerEmail.count > 0 {    
                    // providerEmail != ""    
                    email = providerInfo.providerEmail    
                    break    
                }    
            }    
        }    
    } else if result.needExit() {    
        // TODO: アプリ終了機能を実装してください    
        // 例) exit(0)    
    }    
}

// Hive SDK ログイン(signIn) 試行    
[[HIVEAuthV4 helper] signIn:^(HIVEResultAPI *result, HIVEPlayerInfo *playerInfo) {

        if (result.isSuccess) {
                // ログイン成功 
        }
        else if (result.needExit) {
                // TODO: アプリ終了機能を実装してください
                // 例) exit(0);
        }
        else {
                switch (result.code) {
                        case kAuthV4ConflictPlayer:
                                // アカウントの衝突
                                break;    
                        case kAuthV4HelperImplifiedLoginFail:
                                // 暗黙のログインに失敗
                                // ex) [HIVEAuthV4 showSignIn:^(HIVEResultAPI *result, HIVEPlayerInfo *playerInfo) {
                                // // 何かをする...
                                // }];
                                break;
                        default:
                                // その他の例外状況
                                break;   
                }
        }
        }];

暗黙のログイン動作: モバイル¶

モバイル（Hive SDK Unity AndroidなどのAndroid/iOSプラットフォーム）における暗黙のログイン（AuthV4.Helper.signIn）は、最初のログイン後に他のアカウントでログインする場合、アカウントの衝突状況が発生し、最後にログインしたアカウントでログインするかどうかをユーザーに尋ねるウィンドウを表示します。

暗黙のログイン動作: PC¶

PC（Hive SDK Unity WindowsなどのWindowsプラットフォーム）での暗黙のログイン（AuthV4.Helper.signIn）は、最初のログイン後に別のアカウントでログインする場合、最後にログインしたアカウントに自動的にログインします。アカウントの衝突状況は発生しません。

明示的ログイン¶

明示的ログインとは、ユーザーが認証を行うIdPを選択して進めることを意味します。自動ログインと暗黙的ログインの両方が失敗した場合、ゲームタイトル画面に移動した後、タイトルでクリックしたときに明示的ログインを実行するように実装してください。

明示的ログインUIは、Hive SDKが提供するUIを使用することも、Hive SDKの初期化が完了した後に結果として返される認証に使用するIdPリストを利用してゲーム自体の実装でカスタマイズすることもできます。UIをカスタマイズする場合は、明示的ログインカスタマイズ項目を参照してください。

IdPリストは各国の政策に従ってHiveプラットフォームで制御され提供されます。例えば、中国ではGoogle PlayゲームやFacebook、ゲストは提供されません。

明示的なログインのスクリーンショット¶

SDKが提供するIdP選択UI

SDKが提供するUIを使用して実装する場合¶

SDKで提供されるUIを使用して明示的なログインを実装するには、showSignIn()メソッドを呼び出してIdPリストUIを簡単に呼び出すことができます。

// Hive SDK AuthV4 認証 UI リクエスト
AuthV4.showSignIn((ResultAPI result, AuthV4.PlayerInfo playerInfo)=>{
if (result.isSuccess()) {
        // 認証成功
        // playerInfo : 認証されたユーザー情報

        // メール情報取得の例
        foreach (KeyValuePair<AuthV4.ProviderType, AuthV4.ProviderInfo> entry in playerInfo.providerInfoData) {

                AuthV4.ProviderInfo providerInfo = entry.Value;
                if(providerInfo.providerEmail != null && providerInfo.providerEmail != "") {
                        string email = providerInfo.providerEmail;
                        break;
                }
        }
}
else if (result.needExit()) {
        // TODO: アプリ終了機能を実装してください
        // 例) Application.Quit();
}
});

#include "HiveAuthV4.h"

// Hive SDK AuthV4 認証 UI リクエスト
FHiveAuthV4::ShowSignIn(FHiveAuthV4OnSignInDelegate::CreateLambda([this](const FHiveResultAPI& Result, const FHivePlayerInfo& PlayerInfo) {
        if (Result.IsSuccess()) {
                // 認証成功 (PlayerInfo: 認証されたユーザー情報) 

                // メール情報取得の例
                for (const auto& ProviderInfoEntry : PlayerInfo.ProviderInfoData) {
                        FHiveProviderInfo ProviderInfo = ProviderInfoEntry.Value;
                        FString Email = ProviderInfo.ProviderEmail;
                }
        } else if (Result.NeedExit()) {
                // TODO: アプリ終了機能を実装してください
                // 例) UKismetSystemLibrary::QuitGame(GetWorld(), nullptr, EQuitPreference::Quit, false);
        }
}));

// Hive SDK AuthV4 인증 UI 요청
AuthV4::showSignIn([=](ResultAPI const & result, PlayerInfo const & playerInfo) {
if (result.isSuccess()) {
        // 인증 성공
        // playerInfo: 인증된 사용자 정보

        // メール情報取得の例
        for(auto it = playerInfo.providerInfoData.begin(); it != playerInfo.providerInfoData.end(); ++it) {
                hive::ProviderInfo providerInfo = it->second;
                if(!providerInfo.providerEmail.empty()) {
                        std::string email = providerInfo.providerEmail;
                        break;
                }
        }
}
else if (result.needExit()) {
        // TODO: アプリ終了機能を実装してください
        // Cocos2d-xエンジンユーザー
        // 例) exit(0);
        // Unrealエンジンユーザー
        // 例) UKismetSystemLibrary::QuitGame(GetWorld(), nullptr, EQuitPreference::Quit, false);
}
});

// Hive SDK AuthV4 인증 UI 요청
AuthV4.showSignIn(object : AuthV4.AuthV4SignInListener {
override fun onAuthV4SignIn(result: ResultAPI, playerInfo: AuthV4.PlayerInfo?) {
        if (result.isSuccess) {
                // 認証成功
                // playerInfo: 認証されたユーザー情報

                // メール情報取得の例
                playerInfo?.let {
                        for ((key, value) in it.providerInfoData) {
                                var providerInfo: AuthV4.ProviderInfo = value
                                if(providerInfo.providerEmail.isNotEmpty()) {
                                        val email = providerInfo.providerEmail
                                        break
                                }
                        }
                }
        } else if (result.needExit()) {
                // TODO: アプリ終了機能を実装してください
                // 例) exitProcess(0)
        }
}
})

// Hive SDK AuthV4 인증 UI 요청
AuthV4.showSignIn(new AuthV4.AuthV4SignInListener() {
@Override
public void onAuthV4SignIn(ResultAPI result, AuthV4.PlayerInfo playerInfo) {

        if (result.isSuccess()) {
                // 認証成功
                // playerInfo: 認証されたユーザー情報

                // メール情報取得の例
                if(playerInfo != null) {
                        for (Map.Entry<AuthV4.ProviderType, AuthV4.ProviderInfo> entry : playerInfo.getProviderInfoData().entrySet()) {
                                AuthV4.ProviderInfo providerInfo = entry.getValue();
                                if (providerInfo.getProviderEmail() != "") {
                                        String email = providerInfo.getProviderEmail();
                                        break;
                                }
                        }
                }
        }
        else if (result.needExit()) {
                // TODO: アプリ終了機能を実装してください
                // 例) System.exit(0);
        }
}
});

var email = String()

// Hive SDK AuthV4 認証 UI リクエスト
AuthV4Interface.showSignIn { (result, playerInfo) in

if result.isSuccess() {
        // 認証成功
        // playerInfo: 認証されたユーザー情報

        // メール情報取得の例
        if let playerInfo = playerInfo {
                // providerEmailが存在するproviderInfoを探索（現在ログイン中のprovider）
                for key in playerInfo.providerInfoData.keys {
                        if let providerInfo = playerInfo.providerInfoData[key],
                                providerInfo.providerEmail.count > 0 {
                                // providerEmail != ""
                                email = providerInfo.providerEmail
                                break
                        }
                }
        }
} else if result.needExit() {
        // TODO: アプリ終了機能を実装してください
        // 例) exit(0)
}
}

__block NSString* email = @"";

// Hive SDK AuthV4 認証 UI リクエスト
[HIVEAuthV4 showSignIn:^(HIVEResultAPI *result, HIVEPlayerInfo *playerInfo) {

if([result isSuccess]){
        // 認証成功
        // playerInfo: 認証されたユーザー情報

        // メール情報取得の例
        if(playerInfo != nil) {
                // providerEmailが存在するproviderInfoを探索（現在ログイン中のprovider）
                for (NSString* key in playerInfo.providerInfoData.allKeys) {
                        HIVEProviderInfo* providerInfo = playerInfo.providerInfoData[key];
                        if (providerInfo != nil && providerInfo.providerEmail.length > 0) {
                                // providerEmail != ""
                                email = providerInfo.providerEmail;
                                break;
                        }
                }
        }
} else if ([result needExit]) {
        // TODO: アプリ終了機能を実装してください
        // 例) exit(0);
}
}];

明示的ログインカスタマイズ¶

明示的なログインのカスタマイズUIは、providerTypeListを利用して実装できます。providerTypeListは、Hive SDKを初期化する目的でAuthV4.setup()メソッドを呼び出すか、初期化後にAuthV4.Helper.getIDPList()メソッドを呼び出したときに返される応答コールバックハンドラーです。ゲームUIに合わせてログイン画面を表示したり、特定のIdPとの連携のみを主に表示したい場合にこの機能を使用します。カスタマイズUIを実装した後は、ユーザーのアクションに応じて希望するProviderTypeでsignIn()メソッドを呼び出してログインを実装してください。

• ログイン画面にFacebook連携ボタンのみを表示するUIの例スクリーンショット

次はカスタマイズされた明示的なログインUIでユーザーがGoogleログインを選択した状況を仮定した例のソースです。

using hive;    
    AuthV4.signIn(AuthV4.ProviderType.GOOGLE, (ResultAPI result, AuthV4.PlayerInfo playerInfo) => {    
        if (result.isSuccess()) {    
            // 呼び出し成功    
            // playerInfo : 認証されたユーザー情報。    
            // ProviderType.GOOGLEのメール情報取得例    
            Dictionary<AuthV4.ProviderType, AuthV4.ProviderInfo> providerInfoData = playerInfo.providerInfoData;    
            AuthV4.ProviderInfo providerInfo = providerInfoData[AuthV4.ProviderType.GOOGLE];    
            string email = providerInfo.providerEmail;    
        }    
});

#include "HiveAuthV4.h"

FHiveAuthV4::SignIn(EHiveProviderType::GOOGLE,
                                        FHiveAuthV4OnSignInDelegate::CreateLambda([this](const FHiveResultAPI& Result, const FHivePlayerInfo& PlayerInfo) {

        if (Result.IsSuccess()) {
                // 呼び出し成功 (PlayerInfo: 認証されたユーザー情報)

                // EHiveProviderType::GOOGLE のメール情報取得の例
                TMap<EHiveProviderType, FHiveProviderInfo> ProviderInfoData = PlayerInfo.ProviderInfoData;
                if (const FHiveProviderInfo* ProviderInfo = ProviderInfoData.Find(EHiveProviderType::GOOGLE)) {
                        FString Email = ProviderInfo->ProviderEmail;
                }
        }
}));

#include <HIVE_SDK_Plugin/HIVE_CPP.h>    
    AuthV4::signIn(ProviderType::GOOGLE, [=](ResultAPI const & result, PlayerInfo const & playerInfo) {    
        if (result.isSuccess()) {    
            // 呼び出し成功    
            // playerInfo : 認証されたユーザー情報。

            // ProviderType::GOOGLEのメール情報取得例    
            map<ProviderType, ProviderInfo> providerInfoData = playerInfo.providerInfoData;    
            ProviderInfo providerInfo = providerInfoData[ProviderType::GOOGLE];    
            string email = providerInfo.providerEmail;    
        }    
});

import com.hive.AuthV4    
    import com.hive.ResultAPI    
    AuthV4.signIn(AuthV4.ProviderType.GOOGLE, object : AuthV4.AuthV4SignInListener {    
        override fun onAuthV4SignIn(result: ResultAPI, playerInfo: AuthV4.PlayerInfo?) {    
            if (result.isSuccess) {    
                // 呼び出し成功    
                // playerInfo: 認証されたユーザー情報    
                // ProviderType.GOOGLE のメール情報取得例    
                if (playerInfo != null) {    
                    val providerInfoData = playerInfo.providerInfoData    
                    val providerInfo = providerInfoData[AuthV4.ProviderType.GOOGLE]    
                    if (providerInfo != null) {    
                        val email = providerInfo.providerEmail    
                    }    
                }    
            }    
        }    
})

import com.hive.AuthV4;    
    import com.hive.ResultAPI;    
    AuthV4.INSTANCE.signIn(AuthV4.ProviderType.GOOGLE, (result, playerInfo) -> {    
        if (result.isSuccess()) {    
            // 呼び出し成功    
            // playerInfo: 認証されたユーザー情報    
            // ProviderType.GOOGLE のメール情報取得例    
            if (playerInfo != null) {    
                HashMap<AuthV4.ProviderType, AuthV4.ProviderInfo> providerInfoData = playerInfo.getProviderInfoData();    
                AuthV4.ProviderInfo providerInfo = providerInfoData.get(AuthV4.ProviderType.GOOGLE);    
                if (providerInfo != null) {    
                    String email = providerInfo.getProviderEmail();    
                }    
            }    
        }    
});

import HIVEService    
    AuthV4Interface.signIn(.Google) { result, playerInfo in    
        if result.isSuccess() {    
            // 呼び出し成功    
            // playerInfo: 認証されたユーザー情報。    

            // .Googleのメール情報取得の例    
            if     
                let playerInfo = playerInfo,    
                let providerInfo = playerInfo.providerInfoData["GOOGLE"] {    
                    let email = providerInfo.providerEmail    
            }    
        }    
}

#import <HIVEService/HIVEService-Swift.h>    
    [HIVEAuthV4 signIn:HIVEProviderTypeGoogle handler:^(HIVEResultAPI *result, HIVEPlayerInfo *playerInfo) {    
        if ([result isSuccess]){    
            // 呼び出し成功    
            // playerInfo: 認証されたユーザー情報.    

            // HIVEProviderTypeGoogleのメール情報取得例    
            if(playerInfo != nil) {    
                HIVEProviderInfo *providerInfo = playerInfo.providerInfoData[@"GOOGLE"];    
                if(providerInfo != nil){    
                    NSString *email = providerInfo.providerEmail;    
                }    
            }    
        }    
}];    

デバイスにログインしたIdPアカウントの確認¶

自動ログインは保存されたPlayerIDの認証トークンキーのみでログインし、明示的ログインは複数のIdPに連携されたアカウントにログインします。この2つの場合、ログインしたPlayerIDのIdPアカウントと実際のデバイスにログインしたIdPアカウント（DevicePlayer）が異なる可能性があります。将来的な実績やリーダーボードの使用に備えて、2つのアカウントを統一できるように案内文を提供します。

• SDKが提供するDevicePlayerの使用有無確認UI

次はIdP情報を確認する例のコードです。

using hive;    
    AuthV4.ProviderType providerType = AuthV4.ProviderType.GOOGLE;     
    AuthV4.Helper.syncAccount (providerType, delegate (ResultAPI result, AuthV4.PlayerInfo playerInfo) {    

        switch (result.code) {    
            case ResultAPI.Code.Success:    
                // 正常    
                break;    
            case ResultAPI.Code.AuthV4ConflictPlayer:    
                // アカウントの衝突    
                // ex) Hive UI 使用時     
                // AuthV4.Helper.showConflict(...);    
                // or    
                // ex) GameUI 実装時    
                // AuthV4.Helper.resolverConflict(...);// 現在のユーザー選択時    
                // AuthV4.Helper.switchAccount(...);// ユーザー切替選択時    
                break;    
            default:    
                // その他の例外状況    
                break;    
        }    
});

#include "HiveAuthV4.h"

FHiveAuthV4::Helper::SyncAccount(ProviderType, FHiveAuthV4HelperDelegate::CreateLambda([this](const FHiveResultAPI& Result, const TOptional<FHivePlayerInfo>& PlayerInfo) {

        switch (Result.Code) {
                case FHiveResultAPI::ECode::Success:
                        // 正常な応答
                        break;
                case FHiveResultAPI::ECode::AuthV4ConflictPlayer:
                        // アカウントの衝突
                        // 例) Hive UI 使用時
                        // FHiveAuthV4::Helper::ShowConflict()
                        // 例) Game UI 実装時
                        // FHiveAuthV4::Helper::ResolveConflict() // 現在のユーザー選択
                        // FHiveAuthV4::Helper::SwitchAccount() // ユーザー切替選択
                        break;
                default:
                        // その他の例外状況
                        break;
        }
}));

#include <HIVE_SDK_Plugin/HIVE_CPP.h>    
    using namespace std;    
    using namespace hive;    
    ProviderType providerType = ProviderType::GOOGLE;    
    AuthV4::Helper::syncAccount(providerType, [=](ResultAPI const & result, shared_ptr<PlayerInfo> playerInfo) {    

        switch (result.code) {    
          case ResultAPI::Success:    
            // 正常    
            break;    
          case ResultAPI::AuthV4ConflictPlayer:    
            // アカウントの衝突    
            // 例) Hive UI 使用時     
            // AuthV4::Helper::showConflict(...);    
            // または    
            // 例) GameUI 実装時    
            // AuthV4::Helper::resolverConflict(...);// 現在のユーザー選択時    
            // AuthV4::Helper::switchAccount(...);// ユーザー切り替え選択時    
            break;    
          default:    
            // その他の例外状況    
            break;    
         }        
});

import com.hive.AuthV4    
    import com.hive.ResultAPI    
    val providerType = AuthV4.ProviderType.GOOGLE    
    AuthV4.Helper.syncAccount(providerType, object : AuthV4.Helper.AuthV4HelperListener {    
        override fun onAuthV4Helper(result: ResultAPI, playerInfo: AuthV4.PlayerInfo?) {    
            when (result.code) {    
                ResultAPI.Code.Success -> {    
                    // 正常    
                }    
                ResultAPI.Code.AuthV4ConflictPlayer -> {    
                    // アカウントの衝突    
                    // ex) Hive UI 使用時    
                    // AuthV4.Helper.showConflict(...);    
                    // or    
                    // ex) GameUI 実装時    
                    // AuthV4.Helper.resolverConflict(...);// 現在のユーザー選択時    
                    // AuthV4.Helper.switchAccount(...);// ユーザー切り替え選択時    
                }    
                else -> {    
                    // その他の例外状況    
                }    
            }    
        }    
})

import com.hive.AuthV4;    
    import com.hive.ResultAPI;    
    AuthV4.ProviderType providerType = AuthV4.ProviderType.GOOGLE;    
    AuthV4.Helper.INSTANCE.syncAccount(providerType, (result, playerInfo) -> {    
        switch (result.getCode()) {    
            case Success:    
                // 正常    
                break;    
            case AuthV4ConflictPlayer:    
                // アカウントの衝突    
                // ex) Hive UI 使用時    
                // AuthV4.Helper.INSTANCE.showConflict(...);    
                // or    
                // ex) GameUI 実装時    
                // AuthV4.Helper.INSTANCE.resolverConflict(...);// 現在のユーザー選択時    
                // AuthV4.Helper.INSTANCE.switchAccount(...);// ユーザー切り替え選択時    
                break;    
            default:    
                // その他の例外状況    
                break;    
        }    
});

import HIVEService    
    let providerType: ProviderType = .Google    
    AuthV4Interface.helper().syncAccount(providerType) { result, playerInfo in    
        switch result.getCode() {    
          case .success:    
            // 正常    
          case .authV4ConflictPlayer:    
            // アカウントの衝突    
            // ex) Hive UI 使用時     
            // AuthV4Interface.helper().showConflict(...);    
            // or    
            // ex) GameUI 実装時    
            // AuthV4Interface.helper().resolverConflict(...);// 現在のユーザー選択時    
            // AuthV4Interface.helper().switchAccount(...);// ユーザー切り替え選択時    
          default:    
            // その他の例外状況    
            break    
        }      
}

#import <HIVEService/HIVEService-Swift.h>    
    HIVEProviderType providerType = HIVEProviderTypeGoogle    
    [[HIVEAuthV4 helper] syncAccount: providerType handler: ^(HIVEResultAPI *result, HIVEPlayerInfo *playerInfo) {    
        switch ([result getCode]) {    
            case HIVEResultAPICodeSuccess:    
                // 正常    
                break;    
            case HIVEResultAPICodeAuthV4ConflictPlayer:    
                // アカウントの競合    
                // 例) Hive UI 使用時     
                // [[HIVEAuthV4 helper] showConflict: ...];    
                // または    
                // 例) GameUI 実装時    
                // [[HIVEAuthV4 helper] resolverConflict:...];// 現在のユーザー選択時    
                // [[HIVEAuthV4 helper] switchAccount:...];// ユーザー切替選択時     
                break;    
            default:    
                // その他の例外状況    
                break;    
        }    
}];

ゲストログイン¶

ユーザーがIdPを選択せずにゲスト状態でゲームを利用できるように、ゲストログイン機能をサポートします。Hive SDKが提供する明示的なログインUIからゲストを選択することも、ゲームでカスタマイズして直接実装する場合にもゲストログインを実装できます。Windows環境ではゲストログインはサポートされていません。

ゲストログイン時には次のポリシーを必ず遵守する必要があります。

ゲストログインポリシー¶

• IdP認証ユーザーとゲストユーザーの両方がゲームを同じように利用できるように実装してください。 ゲストログイン時にもHiveプラットフォームの機能のほとんどを利用できます。そのため、あなたのゲームでもゲストとしてログインしたユーザーがIdP連携ユーザーと同じようにゲームを利用できるように実装してください。例えば、ゲストユーザーもゲーム内でアイテムを購入し、決済できる必要があります。
  • ゲストユーザーにログアウト機能を提供しないでください。 ユーザーがゲストとしてログインした後にログアウトすると、もはや同じPlayerIDでログインできなくなります。したがって、ユーザーがゲストとしてログインした場合は、ログアウトできないようにログアウトボタンを提供しないでください。
  • 中国ゲストログイン禁止政策 中国IPを使用する場合、実名認証されたユーザーのみが資金を充電・消費するサービスが可能（17. 5. 1施行）であるため、中国IPでログインできるIdPリストにはゲストログインが含まれていません。

ゲストログインを実行するには、ProviderType.GUESTをパラメータとしてsignIn()メソッドを呼び出してください。 次はゲストログインを実行する例のコードです。

using hive;    
    AuthV4.signIn(AuthV4.ProviderType.GUEST, (ResultAPI result, AuthV4.PlayerInfo playerInfo) => {    
        if (result.isSuccess()) {    
            // 認証成功    
            // playerInfo: 認証されたユーザー情報    
        }    
});

#include "HiveAuthV4.h"

FHiveAuthV4::SignIn(EHiveProviderType::GUEST,
                                        FHiveAuthV4OnSignInDelegate::CreateLambda([this](const FHiveResultAPI& Result, const FHivePlayerInfo& PlayerInfo) {

        if (Result.IsSuccess()) {
                // 呼び出し成功 (PlayerInfo: 認証されたユーザー情報)
        }
}));

#include <HIVE_SDK_Plugin/HIVE_CPP.h>    
    using namespace std;     
    using namespace hive;    
    AuthV4::signIn(ProviderType::GUEST, [=](ResultAPI const & result, PlayerInfo const & playerInfo) {    
        if (result.isSuccess()) {    
            // 認証成功    
            // playerInfo: 認証されたユーザー情報    
        }    
});

import com.hive.AuthV4    
    import com.hive.ResultAPI    
    AuthV4.signIn(AuthV4.ProviderType.GUEST, object : AuthV4.AuthV4SignInListener {    
        override fun onAuthV4SignIn(result: ResultAPI, playerInfo: AuthV4.PlayerInfo?) {    
            if (result.isSuccess) {    
                // 認証成功    
                // playerInfo: 認証されたユーザー情報    
            }    
        }    
})

import com.hive.AuthV4;    
    import com.hive.ResultAPI;    
    AuthV4.INSTANCE.signIn(AuthV4.ProviderType.GUEST, (result, playerInfo) -> {    
        if (result.isSuccess()) {    
            // 認証成功    
            // playerInfo: 認証されたユーザー情報    
        }    
});

import HIVEService    
    AuthV4Interface.signIn(.Guest) { result, playerInfo in    
        if result.isSuccess() {    
            // 인증 성공    
            // playerInfo: 인증된 사용자 정보    
        }    
}

#import <HIVEService/HIVEService-Swift.h>    
    [HIVEAuthV4 signIn: HIVEProviderTypeGuest handler: ^(ResultAPI *result, HIVEPlayerInfo *playerInfo) {    
        if ([result isSuccess]) {    
            // 認証成功    
            // playerInfo: 認証されたユーザー情報    
        }    
}];

カスタムログイン¶

カスタムログイン は カスタマイズされたログイン 機能で、Hiveが提供するIdP以外にゲーム自体で連携するIdPでログインを実装できます。 認証 v4 カスタム認証する に従ってカスタムログインAPI呼び出し時に使用する認証キー(authKey)を生成してみてください。

カスタムログインAPIを呼び出した後、コールバックで渡される**PlayerInfo**クラスのインスタンスを使用して、customProviderInfoDataデータにアクセスし、カスタムログインされたユーザー情報を確認できます。customProviderInfoDataの**ProviderType(enum)**はすべてCUSTOMとして同じに設定され、**ProviderName(String)**で詳細に区別できます。

ゲームでカスタムログインを実装したIdPの情報はAuthV4クラスのsetup()およびshowSignIn()メソッドの呼び出し結果には含まれません。

カスタムログインを初めて実行した後にplayerId>とplayerTokenを発行された場合、カスタムログインAPIを再呼び出しする際にauthV4SessionExist(code)のResult APIがコールバックとして渡されます。この場合、ProviderType.AutoをパラメータとしてsignIn()を呼び出し、既存のログイン済みアカウントで自動ログインを進める必要があります。以下の例のコードを参照してください。

AuthV4クラスのconnect()およびdisconnect()メソッドはカスタムログインIdPの追加連携および解除をサポートしていません。connectWithAuthKey()およびdisconnectWithName()メソッドでカスタムログインIdPの追加連携および解除をサポートします。

カスタムログインを実装する例コードです。

// ゲームで直接実装したTwitterログイン    
    Game.Login("CUSTOM_TWITTER", (string authKey) => {    
    AuthV4.signInWithAuthKey(authKey, (ResultAPI result, PlayerInfo playerInfo) => {    
        if (result.isSuccess()) {    
            Dictionary<string, ProviderInfo> customProviderInfoData = playerInfo.customProviderInfoData;    
            ProviderInfo providerInfo = customProviderInfoData["CUSTOM_TWITTER"];    
            // 次のユーザー連携情報を確認    
            providerInfo.providerType;     // ProviderType.CUSTOM, カスタムはTypeが固定されているためproviderNameで区別する必要がある    
            providerInfo.providerName;   // "CUSTOM_TWITTER"    
            providerInfo.providerUserId;  // 直接実装したTwitterログインに使用されたユーザーid    
            return;    
        }    
        else if (result.code == ResultAPI.Code.AuthV4SessionExist) {    
            // すでにplayerIdおよびplayerTokenが発行されて自動ログインが必要な場合    
            // TODO: AuthV4.signIn(ProviderType.AUTO, (ResultAPI _result, PlayerInfo playerInfo) => {});    
        }    
        else if (result.code == ResultAPI.Code.AuthV4NotInitialized) {    
            // TODO: SDKの初期化が必要    
        }    
        else if (result.code == ResultAPI.Code.AuthV4InvalidParam) {    
            // TODO: 渡したauthKeyの値がNULLまたは空であるか確認する必要がある    
        }    
        else if (result.needExit()) {    
            // TODO: アプリ終了機能を実装してください     
            // 例) Application.Quit();    
        }    
    });    
});