Entities migration information

The entity API introduces new access patterns that are designed to alleviate the pain points of the current account and data systems. The information presented here’s useful if you have previously used the following methods to implement data management for your Title, Player, or Character information. Title access:

client/GetTitleData
admin/GetTitleData
server/GetTitleData

Player access:

Character access:

client/GetCharacterData
client/UpdateCharacterData

Using the entities API, you can call a single method to save the data values for title, player, and character entity types. The API provides access rules that replicate and expand the current system behavior of custom data in a better interface. In some regards, these changes aren’t backwards compatible. However, you can add calls to the entity API without changing the behavior of the existing APIs.

Terminology

The following table describes refinements in terminology related to the entity APIs.

Term	Description
title	This concept is unchanged. Your title may contain global information available to all players. This is similar to TitleData. It’s identified by the title ID (`TitleId`) of the game/application.
master_player_account	This entity type allows you to share information about a player across multiple games in a namespace. This is similar to UserPublisherData. It’s identified by the player ID (`PlayFabId`) of the player, which is returned as part of any login or any call to retrieve account information for the player account (for example, the PlayFab Client API GetAccountInfo).
title_player_account	This concept is based on user/player in the existing API methods. Each player can contain some information for the current title. This is similar to the GetUserData method. This is identified by the entity ID (`EntityKey.Id`) you get back in the EntityKey object on any login where you specify `LoginTitlePlayerAccountEntity` as `True`.
character	This concept is unchanged. Your player may own characters, which can each contain some information. This is similar to CharacterData. It’s identified by the character ID (`CharacterId`) of the character.
PlayFabId	Formerly this term covered both `master_player_account` and `title_player_account` concepts. Separating these concepts simplifies and clarifies the functionality. A player can interact with multiple titles in the same namespace. The player can have unique information in a different `title_player_account` for each title and a single `master_player_account` with shared data across titles. This enables cross-promotion of games and cross-game rewards.

XBOX Services

PlayFab

Terminology

See also

​Terminology

​See also

Terminology

See also