字节跳动小程序SDK

准备条件

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

1. 添加跟踪代码

根据字节跳动小程序框架选择 SDK 并添加跟踪代码。

参照小程序的开发框架,下载相应的SDK,并添加跟踪代码。

  • 字节跳动 原生框架

  • Taro 框架

  • mpvue / uni-app 框架

原生框架
Taro框架
mpvue框架/uni-app框架
原生框架

1. 下载 gio-bytedance-minp.js 文件

把文件放在字节跳动小程序项目里,比如 utils 目录下。

curl --compressed https://assets.giocdn.com/sdk/gio-bytedance-minp.js -o gio-bytedance-minp.js

2、添加跟踪代码

方式一:

在根目录 app.js 文件的顶部添加跟踪代码。

var gio = require("utils/gio-bytedance-minp.js").default;
gio('init', '你的 GrowingIO 项目ID', '你的小程序AppID', { version: '小程序版本' });

方式二:

步骤一:新建一个 gioConfig.js 文件,并且配置 gioConfig.js 文件中的 必要 配置参数。

export default {
projectId: '你的 GrowingIO 项目ID',
appId: '你的小程序AppID',
version: '小程序版本'
...
}

步骤二:在根目录 app.js文件的顶部添加跟踪代码。

var gio = require("utils/gio-bytedance-minp.js").default;
var gioConfig = require("你的 gioConfig.js 文件地址").default;
gio('setConfig', gioConfig);
Taro框架

1.下载 gio-bytedance-minp.js 文件

把文件放在字节跳动小程序项目里,比如 utils 目录下。

curl --compressed https://assets.giocdn.com/sdk/gio-bytedance-minp.js -o gio-bytedance-minp.js

2、添加跟踪代码

方式一:

在根目录 app.js 文件的顶部添加跟踪代码。

import Taro from '@tarojs/taro';
var gio = require("utils/gio-bytedance-minp.js").default;
gio('init', '你的 GrowingIO 项目ID', '你的小程序AppID', { version: '小程序版本', taro: Taro });

方式二:

步骤一:新建一个 gioConfig.js 文件,并且配置 gioConfig.js 文件中的 必要 配置参数。

import Taro from '@tarojs/taro';
export default {
projectId: '你的 GrowingIO 项目ID',
appId: '你的小程序AppID',
version: '小程序版本',
taro: Taro,
...
}

步骤二:在根目录 app.js文件的顶部添加跟踪代码。

var gio = require("utils/gio-bytedance-minp.js").default;
var gioConfig = require("你的 gioConfig.js 文件地址").default;
gio('setConfig', gioConfig);
mpvue框架/uni-app框架

1.下载 gio-bytedance-minp.js 文件

把文件放在字节跳动小程序项目里,比如 utils 目录下。

curl --compressed https://assets.giocdn.com/sdk/gio-bytedance-minp.esm.js -o gio-bytedance-minp.j

2、添加跟踪代码

方式一:

在根目录 app.js 文件的顶部添加跟踪代码。

import Vue from 'vue';
import App from './App';
App.mpType = 'app';
var gio = require("utils/gio-bytedance-minp.js").default;
gio('init', '你的 GrowingIO 项目ID', '你的小程序AppID', { version: '小程序版本', vue: Vue });

方式二:

步骤一:新建一个 gioConfig.js 文件,并且配置 gioConfig.js 文件中的 必要 配置参数。

import Vue from 'vue';
export default {
projectId: '你的 GrowingIO 项目ID',
appId: '你的小程序AppID',
version: '小程序版本',
vue: Vue
...
}

步骤二:在根目录 app.js文件的顶部添加跟踪代码。

var gio = require("utils/gio-bytedance-minp.js").default;
var gioConfig = require("你的 gioConfig.js 文件地址").default;
gio('setConfig', gioConfig);

2. SDK参数配置

建议每次发布小程序新版本的时候,更新一下版本号 version,可以在 GrowingIO 分析不同版本的数据。除了 version 之外,还有以下额外参数可以使用。

参数

解释

version

string

你的小程序的版本号

