初始化配置

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

gdp('init','your GrowingIO projectId', 'your dataSourceID', 'your AppId', {
version: '小程序版本',
host: 'api.growingio.com',
...其他配置项(可配置项见下表)
});

初始化可配置项

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

字段名

参数类型

必填

默认值

说明

autotrack

boolean

true

是否开启无埋点采集 影响事件:VIEW_CLICK, VIEW_CHANGE, FORM_SUBMIT

comAsPage

boolean

false

是否将 Component 当做 Page 处理

dataCollect

boolean

true

是否开启数据采集

debug

boolean

false

是否开启 debug 模式

forceLogin

boolean

false

是否开启 forceLogin 强制登录模式

compress

boolean

false

是否开启数据压缩加密

getLocation

object

见下两项配置

获取位置配置项

getLocation.autoGet

boolean

false

自动获取用户位置信息(需要用户授权)

getLocation.type

wgs84/gcj02

wgs84

坐标系类型。wgs84:标准坐标系;gcj02:火星坐标系

host

string

-

数据上报地址

ignoreFields

string[]

-

要忽略的字段仅支持以下字段: networkState,screenHeight,screenWidth deviceBrand,deviceModel,deviceType

taro

any

-

使用 Taro 开发时使用的实例

usePlugin

boolean

false

是否使用第三方插件

version

string

-

小程序应用版本(建议填写)

vue

any

-

使用 uni-app/mpvue/WePY 开发时使用的实例

详细说明

设置无埋点

默认情况下,SDK开启无埋点采集。如果您不需要无埋点采集,可以通过指定 autotrack: false 关闭。 关闭无埋点后 VIEW_CLICK, VIEW_CHANGE, FORM_SUBMIT 事件将不会再被采集和上报。

gdp('init','your GrowingIO projectId', 'your dataSourceID', 'your AppId', {
version: '小程序版本',
autotrack: false,
...其他配置项(可配置项见下表)
});

设置数据采集

默认情况下,SDK开启数据采集。如果您需要初始化时暂时关闭数据采集,可以通过指定 dataCollect: false 关闭。 初始化关闭数据采集后,至您打开数据采集之前都不会采集数据和上报。

gdp('init','your GrowingIO projectId', 'your dataSourceID', 'your AppId', {
version: '小程序版本',
dataCollect: false,
...其他配置项(可配置项见下表)
});

开启调试模式

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

gdp('init','your GrowingIO projectId', 'your dataSourceID', 'your AppId', {
version: '小程序版本',
debug: true,
...其他配置项(可配置项见下表)
});

设置强制登录模式

默认情况下,SDK通过自动生成的 uid 上报标识用户,如您需要根据 openId 标识用户,可以通过指定 forceLogin: true 来打开强制登录模式。 打开后SDK会暂停上报数据,待用户登录获取 openId,调用 identify 方法设置 访问用户id 为 openId 后继续数据采集,以此来关联用户。

gdp('identify', openId);

注意:

如果用户在打开您的微信小程后没有使用微信授权登录,但是小程序配置了forceLogin为true,会导致SDK不能采集数据,访问数据将大幅减少。如果您不能确定是否要设置这个参数,请先咨询我们。

设置忽略字段

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