Callback Information
Callback Information Description#
AdInfo information callback instructions#
The developer can obtain the information of the current advertisement through the parameter adInfo by setting the callback listener.
Taking the incentive video type as an example, the code is as follows:
Set custom parameters#
Developers can set customAdInfo of each ad loading class to define data before displaying the ad. The SDK will return in the relevant callback after display.
Set the global display callback of the application dimension#
v8.5.0+ In order to facilitate developers to display data statistics, the SDK provides a global display callback API
Description of the callback information field returned by each interface#
| Key | Description |
|---|---|
| adType(Added in V7.1.0) | native native-banner native-splash native-draw banner splash interstitial rewarded-video offerwall |
| segment_id | Added in V7.1.0. Segment ID |
| bucket_id | Added in V7.1.0. A/B Test Group ID |
| adunit_id | Ad unit ID created by TradPlus Platform |
| adsource_placement_id | Ad source ID |
adNetworkId(Added in v7.8.0) | The number corresponding to the three-party advertising network is used to distinguish different advertising networks. Please refer to the 3rd party ad network ID table below |
adNetworkName(Added in v7.8.0) | Three-party ad network name |
| country_code | country code |
| ecpm | ecpm USD (⚠️ecpm is related to float type, the same below) |
| ecpm_cny | ecpm CNY |
| ecpm_precision | Added in V6.5.0. Get eCPM accuracy. "publisher_defined": the eCPM defined by the developer for the ad source in the background of TradPlus; "estimated": the eCPM estimated by TradPlus based on historical data after the developer enables the automatic price function of the ad source in the background ( eCPM for cross-promotion also belongs to this type); "exact": bidding real-time price, |
v7.8.0 obsolete. Developers can obtain it directly through ecpm. | |
v7.8.0 obsolete. Developers can obtain it directly through ecpm_cny. | |
| ecpm_level | Added in V6.5.0. Obtain the order (priority) of ad sources on the developer background intermediary management page. Bidding ad source is 0 by default. For non-bidding ad sources, the manual sorting area starts from 1 and increments. |
| is_adapter_template_render | Is it a template type |
| native_ad_type | Added in v6.9.0. Native ad type. The default is 0 (unknown), and the specific type is returned when the native ad is loaded. 0 - unknown 1 - self-rendering 2 - template 3 - video clip 4 - draw stream |
| is_bid | Whether it is the advertising source of Bidding |
| is_c2s_bid | Added in V7.6.0. Whether it is the advertising source of C2SBidding |
| is_auto_load | Added in V7.6.0. Whether it is automatically loaded |
| load_time | Added in V7.6.0. load time (ms) |
| reward_info | Reward information data (Reward video) returned by the three parties, including advanced rewards for Pangolin and Kuaishou (if any) |
| reward_name | Reward items configured in TradPlus Platform. (Reward video) |
| reward_number | The number of rewards configured in the TradPlus Platform. (Reward Video) |
| request_id | request ID, an id will be generated at the beginning of each call to load, and the complete life cycle of ad loading can be tracked when the final display is completed |
| waterfall_index | The position of the current ad in the waterfall |
| scene_id | Ad Scene ID |
| customAdInfo | Added in v8.3.20. The developer sets the custom data before the ad is displayed. Developers can configure settings through the corresponding APIs of each ad loading class. Custom data will be returned in the relevant callback after the ad is displayed |
| isNative | Added in v8.4.0. Whether it is a native ad. v8.4.0+ Banners and splash ads support the mixed use of native ads. Developers can use this field to determine whether an ad is a native ad. |
| isBottom | Added in v8.5.0. Is it a backup ad |
| placement_ad_type | Added in v8.7.0. Ad source ad type. v8.4.0+ The mixed use of native ads is supported for banners and open-screen ads, and the mixed use of open-screen ads for v8.7.0+ interstitial ads. Developers can use this field to obtain mixed ad types. 1 Native 2 Interstitial 3 Splash 4 Banner 5 RewardVideo 6 Offerwall |
| impPaidData | Impression-level revenue data returned by Admob（Added in v9.5.0） Note: The following fields are included in the data paid_valueMicros: ECPM paid_currencycode: Currency paid_precision: Precision Needs to be enabled in admob backend-Settings-Account-Advertising revenue at the impression opportunity level |
| impressionId | Added in v9.6.0 Uniquely identify.A unique identifier that identifies each ad impression |
| video_protocol | Added in v10.0.0 Video protocol Type 1:vast, 2:vamp |
| banner_w | Added in v10.3.0 The width of Banner configured in the TradPlus platform. |
| banner_h | Added in v10.3.0 The height of Banner configured in the TradPlus platform. |
Three-party advertising network ID table#
| NetworkId | SourceName |
|---|---|
| 1 | Audience-network （Meta） |
| 2 | Admob |
| 3 | Mopub |
| 4 | AdColony |
| 5 | UnityAds |
| 6 | Tapjoy |
| 7 | Liftoff |
| 9 | AppLovin |
| 10 | IronSource |
| 15 | Chartboost |
| 16 | Tencent Ads |
| 17 | Pangle(cn) |
| 18 | Mintegral |
| 19 | Pangle |
| 20 | Kuaishou Ads |
| 21 | Sigmob |
| 23 | Inmobi |
| 24 | Fyber |
| 25 | YouDao |
| 27 | Cross Promotion |
| 28 | Start.io |
| 30 | Helium |
| 31 | Maio |
| 32 | Criteo |
| 33 | MyTarget |
| 34 | Ogury |
| 37 | Kidoz |
| 38 | Smaato |
| 40 | ADX |
| 43 | Baidu |
| 44 | Klevin |
| 45 | A4G |
| 47 | SuperAwesome |
| 48 | GoogleAdManager |
| 50 | Yandex |
| 53 | Verve |
| 56 | ReklamUp |
| 57 | Bigo |
| 58 | Beizi |
| 60 | ONEMOB |
| 64 | PremiumAds |
| 67 | GreedyGame |
| 69 | BeesAds |
| 70 | Amazon |
| 71 | Mango X |
| 73 | TanX |