跳转到主要内容
PRODUCT DOCUMENTS

快速找到所需文档,高效完成接入与排障

浏览产品文档与友盟 Skill,展开目录并阅读正文。

百度小程序

该文档包含友盟+百度小程序统计的SDK接入方法、集成测试等内容。按以下步骤成功集成SDK后,即可查看友盟+为您百度小程序提供的数据采集服务。

适用范围

该文档适用于友盟+百度小程序统计SDK 2.4.0及以上版本。

一、百度小程序统计SDK快速集成

1. 注册友盟+账号

登录友盟+官网,按照引导注册友盟+账号

特别提醒:我们建议开发者在注册账号时使用企业邮箱,避免使用个人邮箱注册,防止由于个人离职带来的问题,建议使用的账号形式 :umeng@企业域名、apps@企业域名、dev@企业域名

2. Appkey申请

进入小程序统计后台创建Appkey,按要求填写小程序名称及类型:3

您也可通过OpenAPI批量申请Appkey,具体文档参考:https://developer.umeng.com/open-api/docs/com.umeng.umini/umeng.umini.createMiniApp/1

行业分类请参考:https://developer.umeng.com/docs/147615/detail/169442若创建应用数超过300,请联系在线客服

3. 创建百度小程序并接入SDK

注:目前百度联盟小程序支持发布到百度、小红书、爱奇艺等多个端应用上,但是审核等流程是分端进行的。故如果您开发了一个百度联盟小程序,需要到多个应用上发布,建议您创建多个应用,例如:xx小程序-爱奇艺,xx小程序-小红书,xx小程序-手百;这样您可以在产品中看到总数据,也可以看到分端的数据。~~

3.1 下载SDK

下载方式请查看文档:https://developer.umeng.com/docs/147615/detail/184228

首次集成推荐使用正式版SDK注:在百度小程序内使用npm请参考https://smartprogram.baidu.com/docs/develop/framework/custom-component_trdparty/

3.2 集成代码

下载的文件放在百度小程序项目里,比如 utils 目录下。下面会假设 SDK 文件放在 utils 目录下。下载的文件放在百度小程序项目里,比如 utils 目录下。下面会假设 SDK 文件放在 utils 目录下。在百度小程序项目根目录的启动文件 app.js 文件的顶部添加以下JS代码

var uma = require('./utils/uma.min');

App({
  umengConfig:{
    appKey:'YOUR_UMENG_APPKEY',//由友盟分配的APP_KEY
// 是否需要通过友盟后台获取openid或匿名openid,如若需要,请到友盟后台设置appId及secret
    autoGetOpenid:true,
    debug:true,//是否打开调试模式
    uploadUserInfo:true// 自动上传用户信息,设为false取消上传,默认为false
}
});
说明

注意:切记一定要正确设置umengConfig,不要拼写错误

3.3 使用 swanid

为什么要使用swanid?因为百度移动端 APP 不强制登录也可以使用,且允许用户打开小程序。所以百度 APP默认提供了swanid 来统计设备信息。故目前实用 swanid 来使友盟+统计用户信息,防止不会在用户没有登录时,丢掉用户数据。方法:开启autoGetOpenid: true并在友盟后台设置有效appkey(百度)及secret信息,否则获取不到 swanid,用户数据不会上报。填写appkey地址:产品「设置管理-应用-基础设置」,点击「修改」,即可以填写AppSecret

上报OpenID (可选)

openid是用户登录百度系 APP,并且打开小程序进行授权后,可以获取到登录用户在小程序中的唯一识别id,即openid。可以上报openid,这样在使用分群或者数据导出功能时,就可以获取到用户在小程序中的唯一识别id,进行运营或者消息触达了。设置方式:开发者需要额外添加代码上传openid

swan.uma.setOpenid(openid)

3.4 百度小程序增加友盟+数据服务域名

操作步骤:登录百度开发者平台,进入小程序的 开发-> 服务器域名,把 https://umini.shujupie.com 加入 request合法域名

3.5 demo

具体集成方式可参考demo:https://github.com/umeng/mp-demos

3.6 sdk集成项及注意事项总结

image.png

二、高级功能

1. 自定义事件

参考: 小程序自定义事件文档

2. 设置应用用户ID

当用户在您的小程序上注册以后,您的应用服务端会在用户数据库里添加一条记录并且分配一个用户ID,可以通过 setUserid 接口设置该用户ID,以便后续做数据打通或基于应用用户ID做计算时使用。

setUserid(userId, provider)

参数:

  • userId(string): 您的应用为用户生成的唯一ID

  • provider(string): ID提供方,兼容老接口使用,无特殊需要应忽略该参数

返回值:无示例:

swan.uma.setUserid('custom_userid');

3. 上传用户信息

开发者可通过在配置中添加 uploadUserInfo: true 选项来使友盟自动上报用户信息。将 uploadUserInfo 设置为 false 则取消上报用户信息。上传的用户信息为小程序平台公开可获取的用户基础信息,例如昵称、头像、性别、地区、语言等,这些信息将用于U-MiniProgram产品中与用户相关的功能统计中 (注:iOS 字节跳动小程序会在触发onhide时上报,但是Android版需要切换到多任务触发onhide时才上报)。示例:

import'umtrack-swan';

App({
  umengConfig:{
    appKey:'YOUR_UMENG_APPKEY',//由友盟分配的APP_KEY
    debug:true,//是否打开调试模式
    uploadUserInfo:true// 自动上传用户信息,设为false取消上传,默认为false
}
});

三、SDK成功接入验证方法

该方案仅提供验证是否集成成功的方法,由于在开发环境下可能会存在数据不完整的情况,请您正式发布小程序后在验证数据正确性。

  1. 按照上述描述方法引入SDK;

  2. 进入IDE打开调试工具中的console选项,若看到有 “[umeng] — 集成SDK成功”提示 即表示SDK集成成功。

四、说明事项

  1. 慎重调用swan.clearStorage()以及swan.clearStorageSync()接口!SDK会将用户相关操作数据缓存在客户端数据存储模块,在特定时间启动发送策略。若调用该接口可导致数据统计不准确的问题;

  2. 若用户在使用小程序过程强制关闭百度产品有可能会造成统计数据丢失的情况。

FAQ:

  • Q: 注册应用时,提示应用名称已存在

  • A:【友盟+】后台的应用名与实际应用名和包名无关,建议命名为应用名+平台

  • Q: 我忘记我的Appkey了,在哪里能查到

  • A:进入小程序统计-应用设置页面,可看到当前小程序的Appkey