初始化配置

配置一览表

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

字段名	参数类型	默认值	说明
`dataCollect`	`boolean`	`true`	是否开启数据采集
`debug`	`boolean`	`false`	是否开启调试模式
`idMapping`	`boolean`	`false`	是否开启多用户身份上报
`extraParams`	`string[]`	`[]`	与 H5 数据打通时额外获取的字段
`followShare`	`boolean`	`true`	是否跟踪分享数据
`forceLogin`	`boolean`	`false`	是否开启强制登录模式
`ignoreFields`	`string[]`	`[]`	上报忽略字段
`requestTimeout`	`number`	`5000`	上报请求超时时长
`serverUrl`	`string`	`https://napi.growingio.com`	数据上报的服务端地址
`taro`	`any`	`-`	使用 Taro 开发时使用的实例，参考集成示例代码
`taroVue`	`any`	`-`	使用 Taro3vue2/3 开发时使用的实例，参考集成示例代码
`tbConfig`	`object`	`-`	淘宝小程序配置项
`uniVue`	`any`	`-`	使用 uni-app 开发时使用的实例，参考集成示例代码
`uploadInterval`	`number`	`1000`	SDK 上报数据的节流间隔时间(单位：ms)
`version`	`string`	`1.0.0`	小程序发版版本号(建议填写)

配置项详解

dataCollect

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

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

gdp('init', accountId, dataSourceId, appId, {
  dataCollect: false,
  ...其他配置项,
});

提示：隐私协议相关逻辑请参考文档。

debug

在开发时设置 debug: true，打开开发者工具控制台，即可看到实时采集的数据。您也可以通过调用动态修改配置接口来修改它。参考文档

gdp('init', accountId, dataSourceId, appId, {
  debug: true,
  ...其他配置项,
});

注意：正式上线时请关闭它，尤其是开启了数据加密时。

idMapping

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

gdp('init', accountId, dataSourceId, appId, {
  idMapping: true,
  ...其他配置项,
});

extraParams

当调用getGioInfo时，除了默认字段以外，可增加以下小程序 SDK 字段。

可选字段	字段含义	可选字段	字段含义	可选字段	字段含义
appChannel	场景值	language	语言	networkState	网络类型
deviceBrand	设备品牌	screenWidth	屏幕宽度	operatingSystem	系统类型
deviceModel	设备型号	screenHeight	屏幕高度	platformVersion	操作系统版本

示例

gdp('init', accountId, dataSourceId, appId, {
  extraParams: [
    'appChannel',
    'deviceBrand',
    'deviceModel',
    'language',
    'networkState',
    'operatingSystem',
    'platformVersion',
    'screenHeight',
    'screenWidth',
  ],
  ...其他配置项,
});

注意：内嵌页集成的 Web JS SDK 版本需>=4.0.0。

followShare

默认情况下，SDK 开启跟踪分享数据功能，自动上报分享事件，详细的进行转发分享的统计，来帮助您更好的分析。

如您不需要此功能，可以通过指定 followShare: false 来关闭跟踪分享，分享事件将不再上报。

gdp('init', accountId, dataSourceId, appId, {
  followShare: false,
  ...其他配置项,
});

forceLogin

默认情况下，SDK 会自动生成访问用户 ID 来标识访问用户。如您需要使用 openId 或 unionId 标识访问用户，可以通过指定 forceLogin: true 来打开强制登录模式。

gdp('init', accountId, dataSourceId, appId, {
  forceLogin: true,
  ...其他配置项,
});

强制登录模式适用于打开小程序就调用 wx.login (参考文档) 获取 openId 或 unionId 的小程序。开启此模式并调用 identity 上报 openId 或 unionId，会将上报的 Id 作为访问用户 ID，有助于访问用户数据关联性分析。

设置forceLogin为true后，SDK 会暂停上报数据，待调用 wx.login后获取 openId 或 unionId，调用 identify 方法后开始数据上报。调用 identify 会替换事件数据的 deviceId 为设定值（一般是小程序 openId 或 unionId），包括调用identify之前触发的事件。

gdp('identify', openId / unionId);

注意：

如果打开小程序后没有调用 wx.login 获取 openId 或 unionId，没有调用 identify 方法，但是小程序 SDK 配置了 forceLogin 为 true，会导致 SDK 不能上报数据，访问数据将大幅减少。如果您不能确定是否要设置这个参数，请先咨询我们技术支持。
如果小程序首页中使用的是内嵌 H5 页面，需要使用内嵌 H5 用户数据打通功能。该场景下，需要在小程序冷启动时，使用开屏页(在小程序首页 page 前增加一个 page 开屏页)作为过渡。

ignoreFields

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

可选字段	字段含义	可选字段	字段含义
deviceBrand	设备品牌	operatingSystem	系统类型
deviceModel	设备型号	screenWidth	屏幕宽度
networkState	网络类型	screenHeight	屏幕高度

示例

gdp('init', accountId, dataSourceId, appId, {
  ignoreFields: [
    'deviceBrand',
    'deviceModel',
    'operatingSystem',
    'networkState',
    'screenHeight',
    'screenWidth',
  ],
  ...其他配置项,
});

