小程序模版集成
模板类小程序SDK集成有两个阶段：1.在小程序模板集成SDK，将appkey添加到小程序SDK中的配置位；2.通过OpenAPI，上报自定义事件。本文档将对小程序模板SDK集成方式进行详细说明。
适用范围
使用友盟+程序统计SDK 2.4.6及以上版本；
集成流程图
模版类小程序SDK集成主要两个阶段：
集成
在小程序模版集成sdk，根据需求配置相关参数，并配置友盟的域名到模版后台中；
生成实例小程序时，在友盟注册小程序应用，将获取到应用的appkey添加到实例小程序sdk中的相应配置位置，再发布小程序上线。
自定义事件
第一部分：集成
模版配置SDK及配置详细教程
在小程序模版集成sdk，根据需求配置相关参数，并配置友盟的域名到模版后台中
1. 获取 sdk
小程序平台 | 安装sdk获方式 | 获取代码 |
|---|---|---|
微信 | npm | npm install umtrack-wx@latest —save |
支付宝 | npm | npm install umtrack-alipay@latest —save |
百度 | npm | npm install umtrack-swan@latest —save |
字节 | npm | npm install umtrack-tt@latest —save |
npm | npm install umtrack-qq@latest —save |
2. 将sdk集成在小程序模版中，集成代码示例：
3. 根据需求配置参数
适用小程序平台 | 参数配置项 | 类型/值 | 首次使用默认值 | 参数功能 | 注意事项 |
|---|---|---|---|---|---|
微信小程序、QQ小程序 | useOpenid | true / false | true | 统计的用户标识为openid | 如果设置为true，但是没有设置友盟+获取openid或者没有上报openid，则用户数据不会发送 |
微信小程序、QQ小程序、百度小程序、字节跳动小程序 | autoGetOpenid | true / false | true | sdk进行请求获取openid（百度获取swanid，字节获取anonymousid）；授权友盟+通过后台自动获取openid，可防止数据统计过程中因未采集到OpenID而造成数据丢失 | 设置后，需要在后台「设置」功能中填写小程序的appid及appsecrect，否则也不会获取openid；注意，如果是微信小程序和QQ小程序，当此配置项为true时，请一定将useOpenid 配置项设为 true；如果服务商无法获得appid（百度为appkey）和appsecrect，则请将此配置项设为false，然后调用 setOpenid() 手动上报openid（百度为swanid，字节为anonymousid） |
微信小程序、支付宝小程序、QQ小程序、百度小程序、字节跳动小程序 | uploadUserInfo | true / false | false | 获取用户的信息和头像，可以在「分享分析」功能中根据头像查看用户的分享排行 | 开启为true时，请确认在启动时获取用户信息。 |
微信小程序、支付宝小程序、QQ小程序、百度小程序、字节跳动小程序 | debug | true / false | true | 是否打开调试模式；建议打开，可以帮助在小程序端进行数据上报的debug | 暂无 |
支付宝小程序 | enableVerify | true / false | false | 剪切板是用于埋点验证获取测试设备信息，以便进行埋点验证的测试工作 | 剪切板功能是用于埋点验证获取测试设备信息的；当开启为true时，用户侧可能会被提示获取剪切板信息；请确认线上发布版本设置为false。 |
4. SDK接口使用
适用小程序平台 | 接口 | 接口功能 | 接口使用注意事项 |
|---|---|---|---|
微信小程序、QQ小程序、百度小程序、字节跳动小程序 | setOpenid(openid) | openid是用户登录app并打开小程序进行授权后，可以获取到登录用户在小程序中的唯一识别id，部分平台要求openid为唯一标识，需要使用此接口上报openid | 微信、QQ小程序，如果设置useOpenid为true，且autoGetOpenid 为false时，一定要注意使用此接口上报openid;不同平台小程序请注意使用不同接口前缀 |
微信小程序、支付宝小程序、QQ小程序、百度小程序、字节跳动小程序 | setUserid(userId, provider) | 用户在您的小程序上注册以后，您的应用服务端会在用户数据库里添加一条记录并且分配一个用户ID，可以通过 | 不同平台小程序请注意使用不同接口前缀 |
微信小程序、QQ小程序 | setUnionid(id) | 获取到unionid，便于用户分群中下载到用户unionid直接进行运营使用 | 不同平台小程序请注意使用不同接口前缀 |
5. 配置友盟的域名到小程序模版后台
登录小程序后台，在「设置」中添加request合法域名：https://umini.shujupie.com注：一定注意设置，否则友盟+接收不到数据。
做完以上配置，通过模版生成示例小程序，小程序中会带上相应配置的友盟的小程序sdk。
通过模版生成实例小程序应用设置
通过openapi在账号下注册示例小程序应用，友盟会给每个注册的应用生成一个appkey，并将获取到的小程序appkey通过参数填写到sdk中填写appkey的位置。
调用 Open API 自动申请Appkey（Open API说明文档），并通过脚本自动填写至appKey参数（黄豆网最佳实践参考：https://files.alicdn.com/tpsservice/57f751eddaa0932072231c1a5c78b0d4.docx）。集成后，所有新建小程序，将呈现在服务商账户下。
发布实例小程序上线
第二部分：自定义事件
第一步：在集成sdk的模版中，设置上报自定义事件
参考：小程序自定义事件文档
第二步：给每个实例小程序注册自定义事件
API批量创建https://developer.umeng.com/open-api/docs/com.umeng.umini/umeng.umini.batchCreateEvent/1
注：只有在产品后台注册自定义事件，才可以使用自定义事件。