Documentation

PlayFab API & SDK Release Notes

Unless otherwise noted, no change will ever affect an existing title. Upgrade warnings are notes about less-than-trivial changes to the sdk which may cause minor compiler errors if you change/upgrade your PlayFab SDK version.

170508 Date: 2017-05-08

API Changes:

  • Breaking Change: ExecuteCloudScript will not serialize the return value of your call, if it is too large.
  • Breaking Change: ExecuteCloudScript will not serialize the logs for your call, if they are too large.
  • Under either of these conditions, the call will still return 200/successful, but the FunctionResult and/or Logs properties will be null.

PlayStream Event Changes:

CSharp SDK Updates:

  • Some unused source files in CSharp SDK have been deleted.
  • This should not affect any existing projects, or the Nuget package, as those files were not referenced by the Visual Studio Solution.

Postman Collection Update:

  • Several common request parameters now utilize environment variables.
  • Specifically, TitleId={{TitleId}}, PlayFabId={{PlayFabId}}, CharacterId={{CharacterId}}, and CatalogVersion={{PrimaryCatalogName}}

170424 Date: 2017-04-24

Sdk Hotfix Release


JavaSdk Updates:

  • We now publish Jar files for the SDK, one for code, and one for javadocs, which you can import into your java project instead of copy-pasting code.  Thanks to Will Iverson for helping us improve our JavaSdk useability

UnityEditorExtensions Updates:

  • We have resolved some install-time exceptions. Specifically it is no longer required that you restart Unity after a first-time install.
  • Additionally, an issue where the Client API was sometimes disabled inappropriately is now fixed. (edited)

UnrealCppSdk Updates:

  • The titleId is now available from the Plugin interface

170411 Date: 2017-04-11

API Changes:

  • New Enterprise Feature: Additional login encryption
  • You can utilize the Policy API methods to enforce Login Calls can require a second layer of encryption
  • See: UpdatePolicy , specifically UpdatePolicyRequest.Statements.ApiConditions
  • This feature is still partially in beta, and activating it is not suggested (yet - Coming Soon!)

New PlayStream Events:

UnitySDK Specific Changes:

  • It is now possible to specify extra headers that will be injected into an API request (This is required for the encrypted login calls above)

UnityEditorExtensions Specific Changes:

  • Fixed a compile issue with Unity 5.6

170406 Date: 2017-04-06

Hot Fix for Unity Android Push Plugin

  • Fixed Android 7.0+ Crash Bug
  • Fixed Android missing Large Icon support ( Lollipop + )
  • Fixed Android Small Icon support on Android 7.0+ ( now supports _transparent.png )

170403 Date: 2017-04-03

API Changes:

  • Client & Server Leaderboard Methods: Get-Leaderboard methods (such as client.GetLeaderboard) previously gained new non-nullable parameters Version and UseSpecificVersion.  The requirement that they were non-nullable was an API-breaking change.  We have updated these properties to be fully optional.
  • Client API: GetPurchaseResult.Items will be deprecated: This portion of the result is often incorrect or incomplete.  It will eventually be replaced with a fully functional parameter.

New PlayStream Events:

  • player_display_name_filtered

Unreal Specific Changes:

  • Unreal CPP SDK: An issue where PlayFab settings such as TitleId were lost when publishing a build has been fixed.
  • Both SDKs have been tested and verified working with Unreal 4.15

JavaSdk Specific Changes

  • JavaSdk folder structure and testing has been restructured
  • The internal folder structure of the repo has changed a bit to accommodate Maven best practices
  • Dependencies are now Maven controlled and no longer included with the SDK
  • Our internal automated testing has been converted to Maven command line
  • Our SDK is NOT available on Maven Central, as that effort has faltered. There is no ETA for completion at this time

UnitySdk Specific Changes:

  • Internal Unity version for testing and building asset bundles updated to 5.6.0. Our Unity SDK remains compatible with all versions of Unity from 4.7 thru 5.6
  • A compile issue with UnityEditorExtensions in Unity 5.6 has been fixed

170223 Date: 2017-02-22

Api Changes:

  • PlayFab leaderboards now store an avatar url for every player.  This can be used to reference a player image for leaderboard entries.
  • All leaderboard APIs can now fetch a specific version of the leaderboard.  This is for titles which are set to use Resetting Leaderboards.
  • Leaderboard entries now contain the PlayerProfile which can be used to display more detailed leaderboards without additional API calls
  • PlayFab can now authenticate clients using Windows Hello and validate Windows Store receipts

New APIs:

New PlayStream Events:

WindowsSDK Specific Changes:

  • Added some missing null checks to the JSON serializer

