Fully automatic loading

1. Introduction to fully automatic loading of rewarded video ads

Fully automatic loading mode is a one-stop request maintenance solution launched by TopOn, which can be based on user usage Status and advertisement consumption progress, multi-node intelligently determines the preloading and caching timing of the next advertisement. On the basis of satisfying the developer's operation strategy, it avoids the risk of failure in real-time loading of advertising data and wasted display opportunities, and alleviates users' negative emotions caused by ads not loading or loading not smoothly. Through fully automatic loading of solutions, developers can avoid repeated and cumbersome manual intervention request solutions, and efficiency improvements are immediate. SDK begins to support fully automatic loading mode.

1.1 Integration recommendations

1. Call ATRewardVideoAutoAd. init (mainActivity, placementIds, listener) in the main Activity onCreat() and pass it to the main Activity for initialization. If you need to add fully automatic ad loading in the future, please call addPlacementId (placementId) to add it
2. It is recommended to call < after entering a scene where ads can be displayed. strong>entryAdScenario(placementId,scenarioId)Stats the cache status of the current advertising space. For specific statistical instructions, you can view the data of advertising scenarios to distinguish different business scenarios
3. Display ads: Determine whether isAdReady(placementId) is ready before displaying, and then call          show(activity,placement,listener) when ready. strong>Perform ad display
4. Server callback: If you need to support server callback (S2S), pass in userId, extraData strong>Please set it at the following timing: Note:

        (1) Fully automatic stimulation The video implements automatic loading logic internally, so please avoid performing ad display directly in the onRewardVideoAutoLoaded callback

        (2) If the ad slot is set to fully automatic loading, do not call ATRewardVideoAd (ordinary rewarded video) .load() to load the ad

1.2 Notes:

   1. onReward() will be called back when the incentive video is issued. Developers can < strong>onRewardDistribute incentives to users during callbacks

   2. Fully automatic loading of incentive videos supports the incentive delivery mechanism of server callback (S2S), and also supports various advertising platforms. For the server callback function, please refer to the Incentive Video Server Incentive (S2S) Instructions

2.API Instructions

2.1 Advertising Initialization

ATRewardVideoAutoAd: Fully automatic loading of rewarded video ads Management class

Initialization:

public class MainActivity extends Activity {
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        //It is recommended to pass in the activity for initialization when creating the main activity onCreate
        ATRewardVideoAutoAd.init(MainActivity.this, new String[]{"your rv placementID1", "your rv placementID2"},autoLoadListener);
    }
}

2.2 Local parameters

ATAdConst.KEY: LocalExtra local parameter predefined Key value

Server callback:

//Set server callback localExtra information
private static void setPlacementIdLocalExtra(String placementId) {
    String userid = "test_userid_001";
    String userdata = "test_userdata_001_" + placementId + "_" + System.currentTimeMillis();
    Map<String, Object> localMap = new HashMap<>();
    localMap.put(ATAdConst.KEY.USER_ID, userid);
    localMap.put(ATAdConst.KEY.USER_CUSTOM_DATA, userdata);
    //Effective from the next ad loading
    ATRewardVideoAutoAd.setLocalExtra(placementId, localMap);
}

//Setting timing 1: Before initialization or adding advertising space
setPlacementIdLocalExtra("your rv placementID1");//Before initialization, set localExtra for the specified advertising space
ATRewardVideoAutoAd.init(this, new String[]{"your rv placementID1", "your rv placementID2"}, autoLoadListener);
//ATRewardVideoAutoAd.addPlacementId("placementId1");

//Set timing 2: After filling the advertisement
private static ATRewardVideoAutoLoadListener autoLoadListener = new ATRewardVideoAutoLoadListener() {
    @Override
    public void onRewardVideoAutoLoaded(String placementId) {
        //If you need to update localExtra, set it here and it will take effect from the next load
        setPlacementIdLocalExtra(placementId);
    }

    @Override
    public void onRewardVideoAutoLoadFail(String placementId, AdError adError) {
    }
};

