Ad Source

1. Configure the ad source

1.1 How to configure the ad source

(1) Select the app and placement

The configured Network ID must be consistent with the selected placement style (if the rewarded video ad format is selected, the configured Network ID is also rewarded video)

 

(2) Click [Add Ad Source]- [Add Ad Source]

Select the corresponding Network and fill in the parameters as required

① If it is a newly added net, you need to fill in the Network parameters first.

You can learn about the path to obtain the report API parameters through the "How to find these parameters?" instructions in the screenshot.

aThe report API is only used to pull the report data of the Network (such as the revenue API, etc.). If you cannot apply for the report API temporarily, you can select "Not activated" first and activate it later when needed.  

② Fill in the code position parameters of the Network

Configuration items	Description
User name	To switch the Network account, please go to the advertising source management page to modify it. (Path: Network page → AD Source Setting→ Select the application to be modified → “Edit” in the upper right corner.) >>Network page description
Ad source parameters	You can learn about the path to obtain ad source parameters through the “How to find these parameters? ” guide in the screenshot. The names and contents of the parameters that need to be filled in for different Networks are different. Just fill them in as required. >>Network Configuration Guide
Price	This price is only used for priority sorting during ad requests: for example, if ABCDE 5 layers of ad sources are added, these 5 layers of ad sources need to be sorted. This sorting will be sorted from high to low according to the filled-in price, and will not affect ad filling. It is recommended that this price be as consistent as possible with the actual eCPM (i.e. eCPM API) value of the ad source, which can be used to estimate the real-time revenue and LTV of the day. Note: If the sorting prices of multiple ad sources are the same, the priority defaults to the same, and a random priority request is made each time; the display probability of ad sources with the same price can be set. Tips for filling in the sorting price: First, distinguish whether the account has the reserve price permission of the Network (generally, the Network has a turnover requirement for opening the reserve price permission. It is recommended to contact the AM of the networks to confirm whether it has the reserve price permission or open the reserve price permission). ① If you have the reserve price permission, fill it in according to the reserve price set on the networks. ② If you do not have the reserve price permission, you can configure it according to the developer's own wishes, because the sorting price in the TopOn background will only affect the order of TopOn SDK in making ad requests and displays. For example, when CJS Ad Source A does not have the reserve price permission, no matter whether the sorting price is set to 1 or 100, as long as its ranking is the highest among all other ad sources, CJS Ad Source A will be requested first. At this time, no matter what price the CJS platform returns, even if the platform returns an ad with a price of 0.01, CJS Ad Source A will be displayed first when the actual ad is displayed. This is because the sorting price set in the TopOn background only affects the priority of request and display. If the developer wants CJS to be displayed first and Youlianghui to be displayed second, they only need to set CJS's ranking price to be greater than Youlianghui, such as setting CJS's ranking price = 2 and Youlianghui's ranking price = 1.
Auto price (optional)	After turning it on, TopOn will calculate the ranking price based on the average eCPM of the past 7 days. Note: Automatic price is only applicable to Networks that have opened the report API; it will take effect after the cumulative display volume of the advertising source reaches 2,000 times, otherwise the manually filled ranking price will prevail. How to determine whether automatic price needs to be turned on: Developers can decide whether to use this function. ① For ad sources that have set a floor price in the network backend, even if the automatic price is not turned on, generally speaking, eCPM API = ranking price (this configuration is recommended) = the floor price eCPM set by the Network, so whether it is turned on or not has little impact. ② For developers who do not have the network floor price permission but have the Network API permission, they can turn on the automatic price to obtain the eCPM API of the ad source, so that TopOn SDK is more in line with the actual eCPM price of the ad when requesting and displaying the ad, and maximizes the display of high eCPM ads.
More Config (optional)	①Capping (Hour): The maximum number of times a single user can view ads from this ad source within 1 hour; ②Capping (Day): The maximum number of times a single user can view ads from this ad source within 1 day; ③Pacing (Sec.): The time interval between the current display of this ad source and the next request for this ad source by a single user Note: Display frequency control is a local setting. If uninstalled and reinstalled, the limit is recalculated; the video display interval is the time interval between the start of video playback and the next request

 

