Skip to main content

iOS

AdInfo Callback Explanation#

Developers can obtain the information of the current ad by setting a callback listener and accessing the adInfo parameter.

Taking rewarded video as an example, the code is as follows:

// Ad impression success
TradplusRewardVideo.Instance().OnRewardVideoImpression += OnImpression;
...
void OnImpression(string adunit, Dictionary<string, object> adInfo)
{
// You can access the following information through the AdInfo object
}

Setting up a Global Impression Callback for App-level Display#

  • To facilitate developers in performing display data statistics, the SDK provides a global impression callback API.
  • Supported versions: Unity plugin version v1.0.4+, iOS v8.5.0+, Android v8.8.0.1+
  • Android Only: Developers need to call the listener for each type in order to receive the GlobalImpressionListener callback. For example, to set the impression callback for rewarded video: TradplusRewardVideo.Instance().OnRewardVideoImpression += OnImpression;
TradplusAds.Instance().AddGlobalAdImpression(OnGlobalAdImpression);
void OnGlobalAdImpression(Dictionary<string, object> adInfo)
{
// Developers can obtain the impression callbacks of all ad placements through this callback
}

Field Explanation for Callback Information Returned by Each Interface#

KeyExplanation
adTypeAdded in V7.1.0 Ad type.
native: Standard native ad
native-banner: Native banner
native-splash: Native splash
native-draw: Native draw
banner: Banner
splash: Splash
interstitial: Interstitial
rewarded-video: Rewarded video
offerwall: Offerwall
segment_idAdded in V7.1.0 Traffic segment ID
bucket_idAdded in V7.1.0 A/B testing group ID
adunit_idAd placement ID created in the TradPlus backend.
adsource_placement_idAd source ID
channel_id
adNetworkId(v7.8.0+)
Number assigned to the third-party ad network, used to distinguish different ad networks. Please refer to the table of third-party ad network IDs below.
channel_name
adNetworkName(v7.8.0+)
Name of the third-party ad network
country_codeCountry code
ecpmeCPM in USD (⚠️The eCPM-related fields are of type float, as are the subsequent fields)
ecpm_cnyeCPM in CNY
ecpm_precisionAdded in V6.5.0. Get the precision of eCPM.
"publisher_defined": eCPM defined by the developer in the TradPlus backend;
"estimated": eCPM estimated by TradPlus based on historical data when the developer enables the auto pricing feature for the ad source (cross-promotion eCPM also belongs to this type);
"exact": Real-time bidding price. When "exact" is returned, developers need to obtain the real-time bidding price through ecpm_exact and ecpm_exact_cny.
ecpm_exactAdded in V6.5.0. Real-time bidding price in USD. When ecpm_precision returns "exact", please use ecpm_exact and ecpm_exact_cny as the ad prices, which are more accurate than ecpm and ecpm_cny.
Deprecated in v7.8.0. Developers can directly obtain it through ecpm.
ecpm_exact_cnyAdded in V6.6.0. Real-time bidding price in CNY. When ecpm_precision returns "exact", please use ecpm_exact and ecpm_exact_cny as the ad prices, which are more accurate than ecpm and ecpm_cny.
Deprecated in v7.8.0. Developers can directly obtain it through ecpm_cny.
ecpm_levelAdded in V6.5.0. Get the order (priority) of the ad source in the mediation management page in the developer backend.
The default value for bidding ad sources is 0.
For non-bidding ad sources, the manual sorting starts from 1 and increases incrementally.
is_adapter_template_renderWhether it is a template type
native_ad_typev6.9.0+. Native ad type. Default: 0 (unknown). The specific type is returned after the native ad is loaded.
0 - Unknown
1 - Self-rendered
2 - Template
3 - Video interstitial
4 - Draw native ad
is_bidWhether it is a bidding ad source
is_c2s_bidAdded in V7.6.0. Whether it is a C2S Bidding ad source
is_auto_loadAdded in V7.6.0. Whether it is auto-loaded
load_timeAdded in V7.6.0. Loading duration in milliseconds
reward_infoReward information returned by third-party (rewarded video), including advanced rewards from TikTok and Kuaishou (if available)
reward_nameReward item configured in the TradPlus backend (rewarded video)
reward_numberReward quantity configured in the TradPlus backend (rewarded video)
request_idRequest identifier. A new ID is generated each time the load function is called. It can be used to track the complete lifecycle of ad loading until display completion
waterfall_indexThe position of the current ad in the waterfall
scene_idAd scene ID
customAdInfov8.3.20+. Custom data set by developers before ad display. Developers can set it through the corresponding API of each ad loading class. The custom data will be returned in relevant callbacks after ad display
isNativev8.4.0+. Whether it is a native ad. From v8.4.0+, banners and splash ads support the mixed use of native ads. Developers can determine whether an ad is a native ad based on this field
isBottomv8.5.0+. Whether it is a backup ad
placement_ad_typev8.7.0+. Ad source ad type.
From v8.4.0+, banners and splash ads support the mixed use of native ads. From v8.7.0+, interstitial ads support the mixed use of splash ads. Developers can obtain the mixed ad types through this field.
1 - Native
2 - Interstitial
3 - Splash
4 - Banner
5 - Rewarded Video
6 - Offerwall
impPaidDataImpression-level revenue data returned by AdMob (v9.5.0+)
Note: The following fields are included in the data:
paid_valueMicros: ECPM
paid_currencycode: Currency code
paid_precision: Precision
impressionIdAdded in v9.6.0 Unique identifier for each ad impression
video_protocoAdded in v10.0.0 Video protocol Type 1:vast, 2:vamp
banner_wAdded in v10.3.0 The width of Banner configured in the TradPlus platform.
banner_hAdded in v10.3.0 The height of Banner configured in the TradPlus platform.

Third-Party Ad Network ID Table#

NetworkIdSourceName
1Audience-network (Meta)
2Admob
3Mopub
4AdColony
5UnityAds
6Tapjoy
7Liftoff
9AppLovin
10IronSource
15Chartboost
16Tencent Ads
17Pangle(cn)
18Mintegral
19Pangle
20Kuaishou Ads
21Sigmob
23Inmobi
24Fyber
25YouDao
27Cross Promotion
28Start.io
30Helium
31Maio
32Criteo
33MyTarget
34Ogury
37Kidoz
38Smaato
40ADX
43Baidu
44Klevin
45A4G
47SuperAwesome
48GoogleAdManager
50Yandex
53Verve
56ReklamUp
57Bigo
58Beizi
60ONEMOB
64PremiumAds
67GreedyGame
69BeesAds
70Amazon
71Mango X
73TanX