Android SDKでオンボーディングのデータを処理する

SDK v4以降では、オンボーディングのより強力な代替手段としてフローを構築できます。オンボーディングがWebView内で動作するのとは異なり、フローはデバイス上でネイティブにレンダリングされるため、よりスムーズなアニメーション、一貫したAndroidのルック＆フィール、高速な読み込み、WebViewランタイムへの依存なしで利用できます。始めるには、フローとペイウォールの取得およびフローとペイウォールの表示をご覧ください。

ユーザーがクイズの質問に回答したり、入力フィールドにデータを入力したりすると、onStateUpdatedAction メソッドが呼び出されます。フィールドの種類をコード内で保存・処理することができます。

例：

override fun onStateUpdatedAction(action: AdaptyOnboardingStateUpdatedAction, context: Context) {
    // Store user preferences or responses
    when (val params = action.params) {
        is AdaptyOnboardingStateUpdatedParams.Select -> {
            // Handle single selection
        }
        is AdaptyOnboardingStateUpdatedParams.MultiSelect -> {
            // Handle multiple selections
        }
        is AdaptyOnboardingStateUpdatedParams.Input -> {
            // Handle text input
        }
        is AdaptyOnboardingStateUpdatedParams.DatePicker -> {
            // Handle date selection
        }
    }
}

アクション形式についてはこちらをご覧ください。

保存されたデータの例（フォーマットは実装によって異なる場合があります）

// Example of a saved select action
{
    "elementId": "preference_selector",
    "meta": {
        "onboardingId": "onboarding_123",
        "screenClientId": "preferences_screen",
        "screenIndex": 1,
        "screensTotal": 3
    },
    "params": {
        "type": "select",
        "value": {
            "id": "option_1",
            "value": "premium",
            "label": "Premium Plan"
        }
    }
}

// Example of a saved multi-select action
{
    "elementId": "interests_selector",
    "meta": {
        "onboardingId": "onboarding_123",
        "screenClientId": "interests_screen",
        "screenIndex": 2,
        "screensTotal": 3
    },
    "params": {
        "type": "multiSelect",
        "value": [
            {
                "id": "interest_1",
                "value": "sports",
                "label": "Sports"
            },
            {
                "id": "interest_2",
                "value": "music",
                "label": "Music"
            }
        ]
    }
}

// Example of a saved input action
{
    "elementId": "name_input",
    "meta": {
        "onboardingId": "onboarding_123",
        "screenClientId": "profile_screen",
        "screenIndex": 0,
        "screensTotal": 3
    },
    "params": {
        "type": "input",
        "value": {
            "type": "text",
            "value": "John Doe"
        }
    }
}

// Example of a saved date picker action
{
    "elementId": "birthday_picker",
    "meta": {
        "onboardingId": "onboarding_123",
        "screenClientId": "profile_screen",
        "screenIndex": 0,
        "screensTotal": 3
    },
"params": {
    "type": "datePicker",
    "value": {
        "day": 15,
        "month": 6,
        "year": 1990
        }
    }
}

ユースケース

ユーザープロファイルをデータで充実させる

入力データをユーザープロファイルと即座に紐づけ、同じ情報を二度尋ねないようにするには、アクションを処理する際に入力データでユーザープロファイルを更新する必要があります。

たとえば、name IDのテキストフィールドでユーザーに名前の入力を求め、その値をユーザーの名（ファーストネーム）として設定したい場合や、email フィールドでメールアドレスを入力してもらう場合、アプリのコードは次のようになります。

override fun onStateUpdatedAction(action: AdaptyOnboardingStateUpdatedAction, context: Context) {
    // Store user preferences or responses
    when (val params = action.params) {
        is AdaptyOnboardingStateUpdatedParams.Input -> {
            // Handle text input
            val builder = AdaptyProfileParameters.Builder()
            
            // Map elementId to appropriate profile field
            when (action.elementId) {
                "name" -> {
                    when (val inputParams = params.params) {
                        is AdaptyOnboardingInputParams.Text -> {
                            builder.withFirstName(inputParams.value)
                        }
                    }
                }
                "email" -> {
                    when (val inputParams = params.params) {
                        is AdaptyOnboardingInputParams.Email -> {
                            builder.withEmail(inputParams.value)
                        }
                    }
                }
            }
            
            Adapty.updateProfile(builder.build()) { error ->
                if (error != null) {
                    // handle the error
                }
            }
        }
    }
}

回答に基づいてペイウォールをカスタマイズする

オンボーディングでクイズを使うと、オンボーディング完了後にユーザーに表示するペイウォールもカスタマイズできます。

たとえば、スポーツの経験についてユーザーに質問し、ユーザーグループごとに異なるCTAやプロダクトを表示することができます。

オンボーディングビルダーでクイズを追加し、各選択肢に意味のあるIDを割り当てます。

IDに基づいてクイズの回答を処理し、ユーザーにカスタム属性を設定します。

override fun onStateUpdatedAction(action: AdaptyOnboardingStateUpdatedAction, context: Context) {
    // Handle quiz responses and set custom attributes
    when (val params = action.params) {
        is AdaptyOnboardingStateUpdatedParams.Select -> {
            // Handle quiz selection
            val builder = AdaptyProfileParameters.Builder()
            
            // Map quiz responses to custom attributes
            when (action.elementId) {
                "experience" -> {
                    // Set custom attribute 'experience' with the selected value (beginner, amateur, pro)
                    builder.withCustomAttribute("experience", params.params.value)
                }
            }
            
            Adapty.updateProfile(builder.build()) { error ->
                if (error != null) {
                    // handle the error
                }
            }
        }
    }
}

カスタム属性の値ごとにセグメントを作成します。
プレースメントを作成し、作成した各セグメントのオーディエンスを追加します。
アプリのコードでそのプレースメントのペイウォールを表示します。オンボーディングにペイウォールを開くボタンがある場合は、そのボタンのアクションへのレスポンスとしてペイウォールのコードを実装してください。