Changelog

All notable changes to this package will be documented in this file.

The format is based on Keep a Changelog and this project adheres to Semantic Versioning.

[1.3.1] - 2025-10-30

Added

  • Deprecation notice in documentation
  • Documentation page listing known issues with the JavaScript SDK

[1.3.0] - 2025-10-20

Added

  • Community API:
    • FBInstant.Community.CanFollowOfficialPageAsync
    • FBInstant.Community.CanJoinOfficialGroupAsync
    • FBInstant.Community.FollowOfficialPageAsync
    • FBInstant.Community.JoinOfficialGroupAsync
  • GamingSquads API:
    • AddToGamingSquadPayload class
    • CreateGamingSquadPayload class
    • FBInstant.Squads
    • GamingSquad class
    • GamingSquad.AddToSquadAsync
    • GamingSquad.GetContextID
    • GamingSquad.GetID
    • GamingSquad.GetImage
    • GamingSquad.GetName
    • GamingSquad.JoinAsync
    • GamingSquad.LeaveAsync
    • GamingSquads class
    • GamingSquads.CanUseSquadsAsync
    • GamingSquads.CreateAsync
    • GamingSquads.GetAsync
    • GamingSquads.GetPlayerSquadsAsync
    • JoinGamingSquadPayload class
    • LeaveGamingSquadPayload class
  • GraphApi class:
    • FBInstant.GraphApi.RequestAsync
  • Leaderboard API:
    • FBInstant.GetLeaderboardAsync
    • Leaderboard class
      • Leaderboard.GetConnectedPlayerEntriesAsync
      • Leaderboard.GetContextID
      • Leaderboard.GetEntriesAsync
      • Leaderboard.GetEntryCountAsync
      • Leaderboard.GetName
      • Leaderboard.GetPlayerEntryAsync
      • Leaderboard.SetScoreAsync
    • LeaderboardEntry class
      • LeaderboardEntry.GetExtraData
      • LeaderboardEntry.GetFormattedScore
      • LeaderboardEntry.GetPlayer
      • LeaderboardEntry.GetRank
      • LeaderboardEntry.GetScore
      • LeaderboardEntry.GetTimestamp
    • LeaderboardPlayer class
      • LeaderboardPlayer.GetID
      • LeaderboardPlayer.GetName
      • LeaderboardPlayer.GetPhoto
  • LiveMatch API:
    • LiveMatch class
      • LiveMatch.GetID
      • LiveMatch.GetContextID
  • Lifecycle API:
    • FBInstant.GetLocale
    • FBInstant.GetPlatform
    • FBInstant.GetSDKVersion
    • FBInstant.LogEvent
    • FBInstant.SetLoadingProgress
    • FBInstant.SwitchGameAsync
  • Player API
    • Player.FlushDataAsync
  • Social API:
    • FBInstant.CheckCanPlayerMatchAsync
    • FBInstant.MatchPlayerAsync
    • FBInstant.Room.GetCurrentMatchAsync
  • Share API:
    • FBInstant.GetEntryPointAsync
    • FBInstant.GetEntryPointData
    • FBInstant.InviteAsync
    • FBInstant.PostSessionScoreAsync
    • FBInstant.ShareAsync
    • InviteFilter enum
    • InvitePayload class
    • InviteSection class
    • InviteSectionType enum
  • Switch API:
    • FBInstant.CanSwitchNativeGameAsync
    • FBInstant.SwitchNativeGameAsync
  • Tournament API:
    • Tournament.GetTournamentType

Deprecated

  • Documented MediaParams and MediaContent as deprecated.

Fixed

  • Fixed a bug for endpoints that take a user callback parameter so that the callback can be invoked multiple times without throwing an error.
  • Increased the timeout when initializing the Facebook Instant Games SDK to allow for more time to complete in unstable network conditions.

[1.2.0] - 2025-06-30

