Kukushka_iOSSDK

Kukushka SDK makes it easy to give players survey tasks followed by a reward. The SDK can be installed and set up in minutes.

This version is designed for the Unity game engine. Other versions of the SDK can be found below:

• Android SDK coming soon!
• Unity SDK

Usage

Just create SurveyMaster:

let master = SurveyMaster(
            userId: String,
            gameKey: String,
            debugMode: Bool
        )

Now you can call two main methods of Kykyshka SDK to preload and show Survey for user:

master.hasSurvey()    // To Check and Preload Available Survey for this user
master.showSurvey()  // To Show Survey for user

SDK Callbacks:
Kukushka SDK has a lot of different Callbacks for your game. Use this callbacks to detect Survey Complete or problems with loading.

Callbacks Example:

// Add Survey Callbacks
master?.onSurveyStart = { _ in
    print("[ViewController] onSurveyStart")
}
master?.onSurveySuccess = { [weak self] nq in
    guard let nq, nq else {
        self?.statusLabel.text = "Последний опрос пройден успешно"
        return
    }
    self?.statusLabel.text = "Пользователь не подошёл под целевую группу последнего опроса"
}
master?.onFail = { [weak self] _ in
    self?.statusLabel.text = "Последний опрос не пройден"
}
master?.onLoadFail = { [weak self] _ in
    self?.statusLabel.text = "Ошибка загрузки"
}
            
// Add Preloading Callbacks
master?.onSurveyAvailable = { [weak self] data in
    self?.statusLabel.text = "Подходящий опрос найден"
}
master?.onSurveyUnavailable = { [weak self] data in
    self?.statusLabel.text = "Подходящий опрос не найден"
    
}

Screen Orientation:

Please, note: Currently version of Kukushka SDK supports only Portrait orientation and your game orientation will be force changed to Portrait at Survey opening and returned to last orientation after Survey closed.

Example

To run the example project, clone the repo, and run pod install from the Example directory first.

Requirements

• iOS 13.0+
• Swift 5

Installation

Kukushka_iOSSDK is available through CocoaPods. To install it, simply add the following line to your Podfile:

pod 'Kukushka_iOSSDK'

Author

Name, contacts

License

Kukushka_iOSSDK is available under the MIT license. See the LICENSE file for more info.