Manual loading

1. Introduction

Manual loading mode can satisfy developers who need flexible access.

1.1 Integration suggestions

1. Loading ads:
• After the opening screen ad is displayed, Load ads by calling loadADWithPlacementID in advance to reduce user waiting time when displayed.
2. Scene statistics:
• It is recommended to call entryRewardedVideoScenarioWithPlacementID after entering the scene where the advertisement is displayed to count the number of usage scenarios of the current ad slot, specifically For statistical explanations, you can view Advertising Scenarios to distinguish data between different business scenarios.
3. Display ads:
• Call rewardedVideoReadyForPlacementID before displaying to determine whether the ad is ready
• YES: You can call showRewardedVideoWithPlacementID for ad display;
• NO: You need to decide whether to give up the impression and preload the next ad based on your needs. , or reload the ad and wait for it to be displayed after success.
4. Next ad preload:
• After the ad is displayed, you can start playing the callback rewardedVideoDidStartPlayingForPlacementID or close it Call loadADWithPlacementID in the callback of rewardedVideoDidCloseForPlacementID for preloading.
• You can refer to Automatically request ads to enable automatic request for ads. If the preloading logic after display above has been implemented, Then automatic request does not need to be turned on, and vice versa.
5. It is recommended to configure the preset strategy:
• Improve the ad loading effect of the first cold start. For detailed instructions and access tutorials, see SDK preset strategy usage instructions

1.2 Notes:

• It is forbidden to execute the ad loading method in the didFailToLoadADWithPlacementID callback, otherwise it will cause a lot of Useless request and may cause application lag
• The userId passed in extra in the loading method, extraData will only be used next time and Subsequent rewarded video loading will take effect, but cached rewarded video ads will not take effect
• Avoid displaying rewarded videos directly in the didFinishLoadingADWithPlacementID callback. If automatic ad requesting is enabled in the background, the SDK will automatically request ads after the ad is displayed, and developers cannot accurately control the timing of rewarded video display
• It is not recommended when the App is in the background Download advertisements to avoid unnecessary exceptions caused by system recycling resources

2. API description

2.1 Loading ads

ATAdManager: Management class for rewarded video ads

Sample code display:

#import <AnyThinkRewardedVideo/AnyThinkRewardedVideo.h>

// load ad
  - (void)loadAd {
    // Set extra, custom parameters, will be sent back in the agent's Extra, can be used to match the custom rules of the AD space; 
    // When the server incentive video callback is enabled, set this value and then send it back to the developer when the incentive is sent.
    NSDictionary *extra = @{
          kATAdLoadingExtraMediaExtraKey:@"media_val",
          kATAdLoadingExtraUserIDKey:@"rv_test_user_id",
          kATAdLoadingExtraRewardNameKey:@"reward_Name",
          kATAdLoadingExtraRewardAmountKey:@(3)
      };
 
    [[ATAdManager sharedManager] loadADWithPlacementID:@"your rv placementId" extra:extra delegate:self];
}

2.2 Display Advertising

Sample code display:

- (void)showRewardVideoAd {
    // Check if the AD is filled before display
    if ([[ATAdManager sharedManager] rewardedVideoReadyForPlacementID:@"your rv placementId"]) {
        // Ads filled, display ads
        [[ATAdManager sharedManager] showRewardedVideoWithPlacementID:@"your rv placementId" inViewController:self delegate:self];
    } else {
        // Unfilled AD
    }
}

2.3 Scene statistics

Statistics on the probability of users reaching the scene, and the data report presented in the background -> Funnel Analysis Report -> reaches the advertising scene, so it is recommended that developers call it in the right place.

/*
     To collect scene arrival rate statistics, you can view related information https://docs.toponad.com/#/zh-cn/ios/NetworkAccess/scenario/scenario
     Call the "Enter AD scene" method when an AD trigger condition is met, such as:
     ** The scenario is a pop-up AD after the cleanup, which is called at the end of the cleanup.
     * 1、Call entryXXX to report the arrival of the scene.
     * 2、Call xxRewardedVideoReadyForPlacementID.
     * 3、Call showXX to show AD view.
     * (Note the difference between auto and manual)
     */