1.2 Frequently Asked Questions

(1) What should I do if there is no report API?

The report API is only used to pull the report data (such as revenue, etc.) of the Network. It does not affect the normal display of ads and use of the application. If you are temporarily unable to apply for the report API, you can select "Not activated" first and activate it later when needed.

Some domestic Networks have certain thresholds for applying for the report API (such as CJS, Youlianghui, Baidu, Kuaishou). If you are temporarily unable to apply for the report API, you can temporarily upload it manually. (Path: TopOn Developer Backstage →Advanced Features→Upload Network Report.)  

(2) In what cases is it recommended to use automatic pricing?

① Since automatic pricing is based on the average eCPM of the previous 7 days, there is a large delay. Therefore, if conditions permit, it is generally not recommended for developers to turn on automatic pricing and choose to adjust manually. However, if your energy is limited and the eCPM of the ad source is relatively stable, you can choose to turn on automatic pricing.

② The bottom few layers of the waterfall

③ The ad source can turn on automatic pricing, because the bottom ad source has a low adjustment frequency and is not valuable, so you can turn on automatic pricing and let it sort by itself.

(3) In what cases is it recommended to use display frequency control (display cap/interval)?

Scenario ①: When some Networks cannot set a floor price, the quality of single-user display can be improved by controlling the display frequency, thereby indirectly improving eCPM.

Scenario ②: If Facebook and admob are integrated, it is recommended to set a display frequency cap at the initial launch of the app, otherwise the Network account may be blocked due to individual extreme devices. (Path: TopOn Developer Backstage ——[Mediation] —— [Add Ad Source]- [Add Ad Source] ——Edit ——[More Config] ——Capping)

 

2. Ad Source Priority Adjustment

After the product is launched, it is necessary to adjust the ad source priority based on data performance to further improve ad monetization revenue.

2.1 How to adjust the priority

(1) Manually adjust by adjusting the sorting price or dragging the ad source; waterfall sorts by price from high to low.

(2) Automatic sorting is achieved by turning on the automatic price system; TopOn will automatically calculate the eCPM and adjust the sorting based on the historical 7-day data; it should be noted that the automatic price will only take effect when the cumulative display volume of the ad source is greater than or equal to 2000. Automatic price can be turned on when editing an ad source.

 

2.2 Configuration of priority display probability for ad sources with the same price

(1) What is the priority display probability for ad sources with the same price?

• The percentage to the right of the ad source priority is the priority display probability for ads with the same price. You can adjust the priority display probability by setting the priority display weight of the ad source. 
• To use the priority display probability for ad sources with the same price, you need to update TopOn SDK v5.7.61 and above. 
• You can set the priority display probability for each ad source with the same price independently. When multiple ad sources with the same price are filled with ads, TopOn will select the ad source for this display according to the priority display probability you set.

 

(2) How to configure the priority display probability for ad sources with the same price?

① In the Mediation list, the priority of the same price advertising source will appear on the right side of the priority display probability, as shown in the following figure:

② Developers can set the priority display weight of advertising sources with the same price through the editing entrance on the right side of the AD Source Priority.

③ TopOn will automatically calculate the priority display probability of the same-price ad sources according to the weights you set

Suggestions: If developers want to adjust the display probability more intuitively, it is recommended that developers allocate the weights of each ad source based on the sum of the weights of all ad sources of the same price being 100

 

3. Bottom Ad

3.1 What are bottom ad

The bottom ad on the TopOn side are TopOn's revenue-enhancing solutions for specific advertising scenarios. It is recommended to use the networks's non-bottom-price placements to configure bottom ad. The bottom-line ad source can be used as an effective revenue supplement solution to solve the problem of low fill rate in some advertising scenarios, guarantee the revenue of applications and placements, streamline ad source configuration and operation plan, and reduce operation and maintenance costs.

 