注意：如果 extraParams 和 ignoreFields 中同时指定了同一字段，getGioInfo 将不再获取到指定的字段，即 ignoreFields 优先级更高。

requestTimeout

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

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

gdp('init', accountId, dataSourceId, appId, {
  requestTimeout: 3000,
  ...其他配置项,
});

originalSource

默认情况下，SDK发送访问事件（VISIT）时，会使用用户初始进入小程序时的path和query信息，以保证能正确上报utm参数等进入信息。但是需要注意的点是，当您的小程序不是在用户进入的页面发送访问事件时，会导致VISIT事件和PAGE事件上报的path和query不一致，从而平台的页面跳出率数据会异常。

举例：如果您的小程序在进入时关闭了数据采集，用户进入P1页面，操作后跳转进入P2页面，然后您打开了采集开关。此时，发送的VISIT事件中的path和query是P1页面的，而PAGE事件的path和query则是P2页面的，这就会导致跳出率异常。

如果您不是上述场景，维持默认值即可；如果您是上述场景，不考虑utm相关信息丢失的问题且想保证跳出率准确，那么可以关闭该配置项。

gdp('init', accountId, datasourceId, appId, {
  originalSource: false,
  ...其他配置项,
});

serverUrl

Saas客户忽略此项配置；OP私有部署客户请填写此项，否则您的服务将无法收获行为数据上报。支持域名和IP地址。

gdp('init', accountId, datasourceId, appId, {
  serverUrl: 'your server url',
  ...其他配置项,
});

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

注意：与3.x版本的SDK不同的是，您需要填写携带协议头的完整服务地址。

tbConfig

淘宝小程序必填项。您需要指定为云函数单发或者为云应用配置服务信息。其中云函数配置与云应用配置方式字段互斥，只能选择其中一种方式进行配置，配置字段均为必填，请求类型均为 POST。

两种方式的区别为：云函数直接发送数据至 Gio 平台，但域名及所有字段需要申请淘宝白名单；云应用为发送至客户服务端，然后再转发至 Gio 平台。

云应用调用时，SDK 给指定云服务接口地址发送上报数据外，还会在 params 中额外带上host, accountId, stm字段用于服务端拼接 Gio 转发地址。

云函数配置方式：

gdp('init',accountId, dataSourceId, appId, {
  tbConfig: {
      cloudFuncSend: true,             // 是否使用云函数进行数据单发，默认为 false
      cloudFuncName: 'httpTunnel'      // 调用的云函数名称，默认为 httpTunnel
      cloudFuncHandler: 'main'         // 指定云函数的handler，默认为 main
  },
  ...其他配置项
});

云应用配置方式：

gdp('init', accountId, dataSourceId, appId, {
  tbConfig: {
    cloudAppId: 'xxxxxx', // 云应用Id，无默认值
    path: 'your cloudApp interface path', // 云应用数据接口，无默认值
  },
  ...其他配置项,
});

uploadInterval

为了 SDK 采集数据尽可能地减小对小程序的性能影响，我们为数据上报设置了 1 秒的节流限制以减少 SDK 并发上报的请求数量。在埋点量大或触发时机频繁时尤其适用。但这也有可能会在用户过快地结束小程序访问时丢失最后行为数据的极端情况。所以提供了uploadInterval配置项允许您自行评估影响并合理地设置。

单位：ms；允许设值范围 0 ~ 2000；默认 1000（即 1 秒）。

gdp('init', accountId, dataSourceId, appId, {
  uploadInterval: 1000,
  ...其他配置项,
});

影响参考：

数值越小，节流限制越小，发送时间越接近事件产生时间；设为 0 则产生事件立即上报。虽然行为数据上报及时，但是发起请求的次数会明显增多，大量埋点产生时可能会挤占一部分请求资源，从而导致业务接口的请求被短暂阻塞，进而影响页面数据加载。

相反，数值越大，节流限制越大，发送时间越远离事件产生时间；设为 2000 则产生事件后会推入请求队列进行计时，直至下一次事件产生的间隔超过 2 秒或者 2 秒内没有事件产生才上报数据（请求队列中存储的事件数达到 50 条时会强制发送一次）。虽然请求次数会变少，但是一旦用户操作过快杀掉了小程序进程或者退出了小程序，最后的行为数据可能就被丢失无法上报。

我们推荐使用 1 秒（即默认值）的间隔限制，最大程度上减少性能影响同时兼顾数据上报准确性。

version

该字段的含义为当前客户站点的版本号，建议填写，可用于分析不同版本之间数据的对比。如不填写，默认值则为1.0.0。

gdp('init', accountId, datasourceId, {
  version: 'your miniprogram app version',
  ...其他配置项,
});

配置一览表​

配置项详解​

dataCollect​

debug​

idMapping​

extraParams​

示例​

followShare​

forceLogin​

ignoreFields​

示例​

requestTimeout​

originalSource​

serverUrl​

tbConfig​

uploadInterval​

version​