初始化配置

在初始化过程中,SDK会接收一个由用户传入的默认配置Configuration,配置相关说明如下表:

配置表格

Config

参数类型

是否必填

默认值

说明

其它

projectId

NSString

null

项目ID,每个应用对应唯一值

-

dataSourceId

NSString

null

应用的DataSourceId,唯一值

-

dataCollectionServerHost

NSString

null

服务端部署后的 ServerHost

-

debugEnabled

BOOL

NO

调试模式,会打印SDK log,抛出错误异常,在线上环境请关闭

-

cellularDataLimit

NSUInteger

10

设置每天使用数据网络(3G\4G\5G)上传的数据量的上限(单位是 MB)

-

dataUploadInterval

NSTimeInterval

15

数据发送的间隔,单位秒

-

sessionInterval

NSTimeInterval

30

会话后台留存时长,单位秒

-

dataCollectionEnabled

BOOL

YES

是否采集数据

-

excludeEvent

int

0

设置事件过滤

-

ignoreField

int

0

设置事件属性过滤

-

impressionScale

float

0

元素曝光事件中的比例因子,范围 [0-1]

无埋点独有

详细说明

  1. projectId urlScheme setDataSourceId setDataCollectionServerHost 这四个参数为 CDP 用户必须要设置的参数,若不清楚具体数值请询问相关服务端对接的开发同事。

  2. debugEnabled 默认不开启,开启后会输出如上所示的SDK Log 日志。

  3. cellularDataLimit 为每日在4G环境下的流量限制,默认为10M。WIFI环境下则不计流量。

  4. dataUploadInterval 上报间隔 GrowingIO SDK 会先将事件存入数据库中,然后以每隔默认时间15秒的情况下向服务器发送事件包(最大50条事件)。

  5. sessionInterval 设置会话后台留存时长 指当前会话在应用进入后台后的最大留存时间,默认为30秒。另外,其他情况下也会重新生成一个新的会话,如设置用户ID等核心信息,重新打开数据收集等。

  6. dataCollectionEnabled 数据收集 当数据收集关闭时,SDK将不会再获取设备信息,也不会产生事件和上报事件。

  7. excludeEvent 事件过滤 默认情况下,事件不会进行过滤。但若不想采集某些事件可以在此设置。事件类型可以参考 GrowingEventFilter

  8. ignoreField 事件属性过滤 事件属性指上报事件中携带的属性参数。可过滤事件属性可以参考 GrowingFieldsIgnore

  9. impressionScale 曝光比例 与曝光事件结合使用。曝光比例是指当一个曝光的View出现在屏幕时可见的部分占据自身尺寸的比例,比如说若设为0则表示只要出现即产生曝光事件,若设为1则表示要整个View都出现在屏幕中。