[[ATAdManager sharedManager] entryRewardedVideoScenarioWithPlacementID:@"your rv placement id" scene:@"your scenarioID"];
// Check if the AD is filled before display
if ([[ATAdManager sharedManager] rewardedVideoReadyForPlacementID:@"your rv placementId"]) {
    // Ad filled, showing ad
    [[ATAdManager sharedManager] showRewardedVideoWithPlacementID:@"your rv placementId" scene:@"your scenarioID" inViewController:self delegate:self];
} else {
    // Unfilled AD
}

2.4 Delegate callback

ATAdLoadingDelegate method

ATRewardedVideoDelegate method

Note: Only TT(CSJ) supports VideoAgainDelegate

Sample code display ：

#pragma mark - loading delegate
- (void)didStartLoadingADSourceWithPlacementID:(NSString *)placementID extra:(NSDictionary*)extra {
    NSLog(@"ADSource--AD--Start--ATRewardVideoViewController::didStartLoadingADSourceWithPlacementID:%@---extra:%@", placementID,extra);
}

- (void)didFinishLoadingADSourceWithPlacementID:(NSString *)placementID extra:(NSDictionary*)extra {
    NSLog(@"ADSource--AD--Finish--ATRewardVideoViewController::didFinishLoadingADSourceWithPlacementID:%@---extra:%@", placementID,extra);
}

- (void)didFailToLoadADSourceWithPlacementID:(NSString*)placementID extra:(NSDictionary*)extra error:(NSError*)error {
    NSLog(@"ADSource--AD--Fail--ATRewardVideoViewController::didFailToLoadADSourceWithPlacementID:%@---error:%@", placementID,error);
}

// bidding
- (void)didStartBiddingADSourceWithPlacementID:(NSString *)placementID extra:(NSDictionary*)extra {
    NSLog(@"ADSource--bid--Start--ATRewardVideoViewController::didStartBiddingADSourceWithPlacementID:%@---extra:%@", placementID,extra);
}

- (void)didFinishBiddingADSourceWithPlacementID:(NSString *)placementID extra:(NSDictionary*)extra {
    NSLog(@"ADSource--bid--Finish--ATRewardVideoViewController::didFinishBiddingADSourceWithPlacementID:%@--extra:%@", placementID,extra);
}

- (void)didFailBiddingADSourceWithPlacementID:(NSString*)placementID extra:(NSDictionary*)extra error:(NSError*)error {
    NSLog(@"ADSource--bid--Fail--ATRewardVideoViewController::didFailBiddingADSourceWithPlacementID:%@--error:%@", placementID,error);
}

-(void) didFinishLoadingADWithPlacementID:(NSString *)placementID {
    NSLog(@"PlacementID--load--Finish--ATRewardedVideoViewController::didFinishLoadingADWithPlacementID:%@", placementID);
}

-(void) didFailToLoadADWithPlacementID:(NSString*)placementID error:(NSError*)error {
    NSLog(@"PlacementID--load--Fail--ATRewardedVideoViewController::didFailToLoadADWithPlacementID:%@ error:%@", placementID, error);
}

#pragma mark - showing delegate
-(void) rewardedVideoDidRewardSuccessForPlacemenID:(NSString *)placementID extra:(NSDictionary *)extra{
    NSLog(@"ATRewardedVideoViewController::rewardedVideoDidRewardSuccessForPlacemenID:%@ extra:%@",placementID,extra);
}

-(void) rewardedVideoDidStartPlayingForPlacementID:(NSString *)placementID extra:(NSDictionary *)extra {
    NSLog(@"ATRewardedVideoViewController::rewardedVideoDidStartPlayingForPlacementID:%@ extra:%@", placementID, extra);
    [self showLog:[NSString stringWithFormat:@"rewardedVideoDidStartPlaying:%@", placementID]];
}

-(void) rewardedVideoDidEndPlayingForPlacementID:(NSString*)placementID extra:(NSDictionary *)extra {
    NSLog(@"ATRewardedVideoViewController::rewardedVideoDidEndPlayingForPlacementID:%@ extra:%@", placementID, extra);
}

