1. Integration questions and self-test guidelines
1.1 Integration Guide
Please refer to the instructions of the integration document to complete the introduction configuration and API call of the SDK. If you have any questions about the integration document, please refer to TopOn Integration Tool for external demos, it is recommended to select the latest version of the SDK when integrating.
1.2 Testing Guide
To facilitate testing ads and troubleshooting related issues, please refer to How to test ads. It is recommended to open the SDK log , and troubleshoot related problems through logs.
1.3 Check the SDK version
- TopOn SDK version number: callable [[ATAPI sharedInstance] version];
1.4 View ads Platform SDK log
Call this method before SDK initialization: [ATAPI setLogEnabled:YES]; To view it in Xcode, please refer to TopOn SDK log Open SDK log
1.5 common error codes
To facilitate troubleshooting, the SDK provides common error codes and error descriptions. Please refer to Error code and Third-party ads error codes to troubleshoot and confirm the problem.
2. Guidelines for solving common classification problems
2.1 Compilation errors and listing issues
2.2 Advertisement Filling failure or no ads can be displayed
3. SDK related background configuration Frequently Asked Questions
3.1 configuration does not take effect (backend configuration, testing Mode, traffic grouping)
1. The background configuration change does not take effect?
- The background configuration will take effect within a few seconds to a few minutes, but the SDK will be cached locally for half an hour. If you need to test it immediately, please Clearing application data, reinstalling, or setting the time back one hour
- If clearing application data, reinstalling, etc. still does not take effect, it may be that the background configuration has not yet taken effect. , please wait a few more minutes, clear the application data or reinstall and try again
2. The test mode does not take effect ?
- Please check whether the device ID configured in the TopOn background is correct, IDFA and IDFV need to be obtained from the log of our SDK
- Refer to the first point above
3. Traffic grouping does not take effect?
- Refer to the first point
- If customization is configured For rules, please check whether the custom rules have been correctly passed into the code. You can print out the key and value in the code for troubleshooting
- If the device is configured id, please check whether the device id configured in the TopOn background is correct. IDFA and IDFV need to be obtained from the log of our SDK
3.2 Parallel requests Number, automatic request advertising function (TopOn background advertising slot - advanced settings)
- Number of parallel requests: When ads are frequently displayed, after playing When the next advertisement needs to be played immediately, the number of parallel requests can be adjusted appropriately, generally 2 to 3. Too many parallel requests will consume bandwidth and affect user experience. When displaying ads, cached ads will be displayed first based on the order of ad sources.
- Automatically request ads: After closing the ad, TopOn SDK will automatically call the load method for this ad slot. The loading result will not be called back to the outside, and the loading will fail. There will be no retries. It is recommended that developers implement this logic themselves. Developers who have not implemented this logic can turn on this function.
3.3 For certain users, devices, regions, etc. Post different advertising sources
3.4 Handle the situation that background music is interrupted caused by the integrated AD
You can call the API of the AD platform before displaying the AD to ensure that the background music will not be interrupted when playing the AD, the code is as follows:
#import <GDTMobSDK/GDTSDKConfig.h>
[GDTSDKConfig enableDefaultAudioSessionSetting:YES];