ログイン・ログアウト

認証におけるログインは、以下のステップで構成されています。

ログイン¶

認証におけるログインは、以下のステップで構成されています。

1. 自動ログインと暗黙のログイン
2. 明示的ログイン
3. デバイス上のIdPアカウントのログイン確認
4. ゲストログイン

Authv4Helperは、ログインに関連する一連のプロセスを実行するクラスであり、応答値に基づいて適切な画面に移動するように設定されています。 ログインを設定する際は、以下のポイントを参照してください。

Appleは、iOSエンタープライズビルドにおいてApple Game Centerおよびアプリ内購入をサポートしていません。したがって、Apple Game Centerアカウントを使用した暗黙的なログインはiOSエンタープライズビルドで使用できず、明示的なログインでもApple Game Centerを使用することはできません。iOSエンタープライズ向けにビルドする際は、コンソールのログインタイプにApple Game Centerを含めてはいけません。

• ゲームが主に13歳未満の子供を対象としている場合、Google Playゲームサービスは適用できず、Googleビルドでは暗黙のログインを使用できません。詳細については、Google Playゲームサービスの品質チェックリストを参照してください。
  • Google Playゲームの暗黙のログインは、初回ログイン時のみ試みるべきです。詳細については、Google開発者ガイドの1.5 プレイヤーがサインインを拒否した場合を記憶するを参照してください。

自動ログインと暗黙のログイン¶

自動ログイン¶

これは、ユーザーがログイン方法を選択しない場合のログイン方法を指し、iOSでは自動的にApple Game Centerアカウントにリンクし、AndroidではGoogle Play Gamesアカウントにリンクします。自動ログインを実装し、自動ログインが失敗した場合には暗黙のログインを行います。

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

オフラインモード¶

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を受け取ることができません。ユーザーの視点からすると、ユーザーはデバイスがネットワークに接続されている間にアプリに少なくとも一度成功裏にログインしている必要があります。ただし、ユーザーのアカウントが最後のログイン試行時にオンラインで一時停止または制限されていた場合、ユーザーはオフラインモードでもログインできません。

1. Hive コンソールでオフラインモードを有効にします App Center > プロジェクト管理 > ゲーム詳細 > Hive 製品設定。

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

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

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

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

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

AuthV4.Helper.signInは、PlayerIDの認証トークンキーを使用して自動的にログインしようとします。既存の認証トークンキーがない場合、iOSではApple Game Center、AndroidではGoogle Play Gamesに自動的にログインします。ログインに失敗した場合、応答値に基づいて適切なログイン画面を設定します。

AuthV4Helperクラスを使用する際

ゲームを起動したユーザーがPGS中に暗黙のログイン試行を拒否した場合、システムはこれを記憶し、以後は暗黙のログインを試みなくなります。プレイヤーセッションが維持されている間に自動ログインが可能であっても、拒否された暗黙のログインの状態を記憶し続けます。この内容はGoogle Play Games Servicesガイドに基づいています。

自動ログインを行う例のコードは以下の通りです。

