初始化配置

Web JS SDK在初始化时,接收最后一个对象参数作为初始化配置项,基本格式如下:

// 最后一个参数即为初始化配置项
gdp('init', 'your projectId', 'your dataSourceId', {
host: 'your apiServerHost',
version: '1.0.0',
debug: true
});

配置表格

该表格列出了当前sdk内置的配置项,但也可以根据插件来新增自定义配置。

字段

参数类型

是否必填

默认值

说明

projectId

String

项目id

dataSourceId

String

数据源id

appId

String

小程序id

host

String

发数请求host

scheme

String

location.protocol获取

默认location.protocol,也可以自定义设置

compress

boolean

false

是否进行数据压缩加密

dataCollect

boolean

true

是否进行数据采集

debug

boolean

false

是否开启debug模式

hashtag

boolean

false

是否开启hash模式

autotrack

boolean

true

是否开启无埋点采集 view_click,view_change,form_submit

enableIdMapping

boolean

false

是否开启id mapping允许 设置userKey

ignoreFields

String[]

要忽略的字段仅支持以下字段 screenWidth,screenHeight

platform

String

web

应用的平台支持字段 web wxwv minp alip baidup qq bytedance

version

String

应用版本(建议填写)对appVer保持兼容

plugins

GioPlugin[]

自定义要启用的插件详细可见插件篇

详细说明

设置请求协议

scheme 为请求协议。默认情况下,scheme 会根据您的网站协议来自行判断。也可以根据请求协议设置scheme。

gdp('init', projectId, datasourceId, { scheme: 'https' });

设置请求host

host 为当前应用埋点数据的接受服务器的域名。默认不配置 host,需要在初始化时设置 host,否则会初始化失败。

gdp('init', projectId, datasourceId, { host: 'api.growingio.com' });

设置debug模式

debug为日志输出模式。默认为 false,在初始化时设置debug模式为true,打开浏览器控制台,即可看到实时采集的数据。

gdp('init', projectId, datasourceId, { debug: true });

设置开启hashtag识别

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

gdp('init', projectId, datasourceId, { hashtag: true });

设置无埋点采集

autotrack为控制无埋点采集。默认情况下是开启,如果想关闭可以初始化时配置autotrack: false,将不再自动采集页面浏览、按钮点击等无埋点事件 。

gdp('init', projectId, datasourceId, { autotrack: false });

设置IdMapping高级功能

enableIDMapping 为 id mapping的高级功能。默认情况是关闭,如需开启可如下配置。(若不了解请勿配置)

gdp('init', projedtId, datasourceId, { enableIdMapping: true });

设置应用版本version

version 是网站版本号。默认无设置,如果网站在不停升级版本,同时想了解不同版本的数据情况,可以参考如下代码设置应用版本。在实际使用中应用版本对移动端 app 更有价值。

gdp('init', projectId, datasourceId, { version: 'v1.0.2' });

对appVer进行了兼容,配置appVer也有效。但后期可能不持续支持!

开启数据压缩

compress 为数据压缩加密。默认为 false,发送数据是明文,可以设置为 true 将数据压缩,一方面保证数据不能被直接查看,增强了数据的安全性。另一方面可以节省用户的流量。

gdp('init', projectId, datasourceId, { compress: true });

设置应用平台

不建议主动设置除了web和wxwv之外的值。GrowingIO会对设置的值进行限制,如果不合规,将被默认为web。合规的选项可见上表格。

该设置会体现在测量协议的platform字段上,如果在与小程序打通的情况下,不论初始时设置的为什么值,其都会被设置为对应的小程序平台。

gdp('init', projectId, datasourceId, { platform: 'web' });