.getFlowConfig
一、概述
注意:请先完成阅读:API方式接入广告位
使用该接口前,请先进行SDK初始化
getFlowConfig接口用于获取广告位id对应配置详情,调用该接口后,请根据接口的返回值,采用对应的方式处理。
创意ID的获取
调用了getFlowConfig后,返回的creativeId的值即为创意ID
二、调用方法
请 严格按照 【接口调用策略】 调用此接口,否则造成的一切后果请自负!
qg.tmSDK.getFlowConfig({
positionId: positionId
}).then((config) => {
console.log('该广告位当前配置', config);
});三、传入参数
positionId将对应的不同类型返回值,使用前请确认当前使用的positionId类型
字段
字段类型
说明
positionId
string
广告位id
四、返回值与广告类型
浮动窗广告位
type为1时,positionId对应的是浮动窗类型
如果创意列表creatives的show_config中,只有image,则只需渲染该静态图
浮动窗广告可在天幕设置角标功能
如果创意列表creatives中,有fps,多个图片素材则需渲染为动态图片,按照fps切换每张图片
示例:fps=5,意味着每秒播放5张图片,即0.2秒切换一张
多icon广告位
type为7时,positionId对应的是多icon广告类型
多icon广告位拥有多个创意,需要全部渲染处理
多icon广告位可在天幕设置角标功能
如果创意列表creatives中,有fps,且返回多张图片(images为list,示例如下),则多个图片素材需渲染为动态图片——按照fps循环渲染每张图片
示例:fps=5,意味着每秒播放5张图片,即0.2秒切换一张(并不是每5s切换一张图片!!)
通过上述方式,在游戏中实现类似gif动图的效果
同时接口返回中仍会有image(单张图片)返回(此为避免部分老游戏游戏SDK直接更新&&未做此部分处理,可能导致游戏异常而做的保险机制),可忽略。(SDK2.6.9-2020-04-22更新)
关于点击后的跳转:即使是多张图片轮播,仍旧是归属于同一个创意(creativeID),也就是说,跳转的时候,只会跳转到同一个游戏。参考跳转接口:.flowNavigate
Banner广告位
type为11时,positionId对应的是Banner类型
返回参数
字段
字段类型
说明
isOpen
boolean
广告位是否开启
type
string
该广告位的类型
auto_change
number
自动切换时间
borderStyle
object
边框样式属性 *仅当后台配置开启时
borderStyle.imageUrl
string
边框图片
borderStyle.size
string
边框尺寸,通常比show_config中的图片大
borderStyle.left
number
show_config中图片相对边框的左位置
borderStyle.top
number
show_config中图片相对边框的上位置
creatives
array
该广告位可渲染的创意列表, 浮动icon类型该数组有且只有一个
creativeId
string
创意id
positionId
string
广告位id
show_config
object
广告位素材详情
show_config.title
string
素材对应渲染的标题
show_config.image
string
素材图片
title
string
多icon广告位的广告文案
cornerOpen
boolean
角标是否开启
最后更新于
这有帮助吗?