getLocation autoGet

true | false

是否自动获取用户的地理位置信息。默认false

getLocation type

wgs84 | gcj02

gcj02 为火星坐标系

followShare

true | false

详细跟踪分享数据,开启后可使用分享分析功能。默认true

forceLogin

true | false

你的小程序是否强制要求用户登陆字节跳动获取 openid,默认 false

debug

true | false

是否开启调试模式,可以看到采集的数据。默认 false

forceLogin 是一个需要特别注意的参数。GrowingIO 默认会在小程序里面设置用户标识符,存储在字节跳动 Storage 里面。这个用户标识符潜在可能会被 clearStorage 清除掉,所以有可能不同的用户标识符对应同一个字节跳动里的 openid。如果你的小程序在用户打开后会去做登陆并且获取 openid 和/或 unionid,可以设置 forceLogin 为 true。当 forceLogin 为 true 的时候,用户标识符会使用 openid,潜在风险是如果没有设置 openid,数据不会发送,所以请特别注意这个参数的设置。

gio('init', '你的 GrowingIO 项目ID', '你的小程序AppID', { version: '小程序版本', forceLogin: true });
...
// 当获取到 userid 后,调用以下方法
gio("identify", userid);

3. 添加请求服务器域名

要正常采集字节跳动小程序的数据并发送给 GrowingIO,需要在字节跳动小程序里事先设置一个通讯域名,允许跟 GrowingIO API 服务器进行网络通信。具体步骤如下:

  1. 登录字节跳动小程序后台,进入配置

  2. 打开开发设置,到服务器域名配置部分

  3. 在request合法域名中添加:https://wxapi.growingio.com

4. 字节跳动小程序 用户属性设置

作为用户行为数据分析工具,用户信息的完善会给后续的分析带来很大的帮助。在小程序中,字节跳动用户属性是非常重要的设置,只有完善了字节跳动用户属性信息,字节跳动的访问用户变量(如下表)才可以在分析工具中使用,交互数据定义、数据校验功能才会方便通过用户字节跳动相关的信息(字节跳动姓名和头像)定位用户。

下面是专门针对用户的接口。

绑定字节跳动用户ID

当用户在你的小程序上登陆获取到 openid 后,可以用过 identify 接口绑定字节跳动用户ID,后续在 GrowingIO 中获取更准确的字节跳动访问用户量。示例代码如下:

tt.request({
url: 'https://YOUR_HOST_NAME/wechat/code2key',
method: 'GET',
data: { code: res.code },
success: function(res) {
var openid = res.data.openid;
var unionid = res.data.unionid;
...
gio('identify', openid, unionid);
}
})

设置字节跳动用户信息

当用户在你的小程序上绑定字节跳动信息后,可以通过 setVisitor 接口设置字节跳动用户信息,后续在 GrowingIO 中分析这个数据。示例代码如下:

tt.getUserInfo({
success: function(res) {
...
gio('setVisitor', res.userInfo);
}
})

QQ信息包含QQ昵称QQ头像性别QQ所填国家QQ所填省份QQ所填城市

字节跳动信息包含字节跳动昵称字节跳动头像性别字节跳动所填国家字节跳动所填省份字节跳动所填城市

*注:用户画像中的部分数据,只有在设置字节跳动用户信息后,才可以统计。

设置登录用户ID

当用户在你的小程序上注册以后,你的产品应用服务端会在用户数据库里添加一条记录并且分配一个 ID,可以通过 setUserId 接口设置注册用户ID,后续在 GrowingIO 中分析登录用户这个数据。示例代码如下:

gio('setUserId', YOUR_USER_ID);

清除登录用户ID

用户退出登录时,清除登录用户ID。

gio('clearUserId');

设置登录用户属性

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

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

5. 自定义数据上传API

自定义数据上传API,请参考自定义数据上传API

6. 创建应用

请在添加了跟踪代码的支付宝小程序重新启动几次,发送数据给 GrowingIO。

在GrowingIO平台的创建微信小游戏应用。创建应用请参考查看创建应用

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

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

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

方式三:数据校验