标准原生
1、请求广告
using TradplusSDK.Api;
//流量分组
Dictionary<string, string> customMap = {};
//local自定义Map,仅Android支持
Dictionary<string, object> localParams = {};
//设置附加参数 extra
TPNativeExtra extra = new TPNativeExtra();
extra.x = 0;
extra.y = 0;
extra.width = 320;
extra.height = 200;
extra.adPosition = TradplusBase.AdPosition.TopLeft;
extra.customMap = customMap;
extra.localParams = localParams;
extra.openAutoLoadCallback = false;
//请求广告
TradplusNative.Instance().LoadNativeAd("在TP平台创建的广告位ID", extra);
参数说明
unitId:TradPlus后台创建的广告位ID
- 开发者需正确填入,例如:unitId设置前后有空格,均会导致广告因拉不到配置而请求失败。
TPNativeExtra:额外参数
- x:坐标 x,默认 0。
- y:坐标 y,默认 0。
- width:宽度,默认 320。
- height:高度,默认 200。
- adPosition:屏幕位置定位(当 x y 都为 0 时生效),默认TopLeft。
- customMap:设置流量分组 相关属性参数
- localParams:设置本地参数。仅Android支持。个别广告平台特殊需要设定的参数。
2、检查是否有可用广告
- 建议开发者展示广告前,调用该API判断是否有可用广告,有广告再调用show方法
- true表示有可用广告,false表示暂时无可用广告
bool isReady = TradplusNative.Instance().NativeAdReady("在TP平台创建的广告位ID");
3、进入广告场景 (可选)
TradplusNative.Instance().EntryNativeAdScenario("在TP平台创建的广告位ID", "sceneId");
参数说明
sceneId :广告场景ID
- 开发者可在在TradPlus后台创建,位置如下:应用管理--广告场景。
- 具体如何调用,可以参考广告场景的调用时机和用途说明。
- 进入广告场景时传入sceneId,展示广告时也需传入sceneId,否则会影响统计。
4、展示广告
//调用展示前先判断是否有广告
bool isReady = TradplusNative.Instance().NativeAdReady("unitId");
if(isReady)
{
//展示广告 如果没有样式需求,className可不传
TradplusNative.Instance().ShowNativeAd("unitId", "sceneId","className");
}
参数说明
className :模版名称
- 开发者可以通过此参数,设置标准原生的渲染模版,默认会使用插件自带的模版进行渲染
- iOS默认模版位置在 Assets/Plugins/IOS 目录下 ( TPNativeTemplate.h,TPNativeTemplate.m,TPNativeTemplate.xib )
- Android默 认模版已经打在tradplus的插件中,开发者无需再次引用。
5、隐藏已展示的广告
TradplusNative.Instance().HideNative("在TP平台创建的广告位ID");
6、显示已隐藏的广告
TradplusNative.Instance().DisplayNative("在TP平台创建的广告位ID");
7、销毁广告
TradplusNative.Instance().DestroyNative("在TP平台创建的广告位ID");
8、监听回调
参数说明
-
adInfo:广告位ID、三方广告平台、ecpm等信息。 具体请参考 Android 回调信息说明, iOS 回调信息说明
-
error:广告请求失败、广告展示失败的错误信息。 具体请参考 错误码、错误信息说明。
常用回调
// 广告加载成功
TradplusNative.Instance().OnNativeLoaded += OnlLoaded;
// 广告加载失败
TradplusNative.Instance().OnNativeLoadFailed += OnLoadFailed;
// 广告展示成功
TradplusNative.Instance().OnNativeImpression += OnImpression;
// 广告展示失败
TradplusNative.Instance().OnNativeShowFailed += OnShowFailed;
// 广告点击
TradplusNative.Instance().OnNativeClicked += OnClicked;
// 广告关闭
TradplusNative.Instance().OnNativeClosed += OnClosed;
// 每层waterfall加载失败时回调
TradplusNative.Instance().OnNativeOneLayerLoadFailed += OnOneLayerLoadFailed;
void OnlLoaded(string adunit, Dictionary<string, object> adInfo)
{
// 广告加载成功
//v1.1.2优化回调方式,一次loadAd对应一次loaded回调,不调用不回调。
}
void OnLoadFailed(string adunit, Dictionary<string, object> error)
{
// 广告加载失败
}
void OnImpression(string adunit, Dictionary<string, object> adInfo)
{
// 广告展示成功
}
void OnShowFailed(string adunit, Dictionary<string, object> adInfo, Dictionary<string, object> error)
{
// 广告展示失败
}
void OnClicked(string adunit, Dictionary<string, object> adInfo)
{
// 广告点击
}
void OnClosed(string adunit, Dictionary<string, object> adInfo)
{
// 广告关闭
}
void OnOneLayerLoadFailed(string adunit, Dictionary<string, object> adInfo, Dictionary<string, object> error)
{
// 每层waterfall加载失败时回调
}
广告源维度回调监听(可选)
//每次调用load方法时返回的回调
TradplusNative.Instance().OnNativeStartLoad += OnStartLoad;
//Bidding开始(每有一个bidding广告源回调一次)
TradplusNative.Instance().OnNativeBiddingStart += OnBiddingStart;
//Bidding加载结束(每有一个bidding广告源回调一次)
TradplusNative.Instance().OnNativeBiddingEnd += OnBiddingEnd;
//每层waterfall开始加载时回调
TradplusNative.Instance().OnNativeOneLayerStartLoad += OnOneLayerStartLoad;
//每层waterfall加载成功时回调
TradplusNative.Instance().OnNativeOneLayerLoaded += OnOneLayerLoaded;
//视频播放开始
TradplusNative.Instance().OnNativeVideoPlayStart += OnVideoPlayStart;
//视频播放结束
TradplusNative.Instance().OnNativeVideoPlayEnd += OnVideoPlayEnd;
//加载流程结束
TradplusNative.Instance().OnNativeAllLoaded += OnAllLoaded;
//调用load之后如果收到此回调,说明广告位仍处于加载状态,无法触发新的一轮广告加载。V1.0.5 新增回调
TradplusNative.Instance().OnNativeIsLoading += OnAdIsLoading;
void OnStartLoad(string adunit, Dictionary<string, object> adInfo)
{
//每次调用load方法时返回的回调
}
void onAdIsLoading(string unitId)
{
//调用load之后如果收到此回调,说明广告位仍处于加载状态,无法触发新的一轮广 告加载。V1.0.5 新增回调
}
void OnBiddingStart(string adunit, Dictionary<string, object> adInfo)
{
//Bidding开始(每有一个bidding广告源回调一次)
}
void OnBiddingEnd(string adunit, Dictionary<string, object> adInfo, Dictionary<string, object> error)
{
//Bidding加载结束(每有一个bidding广告源回调一次)
}
void OnOneLayerStartLoad(string adunit, Dictionary<string, object> adInfo)
{
//每层waterfall开始加载时回调
}
void OnOneLayerLoaded(string adunit, Dictionary<string, object> adInfo)
{
//每层waterfall加载成功时回调
}
void OnVideoPlayStart(string adunit, Dictionary<string, object> adInfo)
{
//视频播放开始
}
void OnVideoPlayEnd(string adunit, Dictionary<string, object> adInfo)
{
//视频播放结束
}
void OnAllLoaded(string adunit, bool isSuccess)
{
//加载流程结束
// isSuccess 返回true,表示此次请求,有广告源加载成功
// isSuccess 返回false,表示此次请求,广告位adUnitId下所有广告源加载失败
}
下载监听 快手、穿山甲支持(可选)(仅Android支持)
void OnDownloadStart(string adunit, Dictionary<string, object> adInfo, int totalBytes,int currBytes, string fileName,string appName )
{
// 开始下载回调
// totalBytes:文件总大小(单位:字节)
// currBytes:当前已下载的大小(单位:字节)
// fileName:文件名称
// appName:文件对应的应用名称
}
void OnDownloadUpdate(string adunit, Dictionary<string, object> adInfo, int totalBytes, int currBytes, string fileName, string appName,int progress)
{
// 下载进度更新回调
// progress:下载进度
}
void OnDownloadPause(string adunit, Dictionary<string, object> adInfo, int totalBytes, int currBytes, string fileName, string appName)
{
// 暂停下载回调
}
void OnDownloadFinish(string adunit, Dictionary<string, object> adInfo, int totalBytes, int currBytes, string fileName, string appName)
{
// 下载完成回调
}
void OnDownloadFailed(string adunit, Dictionary<string, object> adInfo, int totalBytes, int currBytes, string fileName, string appName)
{
// 下载失败回调
}
void OnInstallled(string adunit, Dictionary<string, object> adInfo, int totalBytes, int currBytes, string fileName, string appName)
{
// Apk安装完成回调
}