利用可能な組み込みエンティティの種類
このトピックでは、EntityKey の構築に使用できるエンティティ型について説明します。
エンティティ キーは、新しい API メソッドのほとんどでエンティティを識別します。
EntityKey.Type
フィールドの値を使用して、ID
フィールドに設定する値の種類を決定します。
注意
エンティティ キーは大文字と小文字を区別します。
名前空間
namespace
エンティティは、スタジオ内のすべてのタイトルのすべてのグローバル情報を参照します。
注意
このエンティティへの変更は、リアルタイムで反映されません。
ID
フィールドをゲームの発行元 ID に設定します。
発行元 ID を取得するには:
- ゲーム マネージャーにサインインします。
- ゲーム マネージャーの左上隅の歯車アイコンを選択します。
- [Title Settings (タイトル設定)] を選択します。
- [API 機能] を選択します。
- 発行元 ID は、[API ACCESS] セクションに表示されます。
タイトル
title
エンティティは、タイトルのすべてのグローバル情報を参照します。
注意
このエンティティへの変更は、リアルタイムで反映されません。
ID
フィールドをゲームのタイトル ID に設定します。
タイトル ID を取得するには:
- ゲーム マネージャーにサインインします。
- ゲーム マネージャーの左上隅の歯車アイコンを選択します。
- [Title Settings (タイトル設定)] を選択します。
- [API 機能] を選択します。
- タイトル ID は、[API ACCESS] セクションに表示されます。
master_player_account
master_player_account
は、スタジオ内の全タイトル間で共有されるプレイヤー エンティティです。
ID
フィールドをクラシック API の LoginResult.PlayFabId
に設定します。
LoginResult
を取得するには、Client Authentication でログイン メソッドのいずれかを呼び出します。
title_player_account
ほとんどの開発者にとって、title_player_account
は最も従来的な意味でプレイヤーを表します。
ID
フィールドは、クライアント API の LoginResult.EntityToken.Entity.Id
、または認証 API の GetEntityTokenResponse.Entity.Id
に設定する必要があります。
LoginResult
を取得するには、Client Authentication でログイン メソッドのいずれかを呼び出します。
GetEntityTokenResponse
を取得するには、Get Entity Token を呼び出します。
Character
character
エンティティは title_player_account
のサブエンティティであり、従来型 API のキャラクターの直接的なミラーです。
ID
フィールドを result.Characters[i].CharacterId
から任意の characterId
に設定します。
グループ
group
エンティティは、他のエンティティのコンテナーです。 現在、プレイヤーとキャラクターに制限されています。
グループを作成する場合は ID
フィールドを result.Group.Id
に、メンバーシップを一覧表示するときは、result.Groups[i].Group.Id
に設定します。
game_server
game_server
エンティティは、主にマッチメイキングおよびロビー機能で使用するためにゲーム サーバーが使用する一意のエンティティです。 今後のシナリオは、他の PlayFab 機能をサポートするために追加される可能性があります。
このエンティティは、マッチメイキングとロビーのリアルタイム更新をサブスクライブしたり、ロビー所有者の移行などの特定の機能をサポートしたりするために、ゲーム サーバーに独自の ID を提供します。
game_server
のエンティティとして認証するには、API AuthenticateGameServerWithCustomId をタイトル エンティティとして呼び出し、game_server
エンティティ キーとトークンのペアを取得します。
PFMultiplayerSetEntityToken で PlayFab マルチプレイヤー SDK を使用する場合は、このエンティティ キーを使用します。