1. App Management

You can create and edit apps on the App page. Before officially adding apps, you must register a #TopOn developer account#.

On the app page, you can do the following: add and manage apps, placement, and scenario.

1.1 Add a new app

(1) Click [Add App] in the upper left corner to enter the Add App page. Please enter the information according to the following two situations.

① If your app is already available on Apple Store or Google Play, you can directly enter the app store link and click Search. The system will automatically obtain the app information and complete the input. You need to confirm the information again. If it is correct, click Confirm. Other Android stores do not support search matching.

② If your app is not available on the store, you need to manually enter the required items (app name, Sub-Category, Bundle ID/package name, Orientation, etc.) and confirm submission.

(2) If you need to add multiple apps, you can use the [Add App]-[Batch Add App] function.

1.2 View App Key

When integrating the TopOn SDK, you need to use the App Key provided by TopOn. You can obtain the App Key by following any of the following methods:

(1) Method 1 (recommended)

You can find the App Key of the App dimension in the Edit App page. This App Key can only be used in the corresponding TopOn app.

② Method 2

You can Find the App Key in [My Account]-[Key]. This App Key can be used in all apps under this account.

1.3 Associate Network

On the application page, you can click [Associate Network] in the network module, select the network you need to associate, and enter the corresponding parameters of the network to complete the association configuration.

If you need to change the network account or parameters later, you can click the corresponding network name in the network module to perform the editing operation.

1.4 App Data Preview

On the app management page, after selecting the corresponding app, yesterday's data of some indicators of the current app will be displayed: DAU, Est. Revenue, Est. ARPDAU, and impression / DAU. At the same time, the data fluctuation of yesterday compared with the day before yesterday will be displayed.

If you need to view more data, click [View More Metrics] to go to the full report.

2. placement management

You can create and edit placement on the [Application] page. You must create an app before creating a placement.

2.1 Introduction to Placement

The placement is the place where the ad is exposed in the app. For example, the Ad exposed at the bottom of the game page, or the Ad exposed at the end of the game level. Each placement corresponds to an ad type. Each app must have at least one placement, and most apps usually create multiple ad placements.

2.2 Add a placement

(1) Click [Add placement]-[Add placement] in the upper right corner to enter the Add placement page.

The adding steps are as follows:

① Select the app to which you want to add a placement.

② Customize the ad name.

③ Select the ad format. TopOn supports the following ad format: native ads,rewarded video ads,banner, interstitial ads,splash ads.

④ Select the status. The default is on. If you need to close this placement later, you can choose to pause it.

⑤ Notes. This column is optional.

⑥ When the selected ad format = Rewarded Video, you can choose whether to use the Server Side Callback. For detailed instructions, please see Rewarded Video Server Incentive.

(2) If you need to add multiple placement, you can use the [Batch Add Placement] function.

2.3 View ad placement data

Supports viewing data on placement dimension, and supports choosing which indicators to view.

3. Scenario

You can create and edit ad scenes on the [Application]- [Scenario] page. Before creating a scenario, you must first create a app and at least one placement

On the scenario page, you can do the following:

Add an scenario
View scenario data

3.1 Introduction to scenario

(1) View SDK loading and impression ad conversion data to increase revenue

By using the scenario function, you can view the SDK's ad loading and impression process data in the funnel report to determine whether the ad settings are reasonable, analyze the optimization space for each process conversion, and improve conversion and revenue

(2) Reduce ad space configuration costs

Developers usually use different placement to distinguish data from different ad scenarios, which can effectively distinguish impression and revenue data in each scenario, but at the same time it will increase operating costs (it is necessary to maintain ad source configurations for multiple placements).

The TopOn platform supports the creation of multiple ad scenarios under a placement, which can effectively distinguish impression and click data in different ad scenarios and reduce the cost of user configuration of placement.

3.2 Description of the ad scene access process

(1) The current placement corresponds to only one ad scene:

After adding the code for reaching the ad scene, TopOn will provide the following core indicators in the Full report and funnel report to provide more complete analysis data for your ad realization:

