翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

# C\$1\$1 サーバー SDK for Amazon GameLift Servers 4.x -- データ型
<a name="integration-server-sdk-cpp-ref-datatypes"></a>

サーバー SDK リファレンスを使用して、Amazon GameLift Servers でホスティングするマルチプレイヤーゲームを統合します。統合プロセスのガイダンスについては、「[サーバー SDK を使用して、Amazon GameLift Servers をゲームサーバーに追加します。](gamelift-sdk-server-api.md)」を参照してください。

**注記**  
このリファレンスは、サーバー SDK for Amazon GameLift Servers の以前のバージョン用です。最新バージョンについては、「[C\$1\$1 サーバー SDK 5.x for Amazon GameLift Servers -- データ型](integration-server-sdk5-cpp-datatypes.md)」を参照してください。

この API は、`GameLiftServerAPI.h`、`LogParameters.h`、および `ProcessParameters.h` で定義されています。

[C\$1\$1 サーバー SDK for Amazon GameLift Servers 4.x –- アクション](integration-server-sdk-cpp-ref-actions.md)

## DescribePlayerSessionsRequest
<a name="integration-server-sdk-cpp-ref-dataypes-playersessions"></a>

このデータ型は、取得するプレイヤーセッションを指定するのに使用されます。このデータ型は次のように使用できます。
+ 特定のプレーヤーセッションをリクエストする PlayerSessionId を提供します。
+ 指定したゲームセッションのすべてのプレイヤーセッションをリクエストする GameSessionId を提供します。
+ 指定したプレイヤーのすべてのプレイヤーセッションをリクエストする PlayerId を提供します。

プレイヤーセッション数が多い場合は、ページ分割パラメータを使用して結果を順次ブロックとして取得します。

### 内容
<a name="integration-server-sdk-cpp-ref-dataypes-playersessions-contents"></a>

**GameSessionId**  
一意のゲームセッション識別子。このパラメータを使用して、指定したゲームセッションのすべてのプレイヤーセッションをリクエストします。ゲームセッション ID の形式は、`arn:aws:gamelift:<region>::gamesession/fleet-<fleet ID>/<ID string>` です。<ID string> の値は、カスタム ID 文字列または (ゲームセッション作成時に指定した場合) 生成された文字列のいずれかです。  
型: String  
必須: いいえ

**制限**  
返される結果の最大数。このパラメータを *NextToken* とともに使用して、結果を一連の順次ページとして取得します。プレイヤーセッション ID を指定した場合、このパラメータは無視されます。  
型: Integer  
必須: いいえ

**NextToken**  
結果において次の順次ページの開始を示すトークン。このアクションの以前の呼び出しで返されたトークンを使用します。結果セットの先頭を指定するには、値を指定しないでください。プレイヤーセッション ID を指定した場合、このパラメータは無視されます。  
型: string  
必須: いいえ

**PlayerId**  
プレイヤーを表す一意の識別子。プレイヤー ID は開発者によって定義されます。「[プレイヤー ID を生成する](player-sessions-player-identifiers.md)」を参照してください。  
型: string  
必須: いいえ

**PlayerSessionId**  
プレイヤーセッションを表す一意の識別子。  
型: string  
必須: いいえ

**PlayerSessionStatusFilter**  
結果をフィルタリングするプレイヤーセッションステータス。可能なプレイヤーセッションステータスとして以下のステータスがあります。  
+ RESERVED - プレイヤーセッションリクエストは受領されましたが、プレイヤーのサーバープロセスへの接続や検証はまだ行われていません。
+ ACTIVE - プレイヤーはサーバープロセスによって検証され、現時点で接続されています。
+ COMPLETED - プレイヤー接続は削除されました。
+ TIMEDOUT - プレイヤーセッションリクエストは受領されましたが、タイムアウト制限 (60 秒) 内でのプレイヤーの接続や検証は行われていません。
型: string  
必須: いいえ

## LogParameters
<a name="integration-server-sdk-cpp-ref-dataypes-log"></a>

