SDK对接文档

主题

模块名：GameHelper.GameNav

支持渠道：微信

SDK仅提供跳转API以及SDK通用的埋点统计。请业务层自行设计UI和展示点位，绑定点击事件。

本功能必须由用户手动点击游戏UI触发，不能通过代码自动跳转！

1. 接入流程 ​

1.1 设计UI和对应点位（策划、美术） ​

策划同学设计好导量跳转入口的点位、展示条件、UI设计。

1.2 点位展示UI，并调用SDK上报展示（研发） ​

通过SDK接口，判断当前运行环境是否支持本功能。如果支持，则自行展示UI，并调用GameHelper.GameNav.reportShow()方法

typescript
if (GameHelper.GameNav.isSupport) {
    this.UI.active = true; // step1 - 展示UI
    GameHelper.GameNav.reportShow(); // step2 - 上报SDK展示
}

调用后会自动产生SDK内置的互推展示事件：

json
{
    "_event_name": "game_promotion",
    "properties": {
        "action": "show",
        "scenes": "XXX", // 可选参数，可能没有
        "target_appid": "XXXX", // 可选参数，后续会跳转的应用appid
        ...
    }
}

1.3 绑定点击事件（研发） ​

对UI绑定点击事件，点击发生时调用GameHelper.GameNav.navigateToMiniProgram（opt）。传参说明

  • target_appid: 想跳转应用的appid<必传>

  • envVersion：

    • GameHelper.GameNav.ENV_VER.RELEASE<默认>： 跳转对方应用的线上版。正式包必须写这个

    • GameHelper.GameNav.ENV_VER.DEV： 跳转对方应用的开发版

    • GameHelper.GameNav.ENV_VER.TRAIL： 跳转对方应用的体验版

  • scenes：场景值。可选的预留字段。

  • success：跳转成功后才会执行。由于本体小游戏会被切后台，如果有异步操作(例如网络请求等)，不一定能执行完毕

  • fail：跳转失败才会执行(比如点了取消，×)。

typescript
GameHelper.GameNav.navigateToMiniProgram({
    target_appid: "wxXxxxxxxxxxxxxxxx",
    envVersion: GameHelper.GameNav.ENV_VER.RELEASE,
    success() {
        console.log("业务层回调跳转成功");
        // 执行其他操作
    },
    fail() {
        console.log("业务层回调跳转失败");
        // 执行其他操作
    },
});

调用后会自动产生SDK内置的互推点击事件：

json
{
        "_event_name": "game_promotion",
        "properties": {
                "action": "click",
                "target_appid": "xxxx", // 想跳转应用的appid
                "scenes": "XXX" //展示场景 - 传了才会有本字段
                ...
        }
}

2. 属性 ​

属性类型说明app是否有效小游戏是否有效
ENV_VERObject应用版本枚举×√
isSupportboolean是否支持×√
reportShowFunction上报导量入口展示×√
navigateToMiniProgramFunction跳转小程序×√

3. 测试内容（测试） ​

日志关键词：GameNav

3.1 互推展示上报 ​

当互推UI点位展示时，有一条互推展示新事件上报<栏目1.2说明了>

如果没有，则研发漏掉了代码调用

3.2 互推点击上报 ​

当用户点击了导量UI，无论跳转是否成功，都会有一条互推点击新事件上报<栏目1.3说明了>

SDK自动上报的

3.3 互推归因上报 ​

当用户是通过互推点击进入的时候，在跳转目的地应用下，启动的时候，会有一条互推归因新事件上报

SDK自动上报的。只有启动时成功归因才有本上报。 假设A跳B，本事件是在B里面报的, SDK自动上报

如果用户在目的地应用为首次进入，则type值为0，反之为1。

json
{
        "_event_name": "game_promotion",
        "properties": {
                "action": "result",
                "type": "0或1", // 0表示新用户，1表示老用户
                "source_version": "xxxx", //源包版本
                "source_appid": "xxxx", //源包app_id
                "source_open_id": "xxxx", //源包open_iid
                ...
        }
}
点我快速对接
›