Blueprint インテグレーション

Learn how to implement authentication using Unreal Engine Blueprints.

読み終わるまでの所要時間 5 分

最終更新 1日前

Authentication SDK を依存関係として追加する

以下のブループリントデモンストレーションを進める前に、Authentication SDK プラグインが正常にインストールされていることを確認してください。また、Blueprint のイベントグラフや関数で、Unity Gaming Services > Authentication の下に Authentication 関連の関数が表示されることを確認してください。

Sign In Anonymously

を使用すると、匿名で認証することができます。これは、ユーザー情報を必要とせず、外部プロバイダーとのインタラクションも不要な簡単な認証方法です。成功すると、Unity Authentication サーバーから返される認証情報で現在のプレイヤープロファイルが更新されます。

Sign In Anonymously

は、サインインの実行方法を変更するパラメーターとして

FAuthenticationSignInOptions

構造体を受け取ります。これらのパラメーターの詳細については、Unity API サービスの公式ドキュメントページを参照してください。 SDK からの応答はカスタムイベントで処理できます。その際、Authentication Response を出力ピンとして受け取る必要があります。応答変数を分割するには、応答本文の出力ピンを右クリックして Split Pin を選択します。

Get User Info

Get User Info

を使用すると、現在認証されているユーザーに関する情報を取得できます。これには、ユーザー ID、認証タイムスタンプ、およびそのセッションにリンクされている外部 ID プロバイダーが含まれます。 SDK からの応答はカスタムイベントで処理できます。その際、Authentication SDK からのユーザー応答を表す Authentication User Response を出力ピンとして受け取る必要があります。応答変数を分割するには、応答本文の出力ピンを右クリックして Split Pin を選択します。

Delete User

Delete User

を使用すると、現在認証されているプレイヤーに関連するすべての情報を削除できます。この関数は、プレイヤーをサインアウトし、プレイヤーの設定やプロファイルもすべて削除します。 SDK からの応答はカスタムイベントで処理できます。その際、削除が成功したかどうかを示す

Boolean

を出力ピンとして受け取る必要があります。

Register State Changed Callback

Register State Changed Callback

を使用すると、サブシステムの状態が変化した際に呼び出されるコールバック関数を割り当てることができます。例えば、プレイヤーが認証に成功してサブシステムの状態が

Authorized

に変化した際に、割り当てた関数が実行されます。 SDK からの応答はカスタムイベントで処理できます。その際、Authentication SDK からの応答を表す Authentication State Changed Response を出力ピンとして受け取る必要があります。応答変数を分割するには、応答本文の出力ピンを右クリックして Split Pin を選択します。

Sign Out

Sign Out

を使用すると、現在認証されているプレイヤープロファイルからサインアウトできます。これにより、現在のプレイヤープロファイルが削除され、デフォルトのプロファイルに切り替わります。この関数には、プレイヤーに関連付けられた保存済みの認証情報を削除する、オプションのパラメーターもあります。

注

ノート: デフォルトプロファイルを使用しているときに

Sign Out

が呼び出されると、プロファイル情報が消去されますが、プロファイル自体は保持されます。

この関数は、操作が成功したかどうかを示す

Boolean

を返します。

Switch Profile

Switch Profile

を使用すると、プレイヤープロファイルを切り替えたり、新しいプロファイルを作成したりできます。

注

ノート:

Switch Profile

は、サインアウト状態のときにのみ呼び出すことができます。認証された状態のときにプロファイルの切り替えが試みられた場合は、警告が記録され、何も実行されません。

Switch profile

Profile Exists

Profile Exists

を使用すると、指定したプロファイルが現在のセッションに存在するかどうかを確認できます。

注

ノート: 前のセッションで作成され、現在のセッションでは再作成されていないプロファイルがある場合、

Profile Exists

でそれらを検出することはできません。

この関数は、指定されたプロファイル名が現在のプレイヤープロファイルのリストに存在するかどうかを示す

Boolean

を返します。

Profile exists

Get Current Profile Name

Get Current Profile Name

を使用すると、現在のプレイヤープロファイルの名前を取得できます。この関数は、Authentication サブシステムが使用している現在のプレイヤープロファイルの名前を示す

String

を返します。

Get current profile name

Get Profile Names

Get Current Profile Names

を使用すると、現在のセッションで使用されているすべてのプレイヤープロファイル名のリストを取得できます。この関数は、Authentication サブシステムで使用されているすべてのプレイヤープロファイル名を示す

String Array

を返します。

Get profile names

Register Profile Changed Callback

Register Profile Changed Callback

を使用すると、プレイヤープロファイルが変更されたときに呼び出されるコールバック関数を割り当てることができます。例えば、Switch Profile が正常に実行されたときに、割り当てた関数が実行されます。 SDK からの応答はカスタムイベントで処理できます。その際、Authentication Player Profile Changed Response を出力ピンとして受け取る必要があります。応答変数を分割するには、応答本文の出力ピンを右クリックして Split Pin を選択します。

