原生微信小程序弹窗接入

打开 GMP 系统，进入「管理中心」 -> 「通道管理」 -> 「微信小程序」 -> 「新增小程序接入」

授权时，必须勾选「获取小程序码」、「小程序基本信息管理」、「小程序链接管理」这三个权限，其他权限为可选

3.1 接入 Finder SDK（可选）

❗️注意：此步骤可选，如果有在用的 UBA ，不使用 Finder ，则可以不接入

1、在项目根目录下安装 @datarangers/sdk-mp：

npm install @datarangers/sdk-mp

2、完成之后在「微信开发者工具」中进行「构建 npm」操作：

3.2 接入弹窗 SDK

1、在微信小程序项目根目录下安装 @byte-gmp/gmp-mini-popup：

npm install @byte-gmp/gmp-mini-popup

2、完成之后在「微信开发者工具」中进行「构建 npm」操作：

3、在项目代码 app.js 里引入

import GmpSdk from "@byte-gmp/gmp-mini-popup";

// 如果 3.1 步骤有接入Finder SDK，则需要下面引入
import $$Rangers from "@datarangers/sdk-mp";

// 如果 3.1 步骤有接入Finder SDK，则需要下面 init 方法
// 参数配置参考 3.4.1
$$Rangers.init({
  app_id: 10000001,  // 类型是number而非字符串
  channel_domain: "https://xxx.com",
  log: false, // 是否开启日志打印
  auto_report: true, // 是否开启预置事件采集
  enable_ab_test: false,
});

// GmpSdk.init 参数配置参考 3.4.2
const sdk = GmpSdk.init({
  finderRangers: $$Rangers,
  appId: 2,
  mainAccountId: -1,
  wechatAppId: "wxbee437cfe27aec04", // 替换为「步骤2」接入到 GMP 小程序的 wechatAppId
  origin: "https://xxx.com",
  finderAppId: 10000001, // 类型是number而非字符串
  operatingMode: "Auto",
  reportPopupKey: (key) => {
    console.log(key, "reportPopupKey");
    this.globalData = {
      reportPopupKey: key,
    };
  },
  initPage: "pages/index/index",
  customEventTrigger(key) {
    console.log(key, "customEventTrigger");
  },
  success(res) {
    console.log(res, "success");
  },
  fail(res) {
    console.log(res, "fail");
  },
  error(e) {
    console.log(e, "e");
  },
});

// 如果设置完毕，就可以调用send方法标记可以上报事件了。
// 在SDK的初始化流程中，send方法必须被调用执行过，否则所有事件都不会上报
$$Rangers.send();

App({
  onLaunch() {
    // 将 finder 实例挂载到全局
    this.$$Rangers = $$Rangers;
    // 将 弹窗SDK 实例也挂载到全局
    // 这里命名必须与视图 SDK 组件传入的 key 保持一致，如：
    // <gmp-popup gmpEventKey="gmpEventTrigger" />，则这里属性名为 gmpEventTrigger
    this.gmpEventTrigger = sdk;
  
    wx.login({
      success(res) {
      
        // 参数配置见 3.4.3
        GmpSdk.config({
          code: res?.code,
        });
        
        // 参数配置见 3.4.4
        GmpSdk.on((key: string) => {
          console.log('reportKey:', key);
        });
      },
      error(e) {
        console.log(e, "e");
      },
    });
  },
});

3.3 引入弹窗组件

以首页 pages/index/index 弹窗为例

在 pages/index/index.json 文件配置 usingComponents 如下：

// miniprogram/pages/index/index.json
{
  "usingComponents": {
    "gmp-popup": "@byte-gmp/gmp-mini-popup/components/Popup"
  }
}

在pages/index/index.wxml 文件中引入

❗️注意：在 3.2 中挂载的代码片段 this.gmpEventTrigger = sdk，属性名 为 gmpEventTrigger，刚好对应下面传入 的 gmpEventKey 值

<view class="container">
  
</view>
// 上面代码为示例

// 这里 gmpEventKey 传入的字符串对应 GmpSdk.init 中，success 回调参数挂载的全局属性名
<gmp-popup gmpEventKey="gmpEventTrigger" />

