WebApp快捷打包
穿山甲内容输出
转到模块插件

敬告:此 DEMO 演示为开放测试页面,仅用于开发者快速测试体验应用功能,请严格遵守开发者协议,了解更多

JS-SDK 引用方式:

♦ 普通网页 script 方式加载:下载最新版 jsBridge-v20240326.zip,请在页面上调用 jsBridge 接口之前引用 jsbridge-mini.js 库;

♦ js module 方式引用:npm install ym-jsbridge 具体请参考 npm package

♦ 今日头条 穿山甲内容输出,去申请接入 内容输出

init 初始化

oldPartner:

oldUUID:

newUser:

//调用展示接口之前必须成功初始化
jsBridge.ttDp.init({
  //字符串,通过API方式对接的合作方身份
  oldPartner: $("#init_oldPartner").val(),
  //字符串,通过API方式对接时传给字节的用户身份标识
  oldUUID: $("#init_oldUUID").val(),
  //字符串,是否新用户
  newUser: JSON.parse($("#init_newUser").val()),
  //数字,新手保护时间,单位秒,最长可以设置为432000s(如果需要对接,需要联系穿山甲商务或者技术支持开通权限)
  aliveSeconds: 0
}, function(succ, data) {
  alert(succ ? "初始化成功" : JSON.stringify(data));
});

事件监听

setListener 设置监听器

• 如需接口调用事件,请设置此监听器;

jsBridge.ttDp.setListener(function(event, data) {
    switch (event) {
        //广告
        case "ad": {
            switch (data.action) {
                //广告请求
                case "onDPAdRequest": {
                    break;
                }
                //广告请求成功
                case "onDPAdRequestSuccess": {
                    break;
                }
                //广告请求失败
                case "onDPAdRequestFail": {
                    break;
                }
                //广告填充失败
                case "onDPAdFillFail": {
                    break;
                }
                //广告曝光
                case "onDPAdShow": {
                    break;
                }
                //广告开始播放
                case "onDPAdPlayStart": {
                    break;
                }
                //广告暂停播放
                case "onDPAdPlayPause": {
                    break;
                }
                //广告继续播放
                case "onDPAdPlayContinue": {
                    break;
                }
                //广告播放结束
                case "onDPAdPlayComplete": {
                    break;
                }
                //广告被点击
                case "onDPAdClicked": {
                    break;
                }
            }
            break;
        }
        //非广告(短视频)
        case "draw": {
            switch (data.action) {
                //刷新任务完成(数据刷新完成)
                case "onDPRefreshFinish": {
                    break;
                }
                //页面切换
                case "onDPPageChange": {
                    break;
                }
                //视频播放
                case "onDPVideoPlay": {
                    break;
                }
                //视频暂停
                case "onDPVideoPause": {
                    break;
                }
                //频继续播放
                case "onDPVideoContinue": {
                    break;
                }
                //视频播放完成
                case "onDPVideoCompletion": {
                    break;
                }
                //视频播放结束
                case "onDPVideoOver": {
                    break;
                }
                //界面关闭
                case "onDPClose": {
                    break;
                }
                //举报结果
                case "onDPReportResult": {
                    break;
                }
                //开始请求
                case "onDPRequestStart": {
                    break;
                }
                //请求成功
                case "onDPRequestSuccess": {
                    break;
                }
                //请求失败
                case "onDPRequestFail": {
                    break;
                }
                //点击作者头像
                case "onDPClickAvatar": {
                    break;
                }
                //击作者昵称
                case "onDPClickAuthorName": {
                    break;
                }
                //点击评论
                case "onDPClickComment": {
                    break;
                }
                //点赞
                case "onDPClickLike": {
                    break;
                }
                //点击更多-分享
                case "onDPClickShare": {
                    break;
                }
            }
            break;
        }
    }
    //此函数仅用于显示回调参数在本 DEMO 页面上
    showResult({
        event: event,
        data: data
    });
});

//请拉到页面底部查看回调数据信息
$('html,body').animate({ scrollTop: $('#view').offset().top }, 500);

/**
回调参数说明:
event - 事件代码,字符串类型
data  - 事件数据,JSON 对象
**/

removeListener 移除监听器

//移除监听器,不会再收到回调通知
//在需要时可重新调用 setListener
jsBridge.ttDp.removeListener();

requestPermissionIfNecessary 请求权限

//非必须的,即使没有权限也不影响广告展示
//但建议请求权限,可优化投放广告精准度和用户的交互体验,提高eCPM
jsBridge.ttDp.requestPermissionIfNecessary();

展示

video 沉浸式小视频

content:

channel:

role:

jsBridge.ttDp.video({
  //字符串,内容
  //video 视频
  //live  直播
  //all   全部
  content: $("#video_content").val(),
  //字符串,渠道
  //recommend 推荐
  //follow    关注
  //all       全部
  channel: $("#video_channel").val(),
  //字符串,一起看视频角色
  //host 主控端
  //user 被控端
  //none 普通模式
  role: $("#video_role").val(),
  //字符串,视频场景,内容定制业务必传
  scene: "",
  //数字,仅在一起看视频主控端生效,传入携带的groupid
  hostGroupId: -1,
  //布尔,是否显示可以显示新手引导动画
  showGuide: false,
  //布尔,是否隐藏关注功能
  hideFollow: false,
  //布尔,是否隐藏频道名称
  hideChannelName: false,
  //布尔,是否支持下拉刷新
  enableRefresh: true
}, function(succ, data) {
  if (!succ) {
    alert(JSON.stringify(data));
  }
});

grid 宫格小视频

style:

jsBridge.ttDp.grid({
  //字符串,标题
  title: "好看小视频",
  //字符串,样式
  //normal    宫格卡片普通样式
  //staggered 宫格卡片瀑布流样式
  style: $("#grid_style").val(),
  //字符串,视频场景,内容定制业务必传
  scene: "",
  //布尔,是否支持下拉刷新
  enableRefresh: true
}, function(succ, data) {
  if (!succ) {
    alert(JSON.stringify(data));
  }
});

userProfile 个人主页

page:

jsBridge.ttDp.userProfile({
  //字符串,页面内容
  //home     全部
  //favorite 喜欢
  //focus    关注
  page: $("#userProfile_page").val(),
  //字符串,视频场景,内容定制业务必传
  scene: ""
}, function(succ, data) {
  if (!succ) {
    alert(JSON.stringify(data));
  }
});

监听回调数据: