Skip to main content

初始化配置

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

配置表格

Config参数类型是否必填默认值说明其它版本
projectIdNSStringnil项目 ID(AccountID),每个应用对应唯一值--
dataSourceIdNSStringnil应用的 DataSourceId,唯一值--
dataCollectionServerHostNSStringnil服务端部署后的 ServerHost--
debugEnabledBOOLNO调试模式,会打印 SDK log,抛出错误异常,在线上环境请关闭--
cellularDataLimitNSUInteger10每天发送数据的流量限制,单位 MB--
dataUploadIntervalNSTimeInterval15数据发送的间隔,单位秒--
sessionIntervalNSTimeInterval30会话后台留存时长,单位秒--
dataCollectionEnabledBOOLYES是否采集数据--
excludeEventint0设置事件过滤->=3.2.1
ignoreFieldint0设置事件属性过滤->=3.2.1
impressionScalefloat0元素曝光事件中的比例因子,范围 [0-1]无埋点独有-
idMappingEnabledBOOLNO是否开启多用户身份上报->=3.3.0
urlSchemeNSString您在 Info.plist 配置的 GrowingIO URL Scheme自定义 URL Scheme->=3.3.0
encryptEnabledBOOLNO是否开启网络传输加密->=3.3.2
requestTimeoutNSTimeInterval30事件请求超时时长,单位秒->=3.8.0

详细说明

1. projectIddataSourceIddataCollectionServerHost

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

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

SDK 版本>=3.2.1

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

8. ignoreField

SDK 版本>=3.2.1

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

9. impressionScale

无埋点 SDK 独有

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

10. idMappingEnabled

SDK 版本>=3.3.0

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

11. urlScheme

SDK 版本>=3.3.0

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

12. encryptEnabled

SDK 版本>=3.3.2,pod ENABLE_ENCRYPTION 已被废弃, 请使用 -[GrowingTrackConfiguration setEncryptEnabled] 进行配置

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

13. requestTimeout

设置事件请求超时时长,超过该时长未请求成功,则将等待下一次事件定时上报,默认为 30 秒。

其他

1. 禁用IDFA

info

采集 SDK 版本 >=3.2.0

禁用 IDFA,且 SDK 中不会再有相关获取 IDFA 代码逻辑

info

使用时注意模块版本需要与采集 SDK 版本保持一致

在您的 Podfile 文件中添加

pod 'GrowingAnalytics/DISABLE_IDFA'

打开终端,切换到项目目录,执行 pod installpod update

项目中无需其他额外设置