Получение онбордингов и их конфигурации
Онбординги устарели начиная с Adapty SDK v4. Используйте флоу: в отличие от онбордингов, которые работают внутри WebView, флоу рендерятся нативно на устройстве — плавные анимации, нативный внешний вид, быстрая загрузка и никакой зависимости от WebView.
После того как вы разработали визуальную часть онбординга с помощью билдера в дашборде Adapty, его можно показать в мобильном приложении. Первый шаг — получить онбординг, связанный с плейсментом, и конфигурацию его отображения, как описано ниже.
Прежде чем начать, убедитесь, что:
- У вас установлен Adapty iOS, Android, React Native или Flutter SDK версии 3.8.0 или выше.
- Вы создали онбординг.
- Вы добавили онбординг в плейсмент.
Получение онбординга
Когда вы создаёте онбординг в нашем no-code редакторе, он сохраняется как контейнер с конфигурацией, которую приложение должно загрузить и отобразить. Этот контейнер управляет всем процессом: какой контент показывать, как его представлять и как обрабатывать действия пользователя (например, ответы на вопросы или заполнение форм). Контейнер также автоматически отслеживает аналитические события, поэтому отдельно реализовывать отслеживание просмотров не нужно.
Для лучшей производительности загружайте конфигурацию онбординга заранее — чтобы изображения успели загрузиться до того, как пользователь увидит экран.
Чтобы получить онбординг, используйте метод getOnboarding:
do {
let onboarding = try await Adapty.getOnboarding(placementId: "YOUR_PLACEMENT_ID")
// the requested onboarding
} catch {
// handle the error
}
Параметры:
| Параметр | Наличие | Описание |
|---|---|---|
| placementId | обязательный | Идентификатор нужного плейсмента. Это значение вы указали при создании плейсмента в дашборде Adapty. |
| locale | опциональный по умолчанию: | Идентификатор локализации онбординга. Ожидается языковой код, состоящий из одного или двух подтегов, разделённых символом минус (-). Первый подтег — язык, второй — регион. Пример: Подробнее о кодах локализаций и рекомендациях по их использованию — в разделе Локализации и коды локалей. |
| fetchPolicy | по умолчанию: .reloadRevalidatingCacheData | По умолчанию SDK пытается загрузить данные с сервера и возвращает кешированные данные в случае ошибки. Мы рекомендуем этот вариант, так как он гарантирует, что пользователи всегда получают самые актуальные данные. Однако если вы считаете, что у ваших пользователей нестабильное интернет-соединение, рассмотрите использование Обратите внимание, что кеш сохраняется при перезапуске приложения и очищается только при переустановке или ручной очистке. Adapty SDK хранит онбординги локально в двух слоях: регулярно обновляемый кеш, описанный выше, и резервные онбординги. Также используется CDN для более быстрой загрузки онбордингов и отдельный резервный сервер на случай недоступности CDN. Эта система обеспечивает получение актуальной версии онбордингов и надёжность даже при слабом интернет-соединении. |
| loadTimeout | по умолчанию: 5 сек | Это значение ограничивает таймаут данного метода. Если сервер Adapty не отвечает вовремя или возвращает ошибку, SDK возвращает кешированный онбординг. Если кеш пуст, а сервер завис или вернул ошибку, SDK запрашивает онбординг с резервного сервера (копия CDN, обслуживающая только аудиторию All Users плейсмента). В крайнем случае SDK возвращает онбординг из вашего резервного файла. SDK v3 использует те же три источника, но в другом порядке. Обратите внимание, что в редких случаях этот метод может завершиться чуть позже указанного в |
| Параметр | Описание |
|---|---|
| Onboarding | Объект AdaptyOnboarding с идентификатором и конфигурацией онбординга, Remote Config и рядом других свойств. |
Ускорьте загрузку онбординга с помощью онбординга для аудитории по умолчанию
Как правило, онбординги загружаются почти мгновенно, и беспокоиться об ускорении этого процесса не нужно. Однако если у вас много аудиторий и онбордингов, а у пользователей слабое интернет-соединение, загрузка онбординга может занять больше времени, чем хотелось бы. В таких случаях лучше показать онбординг по умолчанию, чтобы не оставлять пользователя ни с чем.
Чтобы решить эту задачу, можно использовать метод getOnboardingForDefaultAudience, который получает онбординг указанного плейсмента для аудитории All Users. Однако важно понимать, что рекомендуемый подход — получать онбординг через метод getOnboarding, как описано в разделе Получение онбординга выше.
Рассмотрите возможность использования getOnboarding вместо getOnboardingForDefaultAudience, поскольку последний имеет важные ограничения:
- Проблемы совместимости: может вызвать трудности при поддержке нескольких версий приложения — придётся либо делать обратно совместимые дизайны, либо мириться с тем, что старые версии будут отображать контент некорректно.
- Без персонализации: показывает контент только для аудитории «Все пользователи», без учёта страны, атрибуции или пользовательских атрибутов.
Если более быстрая загрузка важнее этих недостатков в вашем случае, используйте getOnboardingForDefaultAudience, как показано ниже. В противном случае используйте getOnboarding, как описано выше.
Adapty.getOnboardingForDefaultAudience(placementId: "YOUR_PLACEMENT_ID") { result in
switch result {
case let .success(onboarding):
// запрошенный онбординг
case let .failure(error):
// обработка ошибки
}
}
Параметры:
| Параметр | Наличие | Описание |
|---|---|---|
| placementId | обязательный | Идентификатор нужного плейсмента. Это значение вы указали при создании плейсмента в дашборде Adapty. |
| locale | опциональный по умолчанию: | Идентификатор локализации онбординга. Ожидается код языка, состоящий из одного или двух подтегов, разделённых символом минуса (-). Первый подтег обозначает язык, второй — регион. Например: Подробнее о кодах локалей и рекомендациях по их использованию см. в разделе Локализации и коды локалей. |
| fetchPolicy | по умолчанию: .reloadRevalidatingCacheData | По умолчанию SDK пытается загрузить данные с сервера и возвращает кешированные данные в случае сбоя. Мы рекомендуем этот вариант, поскольку он гарантирует, что пользователи всегда получают актуальные данные. Однако если у ваших пользователей нестабильное интернет-соединение, рассмотрите Обратите внимание: кеш сохраняется при перезапуске приложения и очищается только при его переустановке или вручную. Adapty SDK хранит онбординги локально в двух слоях: регулярно обновляемый кеш, описанный выше, и резервные онбординги. Для более быстрой загрузки онбордингов используется CDN, а в случае его недоступности — отдельный резервный сервер. Эта система обеспечивает получение актуальных версий онбордингов при надёжной работе даже при слабом интернет-соединении. |