When the SDK reaches the ad scene, it calls the entryAdScenario() method of the TopOn SDK. The ad scene ID can be omitted and the data will be classified into the default ad scene.

(2) The current placement corresponds to multiple ad scenarios. You need to distinguish different ad scenarios to view impression and click data:

① Create an scenario in the TopOn backend and customize the scenario ID.

② Accurately add the scenario code to the App (call the entryAdScenario() method of the TopOn SDK and pass in the ID of each different scenario).

③ Pass in the scenarioId in the show method when displaying ads.

3.3 When to call the scenario

You can call the TopOn SDK in the App to add the scenario code according to different ad formats and the ad logic of your own App

● Rewarded Vide

Refer to the following example to call the method to reach the ad scene

APP type	Ad name	Ad path	Arrive ad scene call time
Game	Get rewards by watching Rewarded videos	Enter the game->Click on the entrance to obtain physical strength/currency->Pop up a pop-up window to watch ads to get rewards->Click the button to watch Rewarded videos	Pop up a pop-up window to watch ads to get rewards
App	Watch videos to clean up garbage	Enter the app->Enter the garbage cleaning function->Scan garbage->Click to clean up immediately->Pop-up window for watching ads to clean up garbage->Click the button to watch the Rewarded video	Pop-up window for watching ads to clean up garbage

● Interstitial (full screen/half screen)

Refer to the following example to call the method to reach the ad scene

APP type	Advertisement name	Advertisement path	Arrive advertisement scene call time
Game	Clear level interstitial	Enter the game->Enter the level->Clear level pop-up->Click to enter the next level/return to the level page button->Pop-up interstitial->Enter the next level/level page	Clear level pop-up
App	Clean up interstitial	Enter the app->Enter the cleanup function->Scan the garbage->Click to clean up now->Clean up animation->Pop up full screen interstitial->Clean up result page	Clean up animation
App	Switch page interstitial	Enter the app->Homepage->Click on other functions of the homepage tab->Reach other function page->Pop-up pop-up window interstitial	Reach other function page

● Native/Information Flow

Refer to the following example to call the method to reach the ad scene

APP type	Advertisement name	Advertisement path	Arrive at the time of calling the advertisement scene
Game/app	Sign in pop-up window native advertisement	Enter the game/app->Pop up the sign in pop-up window->Show the native advertisement below the sign in pop-up window	Pop-up sign-in pop-up window
App	Native ads on the page	Enter the app->Enter the function page/long list page->Native ads embedded in the page	Enter the function page/long list page

● Banner

Refer to the following example to call the method to reach the ad scene

APP type	Advertisement name	Advertisement path	Arrive ad scene call time
Game/app	Banner ads below pop-up windows	Enter the game/app->Pop-up message pop-up window/function pop-up window->Show banner ads below pop-up windows	Pop-up message pop-up window/function pop-up window
Games/apps	Fixed banner ads	Enter the game/app->Enter the level page/novel reading page, etc.->Display the fixed banner advertisement at the bottom of the page	Enter the level page/novel reading page, etc.

Whether the banner ad is preloaded or not, the ad scene can be called on the above page. If the banner ad refreshes automatically, the data entering the ad scene will be smaller than the display data.

● Splash

APP type	Advertisement name	Advertisement path	Arrive at the time of calling the advertisement scene
Game/app	Splash screen advertisement	Enter the game/app->Show the company logo page->Show the splash screen advertisement	Display the company logo page; if you enter the app directly without the logo page, you can call the ad scene when entering the game/app, or you can not call the ad scene

3.4 Create a scenario and obtain the ad scene ID

If you need to use multiple ad scenes to distinguish data, you can create a scenario in the background and obtain the ad scene

The specific steps are as follows:

(1) [Application]-Select the corresponding app-[Scenario].

(2) Click to add a scenario

① Each placement has a Default scene, with the default ad scene ID = 1. When calling the ad scene method, the ad scene ID is not uploaded and the data will be assigned to the default scene

