1. Mediation Unit list

(1) On the [Application] - [Mediation Unit] page, you can view the basic data of the current application Mediation Unit, so as to timely discover the trend of Mediation Unit data changes. The main indicators include Est. revenue, Est. eCPM, and impressions.

(2) In the Mediation Unit list, you can adjust the Mediation Unit status switch according to the actual situation.
Note: After turning off the Mediation Unit, it will affect the online revenue situation. Please adjust it according to actual needs.

(3) Edit Mediation Units. Click the Mediation Unit name to jump to the edit Mediation Unit page. You can adjust the waterfall flow configuration in the Mediation Unit according to the actual situation.

2. Create Mediation Units

On the [Application] - [Mediation Unit] page, click [+Add Mediation Unit] to enter the Mediation Unit adding process

2.1 Step 1: Fill in basic information

(1) Basic Mediation Unit information: Mediation Unit name, ad type

(2) Ad types supported by Hyperbid Tools: splash, rewarded video, banner, native, interstitial

2.2 Step 2: Choose Request Mode

(1) Price Comparison

In Price Comparison mode, Hyperbid Tools will initiate requests for all ad units simultaneously. After calling the show() method, a price comparison will be carried out, and the ad unit with the highest price will win and be displayed.

For ad units with a pricing coefficient set, the participating comparison price = eCPM returned by the ad unit * the pricing coefficient.

If there is a need to tilt the display for different ad units, you can contact the AM to activate the pricing coefficient permission.

(2) Waterfall

In waterfall mode, Hyperbid Tools will group the ad units according to the set number of parallel requests, and the ad units within each group will initiate requests simultaneously. When the number of filled ad units is greater than mediation unit cached offers number, no requests for ad units will be initiated.

Note: You can drag and adjust the priority of ad units at the ad unit configuration preview.

Usage suggestion: If you want to give priority to displaying the ad of certain mediation platform, you can adopt the waterfall mode and adjust the ad units of the mediation platforms that you want to display first to the highest priority.

2.3 Step 3: Enter the AD Unit

(1) According to the actual needs, select the mediation platform you need to use and enter the corresponding mediation platform ad space information.

(2) In the AD Unit, the corresponding relationship between each mediation platform is as follows. Enter the third-party ID information according to the corresponding mediation platform name

(3) Note: The same ad placement ID on the same Mediation cannot be configured in multiple Hyperbid Tools ad units. Otherwise, the ad may not be available in the same load.

In Hyperbid Tools, the "AD Unit" corresponds to the name of each mediation platform:

Mediation	param
TopOn	Placement
MAX	AD Unit ID
Admob	AD Unit ID

When entering a TopOn Ad Unit, you can select the corresponding placement in the drop-down box.

(3) pricing coefficient , the default value is 1, which is used to adjust the display priority of the AD Unit. The supported input range is (0-5], with 2 decimal places.

If you need to give priority to the AD Unit under a certain mediation platform, you can enter a pricing coefficient > 1. When actually comparing prices, the participating price = eCPM returned by the AD Unit * pricing coefficient .
If you need to lower the display ranking of an ad unit under a certain mediation platform, you can enter a pricing coefficient <1 to adjust it.

(4) For custom mediation platforms, Hyperbid Tools defines the third-party ad slot ID as the ad slot ID by default. If you need to pass in other AD Unit dimension parameters (such as ad size), you can pass them in json format in other custom parameters.

(5) When adding an ad unit, the ad unit name will be automatically generated.

(6) Click the mediation platform status button to control the ad unit status with one click

2.4 Step 4: Confirm the waterfall configuration

(1) After completing the AD Unit entry, you can view the configured AD Units in the waterfall preview to confirm whether they meet the actual needs

(2) In waterfall mode,if you need to adjust the AD Unit request priority, you can adjust the priority by dragging the icon on the far left

3. Other functions

3.1 Segment