このデータ型は、ゲームセッション中に生成されたファイルのうち、ゲームセッション終了時に Amazon GameLift Servers でアップロードして保存するファイルを識別するのに使用されます。この情報は、[ProcessReady()](integration-server-sdk-cpp-ref-actions.md#integration-server-sdk-cpp-ref-processready) 呼び出しで Amazon GameLift Servers サービスに伝えられます。

### 内容
<a name="integration-server-sdk-cpp-ref-dataypes-log-contents"></a>

**logPaths**  
Amazon GameLift Servers で将来のアクセスに備えて保存するゲームサーバーログファイルへのディレクトリパス。これらのファイルは、各ゲームセッション中に生成されます。ファイルのパスと名前はゲームサーバーで定義され､ルートゲームビルドディレクトリに保存されます。ログパスは絶対パスである必要があります。例えば、ゲームビルドによって `MyGame\sessionlogs\` などのパスに保存されるゲームセッションログのログパスは `c:\game\MyGame\sessionLogs` (Windows インスタンスの場合) または `/local/game/MyGame/sessionLogs` (Linux インスタンスの場合) となります。  
型: std:vector<std::string>  
必須: いいえ

## ProcessParameters
<a name="integration-server-sdk-cpp-ref-dataypes-process"></a>

このデータ型には、[ProcessReady()](integration-server-sdk-cpp-ref-actions.md#integration-server-sdk-cpp-ref-processready) 呼び出しで Amazon GameLift Servers サービスに送られたパラメータセットが含まれます。

### 内容
<a name="integration-server-sdk-cpp-ref-dataypes-process-contents"></a>

**port**  
サーバープロセスが新しいプレイヤーの接続をリスンするポート番号。値は、このゲームサーバービルドをデプロイするすべてのフリートで設定されているポート番号の範囲に含まれる必要があります。このポート番号は、ゲームセッションオブジェクトとプレイヤーセッションオブジェクトに含まれ、ゲームセッションがサーバープロセスに接続するときに使用します。  
型: Integer   
必須: はい

**logParameters**  
ゲームセッションログファイルへのディレクトリパスのリストを含むオブジェクト。  
型: Aws::GameLift::Server::[LogParameters](#integration-server-sdk-cpp-ref-dataypes-log)  
必須: いいえ

**onStartGameSession**  
Amazon GameLift Servers サービスが新しいゲームセッションを 有効化するために呼び出す コールバック関数の名前です。Amazon GameLift Servers は、クライアントリクエスト [CreateGameSession](https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateGameSession.html) に応答して、この関数を呼び出します。コールバック関数は [GameSession](https://docs.aws.amazon.com/gamelift/latest/apireference/API_GameSession.html) オブジェクト (*Amazon GameLift Servers サービス API リファレンス*で定義) を渡します。  
型: `const std::function<void(Aws::GameLift::Model::GameSession)> onStartGameSession`   
必須: はい

**onProcessTerminate**  
Amazon GameLift Servers サービスがサーバープロセスを強制シャットダウンするために呼び出すコールバック関数の名前。この関数を呼び出した後、Amazon GameLift Servers はサーバープロセスがシャットダウンするのを 5 分間待ち、[ProcessEnding()](integration-server-sdk-cpp-ref-actions.md#integration-server-sdk-cpp-ref-processending) 呼び出しで応答します。応答がない場合は、受信サーバープロセスをシャットダウンします。  
型: `std::function<void()> onProcessTerminate`  
必須: いいえ

**onHealthCheck**  
Amazon GameLift Servers サービスがサーバープロセスにヘルスステータスレポートをリクエストするために呼び出すコールバック関数の名前です。Amazon GameLift Servers は、この関数を 60 秒ごとに呼び出します。この関数を呼び出した後、Amazon GameLift Servers はレスポンスを 60 秒ほど待ちます。レスポンスがなければ、サーバープロセスを異常と記録します。  
型: `std::function<bool()> onHealthCheck`  
必須: いいえ

**onUpdateGameSession**  
Amazon GameLift Servers サービスが更新されたゲームセッションオブジェクトをサーバープロセスに渡すために呼び出すコールバック関数の名前です。Amazon GameLift Servers は、[マッチバックフィル](https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-backfill.html)リクエストが処理され、更新されたマッチメーカーデータを提供できる状態になると、この関数を呼び出します。[GameSession](https://docs.aws.amazon.com/gamelift/latest/apireference/API_GameSession.html) オブジェクト、ステータス更新 (`updateReason`)、およびマッチバックフィルチケット ID が渡されます。  
型: `std::function<void(Aws::GameLift::Server::Model::UpdateGameSession)> onUpdateGameSession`   
必須: いいえ

## StartMatchBackfillRequest
<a name="integration-server-sdk-cpp-ref-dataypes-startmatchbackfillrequest"></a>

このデータ型はマッチメーキングバックフィルリクエストの送信に使用します。この情報は、[StartMatchBackfill()](integration-server-sdk-cpp-ref-actions.md#integration-server-sdk-cpp-ref-startmatchbackfill) 呼び出しで Amazon GameLift Servers サービスに伝えられます。

### 内容
<a name="integration-server-sdk-cpp-ref-dataypes-startbackfill-contents"></a>

**GameSessionArn**  
 一意のゲームセッション識別子。API アクション [GetGameSessionId()](integration-server-sdk-cpp-ref-actions.md#integration-server-sdk-cpp-ref-getgamesessionid) は ARN 形式の識別子を返します。  
型: string  
必須: はい

**MatchmakingConfigurationArn**  
このリクエストに使用されるマッチメーカーの ARN 形式の一意な識別子。元のゲームセッションの作成に使用されたマッチメーカーを見つけるには、ゲームセッションオブジェクトのマッチメーカーデータプロパティを確認します。マッチメーカーデータの詳細については「[マッチメーカーデータの処理](https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-server.html#match-server-data)」を参照してください。  
型: string  
必須: はい

**プレイヤー**  
現在ゲームセッションに参加しているすべてのプレイヤーを表すデータのセット。マッチメーカーはこの情報を使用して、現在のプレイヤーとマッチする新しいプレイヤーを検索します。プレイヤーオブジェクトの形式の説明については、*Amazon GameLift Servers API リファレンスガイド*を参照してください。プレイヤー属性、ID、チームの割り当てを見つけるには、マッチメーカーデータプロパティのゲームセッションオブジェクトを参照してください。マッチメーカーでレイテンシーが使用されている場合は、現在のリージョンの更新されたレイテンシーを収集し、それを各プレイヤーのデータに含めます。  
型: std:vector[<player>](https://docs.aws.amazon.com/gamelift/latest/apireference/API_Player.html)  
必須: はい

**TicketId**  
マッチメーキングまたはバックフィルリクエストチケットの一意の識別子。ここで値を指定しない場合、Amazon GameLift Serversによって UUID 形式で自動的に生成されます。この識別子を使用してマッチバックフィルチケットのステータスを追跡したり、必要に応じてリクエストをキャンセルしたりします。  
型: string  
必須: いいえ

## StopMatchBackfillRequest
<a name="integration-server-sdk-cpp-ref-dataypes-stopmatchbackfillrequest"></a>

このデータ型はマッチメーキングバックフィルリクエストのキャンセルに使用します。この情報は、[StopMatchBackfill()](integration-server-sdk-cpp-ref-actions.md#integration-server-sdk-cpp-ref-stopmatchbackfill) 呼び出しで Amazon GameLift Servers サービスに伝えられます。

### 内容
<a name="integration-server-sdk-cpp-ref-dataypes-stopbackfill-contents"></a>

**GameSessionArn**  
キャンセルされるリクエストに関連付けられた一意のゲームセッション識別子。  
型: string  
必須: はい

**MatchmakingConfigurationArn**  
このリクエストが送信されたマッチメーカーの一意の識別子。  
型: string  
必須: はい

**TicketId**  
キャンセルされるバックフィルリクエストチケットの一意の識別子。  
型: string  
必須: はい