② The ad scene ID can be customized (supported by TopOn SDK v6.2.48 and above) to facilitate developers to distinguish ad scenes when accessing. If the ad scene ID is not filled in, a scenario ID will be automatically generated

③ Rewarded video ads can add incentive information (rewarded name and rewarded amount) in the ad scene, and the incentive information will be called back to the developer. For details, please refer to iOS-Callback Information Description and Android-Callback Information Description

(3) View the scene list and obtain the advertising scene ID, providing it for development students to access and use.

3.5 Access code example for scenario

3.5.1 TopOn Android SDK Code Example

Ad Format	Sample Code
Rewarded video	View
Interstitial	View
Splash	View
Native	View
Banner	View

3.5.2 TopOn iOS SDK Code Example

Ad Format	Sample Code
Rewarded video	View
Interstitial	View
Splash	View
Native	View
Banner	View

3.5.3 Notes

(1) If the scenario ID passed in is incorrect or is not the scenario ID of the current placement, TopOn will count this part of the data into the Default scenario.

(2) If the scenario ID is not passed in the entryAdScenario() and Show() methods, TopOn will count this part of the data into the Default scenario.

(3) If the ID of a paused scenario is passed into the entryAdScenario() or Show() methods, TopOn will count the data into the Default default scenario.

(4) The ad scenarios supported by different versions of TopOn SDK are as follows:

TopOn SDK version	Ad formats that support ad scenarios
>=5.4.7	Rewarded video, Interstitial
>=5.7.9 (5.7.09)	Rewarded video, Interstitial, Native, Banner,Splash

Support TopOn background custom ad scene ID version:>= v6.2.48

3.6 View ad Scenario Data

3.6.1 ad Scenario Data Report

You can view the data of each scenario for a specific placement in Ad Scenario and Report.

3.6.2 Funnel Report

You can view the funnel analysis data of the app in the Funnel Report

4. Display & Request Cap Settings

On the [Application] - [Cap Settings] page, you can set the display and request caps at the application dimension, for different networks and different ad formats.

4.1 Display Cap Settings

(1) Application Dimension

When no restrictions are imposed on the network and ad format, the set display cap applies to all ads within the application.
①Impression Capping (Day): The maximum number of times a single user can view all ads within the application in one day.
②Impression Capping (Hour): The maximum number of times a single user can view all ads within the application in one hour.
③Impression Pacing (Sec.): The time interval between the display of the current ad and the display of any subsequent ad within the APP for a single user.

(2) Network Dimension

When only the network is restricted and no restrictions are placed on the ad format, the set display cap applies to all ads from the restricted network.
①Impression Capping (Day): The maximum number of times a single user can view all ads from this network in one day.
②Impression Capping (Hour): The maximum number of times a single user can view all ads from this network in one hour.
③Impression Pacing (Sec.): The time interval between the display of an ad from this network and the display of any subsequent ad from this network for a single user.

(3) Ad Format Dimension

When only the ad format is restricted and no restrictions are set on the network, the set display cap applies to all ads of the restricted ad format.
①Impression Capping (Day): The maximum number of times a single user can view all ads of this ad format in one day.
②Impression Capping (Hour): The maximum number of times a single user can view ads of this ad format in one hour.
③Impression Pacing (Sec.):The time interval between the display of an ad of this ad format and the display of any subsequent ad of this ad format for a single user.

(4) Network - Ad Format Dimension

When both the ad format and the network are restricted, the set display cap applies to ads of the corresponding ad format under the restricted network.
①Impression Capping (Day): The maximum number of times a single user can view ads of the corresponding ad format under the restricted network in one day.
②Impression Capping (Hour): The maximum number of times a single user can view ads of the corresponding ad format under the restricted network in one hour.
③Impression Pacing (Sec.):The time interval between the display of an ad of the corresponding ad format under this network and the display of any subsequent ad of the corresponding ad format under this network for a single user.

4.2 Request Cap Settings