3.2 How to use bottom ad

TopOn already supports bottom ad. When creating an ad source for the corresponding ad slot, just turn on "bottom ad" in the configuration interface.

Path 1: TopOn Backstage → [Mediation] → [Add Ad Source]→[Add Ad Source]→ Bottom Ad

Path 2: TopOn Backstage → [Network]→[Monetization] → [AD Source Setting] → [Add Ad Source] → Bottom Ad

 

3.3 Ad request and display logic of fallback ads

• Ad request: After the waterfall request is initiated, the fallback will be initiated in parallel with Waterfall. If there are multiple fallback ad sources, the fallback ad sources will be requested serially in the specified order. The bottom ad can make full use of network resources to request and load ads through the staggered parallel strategy, shorten the time it takes to fill ads, and thus reduce the time users have to wait for ads to load, thus improving the user experience.
• Ad display:When the waterfall request is not filled, TopOn will use the bottom ad to display. When the waterfall request is filled, TopOn will display it at a high price.

PS:

• Note that the bottom ad here are different from the common waterfall [bottom ad]. The waterfall [bottom ad] in the usual sense are: set ads with no bottom price or ads with a lower price, and configure them at the bottom of the waterfall as the bottom of the waterfall to ensure the overall traffic fill rate of the ad slot. For example: create a Mintegral ad and set the bottom price of the ad slot to RMB 0.1, and configure it in TopOn Mediation accordingly.
• Setting the bottom-line ad source on the TopOn side can improve the overall fill rate of the ad slot. The reason is that, similar to increasing the number of ad sources requested in parallel, the probability of getting ad fills increases. When displaying ads, the probability of having ad fills provided for display increases. However, for a single user or a single device, there may still be no ad fills. This is because the Networks have different assessments of the value of user traffic. When matching ads, the Networks will decide whether to fill ads for a single user based on their own user portraits and budgets. It does not mean that after setting up a fallback ad, users will 100% get ad fills and displays.
• TopOn SDK v5.7.94 and above versions begin to support fallback ads.

 

3.4 Optimization solution for the first installation of the opening screen advertisement TopOn

(1) Create a traffic group of the SDK preset strategy on the opening screen advertisement position

(2) Configure the waterfall flow in the SDK preset strategy. It is also recommended that you add a bottom-line advertisement source

(3) Export the SDK preset strategy and preset it in the application

For the specific operation process, please refer to Android 《SDK Preset Strategy Instructions》 and iOS 《SDK Preset Strategy Usage Instructions》

The effect of this configuration: You can implement the SDK preset opening screen strategy and realize the bottom-up function of the opening screen bottom-up ad source. That is: this bottom-up ad source will initiate a request in parallel with the overall waterfall flow under the ad slot. And the user will not necessarily use the bottom-up ad in the first request, but will normally use the waterfall flow and the parallel request of the bottom-up ad source. It can maximize the monetization value.

This solution is applicable to all ad types and is supported by TopOn SDK>= v6.1.78.

 

4. Auto Create Ad Source

The general process for developers to configure ad sources is: after creating placements in the network ad backend, create and fill in parameter information in the TopOn backend. The process is relatively complicated and prone to errors. To facilitate developers to quickly configure ad sources, TopOn provides the function of automatically creating ad sources.

After turning on this function, when you create an ad source in the TopOn backend, TopOn will automatically apply to create placements in the network ad backend and fill in the relevant parameter information to TopOn. You do not need to manually create it in the network ad backend.

 

4.1 Supported Network and ad Ad Format

Currently, the following Networks are supported for automatic creation, and more networks are under development.

