Menu

ATAdManager (Splash)

The operation extension for Splash ads, providing features such as ad display, checking cache, checking whether the ad is ready, and scenario statistics. It also includes the definition of Extra keys.

Copy
extern NSString *const kATSplashExtraCountdownKey;
extern NSString *const kATSplashExtraTolerateTimeoutKey; // Timeout duration
extern NSString *const kATSplashExtraHideSkipButtonFlagKey;
extern NSString *const kATSplashExtraBackgroundImageKey;
extern NSString *const kATSplashExtraBackgroundColorKey;
extern NSString *const kATSplashExtraSkipButtonCenterKey;
extern NSString *const kATSplashExtraCustomSkipButtonKey; // Only supports UIButton
extern NSString *const kATSplashExtraCanClickFlagKey;
extern NSString *const kATSplashExtraShowDirectionKey; // Supports Kuaishou Splash ad. Default is vertical direction. 1 indicates horizontal direction.
// 5.7.61+
extern NSString *const kATSplashExtraCountdownIntervalKey;

extern NSString *const kATSplashExtraPlacementIDKey;
extern NSString *const kATSplashExtraNetworkFirmID; // Ad network ID
extern NSString *const kATSplashExtraAdSourceIDKey; // Ad source ID
 
@protocol ATSplashDelegate;

@interface ATAdManager (Splash)

/// Called when loading an ad
/// @param placementID - The placement ID string to be displayed
/// @param extra - Local configuration parameters
/// @param delegate - Delegate object
/// @param containerView - Bottom view
- (void)loadADWithPlacementID:(NSString *)placementID
                        extra:(NSDictionary *)extra
                     delegate:(id<ATSplashDelegate>)delegate
                containerView:(UIView * _Nullable)containerView;

- (void)loadADWithPlacementID:(NSString *)placementID
                        extra:(NSDictionary *)extra
                      tkExtra:(NSDictionary * _Nullable)tkExtra
                adxFloorPrice:(ATADXFloorPrice * _Nullable)adxFloorPrice
                     delegate:(id<ATSplashDelegate>)delegate
                containerView:(UIView * _Nullable)containerView;

/// Called when displaying a Splash ad
/// @param window The window displaying the ad
- (void)showSplashWithPlacementID:(NSString *)placementID 
                            scene:(NSString *)scene
                           window:(UIWindow *)window
                         delegate:(id<ATSplashDelegate>)delegate DEPRECATED_MSG_ATTRIBUTE("Please use showSplashWithPlacementID:config:window:inViewController:extra:delegate: instead");

/// v5.7.61+
- (void)showSplashWithPlacementID:(NSString *)placementID 
                            scene:(NSString *)scene
                           window:(UIWindow *)window
                            extra:(NSDictionary *_Nullable)extra
                         delegate:(id<ATSplashDelegate>)delegate DEPRECATED_MSG_ATTRIBUTE("Please use showSplashWithPlacementID:config:window:inViewController:extra:delegate: instead");

- (void)showSplashWithPlacementID:(NSString *)placementID
                            scene:(NSString *)scene
                           window:(UIWindow *)window
                 inViewController:(UIViewController *)viewController
                         delegate:(id<ATSplashDelegate>)delegate DEPRECATED_MSG_ATTRIBUTE("Please use showSplashWithPlacementID:config:window:inViewController:extra:delegate: instead");

/// v6.2.96+
/// - Parameter Description:
///   - placementID: Placement ID
///   - scene: Scenario ID
///   - window: Display container window. If nil, the key window is used by default.
///   - viewController: Display container view controller. If nil, the top-level view controller is used by default.
///   - extra: Extra parameters
///   - delegate: Event delegate
- (void)showSplashWithPlacementID:(NSString *)placementID 
                            scene:(NSString *)scene
                           window:(UIWindow *)window
                 inViewController:(UIViewController *)viewController
                            extra:(NSDictionary *_Nullable)extra
                         delegate:(id<ATSplashDelegate>)delegate DEPRECATED_MSG_ATTRIBUTE("Please use showSplashWithPlacementID:config:window:inViewController:extra:delegate: instead");

- (void)showSplashWithPlacementID:(NSString *)placementID
                           config:(ATShowConfig *)config
                           window:(UIWindow *)window
                 inViewController:(UIViewController *)viewController
                            extra:(NSDictionary *_Nullable)extra
                         delegate:(id<ATSplashDelegate>)delegate;

/// Check whether the Splash ad is ready
/// v5.7.06+
- (BOOL)splashReadyForPlacementID:(NSString *)placementID;

/// Check whether the Splash ad is ready
/// @param send - Whether to send tracking events
- (BOOL)splashReadyForPlacementID:(NSString *)placementID
                           sendTK:(BOOL)send;

- (BOOL)splashReadyWithoutLogForPlacementID:(NSString *)placementID sendTK:(BOOL)send;

/// Get the status object ATCheckLoadModel of the current placement
- (nullable ATCheckLoadModel *)checkSplashLoadStatusForPlacementID:(NSString *)placementID;

/// Query all cache information for the placement
- (nullable NSArray<NSDictionary *> *)getSplashValidAdsForPlacementID:(NSString *)placementID;

/// Record the cache status statistics of the current placement in a business scenario
/// @param scene - Ad scenario
/// v5.7.91+
- (void)entrySplashScenarioWithPlacementID:(NSString *)placementID
                                     scene:(NSString *)scene;

@end
Previous
ATAdManager (RewardedVideo)
Next
Protocol
Last modified: 2026-07-08Powered by