This function limits the maximum number of ad requests that a single user can initiate within a certain period.

(1) Application Dimension

When no restrictions are imposed on the network and ad format, the set request cap applies to all ads within the APP.

(2) Network Dimension

When only the network is restricted and no restrictions are placed on the ad format, the set request cap applies to all ads from the restricted network.

(3) Ad Format Dimension

When only the ad format is restricted and no restrictions are set on the network, the set request cap applies to all ads of the restricted ad format.

(4) Network - Ad Format Dimension

When both the ad format and the network are restricted, the set request cap applies to ads of the corresponding ad format under the restricted network.

4.3 Reference Usage Scenarios

When other netwoks, such as AdMob , restrict the frequent display or click behavior of a single user, you can set the overall display cap control for the AdMob platform, as shown in the screenshot:

4.4 Notes

The upper limit for adding rules for each indicator is 10.
When display restrictions exist simultaneously at the application dimension, network dimension, ad format dimension, and ad source dimension, the minimum value shall be the limit upper - bound for the current device.
This function is available only when the SDK is upgraded to V6.4.50 or above.

5. Copy placements and waterfall configuration

5.1 Usage scenario:

Developers have multiple apps, and the placements, segments and waterfall flow configurations of some apps are basically the same. When creating a new app, you can directly copy the placements, segments and waterfall flow configurations of existing apps (that is, app B can directly copy part of the waterfall flow configuration of app A). It is recommended to use the automatic creation of ad sources function at the same time to greatly improve efficiency.

5.2 How to operate:

(1) Copy the placement entrance

On the app page, select the app to which you want to add placements, and click Copy placement Function Entrance

(2) Select placements and segments

Select the app you want to copy from. After selecting, all placements and segments under the current app will be displayed. You can check the group you want to copy. You can modify the placement name at this time. Click Continue to create the placement and segment immediately.

Notes:

When the default group copy is not checked, a default group will be automatically created in the newly created placement.
If the current placement has an ongoing AB test, you can only select the segment under a single test group, and you cannot select a segment across test groups.
Among the currently checked placements, placements without waterfall flow configuration or placements that do not support batch adding of ad sources will directly copy the placements and segments.

(3) Fill in the network and ad source information

After clicking Continue to add placements and segments in the first step, all the contents of the placements, ad scenarios, ad source information, and segment advanced settings will be copied to the new app. The copy function only copies the configuration information, and does not copy the network app ID, ad source ID and other information. This information needs to be manually added in the second step of the copy function, or the automatic creation function can be turned on to automatically create a new ad source.

① network information

If the new app is not associated with an network, you need to associate it with the network first and fill in the app ID and other information. The network that has been associated will display the ad source that needs to be filled in (at this time, the type of ad source, sorting price and other configurations are all copied content, which can be modified directly if necessary).

If the current app does not need to be associated with a certain network, you can directly click the [Not Associate] button, and the ad source under this network will not be displayed.

② Additional ad source information

After the network has been associated, the selected segment and corresponding ad source information will be displayed. You only need to supplement the ad source ID (i.e. the third-party ad position ID) and other information. If the associated network supports automatic creation, the automatic creation of ad sources function will be enabled by default, and you do not need to fill in the ad source ID.

After completing all the information, click Submit, and the ad source and configuration information will be automatically added under the current placement. If you have selected multiple placements, you will be returned to the app interface after submitting all placement information in sequence.

6. FAQ

6.1 App Creation Problems

(1) Do you comply with US COPPA/California CCPA?

You can select based on the actual user distribution of your app.

Region	Content
US COPPA	is the abbreviation of the Children's Online Privacy Protection Act of the United States. If your app's users include children under the age of 13 in the United States, please select “Yes”
California CCPA	is the abbreviation of the California Consumer Privacy Act. If your app has users in California, U.S., please select "Yes"

(2) Do apps for Mainland China and non-Mainland China need to be packaged separately?

