自定义数据上传API
预置自定义事件
设置访问用户变量(setVisitor)
当用户未登录时,定义用户属性变量。在添加所需要发送的事件代码之前,需要在GrowingIO”数据中心 > 数据管理 > 变量 > 用户变量的访问用户变量页签下置用户变量。
接口定义
gio('setVisitor', properties: object);
参数说明
名称 | 类型 | 是否必须 | 说明 |
properties | Object | 是 | 访问用户级变量,用户额外的信息参数 |
代码示例
// 假设初始化后把 gio 对象放在 App 的 globalData 里面 // 比如在针对不同的用户做某个 Campaign 的 A/B 测试 getApp().globalData.gio('setVisitor', { campaign_id: 3, campaign_group: 'A 组用户' });
发送登录用户的信息。在添加所需要发送的事件代码之前,需要在GrowingIO”数据中心 > 数据管理 > 变量 > 用户变量的登录用户变量页签下置用户变量。
接口定义
gio('setUser', properties: object)
参数说明
名称 | 类型 | 是否必须 | 说明 |
properties | Object | 是 | 登录用户变量,用户额外的信息参数 |
代码示例
// 假设初始化后把 gio 对象放在 App 的 globalData 里面 getApp().globalData.gio('setUser', { age: 30, level: '高级用户', company: 'GrowingIO', title: '工程师' });
发送页面级别的信息。在添加所需要发送的事件代码之前,需要在GrowingIO”数据中心 > 数据管理 > 变量 > 事件变量的页面级变量页签下置页面级变量。
接口定义
gio('setPage', properties: object)
参数说明
名称 | 类型 | 是否必须 | 说明 |
properties | Object | 是 | 页面级变量,页面额外的信息参数 |
代码示例
// 假设初始化后把 gio 对象放在 App 的 globalData 里面 // 推荐在 Page#onShow 处理这个事件 // 下面假设我在 GrowingIO 后台已经配置了两个页面级变量 pageName 和 type Page({ onShow() { getApp().globalData.gio('setPage', { pageName: '电影列表页', type: this.data.type }); } }
发送一个转化变量用于高级归因分析。在添加所需要发送的事件代码之前,需要在GrowingIO”数据中心 > 数据管理 > 变量 > 转化变量下配置转化变量。
设置一个转化信息用于高级归因分析,目前支持归因方式有最初归因、最终归因和线性归因。
举个例子,如果一个用户是先后通过活动A
、活动B
、活动C
来访问小程序,最后在某次后续几天后的访问购买了某个商品。如果把活动A/B/C分别设置为转化变量campaign
的值,那么:
最初归因:这个购买行为是由 A 贡献的;
最终归因:这次购买行为是 C 贡献的;
线性归因:这次购买行为是 A/B/C 各占 1/3 贡献。
接口定义
gio('setEvar', properties: object)
参数说明
参数名称 | 类型 | 是否必须 | 说明 |
properties | Object | 是 | 转化级变量和转化信息 |
代码示例
// 假设初始化后把 gio 对象放在 App 的 globalData 里面getApp().globalData.gio('setEvar', { campaign: '活动A'});
手动发送一个自定义事件。在添加所需要发送的事件代码之前,需要在GrowingIO”数据中心 > 数据管理 > 事件 > 埋点事件“下配置埋点事件,在变量 > 事件变量下配置事件级变量。
接口定义
gio('track', eventName: string, properties: object);
参数说明
名称 | 类型 | 是否必须 | 说明 |
eventName | string | 是 | 事件标识符。 |
properties | Object | 否 | 事件级变量,即事件发生时所伴随的维度信息参数。 |
代码示例
// 假设初始化后把 gio 对象放在 App 的 globalData 里面 // 在 Page 的 clickBanner 函数里添加以下代码 Page({ clickBanner(e) { getApp().globalData.gio('track', 'clickBanner', { id: movie.id, title: movie.title, index: e.currentTarget.dataset.index }); } })