1.Edit the setting for placement segment:
Request params (attrs for permission control）:
| params | type | required | notes |
|---|---|---|---|
| xxx |
some required params, for detail: Api 9 of Segment-Api |
||
| items | Array[Object] | Y | item list of setting |
| items.xxx | Int | N |
attrs for non-permission control (visible for all publishers), for details: Api 9 of Segment-Api |
| items.intel_opt_cache | Int | N |
Smart optimization, enum description: 1: Off(default) 2: Price Priority 3: Display Priority No parameter or 0 means no modification. Notes: TonOn's Smart Optimized Cache function will automatically increase the ad cache according to the ad cache of the current placement. Smart Optimized Caching supports two modes: |
| items.bf_ldf_rf_sw | Int | N |
Request Fails Retry Switch, enum description： No parameter or 0 means no modification. Notes: Automatically resent the request if it fails. This will increase the numbers of requests and attempts. Supported by TonOn SDK v5.9.40 and above. |
| items.cached_offers_num | Int | N |
Ads Served After Waterfall Execution ，valid enum range：[1,5], default is 1. No parameter or 0 means no modification. Notes：After the ad placement's Load Success callback, the TonOn SDK determines whether the current ad placement has met the stop count requirement. If not, the SDK will continue executing the Waterfall flow until all ad sources are processed or the ad count requirement is met. |
| items.sdk_timeout | Int | N |
Load Timeout (seconds)，valid enum range：[1,5000]，default is 900。 No parameter or 0 means no modification. Notes：The max waiting time for each placement request, and the request will end when timeout |
| items.bottom_req_time | Int | N |
Bottom Ads Request Initiation Time (millseconds)，valid enum range：[0,5000]，default is 1000。 No parameter means no modification. Notes：The time bottom request lags behind the placement request |
| items.dynamic_wf_sw | Int | N |
Dynamic Waterfall Switch，enum description： 1：Yes 2：No（default） No parameter or 0 means no modification. Notes：Based on the real-time value of users at the device level, dynamically adjust the price tiers for each request in the waterfall sequence to achieve optimal request logic, enhancing revenue and loading efficiency while reducing invalid requests. Contact your AM to learn more details. |
| items.pl_up_status_timeout | Int | N |
Placement Filled CD (seconds)，valid enum range：[0,1000]，default is 300，don't set 0 No parameter means no modification. Notes：The LoadSuccess status of the placement dimension marks the UP_status validity period. The developer calls Load during during the cooling time, the SDK directly callback to Load Success |
| items.ad_up_status_timeout | Int | N |
AD Filled CD (seconds)，valid enum range：[1,10000]，default is 900 No parameter or 0 means no modification. Notes：Request Filled status flag UP_status validity period of the ad source dimension. The developer calls request during the cooling time, the SDK directly callback to Request Filled |
| items.auto_refresh_time | Int | N |
Auto Refresh（Auto Request），enum description for different formats: Banner (automatic refresh when refresh mode is [Manual Optimization]): -1 (auto refresh off); range [1,1000], default = 15 (auto refresh interval, unit: seconds). (Notes: Set the interval between regular automatic refresh of advertisements. It is recommended that the interval should be 10 to 150 seconds. If it is not filled, the automatic refresh function will not be enabled. Note: before enabling TonOn automatic refresh, make sure that the automatic refresh or rotation function of third-party advertising sources is turned off, otherwise the display and revenue of advertisements will be affected.) Rewarded video/interstitial /Splash Ads (automatic request): -1 (auto refresh off); 1 (auto refresh on). (Notes: Once the ad is shown, closed or isReady is False, the TonOn SDK will automatically request the ad for the next impression.If the client has processed the pre-loading logic as suggested in the integrated documentation, it is not recommended to turn on this function.) Native ads and other formats: no auto refresh function, ignore |
2. Get the setting for placement segment:
Return params (attrs for permission control）:
| params | type | required | notes |
|---|---|---|---|
| - | Array[Object] | Y |
some required params, for detail: Api 8 of Segment-Api |
| _.xxx | Int | Y |
attrs for non-permission control (visible for all publishers), for details: Api 8 of Segment-Api
|
| _.intel_opt_cache | Int | Y |
Smart optimization, enum description: 1: Off(default) 2: Price Priority 3: Display Priority Notes: TonOn's Smart Optimized Cache function will automatically increase the ad cache according to the ad cache of the current placement. Smart Optimized Caching supports two modes: |
| _.bf_ldf_rf_sw | Int | Y |
Request Fails Retry Switch, enum description： Notes: Automatically resent the request if it fails. This will increase the numbers of requests and attempts. Supported by TonOn SDK v5.9.40 and above. |
| _.cached_offers_num | Int | Y |
Ads Served After Waterfall Execution ，valid enum range：[1,5], default is 1. No parameter or 0 means no modification. Notes：After the ad placement's Load Success callback, the TonOn SDK determines whether the current ad placement has met the stop count requirement. If not, the SDK will continue executing the Waterfall flow until all ad sources are processed or the ad count requirement is met. |
| _.sdk_timeout | Int | Y |
Load Timeout (seconds)，valid enum range：[1,5000]，default is 900。 Notes：The max waiting time for each placement request, and the request will end when timeout |
| _.wf_loadts | Int | Y |
The time to wait after the Waterfall is filled (millseconds)，valid enum range：[1000,120000] Notes：After waiting N seconds after Waterfall running, Load Success will be called back if there is available cache. The precision is second for iOS, and millisecond for Android. For example, if the value is 3.600s, the value is 3s for iOS and 3600ms for Android |
| _.nw_timeout | Int | Y |
Ad source timeout (millseconds)，valid enum range：[100,60000] Notes：After the Ad source times out, the next Ad source will be requested |
| _.hb_bid_timeout | Int | Y |
HB Bid Timeout (millseconds)，valid enum range：[1,120000] Notes：The max bid time of Header Bidding ad sources, and the timeout response will not participate in the auction |
| _.ps_cache_timeout | Int | Y |
Wait Strategy Update Time (seconds)，valid enum range：[0, 100] Notes：The SDK updates the placement strategy in real time when the placement cache is invalid. This configuration controls the waiting placement strategy update timeout for the SDK。 |
| _.pl_up_status_timeout | Int | Y |
Placement Filled CD (seconds)，valid enum range：[0,1000]，default is 300，don't set 0 Notes：The LoadSuccess status of the placement dimension marks the UP_status validity period. The developer calls Load during during the cooling time, the SDK directly callback to Load Success
|
| _.ad_up_status_timeout | Int | Y |
AD Filled CD (seconds)，valid enum range：[1,10000]，default is 900 Notes：Request Filled status flag UP_status validity period of the ad source dimension. The developer calls request during the cooling time, the SDK directly callback to Request Filled
|
| _.byuid_wait_time | Int | Y |
Obtain Buyeruid Time Out (millseconds)，valid enum range：[1,100000] Notes：The wait time for the S2S Header Bidding ad sources to obtain the Buyeruid |
| _.s2s_bd_max | Int | Y |
S2S Bidding Ad Sources Number，valid enum range：[0,10]，0 neans no limit Notes：Max number of S2S Header Bidding ads returned in the same waterfall. When the number of AD sources exceeds the set number, they will be returned in price priority order. TonOn SDK v5.9.90 and above supports |
| _.bottom_req_time | Int | Y |
Bottom Ads Request Initiation Time (millseconds)，valid enum range：[0,5000]，default is 1000。 Notes：The time bottom request lags behind the placement reques |
| _.dynamic_wf_sw | Int | Y |
Dynamic Waterfall Switch，enum description： 1：Yes 2：No（default） Notes：Based on the real-time value of users at the device level, dynamically adjust the price tiers for each request in the waterfall sequence to achieve optimal request logic, enhancing revenue and loading efficiency while reducing invalid requests. Contact your AM to learn more details. |
| _.new_auto_refresh_type | Int | Y |
Refresh Type, notes: only banner format are supported currently, other formats can be ignored, enum description: 1：Auto Optimization 2：Manual Optimization Notes：Select Manual optimization to refresh the banner ad at the time you set; Choose auto optimization and TonOn will match the appropriate refresh time for different ad networks. |
| _.auto_refresh_time | Int | N |
Auto Refresh（Auto Request），enum description for different formats: Banner (automatic refresh when refresh mode is [Manual Optimization]): -1 (auto refresh off); range [1,1000], default = 15 (auto refresh interval, unit: seconds). (Notes: Set the interval between regular automatic refresh of advertisements. It is recommended that the interval should be 10 to 150 seconds. If it is not filled, the automatic refresh function will not be enabled. Note: before enabling TonOn automatic refresh, make sure that the automatic refresh or rotation function of third-party advertising sources is turned off, otherwise the display and revenue of advertisements will be affected.)Rewarded video/interstitial /Splash Ads (automatic request): -1 (auto refresh off); 1 (auto refresh on). (Notes: Once the ad is shown, closed or isReady is False, the TonOn SDK will automatically request the ad for the next impression.If the client has processed the pre-loading logic as suggested in the integrated documentation, it is not recommended to turn on this function.) Native ads and other formats: no auto refresh function, ignore |
| _.wf_lscb_type | Int | Y |
Placement Loaded Callback Mode，enum description： 1：Show Priority 2：Price Priority Notes：TonOn SDK v6.1.52 and above support two Placement Loaded Callback Modes: show priority and price priority Show priority: You can get the placement loaded callback faster. It is recommended to choose this mode when the user frequently displays ads or the app has a limit on the loading time of the ads. Price Priority: Can wait for higher priced ad fill results. This mode is recommended when the user can wait for the ad to be displayed You may choose the appropriate callback mode through AB Testing experiments. |
| _.rotation_num | Int | Y |
Rotation Number，valid enum range：[1,5]，1 means close the rotation, notes：only interstitial format are supported currently, other formats can be ignored Notes：Rotation ads is the continuous display of multiple ads in one display opportunity, and the next ad will automatically play after the rotation interval is reached. TonOn SDK v6.4.30 and above versions support interstitial rotation ads, supported by ad network including Tencent, CSJ, Baidu and Kuaishou, supported styles include interstitial ads and mixed interstitial ads, iOS splash mixed interstitial does not support. |
| _.rotation_inter | Int | Y |
Interval Between Rotation (millseconds)，valid enum range：[3000,30000]，notes：only interstitial format are supported currently, other formats can be ignored |
;}.cls-2{fill:%230868f7;}.cls-3{fill:url(%23未命名的渐变_44);}.cls-4{fill:%23333;}%3c/style%3e%3clinearGradient%20id='未命名的渐变_8'%20x1='33.73'%20y1='100.61'%20x2='-0.03'%20y2='-1.06'%20gradientUnits='userSpaceOnUse'%3e%3cstop%20offset='0'%20stop-color='%237ae9fb'/%3e%3cstop%20offset='0.67'%20stop-color='%232b90f8'/%3e%3cstop%20offset='1'%20stop-color='%230868f7'/%3e%3c/linearGradient%3e%3clinearGradient%20id='未命名的渐变_44'%20x1='27.86'%20y1='18.67'%20x2='68.36'%20y2='22.22'%20gradientUnits='userSpaceOnUse'%3e%3cstop%20offset='0'%20stop-color='%235ac7f2'/%3e%3cstop%20offset='1'%20stop-color='%230868f7'/%3e%3c/linearGradient%3e%3c/defs%3e%3cpath%20class='cls-1'%20d='M29,28.74V81.91l-9.51-3.68v0L8.52,74A7.17,7.17,0,0,1,4,67.32V24.54A3.76,3.76,0,0,1,9.08,21Z'/%3e%3cpath%20class='cls-2'%20d='M68.09,78.07a13.15,13.15,0,0,1-17.9,12.06L29,81.91h0V28.74L50.19,37A13.17,13.17,0,0,0,68.08,25.3h0Z'/%3e%3cpath%20class='cls-3'%20d='M68.08,25.3a13.19,13.19,0,0,1-6.73,10.87A13.09,13.09,0,0,1,50.19,37L29,28.74V6A3.76,3.76,0,0,1,34.1,2.52l25.59,9.91A13.22,13.22,0,0,1,68.08,25.3Z'/%3e%3cpath%20class='cls-4'%20d='M129.06,81.76a4.33,4.33,0,0,1-3.19-1.31,4.4,4.4,0,0,1-1.31-3.24V56.86H97.65V77.21a4.36,4.36,0,0,1-1.35,3.2A4.68,4.68,0,0,1,93,81.76a4.32,4.32,0,0,1-3.19-1.31,4.37,4.37,0,0,1-1.32-3.24V27.27A4.58,4.58,0,0,1,89.83,24a4.59,4.59,0,0,1,7.82,3.27V48.15h26.91V27.27A4.58,4.58,0,0,1,125.91,24a4.59,4.59,0,0,1,7.82,3.27V77.21a4.37,4.37,0,0,1-1.36,3.2A4.65,4.65,0,0,1,129.06,81.76Z'/%3e%3cpath%20class='cls-4'%20d='M163.77,81.66c-6.57,0-11.76-1.92-15.44-5.7s-5.54-9.07-5.54-15.74a26.76,26.76,0,0,1,2.09-10.43,17.72,17.72,0,0,1,6.67-8.06,19.15,19.15,0,0,1,10.68-2.95,19,19,0,0,1,10.46,2.8,18.7,18.7,0,0,1,6.55,7.36,22.53,22.53,0,0,1,2.36,10.28A4.51,4.51,0,0,1,177,63.77H152.23a10.8,10.8,0,0,0,3.49,6.65c2,1.68,4.88,2.52,8.66,2.52a22.25,22.25,0,0,0,7.54-1.21c.74-.3,1.55-.67,2.37-1.07a3.75,3.75,0,0,1,1.84-.4,4.09,4.09,0,0,1,3,1.15,4,4,0,0,1,1.12,3,4.38,4.38,0,0,1-2.58,3.82,32.34,32.34,0,0,1-6.36,2.61A28.67,28.67,0,0,1,163.77,81.66ZM172.4,55.9a9.72,9.72,0,0,0-1.63-4.56A9.9,9.9,0,0,0,167,48a10.38,10.38,0,0,0-4.64-1.14,12,12,0,0,0-4.77,1.06,9.54,9.54,0,0,0-4.89,5.66,11.78,11.78,0,0,0-.51,2.3Z'/%3e%3cpath%20class='cls-4'%20d='M193,81.64a4.49,4.49,0,0,1-4.51-4.55V27.28A4.58,4.58,0,0,1,189.84,24a4.48,4.48,0,0,1,3.28-1.36A4.36,4.36,0,0,1,196.35,24a4.46,4.46,0,0,1,1.31,3.31V77.09a4.34,4.34,0,0,1-1.35,3.2A4.67,4.67,0,0,1,193,81.64Z'/%3e%3cpath%20class='cls-4'%20d='M263.79,81.71a5.7,5.7,0,0,1-4.2-1.74,5.76,5.76,0,0,1-1.73-4.19V27.37a4.58,4.58,0,0,1,1.35-3.27A4.59,4.59,0,0,1,267,27.37V72.53h24a4.58,4.58,0,0,1,3.27,7.82A4.66,4.66,0,0,1,291,81.71Z'/%3e%3cpath%20class='cls-4'%20d='M424.48,81.74a4.71,4.71,0,0,1-2.71-.88,5.43,5.43,0,0,1-1-1l-.07-.09-12.41-17-5.41,5v9.44a4.31,4.31,0,0,1-1.36,3.19,4.66,4.66,0,0,1-3.3,1.36A4.29,4.29,0,0,1,395,80.42a4.36,4.36,0,0,1-1.32-3.23V27.37A4.58,4.58,0,0,1,395,24.1a4.52,4.52,0,0,1,6.58.12,4.54,4.54,0,0,1,1.24,3.15V56.31l17.72-16.38.05,0a4.8,4.8,0,0,1,2.94-1.11,4.4,4.4,0,0,1,3.27,1.2,4.57,4.57,0,0,1,1.2,3.27,4.44,4.44,0,0,1-.77,2.33,7.45,7.45,0,0,1-1.43,1.65l-11,9.64,13.34,17.68a5,5,0,0,1,1,2.71,4.12,4.12,0,0,1-1.36,3.24A4.64,4.64,0,0,1,424.48,81.74Z'/%3e%3cpath%20class='cls-4'%20d='M317.93,81.76a21.5,21.5,0,1,1,21.17-21.5A21.37,21.37,0,0,1,317.93,81.76Zm0-34.1a12.61,12.61,0,1,0,12.42,12.6A12.52,12.52,0,0,0,317.93,47.66Z'/%3e%3cpath%20class='cls-4'%20d='M212.18,101.22a4.12,4.12,0,0,1-3.05-1.26,4.17,4.17,0,0,1-1.26-3.1V43.34a4.37,4.37,0,0,1,1.3-3.14,4.26,4.26,0,0,1,3.13-1.3,4.19,4.19,0,0,1,3.1,1.26,4.32,4.32,0,0,1,1.26,3.16,20.77,20.77,0,0,1,13-4.54,21.51,21.51,0,0,1,0,43,20.51,20.51,0,0,1-13-4.57V96.86a4.15,4.15,0,0,1-1.3,3.06A4.5,4.5,0,0,1,212.18,101.22Zm17.43-53.63c-6.23,0-12.93,4.11-12.93,12.72a12.73,12.73,0,0,0,25.46,0A12.71,12.71,0,0,0,229.61,47.59Z'/%3e%3cpath%20class='cls-4'%20d='M365.76,81.76a21.5,21.5,0,1,1,21.18-21.5A21.37,21.37,0,0,1,365.76,81.76Zm0-34.1a12.61,12.61,0,1,0,12.42,12.6A12.52,12.52,0,0,0,365.76,47.66Z'/%3e%3c/svg%3e)