エンティティ API 再構成アップグレードチュートリアル

はじめに

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

Entity 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 でも同様に対応してください。

まとめ

皆様のフィードバックを基に、ドキュメントサイトとコードで 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