Network name	Ad bidding type	Ad Format
Mintegral	Floor price, Bidding, etc.	All ad format
Tencent Ads	Target price, Bidding, etc.	All ad format
CSJ	Only supports floor price	All ad format
Kuaishou	Target price, Bidding, etc.	All ad format
Baidu	Target price, Bidding, etc.	Rewarded Video, Interstitial, Native (corresponding to Baidu Feed, Vertical Video), Splash Screen
Meta	Bidding	Banner, Interstitial, Native, Native banner, Rewarded video
Pangle	Floor price, Bidding, etc.	All ad format
Admob	Bidding	Rewarded Video, Interstitial, Native, Banner
Liftoff (Vungle)	CPM, Bidding and other types	Interstitial ads, rewarded ads, Banner, MREC, native ads
Bigo	CPM, Bidding and other types	Rewarded video, interstitial, banner, native, splash
Unity	Target price	Rewarded video, interstitial, banner
Digital Turbine	Target price	Rewarded、Interstitial、Banner
Yandex	CPM、Biddingand other types	Banner, Interstitial, Native, banner, Rewarded video（Rewarded ads、Interstitial advertising、The banner、Native advertising、Advertising at the opening）
inmobi	eCPM Floor、Bidding and other types	Interstitial、Banner、Rewarded、Native

 

4.2 How to use automatic ad source creation

Fill in the relevant parameters and authorize on the Topon platform to use this function.

(1) On Topon - Network - Monetization Platform, add or edit your Mintegral/Tencent/Pangle/Kuaishou ad account.

(2) Follow the prompts to complete the relevant parameters. For detailed configuration, please refer to 4.4 Configuration and Usage Guide for Each Platform.

 

4.3 Default Setting Parameters for Each Ad Format

● CJS

 

● Kuaishou

 

● Meta

 

4.4 How to configure and use on each platform

● Mintegral

(1) After activating the report API access, select Yes in the auto-create ad source section and input the secret key to complete the authorization.

(2) If there is an error message while adding the ad source automatically, please check if your Mintegral account has the permission to create media & ad units.

(3) If you have permission but still encounter errors, it is recommended to modify the aggregation platform to TopOn in the Mintegral backend for this App.

 

● Tencent Ads

(1) After activating the report API access, choose Yes for auto-creating ad sources, save after entering Account ID and Secret Key, which will automatically verify whether the current account has permissions to create ad placements.

(2) When creating a new ad position in the waterfall, if you have completed the above steps, you will see the option for automatic creation of ad sources, choose Yes, you can create bidding or non-bidding ad sources, enter related information to complete creation.

 

● CJS

(1) After activating the report API permission, you need to select the corresponding currency according to the currency of the current CJS backend account. Currently, only RMB/USD options are provided. At the same time, select Yes in the Automatically Create Ad Source field and fill in the key to complete the authorization. You need to activate the Code Management API permission of the CJS backend account to use this function. Otherwise, an error will be reported when using the Automatically Create Ad Source function. Please contact the CJS docking colleague to activate it.

The code position of the CJS backend account manages the API permission location:

(2) When creating a new ad position in the waterfall, if you have completed the above steps, you will see the option for automatic creation of ad sources, choose Yes, Pangle supports creating floor price ads, fill in the code bit setting floor price in the floor price setting place, and enter the related information to complete the creation. Please fully understand the following notes.

Notes:

• You need to contact CJS to open the reserve price setting permission (not Gromore reserve price setting permission) before you can set the reserve price on TopOn. Otherwise, you can only create an ad source without reserve price (that is, the reserve price setting = 0)
• The price unit for setting the floor price is displayed according to the currency set by the Network. Please make sure that the currency is correct. When creating an ad source, the filled-in price will be used to create it in the CJS backend. Wrong currency will cause the TopOn display price to be different from the CJS backend price. For ease of use, when the CJS backend currency is different from the TopOn backend currency, a real-time exchange rate conversion display is provided.

※ You can confirm whether you have the permission to set the floor price in the CJS backend: Ad Monetization -> Traffic -> Code Bit -> Create New Ad Position (Choose any ad type) -> Look at the screenshot ①Is it used for Gromore=No ②Expected CPM=Set the expected CPM and can set the price

 

