Skip to main content

初始化配置

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

配置表格​

Config参数类型是否必填默认值说明其它版本
accountIdString是nil项目 ID(AccountID),每个应用对应唯一值-
dataSourceIdString是nil应用的 DataSourceId,唯一值-
dataCollectionServerHostString否napi.growingio.com服务端部署后的 ServerHost-
debugEnabledBool否false调试模式,会打印 SDK log,抛出错误异常,在线上环境请关闭-
cellularDataLimitUInt否10每天发送数据的流量限制,单位 MB-
dataUploadIntervalTimeInterval否15数据发送的间隔,单位秒-
sessionIntervalTimeInterval否30会话后台留存时长,单位秒-
dataCollectionEnabledBool否true是否采集数据-
excludeEventUInt否0设置事件过滤-
ignoreFieldUInt否0设置事件属性过滤-
impressionScaleFloat否0元素曝光事件中的比例因子,范围 [0-1]无埋点独有
idMappingEnabledBool否false是否开启多用户身份上报-
urlSchemeString否您在 Info.plist 配置的 GrowingIO URL Scheme自定义 URL Scheme-
encryptEnabledBool否false是否开启网络传输加密-
compressEnabledBool否false是否开启网络传输压缩->=4.3.0
useProtobufBool否true是否采用 Protobuf 格式保存和上传事件数据-
autotrackEnabledBool否true是否开启无埋点采集无埋点独有
autotrackAllPagesBool否false是否开启页面自动采集无埋点独有>=4.2.0
dataValidityPeriodNSUInteger否7本地未上报的事件数据有效时长,单位天->=4.3.0
customEventWithPathBool否false自定义埋点事件是否自动关联上一个页面->=4.4.0

详细说明​

1. accountId, dataSourceId, dataCollectionServerHost​

这些为必传参数,若不清楚具体数值请询问相关服务端对接的开发同事。

dataCollectionServerHost 默认域名为 SaaS 收数地址,若是 OP 客户,需要设置自己的 ServerHost。

2. debugEnabled​

默认不开启,开启后会输出 SDK Log 日志。

3. cellularDataLimit​

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

4. dataUploadInterval​

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

5. sessionInterval​

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

6. dataCollectionEnabled​

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

7. excludeEvent​

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

8. ignoreField​

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

9. impressionScale​

无埋点 SDK 独有

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

10. idMappingEnabled​

是否支持多用户身份上报, 默认不支持。 是否支持多用户身份上报, 与 API 接口setLoginUserId:userKey:对应,需要上报 userkey 时开启; 开启时,userKey会在每次上报数据时携带;关闭时,userKey不上报。

11. urlScheme​

自定义运行时 URL Scheme,如存在多环境配置,可基于不同环境进行自定义,需同时在 Info.plist 中添加各环境对应的 URL Scheme

12. encryptEnabled​

设置为 true 时,网络传输内容将会加密,不会明文显示。

13. compressEnabled​

设置为 true 时,网络传输内容将会使用 LZ4 进行压缩。

14. useProtobuf​

是否使用 Google Protobuf 格式保存和上传事件数据,默认为 true,为 false 则采用 JSON 格式

15. autotrackEnabled​

当集成无埋点 SDK 时,设置为 false 将关闭无埋点功能和自动采集

16. autotrackAllPages​

当集成无埋点 SDK 时,设置为 true 将开启页面自动采集,alias 默认为 ViewController 的类名;通过调用 autotrackPage 接口所配置的 alias 将覆盖默认值

17. dataValidityPeriod​

每当 SDK 初始化时,将根据所配置的事件有效时长,清除本地已过期的事件数据

18. customEventWithPath​

设置为 true 时,自定义埋点事件将通过 path 字段,自动关联到埋点事件所在页面浏览事件上,默认为 false