-(void) rewardedVideoDidFailToPlayForPlacementID:(NSString*)placementID error:(NSError*)error extra:(NSDictionary *)extra {
    NSLog(@"ATRewardedVideoViewController::rewardedVideoDidFailToPlayForPlacementID:%@ error:%@ extra:%@", placementID, error, extra);
}

-(void) rewardedVideoDidCloseForPlacementID:(NSString*)placementID rewarded:(BOOL)rewarded extra:(NSDictionary *)extra {
    NSLog(@"ATRewardedVideoViewController::rewardedVideoDidCloseForPlacementID:%@, rewarded:%@ extra:%@", 
        placementID, rewarded ? @"yes" : @"no", extra);
}

-(void) rewardedVideoDidClickForPlacementID:(NSString*)placementID extra:(NSDictionary *)extra {
    NSLog(@"ATRewardedVideoViewController::rewardedVideoDidClickForPlacementID:%@ extra:%@", placementID, extra);
}

- (void)rewardedVideoDidDeepLinkOrJumpForPlacementID:(NSString *)placementID extra:(NSDictionary *)extra result:(BOOL)success {
    NSLog(@"ATRewardedVideoViewController:: rewardedVideoDidDeepLinkOrJumpForPlacementID:placementID:%@ with extra: %@, success:%@", 
        placementID,extra, success ? @"YES" : @"NO");
}

// rewarded video again (only TT(CSJ))
-(void) rewardedVideoAgainDidStartPlayingForPlacementID:(NSString*)placementID extra:(NSDictionary*)extra {
    NSLog(@"ATRewardedVideoViewController::rewardedVideoAgainDidStartPlayingForPlacementID:%@ extra:%@", placementID, extra);
}

-(void) rewardedVideoAgainDidEndPlayingForPlacementID:(NSString*)placementID extra:(NSDictionary*)extra {
    NSLog(@"ATRewardedVideoViewController::rewardedVideoAgainDidEndPlayingForPlacementID:%@ extra:%@", placementID, extra);
}

-(void) rewardedVideoAgainDidFailToPlayForPlacementID:(NSString*)placementID error:(NSError*)error extra:(NSDictionary*)extra {
    NSLog(@"ATRewardedVideoViewController::rewardedVideoAgainDidFailToPlayForPlacementID:%@ extra:%@", placementID, extra);
}

-(void) rewardedVideoAgainDidClickForPlacementID:(NSString*)placementID extra:(NSDictionary*)extra {
    NSLog(@"ATRewardedVideoViewController::rewardedVideoAgainDidClickForPlacementID:%@ extra:%@", placementID, extra);
}

-(void) rewardedVideoAgainDidRewardSuccessForPlacemenID:(NSString*)placementID extra:(NSDictionary*)extra {
    NSLog(@"ATRewardedVideoViewController::rewardedVideoAgainDidRewardSuccessForPlacemenID:%@ extra:%@", placementID, extra);
}

2.5 Set server callback Parameters

// Set extra, custom parameters, will be sent back in the agent's Extra, can be used to match the custom rules of the AD space;  
// When the server incentive video callback is enabled, set this value and then send it back to the developer when the incentive is sent.
  NSDictionary *extra = @{
        kATAdLoadingExtraMediaExtraKey:@"media_val", 
        kATAdLoadingExtraUserIDKey:@"rv_test_user_id",
        kATAdLoadingExtraRewardNameKey:@"reward_Name",
        kATAdLoadingExtraRewardAmountKey:@(3)
    };
  // load Reward ad
  [[ATAdManager sharedManager] loadADWithPlacementID:@"your rv placementId" extra:extra delegate:self];

2.6 Other APIs

// Query all cache information for the placement id
 NSArray *array = [[ATAdManager sharedManager] getRewardedVideoValidAdsForPlacementID:@"your rv placementID"];
 NSLog(@"ValidAds.count:%ld--- ValidAds:%@",array.count,array);

3. Sample code

#import <AnyThinkRewardedVideo/AnyThinkRewardedVideo.h>

@interface ATRewardVideoViewController () <ATAdLoadingDelegate, ATRewardedVideoDelegate>
@end

@implementation ATRewardVideoViewController

