中文
登录
后可查看全部文档
成长工具/内容输出/内容SDK/内容SDK_iOS/工程配置及初始化说明
工程配置及初始化说明
最近更新 2024-11-18 14:21:57

尊敬的开发者,为保护用户的合法权益和个人信息,请您详细查阅本文档说明,根据您应用内具体集成的内容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

简介

内容SDK目前支持短剧和短故事能力:

  1. 短剧可以提供给用户竖版短视频场景下的看剧体验。接入方式分为封装形式和接口形式,封装形式包含了聚合页和广告部分,由聚合页来完成变现;接口形式提供给开发者短剧列表接口和播放功能,变现部分由开发者实现。
  2. 短故事可以给用户提供沉浸式的阅读体验,开发者可以使用短故事聚合页或者请求短故事接口自定义首页,同时支持插入段间广告、章间广告、banner广告,开发者自定义插入解锁点(SDK直出广告或者自定义广)来实现变现。

运行环境

  •   支持系统 iOS 12.x 及以上;
  •   SDK编译环境 Xcode 14 及以上;
  •   支持架构 arm64, x86_64;

一、SDK集成

1、接入穿山甲广告SDK

请参考穿山甲媒体平台先接入广告SDK,建议使用56xx及以上版本。

对于您可能使用穿山甲广告SDK或融合SDK,可参考如下方式进行配置隐私信息的获取

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

2、接入内容SDK

2.1 CocoaPods方式接入

为保证开发者实时接入稳定版本,建议使用CocoaPods的方式集成版本号以赋能平台生成的maven命令为准

版本兼容适配:

V2202及以下版本:如果开发者同时有接入内容SDK和点播(存在库冲突),可以将短剧组件的依赖djx-dynamic升级为djx-dynamic-lite即可

V2300及以上版本:①无-lite后缀版本(剔除点播),默认将点播引用单独拆出来引用,规避点播冲突的问题;②后续只支持动态引入,去除dynamic后缀

新点播接入配置

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

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

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

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

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

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

工程配置

第一步:在工程的podfile中添加代码

SDK文件为demo工程根目录下的PangrowthDJX,接入方式参考Podfile,具体如下:

复制

第二步:运行 pod install 命令安装SDK

运行 pod install 不会自动更新 repo,如果下载的不是最新版,可使用 pod install —repo-update 更新或先运行 pod repo update。

复制

二、SDK初始化

1、获取配置文件

在内容输出->接入管理模块找到需要接入内容SDK的应用,点击"下载SDK参数配置",然后将SDK配置文件(例如 sdk_setting_file.json)拖拽到app工程内,并勾选[Copy items if needed]

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


2、初始化

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

复制

3、启动服务

开发者可在进入实际场景前再启动SDK,需要在穿山甲广告SDK初始化成功后再启动内容SDK。

复制

初始化配置

复制

最佳实践

短剧

复制

短故事

复制

4、SDK 配置说明

4.1 隐私合规开关

内容sdk为您提供可选个人信息配置选项,通过以下配置接口,您可以实现不获取内容sdk自身的可选信息。

对于您可能使用穿山甲广告SDK或融合SDK,可参考如下方式进行配置隐私信息的获取

  1. 穿山甲广告SDK隐私开关配置:https://www.csjplatform.com/supportcenter/5378
  2. 融合 SDK隐私开关配置:登录穿山甲媒体平台-接入测试中心查看接入文档的隐私信息合规说明模块进行配置 https://www.csjplatform.com/union/media/union/download/detail?id=197&docId=27491&locale=zh-CN&osType=ios
复制

4.2 个性化开关

复制


本篇目录
联系我们