Menu

Callback information

1. Ad Event Callback

Description of the callbackInfo content in the ad listener event callbacks:

Variable Type Description
network_firm_id int Get the ID corresponding to the ad platform, used to distinguish different ad platforms
adsource_id string Get the ad source ID. You can query the specific network information via the ad source ID in the developer backend or TopOn Open API
adsource_index int Get the sequence of the current ad source in the Waterfall (starting from 0)
adsource_price double Get the eCPM value, the currency unit can be obtained via getCurrency()
adsource_isheaderbidding int Indicates whether it is a header bidding ad source, 1: Yes, 2: No
id string Get the unique ID generated each time an ad is displayed
publisher_revenue double Get the ad display revenue
currency string Get the currency unit, e.g., "USD"
country string Get the country code, e.g., "CN"
adunit_id string Get the TopOn ad placement ID
adunit_format string Get the ad format, including: "Native", "RewardedVideo", "Banner", "Interstitial", "Splash"
precision string Get the eCPM precision."publisher_defined": The eCPM defined by the developer for the ad source in the TopOn backend (the eCPM of cross-promotion also falls into this category)."estimated": The predicted eCPM by TopOn (auto eCPM)."exact": The real-time bidding eCPM from Header Bidding (excluding Meta ad platform)."ecpm_api": Valid for Meta ad sources only, the historical eCPM estimated based on Meta Report API data. Supported in TopOn SDK v5.9.60 and above.
network_type string Get the network type."Network": Third-party ad platform."Cross_Promotion": Cross-promotion."Adx": TopOn Adx
network_placement_id string Get the ad placement ID of the network
ecpm_level int Get the eCPM level of the ad source, header bidding ad sources default to level 0
segment_id int Get the traffic segment ID
scenario_id string Get the ad scenario ID
scenario_reward_name string Get the reward name of the ad scenario, supported only for Rewarded Video
scenario_reward_number int Get the reward amount of the ad scenario, supported only for Rewarded Video
sub_channel string Get the sub-channel information
channel string Get the channel information
custom_rule Dictionary Get the JSON string of the custom rules at the Placement + App level
Previous
Privacy Compliance Guide
Next
FAQ and error codes
Last modified: 2026-01-07Powered by