Обработка данных из онбордингов в Capacitor SDK

Онбординги объявлены устаревшими в SDK v4 и будут удалены в одном из следующих релизов. Они больше не получают исправлений или улучшений. Используйте флоу: в отличие от онбордингов, которые работают внутри WebView, флоу рендерятся нативно на устройстве — это обеспечивает плавные анимации, нативный внешний вид, быструю загрузку и отсутствие зависимости от WebView. См. Получение флоу и пейволов и Отображение флоу и пейволов.

Когда пользователь отвечает на вопрос викторины или вводит данные в поле ввода, вызывается метод onStateUpdated. Вы можете сохранить или обработать тип поля в своём коде.

Например:

view.setEventHandlers({
  onStateUpdated(action, meta) {
    // Process data
  },
});

Формат action описан здесь.

Примеры сохранённых данных (формат может отличаться в вашей реализации)

// 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
        }
    }
}

Сценарии использования

Обогащение профилей пользователей данными

Если вы хотите сразу связать введённые данные с профилем пользователя и не спрашивать его дважды об одном и том же, нужно обновить профиль пользователя с введёнными данными при обработке действия.

Например, вы просите пользователей ввести имя в текстовое поле с ID name и хотите установить значение этого поля как имя пользователя. Также вы просите ввести email в поле email. В коде вашего приложения это может выглядеть так:

view.setEventHandlers({
  onStateUpdated(action, meta) {
    // Store user preferences or responses
    if (action.elementType === 'input') {
      const profileParams: any = {};
      
      // Map elementId to appropriate profile field
      switch (action.elementId) {
        case 'name':
          if (action.value.type === 'text') {
            profileParams.firstName = action.value.value;
          }
          break;
        case 'email':
          if (action.value.type === 'email') {
            profileParams.email = action.value.value;
          }
          break;
      }
      
      // Update profile if we have data to update
      if (Object.keys(profileParams).length > 0) {
        adapty.updateProfile({ params: profileParams }).catch((error) => {
          // handle the error
        });
      }
    }
  },
});

Настройка пейволов на основе ответов

Используя квизы в онбордингах, вы можете настраивать пейволы, которые показываются пользователям после прохождения онбординга.

Например, можно спросить пользователей об их спортивном опыте и показывать разные CTA и продукты разным группам пользователей.

Добавьте квиз в конструкторе онбординга и присвойте понятные идентификаторы его вариантам ответов.

Обрабатывайте ответы квиза по их идентификаторам и задавайте пользовательские атрибуты для пользователей.

view.setEventHandlers({
  onStateUpdated(action, meta) {
    // Handle quiz responses and set custom attributes
    if (action.elementType === 'select') {
      const profileParams: any = {};
      
      // Map quiz responses to custom attributes
      switch (action.elementId) {
        case 'experience':
          // Set custom attribute 'experience' with the selected value (beginner, amateur, pro)
          profileParams.codableCustomAttributes = {
            experience: action.value.value
          };
          break;
      }
      
      // Update profile if we have data to update
      if (Object.keys(profileParams).length > 0) {
        adapty.updateProfile({ params: profileParams }).catch((error) => {
          // handle the error
        });
      }
    }
  },
});

Создайте сегменты для каждого значения пользовательского атрибута.
Создайте плейсмент и добавьте аудитории для каждого созданного сегмента.
Отобразите пейвол для плейсмента в коде приложения. Если в вашем онбординге есть кнопка, открывающая пейвол, реализуйте код пейвола как реакцию на действие этой кнопки.