엔터티 API 구조 변경 업그레이드 자습서

아티클
11/16/2023

소개

설명서 사이트와 PlayFab SDK 모두를 통해 엔터티 API 그룹으로 묶여 있던 API를 일관된 논리적 그룹으로 재구성하여 더 사용하기 쉽게 만들었습니다.

이를 통해 즉각적으로 발생되는 영향은, 만약 게임에서 엔티티 기반의 API를 사용하고 있다면 SDK 업그레이드 시 코드 업데이트가 필요하다는 것입니다.

필수 조건

본 업그레이드 가이드는 다음 조건이 충족되어야 적용됩니다.

엔터티 기반의 PlayFab API를 사용 중입니다.
2018년 8월 9일 또는 그 이후에 나온 PlayFab SDK로 업그레이드했습니다.

참고 항목

서비스 수준에 대한 변경 사항이 ‘없습니다’. 예를 들어 이전 SDK를 사용하는 기존 타이틀은 변경 없이도 잘 작동합니다.

업그레이드 방법

이 변경에 따라 발생하는 근본적인 영향은 PlayFabEntityModel API 그룹이 다음 그림과 같이 논리적으로 연결되는 여섯 개의 서로 다른 API 그룹으로 분리되었다는 것입니다.

PlayFabEntityModel API 그룹에 대한 변경

이전 엔터티 API ->새로운 API 매핑의 전체 목록은 이 자습서의 부록 1에서 찾을 수 있습니다.

참고 항목

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

다음 섹션에서는 새로운 API 그룹 세트에 PlayFabEntityAPIGroup을 사용하여 C# SDK를 업그레이드하는 예제를 살펴보겠습니다.

업그레이드 예제: 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 매핑

아래에 나열된 모든 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

다음을 통해 공유