iOS SDK基础API配置

启动功能

全埋点版本SDK

按照集成步骤，配置了info.plist文件之后，不需要调用任何初始化代码，即可根据info.plist文件中的appkey完成初始化工作。

同时，可以在用启动函数(didFinishLaunchingWithOptions)中调用配置一些可选参数。具体有哪些参数，可详见BaiduMobStat.h文件。代码详见 Demo 程序。忽略下文中“startWithAppId函数调用”。

此外，统计支持您根据自己的业务场景需求（如考虑隐私相关条款）设置对单一设备开启或关闭数据采集。具体来说，当您判断该设备不应该进行数据采集时，不在info.plist里配置appkey即可关闭。

手动埋点版本SDK

在应用启动函数(didFinishLaunchingWithOptions)中调用startWithAppId函数即可完成启动功能。

同时，启动SDK功能之前，您还可以配置一些可选参数。具体有哪些参数，可详见BaiduMobStat.h文件。代码详见 Demo 程序。

此外，统计支持您根据自己的业务场景需求（如考虑隐私相关条款）设置对单一设备开启或关闭数据采集。具体来说，当您判断该设备不应该进行数据采集时，不执行startWithAppId即可实现数据采集关闭。

  1. // 设置您在mtj网站上添加的app的appkey,此处AppId即为应用的appKey
  2. [[BaiduMobStat defaultStat] startWithAppId:@"APP KEY"];
  1. // 设置您在mtj网站上添加的app的appkey,此处AppId即为应用的appKey
  2. BaiduMobStat.default().startWithAppId("APP KEY")

参数列表

全埋点版本：以下所有SDK的参数，需要在应用启动函数(didFinishLaunchingWithOptions)中进行设置。

手动埋点版本：以下所有SDK的参数，需要在应用启动函数(didFinishLaunchingWithOptions)中，startWithAppId函数调用之前，进行设置。

自定义用户ID

设置用户自定义的用户识别id设置一次UserId后，用户被永久标记。传入新的userId将替换老的userId。传入nil或空字符串@""，可清空标记。自定义规则的用户识别id（可以使用登录用户账号、手机号等），长度限制256字节

默认值为空字符串""

  1. // 需要在startWithAppId之前调用，设置自定义的用户识别id
  2. [[BaiduMobStat defaultStat] setUserId:@"xxx"];
  1. // 需要在startWithAppId之前调用，设置自定义的用户识别id
  2. BaiduMobStat.default().userId = "xxx"

shortAppVersion

当前默认取与AppStore上一致的版本号（即CFBundleShortVersionString中的版本号），如要修改，可自行获取后传入

默认值为CFBundleShortVersionString中的版本号

  1. // 需要在startWithAppId之前调用，设置App版本号
  2. [[BaiduMobStat defaultStat] setShortAppVersion:@"1.0.0"];
  1. // 需要在startWithAppId之前调用，设置App版本号
  2. BaiduMobStat.default().shortAppVersion = "1.0.0"

channelId

设置渠道Id

默认值为 "AppStore"

  1. // 需要在startWithAppId之前调用，设置渠道ID
  2. [[BaiduMobStat defaultStat] setChannelId:@"AppStore"];
  1. // 需要在startWithAppId之前调用，设置渠道ID
  2. BaiduMobStat.default().channelId = "AppStore"

enableExceptionLog

是否启用Crash日志收集

默认值YES

  1. // 需要在startWithAppId之前调用，设置是否开启Crash日志收集
  2. [[BaiduMobStat defaultStat] setEnableExceptionLog:YES];
  1. // 需要在startWithAppId之前调用，设置是否开启Crash日志收集
  2. BaiduMobStat.default().enableExceptionLog = true

logSendWifiOnly

是否仅在wifi环境下发送日志

默认值NO，即移动网络也允许发送

  1. // 需要在startWithAppId之前调用，设置是否仅在wifi环境下发送日志
  2. [[BaiduMobStat defaultStat] setLogSendWifiOnly:NO];
  1. // 需要在startWithAppId之前调用，设置是否仅在wifi环境下发送日志
  2. BaiduMobStat.default().logSendWifiOnly = false

sessionResumeInterval

设置两次session的最小间隔时间，有效值范围0～600s，例如设置值30s，则应用进入后台后，30s内唤醒为同一次启动

默认值 30s

  1. // 需要在startWithAppId之前调用，设置两次session的最小间隔时间
  2. [[BaiduMobStat defaultStat] setSessionResumeInterval:30];
  1. // 需要在startWithAppId之前调用，设置两次session的最小间隔时间
  2. BaiduMobStat.default().sessionResumeInterval = 30

enableDebugOn

设置是否打印SDK中的日志，用于调试

默认值 NO

  1. // 需要在startWithAppId之前调用，设置是否打印SDK中的日志
  2. [[BaiduMobStat defaultStat] setEnableDebugOn:NO];
  1. // 需要在startWithAppId之前调用，设置是否打印SDK中的日志
  2. BaiduMobStat.default().enableDebugOn = false

enableGps

是否允许获取GPS信息，用于地域统计。SDK不会主动申请GPS权限，只在宿主App已经有获取GPS权限的情况下，才会获取信息。

默认值 YES

  1. // 需要在startWithAppId之前调用，设置是否允许获取GPS信息
  2. [[BaiduMobStat defaultStat] setEnableGps:YES]
  1. // 需要在startWithAppId之前调用，设置是否允许获取GPS信息
  2. BaiduMobStat.default().enableGps = true