3.4 API

3.4.1 $$Rangers.init 参数

3.4.2 GmpSdk.init 参数

3.4.3 GmpSdk.config 参数

3.4.4 GmpSdk.on

3.4.5 SDK 参数获取

在 GMP 打开「管理中心」 -> 「通道管理」 -> 「微信小程序弹窗」 -> 「SDK参数」

其中，Finder app_id 的值可能有多个，触达时要用哪个应用，这里就选择应用对应后面括号里的 app_id

3.4.6 手动模式

GmpSdk.init 设置为 'Manual'，则进入手动模式。手动模式在调用 GmpSdk.config之后，需要使用 GmpSdk.on 方法进行监听，如果有弹窗将要弹出时，会将 弹窗 Key 以回调函数参数的形式给出来，例如：

onLaunch() {
    wx.login({
      success(res) {
        GmpSdk.config({
          code: res?.code,
        });

        GmpSdk.on((key: string) => {
          // 这里 key 可以做任意处理，比如存到全局变量中
          console.log('reportKey:', key);
          
          // 可以在这里做任何逻辑
          
          // 需要弹窗的时候调用以下方法可以触发弹窗
          getApp().gmpEventTrigger.triggerPopupData(key);
        });
      },
      error(e: Error) {
        console.log(e, 'e');
      },
    });
 },

3.4.7 上报 params

在手动上报时，可调用如下 SDK 方法 eventTrigger 方法触发上报

getApp().gmpEventTrigger.eventTrigger(key, params)

// 使用示例，例如上报事件名为'request_status__', 事件附带属性为 {path: 'pages/index/index', a: 'xxx', b: 'xxx'}
getApp().gmpEventTrigger.eventTrigger('request_status__', {
  path: 'pages/index/index',
  a: 'xxx',
  b: 'xxx'
})

其中参数分别为：

在「小程序后台」- 「开发」 - 「开发管理」 - 「服务器域名」中，将上述 3.4.1 中 channel_domain（Finder 上报域名），3.4.2 中 origin （GMP 域名），配置到「request 合法域名」里

5.1 创建触达任务

❗️注意：测试之前，必须先确保已经导入行为事件；测试只限在小程序本地调试、体验版进行，不能直接发布正式版

创建「触达任务」，选择「微信小程序弹窗」和 「任务关联应用」（未购买 Finder 可忽略，与 3.4.1 参数 app_id 保持一致），点击「确定」

选择「受众用户」（建议选择「全部用户」进行测试验证）

触发条件中选择任一事件，并记住这里的「事件英文名」，如图中为 request_status__

触达配置选择任一模板，点击弹窗，编辑「点击行为」为「关闭弹窗」，然后创建触达任务并审批

5.2 任务弹窗测试

5.2.1 使用 Finder SDK的场景

在「引入弹窗组件」（即引入 <gmp-popup> 组件）的页面代码里（例如首页是 pages/index/index.js），加入下述代码，触发 4.1 中创建触达任务选择的事件英文名，本例子为：request_status__

onShow: () => {
  // 本例子中以下 eventName 为 request_status__
  getApp().$$Rangers.event('eventName');
}

如果弹出弹窗，则代表接入测试成功，可以把上述测试代码删除，创建正式触达任务弹窗

5.2.2 自带 UBA 的场景

在 UBA 监听到事件触发时，手动触发 GMP SDK 的 eventTrigger 方法，key 为事件名，本例子为：request_status__

// UBA 监听事件触发之后插入下面代码：
// key 表示事件名,本例子中以下 key 为 request_status__
// params 指触发事件时某些属性的值，非必传，用法可参考 3.4.7
getApp().gmpEventTrigger.eventTrigger(key, params)

如果弹出弹窗，则代表接入测试成功，可以创建正式触达任务弹窗

5.3 测试完整代码

// app.js
import $$Rangers from '@datarangers/sdk-mp';
import GmpSdk from '@byte-gmp/gmp-mini-popup';