● Kuaishou

(1) When editing the Network, it is necessary to select "Yes" for automatically creating an ad source. Fill in the Account ID, AccessKey, and SecurityKey. You must activate the code bit management API permission in the Kuaishou backend account to use this function. Otherwise, using the automatic ad source creation feature will result in an error. Please contact your colleague interfacing with Kuaishou to activate it.

(2) When creating a new ad slot in the waterfall feed, if you have completed the above steps, you can see the option for automatically creating an ad source. Select "Yes." Kuaishou supports the creation of floor price ads, fill in the floor price in the floor price setting area according to the code bit set floor price, and enter the related information to complete the creation.

 

● Baidu

(1) When editing a Network, you need to select Yes for Automatically Create Advertising Source and fill in AccessKey. You need to configure the public key of TopOn backend to Baidu backend or use your own private key.

You need to enable the media management API permission of the Baidu backend account to use this function. Otherwise, you will not be able to obtain AccessKey and fill in the public key. Please contact your Baidu counterpart to enable it. For details, see: Open Baidu Baidu Alliance's Report API

Baidu backend public key configuration example:

 

● Meta

(1) When editing a Network, you need to select Yes for Automatically Create Advertising Sources, perform Oauth authentication and authorization, log in to your Meta account, and follow the authorization process to grant permissions for Manage Business, Access App Effectiveness Analysis, and Manage Network Settings before you can use the Automatic Creation function.

(2) When creating a new ad slot in the waterfall flow, if you have completed the above steps, you will see the option to automatically create an ad source. Select Yes. Meta only supports the creation of bidding ads. If the current APP is not bound to the Meta application, you need to fill in the application number before using the automatic creation function.

 

● Pangle

(1) When editing a Network, select Yes for Automatically Create Ad Source and fill in the User ID, Role ID and Security Key. You need to apply to Pangle for the Pangle Management API permission to use it.

(2) Pangle background Pangle Management API permission example:

(3) When creating a new ad slot in the waterfall flow, if you have completed the above steps, you will see the option to automatically create an ad source. Select Yes. Pangle supports creating floor price ads. Fill in the code to set the floor price in the floor price setting area and enter the relevant information to complete the creation.

 

● Admob

(1) When editing a Network, you need to select Yes for Automatically create ad sources. You need to re-authorize your Google account. After logging into your Google account, you must follow the authorization process to allow permissions before you can use the automatic creation function.

(2) When creating a new ad slot in the waterfall flow, if you have completed the above steps, you will see the option to automatically create an ad source. Select Yes. Admob only supports the creation of bidding ads. Please confirm that your admob account has the permission to create bidding ad sources. Incentive interstitial ads are not currently supported.

 

● Liftoff (Vungle)

(1) When editing the Network, you need to select "Automatically create ad source" and fill in the Account ID, Reporting API key, and Secret Token.

(2) When creating a new ad slot in the waterfall flow, if you have completed the above steps, you will see the option to automatically create an ad source. Select Yes to support the creation of CPM and bBidding ads. Because Liftoff (Vungle) does not support the splash screen type, when automatically creating a splash screen ad, it will automatically create an interstitial ad. The specific parameter modification needs to be confirmed with the AM of Liftoff (Vungle).

Please make sure that your Liftoff (Vungle) has the CPM setting permission before creating a CPM ad source in the TopOn background. Because the Liftoff (Vungle) API does not support the judgment of whether there is permission, it will create a running ID without permission.

 

● Bigo

(1) When editing the Network, you need to select "Automatically create advertising source" and fill in the developer ID and Token.

(2) When creating a new ad slot in the waterfall flow, if you have completed the above steps, you will see the option to automatically create an ad source. Select Yes to support the creation of CPM and bBidding ads.

 

● Unity

(1) When editing the network,you need to select Yes for Auto Create Ad Source and fill in the API Key, Organization core ID, Key ID, and Secret Key.

