小程序和微信公众号H5 内嵌页 SDK

为小程序（包括微信、支付宝、百度小程序等）内 H5 页面、微信公众号 H5 应用等提供统一的数据采集 SDK。

准备条件

获取项目ID，获取方法请参考"项目管理 > 项目概览 > 查看项目基本信息"。

1. 添加跟踪代码

1. H5页面添加代码

将以下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>

2. 多端使用同一SDK时的平台判断

需要在SDK初始化时进行平台的配置。

gio('init', '您的项目ID', '您的 appid', { 
    platform：'Minp' //支持传入一个判断函数或者一个字符串
});

3. 根据使用端的场景进行其他配置

配置平台：（以支付宝小程序为例， 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>

H5页面与小程序打通用户数据​

当有H5页面需要获取小程序SDK采集用户数据的需求时(将H5页面采集的数据需要与小程序采集的数据做关联分析)，调用此接口可将获取以下数据

gio('getGioInfo');

注意： 1）gio('getGioInfo') 返回的是一个 search 字符串，需要您在字符串前手动拼接 ? 或 & 符号。请拼接在 URL 的查询参数中；如果 URL 中有 Hashtag（#），不能拼接在 Hashtag（#）后的查询参数中。

2）gio('getGioInfo')获取的数据是一次性的，非动态获取，如果切换用户导致sessionId或userId等用户信息变动时，需要您销毁当前webview重设地址。并且使用不保留当前页面的跳转方式跳出承载webview的小程序页面。

示例

举例：
# webview.js
Page({
  data: { url: '' },
  onShow() {
    // 每次onShow时设url的值，保证getGioInfo拿到的是最新值
    this.setData({ url: `https://www.growingIO.com?${gio('getGioInfo')}` });
  },
  onHide() {
    // 退出webview承载页时要销毁webview，保证下次进入时是一个拿到最新数据的全新页面
    this.setData({ url: '' });
  },
  // 如果页面中有登录，需要在登录之后重设一次url的值
  handleLogin() {
    ...
    // 登录完成后重设一次url的值，保证先销毁webview，getGioInfo拿到的是最新值
    this.setData({ url: '' }, () => {
      this.setData({ url: `https://www.growingIO.com?${gio('getGioInfo')}` });
    });
  }
})



# webview.wxml
<web-view src="{{ webUrl }}"></web-view>

gio('getGioInfo')默认获取到的数据示例：

// H5 页面原有的 URL为 :
'https://www.growingio.com/?foo=1#锚点'
// 小程序WebView加载H5时的拼接示例为
`https://www.growingio.com/?foo=1&${gio('getGioInfo')}#锚点`

2. 高级配置

内嵌页 SDK 还有以下额外参数可以使用：

启用hashtag识别

GrowingIO默认不会把 hashtag 识别成页面 URL 的一部分。对于使用 hashtag 进行页面跳转的单页面网站应用来说，可以启用 hashtag 作为标识页面的一部分，将hashtag设置为true

在 微信小程序项目根目录的 app.js 文件设置参数如下：

//如果内嵌页存在微信App_id，建议您填写相应的微信App_id,如果没有，就不用填写
gio('init', '你的项目ID'[,'微信App_id'], { setImp:false, hashtag: true });

强制登录模式

配置forceLogin

默认情况下，SDK 会自动生成访问用户ID来标识访问用户，存储在微信 Storage 里面。这个用户标识符潜在可能会被clearStorage 清除掉，所以有可能不同的自动生成访问用户ID对应同一个微信里的 OpenID。

如您需要使用 openId 或 unionId 标识访问用户，可以在初始化配置中设置 forceLogin: true 来打开强制登录模式。

强制登录模式适用于打开页面就调用 wx.login (参考文档) 获取 openId 或 unionId 。 开启此模式并调用 identity 上报 openid 或 unionId，会将上报的 Id 作为访问用户ID，平台统计数据中访问用户量会与微信后台的比较接近。

设置forceLogin为true后，SDK会继续采集但暂停上报数据，待调用 wx.login后获取 openId 或 unionId，调用 identify 方法后开始数据上报。调用 identify 会替换事件数据的 u(访问用户ID) 字段的值 为设定值（一般是 openId 或 unionId），包括调用identify之前触发的事件

需在初始化配置项将 forceLogin 配置如下:

forceLogin: true, //是否强制要求调用 wx.login 获取 opend 或 unionId。默认 false

获取到 openId 或 unionId 后调用 identify 接口。

适用于打开页面调用 wx.login 获取 openId 或 unionId 。