Hyperbid Tools provides a variety of segment rules so that developers can configure waterfall flow strategies based on a variety of actual monetization scenarios.

(1) In the Add/Edit Mediation Unit page, click [Add segment], select the corresponding segment rule, and generate a new segment. Enter the AD Unit under the segment to complete the waterfall flow configuration.

(2) Supported segment rules: region, city, date, week, hour, network type, application version name, application version number, SDK version, system version, device ID, device type, device brand, device memory, installation time, channel, sub-channel, IDFA status, installation source, user ID, custom rules

(3) Segment priority: In the case of hitting multiple segment rules at the same time, you can adjust the segment priority to decide which waterfall flow policy configuration to send first.

Rules	Conditions	Number of rules	Description	Examples
channel	include, exclude	1	Supports entering multiple channel numbers separated by commas. The channel numbers must first be passed in through the SDK's custom rules.	channel_1
Area	include, exclude	1	Multiple regions can be selected	Mainland China, Japan, South Korea
City	include, exclude	1	You can select multiple cities. You can select cities only after selecting a region and then adding a rule	Guangzhou, Beijing, Shanghai
Date	include	1	Support selection of time period and time zone	2023/01/01-2023/01/02
Hour	include	Multiple	You can select between 00:00 and 23:59	10:00 to 23:59
Time Zone	equals	1	When selecting a date, you can select various time zones	UTC+8 Beijing
Network Type	include	1	You can choose 2G\3G\4G\WiFi network only. You can select multiple options.	4G
Application Version Name	include, exclude	Multiple	App Version Name, you can fill in multiple app versions, separated by commas (You can check the application version dimension in the TopOn comprehensive report)	2.2.1,2.2.2
Application Version Number	include, exclude、≥、≤	One or Multiple	Android: App version_code, you need to fill in an integer. It is recommended to consult App development technology to provide the application version number. iOS: The application version number is consistent with the application version name. (You can check the application version dimension in the TopOn comprehensive report)	zz：112345；iOS：1.1.1
SDK Version	include, exclude、>、<	1	TopOn SDK version, when including or excluding, you can fill in multiple SDK version numbers, separated by English commas. When > and <, you can only fill in one	5.0.0
System Version	include, exclude、>、<	1	Phone system version (Android version name), when including or excluding, you can fill in multiple system version numbers, separated by commas. When > and <, you can only fill in one	iOS：13.3.1；Android：13
Device ID	include	1	You can fill in multiple device IDs, separated by English commas. The device ID can be iOS (IDFA, IDFV), Android (GAID, Android ID, OAID, IMEI, IMEI is supported below Android 10)	28968E75-E7BE-4AA2-BFA0-C455DD74C111
Device Type	include, exclude	1	You can select iPhone or iPad. You can select multiple options.	iPad
Device Brand	include, exclude	1	Multiple brands available	Xiaomi
CPU model	include, exclude	1	You can choose different CPU models, only applicable to Android version	x86
Installation time	>、<	Multiple	The installation time is calculated based on the time when the TopOn SDK is first initialized. Multiple installation time rules are in an AND relationship and must meet the segment requirements at the same time to take effect.	< 1 day or < 24 hours
Sub-channel	include, exclude	1	Supports entering multiple sub-channel numbers separated by commas. The sub-channel numbers must first be passed in through the SDK's custom rules.	sub_channel_1
cold start request	Can only choose yes	/	The SDK will automatically determine whether to apply a cold start, and will use this segment configuration during a cold start. It is recommended to configure fewer ad sources for cold starts to reduce request time and increase display rate.	yes
User ID	include, exclude、≥、≤、区间	Multiple	Upload the user ID and match the word rules	11111
Installation source	include, exclude	Multiple	Can identify the user's installation source, including various app stores, such as Google Play Note: This rule is only effective for Android systems	com.google.com
Custom	Equal to use the = symbol, not equal to use the != symbol, and use the & symbol	1	Set through Key-Value conditions, the conditions of Key and Value can be equal to = or not equal to !=, a Key can correspond to multiple Values, separated by English commas. Use & between multiple conditions, that is, multiple conditions need to be met at the same time	For example, 18-year-old male users, and users brought by Toutiao or Tencent promotion are grouped together, and the custom to be filled in is age=18&sex=male&pnetwork=bytedance,tencent