// 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:
  k              // その他の例外
                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:
                // 暗黙のログインに失敗
                // 例) 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を使用してサインインを試みる
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.Helper.signIn(new AuthV4.Helper.AuthV4HelperListener() {
    @Override
    public void onAuthV4Helper(ResultAPI result, PlayerInfo playerInfo) {

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

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

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

// Hive SDKにサインイン（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)は、初回ログイン後に異なるアカウントでログインするとアカウントの競合状況を引き起こし、AuthV4ConflictPlayerの結果コードを返し、最後にログインしたアカウントでログインするかどうかを尋ねるダイアログをユーザーに表示します（AuthV4.Helper.showConflictの実行）。

ただし、Androidモバイル環境における暗黙のGoogleサインインは、以下のように異なる動作をします。

Androidモバイル環境では、Googleサインインの暗黙のログインは、アカウントの競合を引き起こすことなく（AuthV4ConflictPlayer）、成功または失敗のいずれかを返します。他のモバイル環境とは異なります。上の画像では、レガシーサポートGoogle認証は、Androidモバイル環境におけるGoogleサインインの暗黙のログインを指します。

成功したログインの後、ユーザーがIdP統合を試みたり、Googleの実績とリーダーボードを呼び出したりすると、Googleアカウントを選択するためのUIが表示されます（新しいログインセッションが作成されます）。既にログインしているアカウントのPlayerInfoが確認され、新しく選択されたGoogleアカウントがこの情報と異なる場合、アカウントの競合（AuthV4ConflictPlayer）が発生します。この時点で、アカウント競合の状況を処理すれば、新しく選択されたGoogleアカウントでログインできます。

既存のログインセッションがない状況（例えば、アプリが初めてインストールされて実行されるとき）では、Androidモバイル環境におけるGoogleサインインの暗黙的ログインは、状況に応じて以下のように異なる動作をします。

1. アプリにログインしているGoogleアカウントがAndroid OSデバイスのアカウント設定に存在する状況（GoogleアカウントがAndroid OSデバイスにログインしている状況）
   • Googleアカウントでログインする
2. アプリにログインしている2つ以上のGoogleアカウントがAndroid OSデバイスのアカウント設定に存在する状況（特定のGoogleアカウントがAndroid OSデバイスにログインしている状況）
   • ログインしているGoogleアカウントの中から選択できるUIを表示する
   • UIからアカウントを選択した後にログインする
   • ユーザーがGoogleアカウントを選択せずにUIを閉じた場合、Android OSデバイスのアカウント設定に存在するすべてのGoogleアカウントのリストを表示するUIを表示する
   • ユーザーがすべてのGoogleアカウントのUIから希望のGoogleアカウントを選択した場合、そのアカウントでログインする
3. アプリにログインしているGoogleアカウントがない状況
   • Android OSデバイスのアカウント設定に存在するすべてのGoogleアカウントのリストを表示するUIを表示する
   • ユーザーがすべてのGoogleアカウントのUIから希望のGoogleアカウントを選択した場合、そのアカウントでログインする

下の画像は、上記の3つの状況のUI例を示しています。左から、状況1、2、3に対応しています。

暗黙のログイン動作: 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: アプリの終了機能を実装する
        // e.g.) 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を検索する（現在ログインしているプロバイダー）
            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を検索
            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);
    }
}];

既存のログインセッションがない場合（たとえば、アプリがインストールされて初めて実行されるとき）、Androidモバイル環境での明示的なGoogleサインインは、状況に応じて次のように異なる動作をします。

1. アプリにログインしているGoogleアカウントがAndroid OSデバイスのアカウント設定に存在する状況（GoogleアカウントがAndroid OSデバイスにログインしている状況）
   • 対応するGoogleアカウントでログインする
2. アプリにログインしている2つ以上のGoogleアカウントがAndroid OSデバイスのアカウント設定に存在する状況（特定のGoogleアカウントがAndroid OSデバイスにログインしている状況）
   • ログインしているGoogleアカウントの中から1つを選択できるUIを表示する
   • UIからアカウントを選択した後にログインする
   • ユーザーがGoogleアカウントを選択せずにUIを閉じた場合、Android OSデバイスのアカウント設定に存在するすべてのGoogleアカウントのリストを表示するUIを表示する
   • ユーザーがすべてのGoogleアカウントのリストUIから希望のGoogleアカウントを選択した場合、そのアカウントでログインする
3. アプリにログインしているGoogleアカウントがない状況
   • Android OSデバイスのアカウント設定に存在するすべてのGoogleアカウントのリストを表示するUIを表示する
   • ユーザーがすべてのGoogleアカウントのリストUIから希望のGoogleアカウントを選択した場合、そのアカウントでログインする

以下の画像は、上記の3つの状況のUIの例です。左から、それぞれ状況1、2、3に対応しています。

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

明示的なログインのためのカスタマイズ可能な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.signIn(AuthV4.ProviderType.GOOGLE, (result, playerInfo) -> {
    if (result.isSuccess()) {
        // Call successful
        // playerInfo: authenticated user information
        // Example of retrieving email information for 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にリンクされたアカウントにログインします。いずれの場合も、ログインしているPlayerIDのIdPアカウントは、実際のデバイス（DevicePlayer）にログインしているIdPアカウントと異なる場合があります。将来の成果やリーダーボードの使用に備えて、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:
            // Normal
            break;   
        case ResultAPI.Code.AuthV4ConflictPlayer:
            // アカウントの競合
            // 例) Hive UIを使用しているとき
            // AuthV4.Helper.showConflict(...);
            // または
            // 例) 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()
            // 例) ゲーム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 -> {
                // アカウントの競合
                // 例) Hive UIを使用しているとき
                // AuthV4.Helper.showConflict(...);
                // または
                // 例) GameUIを実装しているとき
                // AuthV4.Helper.resolverConflict(...);// 現在のユーザーを選択するとき
                // AuthV4.Helper.switchAccount(...);// ユーザー切り替えを選択するとき 
            }
            else -> {
                // その他の例外的な状況
            }
        }
    }
})