SDK初始化时配置了 forceLogin 为 true，如果打开页面后没有调用 wx.login 获取 openId 或 unionId，没有调用 identify 方法，会导致SDK不能上报数据，访问数据将大幅减少。如果调用了，但时机不在页面打开时，而在页面使用中较晚的时机，在调用之前若页面关闭则会造成此次访问过程中采集的数据丢失。 如果您不能确定是否要设置这个参数，请先咨询我们技术支持

微信用户信息配置

绑定微信用户 openId 、unionId

上报微信信息，支持按照 openId、unionId 进行用户分群，以及使用微信推送等高级功能。

当页面调用 wx.login 获取到 openId、unionId 后，可以通过 identify 接口绑定微信用户 openId 、unionId，后续在 GrowingIO 平台用户分群功能使用。

接口定义

gio('identify', openId, unionId)

参数说明

示例代码

wx.login({
  success (res) {
    if (res.code) {
      //发起网络请求
      wx.request({
        url: 'https://example.com/onLogin',
        data: {
          code: res.code
        },
        success: res => {
          var openid = res.data.openid;
          var unionid = res.data.unionid;
          // ...
          gio('identify', res.data.openid, res.data.unionid)
        }
      })
    } else {
      console.log('登录失败！' + res.errMsg)
    }
  }
})

如果 SDK 初始化配置项中 没有配置 forceLogin 为 true，而调用了该接口， u(访问用户ID) 字段的值会是自动生成的访问用户ID。如果配置了，调用此接口后，u(访问用户ID) 字段的值会是 参数 openId 的值。

调用 identify 接口会发送 vstr(访问用户变量)事件，但是 openId，unionId 不能作为访问用户变量来使用，会在GrowingIO 平台用户分群功能使用。

微信用户属性设置

作为用户行为数据分析工具，用户信息的完善会给后续的分析带来很大的帮助。在页面中，微信用户属性是非常重要的设置，只有完善了微信用户属性信息，系统自带的微信访问用户变量（如下表）才可以在分析工具中使用，交互数据定义、数据校验功能才会方便通过用户微信相关的信息（微信姓名和头像）定位用户。

当页面上获取到微信用户信息后，可以通过 setVisitor 接口上报微信用户信息，后续在 GrowingIO 平台中使用上述变量分析微信用户属性数据。

接口定义

gio('setVisitor', userInfo)

参数说明

示例代码

wx.getUserInfo({ 
  success: res => 
    // ...
    gio('setVisitor', res.userInfo);
})

微信用户信息包含微信昵称、微信头像、性别、微信所填国家、微信所填省份、微信所填城市。

性别、微信所填国家、微信所填省份、微信所填城市会作为访问用户变量，这些访问用户变量标识符平台会自动生成，无需添加配置。

用户画像中的部分数据，只有在设置微信用户信息后，才可以统计。

登录用户ID

设置登录用户ID，可以将用户行为和您业务系统中的用户ID打通，有助于您在分析用户时，能够进一步了解业务价值上的用户核心行为。

设置登录用户 ID

当用户登录之后调用 setUserId API ，设置登录用户 ID 。

//setUserId API原型
gio('setUserId', userId);
//setuserId API调用示例
gio('setUserId', '1234567890');

清除登录用户 ID

当用户登出之后调用 clearUserId ，清除已经设置的登录用户 ID 。

//clearUserId API原型和调用示例
gio('clearUserId');

设置登录用户属性

当用户在你的小程序上传了注册用户ID后，可以通过 setUser 接口设置注册用户信息，后续在 GrowingIO 中分析这个数据。示例代码如下：

gio('setUserId', user.id); 
gio('setUser', { id: user.id, name: user.name });

3.设置半自动采集浏览事件

用户标记一个元素并提供自定义事件和变量，SDK负责监控，当此元素出现在可视区域中时发送用户配置的自定义事件和变量。

半自动浏览事件指：

  1. 采集用户主动标记的元素，事件类型使用自定义事件类型cstm，需要用户在代码中埋点并且在官网配置自定义事件和变量。

  2. 半自动：指用户提供元素的自定义事件和变量内容，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'})

4. 自定义数据上传API

自定义数据上传API，请参考自定义数据上传API。

5. 创建应用

请在添加了跟踪代码的页面加载几次，上报数据给 GrowingIO。

在GrowingIO平台的创建内嵌页应用。创建应用请参考查看创建应用。

6. 验证SDK是否正常采集数据

方式一：小程序&内嵌页Debugger

方式二：在SDK中设置了Debug模式后，在开发者工具中查看数据采集日志。

方式三：数据校验

上一页Hybrid JS SDK下一页更新日志

最后更新于