Tutorial de atualização da reestruturação da API de entidade

Introdução

Reestruturamos as APIs que estavam agrupadas no grupo Entity API em grupos lógicos coerentes que facilitam seu consumo, tanto pelo site de documentação quanto pelos SDKs do PlayFab. O impacto imediato é que, se você estiver usando as APIs baseadas em entidade no seu jogo, o código precisará ser atualizado quando você atualizar seus SDKs.

Pré-requisitos

As seguintes condições devem ser verdadeiras para que este guia de atualização se aplique a você:

Você está usando as APIs do PlayFab baseadas em entidade.
Você atualizou para um SDK do PlayFab publicado em 9/8/2018 ou posteriormente.

Não há alterações no nível do serviço. Por exemplo, os títulos existentes que usam SDKs antigos continuarão funcionando sem exigir alterações.

Como atualizar

O impacto fundamental dessa alteração é que o grupo de API PlayFabEntityModel foi separado em seis grupos de API diferentes, logicamente agrupados, conforme mostrado na imagem a seguir.

Alterações no grupo de API PlayFabEntityModel

Uma lista completa do mapeamento API de entidade anterior -> Nova API pode ser encontrada no APÊNDICE 1 deste tutorial.

O mapeamento da API clássica não foi afetado.

A próxima seção mostra um exemplo de atualização de um SDK do C# que usa o PlayFabEntityAPIGroup para o novo conjunto de grupos de API.

Exemplo de atualização: SDK do C#

Siga estas etapas para atualizar seu aplicativo. Etapa 1: altere todas as instruções using que fazem referência a PlayFab.EntityModels, como as mostradas abaixo.

using PlayFab.EntityModels;
using PlayFab.DataModels;

Agora você pode escolher de forma granular quais dessas APIs deseja incluir, em vez de importar todo o grupo Entity API. Etapa 2: um exemplo de código mais detalhado da nova API, com comentários sobre como ela era antes, é fornecido abaixo.

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;
}

Faça o mesmo para outros SDKs, usando o mapeamento do APÊNDICE 1 deste tutorial.

Conclusão

Estamos entusiasmados em expor as APIs de entidade de forma mais intuitiva no nosso site de documentação e no nosso código, com base nos seus comentários. Se você tiver dúvidas ou comentários, entre em contato conosco pelos fóruns do PlayFab.

APÊNDICE 1: mapeamentos de API ANTIGA para NOVA

Todas as APIs listadas abaixo faziam parte anteriormente do grupo de API PlayFabEntityModel. Agora, elas estão categorizadas nos seguintes novos grupos de API.

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

​Introdução

​Pré-requisitos

​Como atualizar

​Exemplo de atualização: SDK do C#

​Conclusão

​APÊNDICE 1: mapeamentos de API ANTIGA para NOVA

​PlayFabProfilesApi

​PlayFabAuthenticationApi

​PlayFabDataApi

​PlayFabGroupsApi

​PlayFabEventsApi

​PlayFabCloudScriptApi

Introdução

Pré-requisitos

Como atualizar

Exemplo de atualização: SDK do C#

Conclusão

APÊNDICE 1: mapeamentos de API ANTIGA para NOVA

PlayFabProfilesApi

PlayFabAuthenticationApi

PlayFabDataApi

PlayFabGroupsApi

PlayFabEventsApi

PlayFabCloudScriptApi