Saas升级指南
平台版本确认
首先请先确认您使用的平台版本,Web SDK 4.0 仅支持 4.2.0 及以上版本的分析云。
如果您使用的平台是 GrowingIO官网 ,即使用 2.x 版本SDK,请联系我们购买升级新产品后再进行升级操作。
如果您使用的平台版本是 4.0平台,且版本号大于等于4.2.0 ,您可以继续参考下文进行升级操作。
如果您使用的平台版本不在上述范围内,请咨询我们的技术支持。
SDK版本确认
如何确认您使用的SDK版本?
在您的站点(或浏览器控制台)通过调用 window.vds
查看。
SDK升级
下面将正式介绍SDK从2.x版本升级到4.0版本的步骤。
1、修 改集成代码
如果您使用标准CDN集成方式(即直接复制原2.0文档的集成代码方式)进行集成,请参考集成文档重新集成SDK。
如果您是下载SDK至本地项目集成,请前往下载地址下载4.0版本SDK并加载至项目中。
提示:4.0版本的SDK默认方法名为 gdp
,如果您想继续沿用 gio
的名称,请参考文档修改自定义命名空间。
2、检查初始化配置项
移除已废弃的配置项:imp
、manualImp
、impAttrSeparator
。未使用则忽略。如果您想禁用半自动采集浏览事件,请按需集成SDK,不要注册半自动采集浏览插件即可。
其他配置项请参考文档按需配置功能,如果您不确定是否需要对应配置项,请咨询我们的技术支持。
3、检查api调用
以下步骤仅列出需要改动的点,没有列出的api或内容即为自动兼容无需更改。
- 移除
send
方法调用。4.0版本已不再需要它,SDK在初始化完成后且dataCollect
开启状态下自动上报数据。 - 移除
setConfig
、config
方法调用。SDK仅支持init
方法进行初始化和初始化配置。如需在运行过程中动态修改配置,请使用setOption
参考文档。未使用则忽略。 - 移除
evar.set
方法调用。如需使用转化变量,请将转化变量放在埋点事件属性(track)中进行上报。未使用则忽略。 - 移除
visitor.set
方法调用。如需使用访问用户变量,请将访问用户变量放在用户属性(setUserAttributes)中进行上报。未使用则忽略。 - 重命名替换
page.set
为setPageAttributes
,并且需要参考文档setPageListener
进行相应的修改。 - 重命名替换
people.set
为setUserAttributes
,调用方式不变。未使用则忽略。 - 重命名替换
setUser
为setUserAttributes
,调用方式不变。未使用则忽略。 - 重命名替换
hybridSetUserId
为setUserId
,调用方式不变。未使用则忽略。 - 重命名替换
hybridClearUserId
为clearUserId
,调用方式不变。未使用则忽略。 - 修改
getVisitUserId
为getDeviceId
,调用方式变更,请参考文档修改使用方式。未使用则忽略。
4、检查半自动采集浏览事件(曝光事件)
请参考文档检查半自动采集浏览事件的定义方式是否符合新版本要求。
不再支持自定义分隔符,仅支持JSON格式数据或单字段定义的方式。
5、检查埋点事件和用户属性事件
检查埋点事件(track)、用户属性事件(setUserAttributes)、半自动采集浏览事件(曝光事件)的属性键值对,key和value是否符合限制条件参考文档,如有超出限制或超出限制的可能,请调整业务逻辑。
6、检查采集标记
从4.0版本开始,所有事件中的index字段取值将从 1 开始,所以如果您在页面中使用了data-growing-index
或 data-growing-idx
,请注意排查修改。