2.3 Advertisement display

ATRewardVideoAutoAd:

Ad display:

        /*
     In order to calculate the scene arrival rate, relevant information can be consulted“ https://docs.toponad.com/#/zh -CN/android/NetworkAccess/scenario/scenario“

Call the "Enter Advertising Scene" method when the advertising triggering conditions are met, for example:

**If an advertisement pops up after the cleaning is completed, it will be called at the end of the cleaning;

*1. First call "entryAdScenario"

*2. Can calling "isAdReady" display

*3. Finally, call "show" to display

*4. Scenario ID is passed in to the backend scene management for data display
     */
 ATRewardVideoAd.entryAdScenario("your rv placementID", "your scenarioID");
//Need to determine if the advertising space is ready
if(ATRewardVideoAutoAd.isAdReady("your rv placementID")){
    ATRewardVideoAutoAd.show(activity, "your rv placementID", "your scenarioID"，autoEventListener);
}

2.4 Ad object

ATRewardVideoAutoAd:

ATAdStatusInfo: Status object of the advertising slot

2.5 Advertising Monitoring

ATRewardVideoAutoLoadListener: Loading event callback monitoring of ATRewardVideoAutoAd advertisement:

Listening example:

private static ATRewardVideoAutoLoadListener autoLoadListener = new ATRewardVideoAutoLoadListener() {
    @Override
    public void onRewardVideoAutoLoaded(String placementId) {
     
    }

    @Override
    public void onRewardVideoAutoLoadFail(String placementId, AdError adError) {
    }
}; 

ATRewardVideoAutoEventListener: ATRewardVideoAutoAd advertisement Event callback monitoring:

3. Sample code

//Set server callback localExtra information
private static void setPlacementIdLocalExtra(String placementId) {
    String userid = "test_userid_001";
    String userdata = "test_userdata_001_" + placementId + "_" + System.currentTimeMillis();
    Map<String, Object> localMap = new HashMap<>();
    localMap.put(ATAdConst.KEY.USER_ID, userid);
    localMap.put(ATAdConst.KEY.USER_CUSTOM_DATA, userdata);
    //Effective from the next ad loading
    ATRewardVideoAutoAd.setLocalExtra(placementId, localMap);
}

//Setting timing 1: Before initialization or adding advertising space
setPlacementIdLocalExtra("your rv placementID1");//Before initialization, set localExtra for the specified advertising space
ATRewardVideoAutoAd.init(this, new String[]{"your rv placementID1", "your rv placementID2"}, autoLoadListener);
//ATRewardVideoAutoAd.addPlacementId("placementId1");

//Set timing 2: After filling the advertisement
private static ATRewardVideoAutoLoadListener autoLoadListener = new ATRewardVideoAutoLoadListener() {
    @Override
    public void onRewardVideoAutoLoaded(String placementId) {
        //If you need to update localExtra, set it here and it will take effect from the next load
        setPlacementIdLocalExtra(placementId);
    }

    @Override
    public void onRewardVideoAutoLoadFail(String placementId, AdError adError) {
    }
};
    /*
     In order to calculate the scene arrival rate, relevant information can be consulted“ https://docs.toponad.com/#/zh -CN/android/NetworkAccess/scenario/scenario“

Call the "Enter Advertising Scene" method when the advertising triggering conditions are met, for example:

**If an advertisement pops up after the cleaning is completed, it will be called at the end of the cleaning;

*1. First call "entryAdScenario"

*2. Can calling "isAdReady" display

*3. Finally, call "show" to display

*4. Scenario ID is passed in to the backend scene management for data display
     */
 ATRewardVideoAd.entryAdScenario("your rv placementID1", "your scenarioID");
//Need to determine if the advertising space is ready
if(ATRewardVideoAutoAd.isAdReady("your rv placementID1")){
    ATRewardVideoAutoAd.show(activity, "your rv placementID1", "your scenarioID"，autoEventListener);
}

For detailed rewarded video ad sample code, please refer to:Demo'sRewardVideoAdActivityClass