用户引导 | Kotlin Multiplatform SDK | Adapty 文档

在 Kotlin Multiplatform SDK 中处理用户引导数据

用户引导功能在 SDK v4 中已废弃,将在未来版本中移除。 该功能不再接受修复或改进。请改用 流程:与在 WebView 中运行的用户引导不同,流程直接在设备上原生渲染,带来更流畅的动画效果、一致的原生外观、更快的加载速度,且无需依赖 WebView 运行时。请参阅获取流程与付费墙展示流程与付费墙快速上手。

当您的用户回答测验问题或在输入字段中填写数据时,onboardingViewOnStateUpdatedAction 方法将被调用。您可以在代码中保存或处理字段类型。

例如:


class MyAdaptyUIOnboardingsEventsObserver : AdaptyUIOnboardingsEventsObserver {
    override fun onboardingViewOnStateUpdatedAction(
        view: AdaptyUIOnboardingView,
        meta: AdaptyUIOnboardingMeta,
        elementId: String,
        params: AdaptyOnboardingsStateUpdatedParams
    ) {
        // Store user preferences or responses
        when (params) {
            is AdaptyOnboardingsSelectParams -> {
                // Handle single selection
                val id = params.id
                val value = params.value
                val label = params.label
                AppLogger.d("Selected option: $label (id: $id, value: $value)")
            }
            is AdaptyOnboardingsMultiSelectParams -> {
                // Handle multiple selections
            }
            is AdaptyOnboardingsInputParams -> {
                // Handle text input
            }
            is AdaptyOnboardingsDatePickerParams -> {
                // Handle date selection
            }
        }
    }
}

// Set up the observer
AdaptyUI.setOnboardingsEventsObserver(MyAdaptyUIOnboardingsEventsObserver())
已保存数据示例(格式可能因实现方式不同而有所差异)
   // Example of a saved select action
   {
       "id": "onboarding_on_state_updated_action",
       "view": { /* AdaptyUI.OnboardingView object */ },
       "meta": {
       "onboarding_id": "onboarding_123",
       "screen_cid": "preferences_screen",
       "screen_index": 1,
       "total_screens": 3
   },
       "action": {
       "element_id": "preference_selector",
       "element_type": "select",
       "value": {
       "id": "option_1",
       "value": "premium",
       "label": "Premium Plan"
   }
   }
   }

   // Example of a saved multi-select action
   {
       "id": "onboarding_on_state_updated_action",
       "view": { /* AdaptyUI.OnboardingView object */ },
       "meta": {
       "onboarding_id": "onboarding_123",
       "screen_cid": "interests_screen",
       "screen_index": 2,
       "total_screens": 3
   },
       "action": {
       "element_id": "interests_selector",
       "element_type": "multi_select",
       "value": [
   {
       "id": "interest_1",
       "value": "sports",
       "label": "Sports"
   },
   {
       "id": "interest_2",
       "value": "music",
       "label": "Music"
   }
       ]
   }
   }

   // Example of a saved input action
   {
       "id": "onboarding_on_state_updated_action",
       "view": { /* AdaptyUI.OnboardingView object */ },
       "meta": {
       "onboarding_id": "onboarding_123",
       "screen_cid": "profile_screen",
       "screen_index": 0,
       "total_screens": 3
   },
       "action": {
       "element_id": "name_input",
       "element_type": "input",
       "value": {
       "type": "text",
       "value": "John Doe"
   }
   }
   }

   // Example of a saved date picker action
   {
       "id": "onboarding_on_state_updated_action",
       "view": { /* AdaptyUI.OnboardingView object */ },
       "meta": {
       "onboarding_id": "onboarding_123",
       "screen_cid": "profile_screen",
       "screen_index": 0,
       "total_screens": 3
   },
       "action": {
       "element_id": "birthday_picker",
       "element_type": "date_picker",
       "value": {
       "day": 15,
       "month": 6,
       "year": 1990
   }
   }
   }

使用场景

用户画像数据补充

