441 lines
18 KiB
C
441 lines
18 KiB
C
|
//
|
||
|
|
// VungleSDK.h
|
||
|
|
// Vungle iOS SDK
|
||
|
|
// SDK Version: 6.10.6
|
||
|
|
//
|
||
|
|
// Copyright (c) 2013-Present Vungle Inc. All rights reserved.
|
||
|
|
//
|
||
|
|
|
||
|
|
#import <Foundation/Foundation.h>
|
||
|
|
#import <UIKit/UIKit.h>
|
||
|
|
|
||
|
|
NS_ASSUME_NONNULL_BEGIN
|
||
|
|
|
||
|
|
/**
|
||
|
|
* VungleViewInfo is a container object for state passed
|
||
|
|
* indicating how the play experience went
|
||
|
|
*/
|
||
|
|
@interface VungleViewInfo : NSObject <NSCopying>
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Represents a BOOL whether or not the video can be considered a full view.
|
||
|
|
*/
|
||
|
|
@property (nonatomic, readonly) NSNumber *completedView;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* The time in seconds that the user watched the video.
|
||
|
|
*/
|
||
|
|
@property (nonatomic, readonly) NSNumber *playTime;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Represents a BOOL whether or not the user clicked the download button.
|
||
|
|
*/
|
||
|
|
@property (nonatomic, readonly) NSNumber *didDownload;
|
||
|
|
|
||
|
|
@end
|
||
|
|
|
||
|
|
extern NSString *VungleSDKInitOptionKeyPriorityPlacementID;
|
||
|
|
extern NSString *VungleSDKInitOptionKeyPriorityPlacementAdSize;
|
||
|
|
|
||
|
|
extern NSString *VungleSDKVersion;
|
||
|
|
extern NSString *VunglePlayAdOptionKeyIncentivizedAlertTitleText;
|
||
|
|
extern NSString *VunglePlayAdOptionKeyIncentivizedAlertBodyText;
|
||
|
|
extern NSString *VunglePlayAdOptionKeyIncentivizedAlertCloseButtonText;
|
||
|
|
extern NSString *VunglePlayAdOptionKeyIncentivizedAlertContinueButtonText;
|
||
|
|
extern NSString *VunglePlayAdOptionKeyOrientations;
|
||
|
|
extern NSString *VunglePlayAdOptionKeyStartMuted;
|
||
|
|
extern NSString *VunglePlayAdOptionKeyUser;
|
||
|
|
extern NSString *VunglePlayAdOptionKeyExtraInfoDictionary;
|
||
|
|
extern NSString *VunglePlayAdOptionKeyExtra1;
|
||
|
|
extern NSString *VunglePlayAdOptionKeyExtra2;
|
||
|
|
extern NSString *VunglePlayAdOptionKeyExtra3;
|
||
|
|
extern NSString *VunglePlayAdOptionKeyExtra4;
|
||
|
|
extern NSString *VunglePlayAdOptionKeyExtra5;
|
||
|
|
extern NSString *VunglePlayAdOptionKeyExtra6;
|
||
|
|
extern NSString *VunglePlayAdOptionKeyExtra7;
|
||
|
|
extern NSString *VunglePlayAdOptionKeyExtra8;
|
||
|
|
extern NSString *VunglePlayAdOptionKeyLargeButtons;
|
||
|
|
extern NSString *VunglePlayAdOptionKeyOrdinal;
|
||
|
|
extern NSString *VunglePlayAdOptionKeyFlexViewAutoDismissSeconds;
|
||
|
|
|
||
|
|
typedef enum {
|
||
|
|
VungleSDKErrorInvalidPlayAdOption = 1,
|
||
|
|
VungleSDKErrorInvalidPlayAdExtraKey,
|
||
|
|
VungleSDKErrorCannotPlayAd,
|
||
|
|
VungleSDKErrorCannotPlayAdAlreadyPlaying,
|
||
|
|
VungleSDKErrorCannotPlayAdWaiting,
|
||
|
|
VungleSDKErrorInvalidAdTypeForFeedBasedAdExperience,
|
||
|
|
VungleSDKErrorNoAppID,
|
||
|
|
VungleSDKErrorFlexFeedContainerViewSizeError,
|
||
|
|
VungleSDKErrorFlexFeedContainerViewSizeRatioError,
|
||
|
|
InvalidPlacementsArray,
|
||
|
|
VungleSDKErrorInvalidiOSVersion,
|
||
|
|
VungleSDKErrorTopMostViewControllerMismatch,
|
||
|
|
VungleSDKErrorUnknownPlacementID,
|
||
|
|
VungleSDKErrorSDKNotInitialized,
|
||
|
|
VungleSDKErrorSleepingPlacement,
|
||
|
|
VungleSDKErrorNoAdsAvailable,
|
||
|
|
VungleSDKErrorNotEnoughFileSystemSize,
|
||
|
|
VungleDiscSpaceProviderErrorNoFileSystemAttributes,
|
||
|
|
VungleSDKErrorUnknownBannerSize,
|
||
|
|
VungleSDKResetPlacementForDifferentAdSize,
|
||
|
|
VungleSDKErrorSDKAlreadyInitializing,
|
||
|
|
} VungleSDKErrorCode;
|
||
|
|
|
||
|
|
typedef NS_ENUM (NSInteger, VungleConsentStatus) {
|
||
|
|
VungleConsentAccepted = 1,
|
||
|
|
VungleConsentDenied,
|
||
|
|
};
|
||
|
|
|
||
|
|
typedef NS_ENUM (NSInteger, VungleCCPAStatus) {
|
||
|
|
VungleCCPAAccepted = 1,
|
||
|
|
VungleCCPADenied,
|
||
|
|
};
|
||
|
|
|
||
|
|
typedef NS_ENUM (NSInteger, VungleAdSize) {
|
||
|
|
VungleAdSizeUnknown = 1,
|
||
|
|
VungleAdSizeBanner, // width = 320.0f, .height = 50.0f
|
||
|
|
VungleAdSizeBannerShort, // width = 300.0f, .height = 50.0f
|
||
|
|
VungleAdSizeBannerLeaderboard, // width = 728.0f, .height = 90.0f
|
||
|
|
};
|
||
|
|
|
||
|
|
@protocol VungleSDKLogger <NSObject>
|
||
|
|
- (void)vungleSDKLog:(NSString *)message;
|
||
|
|
@end
|
||
|
|
|
||
|
|
@class VungleSDK;
|
||
|
|
|
||
|
|
@protocol VungleSDKDelegate <NSObject>
|
||
|
|
@optional
|
||
|
|
|
||
|
|
/**
|
||
|
|
* If implemented, this will get called when the SDK has an ad ready to be displayed. Also it will
|
||
|
|
* get called with an argument `NO` for `isAdPlayable` when for some reason, there is
|
||
|
|
* no ad available, for instance there is a corrupt ad or the OS wiped the cache.
|
||
|
|
* Please note that receiving a `NO` here does not mean that you can't play an Ad: if you haven't
|
||
|
|
* opted-out of our Exchange, you might be able to get a streaming ad if you call `play`.
|
||
|
|
* @param isAdPlayable A boolean indicating if an ad is currently in a playable state
|
||
|
|
* @param placementID The ID of a placement which is ready to be played
|
||
|
|
* @param error The error that was encountered. This is only sent when the placementID is nil.
|
||
|
|
*/
|
||
|
|
- (void)vungleAdPlayabilityUpdate:(BOOL)isAdPlayable placementID:(nullable NSString *)placementID error:(nullable NSError *)error;
|
||
|
|
|
||
|
|
- (void)vungleAdPlayabilityUpdate:(BOOL)isAdPlayable placementID:(nullable NSString *)placementID __attribute__((deprecated("Use vungleAdPlayabilityUpdate:isAdPlayable:plaementID:error: instead.")));
|
||
|
|
/**
|
||
|
|
* If implemented, this will get called when the SDK is about to show an ad. This point
|
||
|
|
* might be a good time to pause your game, and turn off any sound you might be playing.
|
||
|
|
* @param placementID The placement which is about to be shown.
|
||
|
|
*/
|
||
|
|
- (void)vungleWillShowAdForPlacementID:(nullable NSString *)placementID;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* If implemented, this will get called when the SDK has presented the view controller or the
|
||
|
|
* view that houses the ad.
|
||
|
|
* @param placementID The placement which is about to be shown.
|
||
|
|
*/
|
||
|
|
- (void)vungleDidShowAdForPlacementID:(nullable NSString *)placementID;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* If implemented, this will be called when the ad is first rendered for the specified placement.
|
||
|
|
* @NOTE: Please use this callback to track views.
|
||
|
|
* @param placementID The placement ID of the advertisement shown
|
||
|
|
*/
|
||
|
|
- (void)vungleAdViewedForPlacement:(NSString *)placementID;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* If implemented, this method gets called when a Vungle Ad Unit is about to be completely dismissed.
|
||
|
|
* At this point, it's recommended to resume your Game or App.
|
||
|
|
*/
|
||
|
|
- (void)vungleWillCloseAdForPlacementID:(nonnull NSString *)placementID;
|
||
|
|
|
||
|
|
- (void)vungleWillCloseAdWithViewInfo:(nonnull VungleViewInfo *)info placementID:(nonnull NSString *)placementID __attribute__((deprecated("Use vungleWillCloseAdForPlacementID: instead.")));
|
||
|
|
|
||
|
|
- (void)vungleSDKwillCloseAdWithViewInfo:(NSDictionary *)viewInfo
|
||
|
|
willPresentProductSheet:(BOOL)willPresentProductSheet __attribute__((deprecated("Use vungleWillCloseAdForPlacementID: instead.")));
|
||
|
|
|
||
|
|
- (void)vungleSDKwillCloseProductSheet:(id)productSheet __attribute__((deprecated("Use vungleWillCloseAdForPlacementID: instead.")));
|
||
|
|
|
||
|
|
/**
|
||
|
|
* If implemented, this method gets called when a Vungle Ad Unit has been completely dismissed.
|
||
|
|
* At this point, you can load another ad for non-auto-cached placement if necessary.
|
||
|
|
*/
|
||
|
|
- (void)vungleDidCloseAdForPlacementID:(nonnull NSString *)placementID;
|
||
|
|
|
||
|
|
- (void)vungleDidCloseAdWithViewInfo:(nonnull VungleViewInfo *)info placementID:(nonnull NSString *)placementID __attribute__((deprecated("Use vungleDidCloseAdForPlacementID: instead.")));
|
||
|
|
|
||
|
|
/**
|
||
|
|
* If implemented, this method gets called when user clicks the Vungle Ad.
|
||
|
|
* At this point, it's recommended to track the click event.
|
||
|
|
*/
|
||
|
|
- (void)vungleTrackClickForPlacementID:(nullable NSString *)placementID;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* If implemented, this method gets called when user taps the Vungle Ad
|
||
|
|
* which will cause them to leave the current application(e.g. the ad action
|
||
|
|
* opens the iTunes store, Mobile Safari, etc).
|
||
|
|
*/
|
||
|
|
- (void)vungleWillLeaveApplicationForPlacementID:(nullable NSString *)placementID;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* This method is called when the user should be rewarded for watching a Rewarded Video Ad.
|
||
|
|
* At this point, it's recommended to reward the user.
|
||
|
|
*/
|
||
|
|
- (void)vungleRewardUserForPlacementID:(nullable NSString *)placementID;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* If implemented, this will get called when VungleSDK has finished initialization.
|
||
|
|
* It's only at this point that one can call `playAd:options:placementID:error`
|
||
|
|
* and `loadPlacementWithID:` without getting initialization errors
|
||
|
|
*/
|
||
|
|
- (void)vungleSDKDidInitialize;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* If implemented, this will get called if the VungleSDK fails to initialize.
|
||
|
|
* The included NSError object should give some information as to the failure reason.
|
||
|
|
* @note If initialization fails, you will need to restart the VungleSDK.
|
||
|
|
*/
|
||
|
|
- (void)vungleSDKFailedToInitializeWithError:(NSError *)error;
|
||
|
|
|
||
|
|
@end
|
||
|
|
|
||
|
|
@interface VungleSDK : NSObject
|
||
|
|
@property (strong) NSDictionary *userData;
|
||
|
|
@property (nullable, strong) id <VungleSDKDelegate> delegate;
|
||
|
|
@property (atomic, readonly, getter = isInitialized) BOOL initialized;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Used when background download has completed.
|
||
|
|
* @note This is sent by the
|
||
|
|
* application:handleEventsForBackgroundURLSession:completionHandler:
|
||
|
|
* and needs to be called in `URLSessionDidFinishEventsForBackgroundURLSession`
|
||
|
|
*/
|
||
|
|
@property void (^backgroundURLSessionCompletionHandler)(void);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Returns the singleton instance.
|
||
|
|
*/
|
||
|
|
+ (VungleSDK *)sharedSDK;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Sets the publish IDFV flag
|
||
|
|
* This value is persistent and so may be set once.
|
||
|
|
* @param publish whether to publish the IDFV value
|
||
|
|
*/
|
||
|
|
+ (void)setPublishIDFV:(BOOL)publish;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Returns the value of the persistent publish IDFV flag.
|
||
|
|
* @return the current value of the publish IDFV flag
|
||
|
|
*/
|
||
|
|
+ (BOOL)shouldPublishIDFV;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Enable or disable background downloads.
|
||
|
|
* @note If enabled you must implement the `application:handleEventsForBackgroundURLSession:completionHandler:`
|
||
|
|
* in your AppDelegate class. Before the AppDelegate method returns, call the VungleSDK completion handler
|
||
|
|
* `backgroundURLSessionCompletionHandler`.
|
||
|
|
* @param enable YES to enable, NO to disable
|
||
|
|
*/
|
||
|
|
+ (void)enableBackgroundDownload:(BOOL)enable;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Check to find out if background download is enabled.
|
||
|
|
* @return YES if background download is enabled, NO if not.
|
||
|
|
*/
|
||
|
|
+ (BOOL)backgroundDownloadEnabled;
|
||
|
|
|
||
|
|
#pragma mark - Initialization
|
||
|
|
/**
|
||
|
|
* Initializes the SDK. You can get your app id on Vungle's dashboard: https://v.vungle.com
|
||
|
|
* @param appID the unique identifier for your app
|
||
|
|
* @param placements An array of strings representing placements defined in the dashboard.
|
||
|
|
* @param error An error object containing information about why initialization failed
|
||
|
|
* @return YES if the SDK has started, NO otherwise
|
||
|
|
*/
|
||
|
|
- (BOOL)startWithAppId:(nonnull NSString *)appID placements:(nullable NSArray <NSString *> *)placements error:(NSError **)error __attribute__((deprecated("Use startWithAppId:appID:error: instead.")));
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Initializes the SDK. You can get your app id on Vungle's dashboard: https://v.vungle.com
|
||
|
|
* @param appID the unique identifier for your app
|
||
|
|
* @param error An error object containing information about why initialization failed
|
||
|
|
* @return YES if the SDK has started, NO otherwise
|
||
|
|
*/
|
||
|
|
- (BOOL)startWithAppId:(nonnull NSString *)appID error:(NSError **)error;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Initializes the SDK. You can get your app id on Vungle's dashboard: https://v.vungle.com
|
||
|
|
* @param appID the unique identifier for your app
|
||
|
|
* @param options A reference to an instance of NSDictionary with customized ad SDK initilize options
|
||
|
|
* @param error An error object containing information about why initialization failed
|
||
|
|
* @return YES if the SDK has started, NO otherwise
|
||
|
|
*/
|
||
|
|
- (BOOL)startWithAppId:(nonnull NSString *)appID options:(nullable NSDictionary *)options error:(NSError **)error;
|
||
|
|
|
||
|
|
#pragma mark - Interstitial, Flex View Ad playback
|
||
|
|
/**
|
||
|
|
* Will play Ad Unit presenting it over the `controller` parameter
|
||
|
|
* @note This method should only be called using placements with `fullscreen` or `flexview` template types
|
||
|
|
* @param controller A subclass of UIViewController. Should correspond to the ViewControler at the top of the ViewController hierarchy
|
||
|
|
* @param options A reference to an instance of NSDictionary with customized ad playback options
|
||
|
|
* @param placementID The placement defined on the Vungle dashboard
|
||
|
|
* @param error An optional double reference to an NSError. In case this method returns `NO` it will be non-nil
|
||
|
|
* @return YES/NO in case of success/error while presenting an AdUnit
|
||
|
|
* @warning Should be called from the main-thread.
|
||
|
|
*/
|
||
|
|
- (BOOL)playAd:(UIViewController *)controller options:(nullable NSDictionary *)options placementID:(nullable NSString *)placementID error:(NSError *__autoreleasing _Nullable *_Nullable)error;
|
||
|
|
|
||
|
|
#pragma mark - MREC / Banner Ad lifecycle
|
||
|
|
/**
|
||
|
|
* Pass in an UIView which acts as a container for the ad experience. This view container may be placed in random positions.
|
||
|
|
* @note This method should only be called using placements that have the `flexfeed` or `mrec` or `banner` template type. For
|
||
|
|
* the `mrec` template type, note that the UIView must have a width of 300 and a height of 250. If the view is provided without
|
||
|
|
* these dimensions, an error message will be returned and the ad will not be shown. For the `banner` template type, note that
|
||
|
|
* the UIView must have the same width and height as the banner size (320x50, 300x50, or 728x90) which you requested. If the
|
||
|
|
* view is provided with a different banner size, an error message will be returned and the ad will not be shown.
|
||
|
|
* @param publisherView container view in which an ad will be displayed
|
||
|
|
* @param options A reference to an instance of NSDictionary with customized ad playback options
|
||
|
|
* @param placementID The placement defined on the Vungle dashboard
|
||
|
|
* @param error An optional double reference to an NSError. In case this method returns `NO` it will be non-nil
|
||
|
|
* @return YES/NO in case of success/error while presenting an AdUnit
|
||
|
|
*/
|
||
|
|
- (BOOL)addAdViewToView:(UIView *)publisherView withOptions:(nullable NSDictionary *)options placementID:(nullable NSString *)placementID error:(NSError *__autoreleasing _Nullable *_Nullable)error;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* This method will dismiss the currently playing Flex View, Flex Feed, Banner or MREC advertisement. If you have added an
|
||
|
|
* advertisement with `addAdViewToView:` or you are playing a placement that has been configured as a Flex View, Flex Feed,
|
||
|
|
* Banner or MREC placement, then this method will remove the advertisement from the screen and perform any necessary clean up
|
||
|
|
* steps.
|
||
|
|
*
|
||
|
|
* This method will call the existing delegate callbacks as part of the lifecycle.
|
||
|
|
*/
|
||
|
|
- (void)finishedDisplayingAd __attribute((deprecated("Use finishDisplayingAd: with the placementID of the ad to finish.")));
|
||
|
|
|
||
|
|
/**
|
||
|
|
* This method will dismiss the currently playing Flex View, Flex Feed, Banner or MREC advertisement with the placementId specified.
|
||
|
|
* If you have added an advertisement with `addAdViewToView:` or you are playing a placement that has been configured as a
|
||
|
|
* Flex View, Flex Feed, Banner or MREC placement, then this method will remove the advertisement from the screen and perform any
|
||
|
|
* necessary clean up steps.
|
||
|
|
* This method will call the existing delegate callbacks as part of the lifecycle.
|
||
|
|
* @param placementId Thje placement identifier for the ad to dismiss.
|
||
|
|
*/
|
||
|
|
- (void)finishDisplayingAd:(NSString *)placementId;
|
||
|
|
|
||
|
|
#pragma mark - Placements support
|
||
|
|
/**
|
||
|
|
* Returns YES/NO when there is certainty that an ad will be able to play/can't play for a given placementID.
|
||
|
|
* @param placementID the specific ID of the placement you are trying to present
|
||
|
|
*/
|
||
|
|
- (BOOL)isAdCachedForPlacementID:(nonnull NSString *)placementID;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* (Overloaded method)
|
||
|
|
* Returns YES/NO when there is certainty that an ad will be able to play/can't play for a given placementID.
|
||
|
|
* @param size the VungleAdSize (enum) you would like to request (only for banner ad type at the moment)
|
||
|
|
* @param placementID the specific ID of the placement you are trying to present
|
||
|
|
*/
|
||
|
|
- (BOOL)isAdCachedForPlacementID:(nonnull NSString *)placementID withSize:(VungleAdSize)size;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Prepares a placement when you know that you will want
|
||
|
|
* to show an ad experience tied to a specific placementID.
|
||
|
|
* @param placementID the specific ID of the placement you would like to present at some point soon
|
||
|
|
* @param error the NSError object that used to hold error generated
|
||
|
|
* @return NO if something goes immediately wrong with loading, YES otherwise
|
||
|
|
*/
|
||
|
|
- (BOOL)loadPlacementWithID:(NSString *)placementID error:(NSError **)error;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* (Overloaded method)
|
||
|
|
* Prepares a placement when you know that you will want
|
||
|
|
* to show an ad experience tied to a specific placementID.
|
||
|
|
* @param placementID the specific ID of the placement you would like to present at some point soon
|
||
|
|
* @param size the VungleAdSize (enum) you would like to request (only for banner ad type at the moment)
|
||
|
|
* @param error the NSError object that used to hold error generated
|
||
|
|
* @return NO if something goes immediately wrong with loading, YES otherwise
|
||
|
|
*/
|
||
|
|
- (BOOL)loadPlacementWithID:(NSString *)placementID withSize:(VungleAdSize)size error:(NSError **)error;
|
||
|
|
|
||
|
|
#pragma mark - Utility methods
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @note This method replaces the `muted` property previously included in VungleSDK.h
|
||
|
|
* @note IT IS HIGHLY RECOMMENDED to set the muted property at the placement level using
|
||
|
|
* play options (key VunglePlayAdOptionKeyStartMuted).
|
||
|
|
* Assigning a value to this property will allow all ads played by the SDK to start muted, or
|
||
|
|
* unmuted. Once called, all ads will use the value provided until the SDK restarts, or until the
|
||
|
|
* method is called with a different value.
|
||
|
|
*/
|
||
|
|
- (void)setMuted:(BOOL)muted;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Returns debug info.
|
||
|
|
*/
|
||
|
|
- (NSDictionary *)debugInfo;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* By default, logging is off.
|
||
|
|
*/
|
||
|
|
- (void)setLoggingEnabled:(BOOL)enable;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Log a new message. The message will be sent to all loggers.
|
||
|
|
*/
|
||
|
|
- (void)log:(NSString *)message, ... NS_FORMAT_FUNCTION(1, 2);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Attach a new logger. It will get called on every log generated by Vungle (internally and externally).
|
||
|
|
*/
|
||
|
|
- (void)attachLogger:(id <VungleSDKLogger>)logger;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Detaches a logger. Make sure to do this, otherwise you might leak memory.
|
||
|
|
*/
|
||
|
|
- (void)detachLogger:(id <VungleSDKLogger>)logger;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* This only works on the simulator
|
||
|
|
*/
|
||
|
|
- (void)clearSleep;
|
||
|
|
|
||
|
|
#pragma mark - GDPR support
|
||
|
|
/**
|
||
|
|
* This method takes the consent status of users. If consent is given, Vungle will be able to send targeted ads.
|
||
|
|
* @param status the enum to be set for user consent status.
|
||
|
|
* @param version the string to be set for publisher's consent version. It can be any string value.
|
||
|
|
*/
|
||
|
|
- (void)updateConsentStatus:(VungleConsentStatus)status consentMessageVersion:(NSString *)version;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* This method returns the current consent status for the user recorded in the SDK. If no status is found,
|
||
|
|
* the method returns 0.
|
||
|
|
*/
|
||
|
|
- (VungleConsentStatus)getCurrentConsentStatus;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* This method returns the current consent message version that recorded in the SDK. If not version info found,
|
||
|
|
* the method returns nil.
|
||
|
|
*/
|
||
|
|
- (NSString *)getConsentMessageVersion;
|
||
|
|
|
||
|
|
#pragma mark - CCPA support
|
||
|
|
/**
|
||
|
|
* This method takes the CCPA status of users. If CCPA status is accepted, Vungle will be able to send targeted ads.
|
||
|
|
* @param status the enum to be set for user CCPA status.
|
||
|
|
*/
|
||
|
|
- (void)updateCCPAStatus:(VungleCCPAStatus)status;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* This method returns the current CCPA status for the user recorded in the SDK. If no status is found,
|
||
|
|
* the method returns 0.
|
||
|
|
*/
|
||
|
|
- (VungleCCPAStatus)getCurrentCCPAStatus;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* This method disables refresh functionality for all banner and MREC placements.
|
||
|
|
*/
|
||
|
|
- (void)disableBannerRefresh;
|
||
|
|
|
||
|
|
@end
|
||
|
|
|
||
|
|
NS_ASSUME_NONNULL_END
|