System	Content
Android	①When integrating Android projects, apps for Mainland China and non-Mainland China need to be packaged separately. ②If the domestic SDK version is integrated and published on Google Play, it will be removed from Google Play. ③On the SDK download page in the TopOn backend, the app publishing region option is already provided. You can select "domestic" or "overseas" to download and select the corresponding SDK version.
iOS	①When integrating iOS projects, there is no need to integrate separately for Mainland China and non-Mainland China. ②Note: Starting from TopOn SDK iOS v5.7.45, TopOn SDK provides separate downloads of Pangolin domestic and overseas SDKs. If you want to use Pangolin SDK for monetization both in China and overseas, you need to integrate separately.

(3) Can I create an app if it is not listed on AppStore/Google Play?

Yes. Select "No" at AppStore/Google Play, and then fill in the required information according to the instructions. If the app is subsequently listed on AppStore or Google Play, it is recommended to return here to modify the status.

(4) If the app is not available in the store, can I integrate the topon SDK and test it first?

Yes. If the app is not available in the store and parameters cannot be created on each network, you can use TopOn's test mode or use the demo ID provided by TopOn for integration testing, and then configure the parameters on each network in the TopOn backend after creating them. >>TopOn SDK Test Guide

(5) How to obtain TopOn’s app ID (App ID)

Path: TopOn Backstage →[Application] →App ID

6.2 placements and ad scenarios

(1) How to obtain TopOn’s placement ID

Path: TopOn Backstage →[Application] →Placement ID

(2) How to obtain TopOn’s scenario ID

Path: TopOn Backstage →[Application] →[Scenario]→Scenario ID

(3) What should I do if I accidentally delete an app/placement/scenario?

Developers are not supported to directly restore deleted apps/ad placements/ad scenarios in the TopOn backstage. If necessary, please contact the TopOn business operation team.

(4) Can TopOn block ad content?

TopOn does not support blocking ad content from third-party ad platforms. If you need to block a specific ad, you need to set it up in the backstage of each third-party network. If you use TopOn ADX, please contact the TopOn business operation team for material review and blocking.

(5) What is the incentive amount?

The TopOn backend supports setting the rewarded amount, which is returned through reward_amount. Developers can issue rewards based on the value returned in the backend, or they can issue rewards based on their own rules.

(6) The difference between placements and ad scenes

① One placement on TopOn corresponds to one waterfall flow, which corresponds to a set of code slot IDs of a third-party network, and can accurately distinguish the actual revenue of each placement.

② One placement on TopOn can correspond to multiple ad scenes, and multiple ad scenes under one placement share one waterfall flow.

③ The actual revenue of each placement can be accurately distinguished, but the actual revenue of each ad scene cannot be accurately distinguished.

(7) Applicable scenarios and advantages of ad scenarios

① Applicable scenarios of ad scenarios: There are many ad scenarios within an app. If different ad scenarios use different placement IDs and different waterfall flow strategies, it will result in high operating costs and low efficiency. In this case, it is recommended to use the scenario function of TopOn.

eg: There are three Rewarded video ad entrances in a game, namely sign-in incentive, resurrection incentive, and free props incentive. The three ad entrances can share the same TopOn placement ID and use a set of waterfall flow strategies, but at the same time, it is hoped that the data performance of each ad entrance can be distinguished. In this case, the scenario function can be used to distinguish them. Create three scenario IDs (as shown below) and integrate them according to the instructions in the help document to distinguish the data of different ad scenarios. >>How to use the scenario function?

② Advantages of the ad scene function:

All ad platforms generally recommend that a single code position (a single ad source of TopOn) should have a daily display of more than 5K to reach the machine learning threshold, and ecpm is relatively stable, and there is a greater chance of allocating higher-quality ads;
Loading all ad positions together may put pressure on user devices. At the same time, if some ad positions with deeper entrances request ads but have few display opportunities and low display rates, the weight of the ad position may also be reduced, and ecpm will decrease;
Reduce operating costs. The ad scene function only needs to operate one ad position, and there is no need to manage multiple waterfall flows.

Platform Guide