Получение флоу и пейволов - Unity

Что возвращает GetFlow
Флоу Создаются в Flow Builder — рендерятся нативно на устройстве, без WebView
Пейволы Paywall Builder Весь существующий контент Paywall Builder

После того как вы разработали флоу или пейвол в Paywall Builder, его можно отобразить в мобильном приложении. Первый шаг — получить флоу или пейвол, связанный с плейсментом, и его конфигурацию отображения, как описано ниже.

Хотите увидеть реальный пример интеграции Adapty SDK в мобильное приложение? Посмотрите наши примеры приложений — они демонстрируют полную настройку: отображение пейволов, совершение покупок и другие базовые функции.

Прежде чем начать отображать флоу в мобильном приложении (нажмите, чтобы развернуть)
  1. Создайте продукты в дашборде Adapty.
  2. Создайте флоу/пейвол и добавьте в него продукты в дашборде Adapty.
  3. Создайте плейсменты и добавьте в них флоу/пейвол в дашборде Adapty.
  4. Установите Adapty SDK в своё мобильное приложение.

Получение флоу/пейвола

Если вы создали флоу или пейвол с помощью Flow Builder или Paywall Builder, вам не нужно беспокоиться об их отрисовке в коде мобильного приложения для показа пользователю. Такой флоу или пейвол содержит в себе и то, что должно отображаться, и то, как это должно выглядеть. Тем не менее вам нужно получить его ID через плейсмент, конфигурацию представления, а затем отобразить его в приложении.

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

Чтобы получить флоу или пейвол, используйте метод GetFlow:

Adapty.GetFlow(
    "YOUR_PLACEMENT_ID",
    AdaptyPlacementFetchPolicy.Default,
    TimeSpan.FromSeconds(5),
    (flow, error) => {
        if (error != null) {
            // handle the error
            return;
        }

        // flow - the requested flow/paywall
    }
);

Параметры:

ПараметрНаличиеОписание
placementIdобязательныйИдентификатор нужного плейсмента. Это значение вы указывали при создании плейсмента в дашборде Adapty.
fetchPolicyпо умолчанию: AdaptyPlacementFetchPolicy.Default

По умолчанию SDK пытается загрузить данные с сервера и возвращает кешированные данные в случае сбоя. Мы рекомендуем этот вариант, поскольку он гарантирует, что пользователи всегда получают актуальные данные.

Однако если у ваших пользователей нестабильное интернет-соединение, рассмотрите использование AdaptyPlacementFetchPolicy.ReturnCacheDataElseLoad — оно возвращает кешированные данные, если они есть. В этом случае пользователи могут не получить самые последние данные, зато загрузка будет быстрее вне зависимости от качества соединения. Кеш регулярно обновляется, поэтому его безопасно использовать в течение сессии, чтобы избежать лишних сетевых запросов.

Обратите внимание: кеш сохраняется при перезапуске приложения и очищается только при его переустановке или вручную.

Adapty SDK хранит флоу и пейволы локально в двух слоях: регулярно обновляемый кеш, описанный выше, и резервные пейволы. Для ускорения загрузки также используется CDN, а при его недоступности — отдельный резервный сервер. Такая система гарантирует получение актуальной версии данных и надёжную работу даже при нестабильном интернет-соединении.

loadTimeoutпо умолчанию: 5 сек

Это значение ограничивает таймаут данного метода. При достижении таймаута будут возвращены кешированные данные или локальный резерв.

Обратите внимание: в редких случаях метод может завершиться с таймаутом чуть позже указанного в loadTimeout значения, поскольку операция может включать несколько запросов под капотом.

ПараметрОписание
FlowОбъект AdaptyFlow, содержащий плейсмент, идентификаторы (InstanceIdentity, VariationId), название, варианты пейволов (Paywalls — список объектов AdaptyFlowPaywall) и Remote Config (RemoteConfigs — список с одной записью на каждую локаль). Чтобы получить продукты для предзагрузки, кастомного UI или программных проверок, вызовите GetPaywallProducts(flow).

Получение конфигурации представления

