帮助中心

中文

后可查看全部文档

帮助文档

新手引导

合作注册

流量管理

开发测试

财务结算

业务规范

GroMore

AdSpark（增长参谋）

成长工具

工程配置及初始化说明

最近更新 2024-11-18 14:21:51

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

内容SDK合规使用说明：https://www.csjplatform.com/terms/28122

内容SDK隐私政策：https://www.csjplatform.com/terms/28123

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

一、工程配置

新老版本兼容适配：

如果您同时接入了新旧版本(小视频DPSdk & V1.0内容 DJXSdk )，需要参考以下说明进行修复

新旧版本验证：

老版本接入验证：搜索工程确认是否有引入 implementation('com.pangle.cn:pangrowth-sdk:4.2.x.x')
新版本接入验证：当前版本是2.3.x.x，请以平台生成的赋能版本为准。

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

如果您接入了 V2.0 内容SDK「短剧+短故事」，需要参考以下说明进行升级

依赖：参考添加依赖模块说明，增加基础组件(pangrowth-base，必须接入)、短剧组件(pangrowth-djx-sdk，可选接入)、短故事组件(pangrowth-nov-sdk，可选接入)
初始化：

只接入短剧能力：开发者升级到内容SDK 2.0版本，依赖如上所示(base+djx)，初始化逻辑没有变动「DJXSdk.init( )」；
只接入短故事能力：开发者升级到内容SDK 2.0版本，依赖如上所示(base+nov)，初始化逻辑「NovSDK.init( )」
短剧+短故事功能，开发者升级到内容SDK 2.0版本，依赖如上所示(base+djx+nov)，初始化逻辑「 DJXSdk.init( ) + NovSDK.init( ) 」

功能使用说明：内容SDK 2.0版本支持短剧和短故事能力，开发者可以根据实际业务情况进行接入

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

1、添加 Maven 仓库

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

复制

2、添加依赖

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

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

版本兼容适配：

小视频SDK(DPSDK)接入说明

如果小视频SDK和内容SDK存在库冲突(小视频和内容SDK的短剧模块底层都有播放器相关能力)，可以将小视频SDK升级到 4210即可，若还有问题请联系穿山甲对接同学。

4210(剔除点播，① 小视频和内容SDK-短剧组件同时接入时使用；②额外有单独引入点播SDK)
4200(带点播，单独接入小视频或和内容SDK-短故事组件同时接入时使用，保证底层只有一个点播即可

内容SDK接入说明

如果开发者同时有接入内容SDK和点播(存在库冲突)，2300以前版本可以将短剧组件的依赖pangrowth-djx-sdk升级为pangrowth-djx-sdk-lite即可，2300及以后版本内容SDK会通过pom默认将新点播版本引入(支持倍速功能及稳定性提升)，即短剧组件由pangrowth-djx-sdk变更为pangrowth-djx-sdk-lite，同时老版本pangrowth-djx-sdk依然会同步到外网，媒体可以自行依赖使用

内容2300及以上版本，因为内容SDK默认是lite剔除点播的版本，小视频可以使用4200(带点播)，保证底层只有一个点播即可
若媒体单独引入的点播版本大于短剧组件：IDE会自动升级，理论上无需处理。极端情况可能遇到短剧sdk还未适配高版本点播接口，发版适配即可。
若媒体单独引入的点播版本小于短剧组件，两种解决方案：1剔除短剧组件版本(exclude group: 'com.bytedanceapi', module: 'ttsdk-player_premium')、2强制固定版本(force 'com.bytedanceapi:ttsdk-player_premium:x.x.x.x')。内容SDK会尽可能保持向下兼容。

新点播接入配置

Android升级后，支持长按倍速功能问题

① 在穿山甲后台>>>，找到自己的应用，下载新的配置文件，并检查格式

② 先点击“包名录入”，可录入多个，需要和真实包名完全匹配

③ 再点击“下载SDK参数配置”，检查本地配置文件格式，内部含license_config列表字段，内层PakageName字段和录入的包名一致

④ 如果license_config没有请联系对接同学

⑤ 工程配置后，如想实现倍速功能请参考常见问题-自定义倍速功能实现

工程配置

复制

3、权限申请

复制

二、初始化

1、获取配置文件

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

注意：小视频SDK「DPSdk」升级到内容SDK「DJXSdk」，一定要更新配置文件，否则初始化会失败。

2、初始化

初始化只执行数据保存相关的操作，不获取个人隐私信息。

内容sdk为您提供可选个人信息配置选项，通过参考文档4.2配置接口，您可以实现不获取内容sdk自身的可选信息。请详细阅读各自的合规使用说明，以了解隐私配置选项。

只接短剧能力：开发者从内容SDK 1.0升级到2.0版本，依赖改动如上所示(base+djx)，初始化逻辑没有变动「DJXSdk.init( )」；

复制

只接短故事能力：开发者从内容SDK 1.0升级到2.0版本，依赖如上所示(base+nov)，初始化逻辑「NovSDK.init( )」

复制

短剧+短故事功能：开发者从内容SDK 1.0升级到2.0版本，依赖如上所示(base+djx+nov)，初始化逻辑「 DJXSdk.init( ) + NovSDK.init( ) 」

复制

3、启动服务

在用户同意隐私权限后，使用SDK具体场景（如创建短剧聚合页），必须先调用init接口，然后调用start接口(初始化init只执行数据保存相关的操作，不获取个人隐私信息)，并在start结果成功回调之后才能使用具体的场景功能启动，建议在较早的时间启动Sdk。
对于您可能使用穿山甲广告SDK或融合SDK，可参考如下方式进行配置隐私信息的获取

穿山甲广告SDK隐私开关配置：https://www.csjplatform.com/supportcenter/5397#18mipxczvs740
融合 SDK隐私开关配置：登录穿山甲媒体平台-接入测试中心查看接入文档的隐私信息合规说明模块进行配置 https://www.csjplatform.com/union/media/union/download/detail?id=195&docId=27616&locale=zh-CN&osType=android

①、在穿山甲广告 SDK 初始化成功的回调中 InitCallback.success 启动内容SDK；

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

②、启动服务之前请确保内容SDK 已被初始化；

③、其他聚合 SDK 需自行判断穿山甲广告 SDK 初始化完成状态，在初始化成功后再启动内容SDK；

复制

4、SDK 配置说明

4.1 DJXSdkConfig SDK 配置参数

复制

4.2 IDJXPrivacyController 隐私合规开关

复制

4.3 IDJXToastController Toast 回调监听

复制

4.4 DJXUpdate 个性化控制器

复制

4.5 StartListener 初始化监听

复制

4.6 错误信息 DJXError 说明

复制

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

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

本篇目录