(2) When adding an ad source, click [+Auto Create Ad Source], fill in the corresponding information and save.

 

● Digital Turbine

(1) When editing the network, you need to fill in the Client ID and Client Secret.

(2) When adding an ad source, configure the appid, click [+Auto Create Ad Source], fill in the corresponding information and save.

 

● Yandex

(1) When editing a network, you need to select Yes for Auto Create Ad Source and fill in the Block Configuration API.

(2) When adding an ad source, configure the appid, click[+Auto Create Ad Source], fill in the corresponding information and save.

 

5. Batch Paste

When adding advertising sources in batches, you can select the smart paste import function.

Supports direct pasting and recognition of the Excel table content exported from the Network. You can paste the advertising position ID, advertising position name, and sorting price of the Network into the input box. After entering, click the recognition button to automatically recognize the input content and intelligently identify the corresponding Network. Only some Networks are supported.

 

5.1 Currently supports automatic recognition of Networks:

CJS, Youlianghui, Kuaishou, Mintegral, Sigmob, and other Network IDs need to be manually selected when importing.

 

5.2 Specific page steps

(1) [Mediation]->[Add AD Source]-> [Batch Add Ad source], add advertising source entry and add smart paste import entry, click to open the import pop-up window

 

(2) On the import pop-up page, you can follow the steps in the figure to perform intelligent identification:

① Paste the ad slot ID, ad slot name and the sorting price to be set in the Excel table exported from the Network into the Network information input box. The ad slot name and sorting price can be left blank

② After entering, click the Identify button

③ The Network corresponding to the intelligent identification will be displayed in the identification information. After confirming the information, click One-click Import to import it into the corresponding Network configuration. If no Network is entered, it will be imported into the current Network.

Note: If the current ad slot is not associated with the imported platform, you will not be able to select the corresponding platform in the Network. You need to associate it first on the batch add page or Network page.

 

6. Batch add/edit ad sources

When you need to adjust the ad sources of multiple traffic groups under the ad slot, you can use the batch add/edit ad source function to achieve this. Click the batch add/edit ad source entrance in the Mediation to enter the page.

(1) Batch add: Click the Add Ad Source button to add a new ad source. By default, all traffic groups are added. You can use the switch to turn off the traffic groups that do not need to be added. The traffic groups can be filtered and displayed. You can set the sorting price and other data for each traffic group separately.

(2) Batch Edit: Displays all traffic groups bound to the current ad source. You can edit different traffic groups bound to a single ad source (open/close, unbind), edit each sorting price, and filter and display traffic groups

 

7. Copy Ad Source

(1) When the ad placement associated with a waterfall has multiple traffic groups or when AB testing is enabled, you can use the duplicate ad source feature to batch copy waterfalls from other groups under that ad placement. Multiple traffic groups can directly utilize the same ad sources.

(2) Select the group you want to copy, check the ad sources you wish to duplicate, and copy all settings of the ad source, including eCPM price, activation status, and ad source strategy (such as display count limits), to the current group.

 

8. FAQ

(1) How long does it take for the configuration to take effect after being modified in the TopOn backend?

All configurations in the TopOn backend basically follow this time:

The configuration will take effect 5 minutes after being modified in the TopOn backend. If you need to test, please set your phone time back 1 hour and try again; or clear the cache on Android/uninstall and reinstall on iOS. (Because the policy cache time is about half an hour)

In particular, the custom rules in the traffic grouping are adjusted dynamically. If the custom rules have been modified, they will be updated to the latest traffic grouping rules at the next ad request.

 

(2) In Mediation, does the Network bidding use server-side bidding or client-side bidding? Does it require developers to do technical joint debugging?

Some Networks use server-side bidding, while others use client-side bidding. For more information, see: >>Overview of Aggregation Platforms

Developers do not need to do technical joint debugging. The application side only needs to integrate the corresponding version of TopOn SDK and then fill in the bidding placements.