跳到主要内容

原生横幅

1、请求广告​

using TradplusSDK.Api;

//流量分组
Dictionary<string, string> customMap = {};
//local自定义Map，仅Android支持
Dictionary<string, object> localParams = {};

//设置附加参数 extra
TPNativeBannerExtra extra = new TPNativeBannerExtra();
extra.x = 0;
extra.y = 0;
extra.width = 320;
extra.height = 50;
extra.closeAutoShow = false;
extra.adPosition = TradplusBase.AdPosition.TopLeft;
extra.customMap = customMap;
extra.localParams = localParams;
extra.className = "className";
extra.openAutoLoadCallback = false;

//请求广告
TradplusNativeBanner.Instance().LoadNativeBannerAd("在TP平台创建的广告位ID", sceneId, extra);

参数说明

unitId：TradPlus后台创建的广告位ID​
  • 开发者需正确填入，例如：unitId设置前后有空格，均会导致广告因拉不到配置而请求失败。
sceneId ：广告场景ID​
  • 开发者可在在TradPlus后台创建，位置如下：应用管理--广告场景。
  • 具体如何调用，可以参考广告场景的调用时机和用途说明。
  • 进入广告场景时传入sceneId，展示广告时也需传入sceneId，否则会影响统计。
TPNativeBannerExtra：额外参数​
  • x：坐标 x，默认 0。
  • y：坐标 y，默认 0。
  • width：宽度，默认 320。
  • height：高度，默认 50。
  • adPosition：屏幕位置定位（当 x y 都为 0 时生效），默认TopLeft。
  • closeAutoShow：是否关闭自动展示 。默认开启自动展示，传入true关闭。
  • customMap：设置流量分组 相关属性参数
  • localParams：设置本地参数。仅Android支持。个别广告平台特殊需要设定的参数。
  • className：原生横幅的渲染模版名称，可不设置。SDK会使用默认模版进行渲染

2、检查是否有可用广告​

  • 建议开发者展示广告前，调用该API判断是否有可用广告,有广告再调用show方法
  • true表示有可用广告，false表示暂时无可用广告
bool isReady = TradplusNativeBanner.Instance().NativeBannerAdReady("在TP平台创建的广告位ID");

3、进入广告场景 (可选)​

TradplusNativeBanner.Instance().EntryNativeBannerAdScenario("在TP平台创建的广告位ID", "sceneId");

4、展示广告​

此接口配合 closeAutoShow 关闭自动展示时使用

//调用展示前先判断是否有广告
bool isReady = TradplusNativeBanner.Instance().NativeBannerAdReady("在TP平台创建的广告位ID");
if(isReady)
{
	//展示广告
	TradplusNativeBanner.Instance().ShowNativeBannerAd("在TP平台创建的广告位ID", "sceneId");
}

5、隐藏已展示的广告​

//隐藏已展示的广告
TradplusNativeBanner.Instance().HideNativeBanner("在TP平台创建的广告位ID");

6、显示已隐藏的广告​

//显示已隐藏的广告
TradplusNativeBanner.Instance().DisplayNativeBanner("在TP平台创建的广告位ID");

7、销毁广告​

//销毁广告
TradplusNativeBanner.Instance().DestroyNativeBanner("在TP平台创建的广告位ID");

8、监听回调​

参数说明

常用回调​

// 广告加载成功
TradplusNativeBanner.Instance().OnNativeBannerLoaded += OnlLoaded;
// 广告加载失败
TradplusNativeBanner.Instance().OnNativeBannerLoadFailed += OnLoadFailed;
// 广告展示成功
TradplusNativeBanner.Instance().OnNativeBannerImpression += OnImpression;
//广告展示失败
TradplusNativeBanner.Instance().OnNativeBannerShowFailed += OnShowFailed;
//广告点击
TradplusNativeBanner.Instance().OnNativeBannerClicked += OnClicked
//每层waterfall加载失败时回调
TradplusNativeBanner.Instance().OnNativeBannerOneLayerLoadFailed += 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 OnOneLayerLoadFailed(string adunit, Dictionary<string, object> adInfo, Dictionary<string, object> error)
{
	//每层waterfall加载失败时回调
}

广告源维度回调监听(可选)​


//每次调用load方法时返回的回调 
TradplusNativeBanner.Instance().OnNativeBannerStartLoad += OnStartLoad;
//Bidding开始(每有一个bidding广告源回调一次)
TradplusNativeBanner.Instance().OnNativeBannerBiddingStart += OnBiddingStart;
//Bidding加载结束(每有一个bidding广告源回调一次)
TradplusNativeBanner.Instance().OnNativeBannerBiddingEnd += OnBiddingEnd;
//每层waterfall开始加载时回调
 TradplusNativeBanner.Instance().OnNativeBannerOneLayerStartLoad += OnOneLayerStartLoad;
//每层waterfall加载成功时回调
TradplusNativeBanner.Instance().OnNativeBannerOneLayerLoaded += OnOneLayerLoaded;
//加载流程结束
TradplusNativeBanner.Instance().OnNativeBannerAllLoaded += OnAllLoaded;
//调用load之后如果收到此回调，说明广告位仍处于加载状态，无法触发新的一轮广告加载。V1.0.5 新增回调
TradplusNativeBanner.Instance().OnNativeBannerIsLoading += OnAdIsLoading;、

void OnStartLoad(string adunit, Dictionary<string, object> adInfo)
{
	//每次调用load方法时返回的回调 
}

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 onAdIsLoading(string unitId)
{
	//调用load之后如果收到此回调，说明广告位仍处于加载状态，无法触发新的一轮广告加载。V1.0.5 新增回调
}

void OnOneLayerStartLoad(string adunit, Dictionary<string, object> adInfo)
{
	//每层waterfall开始加载时回调
}

void OnOneLayerLoaded(string adunit, Dictionary<string, object> adInfo)
{
	//每层waterfall加载成功时回调
}

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安装完成回调
}