# CPS组件API开发接入文档

基础库 3.8.6 开始支持，低版本需做兼容处理

# 1.组件概览

CPS组件需3.8.6及以上基础库版本支持，基于 PageManager 能力。 CPS组件分为「单游戏组件、多游戏组件、游戏橱窗」三种，mp端配置后均可使用API创建。

从左往右依次是「单游戏组件、多游戏组件、游戏橱窗」

CPS组件query：Object

参数	类型	必填	说明
Object.id	string	是	必选，填入mp端配置的组件ID
Object.left	number	否	可选，组件左上角屏幕横坐标单游戏组件/多游戏组件时有效不填时平台将自动适应游戏类型并展示
Object.top	number	否	可选，组件左上角屏幕纵坐标单游戏组件/多游戏组件时有效不填时平台将自动适应游戏类型并展示
Object.isVertical	boolean	否	可选，当为「多游戏组件」时，可以选择「水平展示/竖直展示」，默认为false
Object.query	object	否	可选，打开CPS游戏时传入的启动query参数

# 2.开发接入实现

# ● 获取PageManager实例

const pageManager = wx.createPageManager();

# ● 预加载

pageManager.load({
    openlink: 'wFFX1cDJnwJCet72QGUJJvBpa9z9lfAob-7EYHwzFENHJ_tNECj5LquvJqnbm82RktAcRyg7gORaUSh0yRSiuYF21JvF84j7-SgazajvTW-ScbwFiQccq8FWsrzHVPox1dr90HHv_CTrgRJD4HOdiRJFeLNRrDu0Pj3vsIGuonI', // CPS推荐组件OPENLINK常量，直接复制即可
    query:{
        id: 'xxxx', // mp端配置的组件id，必填，在mp申请
        //组件的位置，选填，不填时系统自动适应，均为逻辑像素。
        left: 0, // 组件左上角屏幕横坐标，单游戏组件/多游戏组件时有效，
        top: 100, // 组件左上角屏幕纵坐标，单游戏组件/多游戏组件时有效
        isVertical:false, // 可选，多游戏组件时有效，默认为false。
    }
  });

# ● 展示（若未进行预加载会首先进行预加载）

// 已进行预加载
pageManager.show();

// 未进行预加载
pageManager.show({
    openlink: 'openlinkxxxx', // CPS推荐组件OPENLINK常量，暂未配置，仅为示例
    query:{
        id: 'idxxxx', // mp端配置的组件id，必填，在 mp 申请
        
        //组件的位置，选填，不填时系统自动适应
        left: 0, // 组件左上角屏幕横坐标，单游戏组件/多游戏组件时有效，
        top: 100, // 组件左上角屏幕纵坐标，单游戏组件/多游戏组件时有效
        isVertical:false, // 可选，多游戏组件时有效，默认为false。
        }
  });

# ● 销毁

pageManager.destroy();

# ● 监听事件

pageManager.on(
    'show', // show | destroy | error｜ click
    () => {
        console.log('cps recommend component show.');
    },
)
pageManager.on(
    'click', // show | destroy | error｜ click
    (res) => {
        console.log('cps recommend component click：', res.targetAppName);
    },
)

# 3.pageManager.on 监听事件回调

回调类型	回调时机	返回	备注
ready	组件加载完毕时触发	-	-
show	用户侧展示组件时触发	-	-
destroy	用户关闭组件时触发	-	-
clickgame	用户点击组件中的CPS游戏时触发	Object	从CPS游戏返回后触发
error	组件发生错误时触发	Object	-

clickgame callback回调返回：

返回参数	类型	说明
Object.targetAppName	string	表示玩家点击的CPS游戏的名称

error callback 回调返回：

返回参数	类型	说明
Object.errCode	number	错误码
Object.errMsg	string	调用时返回的错误消息 ● 当前广告ID不可用 ● 暂无CPS推荐组件调用权限 ● 其他组件错误信息