엔터티 API 재구성 업그레이드 튜토리얼 - XBOX Game Development Documentation

소개

엔터티 API 그룹에 뭉쳐 있던 API를 문서 사이트와 PlayFab SDK 모두에서 더 쉽게 사용할 수 있도록 일관성 있는 논리적 그룹으로 재구성했습니다. 즉각적인 영향은 게임에서 엔터티 기반 API를 사용해 왔다면 SDK를 업그레이드할 때 코드를 업데이트해야 한다는 점입니다.

사전 요구 사항

이 업그레이드 가이드가 적용되려면 다음 조건이 모두 참이어야 합니다.

엔터티 기반 PlayFab API를 사용하고 있습니다.
2018년 8월 9일 이후에 게시된 PlayFab SDK로 업그레이드했습니다.

서비스 수준의 변경 사항은 없습니다. 예를 들어, 이전 SDK를 사용하는 기존 타이틀은 변경 없이 계속 작동합니다.

업그레이드 방법

이번 변경의 근본적인 영향은 PlayFabEntityModel API 그룹이 다음 그림과 같이 논리적으로 연관된 6개의 서로 다른 API 그룹으로 분리되었다는 점입니다.

이전 엔터티 API -> 새 API 매핑의 전체 목록은 이 튜토리얼의 부록 1에서 확인할 수 있습니다.

클래식 API 매핑은 영향을 받지 않았습니다.

다음 섹션에서는 PlayFabEntityAPIGroup을 사용하는 C# SDK를 새로운 API 그룹 세트로 업그레이드하는 예제를 안내합니다.

업그레이드 예제: C# SDK

애플리케이션을 업그레이드하려면 다음 단계를 따르세요. 1단계: 다음과 같이 PlayFab.EntityModels를 참조하는 using 문을 변경합니다.

using PlayFab.EntityModels;
using PlayFab.DataModels;

이제 전체 엔터티 API 그룹을 가져오는 대신 어떤 API를 가져올지 세부적으로 선택할 수 있습니다. 2단계: 새 API에 대한 더 상세한 코딩 예제는 아래와 같으며, 이전에는 어떻게 작성되었는지에 대한 주석이 포함되어 있습니다.

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

이 튜토리얼의 부록 1에 있는 매핑을 사용하여 다른 SDK도 동일한 방식으로 진행합니다.

결론

여러분의 피드백을 바탕으로 문서 사이트와 코드에서 엔터티 API를 보다 직관적인 방식으로 노출하게 되어 기쁘게 생각합니다. 질문이나 의견이 있으시면 PlayFab 포럼을 통해 문의해 주세요.

부록 1: 이전에서 새 API로의 매핑

아래에 나열된 모든 API는 이전에 PlayFabEntityModel API 그룹의 일부였습니다. 이제 다음 새 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

​소개

​사전 요구 사항

​업그레이드 방법

​업그레이드 예제: C# SDK

​결론

​부록 1: 이전에서 새 API로의 매핑

​PlayFabProfilesApi

​PlayFabAuthenticationApi

​PlayFabDataApi

​PlayFabGroupsApi

​PlayFabEventsApi

​PlayFabCloudScriptApi

소개

사전 요구 사항

업그레이드 방법

업그레이드 예제: C# SDK

결론

부록 1: 이전에서 새 API로의 매핑

PlayFabProfilesApi

PlayFabAuthenticationApi

PlayFabDataApi

PlayFabGroupsApi

PlayFabEventsApi

PlayFabCloudScriptApi