Unity Ads iOS SDK API reference - Objective-C
Access the Unity Ads SDK public API reference to view available classes, methods, and properties you can use in Objective-C to integrate and control ad behavior in your iOS app.
Read time 13 minutesLast updated 2 months ago
Use this reference for the Unity Ads iOS SDK API in Objective-C as you integrate Unity Ads into your iOS applications.
Before using this API, ensure that you've imported the library to enable monetization in your app. Refer to Import the UnityAds library for more information.
UnityAdsClasses
UADSBannerAd
The class manages the loading and showing of banner ads.
UADSBannerAdload:completion:_
@interface UADSBannerAd : NSObject+ (void)load:(UADSBannerLoadConfiguration * _Nonnull)config completion:(void (^ _Nonnull)(UADSBannerAd * _Nullable, id<UnityAdsError> _Nullable))completion;@end
Loads a banner ad with the specified configuration.
Parameters | Description |
|---|---|
| configuration | The options for loading the banner ad. |
| completion | A callback that gets called when the banner is loaded. Returns the loaded BannerAd instance if successful, or an UnityAdsError if loading fails. |
view
@interface UADSBannerAd : NSObject@property (nonatomic, readonly, strong) UIView * _Nonnull view;@end
A view property that provides access to the banner ad instance. Use this property to insert the banner ad within your app's existing view hierarchy at the desired location.
UADSBannerView
Warning
Deprecated in version 4.19.0. Scheduled for removal in version 5.0.0.
Use instead. See iOS deprecated APIs for migration details.
UADSBannerAdUADSBannerViewUADSBannerViewDelegate
Warning
Deprecated in version 4.19.0. Scheduled for removal in version 5.0.0.
Use instead. See iOS deprecated APIs for migration details.
UADSBannerAdDelegateUADSBannerViewDelegateUADSBannerLoadConfiguration
The class encapsulates the options needed to load banner ads. This includes specifying the placement ID, banner size, optional ad markup, optional delegate, and any additional parameters.
UADSBannerLoadConfiguration@interface BannerLoadConfiguration : NSObject@property (nonatomic, strong) NSString *placementId;@property (nonatomic, strong, nullable) NSString *adMarkup;@property (nonatomic, assign) CGSize bannerSize;@property (nonatomic, weak, nullable) id<UADSBannerAdDelegate> delegate;@property (nonatomic, strong, nullable) NSString *mediationAdUnitId;@property (nonatomic, strong, nullable) MediationInfo *mediationInfo;@property (nonatomic, strong) NSDictionary<NSString *, NSString *> *extras;@end
Property | Description | Required |
|---|---|---|
| The placement ID defined in the Unity Monetization Dashboard. | Yes |
| Ad markup data that's used when loading an ad through bidding. | No |
| The size of the banner ad. | Yes |
| Delegate to handle banner ad events. | Yes |
| The ad unit or placement ID defined in your mediation partner's dashboard. | No |
| Specifies details about your mediation integration. | No |
| Additional custom key–value pairs. | No |
UADSBannerLoadConfigurationBuilder
Use to create and return an instance of the class.
UADSBannerLoadConfigurationBuilderUADSBannerLoadConfigurationinitWithPlacementId:adMarkup:bannerSize:delegate
- (nonnull instancetype)initWithPlacementId:(NSString * _Nonnull)placementId bannerSize:(CGSize)bannerSize delegate:(id <UADSBannerAdDelegate> _Nonnull)delegate;
Creates a new instance of .
BannerLoadConfigurationBuilderProperty | Description | Required |
|---|---|---|
| The placement ID defined in the Unity Monetization Dashboard. | Yes |
| The size of the banner ad. | Yes |
| Delegate to handle banner ad events. | Yes |
Returns: An instance of .
UADSBannerLoadConfigurationBuilderwithAdMarkup:_
- (nonnull instancetype)withAdMarkup:(NSString * _Nonnull)adMarkup
Adds an adMarkup to the .
UADSBannerLoadConfigurationBuilderParameter | Description |
|---|---|
| adMarkup | Ad markup data that's used when loading an ad through bidding. |
withMediationAdUnitId:_
- (nonnull instancetype)withMediationAdUnitId:(NSString * _Nonnull)mediationAdUnitId
Adds a mediation ad unit ID to the .
UADSBannerLoadConfigurationBuilderParameter | Description |
|---|---|
| mediationAdUnitId | The ad unit or placement ID defined in your mediation partner's dashboard. |
Returns: The updated instance.
UADSBannerLoadConfigurationBuilderwithMediationInfo:_
- (nonnull instancetype)withMediationInfo:(UADSMediationInfo * _Nonnull)info
Adds mediation information to the .
UADSBannerLoadConfigurationBuilderParameter | Description |
|---|---|
| mediationInfo | Details about the mediation integration (name, version, adapter version). |
Returns: The updated UADSBannerLoadConfigurationBuilder instance.
withExtras:_
- (nonnull instancetype)withExtras:(NSDictionary<NSString *, NSString *> * _Nonnull)extras
Adds extra key–value parameters to the .
UADSBannerLoadConfigurationBuilderParameter | Description |
|---|---|
| extras | Custom parameters for banner loading. |
Returns: The updated instance.
UADSBannerLoadConfigurationBuilderbuild
- (UADSBannerLoadConfiguration * _Nonnull)build
Builds and returns a instance.
UADSBannerLoadConfigurationReturns: An instance of .
UADSBannerLoadConfigurationUADSBannerLoadOptions
Warning
Deprecated in version 4.19.0. Scheduled for removal in version 5.0.0.
Use and instead. See iOS deprecated APIs for migration details.
UADSBannerLoadConfigurationUADSBannerLoadConfigurationBuilderUADSBannerLoadOptionsUADSInitializationConfiguration
@interface UADSInitializationConfiguration: NSObject@property (nonatomic, strong) NSString *gameId;@property (nonatomic, assign) BOOL isTestModeEnabled;@property (nonatomic, assign) UADSLogLevel logLevel;@property (nonatomic, strong, nullable) UADSMediationInfo *mediationInfo;@property (nonatomic, strong) NSDictionary<NSString *, NSString *> *extras;@end
The class creates an object consisting of essential information about your app required to initialize the Unity Ads SDK.
UADSInitializationConfigurationProperty | Type | Description | Required |
|---|---|---|---|
| | Unique identifier for your Unity project. | Yes |
| | Enables or disables test mode. | No |
| | Specifies the detail level of log output. | No |
| | Specifies details about your mediation integration. | No |
| | Additional key–value pairs for custom configuration. | No |
UADSInitializationConfigurationBuilder
Use to create and return an instance of the class.
UADSInitConfigurationBuilderUADSInitializationConfigurationinitWithgameID:_
- (nonnull instancetype)initWithGameId:(NSString * _Nonnull)gameId
Creates a new instance of .
UADSInitConfigurationBuilderParameter | Description |
|---|---|
| gameId | Unique identifier for a game, given by Unity Ads admin tools or Unity editor. |
Returns: An instance of .
UADSInitConfigurationBuilderwithTestMode:_
- (nonnull instancetype)withTestMode:(BOOL)testMode
Sets the test mode.
Parameter | Description |
|---|---|
| testMode | Set this flag to |
Returns: The updated instance.
UADSInitConfigurationBuilderwithLogLevel:_
- (nonnull instancetype)withLogLevel:(enum UADSLogLevel)logLevel
Sets the log level, which defines the amount of detail included in logs, from none to full debug information.
Parameter | Description |
|---|---|
| level | Specifies the detail level of log output. |
Returns: The updated instance.
UADSInitConfigurationBuilderwithMediationInfo:_
- (nonnull instancetype)withMediationInfo:(UADSMediationInfo * _Nonnull)info
Sets the mediation information, which provides details about your app's mediation integration, including mediation name, version, and adapter version.
Parameter | Description |
|---|---|
| info | Specifies details about your mediation integration. |
Returns: The updated instance.
UADSInitConfigurationBuilderwithExtras:_
- (nonnull instancetype)withExtras:(NSDictionary<NSString *, NSString *> * _Nonnull)extras
Sets additional parameters.
Parameter | Description |
|---|---|
| extras | Additional key–value pairs for custom configuration. |
Returns: The updated instance.
UADSInitConfigurationBuilderbuild
- (UADSInitializationConfiguration * _Nonnull)build
Builds and returns a UADSInitializationConfiguration instance.
Returns: An instance of .
UADSInitializationConfigurationUADSInterstitialAd
The class manages the loading and showing of interstitial ads.
UADSInterstitialAdload:completion:_
@interface UADSInterstitialAd : NSObject+ (void)load:(UADSLoadConfiguration * _Nonnull)configuration completion:(void (^ _Nonnull)(UADSInterstitialAd * _Nullable, id<UnityAdsError> _Nullable))completion;@end
Loads an interstitial ad with the specified configuration.
Parameters | Description |
|---|---|
| configuration | An instance of UADSLoadConfiguration containing the ad loading options. |
| completion | A callback that gets called when the loading process is finished. Returns either a UADSInterstitialAd instance or an error. |
show:delegate:_
@interface UADSInterstitialAd : NSObject- (void)show:(UADSShowConfiguration * _Nullable)configuration delegate:(id <UADSInterstitialShowDelegate> _Nonnull)delegate;@end
Displays the loaded interstitial ad.
Parameter | Description |
|---|---|
| configuration | Optional configuration for showing the ad. |
| delegate | A delegate conforming to |
onAdExpired
Register a callback that gets triggered when the ad expires.
@interface UnityAd : NSObject@property (nonatomic, copy) void (^ _Nullable onAdExpired)(UnityAd * _Nonnull);@end
UADSLoadConfiguration
The class encapsulates the options needed to load Unity ads. This includes specifying the placement ID, optional ad markup, and any additional parameters.
UADSLoadConfiguration@interface UADSLoadConfiguration: NSObject@property (nonatomic, strong) NSString *placementId;@property (nonatomic, strong, nullable) NSString *adMarkup;@property (nonatomic, strong, nullable) NSString *mediationAdUnitId;@property (nonatomic, strong, nullable) UADSMediationInfo *mediationInfo;@property (nonatomic, strong) NSDictionary<NSString *, NSString *> *extras;@end
Creates a new instance of .
UADSLoadConfigurationProperty | Description | Required |
|---|---|---|
| The placement ID defined in the Unity Monetization Dashboard. | Yes |
| Ad markup data that's used when loading an ad through bidding. | No |
| The placement ID used in your mediation partner's dashboard. | No |
| Specifies details about your mediation integration. | No |
| Additional custom key–value pairs for configuration. | No |
Note: The adMarkup property is required for all bidding implementations. For waterfall implementations, you can set adMarkup to nil. |
UADSLoadConfigurationBuilder
Use to create and return an instance of the class.
UADSLoadConfigurationBuilderUADSLoadConfigurationinitWithPlacementId:_
- - (nonnull instancetype)initWithPlacementId:(NSString * _Nonnull)placementId;
Creates a new instance of .
UADSLoadConfigurationBuilderParameter | Description |
|---|---|
| The placement ID defined in the Unity Monetization Dashboard. |
Returns: An instance of .
UADSLoadConfigurationBuilderwithAdMarkup:_
- (nonnull instancetype)withAdMarkup:(NSString * _Nonnull)adMarkup
Adds an adMarkup to the .
UADSLoadConfigurationBuilderProperty | Description |
|---|---|
| Ad markup data that's used when loading an ad through bidding. |
Returns: The updated instance.
UADSLoadConfigurationBuilderwithMediationAdUnitId:_
- (nonnull instancetype)withMediationAdUnitId:(NSString * _Nonnull)mediationAdUnitId
Adds the mediation ad unit ID to the .
UADSLoadConfigurationBuilderProperty | Description |
|---|---|
| The placement ID used in your mediation partner's dashboard. |
Returns: The updated instance.
UADSLoadConfigurationBuilderwithMediationInfo:_
- (nonnull instancetype)withMediationInfo:(UADSMediationInfo * _Nonnull)info
Adds mediation information to the .
UADSLoadConfigurationBuilderParameter | Description |
|---|---|
| mediationInfo | Specifies details about your mediation integration (name, version, adapter version). |
Returns: The updated instance.
UADSLoadConfigurationBuilderwithExtras:_
- (nonnull instancetype)withExtras:(NSDictionary<NSString *, NSString *> * _Nonnull)extras
Adds extra configuration key–value pairs to the .
UADSLoadConfigurationBuilderParameter | Description |
|---|---|
| extras | A dictionary of custom parameters for ad loading. |
Returns: The updated instance.
UADSLoadConfigurationBuilderbuild
- (UADSLoadConfiguration * _Nonnull)build
Builds and returns a instance.
UADSLoadConfigurationReturns: An instance of .
UADSLoadConfigurationUADSLoadOptions
Warning
Deprecated in version 4.19.0. Scheduled for removal in version 5.0.0.
Use instead. See iOS deprecated APIs for migration details.
UADSLoadConfigurationBuilderUADSLoadOptionsUADSMediationInfo
Specifies details about your mediation integration.
@interface UADSMediationInfo : NSObject- (nonnull instancetype)initWithName:(NSString * _Nonnull)name version:(NSString * _Nonnull)version adapterVersion:(NSString * _Nonnull)adapterVersion@end
Parameters | Description |
|---|---|
| name | The name of the mediation platform integrated in your app. |
| version | The version of the mediation SDK integrated in your app. |
| adapterVersion | The version of the Unity Ads adapter for your mediation partner. |
Returns: An instance of .
UADSMediationInfoUADSMediationMetaData
Warning
Deprecated in version 4.19.0. Scheduled for removal in version 5.0.0.
Use instead. See iOS deprecated APIs for migration details.
UADSMediationInfoUADSMediationMetaDataUADSRewardedAd
The UADSRewardedAd class manages the loading and showing of rewarded ads.
load:completion:_
+ (void)load:(UADSLoadConfiguration * _Nonnull)configuration completion:(void (^ _Nonnull)(UADSRewardedAd * _Nullable, id<UnityAdsError> _Nullable))completion;
Loads a rewarded ad with the specified options.
Parameters | Description |
|---|---|
| configuration | An instance of UADSLoadConfiguration containing the ad loading options. |
| completion | A callback that gets called when ad loading finishes. Returns a UADSRewardedAd instance if successful, or an UnityAdsError if loading fails. |
show:delegate:_
- (void)show:(UADSShowConfiguration * _Nullable)configuration delegate:(id <UADSRewardedShowDelegate> _Nonnull)delegate;
Displays the loaded rewarded ad.
Parameter | Description |
|---|---|
| configuration | Optional settings for showing the ad. |
| delegate | A delegate that handles rewarded ad events. |
onAdExpired
Register a callback that gets triggered when the ad expires.
@interface UnityAd : NSObject@property (nonatomic, copy) void (^ _Nullable onAdExpired)(UnityAd * _Nonnull);@end
UADSShowConfiguration
The class specifies additional parameters that you want to pass in the form of key-value pairs when showing Unity Ads.
UADSShowConfiguration@interface UADSShowConfigurationBuilder : NSObject@property (nonatomic, weak, nullable) UIViewController *viewController;@property (nonatomic, strong, nullable) NSString *customRewardString;@property (nonatomic, strong) NSDictionary<NSString *, NSString *> *extras;@end
Creates a new instance of with optional additional parameters.
UADSShowConfigurationProperty | Description | Required |
|---|---|---|
| The view controller used to present the ad. | No |
| A custom reward identifier for the ad impression. | No |
| Additional key–value parameters to include when showing the ad. Defaults to an empty dictionary. | No |
UADSShowConfigurationBuilder
Use to create and return an instance of the class.
UADSShowConfigurationBuilderUADSShowConfigurationinit
- (nonnull instancetype)init;
Creates a new instance of .
UADSShowConfigurationBuilderwithViewController:_
- (nonnull instancetype)withViewController:(UIViewController * _Nonnull)viewController
Sets the view controller to present the ad from.
Parameter | Description |
|---|---|
| The view controller presenting the ad. |
Returns: The updated instance.
UADSShowConfigurationBuilderwithCustomRewardString:_
- (nonnull instancetype)withCustomRewardString:(NSString * _Nonnull)customRewardString
Sets a custom reward identifier for the ad impression.
Parameter | Description |
|---|---|
| A unique reward ID for the ad impression. |
Returns: The updated instance.
ShowConfigurationBuilderwithExtras:_
- (nonnull instancetype)withExtras:(NSDictionary<NSString *, NSString *> * _Nonnull)extras
Adds extra key–value parameters when showing the ad.
Parameter | Description |
|---|---|
| Custom parameters for ad display. |
Returns: The updated instance.
UADSShowConfigurationBuilderbuild
- (UADSShowConfiguration * _Nonnull)build
Builds and returns a instance.
UADSShowConfigurationReturns: An instance of .
UADSShowConfigurationUADSShowOptions
Warning
Deprecated in version 4.19.0. Scheduled for removal in version 5.0.0.
Use instead. See iOS deprecated APIs for migration details.
UADSShowConfigurationBuilderUADSShowOptionsUADSTokenConfiguration
@interface UADSTokenConfiguration : NSObject@property (nonatomic, assign) AdFormat UADSAdFormat;@property (nonatomic, strong, nullable) UADSMediationInfo *mediationInfo;@property (nonatomic, strong, nullable) NSString *mediationAdUnitId;@property (nonatomic, strong, nullable) NSString *placementId;@property (nonatomic, assign) CGSize bannerSize;@property (nonatomic, strong) NSDictionary<NSString *, NSString *> *extras;@end
The interface creates an object consisting of essential information required to get a bidding token.
UADSTokenConfigurationProperty | Description | Required |
|---|---|---|
| Specifies the type of ad format (interstitial, rewarded, banner). | Yes |
| Specifies details about your mediation integration. | No |
| The placement ID used in your mediation partner's dashboard. | No |
| The placement ID defined in the Unity Monetization Dashboard. | No |
| The size of the banner ad if a token requested a banner ad. | No |
| Additional key–value pairs for custom configuration. | No |
UADSTokenConfigurationBuilder
Use to create and return an instance of the class.
UADSTokenConfigurationBuilderUADSTokenConfigurationinitWithAdFormat:_
- (nonnull instancetype)initWithAdFormat:(enum UADSAdFormat)adFormat
Creates a new instance of .
UADSTokenConfigurationBuilderParameter | Description |
|---|---|
| adFormat | An instance of AdFormat that specifies the type of ad (interstitial, rewarded, banner). |
Returns: An instance of .
UADSTokenConfigurationBuilderwithMediationInfo:_
- (nonnull instancetype)withMediationInfo:(UADSMediationInfo * _Nonnull)mediationInfo
Specifies details about your mediation integration.
Parameter | Description |
|---|---|
| mediationInfo | Specifies details about your mediation integration. |
Returns: The updated instance.
TokenConfigurationBuilderwithMediationAdUnitId:_
- (nonnull instancetype)withMediationAdUnitId:(NSString * _Nonnull)mediationAdUnitId
Adds the mediation ad unit ID to the .
TokenConfigurationProperty | Description |
|---|---|
| The placement ID used in your mediation partner's dashboard. |
Returns: The updated instance.
UADSTokenConfigurationBuilderwithPlacementId:_
- (nonnull instancetype)withPlacementId:(NSString * _Nonnull)placementId
Specifies the placement ID defined in the Unity Monetization Dashboard.
Parameter | Description |
|---|---|
| placementId | The placement ID defined in the Unity Monetization Dashboard. |
Returns: The updated instance.
UADSTokenConfigurationBuilderwithBannerSize:_
- (nonnull instancetype)withBannerSize:(CGSize)bannerSize
Specifies the size of the banner ad if a token requested a banner ad.
Parameter | Description |
|---|---|
| bannerSize | The size of the banner ad if a token requested a banner ad. |
Returns: The updated instance.
UADSTokenConfigurationBuilderwithExtras:_
- (nonnull instancetype)withExtras:(NSDictionary<NSString *, NSString *> * _Nonnull)extras
Specifies additional key–value pairs for custom configuration.
Parameter | Description |
|---|---|
| extras | Additional key–value pairs for custom configuration. |
Returns: The updated instance.
UADSTokenConfigurationBuilderbuild
- (UADSTokenConfiguration * _Nonnull)build
Builds and returns a instance.
UADSTokenConfigurationReturns: An instance of .
UADSTokenConfigurationUnityAds
The class is a static class that serves as the primary entry point for the SDK. It handles initialization, token retrieval, privacy consent, and provides access to global SDK properties.
UnityAdsInitialization
initialize(_, completion:)
Initializes the Unity Ads SDK with a specified configuration. The completion block is called when initialization completes with either success or failure.
+ (void) initialize:(UADSInitializationConfiguration *) configuration completion:(void (^)(id<UnityAdsError> )) completion;
Parameter | Description |
|---|---|
| configuration | The UADSInitializationConfiguration object that contains the required settings to initialize the SDK. |
| completion | A callback that gets called when SDK initialization finishes. Returns an UnityAdsError if initialization fails. |
GetToken
getToken(_, completion:)
Fetches a bidding token based on the provided and passes it to the completion block.
UADSTokenConfiguration+ (void) getToken:(UADSTokenConfiguration *) configuration completion:(void (^)(NSString * )) completion;
Parameter | Description |
|---|---|
| configuration | A |
| completion | A completion block that is called with the token if it's successfully fetched, or null if an error occurs. |
Static variables
IsInitialized
Determines if the Unity Ads SDK is initialized successfully.
+ (BOOL)isInitialized
Returns: If , Unity Ads has been successfully initialized.
truegetVersion
Determines the current Unity Ads SDK version in use.
+ (NSString *)getVersion
Returns: The current installed version of Unity Ads SDK.
userIdentifier
Sets a unique ID for each user of your app.
@objc public static var userIdentifier: String {...}
Privacy
setUserConsent()
Displays the user's opt-in choices for personalized ads.
+ (void)setUserConsent:(BOOL)consentGranted;
setUserOptOut()
Offers users the option to opt out of data collection and personalized ads.
+ (void)setUserOptOut:(BOOL)optOut;
setNonBehavioral()
Enables the display of contextual (non-personalized) ads.
+ (void)setNonBehavioral:(BOOL)nonBehavioral;
UADSMetaData
Warning
Deprecated in version 4.19.0. Scheduled for removal in version 5.0.0.
Use the typed privacy methods on : , , and . See iOS deprecated APIs for migration details.
UnityAdssetUserConsent:setUserOptOut:setNonBehavioral:UADSMetaDataUnityAdsInitializationDelegate
Warning
Deprecated in version 4.19.0. Scheduled for removal in version 5.0.0.
Use a completion block with instead. See iOS deprecated APIs for migration details.
UnityAds initialize:completion:UnityAdsInitializationDelegateUnityAdsLoadDelegate
Warning
Deprecated in version 4.19.0. Scheduled for removal in version 5.0.0.
Use a completion block with or instead. See iOS deprecated APIs for migration details.
UADSInterstitialAd load:completion:UADSRewardedAd load:completion:UnityAdsLoadDelegateUnityAdsShowDelegate
Warning
Deprecated in version 4.19.0. Scheduled for removal in version 5.0.0.
Use or instead. See iOS deprecated APIs for migration details.
UADSInterstitialShowDelegateUADSRewardedShowDelegateUnityAdsShowDelegateEnum
UADSAdFormat
Defines the different types of ad formats supported by Unity Ads.
typedef enum { UADSAdFormatUnspecified = 0, UADSAdFormatInterstitial = 1, UADSAdFormatRewarded = 2, UADSAdFormatBanner = 3,} UADSAdFormat;
Parameter | Description |
|---|---|
| UADSAdFormatUnspecified | No specified ad format. |
| UADSAdFormatInterstitial | Full-screen ads shown at natural pauses in the app. |
| UADSAdFormatRewarded | Ads that grant users a reward after completion. |
| UADSAdFormatBanner | Rectangular ads displayed within the app's layout, typically anchored to the top or bottom of the screen. |
UnityAdsAdFormat
Warning
Deprecated in version 4.19.0. Scheduled for removal in version 5.0.0.
Use instead. See iOS deprecated APIs for migration details.
UADSAdFormatUnityAdsAdFormatUADSLogLevel
Defines the logging levels for Unity Ads.
typedef enum { UADSLogLevelDisabled = 0, UADSLogLevelError = 1, UADSLogLevelInfo = 2, UADSLogLevelDebug = 3,} UADSLogLevel;
Parameter | Description |
|---|---|
| UADSLogLevelDisabled | No logs output. |
| UADSLogLevelError | Logs only critical errors and failures in init/load/show operations. |
| UADSLogLevelInfo | Logs key operational events (such as initialization started/completed, load started/completed, show started/finished, and token generation). |
| UADSLogLevelDebug | Logs all info plus detailed internal operations like network requests and internal errors. |
UADSShowFinishState
Represents the finish state of an ad after it has been shown.
typedef enum { UADSShowFinishStateSkipped = 0, UADSShowFinishStateCompleted = 1,} UADSShowFinishState
Parameter | Description |
|---|---|
| UADSShowFinishStateSkipped | The user closed or skipped the ad before it finished. |
| UADSShowFinishStateCompleted | The ad played until the end. |
Protocol
UADSBannerAdDelegate
@protocol UADSBannerAdDelegate <NSObject>- (void)bannerImpression:(UADSBannerAd * _Nonnull)banner;- (void)bannerDidClick:(UADSBannerAd * _Nonnull)banner;- (void)bannerDidFailShow:(UADSBannerAd * _Nonnull)banner error:(id<UnityAdsError> _Nonnull)error;@end
Method | Description |
|---|---|
| Called when a banner ad is displayed (impression recorded). |
| Called when the user clicks the banner ad. |
| Called if the banner fails to display, with an |
UADSInterstitialShowDelegate
@protocol UADSInterstitialShowDelegate <NSObject>- (void)showDidStart:(UADSInterstitialAd * _Nonnull)unityAd;- (void)showDidClick:(UADSInterstitialAd * _Nonnull)unityAd;- (void)showDidComplete:(UADSInterstitialAd * _Nonnull)unityAd with:(enum UADSShowFinishState)finishState;- (void)showDidFail:(UADSInterstitialAd * _Nonnull)unityAd error:(id<UnityAdsError> _Nonnull)error;@end
Method | Description |
|---|---|
| Called when the interstitial ad starts showing. |
| Called when the interstitial ad is clicked. |
| Called when the ad finishes showing. Provides a |
| Called if the ad fails to show, with an |
UADSRewardedShowDelegate
@protocol UADSRewardedShowDelegate <NSObject>- (void)showDidStart:(UADSRewardedAd * _Nonnull)unityAd;- (void)showDidClick:(UADSRewardedAd * _Nonnull)unityAd;- (void)showDidComplete:(UADSRewardedAd * _Nonnull)unityAd with:(enum UADSShowFinishState)finishState;- (void)showDidFail:(UADSRewardedAd * _Nonnull)unityAd error:(id<UnityAdsError> _Nonnull)error;- (void)showDidReceiveReward:(UADSRewardedAd * _Nonnull)unityAd;@end
Method | Description |
|---|---|
| Called when the rewarded ad starts showing. |
| Called when the rewarded ad is clicked. |
| Called when the ad finishes showing. Provides a |
| Called if the ad fails to show, with an |
| Called when the user earns the reward from the ad. |
UnityAdsError
@protocol UnityAdsError@property (nonatomic, readonly) NSInteger code;@property (nonatomic, readonly, copy) NSString * _Nonnull message;@end
Parameter | Description |
|---|---|
| code | |
| message |
UADSBannerErrorCode
Warning
Deprecated in version 4.19.0. Scheduled for removal in version 5.0.0.
Use the protocol instead. See iOS deprecated APIs for migration details.
id<UnityAdsError>UADSBannerErrorCodeUnityAdsInitializationError
Warning
Deprecated in version 4.19.0. Scheduled for removal in version 5.0.0.
Use the protocol instead. See iOS deprecated APIs for migration details.
id<UnityAdsError>UnityAdsInitializationErrorUnityAdsLoadError
Warning
Deprecated in version 4.19.0. Scheduled for removal in version 5.0.0.
Use the protocol instead. See iOS deprecated APIs for migration details.
id<UnityAdsError>UnityAdsLoadErrorUnityAdsShowError
Warning
Deprecated in version 4.19.0. Scheduled for removal in version 5.0.0.
Use the protocol instead. See iOS deprecated APIs for migration details.
id<UnityAdsError>UnityAdsShowError