После получения флоу или пейвола загрузите конфигурацию его представления и создайте представление за один шаг с помощью метода CreateFlowView. Отдельного флага для проверки нет: если плейсмент был создан в Flow Builder (флоу) или Paywall Builder (пейвол), CreateFlowView вернёт представление, готовое к отображению. Если плейсмент — это кастомный пейвол без UI Builder, CreateFlowView вернёт ошибку — обработайте её как пейвол с Remote Config.

Убедитесь, что в Flow Builder включён переключатель Show on device. Если эта опция не включена, конфигурация представления не будет доступна для получения.

var parameters = new AdaptyUICreateFlowViewParameters()
    .SetPreloadProducts(true)
    .SetLoadTimeout(TimeSpan.FromSeconds(5));

AdaptyUI.CreateFlowView(flow, parameters, (view, error) => {
    if (error != null) {
        // the flow has no view configured, or view creation failed
        return;
    }

    // use view
});
ПараметрОбязательностьОписание
flowобязательныйОбъект AdaptyFlow, полученный через Adapty.GetFlow.
LocaleнеобязательныйИдентификатор локализации Builder для отображения флоу или пейвола, например en или pt-br. Флоу локализуется при создании вью, поэтому здесь единственное место, где можно выбрать локализацию. SDK не читает локаль устройства: если параметр не задан, флоу отображается на en или в локали по умолчанию, если локализации en нет. Код должен точно совпадать с кодом локализации флоу. См. Использование локализаций и кодов локали.
LoadTimeoutнеобязательныйОграничивает время ожидания для этого метода. Если таймаут истёк, будут возвращены кешированные данные или локальный резервный вариант. Обратите внимание, что в редких случаях метод может завершиться чуть позже заданного значения LoadTimeout, поскольку операция может включать несколько запросов.
PreloadProductsнеобязательныйУстановите true, чтобы заранее загрузить продукты для повышения производительности. При включении продукты загружаются заблаговременно, сокращая время до отображения флоу или пейвола.
ProductPurchaseParametersнеобязательныйТолько Android (игнорируется на iOS). Словарь из AdaptyProductIdentifier в AdaptyPurchaseParameters. Используйте для настройки параметров покупки — персонализированных предложений или параметров обновления подписки для отдельных продуктов во флоу или пейволе.
EnableSafeAreaPaddingsнеобязательныйТолько Android (игнорируется на iOS). Если true, вью флоу применяет отступы безопасной зоны. По умолчанию: true. Значение по умолчанию подходит для большинства случаев.

Если вы используете несколько языков, узнайте, как добавить локализацию в Builder.

После загрузки покажите флоу или пейвол.

Получите флоу или пейвол для аудитории по умолчанию, чтобы ускорить загрузку

Обычно флоу и пейволы загружаются почти мгновенно, так что беспокоиться об ускорении этого процесса не нужно. Однако если у вас много аудиторий и плейсментов, а у пользователей слабое интернет-соединение, загрузка флоу или пейвола может занять больше времени, чем хотелось бы. В таких ситуациях имеет смысл показывать флоу или пейвол по умолчанию — это обеспечит плавный пользовательский опыт вместо пустого экрана.

Чтобы решить эту задачу, можно воспользоваться методом GetFlowForDefaultAudience, который получает флоу или пейвол указанного плейсмента для аудитории All Users. Однако важно понимать, что рекомендуемый подход — получать флоу или пейвол через метод GetFlow, как описано в разделе Получение флоу/пейвола выше.

Почему мы рекомендуем использовать GetFlow

Метод GetFlowForDefaultAudience имеет ряд существенных недостатков:

  • Возможные проблемы с обратной совместимостью: если нужно показывать разные флоу для разных версий приложения (текущей и будущих), могут возникнуть сложности. Придётся либо проектировать флоу с учётом текущей (устаревшей) версии, либо мириться с тем, что у пользователей этой версии флоу может не отображаться.
  • Потеря таргетинга: все пользователи будут видеть один и тот же флоу, настроенный для аудитории All Users, — то есть вы теряете персонализированный таргетинг (в том числе по странам, маркетинговой атрибуции или собственным кастомным атрибутам).

