140 lines
5.2 KiB
C
140 lines
5.2 KiB
C
|
|
//
|
||
|
|
// MAAdView.h
|
||
|
|
// AppLovinSDK
|
||
|
|
//
|
||
|
|
// Created by Thomas So on 8/9/18.
|
||
|
|
// Copyright © 2020 AppLovin Corporation. All rights reserved.
|
||
|
|
//
|
||
|
|
|
||
|
|
#import <UIKit/UIKit.h>
|
||
|
|
#import "ALSdk.h"
|
||
|
|
#import "MAAdViewAdDelegate.h"
|
||
|
|
#import "MAAdRevenueDelegate.h"
|
||
|
|
#import "MAAdReviewDelegate.h"
|
||
|
|
|
||
|
|
NS_ASSUME_NONNULL_BEGIN
|
||
|
|
|
||
|
|
/**
|
||
|
|
* This class represents a view-based ad — i.e. banner/leader or MREC.
|
||
|
|
*
|
||
|
|
* @see <a href="https://dash.applovin.com/documentation/mediation/ios/getting-started/banners">MAX Integration Guide ⇒ iOS ⇒ Banners</a>
|
||
|
|
* @see <a href="https://dash.applovin.com/documentation/mediation/ios/getting-started/mrecs">MAX Integration Guide ⇒ iOS ⇒ MRECs</a>
|
||
|
|
*/
|
||
|
|
@interface MAAdView : UIView
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Creates a new ad view for a given ad unit ID.
|
||
|
|
*
|
||
|
|
* @param adUnitIdentifier Ad unit ID to load ads for.
|
||
|
|
*/
|
||
|
|
- (instancetype)initWithAdUnitIdentifier:(NSString *)adUnitIdentifier;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Creates a new ad view for a given ad unit ID.
|
||
|
|
*
|
||
|
|
* @param adUnitIdentifier Ad unit ID to load ads for.
|
||
|
|
* @param sdk SDK to use. You can obtain an instance of the SDK by calling @code +[ALSdk shared] @endcode.
|
||
|
|
*/
|
||
|
|
- (instancetype)initWithAdUnitIdentifier:(NSString *)adUnitIdentifier sdk:(ALSdk *)sdk;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Creates a new ad view for a given ad unit ID and ad format.
|
||
|
|
*
|
||
|
|
* @param adUnitIdentifier Ad unit ID to load ads for.
|
||
|
|
* @param adFormat Ad format to load ads for.
|
||
|
|
*/
|
||
|
|
- (instancetype)initWithAdUnitIdentifier:(NSString *)adUnitIdentifier adFormat:(MAAdFormat *)adFormat;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Create a new ad view for a given ad unit ID, ad format, and SDK.
|
||
|
|
*
|
||
|
|
* @param adUnitIdentifier Ad unit id to load ads for.
|
||
|
|
* @param adFormat Ad format to load ads for.
|
||
|
|
* @param sdk SDK to use. You can obtain an instance of the SDK by calling @code +[ALSdk shared] @endcode.
|
||
|
|
*/
|
||
|
|
- (instancetype)initWithAdUnitIdentifier:(NSString *)adUnitIdentifier adFormat:(MAAdFormat *)adFormat sdk:(ALSdk *)sdk;
|
||
|
|
|
||
|
|
- (instancetype)init NS_UNAVAILABLE;
|
||
|
|
- (instancetype)initWithFrame:(CGRect)frame NS_UNAVAILABLE;
|
||
|
|
- (instancetype)initWithCoder:(NSCoder *)decoder NS_UNAVAILABLE;
|
||
|
|
+ (instancetype)new NS_UNAVAILABLE;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* A delegate that will be notified about ad events.
|
||
|
|
*/
|
||
|
|
@property (nonatomic, weak, nullable) IBOutlet id<MAAdViewAdDelegate> delegate;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* A delegate that will be notified about ad revenue events.
|
||
|
|
*/
|
||
|
|
@property (nonatomic, weak, nullable) IBOutlet id<MAAdRevenueDelegate> revenueDelegate;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* A delegate that will be notified about Ad Review events.
|
||
|
|
*/
|
||
|
|
@property (nonatomic, weak, nullable) IBOutlet id<MAAdReviewDelegate> adReviewDelegate;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Loads the ad for the current ad view. Set @code [MAAdView delegate] @endcode to assign a delegate that should be notified about ad load state.
|
||
|
|
*
|
||
|
|
* @see <a href="https://dash.applovin.com/documentation/mediation/ios/getting-started/banners#loading-a-banner">MAX Integration Guide ⇒ iOS ⇒ Banners ⇒ Loading a Banner</a>
|
||
|
|
* @see <a href="https://dash.applovin.com/documentation/mediation/ios/getting-started/mrecs#loading-an-mrec">MAX Integration Guide ⇒ iOS ⇒ MRECs ⇒ Loading an MREC</a>
|
||
|
|
*/
|
||
|
|
- (void)loadAd;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Starts or resumes auto-refreshing of the banner.
|
||
|
|
*
|
||
|
|
* @see <a href="https://dash.applovin.com/documentation/mediation/ios/getting-started/banners#showing-a-banner">MAX Integration Guide ⇒ iOS ⇒ Banners ⇒ Showing a Banner</a>
|
||
|
|
* @see <a href="https://dash.applovin.com/documentation/mediation/ios/getting-started/mrecs#hiding-and-showing-an-mrec">MAX Integration Guide ⇒ iOS ⇒ MRECs ⇒ Hiding and Showing an MREC</a>
|
||
|
|
*/
|
||
|
|
- (void)startAutoRefresh;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Pauses auto-refreshing of the banner.
|
||
|
|
*
|
||
|
|
* @see <a href="https://dash.applovin.com/documentation/mediation/ios/getting-started/banners#hiding-a-banner">MAX Integration Guide ⇒ iOS ⇒ Banners ⇒ Hiding a Banner</a>
|
||
|
|
* @see <a href="https://dash.applovin.com/documentation/mediation/ios/getting-started/mrecs#hiding-and-showing-an-mrec">MAX Integration Guide ⇒ iOS ⇒ MRECs ⇒ Hiding and Showing an MREC</a>
|
||
|
|
*/
|
||
|
|
- (void)stopAutoRefresh;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* The placement name that you assign when you integrate each ad format, for granular reporting in ad events (e.g. "Rewarded_Store", "Rewarded_LevelEnd").
|
||
|
|
*/
|
||
|
|
@property (nonatomic, copy, nullable) NSString *placement;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* The ad unit identifier this @c MAAdView was initialized with and is loading ads for.
|
||
|
|
*/
|
||
|
|
@property (nonatomic, copy, readonly) NSString *adUnitIdentifier;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* The format of the ad view.
|
||
|
|
*/
|
||
|
|
@property (nonatomic, weak, readonly) MAAdFormat *adFormat;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Sets an extra parameter key/value pair for the ad.
|
||
|
|
*
|
||
|
|
* @param key Parameter key.
|
||
|
|
* @param value Parameter value.
|
||
|
|
*/
|
||
|
|
- (void)setExtraParameterForKey:(NSString *)key value:(nullable NSString *)value;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Set a local extra parameter to pass to the adapter instances. Will not be available in the @code -[MAAdapter initializeWithParameters:withCompletionHandler:] @endcode method.
|
||
|
|
*
|
||
|
|
* @param key Parameter key. Must not be null.
|
||
|
|
* @param value Parameter value. May be null.
|
||
|
|
*/
|
||
|
|
- (void)setLocalExtraParameterForKey:(NSString *)key value:(nullable id)value;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* The custom data to tie the showing ad to, for ILRD and rewarded postbacks via the @c {CUSTOM_DATA} macro. Maximum size is 8KB.
|
||
|
|
*/
|
||
|
|
@property (nonatomic, copy, nullable) NSString *customData;
|
||
|
|
|
||
|
|
@end
|
||
|
|
|
||
|
|
NS_ASSUME_NONNULL_END
|