接入文档.md 39 KB
KMAdvertisement
广告Framework，远程控制广告显示，可通过以下参数控制
- 显示状态
- 开始结束时间
- APP名称
- 订阅情况
- 平台
- 支持版本
如何接入
- 导入KMAdvertisement.framework
- 导入AFNetworking.framework
- 按照接入示例
功能
接入示例
视图加载方法
1.绑定视图
2.指定视图
//设置基础参数
KMAdvertisementManager.manager.initConfig(appID: .PDFReaderProIOS,
subscribeType: .unsubscribed,
platform: .iOS)
//测试模式，默认false
KMAdvertisementManager.manager.debug = true
unowned let weakSelf = self
//获取广告数据
KMAdvertisementManager.manager.fetchData { data, error in
if data != nil {
for model in data! {
if model.showType == .scroll {
//视图加载方法一
let view = KMAdvertisementManager.manager.show(type: .scroll, data: model, superView: weakSelf.showScrollView) { actionType in
print("点击了 scroll 1")
}
//视图加载方法二
weakSelf.advertisementScroll.inputData = model
weakSelf.advertisementScroll.actionCompletion = { actionItem in
print("点击了 scroll 2")
}
}
if model.showType == .view {
//视图加载方法一
let view = KMAdvertisementManager.manager.show(type: .view, data: model, superView: weakSelf.showView) { actionItem in
print("点击了 view 1")
}
//视图加载方法二
weakSelf.advertisementView.inputData = model
weakSelf.advertisementView.actionCompletion = { actionItem in
print("点击了 view 2")
}
}
}
}
}
数据格式
KMAdvertisementModel
| key | type | example | description |
|---|---|---|---|
| appName | AppNameType | appName: FilmageEditorMac | APP名称 |
| platform | PlatformType | platform: iOS | 平台 |
| showType | ShowType | showType: "List" | APP名称 |
| subscribeType | SubscribeType | subscribeType: "subscribed" | 显示类型 |
| startTime | String 时间戳 | startTime: "1669709056569" | APP名称 |
| endTime | String 时间戳 | endTime: "1709709056569 " | 结束时间 |
| version | String | appName: "1.3.5" | 版本 |
| content | Section | content: [Section] | 内容 |
Section
| key | type | example | description |
|---|---|---|---|
| sectionTitle | Text | sectionTitle: Text | setion标题 |
| content | Conent | content: [ Conent] | 详情 |
Content
| key | type | example | description |
|---|---|---|---|
| index | Int | index: 0 | 下标 |
| title | Text | title: Text | 标题 |
| imageURL | Image | imageURL: Image | 图片链接 |
| ipadImageURL | Image | ipadImageURL: Image | ipad图片链接 |
| linkURL | Language | linkURL: Language | 点击链接 |
| tips | Language | tips: Language | tips |
| button | Text | button: Text | 按钮样式 |
| actionType | ActionType | actionType: "URL" | 响应类型 |
Text
| key | type | example | description |
|---|---|---|---|
| font | Font | font: Font | 字体 |
| color | Color | color: Color | 颜色 |
| background | Background | background: Background | 背景 |
| language | Language | language: Language | 多语 |
Image
| key | type | example | description |
|---|---|---|---|
| height | Language | height: Language | 高亮 |
| normal | Language | normal: Language | 正常 |
| background | Background | background: Background | 背景颜色 |
Language
| key | type | example | description |
|---|---|---|---|
| en | String | en: "en" | 英文 |
| zh_TW | String | zhTW: "繁中" | 繁中 |
| zh_CN | String | zhCN: "简中" | 简中 |
Background
| key | type | example | description |
|---|---|---|---|
| color | Color | color: Color | 颜色 |
| layer | Layer | layer: Color | 图层 |
Color
| key | type | example | description |
|---|---|---|---|
| height | AppNameType | appName: FilmageEditorMac | APP名称 |
| normal | Conent | platform: iOS | 平台 |
ColorState
| key | type | example | description |
|---|---|---|---|
| dark | ColorInfo | dark:{"hex":"#C7C8CC","alpha":1} | 黑暗模式 |
| universal | ColorInfo | universal:{"hex":"#C7C8CC","alpha":1} | 正常模式 |
ColorInfo
| key | type | example | description |
|---|---|---|---|
| hex | String | hex: "#FFFFFF" | 颜色16进制 |
| alpha | Float | alpha: 1.0 | 透明度 |
Text
| key | type | example | description |
|---|---|---|---|
| name | String | name: "AppleSystemUIFont" | 字体名称 |
| size | Int | size: 13 | 字体大小 |
Layer
| key | type | example | description |
|---|---|---|---|
| cornerRadius | Float | cornerRadius: 15 | 圆角 |
| borderWidth | Float | borderWidth: 1 | 边框宽度 |
| borderColor | Color | borderColor: Color | 颜色 |
List
json示例
{
"appName":"FilmageEditorMac",
"platform":"Mac",
"showType":"list",
"version":"1.3.5",
"startTime":"1669709056569",
"endTime":"1689709056569",
"subscribeType":"unsubscribed",
"content":[
{
"sectionTitle":{
"font":{
"name":"AppleSystemUIFont",
"size":13
},
"color":{
"height":{
"dark":{
"hex":"#C7C8CC",
"alpha":1
},
"universal":{
"hex":"#42464D",
"alpha":1
}
},
"normal":{
"dark":{
"hex":"#C7C8CC",
"alpha":1
},
"universal":{
"hex":"#42464D",
"alpha":1
}
}
},
"language":{
"en":"PDF Pro系列",
"zh_TW":"PDF Pro系列",
"zh_CN":"PDF Pro系列"
}
},
"content":[
{
"title":{
"font":{
"name":"AppleSystemUIFont",
"size":13
},
"color":{
"height":{
"dark":{
"hex":"#4E7EDB",
"alpha":1
},
"universal":{
"hex":"#273B61",
"alpha":1
}
},
"normal":{
"dark":{
"hex":"#C7C8CC",
"alpha":1
},
"universal":{
"hex":"#42464D",
"alpha":1
}
}
},
"language":{
"en":"The Warmest Black Friday Deal!",
"zh_TW":"老闆哭了~趁黑色星期五升級Write-on Video Pro最划算!",
"zh_CN":"老板哭了~趁黑色星期五升级V视频Pro最划算!"
},
"tips":{
"en":"The Warmest Black Friday Deal!",
"zh_TW":"老闆哭了~趁黑色星期五升級Write-on Video Pro最划算!",
"zh_CN":"老板哭了~趁黑色星期五升级V视频Pro最划算!"
},
"background":{
"color":{
"height":{
"dark":{
"hex":"#FFFFFF",
"alpha":0.05
},
"universal":{
"hex":"#000000",
"alpha":0.05
}
},
"normal":{
"dark":{
"hex":"#25282B",
"alpha":1
},
"universal":{
"hex":"#FBFCFF",
"alpha":0.05
}
}
},
"layer":{
"cornerRadius":6
}
}
},
"imageURL":{
"height":{
"en":"https://iap-s3.kdanmobile.com/resource/ff29cfce-b64a-46ca-b260-f57c9e3240b8/blackFriday20211020_2x.png",
"zh_TW":"https://iap-s3.kdanmobile.com/resource/ff29cfce-b64a-46ca-b260-f57c9e3240b8/blackFriday20211020_2x.png",
"zh_CN":"https://iap-s3.kdanmobile.com/resource/ff29cfce-b64a-46ca-b260-f57c9e3240b8/blackFriday20211020_2x.png"
},
"normal":{
"en":"https://pdfreader-dev.oss-cn-shanghai.aliyuncs.com/advertise/638858600d7471669879904.png",
"zh_TW":"https://pdfreader-dev.oss-cn-shanghai.aliyuncs.com/advertise/638858600d7471669879904.png",
"zh_CN":"https://pdfreader-dev.oss-cn-shanghai.aliyuncs.com/advertise/638858600d7471669879904.png"
}
},
"linkURL":{
"en":"https://www.pdfreaderpro.com/store",
"zh_TW":"https://www.pdfreaderpro.com/store",
"zh_CN":"https://www.pdfreaderpro.com/store"
}
},
{
"title":{
"font":{
"name":"AppleSystemUIFont",
"size":13
},
"color":{
"height":{
"dark":{
"hex":"#4E7EDB",
"alpha":1
},
"universal":{
"hex":"#273B61",
"alpha":1
}
},
"normal":{
"dark":{
"hex":"#C7C8CC",
"alpha":1
},
"universal":{
"hex":"#42464D",
"alpha":1
}
}
},
"language":{
"en":"The Warmest Black Friday Deal!",
"zh_TW":"老闆哭了~趁黑色星期五升級Write-on Video Pro最划算!",
"zh_CN":"老板哭了~趁黑色星期五升级V视频Pro最划算!"
},
"tips":{
"en":"The Warmest Black Friday Deal!",
"zh_TW":"老闆哭了~趁黑色星期五升級Write-on Video Pro最划算!",
"zh_CN":"老板哭了~趁黑色星期五升级V视频Pro最划算!"
},
"background":{
"color":{
"height":{
"dark":{
"hex":"#FFFFFF",
"alpha":0.05
},
"universal":{
"hex":"#000000",
"alpha":0.05
}
},
"normal":{
"dark":{
"hex":"#25282B",
"alpha":1
},
"universal":{
"hex":"#FBFCFF",
"alpha":0.05
}
}
},
"layer":{
"cornerRadius":6
}
}
},
"imageURL":{
"height":{
"en":"https://iap-s3.kdanmobile.com/resource/ff29cfce-b64a-46ca-b260-f57c9e3240b8/blackFriday20211020_2x.png",
"zh_TW":"https://iap-s3.kdanmobile.com/resource/ff29cfce-b64a-46ca-b260-f57c9e3240b8/blackFriday20211020_2x.png",
"zh_CN":"https://iap-s3.kdanmobile.com/resource/ff29cfce-b64a-46ca-b260-f57c9e3240b8/blackFriday20211020_2x.png"
},
"normal":{
"en":"https://pdfreader-dev.oss-cn-shanghai.aliyuncs.com/advertise/638858600d7471669879904.png",
"zh_TW":"https://pdfreader-dev.oss-cn-shanghai.aliyuncs.com/advertise/638858600d7471669879904.png",
"zh_CN":"https://pdfreader-dev.oss-cn-shanghai.aliyuncs.com/advertise/638858600d7471669879904.png"
}
},
"linkURL":{
"en":"https://www.pdfreaderpro.com/store",
"zh_TW":"https://www.pdfreaderpro.com/store",
"zh_CN":"https://www.pdfreaderpro.com/store"
}
}
]
},
{
"sectionTitle":{
"font":{
"name":"AppleSystemUIFont",
"size":13
},
"color":{
"height":{
"dark":{
"hex":"#C7C8CC",
"alpha":1
},
"universal":{
"hex":"#42464D",
"alpha":1
}
},
"normal":{
"dark":{
"hex":"#C7C8CC",
"alpha":1
},
"universal":{
"hex":"#42464D",
"alpha":1
}
}
},
"language":{
"en":"Filmage 系列",
"zh_TW":"Filmage 系列",
"zh_CN":"Filmage 系列"
}
},
"content":[
{
"title":{
"font":{
"name":"AppleSystemUIFont",
"size":13
},
"color":{
"height":{
"dark":{
"hex":"#4E7EDB",
"alpha":1
},
"universal":{
"hex":"#273B61",
"alpha":1
}
},
"normal":{
"dark":{
"hex":"#C7C8CC",
"alpha":1
},
"universal":{
"hex":"#42464D",
"alpha":1
}
}
},
"language":{
"en":"The Warmest Black Friday Deal!",
"zh_TW":"老闆哭了~趁黑色星期五升級Write-on Video Pro最划算!",
"zh_CN":"老板哭了~趁黑色星期五升级V视频Pro最划算!"
},
"tips":{
"en":"The Warmest Black Friday Deal!",
"zh_TW":"老闆哭了~趁黑色星期五升級Write-on Video Pro最划算!",
"zh_CN":"老板哭了~趁黑色星期五升级V视频Pro最划算!"
},
"background":{
"color":{
"height":{
"dark":{
"hex":"#FFFFFF",
"alpha":0.05
},
"universal":{
"hex":"#000000",
"alpha":0.05
}
},
"normal":{
"dark":{
"hex":"#25282B",
"alpha":1
},
"universal":{
"hex":"#FBFCFF",
"alpha":0.05
}
}
},
"layer":{
"cornerRadius":6
}
}
},
"imageURL":{
"height":{
"en":"https://iap-s3.kdanmobile.com/resource/ff29cfce-b64a-46ca-b260-f57c9e3240b8/blackFriday20211020_2x.png",
"zh_TW":"https://iap-s3.kdanmobile.com/resource/ff29cfce-b64a-46ca-b260-f57c9e3240b8/blackFriday20211020_2x.png",
"zh_CN":"https://iap-s3.kdanmobile.com/resource/ff29cfce-b64a-46ca-b260-f57c9e3240b8/blackFriday20211020_2x.png"
},
"normal":{
"en":"https://pdfreader-dev.oss-cn-shanghai.aliyuncs.com/advertise/638858600d7471669879904.png",
"zh_TW":"https://pdfreader-dev.oss-cn-shanghai.aliyuncs.com/advertise/638858600d7471669879904.png",
"zh_CN":"https://pdfreader-dev.oss-cn-shanghai.aliyuncs.com/advertise/638858600d7471669879904.png"
}
},
"linkURL":{
"en":"https://www.pdfreaderpro.com/store",
"zh_TW":"https://www.pdfreaderpro.com/store",
"zh_CN":"https://www.pdfreaderpro.com/store"
}
},
{
"title":{
"font":{
"name":"AppleSystemUIFont",
"size":13
},
"color":{
"height":{
"dark":{
"hex":"#4E7EDB",
"alpha":1
},
"universal":{
"hex":"#273B61",
"alpha":1
}
},
"normal":{
"dark":{
"hex":"#C7C8CC",
"alpha":1
},
"universal":{
"hex":"#42464D",
"alpha":1
}
}
},
"language":{
"en":"The Warmest Black Friday Deal!",
"zh_TW":"老闆哭了~趁黑色星期五升級Write-on Video Pro最划算!",
"zh_CN":"老板哭了~趁黑色星期五升级V视频Pro最划算!"
},
"tips":{
"en":"The Warmest Black Friday Deal!",
"zh_TW":"老闆哭了~趁黑色星期五升級Write-on Video Pro最划算!",
"zh_CN":"老板哭了~趁黑色星期五升级V视频Pro最划算!"
},
"background":{
"color":{
"height":{
"dark":{
"hex":"#FFFFFF",
"alpha":0.05
},
"universal":{
"hex":"#000000",
"alpha":0.05
}
},
"normal":{
"dark":{
"hex":"#25282B",
"alpha":1
},
"universal":{
"hex":"#FBFCFF",
"alpha":0.05
}
}
},
"layer":{
"cornerRadius":6
}
}
},
"imageURL":{
"height":{
"en":"https://iap-s3.kdanmobile.com/resource/ff29cfce-b64a-46ca-b260-f57c9e3240b8/blackFriday20211020_2x.png",
"zh_TW":"https://iap-s3.kdanmobile.com/resource/ff29cfce-b64a-46ca-b260-f57c9e3240b8/blackFriday20211020_2x.png",
"zh_CN":"https://iap-s3.kdanmobile.com/resource/ff29cfce-b64a-46ca-b260-f57c9e3240b8/blackFriday20211020_2x.png"
},
"normal":{
"en":"https://pdfreader-dev.oss-cn-shanghai.aliyuncs.com/advertise/638858600d7471669879904.png",
"zh_TW":"https://pdfreader-dev.oss-cn-shanghai.aliyuncs.com/advertise/638858600d7471669879904.png",
"zh_CN":"https://pdfreader-dev.oss-cn-shanghai.aliyuncs.com/advertise/638858600d7471669879904.png"
}
},
"linkURL":{
"en":"https://www.pdfreaderpro.com/store",
"zh_TW":"https://www.pdfreaderpro.com/store",
"zh_CN":"https://www.pdfreaderpro.com/store"
}
}
]
}
]
}
View
json示例
{
"appName":"PDFReaderProIOS",
"platform":"iOS",
"showType":"view",
"version":"1.3.5",
"startTime":"1669709056569",
"endTime":"1709709056569",
"subscribeType":"unsubscribed",
"content":[
{
"content":[
{
"actionType":"URL",
"imageURL":{
"normal":{
"en":"https://pdfreader-dev.oss-cn-shanghai.aliyuncs.com/advertise/638b23df050501670063071.png",
"zh_TW":"https://pdfreader-dev.oss-cn-shanghai.aliyuncs.com/advertise/638b23df050501670063071.png",
"zh_CN":"https://pdfreader-dev.oss-cn-shanghai.aliyuncs.com/advertise/638b23df050501670063071.png"
}
},
"linkURL":{
"en":"https://www.pdfreaderpro.com/store",
"zh_TW":"https://www.pdfreaderpro.com/store",
"zh_CN":"https://www.pdfreaderpro.com/store"
},
"actionType":"comparative"
}
]
}
]
}
Scroll
json示例
{
"appName":"PDFReaderProIOS",
"platform":"iOS",
"showType":"scroll",
"version":"1.3.5",
"startTime":"1669709056569",
"endTime":"1700709056569",
"subscribeType":"unsubscribed",
"content":[
{
"content":[
{
"actionType":"URL",
"imageURL":{
"normal":{
"en":"https://pdfreader-dev.oss-cn-shanghai.aliyuncs.com/advertise/6389b1bb019111669968315.png",
"zh_TW":"https://pdfreader-dev.oss-cn-shanghai.aliyuncs.com/advertise/6389b1bb019111669968315.png",
"zh_CN":"https://pdfreader-dev.oss-cn-shanghai.aliyuncs.com/advertise/6389b1baed2f41669968314.png"
}
},
"linkURL":{
"en":"https://www.pdfreaderpro.com/store",
"zh_TW":"https://www.pdfreaderpro.com/store",
"zh_CN":"https://www.pdfreaderpro.com/store"
}
},
{
"actionType":"URL",
"imageURL":{
"normal":{
"en":"https://pdfreader-dev.oss-cn-shanghai.aliyuncs.com/advertise/638b04d197d561670055121.png",
"zh_TW":"https://pdfreader-dev.oss-cn-shanghai.aliyuncs.com/advertise/638b04d197d561670055121.png",
"zh_CN":"https://pdfreader-dev.oss-cn-shanghai.aliyuncs.com/advertise/638b04d197ff01670055121.png"
}
},
"linkURL":{
"en":"https://www.pdfreaderpro.com/store",
"zh_TW":"https://www.pdfreaderpro.com/store",
"zh_CN":"https://www.pdfreaderpro.com/store"
}
},
{
"actionType":"URL",
"title":{
"font":{
"name":"Helvetica-Bold",
"size":20
},
"color":{
"normal":{
"universal":{
"hex":"#FFFFFF",
"alpha":1
}
}
},
"language":{
"en":"All-New PDF Reader Pro Windows Released!",
"zh_TW":"PDF Reader Pro Windows版全新發佈！",
"zh_CN":"PDF Reader Pro Windows版全新发布！"
}
},
"button":{
"font":{
"name":"PingFangSC-Semibold",
"size":13
},
"color":{
"normal":{
"universal":{
"hex":"#FFFFFF",
"alpha":1
}
}
},
"language":{
"en":"Learn More",
"zh_TW":"更多資訊",
"zh_CN":"了解更多"
},
"background":{
"color":{
"height":{
"dark":{
"hex":"#FFFFFF",
"alpha":1
},
"universal":{
"hex":"#FFFFFF",
"alpha":1
}
},
"normal":{
"dark":{
"hex":"#FFFFFF",
"alpha":1
},
"universal":{
"hex":"#FFFFFF",
"alpha":1
}
}
},
"layer":{
"cornerRadius":15,
"borderWidth":1,
"borderColor":{
"color":{
"height":{
"dark":{
"hex":"#FFFFFF",
"alpha":1
},
"universal":{
"hex":"#FFFFFF",
"alpha":1
}
},
"normal":{
"dark":{
"hex":"#FFFFFF",
"alpha":1
},
"universal":{
"hex":"#FFFFFF",
"alpha":1
}
}
}
}
}
}
},
"imageURL":{
"normal":{
"en":"https://pdfreader-dev.oss-cn-shanghai.aliyuncs.com/advertise/6389b82d63b181669969965.png",
"zh_TW":"https://pdfreader-dev.oss-cn-shanghai.aliyuncs.com/advertise/6389b82d63b181669969965.png",
"zh_CN":"https://pdfreader-dev.oss-cn-shanghai.aliyuncs.com/advertise/6389b82d63b181669969965.png"
}
},
"linkURL":{
"en":"https://www.pdfreaderpro.com/windows?utm_source=iOSApp&utm_campaign=PDFiOS&utm_medium=pdfios_promo",
"zh_TW":"https://www.pdfreaderpro.com/windows?utm_source=iOSApp&utm_campaign=PDFiOS&utm_medium=pdfios_promo",
"zh_CN":"https://www.pdfreaderpro.com/windows?utm_source=iOSApp&utm_campaign=PDFiOS&utm_medium=pdfios_promo"
}
}
]
}
]
}
Pop
json示例
代码块
-
//APP类型 public enum KMAdvertisementAppNameType: String, Codable { case RecordIt = "RecordIt" case RecordItPro = "RecordItPro" case RecordItDMG = "RecordItDMG" case FilmageScreen = "FilmageScreen" case FilmageScreenPro = "FilmageScreenPro" case FilmageScreenDMG = "FilmageScreenDMG" case FilmageEditorMac = "FilmageEditorMac" case FilmageEditorMacPro = "FilmageEditorMacPro" case FilmageEditorMacDMG = "FilmageEditorMacDMG" case FilmageConverterMac = "FilmageConverterMac" case FilmageConverterMacPro = "FilmageConverterMacPro" case FilmageConverterMacDMG = "FilmageConverterMacDMG" case FilmagePlayerMac = "FilmagePlayerMac" case FilmagePlayerMacPro = "FilmagePlayerMacPro" case FilmagePlayerMacDMG = "FilmagePlayerMacDMG" case PDFReaderProMac = "PDFReaderProMac" case PDFReaderProMacPro = "PDFReaderProMacPro" case PDFReaderProMacDMG = "PDFReaderProMacDMG" case PDFReaderProIOS = "PDFReaderProIOS" case PDFReaderProIOSPro = "PDFReaderProIOSPro" } -
//平台 public enum KMAdvertisementPlatformType: String, Codable { case unknow = "unknow" case Mac = "Mac" // case iOS = "iOS" // } -
//显示样式 public enum KMAdvertisementShowType: String, Codable { case unknow = "unknow" case list = "list" //列表 case pop = "pop"//弹窗 case scroll = "scroll"//循环 case view = "view" //视图显示 } KMAdvertisementSubscribeType ```swift //订阅状态 public enum KMAdvertisementSubscribeType: String, Codable { case unknow = "unknow" case unsubscribed = "unsubscribed"//未订阅 case subscribed = "subscribed"//已订阅 }
* <a id="ActionType">KMAdvertisementActionType</a>
```swift
//点击视图后跳转选项
public enum KMAdvertisementActionType: String, Codable {
case unknow = "unknow"
case URL = "URL"//链接
case comparative = "comparative"//比价表
}
- KMAdvertisementLanguageType ```swift //多语 public enum KMAdvertisementLanguageType: String { case unknow = "unknow" case en = "en"// case zhCN = "zhCN"// case zhTW = "zhTW"// }
```