- (void)viewDidLoad {
    [super viewDidLoad];
    [self loadAd];
}

  - (void)loadAd {
    // Set extra, custom parameters, will be sent back in the agent's Extra, can be used to match the custom rules of the AD space;  
    // When the server incentive video callback is enabled, set this value and then send it back to the developer when the incentive is sent.
    NSDictionary *extra = @{
          kATAdLoadingExtraMediaExtraKey:@"media_val",
          kATAdLoadingExtraUserIDKey:@"rv_test_user_id",
          kATAdLoadingExtraRewardNameKey:@"reward_Name",
          kATAdLoadingExtraRewardAmountKey:@(3)
      };
    // load rewarded ads
    [[ATAdManager sharedManager] loadADWithPlacementID:@"your rv placementId" extra:extra delegate:self];
}

- (void)entryAdScenario {

    /* To collect scene arrival rate statistics, you can view related information https://docs.toponad.com/#/zh-cn/ios/NetworkAccess/scenario/scenario 
    Call the "Enter AD scene" method when an AD trigger condition is met, 
    such as: ** The scenario is a pop-up AD after the cleanup, 
    which is called at the end of the cleanup. 
    * 1、Call entryXXX to report the arrival of the scene. 
    * 2、Call xxRewardedVideoReadyForPlacementID. 
    * 3、Call showXX to show AD view. 
    * (Note the difference between auto and manual) */
    [[ATAdManager sharedManager] entryRewardedVideoScenarioWithPlacementID:@"your rv placement id" scene:@"your scenarioID"];
}

- (void)showRewardVideoAd {
    
    [self entryAdScenario];
    
     // Check if the AD is filled before display
    if ([[ATAdManager sharedManager] rewardedVideoReadyForPlacementID:@"your rv placementId"]) {
 
        [[ATAdManager sharedManager] showRewardedVideoWithPlacementID:@"your rv placementId" scene:@"your scenarioID" inViewController:self delegate:self];
    } else {
 
    }
}

#pragma mark - loading delegate
- (void)didStartLoadingADSourceWithPlacementID:(NSString *)placementID extra:(NSDictionary*)extra {
    NSLog(@"ADSource--AD--Start--ATRewardVideoViewController::didStartLoadingADSourceWithPlacementID:%@---extra:%@", placementID,extra);
}

- (void)didFinishLoadingADSourceWithPlacementID:(NSString *)placementID extra:(NSDictionary*)extra {
    NSLog(@"ADSource--AD--Finish--ATRewardVideoViewController::didFinishLoadingADSourceWithPlacementID:%@---extra:%@", placementID,extra);
}

- (void)didFailToLoadADSourceWithPlacementID:(NSString*)placementID extra:(NSDictionary*)extra error:(NSError*)error {
    NSLog(@"ADSource--AD--Fail--ATRewardVideoViewController::didFailToLoadADSourceWithPlacementID:%@---error:%@", placementID,error);
}

// bidding
- (void)didStartBiddingADSourceWithPlacementID:(NSString *)placementID extra:(NSDictionary*)extra {
    NSLog(@"ADSource--bid--Start--ATRewardVideoViewController::didStartBiddingADSourceWithPlacementID:%@---extra:%@", placementID,extra);
}

- (void)didFinishBiddingADSourceWithPlacementID:(NSString *)placementID extra:(NSDictionary*)extra {
    NSLog(@"ADSource--bid--Finish--ATRewardVideoViewController::didFinishBiddingADSourceWithPlacementID:%@--extra:%@", placementID,extra);
}

- (void)didFailBiddingADSourceWithPlacementID:(NSString*)placementID extra:(NSDictionary*)extra error:(NSError*)error {
    NSLog(@"ADSource--bid--Fail--ATRewardVideoViewController::didFailBiddingADSourceWithPlacementID:%@--error:%@", placementID,error);
}

-(void) didFinishLoadingADWithPlacementID:(NSString *)placementID {
    NSLog(@"ADSource--load--Finish--ATRewardedVideoViewController::didFinishLoadingADWithPlacementID:%@", placementID);
}