Если вы готовы принять эти ограничения ради более быстрой загрузки флоу или пейвола, используйте метод GetFlowForDefaultAudience следующим образом. В противном случае используйте GetFlow, описанный выше.

Adapty.GetFlowForDefaultAudience(
    "YOUR_PLACEMENT_ID",
    AdaptyPlacementFetchPolicy.Default,
    (flow, error) => {
        if (error != null) {
            // handle the error
            return;
        }

        // flow - the requested flow
    }
);
ПараметрНаличиеОписание
placementIdобязательныйИдентификатор плейсмента. Это значение вы указываете при создании плейсмента в дашборде Adapty.
fetchPolicyпо умолчанию: AdaptyPlacementFetchPolicy.Default

По умолчанию SDK пытается загрузить данные с сервера и возвращает кешированные данные в случае ошибки. Мы рекомендуем этот вариант, так как он гарантирует, что пользователи всегда получают самые актуальные данные.

Однако если вы считаете, что у ваших пользователей нестабильное интернет-соединение, используйте AdaptyPlacementFetchPolicy.ReturnCacheDataElseLoad, чтобы возвращать кешированные данные при их наличии. В этом случае пользователи могут получать не самые последние данные, но загрузка будет быстрее вне зависимости от качества соединения. Кеш регулярно обновляется, поэтому его безопасно использовать в течение сессии во избежание лишних сетевых запросов.

Обратите внимание, что кеш сохраняется при перезапуске приложения и очищается только при его переустановке или вручную.

Настройка ресурсов

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

У hero-изображений и видео есть предопределённые идентификаторы: hero_image и hero_video. В пользовательском пакете ресурсов вы адресуете эти элементы по их идентификаторам и настраиваете их поведение.

Для остальных изображений и видео необходимо задать пользовательский идентификатор в дашборде Adapty.

Например, вы можете:

  • Показывать разное изображение или видео отдельным пользователям.
  • Показывать локальное превью-изображение, пока загружается основное удалённое изображение.
  • Показывать превью-изображение перед запуском видео.

Вот пример того, как можно передать кастомные ресурсы через простой словарь:

var customAssets = new Dictionary<string, AdaptyCustomAsset>
{
    { "custom_image", AdaptyCustomAsset.LocalImageFile("custom_assets/images/custom_image.png") },
    { "hero_video", AdaptyCustomAsset.LocalVideoFile("custom_assets/videos/custom_video.mp4") }
};

var parameters = new AdaptyUICreateFlowViewParameters()
    .SetCustomAssets(customAssets)
    .SetLoadTimeout(TimeSpan.FromSeconds(3));

AdaptyUI.CreateFlowView(flow, parameters, (view, error) => {
    // handle the result
});

Если ресурс не найден или не загружается, флоу или пейвол вернётся к внешнему виду по умолчанию, заданному в Builder.

Настройка таймеров, заданных разработчиком

Чтобы использовать пользовательские таймеры в приложении Unity, передайте словарь с идентификаторами таймеров и датами их окончания в метод SetCustomTimers. Пример:

var customTimers = new Dictionary<string, DateTime> {
    { "CUSTOM_TIMER_6H", DateTime.Now.AddHours(6) },
    { "CUSTOM_TIMER_NY", new DateTime(2026, 1, 1) }
};

var parameters = new AdaptyUICreateFlowViewParameters()
    .SetCustomTimers(customTimers)
    .SetLoadTimeout(TimeSpan.FromSeconds(3));

AdaptyUI.CreateFlowView(flow, parameters, (view, error) => {
    // handle the result
});

В этом примере CUSTOM_TIMER_NY и CUSTOM_TIMER_6H — это Timer ID пользовательских таймеров, заданных вами в дашборде Adapty. Резолвер таймеров обеспечивает динамическое обновление каждого таймера корректным значением в вашем приложении. Например:

  • CUSTOM_TIMER_NY: время, оставшееся до окончания действия таймера, например до Нового года.
  • CUSTOM_TIMER_6H: время, оставшееся в 6-часовом периоде, который начался, когда пользователь открыл флоу или пейвол.

После того как вы разработали визуальную часть пейвола в новом Paywall Builder в дашборде Adapty, вы можете отобразить его в мобильном приложении. Первый шаг — получить пейвол, связанный с плейсментом, и его конфигурацию представления, как описано ниже.

