Metrics Interface はゲームの使用状況をトラックし、デベロッパー ポータルのゲーム分析ダッシュボードに入力します。このデータには、ゲームのクライアントとサーバーのアクティブなオンライン インスタンスと、ローカル プレイヤーがプレイした過去のセッションが含まれます。
使用状況メトリクスを収集する
データ収集を有効にするには、**Platform インターフェース**の関数である EOS_Platform_GetMetricsInterface を通じて EOS_HMetrics ハンドルを取得する必要があります。すべての Metrics インターフェースの関数が、1 つ目のパラメータとしてこのハンドルを必要とします。
Epic Online Services (EOS) SDK がデータを収集し、バックエンド サービスが処理と保存を行います。集められた結果は、ゲーム分析ダッシュボードで利用でき、世界中のゲーム アクティビティ、プレイヤー維持、およびオンライン ユーザー数の監視ができます。
制限事項
メトリクス データは 5 分ごとに更新されます。この更新頻度が原因で、テスト中、クライアントがダッシュボードにすぐに表示されない場合があります。さらに、ユーザー維持の計算には数日分の履歴データが必要なため、最初の数日間はゲーム分析ダッシュボードにプレイヤー維持情報は表示されません。
メトリクス収集の実行には、EOS SDK の公開されている API のみを使用する必要があります。EOS SDK は、外部プログラムや外部サービスのメトリクス収集には使用できません。
プレイ セッションをレポートする
EOS のデータ収集は、各プレイヤーが各プレイ セッションを開始および終了するときのゲーム レポートを利用しています。セッションを記録するには、ゲーム内の各プレイヤーの EOS_Metrics_BeginPlayerSessionOptions データ構造体を使用して EOS_Metrics_BeginPlayerSession を呼び出します。これにより、プレイヤーがリモート サーバーのゲームに参加したか、プレイヤーが独自のゲームをホストしていることが SDK に通知されます。プレイヤーがサーバーから退出した場合やローカル セッションを終了した場合は、EOS_Metrics_BeginPlayerSessionOptions データ構造体を使用して EOS_Metrics_EndPlayerSession を呼び出して、セッションの終わりをマークします。
EOS_Metrics_BeginPlayerSession を呼び出すときに EOS_Metrics_BeginPlayerSessionOptions 構造体を次の情報で初期化します。
| プロパティ | 値 |
|---|---|
ApiVersion | EOS_METRICS_BEGINPLAYERSESSION_API_LATEST に設定する。 |
LocalUserId | ローカル ユーザーのグローバルに一意なアカウント識別子。Epic のユーザー アカウントに使用する。 |
LocalUserIdExternal | ローカル ユーザーのグローバルに一意なアカウント識別子。Epic 以外のユーザー アカウントに使用する。 |
DisplayName | プレイヤーのゲーム内の名前。UTF-8 文字列。 |
ControllerType | プレイヤーが使用しているゲーム コントローラーのタイプ。 |
ServerIp | ゲーム セッションをホストしているゲーム サーバーの IP アドレス。 |
GameSessionId | ゲームでは、バックエンド サービスのセッション レコードにアタッチするカスタム マッチ識別子文字列を設定できます。このデータは、将来、プレイ中に発生するトラック対象イベントとゲーム セッションを関連付けるために使用できるようになります。 |
EOS_Metrics_EndPlayerSession を呼び出すときに EOS_Metrics_EndPlayerSessionOptions 構造体を次の情報で初期化します。
| プロパティ | 値 |
|---|---|
ApiVersion | EOS_METRICS_ENDPLAYERSESSION_API_LATEST に設定する。 |
LocalUserId | セッションを開始したプレイヤーのアカウント ID。EOS_Metrics_BeginPlayerSession の以前の呼び出しに使用した LocalUserId と一致する必要がある。 |
LocalUserIdExternal | セッションを開始したプレイヤーのアカウント ID。EOS_Metrics_BeginPlayerSession の以前の呼び出しに使用した LocalUserIdExternal と一致する必要がある。 |
同時接続オンライン ユーザー (CCU) とユーザー維持データを収集する
EOS SDK は、同時接続オンライン ユーザーとゲーム サーバーの数を自動的に記録します。この機能は、ゲームのクライアントまたはサーバーを実行するオンライン マシンで SDK を初期化するとアクティブになります。ユーザー維持データは、ゲームがリリースされて数日経過してから、レポートされたプレイ セッションに基づく履歴データを使用して計算されます。