回调信息说明
一、adInfo的信息回调说明
开发者可通过设置回调监听,就可通过参数adInfo获取当前广告的信息。
以激励视频类型为例,代码如下:
onAdImpression: (adUnitId,adInfo)
{
print('onAdImpression : adUnitId = $adUnitId, adInfo = $adInfo');
},
返回信息如下,可以获取到对应的内容:
{"adNetworkId":"2","adSourceId":"ca-app-pub-3940256099942544/1033173712","adSourceName":"admob","adUnitId":"788E1FCB278B0D7E97282231154458B7","adViewHeight":0,"adViewWidth":0,"amount":0,"bucketId":"1516"......}
设置应用维度的全局的展示回调
- 为方便开发者进行展示数据统计,SDK提供了全局展示回调API
- 支持版本:Flutter插件版本 v1.0.4+,iOS v8.5.0+, Android v8.8.0.1+
- Android Only:开发者同步需要调用每个类型的基础监听,才能收到GlobalImpressionListener监听,例如:激励视频设置
TPRewardVideoAdListener
import 'package:tradplus_sdk/tradplus_sdk.dart';
static TPGlobalAdImpressionListener? globalAdImpressionListener;
globalAdImpressionListener = TPGlobalAdImpressionListener(
onGlobalAdImpression: (adInfo) {
//开发者可以通过此回调获取到所有广告位的展示回调
}
);
TPSDKManager.setGlobalAdImpressionListener(globalAdImpressionListener!);
Android 回调信息字段说明
| 方法 | 类型 | 说明 |
|---|---|---|
| tpAdUnitId | String | TradPlus后台创建的广告位ID。 |
| true_adunit_id | String | V12.4.0.1新增。共享广告位特有的广告信息,用于记录广告最终展示在哪个广告位上。 |
| adSourceName | String | 三方广告网络名称。例如,谷歌广告返回“Admob”。 |
| adNetworkId | String | 三方广告网络对应的编号,用于区分不同广告网络。请参考下述的三方广告网络编号表。 |
| adSourceId | String | 三方广告位ID。 |
| ecpm | String | Ecpm美金。(默认) |
| ecpmcny | String | Ecpm人民币。 |
| ecpmPrecision | String | 获取eCPM精度。 "publisher_defined":开发者在TradPlus后台为广告源定义的eCPM; "estimated": 开发者在后台开启广告源的自动价格功能后,TradPlus根据历史数据预估的eCPM(交叉推广的eCPM也属于该类型); |
| ecpmLevel | String | 获取广告源在开发者后台中介管理页面的顺序(优先级)。 bidding广告源默认为0。 非bidding广告源,手动排序区从1开始递增。 |
| loadTime | long | 加载时长。 |
| rewardName | String | 仅激励视频支持。TradPlus后台配置的奖励项目。 |
| rewardNumber | int | 仅激励视频支持。TradPlus后台配置的奖励数量。 |
| isoCode | String | 国家码。 |
| height | int | 高。横幅广告可获取设置的对应广告位的高度。 |
| width | int | 宽。横幅广告可获取设置的对应广告位的宽度。 |
| rewardVerifyMap | Map | 仅Tencent激励视频支持。腾讯优量汇激励视频服务器奖励验证,需要在奖励回调中设置对应的user_id。 |
| isBiddingNetwork | boolean | 判断是否是开启Bidding的广告网络。 |
| waterfallIndex | int | 获取当前广告在waterfall中的排序。 |
| requestId | String | 请求标识,每次调用load开始会生成一个id,到最终展示完成,可以追踪广告加载的完整生命周期 |
| subChannel | String | 获取子渠道信息。 |
| channel | String | 获取渠道信息。 |
| sceneId | String | 广告场景ID。 |
| configBean | ConfigResponse.WaterfallBean.ConfigBean | 获取WatllFall策略下发的三方对象。 |
| networkType | String | 获取对应的广告类型。 "interstitial"插屏广告、"interstitial-video"激励视频、"banner"横幅广告、"Native Banner"原生横幅、"Native DrawVideo"Draw信息流、"Native Splash"原生拼接开屏 |
| bucketId | String | AB测试分组ID。 |
| segmentId | String | 流量分组ID。 |
| isBottom | boolean | V8.8.0.1新增。是否为备用广告。 |
| placementAdType | int | V9.0.0.1新增。 V8.7.0.1横幅和开屏广告支持原生广告混用,V9.0.0.1插屏广告支持开屏广告混用,开发者可以通过此字段获取混用广告类型。 广告源广告类型:1、原生;2、插屏;3、开屏;4、Banner;5、激励;6、积分墙 |
| impPaidData | Map | paid_valueMicros: ECPM; paid_currencycode: 币种; paid_precision: 精度 需要在admob后台-设置-账户-展示机会层级的广告收入 启用 说明:因Admob 2025年7月17日官方政策调整,Admob SDK停止分享展示级别收益,请使用TPAdInfo.ecpm 获取广告展示收入数据 |
| impressionId | String | V9.9.0.1新增。标识每次广告展示的唯一标识。 |
| bannerW | int | v10.6.0.1新增 Banner在后台配置的尺寸宽度 |
| bannerH | int | v10.6.0.1新增 Banner在后台配置的尺寸高度 |
iOS 回调信息字段说明
| Key | 说明 |
|---|---|
| adType | 广告类型。 native : 标准原生 native-banner : 原生横幅 native-splash :原生开屏 native-draw:原生draw信息流 banner:横幅 splash :开屏 interstitial :插屏 rewarded-video:激励视频 offerwall:积分墙 |
| segment_id | 流量分组ID |
| bucket_id | A/B测试组ID |
| adunit_id | TradPlus后台创建的广告位ID。 |
| true_adunit_id | V12.1.0 新增共享广告位特有的广告信息,用于记录广告最终展示在哪个广告位上。 |
| adsource_placement_id | 广告源ID |
| adNetworkId | 三方广告网络对应的编号,用于区分不同广告网络。请参考下述的三方广告网络编号表 |
| adNetworkName | 三方广告网络名称 |
| adSourceId(v11.70+) | 三方广告位ID,11.7.0之前版本大部份广告源可通过 placementid 字段获取 (MyTarget 字段为 slot_id) |
| country_code | 国家码 |
| ecpm | ecpm美金(⚠️ecpm相关为float类型,下同) |
| ecpm_cny | ecpm人民币 |
| ecpm_precision | 获取eCPM精度。 "publisher_defined":开发者在TradPlus后台为广告源定义的eCPM; "estimated": 开发者在后台开启广告源的自动价格功能后,TradPlus根据历史数据预估的eCPM(交叉推广的eCPM也属于该类型); "exact": bidding实时价格, |
| ecpm_level | 获取广告源在开发者后台中介管理页面的顺序(优先级)。 bidding广告源默认为0。 非bidding广告源,手动排序区从1开始递增。 |
| is_adapter_template_render | 是否为模版类型 |
| native_ad_type | 原生广告类型。默认 0(未知),当原生广告加载完成后返回具体类型。 0 - 未知 1 -自渲染 2 - 模版 3 - 视频贴片 4 - draw信息流 |
| is_bid | 是否为Bidding的广告源 |
| is_c2s_bid | 是否为C2SBidding的广告源 |
| is_auto_load | 是否是自动加载 |
| load_time | 加载时长 毫秒 |
| reward_info | 三方返回的奖励信息数据(激励视频),包括穿山甲和快手的进阶奖励(如果有) |
| reward_name | TradPlus后台配置的奖励项目。(激励视频) |
| reward_number | TradPlus后台配置的奖励数量。(激励视频) |
| request_id | 唯一标识一次广告请求,每次调用load开始会生成一个id,到最终展示完成,可以追踪广告加载的完整生命周期 |
| waterfall_index | 当前广告在waterfall中的位置 |
| scene_id | 广告场景ID |
| customAdInfo | v8.3.20+ 开发者在广告 展示前设置对自定义数据。开发者可通过各广告加载类对应API进行设置。自定义数据会在广告展示后的相关回调中返回 |
| isNative | v8.4.0+ 是否为原生广告。v8.4.0+横幅和开屏广告支持原生广告混用,开发者可以通过此字段判断广告是否为原生广告 |
| isBottom | v8.5.0+ 是否为备用广告 |
| placement_ad_type | v8.7.0+ 广告源广告类型。 v8.4.0+ 横幅和开屏广告支持原生广告混用,v8.7.0+ 插屏广告支持开屏广告混用,开发者可以通过此字段获取混用广告类型。 1 原生 2 插屏 3 开屏 4 Banner 5 激励 6 积分墙 |
| impPaidData | Admob返回的展示级收益数据(v9.5.0+) 注:数据中包括以下字段 paid_valueMicros: value paid_currencycode: 币种 paid_precision: 精度 |
| impressionId | v9.6.0新增 标识每次广告展示的唯一标识 |
| video_protocol | v10.0.0新增 视频协议类型 1:vast, 2:vamp |
| banner_w | v10.3.0新增 Banner在后台配置的尺寸宽度 |
| banner_h | v10.3.0新增 Banner在后台配置的尺寸高度 |
二、三方广告网络编号表
| NetworkId | 广告平台 |
|---|---|
| 1 | audience-network (Facebook) |
| 2 | Admob |
| 4 | AdColony |
| 5 | UnityAds |
| 6 | Tapjoy |
| 7 | LiftOff(Vungle) |
| 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 |
| 36 | appnext |
| 37 | kidoz |
| 38 | Smaato |
| 40 | TP-ExChange (TPX) |
| 41 | HuaWei |
| 43 | Baidu |
| 45 | A4G |
| 46 | Mimo (米盟) |
| 47 | SuperAwesome |
| 48 | Google Ad Manager |
| 50 | Yandex |
| 53 | Verve |
| 55 | zMaticoo |
| 56 | Reklamup |
| 57 | Bigo |
| 63 | TapTap |
| 64 | PremiumAds |
| 67 | GreedyGame |
| 68 | AlgoriX |
| 69 | BeesAds |
| 70 | Amazon |
| 71 | Mango X |
| 72 | Octopus |
| 72 | Tanx |
| 74 | Taurusx |
| 75 | 海外快手 |
| 76 | Columbus(海外小米) |
| 77 | Yso |
| 78 | Vivo |
| 79 | Oppo |
| 80 | Honor(荣耀) |