Новый Paywall Builder работает с Unity SDK версии 3.3.0 и выше.

Обратите внимание: эта тема относится к пейволам, созданным с помощью Paywall Builder. Если вы реализуете пейволы вручную, обратитесь к теме Получение пейволов и продуктов для пейволов с Remote Config в мобильном приложении.

Хотите увидеть реальный пример интеграции Adapty SDK в мобильное приложение? Посмотрите наши примеры приложений — они демонстрируют полную настройку: отображение пейволов, совершение покупок и другие базовые функции.

Прежде чем начать отображать пейволы в мобильном приложении (нажмите, чтобы развернуть)
  1. Создайте продукты в дашборде Adapty.
  2. Создайте пейвол и добавьте в него продукты в дашборде Adapty.
  3. Создайте плейсменты и добавьте в них пейвол в дашборде Adapty.
  4. Установите Adapty SDK в своём мобильном приложении.

Получение пейвола, созданного в Paywall Builder

Если вы создали пейвол в Paywall Builder, вам не нужно беспокоиться о его отображении в коде мобильного приложения — пейвол уже содержит всё необходимое: что и как должно быть показано. Тем не менее, вам нужно получить его ID через плейсмент, конфигурацию отображения, а затем показать пейвол в приложении. Для оптимальной производительности важно получать пейвол и его конфигурацию отображения как можно раньше, чтобы изображения успели загрузиться до того, как пользователь увидит пейвол.

Чтобы получить пейвол, используйте метод GetPaywall:

Adapty.GetPaywall("YOUR_PLACEMENT_ID", "en", (paywall, error) => {
  if(error != null) {
    // handle the error
    return;
  }
  
  // paywall - the resulting object
});

Параметры:

ПараметрНаличиеОписание
placementIdобязательныйИдентификатор нужного плейсмента. Это значение вы указали при создании плейсмента в дашборде Adapty.
locale

опциональный

по умолчанию: en

Идентификатор локализации пейвола. Ожидается языковой код, состоящий из одного или двух подтегов, разделённых символом минус (-). Первый подтег — язык, второй — регион.

Пример: en означает английский, pt-br — португальский (Бразилия).

Подробнее о кодах локалей и рекомендациях по их использованию — в разделе Локализации и коды локалей.

fetchPolicyпо умолчанию: .reloadRevalidatingCacheData

По умолчанию SDK пытается загрузить данные с сервера и возвращает кешированные данные в случае ошибки. Мы рекомендуем этот вариант, так как он гарантирует, что пользователи всегда получают самые актуальные данные.

Однако если ваши пользователи часто сталкиваются с нестабильным интернетом, рассмотрите вариант .returnCacheDataElseLoad — он возвращает кешированные данные, если они есть. В этом случае пользователи могут получить не самые свежие данные, зато загрузка будет быстрее вне зависимости от качества соединения. Кеш регулярно обновляется, поэтому его безопасно использовать в течение сессии, чтобы избежать лишних сетевых запросов.

Обратите внимание: кеш сохраняется при перезапуске приложения и очищается только при его переустановке или ручной очистке.

Adapty SDK хранит пейволы локально в двух слоях: регулярно обновляемый кеш, описанный выше, и резервные пейволы. Для ускорения загрузки пейволов мы также используем CDN и отдельный резервный сервер на случай недоступности CDN. Эта система гарантирует, что вы всегда получаете актуальную версию пейволов, сохраняя надёжность даже при слабом интернет-соединении.

loadTimeoutпо умолчанию: 5 сек

Ограничивает таймаут этого метода. При достижении таймаута будут возвращены кешированные данные или локальный резервный вариант.

Обратите внимание: в редких случаях метод может завершиться с небольшой задержкой относительно значения, указанного в loadTimeout, так как операция может включать несколько запросов под капотом.

Параметры ответа:
ПараметрОписание
PaywallОбъект AdaptyPaywall со списком ID продуктов, идентификатором пейвола, Remote Config и рядом других свойств.

Получение конфигурации отображения пейвола, созданного в Paywall Builder

