實體 API 重新架構升級教學課程 - XBOX Game Development Documentation

簡介

我們已將原本歸類在 Entity API 群組下的 API 重新架構為連貫的邏輯群組，讓您無論是透過文件網站還是 PlayFab SDK，都能更輕鬆地使用它們。直接的影響是，如果您一直在遊戲中使用以實體為基礎的 API，則升級 SDK 時需要更新程式碼。

必要條件

必須符合下列條件，本升級指南才適用於您：

您正在使用以實體為基礎的 PlayFab API。
您已升級至 2018 年 8 月 9 日或之後發佈的 PlayFab SDK。

服務層級沒有任何變更。例如，使用舊版 SDK 的現有遊戲無須變更即可繼續運作。

如何升級

此變更的基本影響是，PlayFabEntityModel API 群組已分成六個在邏輯上相互關聯的不同 API 群組，如下圖所示。

先前的 Entity API -> 新 API 的完整對應清單，請參閱本教學課程的附錄 1。

傳統 API 對應未受到影響。

下一節將逐步引導您完成範例，將使用 PlayFabEntityAPIGroup 的 C# SDK 升級至新的 API 群組集合。

升級範例：C# SDK

請依照下列步驟升級您的應用程式。 步驟 1：變更任何參考 PlayFab.EntityModels 的 using 陳述式，例如下列陳述式。

using PlayFab.EntityModels;
using PlayFab.DataModels;

現在您可以更精細地選擇要引入哪些 API，而不必匯入整個 Entity 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;
}

其他 SDK 請比照辦理，使用本教學課程附錄 1 中的對應。

結論

我們很高興能根據您的意見反應，在文件網站和程式碼中以更直覺的方式公開 Entity 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

​簡介

​必要條件

​如何升級

​升級範例：C# SDK

​結論

​附錄 1：舊 API 至新 API 的對應

​PlayFabProfilesApi

​PlayFabAuthenticationApi

​PlayFabDataApi

​PlayFabGroupsApi

​PlayFabEventsApi

​PlayFabCloudScriptApi

簡介

必要條件

如何升級

升級範例：C# SDK

結論

附錄 1：舊 API 至新 API 的對應

PlayFabProfilesApi

PlayFabAuthenticationApi

PlayFabDataApi

PlayFabGroupsApi

PlayFabEventsApi

PlayFabCloudScriptApi