-(void) didFailToLoadADWithPlacementID:(NSString*)placementID error:(NSError*)error {
    NSLog(@"placementID--load--Fail--ATRewardedVideoViewController::didFailToLoadADWithPlacementID:%@ error:%@", placementID, error);
}

#pragma mark - showing delegate
-(void) rewardedVideoDidRewardSuccessForPlacemenID:(NSString *)placementID extra:(NSDictionary *)extra{
    NSLog(@"ATRewardedVideoViewController::rewardedVideoDidRewardSuccessForPlacemenID:%@ extra:%@",placementID,extra);
}

-(void) rewardedVideoDidStartPlayingForPlacementID:(NSString *)placementID extra:(NSDictionary *)extra {
    NSLog(@"ATRewardedVideoViewController::rewardedVideoDidStartPlayingForPlacementID:%@ extra:%@", placementID, extra);
    [self showLog:[NSString stringWithFormat:@"rewardedVideoDidStartPlaying:%@", placementID]];
}

-(void) rewardedVideoDidEndPlayingForPlacementID:(NSString*)placementID extra:(NSDictionary *)extra {
    NSLog(@"ATRewardedVideoViewController::rewardedVideoDidEndPlayingForPlacementID:%@ extra:%@", placementID, extra);
}

-(void) rewardedVideoDidFailToPlayForPlacementID:(NSString*)placementID error:(NSError*)error extra:(NSDictionary *)extra {
    NSLog(@"ATRewardedVideoViewController::rewardedVideoDidFailToPlayForPlacementID:%@ error:%@ extra:%@", placementID, error, extra);
}

-(void) rewardedVideoDidCloseForPlacementID:(NSString*)placementID rewarded:(BOOL)rewarded extra:(NSDictionary *)extra {
    NSLog(@"ATRewardedVideoViewController::rewardedVideoDidCloseForPlacementID:%@, rewarded:%@ extra:%@", placementID, rewarded ? @"yes" : @"no", extra);
}

-(void) rewardedVideoDidClickForPlacementID:(NSString*)placementID extra:(NSDictionary *)extra {
    NSLog(@"ATRewardedVideoViewController::rewardedVideoDidClickForPlacementID:%@ extra:%@", placementID, extra);
}

- (void)rewardedVideoDidDeepLinkOrJumpForPlacementID:(NSString *)placementID extra:(NSDictionary *)extra result:(BOOL)success {
    NSLog(@"ATRewardedVideoViewController:: rewardedVideoDidDeepLinkOrJumpForPlacementID:placementID:%@ with extra: %@, success:%@", placementID,extra, success ? @"YES" : @"NO");
}

// rewarded video again (only TT(CSJ) )
-(void) rewardedVideoAgainDidStartPlayingForPlacementID:(NSString*)placementID extra:(NSDictionary*)extra {
    NSLog(@"ATRewardedVideoViewController::rewardedVideoAgainDidStartPlayingForPlacementID:%@ extra:%@", placementID, extra);
}

-(void) rewardedVideoAgainDidEndPlayingForPlacementID:(NSString*)placementID extra:(NSDictionary*)extra {
    NSLog(@"ATRewardedVideoViewController::rewardedVideoAgainDidEndPlayingForPlacementID:%@ extra:%@", placementID, extra);
}

-(void) rewardedVideoAgainDidFailToPlayForPlacementID:(NSString*)placementID error:(NSError*)error extra:(NSDictionary*)extra {
    NSLog(@"ATRewardedVideoViewController::rewardedVideoAgainDidFailToPlayForPlacementID:%@ extra:%@", placementID, extra);
}

-(void) rewardedVideoAgainDidClickForPlacementID:(NSString*)placementID extra:(NSDictionary*)extra {
    NSLog(@"ATRewardedVideoViewController::rewardedVideoAgainDidClickForPlacementID:%@ extra:%@", placementID, extra);
}

-(void) rewardedVideoAgainDidRewardSuccessForPlacemenID:(NSString*)placementID extra:(NSDictionary*)extra {
    NSLog(@"ATRewardedVideoViewController::rewardedVideoAgainDidRewardSuccessForPlacemenID:%@ extra:%@", placementID, extra);
}

@end

Detailed rewarded video advertising please refer to the sample code: Demo ATRewardVideoViewController classes.