(4) When adding a new segment, you can copy the default group configuration to the newly created segment. The copied configuration includes: enabled ad units, request mode, and advanced settings.

(5) Click [Copy Existing Ad Units] to copy ad units from different segments of the same application and the same ad type to the current segment.

Note: The copyable segment is single-select and must be a segment that has been submitted for creation. The currently added and unsubmitted group cannot be copied.

3.2 Advanced settings

(1) Request Number

when the Mediation Unit is loaded, the number of AD Units loaded in parallel, default is all.

When the request mode is Price Comparison, the number of parallel requests is fixed as all.

When the request mode is Waterfall, the default number of parallel requests is 1, which can be adjusted according to actual needs.

(2) Mediation Unit Cached Offers Number

after the SDK calls back the Load Success of the Mediation Unit, it determines whether the current Mediation Unit has reached the cache quantity requirement. If not, the SDK will continue to execute the WaterFall process until all AD Units are executed or the cache quantity requirement is reached. The default value is 1.

The Mediation Unit Cached Offers Number is only effective in the waterfall request mode.

(3) Ad Unit Timeout

If an AD Unit has been loaded for a certain period of time and has not returned a loading result, the next AD Unit will be loaded.

The Ad Unit Timeout is only effective in the waterfall request mode.

Note: This is to load the next AD Unit after the timeout period has expired. The AD Unit filling will still be retained after the timeout

(4) Auto Refresh

Set the time interval for automatic ad refresh. It is recommended to set the interval from 10 seconds to 150 seconds. If you enter 0, the auto refresh function will not be enabled. The default value is 15 seconds, which is only available for banner positions.

Note: It is recommended to turn off the automatic rotation function of third-party advertising platforms and control it uniformly through Hyperbid Tools.

(5) Mediation Unit Loaded Callback Mode

Hyperbid SDK v3.2.0 and above support two Mediation Unit Loaded Callback Modes: show priority and price priority

● Price Priority: You can get the mediation unit filling callback faster. When users frequently display ads or the App has restrictions on the ad loading time, it is recommended to select this mode.

● Show Priority: Accept a long wait for a higher-priced ad to be filled callback. This mode is recommended when users can wait for ads to be displayed.

You can conduct experiments by combining the settings with your own interface call timing through AB test to select the appropriate callback mode.

Recommendations for Loaded Callback Mode:

Whether the ad is triggered by user behavior	Whether to rely on load callback to display ads	Recommended Hyperbid load callback mode selection
Yes	Yes	Show Priority
Yes	No	Show Priority
No, can handle preloading	Yes	1) If there is no preloading logic and it relies on load callback, it is recommended to prioritize display; 2) If there is preloading logic and it relies on load callback, it is recommended to Price Priority or make a decision through ab test. At the same time, developers can set the Callback Timeout according to product type and demand.
No, can handle preloading	No	It is recommended to Price Priority or conduct ab test through Hyperbid.

(6) Price Priority Callback Timeout

Hyperbid Tools provides default values for timeouts of different mediation unit styles. It is recommended that developers configure timeouts for different ad positions based on A/B Test and actual data. The minimum value is 1 s.

Native	3s
Banner	3s
Splash	4.5s
Interstitial	45s
Rewarded Video	45s

You can make settings in combination with the fill time quantiles of ad units. For example, check the fill time quantiles of ad units with longer fill times in the current mediation unit, and make settings in combination with the 75th/90th fill time quantiles.

Your guide to Hyperbid Tools