AATAppOpenAdPlacement

Swift

@objc public protocol AATAppOpenAdPlacement {

    /// Set the placement delegate that will listen to ad loading and display events.
    var delegate: AATAppOpenPlacementDelegate? { get set }

    /// Set the placement statistics delegate
    var statisticsDelegate: AATStatisticsDelegate? { get set }

    /// Set the placement impression delegate
    var impressionDelegate: AATImpressionDelegate? { get set }

    /// Start the automatic reloading of the placement.
    ///
    /// When using this method, the placement will automatically once the current loaded ad has been shown.
    ///
    func startAutoReload()

    /// Stop the automatic reloading of the placement.
    func stopAutoReload()

    /// Requests placement reload.
    ///
    /// Works only if automatic reloading is disabled. In this case, the placement will not request a new ad after showing the current loaded one.
    ///
    func reload() -> Bool

    /// Returns true if there is an ad loaded.
    /// - Returns: True if there is an ad loaded.
    func hasAd() -> Bool

    /// Shows the fullscreen ad if ad is ready.
    /// - Returns: True if showing fullscreen was successful, false otherwise.
    func show() -> Bool

    /// Sets the targeting information for the placement
    ///
    /// Information provided for placement overrides targeting information overrides targeting information for application set by the ``AATSDK/setTargetingInfo(info:)``
    var targetingInfo: [String : [String]]? { get set }

    /// Sets the content targeting url for the placement.
    ///
    /// Information provided for placement overrides targeting information for application set by the ``AATSDK/setContentTargetingUrl(targetingUrl:)``
    var contentTargetingUrl: String? { get set }

    /// Checks if the frequency cap has been reached.
    /// - Returns: true if the frequency cap has been reached.
    func isFrequencyCapReached() -> Bool
}

Objective-C

@protocol AATAppOpenAdPlacement <AATPlacement>
/// Set the placement delegate that will listen to ad loading and display events.
@property (nonatomic, strong) id <AATAppOpenPlacementDelegate> _Nullable delegate;
/// Sets the placement statistics delegate
@property (nonatomic, strong) id <AATStatisticsDelegate> _Nullable statisticsDelegate;
/// Sets the placement impression delegate
@property (nonatomic, strong) id <AATImpressionDelegate> _Nullable impressionDelegate;
/// Start the automatic reloading of the placement.
/// When using this method, the placement will automatically once the current loaded ad has been shown.
- (void)startAutoReload;
/// Stop the automatic reloading of the placement.
- (void)stopAutoReload;
/// Requests placement reload.
/// Works only if automatic reloading is disabled. In this case, the placement will not request a new ad after showing the current loaded one.
- (BOOL)reload;
/// Returns true if there is an ad loaded.
///
/// returns:
/// True if there is an ad loaded.
- (BOOL)hasAd;
/// Shows the fullscreen ad if ad is ready.
///
/// returns:
/// True if showing fullscreen was successful, false otherwise.
- (BOOL)show;
/// Sets the targeting information for the placement
/// Information provided for placement overrides targeting information overrides targeting information for application set by the <code>AATSDK/setTargetingInfo(info:)</code>
@property (nonatomic, copy) NSDictionary<NSString *, NSArray<NSString *> *> * _Nullable targetingInfo;
/// Sets the content targeting url for the placement.
/// Information provided for placement overrides targeting information for application set by the <code>AATSDK/setContentTargetingUrl(targetingUrl:)</code>
@property (nonatomic, copy) NSString * _Nullable contentTargetingUrl;
/// Checks if the frequency cap has been reached.
///
/// returns:
/// true if the frequency cap has been reached.
- (BOOL)isFrequencyCapReached;
@end