Убедитесь, что в Paywall Builder включён переключатель Show on device. Если этот параметр не активирован, конфигурация отображения не будет доступна для получения.

После загрузки пейвола проверьте, содержит ли он ViewConfiguration — это признак того, что пейвол создан в Paywall Builder. Это поможет вам понять, как отображать пейвол. Если ViewConfiguration присутствует, обрабатывайте его как пейвол Paywall Builder; если нет — обработайте его как пейвол с Remote Config. В Unity SDK напрямую вызывайте метод CreatePaywallView, не запрашивая конфигурацию вью вручную.

Результат метода CreatePaywallView можно использовать только один раз. Если нужно использовать его повторно, вызовите CreatePaywallView заново. Повторный вызов без пересоздания может привести к ошибке AdaptyUIError.viewAlreadyPresented.

var parameters = new AdaptyUICreatePaywallViewParameters()
  .SetPreloadProducts(preloadProducts)
  .SetLoadTimeout(new TimeSpan(0, 0, 3));

AdaptyUI.CreatePaywallView(paywall, parameters, (view, error) => {
  // handle the result
});

Параметры:

ПараметрНаличиеОписание
paywallобязательныйОбъект AdaptyPaywall для получения контроллера нужного пейвола.
loadTimeoutпо умолчанию: 5 секОграничивает таймаут для этого метода. Если таймаут истёк, будут возвращены кешированные данные или локальный резервный пейвол. Обратите внимание, что в редких случаях метод может завершиться с небольшой задержкой сверх значения loadTimeout, поскольку операция может включать несколько запросов под капотом.
PreloadProductsопциональныйПередайте массив AdaptyPaywallProducts для оптимизации времени отображения продуктов на экране. Если передать nil, AdaptyUI автоматически загрузит необходимые продукты.
CustomTagsопциональныйЗадайте словарь пользовательских тегов и их значений. Пользовательские теги служат плейсхолдерами в контенте пейвола и динамически заменяются конкретными строками для персонализации. Подробнее см. в разделе о пользовательских тегах в Paywall Builder.
CustomTimersопциональныйЗадайте словарь пользовательских таймеров и дат их окончания. Пользовательские таймеры позволяют отображать обратный отсчёт на пейволе.

Если вы используете несколько языков, узнайте, как добавить локализацию Paywall Builder и как правильно использовать коды локалей здесь.

Как только у вас есть представление, покажите пейвол.

Настройка ассетов

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

Hero-изображения и видео имеют предопределённые идентификаторы: hero_image и hero_video. В бандле кастомных ассетов вы обращаетесь к этим элементам по их идентификаторам и настраиваете их поведение.

Для остальных изображений и видео нужно задать кастомный идентификатор в дашборде Adapty.

Например, вы можете:

  • Показывать разные изображения или видео разным пользователям.
  • Показывать локальное превью-изображение, пока загружается основное удалённое.
  • Показывать превью-изображение перед запуском видео.

Чтобы использовать эту функцию, обновите Adapty Unity SDK до версии 3.8.0 или выше.

Вот пример того, как можно передавать пользовательские ресурсы через простой словарь:

var customAssets = new Dictionary<string, AdaptyCustomAsset>
{
    { "custom_image", AdaptyCustomAsset.LocalImageFile("custom_assets/images/custom_image.png") },
    { "hero_video", AdaptyCustomAsset.LocalVideoFile("custom_assets/videos/custom_video.mp4") }
};

var parameters = new AdaptyUICreatePaywallViewParameters()
    .SetCustomAssets(customAssets)
    .SetLoadTimeout(new TimeSpan(0, 0, 3));

AdaptyUI.CreatePaywallView(paywall, parameters, (view, error) => {
    // handle the result
});

Если ресурс не найден, пейвол вернётся к внешнему виду по умолчанию.

Настройка таймеров, заданных разработчиком

Чтобы использовать кастомные таймеры в Unity-приложении, передайте словарь с ID таймеров и датами их окончания напрямую в метод SetCustomTimers. Пример:

var customTimers = new Dictionary<string, DateTime> {
    { "CUSTOM_TIMER_6H", DateTime.Now.AddHours(6) },
    { "CUSTOM_TIMER_NY", new DateTime(2025, 1, 1) }
};

