主题
Skip to content 
设首和复访功能
1. 接入须知
建议先了解平台定义的设首任务和复访任务说明;点此跳转设首复访介绍
策划需要提供并设计用户完成设首任务和复访任务各自的奖励;
设首和复访的相关UI(图标、任务介绍界面);
2. 调用流程
1. 初始化任务类型
SDK初始化结束后;调用 GameHelper.AddHome.getAddHomeResult
传入成功和失败(失败回调选接)回调;
可在成功回调内控制设首任务或者复访任务的图标显示;success回调会返回一个boolean类型的参数:
- true表示用户已完成设首,此时可显示复访任务图标
- false表示用户未设首,显示设首任务图标
2. 跳转完成设首任务
在游戏内合适的地方调用 GameHelper.ZFBAddHome.jumpToAddHome 会跳转到支付宝游戏中心; 在success回调内发放设首奖励,用户完成设首任务时会执行success回调;
3. 跳转完成复访任务
在游戏内合适的地方调用 GameHelper.ZFBAddHome.jumpToRevisit 会跳到支付宝游戏中心,官方内置的引导会指引用户完成复访任务,当用户根据指引回到游戏后,会执行success回调,游戏层可在success回调发放奖励;

WARNING
未上架的应用接入复访需要注意
在复访指引过程中,由于游戏中心的《最近使用》一栏无法显示未上架的应用,SDK提供了一个测试参数debugMode,仅限测试阶段使用,调用GameHelper.ZFBAddHome.jumpToRevisit并传入debugMode: true后,测试过程中按照指引操作到游戏中心界面后直接返回游戏即可触发奖励下发;
正式包务必删除debugMode参数或传入false;
应用上线后,建议测试下复访流程;
4. 三方提供的设首&复访事件上报接口(请询问需求方是否接入)
SDK将三方提供的埋点上报进行封装,方便游戏层调用 GameHelper.ZFBAddHome.reportCustomEvent
调用示例
js
GameHelper.ZFBAddHome.reportCustomEvent(GameHelper.ZFBAddHome.TASK_EVENT_NAME.SetIconExpo);
官方共提供了十个埋点事件,如下
事件描述 | SDK内事件枚举 | 支付宝侧上报时对应的事件名 |
---|---|---|
游戏首页显示设首 icon 时 | GameHelper.ZFBAddHome.TASK_EVENT_NAME.SetIconExpo | center_setappc_icon_expo |
设首 icon 被点击时 | GameHelper.ZFBAddHome.TASK_EVENT_NAME.SetIconClick | center_setappc_icon_click |
点击设首 icon 弹出设首面板后 | GameHelper.ZFBAddHome.TASK_EVENT_NAME.SetPanelExpo | center_setappc_panel_expo |
设首面板上按钮完成任务被点击时 | GameHelper.ZFBAddHome.TASK_EVENT_NAME.SetPanelClick | center_setappc_panel_click |
用户领取设首奖励成功后 | GameHelper.ZFBAddHome.TASK_EVENT_NAME.SetPrizeReceive | center_setappc_prize_receive |
游戏首页显示复访 icon 时 | GameHelper.ZFBAddHome.TASK_EVENT_NAME.ReIconExpo | revisit_icon_expo |
复访 icon 被点击时 | GameHelper.ZFBAddHome.TASK_EVENT_NAME.ReIconClick | revisit_icon_click |
点击复访 icon 弹出复访面板后 | GameHelper.ZFBAddHome.TASK_EVENT_NAME.RePanelExpo | revisit_panel_expo |
复访面板上前往复访按钮被点击时 | GameHelper.ZFBAddHome.TASK_EVENT_NAME.RePanelClick | revisit_panel_click |
用户领取复访奖励成功后 | GameHelper.ZFBAddHome.TASK_EVENT_NAME.RePrizeReceive | revisit_prize_receive |
点我快速对接