import com.hive.AuthV4;
import com.hive.ResultAPI;

AuthV4.ProviderType providerType = AuthV4.ProviderType.GOOGLE;
AuthV4.Helper.syncAccount(providerType, (result, playerInfo) -> {
    switch (result.getCode()) {
        case Success:
            // 通常  
        case AuthV4ConflictPlayer:    
            break;   
            // アカウントの競合
            // 例) Hive UIを使用しているとき
            // AuthV4.Helper.showConflict(...);
            // または
            // 例) GameUIを実装しているとき
            // AuthV4.Helper.resolverConflict(...);// 現在のユーザーを選択する時
            // AuthV4.Helper.switchAccount(...);// ユーザー切り替えを選択する時 
            break;
        default:  
            // その他の例外
            break;
    }
});

import HIVEService
let providerType: ProviderType = .Google

AuthV4Interface.helper().syncAccount(providerType) { result, playerInfo in
    switch result.getCode() {
        case .success:
        // 通常
        case .authV4ConflictPlayer:
        // アカウントの競合
        // 例) Hive UIを使用しているとき
        // AuthV4Interface.helper().showConflict(...);
        // または
        // 例) 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を使用している場合、実名確認を受けたユーザーのみがリチャージやリソースの消費を行うことができます（2017年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.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 サインイン: HIVEProviderTypeGuest ハンドラー: ^(ResultAPI *result, HIVEPlayerInfo *playerInfo) {
    if ([result isSuccess]) {
        // 認証成功
        // playerInfo: 認証されたユーザー情報
    }
}];

カスタムログイン¶

カスタムログインはカスタマイズされたログインのための機能で、Hiveが提供するIdPに加えて、ゲーム自体と統合されたIdPを通じてログインを実装することを可能にします。カスタムログインAPIを呼び出す際に使用する認証キー(authKey)を生成してみてください。これはAuthenticate v4 Custom Authenticationに従って行います。

カスタムログインAPIを呼び出した後、コールバックとして受け取ったPlayerInfoクラスのインスタンスを通じて、customProviderInfoDataデータにアクセスしてカスタムでログインしたユーザーの情報を確認できます。customProviderInfoDataのProviderType (enum)は一律にCUSTOMに設定されており、ProviderName (String)によって詳細に区別できます。

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

カスタムログインの最初の実行後にplayerIdとplayerTokenを受け取った場合、カスタムログインAPIが再呼び出しされると、authV4SessionExist(code)の結果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、カスタムタイプは固定されているため、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();
        }
    });  
});

#include "HiveAuthV4.h"

// ゲーム内で「CUSTOM_TWITTER」タイプのTwitterログインを直接実装しました
void GameLogin(const FString& AuthKey)
{
    FHiveAuthV4::SignInWithAuthKey(AuthKey, FHiveAuthV4OnSignInDelegate::CreateLambda([this](const FHiveResultAPI& Result, const FHivePlayerInfo& PlayerInfo) {

        if (Result.IsSuccess()) {
            TMap<FString, FHiveProviderInfo> CustomProviderInfoData = PlayerInfo.CustomProviderInfoData;
            if (const FHiveProviderInfo* ProviderInfo = CustomProviderInfoData.Find(TEXT("CUSTOM_TWITTER"))) {
                    EHiveProviderType ProviderType = ProviderInfo->ProviderType; // EHiveProviderType::CUSTOM, custom types are fixed
                    FString ProviderName = ProviderInfo->ProviderName; // Need to distinguish by ProviderName
                    FString ProviderUserId = ProviderInfo->ProviderUserId; // User id used in the custom Twitter login
            }
        } else if (Result.NeedExit()) {
            // TODO: アプリ終了機能を実装する
            // e.g.) UKismetSystemLibrary::QuitGame(GetWorld(), nullptr, EQuitPreference::Quit, false);
        } else if (Result.Code == FHiveResultAPI::ECode::AuthV4SessionExist) {
            // もしplayerIdとplayerTokenがすでに発行されていて、自動ログインが必要な場合
            // TODO: FHiveAuthV4.SignIn(EHiveProviderType::GUEST, Delegate);
        } else if (Result.Code == FHiveResultAPI::ECode::AuthV4NotInitialized) {
            // TODO: SDKの初期化が必要
        } else if (Result.Code == FHiveResultAPI::ECode::AuthV4InvalidParam) {
            // TODO: 提供されたauthKeyの値が空でないか確認する
        }
    }));
}

