敬告:此 DEMO 演示为开放测试页面,仅用于开发者快速测试体验应用功能,请严格遵守开发者协议。
♦ JS-SDK 引用方式:
♦ 普通网页 script 方式加载:下载最新版 jsBridge-v20260714.zip,请在页面上调用 jsBridge 接口之前引用 jsbridge-mini.js 库;
♦ js module 方式引用:npm install ym-jsbridge 具体请参考 npm package
事件监听
• 如需接口调用事件,请设置此监听器;
jsBridge.omni.setListener(function(event, data) {
switch (event) {
//开屏广告 jsBridge.omni.splash(...)
case "splash": {
switch (data.action) {
//加载成功
case "onSplashAdSuccessLoad": {
break;
}
//加载失败
case "onSplashAdFailToLoad": {
break;
}
//展示成功
case "onSplashAdSuccessPresent": {
break;
}
//点击
case "onSplashAdClicked": {
break;
}
//关闭
case "onSplashClosed": {
break;
}
}
break;
}
//激励视频 jsBridge.omni.reward(...)
case "reward": {
switch (data.action) {
//加载成功
case "onVideoAdLoadSuccess": {
break;
}
//加载失败
case "onVideoAdLoadError": {
break;
}
//开始播放
case "onVideoAdPlayStart": {
break;
}
//完成播放
case "onVideoAdPlayEnd": {
break;
}
//播放失败
case "onVideoAdPlayError": {
break;
}
//发放奖励
case "onVideoRewarded": {
jsBridge.toast('激励达成')
break;
}
//点击
case "onVideoAdClicked": {
break;
}
//关闭
case "onVideoAdClosed": {
break;
}
}
break;
}
//插屏广告 jsBridge.omni.interstitial(...)
case "interstitial": {
switch (data.action) {
//加载成功
case "onInterstitialAdLoadSuccess": {
break;
}
//加载失败
case "onInterstitialAdLoadError": {
break;
}
//播放开始
case "onInterstitialAdPlayStart": {
break;
}
//播放结束
case "onInterstitialAdPlayEnd": {
break;
}
//播放失败
case "onInterstitialAdPlayError": {
break;
}
//点击
case "onInterstitialAdClicked": {
break;
}
//关闭
case "onInterstitialAdClosed": {
break;
}
}
break;
}
//Banner jsBridge.omni.banner(...)
case "banner": {
switch (data.action) {
//加载成功
case "onAdLoadSuccess": {
break;
}
//加载失败
case "onAdLoadError": {
break;
}
//展示成功
case "onAdShown": {
break;
}
//自动刷新成功
case "onAdAutoRefreshed": {
break;
}
//自动刷新失败
case "onAdAutoRefreshFail": {
break;
}
//点击
case "onAdClicked": {
break;
}
//关闭/移除
case "onAdClosed": {
break;
}
}
break;
}
}
//此函数仅用于显示回调参数在本 DEMO 页面上
showResult({
event: event,
data: data
});
});
//请拉到页面底部查看回调数据信息
$('html,body').animate({ scrollTop: $('#view').offset().top }, 500);
/**
回调参数说明:
event - 事件代码,字符串
data - 事件数据,JSON 对象
**/
//移除监听器,不会再收到回调通知 //在需要时可重新调用 setListener jsBridge.omni.removeListener();
媒体
//获取当前初始化的媒体信息
jsBridge.omni.getMedia(function(success, res) {
/* res: {
appId: string, //媒体应用 ID
splashCodeId: string, //开屏广告ID
adultContent: boolean, //是否为成年用户
personalAd: boolean, //是否启用个性化推荐
debug: boolean, //是否调试模式
initSuccess: boolean, //SDK 是否初始化成功
initErrMsg: string //SDK 初始化失败时的错误描述
}
*/
alert(JSON.stringify(res));
});
appId:
splashCodeId:
adultContent:
personalAd:
debug:
//设置下次启动进程时(冷启动 APP)的初始化媒体信息
jsBridge.omni.setMedia({
//媒体应用 ID
appId: "{{setMedia.appId}}",
//开屏广告位 ID,如果不为空则打开 App 时自动展示开屏广告
splashCodeId: "{{setMedia.splashCodeId}}",
//是否为成年用户
adultContent: {{setMedia.adultContent}},
//是否启用个性化推荐
personalAd: {{setMedia.personalAd}},
//是否启用调试模式
debug: {{setMedia.debug}}
}, function(success, res) {
if (success) {
alert("已设置,请重启进程。");
} else {
alert(JSON.stringify(res));
}
});
展示广告
codeId:
timeout:
//开屏广告
//如果在打包插件上配置了开屏广告位 ID 则无需调用此接口,启动 APP 时会自动调用展示开屏广告。
jsBridge.omni.splash({
//开屏广告位 ID
codeId: "{{splash.codeId}}",
//加载广告超时时间(毫秒)
timeout: {{splash.timeout}}
}, function(success, res) {
if (!success) {
alert(JSON.stringify(res));
}
});
codeId:
userId:
//激励视频
jsBridge.omni.reward({
//广告位 ID
codeId: "{{reward.codeId}}",
//用户ID,一般用于激励视频回调
userId: "{{reward.userId}}",
//任意自定义键值对数据,一般用于激励视频回调
extra: {
hello: '世界',
key: 'reward'
}
}, function(success, res) {
if (!success) {
alert(JSON.stringify(res));
}
});
codeId:
userId:
jsBridge.omni.interstitial({
//广告位 ID
codeId: "{{interstitial.codeId}}",
//用户ID
userId: "{{interstitial.userId}}",
//任意自定义键值对数据
extra: {
hello: '世界',
key: 'interstitial'
}
}, function(success, res) {
if (!success) {
alert(JSON.stringify(res));
}
});
remove:
codeId:
userId:
top:
bottom:
//横幅广告,实际上时浮在web页面上的一块区域
jsBridge.omni.banner({
//是否移除广告,当 true 移除广告时其他参数均可不传
remove: {{banner.remove}},
//广告位 ID
codeId: "{{banner.codeId}}",
//用户ID
userId: "{{banner.userId}}",
//到顶部间距
//当 top >= 0 时以顶部间距为准(忽略 bottom 参数)
//当 top < 0 时以底部的间距为准(忽略 top 参数)
top: {{banner.top}},
//到底部的间距
bottom: {{banner.bottom}},
//任意自定义键值对数据
extra: {
hello: '世界',
key: 'interstitial'
}
}, function(succ, res) {
if (!succ) {
alert(JSON.stringify(res));
}
});
监听回调数据: