Tutoriel de mise à niveau suite à la restructuration de l'API d'entité

Introduction

Nous avons restructuré les API qui étaient regroupées sous le groupe Entity API en groupes logiques cohérents, afin d’en faciliter l’utilisation, à la fois au moyen du site de documentation et les SDK PlayFab. La conséquence immédiate est que, si vous utilisiez les API basées sur les entités dans votre jeu, le code devra être mis à jour lorsque vous mettrez à niveau vos SDK.

Prérequis

Les conditions suivantes doivent être remplies pour que ce guide de mise à niveau s’applique à vous :

Vous utilisez les API PlayFab basées sur les entités.
Vous avez effectué la mise à niveau vers un SDK PlayFab publié le 9/8/2018 ou ultérieurement.

Il n’y a aucune modification au niveau du service. Par exemple, les titres existants utilisant d’anciens SDK continueront de fonctionner sans nécessiter de modifications.

Procédure de mise à niveau

L’impact fondamental de ce changement est que le groupe d’API PlayFabEntityModel a été scindé en six groupes d’API distincts, liés logiquement entre eux, comme le montre l’image suivante.

Modifications du groupe d'API PlayFabEntityModel

La liste complète des correspondances Previous Entity API -> New API se trouve dans l’ANNEXE 1 de ce tutoriel.

Le mappage de l’API classique n’a pas été modifié.

La section suivante présente un exemple de mise à niveau d’un SDK C# utilisant le PlayFabEntityAPIGroup vers le nouvel ensemble de groupes d’API.

Exemple de mise à niveau : SDK C#

Suivez ces étapes pour mettre à niveau votre application. Étape 1 : modifiez toutes les instructions using qui référencent PlayFab.EntityModels, comme celles présentées ci-dessous.

using PlayFab.EntityModels;
using PlayFab.DataModels;

Vous pouvez désormais choisir précisément les API que vous souhaitez importer, au lieu d’importer tout le groupe Entity API. Étape 2 : un exemple de code plus détaillé de la nouvelle API, avec des commentaires indiquant à quoi il ressemblait auparavant, est fourni ci-dessous.

public async void Example()
{
       var logrequest = new PlayFab.ClientModels.LoginWithCustomIDRequest
       {
           CustomId = "TestExample",
           CreateAccount = true,
       };

       var loginResult = await PlayFab.PlayFabClientAPI.LoginWithCustomIDAsync(logrequest);
       var playfabId = loginResult?.Result?.PlayFabId;

       // PlayFab EntityAPI has been replaced here with the PlayFabProfilesAPI
       // and PlayFab.EntityModels has been replaced with PlayFab.ProfileModels
       var getProfileResult = await PlayFab.PlayFabProfilesAPI.GetProfileAsync(new
       PlayFab.ProfilesModels.GetEntityProfileRequest());
       var profile = getProfileResult?.Result?.Profile;
}

Procédez de même pour les autres SDK, en utilisant les correspondances de l’ANNEXE 1 de ce tutoriel.

Conclusion

Nous sommes ravis d’exposer les API d’entité de façon plus intuitive sur notre site de documentation et dans notre code, en fonction de vos commentaires. Si vous avez des questions ou des commentaires, contactez-nous au moyen des forums PlayFab.

ANNEXE 1 : correspondances entre les ANCIENNES et les NOUVELLES API

Toutes les API répertoriées ci-dessous faisaient auparavant partie du groupe d’API PlayFabEntityModel. Elles sont désormais classées dans les nouveaux groupes d’API suivants.

PlayFabProfilesApi

GetGlobalPolicy
GetProfile
GetProfiles
SetGlobalPolicy
SetProfilePolicy

PlayFabAuthenticationApi

GetEntityToken

PlayFabDataApi

AbortFileUploads
DeleteFiles
FinalizeFileUploads
GetFiles
InitiateFileUploads
GetObjects
SetObjects

PlayFabGroupsApi

AcceptGroupApplication
AcceptGroupInvitation
AddMembers
ApplyToGroup
BlockEntity
ChangeMemberRole
CreateGroup
CreateRole
DeleteGroup
DeleteRole
GetEntityToken
GetGroup
InviteToGroup
IsMember
ListGroupApplications
ListGroupBlocks
ListGroupInvitations
ListGroupMembers
ListMembershipOpportunities
RemoveGroupApplication
RemoveGroupInvitation
RemoveMembers
UnblockEntity
UpdateGroup
UpdateRole

PlayFabEventsApi

WriteEvents

PlayFabCloudScriptApi

ExecuteEntityCloudScript

​Introduction

​Prérequis

​Procédure de mise à niveau

​Exemple de mise à niveau : SDK C#

​Conclusion

​ANNEXE 1 : correspondances entre les ANCIENNES et les NOUVELLES API

​PlayFabProfilesApi

​PlayFabAuthenticationApi

​PlayFabDataApi

​PlayFabGroupsApi

​PlayFabEventsApi

​PlayFabCloudScriptApi

Introduction

Prérequis

Procédure de mise à niveau

Exemple de mise à niveau : SDK C#

Conclusion

ANNEXE 1 : correspondances entre les ANCIENNES et les NOUVELLES API

PlayFabProfilesApi

PlayFabAuthenticationApi

PlayFabDataApi

PlayFabGroupsApi

PlayFabEventsApi

PlayFabCloudScriptApi