English
Log In
You can then view all documents
成长工具/短剧SDK/短剧SDK接入_Android/工程配置及初始化说明
工程配置及初始化说明
Last updated 2024-02-05 16:54:18

尊敬的开发者,为保护用户的合法权益和个人信息,请您详细查阅本文档说明,根据您应用内具体集成的短剧SDK情况及短剧SDK隐私政策短剧SDK合规使用说明的指引进行合规接入,同时在您的应用隐私政策中对短剧SDK以及数据交互情况进行披露,并需获得个人信息主体的授权同意。

短剧SDK合规使用说明 :https://www.csjplatform.com/terms/28122

短剧SDK隐私政策 : https://www.csjplatform.com/terms/28123

短剧SDK第三方信息共享清单 : https://www.csjplatform.com/terms/28120

短剧SDK应用权限申请与使用情况说明 : https://www.csjplatform.com/terms/28121

一、工程配置

新老版本兼容适配:如果您同时接入了新旧版本(DPSdk & DJXSdk ),需要参考以下说明进行修复

新旧版本验证:

  1. 老版本接入验证:搜索工程确认是否有引入 implementation('com.pangle.cn:pangrowth-sdk:3.9.x.x')
  2. 新版本接入验证:新版本支持maven依赖的方式,当前版本是1.1.0.2,请以平台生成的赋能版本为准。

版本兼容适配:如果存在库冲突,可以将老版本即DPSdk 3902升级到4110即可,若还有问题请联系穿山甲对接同学。

如果开发者同时接入快手SDK,请联系快手方技术支持关闭崩溃收集功能,避免特定机型上偶现崩溃问题

1、添加 Maven 仓库

打开project级别的build.gradle,添加如下两个仓库

复制

2、添加依赖

在app module的build.gradle文件的dependencies中添加,版本号以赋能平台勾选组件生成maven命令为准,获取方式如下图所示

为保证开发者实时接入稳定版本,需要在dependencies中添加如下依赖,版本号以赋能平台生成的maven命令为准

版本兼容适配:如果存在库冲突,可以将老版本即DPSdk 3902升级到 4110即可,若还有问题请联系穿山甲对接同学。

复制


3、权限申请

复制

二、初始化

1、获取配置文件

在内容输出->接入管理模块找到需要接入短剧SDK的应用,点击"下载SDK参数配置",然后将SDK配置文件(例如 sdk_setting_file.json)拷贝到项目的 assets 文件夹下。

注意:小视频SDK「DPSdk」升级到短剧SDK「DJXSdk」,一定要更新配置文件,否则初始化会失败。

2、初始化

复制

3、启动服务

在用户同意隐私权限后,使用SDK具体场景(如创建短剧聚合页),必须先调用init接口,然后调用start接口,并在start结果成功回调之后才能使用具体的场景功能启动,建议在较早的时间启动Sdk。

①、启动服务之前请确保短剧 SDK 已被初始化;

②、在穿山甲广告 SDK 初始化成功的回调中 InitCallback.success 启动短剧 SDK;

广告SDK初始化成功的回调:穿山甲5600 以下版本在 TTAdSdk.init() 方法中,5600及以上版本在 TTAdSdk.start() 方法中

③、其他聚合 SDK 需自行判断穿山甲广告 SDK 初始化完成状态,在初始化成功后再启动短剧 SDK;

复制

4、SDK 配置说明

4.1 DJXSdkConfig SDK 配置参数

复制

4.2 IDJXPrivacyController 隐私合规开关

复制

4.3 IDJXToastController Toast 回调监听

复制

4.4 DJXUpdate 个性化控制器

复制

5、其他说明【⚠️必读⚠️】

  1. 建议在接入调试时打开 DJXSdkConfig.Builder().setDebug(true),SDK 会输出日志并给出 toast 提示;
  2. 在使用 SDK 时尽量保证已获取到权限:文件读写权限、read_phone权限;
  3. 混淆配置已经打入 AAR 中,不需要做额外处理;
  4. 资源混淆说明:如果宿主接入了类似ResGuard的资源混淆框架,也需要将resName加入到这类框架的白名单中。resName可以直接从文件zeus_keep_res_djxsdk.xml中copy需要keep的resName;
  5. so库支持的架构为 armeabi-v7a 和 armeabi-v8a;
  6. 请自查是是否单独申请过火山引擎平台的appid/单独接入过applog,即若其他业务侧生成的appid和穿山甲侧不同,开发者可以自行处理applog相关逻辑;若开发者有接入穿山甲赋能其他 SDK,需确保其初始化时机早于短剧 sdk,否则会导致短剧 sdk 不能正常工作&媒体自己的埋点失效。


Contents
Contact us