エンティティ API 再構成の更新チュートリアル

  • [アーティクル]

はじめに

ドキュメント サイト と PlayFab SDK を介して、エンティティ API グループ内の、容易に利用できる一貫性のある論理グループに API をひとかまりにして再構築しました。

すぐに出る影響は、ゲームでエンティティベースの API を使用していた場合、SDK をアップグレードする際にコードを更新する必要があります。

前提条件

適用する場合に、このアップグレード ガイドの次の条件を満たしている必要があります。

  1. エンティティベースの PlayFab API を使用しています。
  2. 2018 年 8 月 9 日以降で公開されている PlayFab SDK にアップグレードしました。

注意

サービスレベルの変更は ありません。 たとえば、古い SDK を使用している既存のタイトルは、変更の必要がありません。

アップグレード方法

この変更の本質的な影響は、次の図で示すように、PlayFabEntityModel API グループが論理的に結合された 6 つの異なる API グループに分割されていることです。

PlayFabEntityModel API グループへの変更

[以前のエンティティ API] -> [新しい API] の完全な一覧のマッピングが、このチュートリアルの [付録 1] に記載されています。

注意

従来の API マッピングは影響を受けて いません。

次のセクションでは、PlayFabEntityAPIGroup を使用して新しい API グループセットに 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;
}

他の SDK に対しても、このチュートリアルの付録 1 のマッピングを使用して同様の手順を実行してください。

まとめ

お客様のフィードバックを元にドキュメント サイトやコードがより直感的で使いやすくなったエンティティ 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