getTigerList(获取交叉推广配置)
交叉推广生命周期
交叉推广流程时序图
版本支持
1.0.5及以上
描述
1、用于获取交叉推广位的要展示的交叉推广的配置信息。
2、浮动Icon、闪屏等统一视作一个交叉推广位进行管理,在本接口中通过输入交叉推广位的ID,获取对应的交叉推广配置,不同的交叉推广位返回的交叉推广素材类型可能不同(根据type字段进行判断),对应的,需做不同的处理。
3、小游戏接入时目前只考虑5种类型:
type值 | 字段说明 |
---|---|
1 | 游戏浮动静态Icon |
2 | 游戏浮动动态Icon |
3 | 游戏闪屏(竖屏) |
7 | 游戏banner |
8 | 游戏闪屏(横屏) |
9 | 抽屉展示(猜你喜欢) |
10 | 测试静态广告位 |
12 | 测试动态广告位 |
4、小程序接入时目前只考虑3种类型:
type值 | 字段说明 |
---|---|
4 | 盒子静态图标 |
5 | 盒子gif图标 |
6 | 盒子Banner |
5、同一个交叉推广位上可能出现不同type的交叉推广配置。
6、每次展示(重新打开,切换页面等)都需调用一次接口,展示哪个交叉推广位,请求哪个交叉推广位的数据,请勿使用本地缓存的交叉推广配置,请勿一次性请求暂时不会展示的数据。
7、一次生命周期中,重复调用该接口,可获取不同的交叉推广配置。此功能用于实现切换交叉推广内容。
使用场景
获取交叉推广列表放在游戏的交叉推广位中,该按钮的样式由此接口提供。(点击后调用navigateToTiger方法)
调用方法
import XH_MINIPRO_SDK from './utils/XH_MINIPRO_SDK.js'
XH_MINIPRO_SDK.getTigerList({
tiger_position_id_list: ['110'], //传入交叉推广位id,交叉推广位id获取方式请联系星汉运营团队;注意:在对应的推广场景获对应的交叉推广列表,不能进入游戏时一次性获取所有交叉推广位 ID 的列表;
appVersion: '1.0.0' //传入当前应用版本号
}).then(list=>{
console.log(list) //交叉推广列表,当对应的交叉推广位配置了足够多交叉推广时,每次返回的交叉推广都有所不同
})
参数
字段 | 字段类型 | 字段说明 |
---|---|---|
appVersion | String | 应用的版本号;使用3段数字的版本号,比如'1.0.2‘, '0.1.22', ’5.8.0'等,请与上传程序时的版本号保持一致 |
tiger_position_id_list | Array | 传入交叉推广位id数组,交叉推广位id获取方式请联系星汉运营团队, 返回的交叉推广列表顺序和传入的交叉推广位id一致 |
返回值样例
[
{
"is_open": true, //是否开启交叉推广
"creative_id": -1, //交叉推广id
"tiger_position_id": 553, //交叉推广位id
"type": 1,
"show_config":{ //显示配置, 配置内容和type类型有关,具体可以看详细说明
"image":"https://cdn.kuaiyugo.com/appprogram/dsp/admin/2018-10-28_236d2800-da82-11e8-a531-2d9b2463b3cf.jpg", //显示的图片
"show_type":1 //显示类型,""空内容则无效果,1为静态交叉推广
},
},
]
tiger_position_id_list 说明
1、传入的格式为数值, 比如有两个交叉推广位443, 444,则传入[443, 444]
2、返回的数据结构和传入的交叉推广位顺序有关,比如传入[443, 444],则返回的数据为
[{
tiger_position_id: 443,
...
}, {
tiger_position_id: 444,
...
}]
返回值详解
字段 | 字段类型 | 字段说明 |
---|---|---|
type | Number | 交叉推广类型 详细类型请看类型详解交叉推广配置返回值说明 |
is_open | Boolean | 交叉推广是否开启(开启-true, 关闭-false) |
creative_id | Number | 交叉推广id |
tiger_position_id | Number | 交叉推广位id |
show_config | Object | 显示配置, 详细返回内容详解交叉推广配置返回值说明 |