Tutorial zur Umstrukturierung des Entitäts-API-Upgrades

Artikel
11/16/2023

Einführung

Wir haben die APIs, die unter der Entitäts-API-Gruppe zusammengefasst wurden, in kohärente logische Gruppen umstrukturiert, die ihre Nutzung vereinfachen, sowohl über die Dokumentationswebsite als auch über die PlayFab SDKs.

Die unmittelbare Auswirkung ist, dass, wenn Sie die entitätsbasierten APIs in Ihrem Spiel verwendet haben, der Code aktualisiert werden muss, wenn Sie Ihre SDKs aktualisieren.

Voraussetzungen

Die folgenden Bedingungen müssen erfüllt sein, damit dieser Upgradeleitfaden für Sie gilt:

Sie verwenden die entitätsbasierten PlayFab-APIs.
Sie haben ein Upgrade auf ein PlayFab SDK durchgeführt, das am 09.08.2018 oder höher veröffentlicht wurde.

Notiz

Es gibt keine Änderungen am Servicelevel. Beispielsweise funktionieren vorhandene Titel, die alte SDKs verwenden, ohne Dass Änderungen erforderlich sind.

Upgrade

Die grundlegende Auswirkung dieser Änderung besteht darin, dass die PlayFabEntityModel API-Gruppe in sechs verschiedene API-Gruppen aufgeteilt wurde, die logisch miteinander verbunden sind, wie in der folgenden Abbildung dargestellt.

Änderungen an der PlayFabEntityModel-API-Gruppe

Eine vollständige Liste der Zuordnung der vorherigen Entitäts-API> – Neue API finden Sie in ANHANG 1 dieses Tutorials.

Notiz

Die Zuordnung der klassischen API ist nicht betroffen.

Der nächste Abschnitt führt Sie durch ein Beispiel für das Upgrade eines C#-SDK mit auf PlayFabEntityAPIGroup die neuen API-Gruppen.

Upgradebeispiel: C#-SDK

Führen Sie die folgenden Schritte aus, um ein Upgrade für Ihre Anwendung durchzuführen.

Schritt 1: Ändern Sie alle using Anweisungen, die auf die unten gezeigten verweisen PlayFab.EntityModels .

using PlayFab.EntityModels;
using PlayFab.DataModels;

Sie können jetzt genau festlegen, welche dieser APIs Sie einbinden möchten, anstatt die gesamte Entitäts-API-Gruppe zu importieren.

Schritt 2: Ein ausführlicheres Codierungsbeispiel für die neue API mit Kommentaren zu ihrer Darstellung finden Sie unten.

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

Folgen Sie anderen SDKs, indem Sie die Zuordnung aus ANHANG 1 in diesem Tutorial verwenden.

Abschluss

Wir freuen uns, die Entitäts-APIs basierend auf Ihrem Feedback auf unserer Dokumentationswebsite und in unserem Code intuitiver verfügbar zu machen.

Wenn Sie Fragen und Kommentare haben, kontaktieren Sie uns bitte über die PlayFab-Foren.

ANHANG 1: ZUORDNUNGEN ZWISCHEN ALT UND NEU

Alle unten aufgeführten APIs waren zuvor Teil der PlayFabEntityModel API-Gruppe. Sie sind jetzt unter den folgenden neuen API-Gruppen kategorisiert.

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

Freigeben über