短剧-接口方式接入

一、获取短剧信息

1、请求短剧详情

注意：短剧内容库是持续实时更新的，不定期会有短剧上新或下线，为了保证更好的使用效果，开发者应实时请求接口获取短剧信息，不要自行存储短剧封面、分类等内容，再做页面渲染。否则可能会出现某部短剧页面渲染了，但实际该短剧已下线无法播放的情况，影响用户体验。

如果您自行渲染页面，可参考以下方式做产品设计： 人工在服务端配置聚合页/列表页的短剧排序。在页面加载时，实时请求接口拉取物料进行页面渲染；如拉取失败，则不展示该短剧，顺位展示下个短剧。避免因短剧下线影响线上展示/播放。

说明	方法名
批量获取所有短剧	`DPSdk.factory().requestAllDrama(int page, int count, boolean order, DramaCallback callback)`
通过个性化推荐顺序获取所有短剧	`DPSdk.factory().requestAllDramaByRecommend(int page, int count, DramaCallback callback);`
通过指定短剧id获取对应短剧信息	`DPSdk.factory().requestDrama(List<Long> dramaIds, DramaCallback callback)`
通过分类请求短剧	`DPSdk.factory().requestDramaByCategory(String category, int page, int count, DramaCallback callback)`
通过搜索请求短剧	`DPSdk.factory().searchDrama(String query, boolean isFuzzy, int page, int count, DramaCallback callback)`
获取短剧历史记录	`DPSdk.factory().getDramaHistory(int page, int count, DramaCallback callback)`
清理短剧历史记录	`DPSdk.factory().clearDramaHistory(DramaCallback callback)`
上报短剧自建聚合页 log/埋点信息	`DPSdk.factory().uploadDramaHomeLog(NonNull DPDramaLog dramaLog)`

复制

2、接口说明

DPDrama类说明，请参考短剧信息DPDrama说明

二、加载短剧播放页Fragment

接入方可以调用DPSdk.factory().createDramaDetail(DPWidgetDramaDetailParams params)来获取fragment，将获取到的聚合播放页fragment放入到自己app中即可。若设置短剧详情页为非封装模式穿山甲仅提供播放页面和播放回调接口，开发者自行设计激励解锁逻辑，然后调用SDK播放接口进行短剧播放。

代码片段示例

详细请参考Demo中DramaApiDetailActivity实现

复制

三、接口说明

1、获取组件工厂

复制

2、创建组件

复制

3、组件IDPWidget说明

IDPWidget类说明，请参考组件IDPWidget说明

4、组件参数DPWidgetDramaDetailParams说明

复制

5、短剧详情页配置 DPDramaDetailConfig

DPDramaDetailConfig类说明，请参考短剧详情页DPDramaDetailConfig配置；

6、监听器IDPDramaListener说明

短剧播放详情新增无限下滑功能，播放至短剧最后一集时继续上拉会切换新的短剧，并通过onDramaSwitch回调通知开发者（接口接入必须实现该回调）

IDPDramaListener类说明，请参考内流短剧详情页IDPDramaListener回调；

7、监听器IDPAdListener说明

IDPDramaListener类说明，请参考广告监听器IDPAdListener；

8、短剧埋点结构 DPDramaLog（赋能3800新增）

复制

四、使用说明

开发者需要在短剧上实现自己的激励视频广告时，需要按照以下步骤进行设置(详细请参考Demo DramaApiDetailActivity示例)：

创建短剧播放页Fragment
实现IDPDramaListener.isNeedBlock回调判断是否需要解锁才能观看，如果需要阻塞视频播放，并返回true
实现IDPDramaListener.showAdIfNeeded回调，实现广告展示逻辑，在广告奖励发放时，调用callback.onDramaRewardArrived进行短剧播放

本篇目录