Added

  • Player API:
    • SignedASID class
    • Player.GetID
    • Player.GetASIDAsync
    • Player.GetSignedASIDAsync
    • SignedASID.GetASID
    • SignedASID.GetSignature
  • Lifecycle API:
    • FBInstant.OnPause
    • ScreenshotPayloadclass
    • FBInstant.RegisterScreenshotProvider
  • Remaining Context API:
    • FBInstant.Context.GetID
    • ContextType enum
    • FBInstant.Context.GetType
    • ContextSizeResponse class
    • FBInstant.Context.IsSizeBetween
    • FBInstant.SetSessionData

Changed

  • Documentation for FBInstant.Context.CreateAsync as it only accepts a one-element array as the argument
  • Updated minimum Unity version in documentation to match package.json: 6000.1.0a6

[1.1.0] - 2025-04-24

Added

  • Payments API:
    • Payments class
    • Purchase class
    • PurchaseConfig class
    • PurchasePlatform enum
    • FBInstant.Payments.GetPurchasesAsync
    • FBInstant.Payments.ConsumePurchaseAsync
    • FBInstant.Payments.OnReady
    • FBInstant.Payments.GetCatalogAsync
    • FBInstant.Payments.PurchaseAsync
  • Class JsResult for retrieving the result of a JavaScript function call, propagating to C# any JavaScript exception
  • Documentation about error handling and upgrading.

Changed

  • Implemented exception propagation from JavaScript to C# for all API endpoints
  • Implemented exception propagation from JavaScript to C# for JS object member accessors

[1.0.0] - 2025-02-14

Added

Removed

  • Removed top-level container class Sdk
  • Removed JsNative namespace

Changed

  • Changed namespace Runtime to Meta.InstantGames.Runtime
  • Moved entities in JsNative namespace to Meta.InstantGames.Runtime
  • Made Meta.InstantGames.FBInstant a static class, allowing usage analogous to the JavaScript SDK, with no need to first instantiate an object.
  • Changed object initialization from JavaScript to use an empty object {} instead of Object.create(null)
  • Changed terms of service in LICENSE.md
  • Made property Uuid on SDK classes internal
  • Renamed class JsNative to JsObject
  • Class APIError derives from JsException and inherits its Message property from the base class
  • Moved JavaScript helper functions to new global object JSRuntime

Fixed

  • Fixed return value of FBInstant.Tournament.GetPayload from JSON serializable object to nullable string
  • Fixed handling of undefined strings returned from JavaScript SDK endpoints

[1.0.0-pre.1] - 2025-01-06

Removed

  • Moved test code to separate package com.unity.meta-instant-games-sdk.tests.

Changed

  • Made Meta.InstantGames.APIError throwable and removed property JsException and its corresponding class

[0.0.1-exp.3] - 2024-12-17

Added

  • Function WaitForCompletion in WebTask and WebTask<T> so that they are compatible with coroutines
  • Build preprocessor that selectively includes auto-bootstrapping of the SDK when building for UNITY_FACEBOOK_INSTANT_GAMES
  • Requirements section to document the system requirements to use this package
  • Timeout of 3000ms for calls InitializeAsync and StartGameAsync in auto-bootstrapping

Changed

  • C# API member names (methods, properties) are PascalCase instead of CamelCase

Fixed

  • Build hanging in a general Web build when package is added to a project.

[0.0.1-exp.2] - 2024-12-02

Added

  • Monetization APIs:
    • FBInstant.getInterstitialAdAsync
    • FBInstant.loadBannerAdAsync
    • FBInstant.hideBannerAdAsync
    • FBInstant.getRewardedVideoAsync
    • FBInstant.getRewardedInterstitialAsync
    • AdInstance class
    • AdInstance.getPlacementID
    • AdInstance.loadAsync
    • AdInstance.showAsync
  • init.jspre file that will download and initialize the JavaScript SDK

Changed

  • Namespace for the C# bindings has changed from Internal.Bindings to Meta.InstantGames.
  • Top level class for the C# bindings has changed from FacebookInstantGamesSDK to Sdk

[0.0.1-exp.1] - 2024-10-16

This is the first (experimental) release of Unity Package com.unity.meta-instant-games-sdk.

Added

  • Added initial package contents.