ドキュメント

サポート

Vivox Unity SDK

Vivox Unity SDK

カスタム ID を使用してサインインする

Sign in users to Vivox with custom identifiers.
読み終わるまでの所要時間 1 分最終更新 4日前
既存のプレイヤー管理システムがすでにあり、プレイヤー ID を作成している場合は、カスタム ID プロバイダーを使用してアイデンティティをリンクできます。 前提条件:
  1. Unity Cloud プロジェクトを設定する
    • プロジェクト ID、環境 ID、環境名を確認してください。
  2. UAS カスタム ID プロバイダーを有効にする この設定のサービスアカウントの認証情報をご用意ください。
この設定のすべてのフロー
サインインする
  1. サインインの際にすべてのユーザーを UAS カスタム ID プロバイダーに登録し、プレイヤーの 
    accessToken
    と 
    sessionTokens
    を取得します。
  2. accessToken
    と 
    sessionToken
    を使用してクライアントに AuthenticationService を設定します

クライアント側の設定

さらに後で説明するサーバー側でのサインインの設定と合わせて、アクセストークンをバックエンドから取得して 
AuthenticationService
で処理する必要があります。 
ProcessAuthenticationTokens
を使用して、Unity Authentication サービスアクセストークンを処理し、プレイヤーの認証を必要とする、ゲームに統合されている他の UGS SDK で使用できるようにします。アクセストークンには期限があるため、アクセストークンを手動で更新し、新しいアクセストークンを使用して 
ProcessAuthenticationTokens
を呼び出す必要があります。
ProcessAuthenticationTokens
の呼び出しには、アクセストークンとセッショントークンの両方を使用できます。Unity Authentication SDK は、期限が切れる前にアクセストークンを更新し、プレイヤーのセッションをアクティブに保ち、キャッシュされたプレイヤーのサインイン を有効にします。 
using Unity.Services.Authentication;using Unity.Services.Vivox;void SignUserWithCustomTokenWithAutoRefresh(){    try    {        // Check if a cached player already exists by checking if the session token exists        if (AuthenticationService.Instance.SessionTokenExists)        {            // This call will sign in the cached player.            await AuthenticationService.Instance.SignInAnonymouslyAsync();            Debug.Log("Cached user sign in succeeded!");        }        else        {            var userTokens = // Fetch the user tokens using your method calls            AuthenticationService.Instance.ProcessAuthenticationTokens(userTokens.AccessToken, userTokens.SessionToken)        }        // Shows how to get the playerID        Debug.Log($"PlayerID: {AuthenticationService.Instance.PlayerId}");        await VivoxService.Instance.InitializeAsync();    }    catch (AuthenticationException ex)    {        // Compare error code to AuthenticationErrorCodes        // Notify the player with the proper error message        Debug.LogException(ex);    }    catch (RequestFailedException ex)    {        // Compare error code to CommonErrorCodes        // Notify the player with the proper error message        Debug.LogException(ex);    }    catch (Exception ex) {        // Handle exceptions from your method call        Debug.LogException(ex);    }}
サンプルコードはメソッドのみであり、クラスではありません。 アクセストークンはバックエンドから取得する必要があります。この詳細については、以下の サーバー側の設定 を参照してください。

サーバー側の設定

プレイヤーのサインイン時に、各プレイヤーが UAS カスタム ID プロバイダーに登録されるようにし、プレイヤーの 
accessToken
と 
sessionToken
を取得します。まだ行っていない場合には、UAS カスタム ID プロバイダーを有効にする を参照して設定してください。サービスアカウント認証情報を使用して、プレイヤーをゲームサーバーに登録するリクエストを送信できます。
  1. トークン交換 API を呼び出して、ステートレストークンを取得します。
  2. カスタム ID を使用したサインインの API を呼び出します。
curl --location 'https://player-auth.services.api.unity.com/v1/projects/<PROJECT_ID>/authentication/server/custom-id' \--header 'Content-Type: application/json' \--header 'UnityEnvironment: <ENVIRONMENT_NAME>' \--header 'Authorization: Bearer <STATELESS_TOKEN' \--data '{    "externalId": "YOUR_CUSTOM_PLAYER_ID"}'
このリクエストのレスポンスに含まれる 
idToken
と 
sessionToken
を、
AuthenticationService
を初期化するためにクライアントに返す必要があります。このコンテキストでは 
idToken
を 
accessToken
として使用できます。 任意ですが、プレイヤー名 API を使用してプレイヤーの名前を設定することもできます。これは、Vivox Safety 製品を使用している場合に役立ちます。Moderation ダッシュボードでモデレーターに対してプレイヤー名を表示できるためです。プレイヤーが名前を変更する場合にプレイヤー名を最新状態に保つようにしてください。プレイヤー名の管理 を使用してクライアント側からプレイヤー名を直接管理することもできます。