Register Profile Deleted Callback

Register Profile Changed Callback

を使用すると、プレイヤープロファイルが現在のセッションから削除されたときに呼び出されるコールバック関数を割り当てることができます。例えば、Sign Out が正常に実行されたときに、割り当てた関数が実行されます。 SDK からの応答はカスタムイベントで処理できます。その際、[Authentication Player Profile] Authentication Player Profile Deleted Response を出力ピンとして受け取る必要があります。応答変数を分割するには、応答本文の出力ピンを右クリックして Split Pin を選択します。

Is Signed In

Is Signed In

を使用すると、現在のプレイヤープロファイルがサインインしているかどうかを確認できます。"サインインしている" とは、Authorized (認証済み) または Expired (有効期限切れ) のいずれかの状態であることを意味します。この関数は、現在のプレイヤープロファイルがサインインしているかどうかを示す

Boolean

を返します。

Is Anonymous

Is Anonymous

を使用すると、現在のプレイヤープロファイルが匿名でサインインしているかどうかを確認できます。

Sign In Anonymously

が正常に実行されると、true が返されます。この関数は、現在のプレイヤープロファイルが匿名でサインインしているかどうかを示す

Boolean

を返します。最後のサインインが匿名であれば、セッションが期限切れであっても true が返されます。

Is Authorized

Is Authorized

を使用すると、現在のプレイヤープロファイルがサインインしており、現在も認証されているかどうかを確認できます。この関数は、現在のプレイヤープロファイルがサインインしており、認証に成功しているかどうかを示す

Boolean

を返します。サインイン関数が実行され、有効期限がまだ切れていなければ、true が返されます。

Is Expired

Is Expired

を使用すると、現在のプレイヤープロファイルのセッションが有効期限切れかどうかを確認できます。この関数は、現在のプレイヤープロファイルのセッションが最初の Authentication Response で返された有効期限を過ぎているかどうかを示す

Boolean

を返します。

Session Token Exists

Session Token Exists

を使用すると、現在のプレイヤープロファイルのプレイヤー設定にセッショントークンが存在するかどうかを確認できます。この関数は、セッショントークンが存在するかどうかを示す

Boolean

を返します。

Get Unity Project Id

Get Unity Project Id

を使用すると、現在の認証セッションに関連付けられている Unity プロジェクト ID を取得できます。この関数は、現在使用中のプロジェクト ID を示す

Guid

を返します。

Get Unity Environment Name

Get Unity Environment Name

を使用すると、現在の認証セッションに関連付けられている Unity 環境名を取得できます。この関数は、現在使用中の環境を示す

String

を返します。

Get Access Token

Get Access Token

を使用すると、現在のセッションのアクセストークンを取得できます。当該の文字列が存在しない場合は、空の文字列が返されます。

Get Session Token

Get Session Token

を使用すると、現在のセッションのセッショントークンを取得できます。当該の文字列が存在しない場合は、空の文字列が返されます。

Get User Id

Get User Id

関数を使用すると、現在のセッションのユーザー ID を取得できます。

注

ノート: これはプレイヤープロファイル名とは異なります。ユーザー ID は、Unity Authentication System から返される一意のユーザー識別子です。

この関数は、現在のプレイヤープロファイルのユーザー ID を示す

String

を返します。当該の文字列が存在しない場合は、空の文字列が返されます。

Get State

Get State

関数を使用すると、認証セッションの現在の状態を取得できます。この関数は、サブシステムの状態を表す

Enum

を返します。

Set Unity Project Id

Set Unity Project Id

を使用すると、現在の認証セッションに対して Unity プロジェクト ID を設定できます。この関数は

Guid

を受け取ります。

注

ノート: これが実行されると、プロジェクト設定で設定された Unity プロジェクト ID がオーバーライドされます。

Set Unity Environment Name

Set Unity Environment Name

を使用すると、現在の認証セッションに対して Unity 環境名を設定できます。この関数は

String

を受け取ります。

注

ノート: これが実行されると、プロジェクト設定で設定された Unity 環境名がオーバーライドされます。

ドキュメント

Development

User Acquisition

Monetization

産業

ドキュメント

Development

User Acquisition

Monetization

産業

Authentication for Unreal Engine

Authentication for Unreal Engine

Blueprint インテグレーション

Authentication SDK を依存関係として追加する

Get User Info

Delete User

Register State Changed Callback

Sign Out

Switch Profile

Profile Exists

Get Current Profile Name

Get Profile Names

Register Profile Changed Callback

Register Profile Deleted Callback

Is Signed In

Is Anonymous

Is Authorized

Is Expired

Session Token Exists

Get Unity Project Id

Get Unity Environment Name

Get Access Token

Get Session Token

Get User Id

Get State

Set Unity Project Id

Set Unity Environment Name