$$Rangers.init({
  app_id: 10000026, // 注意类型是number而非字符串
  channel_domain: 'https://www.xxx.com', // 按文档替换为真实链接
  log: false, // 是否开启日志打印
  auto_report: true, // 是否开启预置事件采集
  enable_ab_test: false,
});
const gmpEventTrigger = GmpSdk.init({
  finderRangers: $$Rangers,
  appId: 1,
  mainAccountId: -1,
  wechatAppId: 'wxbee437cfe27aec01', // 按文档替换为真实的wechatAppId
  origin: 'https://www.xxx.com/gmp', // 按文档替换为真实链接
  finderAppId: 10000026, // 注意类型是number而非字符串
  operatingMode: 'Auto',
  initPage: 'pages/index/index',
  customEventTrigger(key) {
    console.log(key, 'customEventTrigger');
  },
  success(res) {
    console.log(res);
  },
  fail(res) {
    console.log(res, 'fail');
  },
  error(e) {
    console.log(e, 'e');
  },
});
// 如果设置完毕，就可以调用send方法标记可以上报事件了。
// 在SDK的初始化流程中，send方法必须被调用执行过，否则所有事件都不会上报
$$Rangers.send();

App({
  onLaunch() {
    this.$$Rangers = $$Rangers;
    this.gmpEventTrigger = gmpEventTrigger;

    wx.login({
      success(res) {
        GmpSdk.config({
          code: res?.code,
        });

        GmpSdk.on(key => {
          getApp().reportPopupKey = key;
          console.log('reportKey:', key);
        });
      },
      error(e) {
        console.log(e, 'e');
      },
    });
  },
});

// pages/index/index.json
{
  "usingComponents": {
    "gmp-popup": "@byte-gmp/gmp-mini-popup/components/Popup"
  }
}

// pages/index/index.wxml
<view class="container">
  <view class="title">GMP SDK 小程序Demo</view>
</view>
<gmp-popup gmpEventKey="gmpEventTrigger" />

// pages/index/index.js
Page({
  onShow() {
    getApp().$$Rangers.event('request_status__');
  },
});

5.4 弹窗效果示例

6.1 代码接入

在小程序中选择一个页面来预览弹窗与测试弹窗发送，比如选定 pages/popup-test/index 来作为测试页面，需要在该页面 index.ts|js 代码文件加入下述代码：

// pages/popup-test/index.ts

/**
* 生命周期函数
*/
onShow(options) {
  // scene 需要使用 decodeURIComponent 才能获取到生成二维码时传入的 scene
  const scene = decodeURIComponent(options.scene || '');

  function showData() {
    if (app.gmpEventTrigger) {
      app.gmpEventTrigger.sdkContext.showWindowCode(
        scene,  // 这里取的是路径里携带的scene参数
        'pages/popup-test/index', // 这里配置测试弹窗发送 & 预览的小程序页面
      );
    } else {
      setTimeout(showData, 500);
    }
  }
  setTimeout(showData, 2000);
},

另外在该页面 wxml 代码里引入弹窗组件：

// pages/popup-test/index.wxml
<view>弹窗测试页面</view>
<gmp-popup gmpEventKey="gmpEventTrigger" />

6.2 GMP 平台侧配置

参考下图，将上述用于测试发送页面路径（例如： pages/popup-test/index ），配置到「预览扫码预览路径」里

6.3 预览弹窗

点击 「微信小程序弹窗」 - 「预览」，扫码即可预览弹窗

在 「触达任务」 - 「触达配置」里，可以点击「测试弹窗」，扫码也可测试弹窗

weapp-1707196787.zip

1.32MB

8.1 弹窗没有正常弹出

1. 检查 GmpSdk.init 配置的 success 回调是否有进入

2. 检查SDK初始化后，是否正常触发gmp/openapi/v3/miniprogram_popup/getMiniProgramOpenId、openapi/v3/miniprogram_popup/getMiniProgramTask接口，有无出现接口报错

3. 检查希望出现弹窗的页面是否正常接入了弹窗组件，页面中元素是否出现gmp-popup标签，是否在触发事件后出现内容

8.2 数据分析展示异常

1. 检查异常的数据分析的项目id和初始化时传入的项目id是否一致

2. 检查DataFinder的SDK是否正常接入以及是否触发上报函数

3. 检查DataFinder的上报函数是否存在异常，且在DataFinder中是否存在上报的数据