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

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

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

例：

func onboardingController(_ controller: AdaptyOnboardingController, onStateUpdatedAction action: AdaptyOnboardingsStateUpdatedAction) {
    // Store user preferences or responses
    switch action.params {
    case .select(let params):
        // Handle single selection
    case .multiSelect(let params):
        // Handle multiple selections
    case .input(let params):
        // Handle text input
    case .datePicker(let params):
        // Handle date selection
    }
}

action オブジェクトに含まれる情報：

パラメーター	説明
`elementId`	入力要素の一意の識別子です。回答を保存する際に、質問と回答を紐付けるために使用できます。
`params`	ユーザーの入力データオブジェクトで、typeとvalueのプロパティを含みます。
`params.type`	入力要素のタイプです。以下のいずれかになります： • `"select"` - オプションからの単一選択 • `"multiSelect"` - オプションからの複数選択 • `"input"` - テキスト入力フィールド • `"datePicker"` - 日付選択
`params.value`	ユーザーが選択または入力した値です。構造はタイプによって異なります： • `select`：`id`、`value`、`label` を持つオブジェクト • `multiSelect`：`id`、`value`、`label` を持つオブジェクトの配列 • `input`：`type`、`value` を持つオブジェクト • `datePicker`：`day`、`month`、`year` を持つオブジェクト

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

// 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 フィールドにメールアドレスを入力してもらう場合、アプリのコードは次のようになります：

func onboardingController(_ controller: AdaptyOnboardingController, onStateUpdatedAction action: AdaptyOnboardingsStateUpdatedAction) {
    // Store user preferences or responses
    switch action.params {
    case .input(let params):
        // Handle text input
        let builder = AdaptyProfileParameters.Builder()

        // Map elementId to appropriate profile field
        switch action.elementId {
        case "name":
            builder.with(firstName: params.value.value)
        case "email":
            builder.with(email: params.value.value)
        default:
            break
        }

        // Delegate methods are synchronous; kick off the async update in a Task.
        Task {
            do {
                try await Adapty.updateProfile(params: builder.build())
            } catch {
                // handle the error
            }
        }
    default:
        break
    }
}

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

オンボーディングのクイズを活用して、ユーザーがオンボーディングを完了した後に表示するペイウォールをカスタマイズすることもできます。

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

オンボーディングビルダーでクイズを追加し、各オプションにわかりやすいIDを割り当てます。

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

func onboardingController(_ controller: AdaptyOnboardingController, onStateUpdatedAction action: AdaptyOnboardingsStateUpdatedAction) {
    // Handle quiz responses and set custom attributes
    switch action.params {
    case .select(let params):
        // Handle quiz selection
        let builder = AdaptyProfileParameters.Builder()

        // Map quiz responses to custom attributes
        switch action.elementId {
        case "experience":
            // Set custom attribute 'experience' with the selected value (beginner, amateur, pro)
            try? builder.with(customAttribute: params.value.value, forKey: "experience")
        default:
            break
        }

        // Delegate methods are synchronous; kick off the async update in a Task.
        Task {
            do {
                try await Adapty.updateProfile(params: builder.build())
            } catch {
                // handle the error
            }
        }
    default:
        break
    }
}

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