如果你希望立即将用户输入的数据与用户画像关联,避免重复询问相同信息,可以在处理操作时更新用户画像,将输入数据写入其中。

例如,你让用户在 ID 为 name 的文本字段中输入姓名,并希望将该字段的值设置为用户的名字;同时,你让用户在 email 字段中输入邮箱。在你的应用代码中,实现方式可能如下:


class MyAdaptyUIOnboardingsEventsObserver : AdaptyUIOnboardingsEventsObserver {
    override fun onboardingViewOnStateUpdatedAction(
        view: AdaptyUIOnboardingView,
        meta: AdaptyUIOnboardingMeta,
        elementId: String,
        params: AdaptyOnboardingsStateUpdatedParams
    ) {
        // Store user preferences or responses
        when (params) {
            is AdaptyOnboardingsInputParams -> {
                // Handle text input
                val builder = AdaptyProfileParameters.Builder()

                // Map elementId to appropriate profile field
                when (elementId) {
                    "name" -> {
                        when (val input = params.input) {
                            is AdaptyOnboardingsTextInput -> {
                                builder.withFirstName(input.value)
                            }
                        }
                    }
                    "email" -> {
                        when (val input = params.input) {
                            is AdaptyOnboardingsEmailInput -> {
                                builder.withEmail(input.value)
                            }
                        }
                    }
                }

                // Update profile asynchronously
                mainUiScope.launch {
                    val profileParams = builder.build()
                    val result = Adapty.updateProfile(profileParams)
                    result.onSuccess { profile ->
                        // Profile updated successfully
                        AppLogger.d("Profile updated: ${profile.email}")
                    }.onError { error ->
                        // Handle the error
                        AppLogger.e("Failed to update profile: ${error.message}")
                    }
                }
            }
        }
    }
}

// Set up the observer
AdaptyUI.setOnboardingsEventsObserver(MyAdaptyUIOnboardingsEventsObserver())

根据答案定制付费墙

在用户引导中使用测验,您还可以根据用户完成用户引导后的答案来定制向其展示的付费墙。

例如,您可以询问用户的运动经验,并向不同用户群体展示不同的 CTA 和产品。

  1. 在用户引导编辑器中添加测验,并为测验选项分配有意义的 ID。
experience.webp
  1. 根据 ID 处理测验响应,并为用户设置自定义属性

class MyAdaptyUIOnboardingsEventsObserver : AdaptyUIOnboardingsEventsObserver {
    override fun onboardingViewOnStateUpdatedAction(
        view: AdaptyUIOnboardingView,
        meta: AdaptyUIOnboardingMeta,
        elementId: String,
        params: AdaptyOnboardingsStateUpdatedParams
    ) {
        // Handle quiz responses and set custom attributes
        when (params) {
            is AdaptyOnboardingsSelectParams -> {
                // Handle quiz selection
                val builder = AdaptyProfileParameters.Builder()

                // Map quiz responses to custom attributes
                when (elementId) {
                    "experience" -> {
                        // Set custom attribute 'experience' with the selected value (beginner, amateur, pro)
                        builder.withCustomAttribute("experience", params.value)
                    }
                }

                // Update profile asynchronously
                mainUiScope.launch {
                    val profileParams = builder.build()
                    val result = Adapty.updateProfile(profileParams)
                    result.onSuccess { profile ->
                        // Profile updated successfully
                        AppLogger.d("Custom attribute 'experience' set to: ${params.value}")
                    }.onError { error ->
                        // Handle the error
                        AppLogger.e("Failed to update profile: ${error.message}")
                    }
                }
            }
        }
    }
}

// Set up the observer
AdaptyUI.setOnboardingsEventsObserver(MyAdaptyUIOnboardingsEventsObserver())
  1. 为每个自定义属性值创建市场细分
  2. 创建一个版位,并为你创建的每个市场细分添加目标受众
  3. 在你的应用代码中为该版位展示付费墙。如果你的用户引导中有一个打开付费墙的按钮,请将付费墙代码实现为响应该按钮操作