All SDKs:

  • Minor additions to the testTitleData format.  This only applies to the Example-Test projects that come with SDKs.

170130 Date: 2017-01-29

Breaking Changes:

  • The folder structure for JavaScriptSDK and NodeSDK has been changed with today's major release.  This may result in some broken connections for your project when you upgrade.  (File names and file contents have not changed.  New TypeScript files now exist, which did not exist before)

API Changes:

  • Added clarifying documentation to CDN APIs.  Specifically mentioning that the CDN is not part of our free service.
  • Google login fixes (Blog Post Pending)

New PlayStream Events:

JavaScriptSDK Specific Changes:

  • Release day for a major upgrade!  Version number updated to 1.0
  • TypeScript integration!
  • Repository cleanup: Separating the sdk files from the example files
  • Our example project has been converted to TypeScript
  • See our blog!

NodeSDK:

  • Release day for a major upgrade!  Version number updated to 1.0
  • TypeScript integration!
  • Our example project has been converted to TypeScript
  • See our blog!

CloudScript Examples:

  • Release of a new example repository.
  • TypeScript integration!
  • See our blog!
  • And new repository!
  • We will be expanding this repository over time.

UnitySDK:

  • Fixed an issue where where JsonWrapper did not work as expected in all cases.
  • See our forum post for details: https://community.playfab.com/questions/7599/cloudscript-getplayercombinedinfo-little-problem.html
  • All of the following deprecated wrapper classes have been removed in favor of PlayFab.Json.JsonWrapper
  • PlayFab.Json.JsonConvert (Use PlayFab.Json.JsonWrapper)
  • PlayFab.Json.SimpleJson (Use PlayFab.Json.JsonWrapper or PlayFab.Json.PlayFabSimpleJson)
  • PlayFab.SimpleJson (Use PlayFab.Json.JsonWrapper or PlayFab.Json.PlayFabSimpleJson)
  • Repeating a note from 160627, UnityEngine.SimpleJson is an empty namespace in the UnityEngine.dll, and that makes it necessary for us to not use that identifier.

UnityEditorExtensions:

  • Resolved an issue where the PlayFab panel will re-load infinitely if your account cannot view any studios.
  • Resolved an issue where PlayFabSharedSettings (Scriptable Object) would sometimes not save properly if you picked your title from the PlayFab panel.

170109 Date: 2017-01-08

Breaking Changes:

  • Libs in older versions of WindowsSdk have been removed, and must be re-created in Visual Studio.  Those libs never worked in vs2015, so it's highly suggested you just update to the latest WindowsSdk, published last week.

API Changes:

  • Fixed typos in documentation

All SDKs:

SdkGenerator Changes:

  • The ActionScriptSDK build script was inconsistent from the other SDKs.  The SdkGenerator commands that build ActionScriptSDK have been simplified to match other SDKs.  (No changes to the SDK itself)

UnitySDK Specific Changes:

  • Some public elements in PlayFabSettings have gained Obsolete tags: PlayFabSettings.PlayFabSharedSettings, PlayFabSettings.DefaultPlayFabApiUrl, PlayFabSettings.GetSharedSettingsObject(), PlayFabSettings.ProductionEnvironmentUrl.  These will be made private after a transition period

WindowsSDK Specific Changes:

  • GitHub repo has been BFG'd, and all large files have been removed from the history.  Please delete your clone or fork, and re-create it so that your history is clean.

170102 Date: 2017-01-01

API Changes:

  • Client/GetUserCombinedInfo has transitioned to fully obsolete, and has been removed from the SDK and documentation

Cocos2d-xSDK Specific Changes:

  • Fixed a crash when a PlayFab API returns an invalid response
  • Resolved some compiler warnings
  • Added unit tests for lambda callback functions in our test example project

UnitySdk Specific Changes:

  • We have internally updated to Unity 5.5, and our .unitypackage files are built using this version
  • As always, we continue to support all Unity versions 4.7 and higher
  • Added static constructors to many static classes, in order to solidify the initialization sequence in Mono2x compiler.  This should resolve some of the PlayFabSharedSettings issues we've been seeing in iOS.
  • IDFA/ADID will now work properly for Unity 5.6 beta.
  • KNOWN ISSUE: Unity 5.6 beta builds do not work on Windows Server (OS), which includes PlayFab game-server hosting.  Please contact Unity if this affects you.

WindowsSdk Specific Changes:


161121 Date: 2016-11-20

API Changes:

  • Each Client API can now be individually enabled or disabled
  • See our blog post for details
  • We are releasing a new feature called Scheduled Tasks
  • See our blog post for details: (Coming soon)

New APIs:

New PlayStream Event:

WindowsSdk Specific Changes:

Next Page