You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
255 lines
9.4 KiB
255 lines
9.4 KiB
#import <UIKit/UIKit.h>
|
|
|
|
#import <UnityAds/UADSMediationMetaData.h>
|
|
#import <UnityAds/UADSPlayerMetaData.h>
|
|
|
|
/**
|
|
* An enumerate that describes the state of `UnityAds` placements.
|
|
* @note All placement states, other than `kUnityAdsPlacementStateReady`, indicate that the placement is not currently ready to show ads.
|
|
*/
|
|
typedef NS_ENUM(NSInteger, UnityAdsPlacementState) {
|
|
/**
|
|
* A state that indicates that the placement is ready to show an ad. The `show:` selector can be called.
|
|
*/
|
|
kUnityAdsPlacementStateReady,
|
|
/**
|
|
* A state that indicates that no state is information is available.
|
|
* @warning This state can that UnityAds is not initialized or that the placement is not correctly configured in the Unity Ads admin tool.
|
|
*/
|
|
kUnityAdsPlacementStateNotAvailable,
|
|
/**
|
|
* A state that indicates that the placement is currently disabled. The placement can be enabled in the Unity Ads admin tools.
|
|
*/
|
|
kUnityAdsPlacementStateDisabled,
|
|
/**
|
|
* A state that indicates that the placement is not currently ready, but will be in the future.
|
|
* @note This state most likely indicates that the ad content is currently caching.
|
|
*/
|
|
kUnityAdsPlacementStateWaiting,
|
|
/**
|
|
* A state that indicates that the placement is properly configured, but there are currently no ads available for the placement.
|
|
*/
|
|
kUnityAdsPlacementStateNoFill
|
|
};
|
|
|
|
/**
|
|
* An enumeration for the completion state of an ad.
|
|
*/
|
|
typedef NS_ENUM(NSInteger, UnityAdsFinishState) {
|
|
/**
|
|
* A state that indicates that the ad did not successfully display.
|
|
*/
|
|
kUnityAdsFinishStateError,
|
|
/**
|
|
* A state that indicates that the user skipped the ad.
|
|
*/
|
|
kUnityAdsFinishStateSkipped,
|
|
/**
|
|
* A state that indicates that the ad was played entirely.
|
|
*/
|
|
kUnityAdsFinishStateCompleted
|
|
};
|
|
|
|
/**
|
|
* An enumeration for the various errors that can be emitted through the `UnityAdsDelegate` `unityAdsDidError:withMessage:` method.
|
|
*/
|
|
typedef NS_ENUM(NSInteger, UnityAdsError) {
|
|
/**
|
|
* An error that indicates failure due to `UnityAds` currently being uninitialized.
|
|
*/
|
|
kUnityAdsErrorNotInitialized = 0,
|
|
/**
|
|
* An error that indicates failure due to a failure in the initialization process.
|
|
*/
|
|
kUnityAdsErrorInitializedFailed,
|
|
/**
|
|
* An error that indicates failure due to attempting to initialize `UnityAds` with invalid parameters.
|
|
*/
|
|
kUnityAdsErrorInvalidArgument,
|
|
/**
|
|
* An error that indicates failure of the video player.
|
|
*/
|
|
kUnityAdsErrorVideoPlayerError,
|
|
/**
|
|
* An error that indicates failure due to having attempted to initialize the `UnityAds` class in an invalid environment.
|
|
*/
|
|
kUnityAdsErrorInitSanityCheckFail,
|
|
/**
|
|
* An error that indicates failure due to the presence of an ad blocker.
|
|
*/
|
|
kUnityAdsErrorAdBlockerDetected,
|
|
/**
|
|
* An error that indicates failure due to inability to read or write a file.
|
|
*/
|
|
kUnityAdsErrorFileIoError,
|
|
/**
|
|
* An error that indicates failure due to a bad device identifier.
|
|
*/
|
|
kUnityAdsErrorDeviceIdError,
|
|
/**
|
|
* An error that indicates a failure when attempting to show an ad.
|
|
*/
|
|
kUnityAdsErrorShowError,
|
|
/**
|
|
* An error that indicates an internal failure in `UnityAds`.
|
|
*/
|
|
kUnityAdsErrorInternalError,
|
|
};
|
|
|
|
/**
|
|
* The `UnityAdsDelegate` protocol defines the required methods for receiving messages from UnityAds.
|
|
* Must be implemented by the hosting app.
|
|
* The unityAdsReady: method is called when it's possible to show an ad.
|
|
* All other methods are used to provide notifications of events of the ad lifecycle.
|
|
* @note On initialization, there are ready (or error) callbacks for each placement attached to the game identifier.
|
|
*/
|
|
NS_ASSUME_NONNULL_BEGIN
|
|
@protocol UnityAdsDelegate <NSObject>
|
|
/**
|
|
* Called when `UnityAds` is ready to show an ad. After this callback you can call the `UnityAds` `show:` method for this placement.
|
|
* Note that sometimes placement might no longer be ready due to exceptional reasons. These situations will give no new callbacks.
|
|
*
|
|
* @warning To avoid error situations, it is always best to check `isReady` method status before calling show.
|
|
* @param placementId The ID of the placement that is ready to show, as defined in Unity Ads admin tools.
|
|
*/
|
|
- (void)unityAdsReady:(NSString *)placementId;
|
|
/**
|
|
* Called when `UnityAds` encounters an error. All errors will be logged but this method can be used as an additional debugging aid. This callback can also be used for collecting statistics from different error scenarios.
|
|
*
|
|
* @param error A `UnityAdsError` error enum value indicating the type of error encountered.
|
|
* @param message A human readable string indicating the type of error encountered.
|
|
*/
|
|
- (void)unityAdsDidError:(UnityAdsError)error withMessage:(NSString *)message;
|
|
/**
|
|
* Called on a successful start of advertisement after calling the `UnityAds` `show:` method.
|
|
*
|
|
* @warning If there are errors in starting the advertisement, this method may never be called. Unity Ads will directly call `unityAdsDidFinish:withFinishState:` with error status.
|
|
*
|
|
* @param placementId The ID of the placement that has started, as defined in Unity Ads admin tools.
|
|
*/
|
|
- (void)unityAdsDidStart:(NSString *)placementId;
|
|
/**
|
|
* Called after the ad has closed.
|
|
*
|
|
* @param placementId The ID of the placement that has finished, as defined in Unity Ads admin tools.
|
|
* @param state An enum value indicating the finish state of the ad. Possible values are `Completed`, `Skipped`, and `Error`.
|
|
*/
|
|
- (void)unityAdsDidFinish:(NSString *)placementId
|
|
withFinishState:(UnityAdsFinishState)state;
|
|
@end
|
|
|
|
/**
|
|
* `UnityAds` is a static class with methods for preparing and showing ads.
|
|
*
|
|
* @warning In order to ensure expected behaviour, the delegate must always be set.
|
|
*/
|
|
|
|
@interface UnityAds : NSObject
|
|
|
|
- (instancetype)init NS_UNAVAILABLE;
|
|
+ (instancetype)initialize NS_UNAVAILABLE;
|
|
|
|
/**
|
|
* Initializes UnityAds. UnityAds should be initialized when app starts.
|
|
*
|
|
* @param gameId Unique identifier for a game, given by Unity Ads admin tools or Unity editor.
|
|
* @param delegate delegate for UnityAdsDelegate callbacks
|
|
*/
|
|
+ (void)initialize:(NSString *)gameId
|
|
delegate:(nullable id<UnityAdsDelegate>)delegate;
|
|
/**
|
|
* Initializes UnityAds. UnityAds should be initialized when app starts.
|
|
*
|
|
* @param gameId Unique identifier for a game, given by Unity Ads admin tools or Unity editor.
|
|
* @param delegate delegate for UnityAdsDelegate callbacks
|
|
* @param testMode Set this flag to `YES` to indicate test mode and show only test ads.
|
|
*/
|
|
+ (void)initialize:(NSString *)gameId
|
|
delegate:(nullable id<UnityAdsDelegate>)delegate
|
|
testMode:(BOOL)testMode;
|
|
/**
|
|
* Show an ad using the defaul placement.
|
|
*
|
|
* @param viewController The `UIViewController` that is to present the ad view controller.
|
|
*/
|
|
+ (void)show:(UIViewController *)viewController;
|
|
/**
|
|
* Show an ad using the provided placement ID.
|
|
*
|
|
* @param viewController The `UIViewController` that is to present the ad view controller.
|
|
* @param placementId The placement ID, as defined in Unity Ads admin tools.
|
|
*/
|
|
+ (void)show:(UIViewController *)viewController placementId:(NSString *)placementId;
|
|
/**
|
|
* Provides the currently assigned `UnityAdsDelegate`.
|
|
*
|
|
* @return The current `UnityAdsDelegate`.
|
|
*/
|
|
+ (id<UnityAdsDelegate>)getDelegate;
|
|
/**
|
|
* Allows the delegate to be reassigned after UnityAds has already been initialized.
|
|
*
|
|
* @param delegate The new `UnityAdsDelegate' for UnityAds to send callbacks to.
|
|
*/
|
|
+ (void)setDelegate:(id<UnityAdsDelegate>)delegate;
|
|
/**
|
|
* Get the current debug status of `UnityAds`.
|
|
*
|
|
* @return If `YES`, `UnityAds` will provide verbose logs.
|
|
*/
|
|
+ (BOOL)getDebugMode;
|
|
/**
|
|
* Set the logging verbosity of `UnityAds`. Debug mode indicates verbose logging.
|
|
* @warning Does not relate to test mode for ad content.
|
|
* @param enableDebugMode `YES` for verbose logging.
|
|
*/
|
|
+ (void)setDebugMode:(BOOL)enableDebugMode;
|
|
/**
|
|
* Check to see if the current device supports using Unity Ads.
|
|
*
|
|
* @return If `NO`, the current device cannot initialize `UnityAds` or show ads.
|
|
*/
|
|
+ (BOOL)isSupported;
|
|
/**
|
|
* Check if the default placement is ready to show an ad.
|
|
*
|
|
* @return If `YES`, the default placement is ready to show an ad.
|
|
*/
|
|
+ (BOOL)isReady;
|
|
/**
|
|
* Check if a particular placement is ready to show an ad.
|
|
*
|
|
* @param placementId The placement ID being checked.
|
|
*
|
|
* @return If `YES`, the placement is ready to show an ad.
|
|
*/
|
|
+ (BOOL)isReady:(NSString *)placementId;
|
|
/**
|
|
* Check the current state of the default placement.
|
|
*
|
|
* @return If this is `kUnityAdsPlacementStateReady`, the placement is ready to show ads. Other states represent errors.
|
|
*/
|
|
+ (UnityAdsPlacementState)getPlacementState;
|
|
/**
|
|
* Check the current state of a placement.
|
|
*
|
|
* @param placementId The placement ID, as defined in Unity Ads admin tools.
|
|
*
|
|
* @return If this is `kUnityAdsPlacementStateReady`, the placement is ready to show ads. Other states represent errors.
|
|
*/
|
|
+ (UnityAdsPlacementState)getPlacementState:(NSString *)placementId;
|
|
/**
|
|
* Check the version of this `UnityAds` SDK
|
|
*
|
|
* @return String representing the current version name.
|
|
*/
|
|
+ (NSString *)getVersion;
|
|
/**
|
|
* Check that `UnityAds` has been initialized. This might be useful for debugging initialization problems.
|
|
*
|
|
* @return If `YES`, Unity Ads has been successfully initialized.
|
|
*/
|
|
+ (BOOL)isInitialized;
|
|
|
|
@end
|
|
NS_ASSUME_NONNULL_END
|