QualarooSDK for iOS
Qualaroo 助力公司识别并利用移动访问者收入机会。
如何开始
- 下载 QualarooSDKiOS 并尝试示例应用。
- 查看我们的 wiki 页面。
- 查看文档 - 它位于
Documentation
文件夹中。 - 继续阅读本页面。
- 更新日志
安装
目前推荐并支持使用 CocoaPods 进行安装。
CocoaPods
CocoaPods 是一个用于 Swift 和 Objective-C 的依赖项管理器,它能自动化并简化在项目中使用 QualarooSDK 等第三方库的过程。您可以使用以下命令安装它:
$ gem install cocoapods
使用 CocoaPods 在 Xcode 项目中集成 QualarooSDKiOS,请在 Podfile 中指定它
source 'https://github.com/CocoaPods/Specs.git'
platform :ios, '8.0'
target 'TargetName' do
pod 'Qualaroo', '1.13.1'
end
然后,运行以下命令:
$ pod install
Carthage
简单地添加
github "qualaroo/ios-sdk" ~> 1.13.1
到你的 Cartfile
用法
该框架可以用于iPhone和iPad。它支持iOS 8.0以上版本。
导入
对于Swift,使用 import Qualaroo
对于Objective-C,使用 @import Qualaroo;
确保你已经将 始终嵌入Swift标准库 设置为 是
纯Objective-C项目
如果你在项目中遇到Swift符号无法识别的问题,请向项目中添加一个新的空Swift文件(文件->新建->Swift),并确保当Xcode提示时创建一个Objective C桥接头。
初始化客户端
为了能够使用Qualaroo SDK,你需要首先初始化它。
Qualaroo.shared.configure(with: "<your_key_here>")
初始化后,SDK将通过 Qualaroo.shared
字段可访问。
显示具有给定别名的调查
如果仪表盘中配置的所有条件都满足,则会显示调查问卷。
//Show survey with "your_survey_alias" alias
Qualaroo.shared.showSurvey(with: "your_survey_alias")
您还可以检查特定调查问卷是否会显示(例如:SDK已初始化且所有条件均已满足)。
let willShowSurvey = Qualaroo.shared.willSurveyBeShown(with alias: String)
if (willShowSurvey) {
// do something
}
设置用户属性
//Set unique user id
Qualaroo.shared.setUserID("HAL_9000")
//Add or replace user property "name" to "Hal"
Qualaroo.shared.addUserProperty("name", withValue: "Hal")
//remove property "name"
Qualaroo.shared.removeUserProperty("name")
设置首选语言
您可以为显示调查问卷时设置首选语言。
//Set preferred display language to French
Qualaroo.shared.setPreferredSurveysLanguage("fr");
您提供的语言应该是一个与ISO 639-1兼容的语言代码(两个小写字母)。
配置显示调查问卷的选项
//Omit targetting options
Qualaroo.shared.showSurvey(
with: "your_survey_alias",
forced: true
)
观察与调查相关的活动
为了能够监听事件,您需要创建自己的SurveyDelegate
协议实现。
public protocol SurveyDelegate: class {
/// Survey view has loaded.
func surveyDidStart()
/// User has dismissed survey before finishing it.
func surveyDidDismiss()
/// User finished survey (or dismissed it on last message).
func surveyDidFinish()
/// Some internal error occured. Survey was closed and probably not finished.
func surveyDidClose(errorMessage: String)
/// Some question will be sending callbacks after user has responded. This method is optional.
@objc optional func userDidAnswerQuestion(_ response: UserResponse)
}
要为给定的调查问卷注册调查代理,请使用showSurvey
调用。
class Foo {
let surveyDelegate = YourSurveyDelegateImpl()
func showMySurvey() {
// show "your_survey_alias" survey and register a delagate
Qualaroo.shared.showSurvey(
with: "your_survey_alias",
delegate: surveyDelegate
)
}
}
运行AB测试[实验性!]
您可能想同时测试多个调查问卷并验证哪个表现最好。在提供的调查问卷中,将随机选择一个并向用户展示。这种选择将保留多次应用程序启动之间。
要针对调查问卷"A"、"B"和"C"运行AB测试:
Qualaroo.shared.abTestSurveys(
with: ["my_survey_A", "my_survey_B", "my_survey_C"]
)
请注意,这是一个实验性功能,其实现可能在未来的版本中发生变化。
调试模式
为了获取更多信息并帮助我们解决潜在的bug和问题,请使用以下命令:
Qualaroo.shared.setDebugMode(true)
已知问题
如果您注意到以下日志:无法加载来源于标识为"org.cocoapods.Qualaroo"的bundle中的nib的"logo_ico"图像
,这可能是由于您使用的一些其他库造成的。
如果可能的话,通过创建新问题并与我们分享您的Podfile,我们将为您提供一个解决方案。
功能
如果想要了解Qualaroo提供的功能,请查看我们的维基页面。
沟通
- 如果您是开发者,需要帮助解决某些内部SDK问题或发现bug,请发送邮件至:[email protected]
- 如果您想知道如何通过使用此SDK获益,或如何使用Qualaroo仪表板创建调查,请发送邮件至:[email protected]
- 如果您需要SDK当前尚未提供的功能或功能模块,请发送邮件至:[email protected]