var parameters = new AdaptyUICreatePaywallViewParameters()
    .SetCustomTimers(customTimers)
    .SetLoadTimeout(new TimeSpan(0, 0, 3));

AdaptyUI.CreatePaywallView(paywall, parameters, (view, error) => {
    // handle the result
});

В этом примере CUSTOM_TIMER_NY и CUSTOM_TIMER_6H — это Timer ID таймеров, заданных разработчиком в дашборде Adapty. Резолвер таймеров обеспечивает динамическое обновление каждого таймера с правильным значением. Например:

  • CUSTOM_TIMER_NY: время, оставшееся до окончания таймера, например до Нового года.
  • CUSTOM_TIMER_6H: время, оставшееся в 6-часовом периоде, который начался, когда пользователь открыл пейвол.

Ускорьте загрузку пейвола с помощью пейвола аудитории по умолчанию

Как правило, пейволы загружаются почти мгновенно, и беспокоиться об ускорении этого процесса не нужно. Однако если у вас много аудиторий и пейволов, а пользователи работают в условиях слабого интернет-соединения, загрузка пейвола может занять больше времени, чем хотелось бы. В таких ситуациях стоит показывать пейвол по умолчанию — это обеспечит плавный пользовательский опыт вместо полного отсутствия пейвола. Чтобы решить эту задачу, можно использовать метод GetPaywallForDefaultAudience, который получает пейвол указанного плейсмента для аудитории All Users. Однако важно понимать, что рекомендуемый подход — получать пейвол методом getPaywall, как описано в разделе Получение пейвола выше.

Рекомендуем использовать GetPaywall вместо GetPaywallForDefaultAudience, так как последний имеет важные ограничения:

  • Проблемы совместимости: могут возникнуть сложности при поддержке нескольких версий приложения — придётся либо делать обратно совместимые дизайны, либо мириться с тем, что в старых версиях пейвол может отображаться некорректно.
  • Нет персонализации: показывает контент только для аудитории «Все пользователи», без таргетинга по стране, атрибуции или кастомным атрибутам.

Если скорость загрузки важнее этих недостатков для вашего сценария использования, используйте GetPaywallForDefaultAudience, как показано ниже. В противном случае используйте GetPaywall, как описано выше.

Adapty.GetPaywallForDefaultAudience("YOUR_PLACEMENT_ID", "en", (paywall, error) => {
  if(error != null) {
    // handle the error
    return;
  }
  
  // paywall - the resulting object
});

Параметры:

ПараметрНаличиеОписание
placementIdобязательныйИдентификатор нужного плейсмента. Это значение, которое вы указали при создании плейсмента в дашборде Adapty.
locale

опциональный

по умолчанию: en

Идентификатор локализации пейвола. Ожидается языковой код, состоящий из одного или двух подтегов, разделённых символом минус (-). Первый подтег обозначает язык, второй — регион.

Например: en — английский, pt-br — бразильский португальский.

fetchPolicyпо умолчанию: .reloadRevalidatingCacheData

По умолчанию SDK пытается загрузить данные с сервера и возвращает кешированные данные в случае сбоя. Мы рекомендуем этот вариант, поскольку он гарантирует, что пользователи всегда получают актуальные данные.

Однако если у ваших пользователей нестабильное интернет-соединение, рассмотрите использование .returnCacheDataElseLoad — тогда кешированные данные будут возвращаться, если они есть. В таком случае пользователи могут не получить самые свежие данные, зато загрузка будет быстрее независимо от качества соединения. Кеш регулярно обновляется, поэтому его безопасно использовать в рамках сессии, чтобы избежать лишних сетевых запросов.

Обратите внимание: кеш сохраняется при перезапуске приложения и очищается только при переустановке или принудительной очистке.

Adapty SDK хранит пейволы локально на двух уровнях: регулярно обновляемый кеш, описанный выше, и резервные пейволы. Для ускорения загрузки пейволов используется CDN, а в случае его недоступности — отдельный резервный сервер. Такая система обеспечивает актуальность пейволов и надёжность даже при слабом интернет-соединении.