Skip to main content

初始化配置

配置一览表​

下表中列出了所有WebJS SDK的配置项，请按需设置。如您不确定是否需要，请咨询我们。

字段名参数类型默认值说明
autotrackbooleantrue是否开启无埋点采集，集成无埋点插件后默认开启无埋点采集
cookieDomainstring当前站点的一级域名自定义cookie存储的域
compressbooleantrue是否数据加密，集成加密插件后默认开启加密
dataCollectbooleantrue是否开启数据采集
debugbooleanfalse是否开启调试模式
enableIdMappingbooleanfalse是否开启多用户身份上报
hashtagbooleanfalse是否开启hash解析
hoststring-数据上报的服务端地址(无需携带协议头)(必填)
ignoreFieldsstring[]-上报忽略字段
requestTimeoutnumber5000上报降级至xhr和图片时，请求的超时时长
sendTypestringbeacon数据上报优先方式
schemestringlocation.protocol网络协议
storageTypestringcookieSDK信息的持久化存储的类型(仅支持cookie或localStorage)
versionstring-Web应用发版版本号(建议填写)

配置项详解​

autotrack​

默认情况下，无埋点开关默认开启。当在 SDK 中加载了无埋点插件时会自动启用无埋点采集功能。如果您不需要无埋点采集，可以通过以下两种方式进行关闭：

方式一：全量集成时 或 按需集成已注册插件，初始化设置 autotrack: false 进行关闭。

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

方式二：按需集成时移除无埋点插件即可。

关闭无埋点后 VIEW_CLICK , VIEW_CHANGE , FORM_SUBMIT 事件将不会再被采集和上报。

您也可以通过调用动态修改配置接口来修改它。参考文档

cookieDomain​

默认情况下，SDK的用户信息（deviceId、userId、sessionId等）都是存储在您站点的主域名下，子域名都集成SDK时会共享用户信息。但如果您需要进行区分，配置此项并指定为当前的子域名即可区分用户信息进行数据隔离。

例：您有a.growingio.com和b.growingio.com两个或多个子域名，通常情况下都集成SDK访问时会共享用户信息，即视为同一个用户。如果您希望进行区分和数据隔离，指定cookieDomain为各自的完整子域名即可。

注意：SDK版本>=3.8.0-rc.9支持。

compress​

默认情况下，加密开关默认开启。当在 SDK 中加载了加密插件时自动启用数据加密功能。如果您不需要数据加密，可以通过以下两种方式进行关闭：

方式一：全量集成时 或 按需集成已注册插件，初始化设置 compress: false 进行关闭。

gdp('init', accountId, datasourceId, { compress: false });

方式二：按需集成时移除加密插件即可。

注意：开启加密后抓包工具无法抓取上报的明文数据，但debug模式开启时开发者工具中仍能看到未加密的上报数据。

dataCollect​

默认情况下，数据采集开关默认开启。如果您需要初始化时暂时关闭数据采集（例如隐私协议的场景），可以通过指定 dataCollect: false 关闭。 需要开启数据采集时再通过调用动态修改配置接口来修改它。参考文档

初始化关闭数据采集后，至您打开数据采集之前都不会采集数据和上报。

gdp('init', accountId, datasourceId, { dataCollect: false });

debug​

在开发时设置 debug: true，打开开发者工具控制台，即可看到实时采集的数据。注意正式上线时关闭它，尤其是开启了数据加密时。

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

您也可以通过调用动态修改配置接口来修改它。参考文档

enableIdMapping​

多用户身份上报，是否开启多用户身份上报，默认不开启。开启后，调用设置登录用户ID接口时，设置 userKey，服务端调用用户身份融合API时，可将不同的登录用户ID识别为同一用户。开启多用户身份上报后，需要在设置登录用户ID时设置userKey。参考文档

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

hashtag​

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

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

ignoreFields​

默认情况下，SDK会上报设备的相关信息。如果您不需要这些数据，可以通过指定 ignoreFields: [xxx,xxx] 来忽略指定字段的上报。 您可以指定一项或多项字段，但均需为数组格式进行设置。支持字段如下：

screenHeight      屏幕高度
screenWidth       屏幕宽度

示例​

gdp('init', '91eaf9b283361032', 'ae45f95742195faa', 'wx123456', {
  version: '1.0.1',
  debug: true,
  ignoreFields: [
    'screenHeight',
    'screenWidth'
  ],
});

requestTimeout​

默认情况下，SDK的上报请求在XHR和图片的形式下超时时长为 5000毫秒（即5秒），超时即自动失败。当您需要控制降级至XHR和图片的数据上报发送方式请求超时时长时可修改，以避免一些意外的网络请求阻塞的问题。

配置项取值：整数大于0，单位毫秒。

注意：该配置项仅在XHR和图片请求时生效，beacon请求无法控制。

gdp('init', accountId, datasourceId, { requestTimeout: '3000' });

sendType​

默认情况下，SDK上报数据的请求方式为自动判断，优先使用sendBeacon进行上报；当sendBeacon无法支持或队列繁忙无法继续使用时，会自动降级为XMLHttpRequest异步请求；当XMLHttpRequest遇到问题发送失败时，会自动降级为图片请求继续上报。

如果您的站点对某些请求方式有特殊限制或更愿意使用其中某种方式时，可指定优先上报的方式，失败时依然会按上述优先级自动降级。

配置项取值：beacon、xhr、image，默认值beacon。

注意：在您修改默认的优先上报方式之前，请在网络上查阅相关资料以充分了解3种发送方式的区别及优缺点。

gdp('init', accountId, datasourceId, { sendType: 'xhr' });

scheme​

默认情况下，网络协议为自动获取location.protocol，但考虑到在开发的过程中可能需要使用http等指定协议的测试服务，因此我们提供了初始化修改数据上报网络协议的配置。注意正式上线时关闭它或指定正确的协议，否则可能会因为跨域等问题导致数据上报失败。

gdp('init', accountId, datasourceId, { scheme: 'http' });

您也可以通过调用动态修改配置接口来修改它。参考文档