获取项目ID,获取方法请参考"项目管理 > 项目概览 > 查看项目基本信息"。
将以下JS代码复制到H5页面的 <head> 和 </head> 标签之间即可。安装成功后,除 localhost 和 IP 地址外,网址下所有的行为数据都将会被收集。
<script type="text/javascript">!function(e,t,n,g,i){e[i]=e[i]||function(){(e[i].q=e[i].q||[]).push(arguments)},n=t.createElement("script"),tag=t.getElementsByTagName("script")[0],n.async=1,n.src=('https:'==document.location.protocol?'https://':'http://')+g,tag.parentNode.insertBefore(n,tag)}(window,document,"script","assets.giocdn.com/2.0/gio-wxwv.js","gio");// ‘你的appid’为选填项,如果你的微信内嵌页应用有微信分配的appid,建议填写;如果没有,可以留空。gio('init', '你的项目ID', '你的 appid', { debug: false });gio('send');</script>
需要在SDK初始化时进行平台的配置。
gio(‘init’, ‘您的 GrowingIO 项目ID’, ‘您的 AppID’, {platform:支持传入一个判断函数或者一个字符串});
应用场景 | 统计平台 |
微信小程序内嵌 H5 页面 | Minp(微信小程序) |
微信公众号应用使用 H5 页面 | wxwv(微信内嵌页应用) |
移动端浏览器打开 H5 页面 | Web(网页端) |
支付宝小程序内嵌 H5 页面 | alip(支付宝小程序) |
百度小程序内嵌 H5 页面 | baidup(百度小程序) |
字节跳动小程序内嵌 H5 页面 | bytedance(字节跳动小程序) |
QQ小程序内嵌 H5 页面 | qq(QQ小程序) |
配置平台:(以支付宝小程序为例, WebView加载的H5 页面)
判断平台,加入如下代码,并在platform 中传值”alip“。
<!-- GrowingIO Analytics code version 2.1 --><!-- Copyright 2015-2017 GrowingIO, Inc. More info available at http://www.growingio.com --><script type='text/javascript'>!function(e,t,n,g,i){e[i]=e[i]||function(){(e[i].q=e[i].q||[]).push(arguments)},n=t.createElement("script"),tag=t.getElementsByTagName("script")[0],n.async=1,n.src=('https:'==document.location.protocol?'https://':'http://')+g,tag.parentNode.insertBefore(n,tag)}(window,document,"script","assets.giocdn.com/2.0/gio-wxwv.js","gio");gio('init', '你的 GrowingIO 项目ID', '你的支付宝小程序的 AppID', {platform: 'alip'});gio('send');</script>
在小程序里面 WebView 加载时,URL添加额外属性 gio('getGioInfo') 获取用户会话信息。注意使用?
或&
拼接。
举例:# webview.jsPage({data: {// 当内嵌页URL存在参数时,需带上&符号webUrl: `https://example.org/demo.html?key=val&${gio('getGioInfo')}`}});# webview.wxml<web-view src="{{ webUrl }}"></web-view>
内嵌页 SDK 还有以下额外参数可以使用:
参数 | 值 | 解释 |
hashtag | true | false | GrowingIO默认不会把 hashtag 识别成页面 URL 的一部分。对于使用 hashtag 进行页面跳转的单页面网站应用来说,可以启用 hashtag 作为标识页面的一部分,将hashtag设置为true,默认为false。 |
debug | true | false | 开启debug可以进行数据的实时调试,默认为false,调试方式为打开开发者工具,在console中查看。 |
touch | true | false | 设置是否支持touch事件,如果为true则会采集touch事件,否则采集click事件。sdk中会判断当前是否支持touch事件设置默认值。 |
GrowingIO默认不会把 hashtag 识别成页面 URL 的一部分。对于使用 hashtag 进行页面跳转的单页面网站应用来说,可以启用 hashtag 作为标识页面的一部分,将hashtag设置为true
在 微信小程序项目根目录的 app.js 文件设置参数如下:
//如果内嵌页存在微信App_id,建议您填写相应的微信App_id,如果没有,就不用填写gio('init', '你的项目ID'[,'微信App_id'], { setImp:false, hashtag: true });
作为用户行为数据分析工具,用户信息的完善会给后续的分析带来很大的帮助。在微信内嵌页中,微信用户属性是非常重要的设置,只有完善了微信用户属性信息,微信的访问用户变量(如下表)才可以在分析工具中使用,交互数据定义、数据校验功能才会方便通过用户微信相关的信息(微信姓名和头像)定位用户。
下面是专门针对用户的两个个接口。
当用户在你的微信内嵌页上授权获取到 openid 后,可以用过 identify
接口绑定微信用户ID,后续在 GrowingIO 中使用微信ID创建用户分群。示例代码如下:
wx.request({url: 'https://YOUR_HOST_NAME/wechat/code2key',method: 'GET',data: { code: res.code }success: res =>var openid = res.data.openid;var unionid = res.data.unionid;// ...gio('identify', res.data.openid, res.data.unionid)})
当用户在你的微信内嵌页上绑定微信信息后,可以通过 setVisitor
接口设置微信用户信息,后续在 GrowingIO 中,使用访问用户变量分析这个数据。示例代码如下:
wx.getUserInfo({success: res =>// ...gio('setVisitor', res.userInfo);})
微信信息包含微信昵称、微信头像、性别、微信所填国家、微信所填省份、微信所填城市。
设置登录用户ID,可以将用户行为和您业务系统中的用户ID打通,有助于您在分析用户时,能够进一步了解业务价值上的用户核心行为。
当用户登录之后调用 setUserId API ,设置登录用户 ID 。
参数名称 | 参数类型 | 是否必须 | 说明 |
userId | String | 是 | 用户的登录ID |
//setUserId API原型gio('setUserId', userId);//setuserId API调用示例gio('setUserId', '1234567890');
当用户登出之后调用 clearUserId ,清除已经设置的登录用户 ID 。
//clearUserId API原型和调用示例gio('clearUserId');
当用户在你的小程序上传了注册用户ID后,可以通过 setUser 接口设置注册用户信息,后续在 GrowingIO 中分析这个数据。示例代码如下:
gio('setUserId', user.id);gio('setUser', { id: user.id, name: user.name });
用户标记一个元素并提供自定义事件和变量,SDK负责监控,当此元素出现在可视区域中时发送用户配置的自定义事件和变量。
半自动浏览事件指:
采集用户主动标记的元素,事件类型使用自定义事件类型cstm,需要用户在代码中埋点并且在官网配置自定义事件和变量。
半自动:指用户提供元素的自定义事件和变量内容,SDK根据当前元素是否在屏幕上可见,自动发送一个自定义事件。即:需要用户标记元素并且提供自定义事件和变量,SDK在元素出现在屏幕上时自动发送,不同于track接口发送的cstm事件,调用即发送。
注意事项:
注意参数是否合法,与埋点 API 一样,eventID 和事件级变量 JSONObject 都有参数限制要求。
在元素展示前调用GIO API,GIO 负责监听元素展示并触发事件,半自动化浏览事件SDK 上传的数据类型为 cstm ,和自定义事件是同种类型,所以需要您在官网新建对应的事件类型和变量,并且强烈建议使用数据校验工具验证埋点事件。
触发 SDK 自动采集时机: 元素从当前屏幕上不可见到可见。
对于被追踪元素上方有其它元素遮挡的情况 ,GrowingIO 仍可能发送该元素的展示事件 (适配这种case会消耗巨大性能,暂时不兼容)。
gio('init', ' your projectId', 'your appId', {imp: true})
使用此方法标记元素的浏览时,请在console验证cstm事件。
<body><div><h2 data-gio-imp-track='testImp' data-gio-track-foo='bar' data-gio-track-baz='qux'>标记元素并带上两个事件变量</h2></div></body>
以上示例相当于在用户元素出现在可视区域时,我们会对应的执行以下对应的API调用。
gio('track', 'testImp', { foo: 'bar', baz: 'qux'})
自定义数据上传API,请参考自定义数据上传API。
请在添加了跟踪代码的支付宝小程序重新启动几次,发送数据给 GrowingIO。
在GrowingIO平台的创建微信小游戏应用。创建应用请参考查看创建应用。
方式一:小程序&内嵌页Debugger
方式二:在SDK中设置了Debug模式后,在开发者工具中查看数据采集日志。
方式三:数据校验