using namespace std;
using namespace hive;

// ゲーム内で直接実装されたTwitterログイン
Game::Login("CUSTOM_TWITTER", [=](string authKey) {
    AuthV4::signInWithAuthKey(authKey, [=](ResultAPI const & result, PlayerInfo const & playerInfo) {
        if (result.isSuccess()) {
            map<string, ProviderInfo> customProviderInfoData = playerInfo.customProviderInfoData;
            ProviderInfo providerInfo = customProviderInfoData["CUSTOM_TWITTER"];
            // 以下のユーザーリンク情報を確認
            providerInfo.providerType; // ProviderType::CUSTOM、カスタムタイプは固定されているため、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 const & _result, PlayerInfo const & 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: アプリ終了機能を実装
            // Cocos2d-xエンジンユーザー向け
            // 例) exit(0);
            // Unrealエンジンユーザー向け
            // 例) UKismetSystemLibrary::QuitGame(GetWorld(), nullptr, EQuitPreference::Quit, false);
        }
    });  
});

// ゲーム内で直接実装されたTwitterログイン
Game.Login("CUSTOM_TWITTER") { authKey: String ->

    AuthV4.signInWithAuthKey(authKey, object : AuthV4.AuthV4SignInListener {
        override fun onAuthV4SignIn(result: ResultAPI, playerInfo: AuthV4.PlayerInfo?) {

            if (result.isSuccess && playerInfo != null) {
                playerInfo.customProviderInfoData["CUSTOM_TWITTER"]?.let { providerInfo ->
                    providerInfo.providerType   // ProviderType.CUSTOM, custom types are fixed, so need to distinguish by providerName
                    providerInfo.providerName   // "CUSTOM_TWITTER"
                    providerInfo.providerUserId // User id used for the custom Twitter login
                }
            }
            else if (result.needExit()) {
                // TODO: アプリ終了機能を実装する
                // e.g.) exitProcess(0)
            }
            else if (result.code == ResultAPI.Code.AuthV4SessionExist) {
                // playerIdとplayerTokenがすでに発行されていて、自動ログインが必要な場合
                // TODO: AuthV4.signIn(AuthV4.ProviderType.AUTO, authV4SignInListener)
            }
            else if (result.code == ResultAPI.Code.AuthV4NotInitialized) {
                // TODO: SDKの初期化が必要
            }
            else if (result.code == ResultAPI.Code.AuthV4InvalidParam) {
                // TODO: 提供されたauthKeyの値がNULLまたは空であるか確認する
            }
        }
    })
}

// ゲーム内で直接実装されたTwitterログイン
Game.Login("CUSTOM_TWITTER") { authKey: String ->
    AuthV4.signInWithAuthKey(authKey, new AuthV4.AuthV4SignInListener() {
        @Override
        public void onAuthV4SignIn(@NonNull ResultAPI result, @Nullable AuthV4.PlayerInfo playerInfo) {

            if(result.isSuccess() && playerInfo != null) {
                HashMap<String, AuthV4.ProviderInfo> customProviderInfoData = playerInfo.getCustomProviderInfoData();
                AuthV4.ProviderInfo providerInfo = customProviderInfoData.get("CUSTOM_TWITTER");
                // 次のユーザーリンク情報を確認します
                if (providerInfo != null){
                    providerInfo.getProviderType(); // AuthV4.ProviderType.CUSTOM、カスタムタイプは固定されているため、providerNameで区別する必要があります
                    providerInfo.getProviderName(); // "CUSTOM_TWITTER"
                    providerInfo.getProviderUserId(); // 直接実装されたカスタムTwitterログインに使用されるユーザーID
                }
            } else if (result.needExit()) {
                // TODO: アプリ終了機能を実装する
                // 例) System.exit(0);
            } else if (result.getCode() == ResultAPI.Code.AuthV4SessionExist) {
                // playerIdとplayerTokenがすでに発行され、自動ログインが必要な場合
                // TODO: AuthV4.signIn(AuthV4.ProviderType.AUTO, authV4SignInListener)
            } else if (result.getCode() == ResultAPI.Code.AuthV4NotInitialized) {
                // TODO: SDKの初期化が必要です
            } else if (result.getCode() == ResultAPI.Code.AuthV4InvalidParam) {
                // TODO: 提供されたauthKeyの値がNULLまたは空であるか確認する
            }
        }
    });
}