Deprecated API classes

Identify deprecated Unity Ads SDK classes across Unity, Android, and iOS, along with their replacements and removal versions.

Read time 6 minutes

Last updated 4 hours ago

Unity (C#)

The following API classes are deprecated or obsolete for the Unity SDK:

API to be removed	Deprecated in version	What to use instead	Removed in version	Depreciation reason
`IsReady()`	NA	Use the updated `Load` method signature to access load callbacks.	4.0.0	No longer required with `Load` and `Show` functionality.
`IsReady(string placementId)`	NA	Use the updated `Load` method signature to access load callbacks.	4.0.0	No longer required with `Load` and `Show` functionality.
`AddListener(IUnityAdsListener listener)`	NA	Use the `Initialize` , `Load` , and `Show` methods' listeners.	4.0.0	Improved callbacks for `Load` and `Show` APIs.
`RemoveListener(IUnityAdsListener listener)`	NA	Use the `Initialize` , `Load` , and `Show` methods' listeners.	4.0.0	Improved callbacks for `Load` and `Show` APIs.
`GetPlacementState()`	NA	No direct replacement.	4.0.0	Improved callbacks for `Load` and `Show` APIs.
`GetPlacementState(string placementId)`	NA	No direct replacement.	4.0.0	No longer required with `Load` and `Show` functionality.
`IUnityAdsListener`	NA	Use the `IUnityAdsInitializationListener` , `IUnityAdsLoadListener` , and `IUnityAdsShowListener` interfaces.	4.0.0	Improved callbacks for `Load` and `Show` APIs.
`Show()`	NA	Use the (/grow/ads/unity-sdk/unity-api#show)Show(string placementId) method signature to specify an Ad Unity ID.	4.0.0	Updated `Load` and `Show` functionality.
`ShowOptions.resultCallback`	3.1.0	Use the `IUnityAdsShowListener` interface callbacks.	4.0.0	Updated `Load` and `Show` functionality.

Android (Java)

The following API classes are deprecated or obsolete for the Android SDK:

API to be removed	Deprecated in version	What to use instead	Removed in version	Depreciation reason
`initialize(final Activity activity, final String gameId, final IUnityAdsListener listener)`	3.4.0	Use the consolidated `initialize` method signature.	4.0.0	Replaced by consolidated `initialize` API.
`initialize(final Activity activity, final String gameId)`	3.4.0	Use the consolidated `initialize` method signature.	4.0.0	Replaced by consolidated `initialize` API.
`initialize(final Activity activity, final String gameId, final IUnityAdsInitializationListener initializationListener)`	3.4.0	Use the consolidated `initialize` method signature.	4.0.0	Replaced by consolidated `initialize` API.
`initialize(final Activity activity, final String gameId, final IUnityAdsListener listener, final boolean testMode)`	3.4.0	Use the consolidated `initialize` method signature.	4.0.0	Replaced by consolidated `initialize` API.
`initialize(final Activity activity, final String gameId, final boolean testMode)`	3.4.0	Use the consolidated `initialize` method signature.	4.0.0	Replaced by consolidated `initialize` API.
`initialize(final Activity activity, final String gameId, final boolean testMode, final IUnityAdsInitializationListener initializationListener)`	3.4.0	Use the consolidated `initialize` method signature.	4.0.0	Replaced by consolidated `initialize` API.
`initialize(final Activity activity, final String gameId, final IUnityAdsListener listener, final boolean testMode, final boolean enablePerPlacementLoad)`	3.4.0	Use the consolidated `initialize` method signature.	4.0.0	Replaced by consolidated `initialize` API.
`initialize(final Activity activity, final String gameId, final boolean testMode, final boolean enablePerPlacementLoad)`	3.4.0	Use the consolidated `initialize` method signature.	4.0.0	Replaced by consolidated `initialize` API.
`initialize(final Activity activity, final String gameId, final boolean testMode, final boolean enablePerPlacementLoad, final IUnityAdsInitializationListener initializationListener)`	3.4.0	Use the consolidated `initialize` method signature.	4.0.0	Replaced by consolidated `initialize` API.
`initialize(final Context context, final String gameId, final boolean testMode, final boolean enablePerPlacementLoad)`	NA	Use the consolidated `initialize` method signature.	4.0.0	Replaced by consolidated `initialize` API.
`initialize(final Context context, final String gameId, final boolean testMode, final boolean enablePerPlacementLoad, final IUnityAdsInitializationListener initializationListener)`	NA	Use the consolidated `initialize` method signature.	4.0.0	Replaced by consolidated `initialize` API.
`setListener(IUnityAdsListener listener)`	3.4.0	Use the `initialize` , [ `load` ] `load` , and [ `show` ] `show` methods' listeners.	4.0.0	Improved callbacks for `Show` and `Load` APIs.
`getListener()`	3.4.0	Use the `initialize` , `load` , and `show` methods' listeners.	4.0.0	Improved callbacks for `Show` and `Load` APIs.
`addListener(IUnityAdsListener listener)`	NA	Use the `initialize` , `load` , and `show` methods' listeners.	4.0.0	Improved callbacks for `Show` and `Load` APIs.
`removeListener(IUnityAdsListener listener)`	NA	Use the `initialize` , `load` , and `show` methods' listeners.	4.0.0	Improved callbacks for `Show` and `Load` APIs.
`isReady()`	3.7.1	Use the updated `load` method signature to access load callbacks.	4.0.0	Introduced a `Load` API with callbacks.
`isReady(String placementId)`	3.7.1	Use the updated `load` method signature to access load callbacks.	4.0.0	Introduced a `Load` API with callbacks.
`getPlacementState()`	NA	No direct replacement.	4.0.0	No longer required with `Load` and `Show` functionality.
`show(final Activity activity)`	3.7.0	Use the updated `show` method signature to access show callbacks.	4.0.0	Introduced a `Show` API with callbacks.
`IUnityAdsListener`	NA	Use the `IUnityAdsInitializationListener` , `IUnityAdsLoadListener` , `IUnityAdsShowListener` interfaces.	4.0.0	Improved callbacks for `Show` and `Load` APIs.
`IUnityAdsExtendedListener`	NA	Use the `IUnityAdsShowListener` interface.	4.0.0	Improved callbacks for `Show` and `Load` APIs.
`com.unity3d.services.monetization`	NA	Use the `UnityAds.java` API.	4.0.0	Legacy `Monetization` API not supported.
`com.unity3d.services.purchasing`	NA	No direct replacement.	4.0.0	Legacy `Monetization` API not supported.

iOS (Objective-C)

The following API classes are deprecated or obsolete for the iOS SDK:

API to be removed	Deprecated in version	What to use instead	Removed in version	Depreciation reason
`UnityAdsDelegate`	NA	Use the `UnityAdsInitializationDelegate` , `UnityAdsLoadDelegate` , and `UnityAdsShowDelegate` interfaces.	4.0.0	Replaced by consolidated `Initialize` API.
`UnityAdsDelegateUtil`	NA	Use the `UnityAdsInitializationDelegate` , `UnityAdsLoadDelegate` , and `UnityAdsShowDelegate` interfaces.	4.0.0	Replaced by consolidated `Initialize` API.
`UADSInAppPurchaseMetaData`	NA	No direct replacement; however you can use the generic `MetaData` class.	4.0.0	Replaced by consolidated `Initialize` API.
`UnityAdsExtendedDelegate`	NA	Use the `UnityAdsInitializationDelegate` , `UnityAdsLoadDelegate` , and `UnityAdsShowDelegate` interfaces.	4.0.0	Replaced by consolidated `Initialize` API.
`initialize: (NSString *)gameId delegate: (nullable id&#x3-c;-unity-ads-delegate>)`	3.4.0	Use the consolidated `Initialize` method signature.	4.0.0	Replaced by consolidated `Initialize` API.
`initialize: (NSString *)gameId delegate: (nullable id&#x3-c;-unity-ads-delegate>)delegate testMode: (BOOL)testMode`	3.4.0	Use the consolidated `Initialize` method signature.	4.0.0	Replaced by consolidated Initialize API.
`initialize: (NSString *)gameId delegate: (nullable id&#x3-c;-unity-ads-delegate>)delegate testMode: (BOOL)testMode enablePerPlacementLoad: (BOOL)enablePerPlacementLoad`	3.4.0	Use the consolidated `Initialize` method signature.	4.0.0	Replaced by consolidated Initialize API.
`initialize: (NSString *)gameId testMode: (BOOL)testMode enablePerPlacementLoad: (BOOL)enablePerPlacementLoad`	3.4.0	Use the consolidated `Initialize` method signature.	4.0.0	Replaced by consolidated `initialize` API.
`initialize: (NSString *)gameId testMode: (BOOL)testMode enablePerPlacementLoad: (BOOL)enablePerPlacementLoad initializationDelegate: (nullable id&#x3-c;-unity-ads-initialization-delegate>)initializationDelegate;`	3.4.0	Use the consolidated `Initialize` method signature.	4.0.0	Replaced by consolidated `initialize` API.
`show: (UIViewController *)viewController`	3.7.0	Use the updated `show` method signature.	4.0.0	Introduced a `show` API with callbacks.
`show: (UIViewController )viewController placementId: (NSString )placementId`	3.7.0	Use the updated `show` method signature.	4.0.0	Introduced a `show` API with callbacks.
`show: (UIViewController )viewController placementId: (NSString )placementId options: (UADSShowOptions *)options`	3.7.0	Use the updated `show` method signature.	4.0.0	Introduced a `Show` API with callbacks.
`getDelegate`	3.4.0	Use the `Initialize` , `load` , and `show` methods' delegate interfaces.	4.0.0	No longer required with `Load` and `Show` functionality.
`setDelegate: (id&#x3-c;-unity-ads-delegate>)delegate`	3.4.0	Use the `Initialize` , `load` , and `show` methods' delegate interfaces.	4.0.0	No longer required with `Load` and `Show` functionality.
`addDelegate: (__nullable id&#x3-c;-unity-ads-delegate>)delegate`	3.7.0	Use the `Initialize` , `load` , and `show` methods' delegate interfaces.	4.0.0	No longer required with `Load` and `Show` functionality.
`removeDelegate: (id&#x3-c;-unity-ads-delegate>)delegate;`	NA	Use the `Initialize` , `load` , and `show` methods' delegate interfaces.	4.0.0	No longer required with Load and Show functionality.
`isReady`	3.7.1	Use the updated `load` method signature.	4.0.0	Introduced a `load` API with callbacks.
`isReady: (NSString *)placementId`	3.7.1	Use the updated `load` method signature.	4.0.0	Introduced a `load` API with callbacks.
`getPlacementState`	NA	No direct replacement.	4.0.0	No longer required with `Load` and `Show` functionality.
`getPlacementState: (NSString *)placementId`	NA	No direct replacement.	4.0.0	No longer required with `Load` and `Show` functionality.
All of the `monetization` classes	3.4.0	Use the `UnityAdvertisement.h` class.	4.0.0	Legacy `Monetization` API not supported.
All of the `purchasing` classes	3.4.0	No direct replacement.	4.0.0	Legacy `Monetization` API not supported.

Documentation

Engine

Services

Grow

Industry

Support

Unity Ads Monetization

Android developer monetization guide

iOS developer monetization guide

Privacy consent setup

Unity Ads Monetization

Deprecated API classes

Unity (C#)

API to be removed

Deprecated in version

What to use instead

Removed in version

Depreciation reason

Android (Java)

API to be removed

Deprecated in version

What to use instead

Removed in version

Depreciation reason

iOS (Objective-C)

API to be removed

Deprecated in version

What to use instead

Removed in version

Depreciation reason