微信小程序 SDK
一、集成Flutter插件
1、在项目pubspec.yaml文件中的dependencies下添加如下依赖
ts_flutter_plugin:
git:
url: https://github.com/GaozyDev/ts_flutter_plugin.git
ref: main
2、执行 flutter pub get 命令安装插件
flutter pub get
二、Flutter插件初始化
可根据配置初始化sdk,可配置属性如下:
字段 | 类型 | 是否必须 | 说明 |
---|---|---|---|
app_key | String | 是 | TrackingSystem给接入应用分配的唯一标识,测试、生产的app_key不一样 |
debug | Boolean | 否 | 调试模式,控制是否打印调试日志,默认不打印 |
ts_app | String | 否 | 埋点设置的应用标识,可以是中文 |
ts_ext | JsonString | 否 | 自定义拓展key/value属性 |
server_url | String | 否 | 数据上报地址,默认值为TrackingSystem系统的上报地址 |
示例
// 获取sdk实例
final _tsFlutterPlugin = TsFlutterPlugin();
// 初始化配置
InitData initData = InitData(appKey: "qa16841405XXXX", debug: true);
// 初始化sdk
bool? result = await _tsFlutterPlugin.initSDK(initData);
三、设置用户属性
在登录成功后调用setUserInfo方法设置用户属性,且必须在调用了sdk.tracking()方法后调用。
参数说明:JsonObject,只支持以下属性的设置
字段 | 类型 | 是否必须 | 说明 |
---|---|---|---|
guid | String | 是 | 业务系统用户唯一标识(如果使用open_id作为用户标识,则值与open_id一致) |
open_id | String | 是 | 用户open_id |
union_id | String | 否 | 用户union_id |
real_name | String | 否 | 真实姓名 |
nick_name | String | 否 | 昵称 |
age | Number | 否 | 年龄 |
birthday | String | 否 | 生日 |
gender | String | 否 | 性别: 男/女 |
account | String | 否 | 账号 |
country | String | 否 | 国家 |
province | String | 否 | 省份 |
city | String | 否 | 城市 |
示例
bool? result = await _tsFlutterPlugin.setUserInfo(UserInfo(guid, real_name, nick_name,
age, birthday, gender, account, country, province, city));
四、自定义事件埋码
可调用sdk实例的event方法上报自定义事件,方法参数如下:
字段 | 类型 | 是否必须 | 说明 |
---|---|---|---|
eventName | String | 是 | 事件名称 |
eventParam | JsonObject | 否 | 事件属性 |
示例
bool? result = await _tsFlutterPlugin.event("eventName", {"eventKey": "eventValue"});
返回结果:true 调用成功 false 调用失败
五、采集页面属性
在项目MaterialApp中设置navigatorObservers属性为[TSNavigatorObserver()]