Der von Microsoft betriebene Backend-Dienst PlayFab hat am 9. August 2018 angekündigt, die bisherige Entity-API aufzuspalten. Die Methoden waren bis dahin unter einer einzigen Gruppe zusammengefasst und verteilen sich seitdem auf mehrere logisch getrennte API-Gruppen. Der Anbieter nennt die Umstellung einen großen SDK-Breaking-Change für alle Entwickler, die mit der früheren Entity-API arbeiten. Wer ein ab dem 9. August 2018 veröffentlichtes SDK einsetzt, kommt um eine Anpassung des eigenen Codes nicht herum. Mehr zur jüngsten Entwicklung des Dienstes steht im Bericht zum PlayFab-Mai-Update.
Aufteilung in sechs API-Gruppen
Der Upgrade-Leitfaden beschreibt, wie die bisherige Gruppe PlayFabEntityModel in sechs eigenständige API-Gruppen zerlegt wird. Die Profilverwaltung wandert in die PlayFabProfilesApi mit Methoden wie GetProfile, GetProfiles, GetGlobalPolicy, SetGlobalPolicy und SetProfilePolicy. Die Token-Ausgabe über GetEntityToken liegt nun in der PlayFabAuthenticationApi. Datei- und Objektzugriffe bündelt die PlayFabDataApi, darunter InitiateFileUploads, FinalizeFileUploads, AbortFileUploads, DeleteFiles, GetFiles sowie GetObjects und SetObjects. Für Gruppen und Rollen ist die PlayFabGroupsApi zuständig, mit Methoden wie CreateGroup, AddMembers, ChangeMemberRole und ListGroupMembers. Dazu kommen die PlayFabEventsApi mit WriteEvents und die PlayFabCloudScriptApi mit ExecuteEntityCloudScript.
Hinter der Umstrukturierung steht laut Anbieter der Wunsch nach einer kohärenteren logischen Gruppierung. Sie soll den Zugriff sowohl über die Dokumentation als auch über die SDKs erleichtern. Den Anstoß gaben Rückmeldungen von Entwicklern. Die Zuordnung der klassischen API bleibt von der Änderung unberührt.
Was Studios beim Upgrade anpassen müssen
Auf Service-Ebene ändert sich nichts. Bestehende Titel, die ältere SDKs nutzen, laufen ohne Eingriffe weiter. Nötig wird die Codeanpassung erst beim Upgrade auf ein SDK ab dem 9. August 2018. Im C-Sharp-SDK trifft das etwa using-Anweisungen wie PlayFab.EntityModels, an deren Stelle granularere Verweise auf die jeweiligen Modellnamespaces treten. Aus Aufrufen über PlayFabEntityAPI mit PlayFab.EntityModels wird beispielsweise die PlayFabProfilesAPI mit PlayFab.ProfilesModels. Eine vollständige Zuordnung der alten zu den neuen Methoden liefert ein Anhang des Upgrade-Leitfadens, zu finden unter dem Quelllink.