Получение пейволов и продуктов для пейволов с Remote Config в Capacitor SDK

Прежде чем отображать Remote Config и кастомные пейволы, вам нужно получить информацию о них. Обратите внимание, что этот раздел посвящён Remote Config и кастомным пейволам. Чтобы узнать, как получить флоу или пейволы, настроенные в Flow Builder или Paywall Builder, обратитесь к статье Получение флоу Flow Builder и пейволов Paywall Builder и их конфигурации.

Прежде чем начать получать флоу и продукты в мобильном приложении (нажмите, чтобы развернуть)

1. Создайте продукты в дашборде Adapty.

2. Создайте флоу или пейвол и добавьте в него продукты в дашборде Adapty.

3. Создайте плейсменты и добавьте в них флоу или пейвол в дашборде Adapty.

4. Установите Adapty SDK в своём мобильном приложении.

Получение информации о флоу

В Adapty продукт объединяет в себе продукты из App Store и Google Play. Эти кроссплатформенные продукты интегрируются во флоу и пейволы, что позволяет отображать их в конкретных плейсментах мобильного приложения.

Чтобы отобразить продукты, необходимо получить объект AdaptyFlow из одного из ваших плейсментов с помощью метода getFlow.

try {
  const flow = await adapty.getFlow({ 
    placementId: 'YOUR_PLACEMENT_ID', 
    params: {
      fetchPolicy: 'reload_revalidating_cache_data', // Load from server, fallback to cache
      loadTimeoutMs: 5000 // 5 second timeout
    }
  });
  // the requested flow
} catch (error) {
  console.error('Failed to fetch flow:', error);
}

Параметр	Наличие	Описание
placementId	обязательный	Идентификатор плейсмента. Это значение вы указали при создании плейсмента в дашборде Adapty.
params.fetchPolicy	опциональный по умолчанию: 'reload_revalidating_cache_data'	По умолчанию SDK пытается загрузить данные с сервера и возвращает кэшированные данные в случае сбоя. Мы рекомендуем этот вариант, так как он гарантирует, что пользователи всегда получают актуальные данные. Однако если у ваших пользователей нестабильное интернет-соединение, рассмотрите использование 'return_cache_data_else_load' для возврата кэшированных данных, если они существуют. В этом случае пользователи могут не получить самые последние данные, но время загрузки будет меньше вне зависимости от качества соединения. Кэш регулярно обновляется, поэтому его безопасно использовать в течение сессии, чтобы избежать лишних сетевых запросов. Обратите внимание, что кэш сохраняется при перезапуске приложения и очищается только при переустановке или ручной очистке. Adapty SDK хранит флоу и пейволы в двух слоях: регулярно обновляемый кэш, описанный выше, и резервные пейволы. Также используется CDN для более быстрой загрузки флоу и пейволов, а также отдельный резервный сервер на случай недоступности CDN. Эта система обеспечивает получение актуальной версии флоу и надёжность даже при слабом интернет-соединении.
params.loadTimeoutMs	опциональный по умолчанию: 5000 мс	Это значение ограничивает таймаут (в миллисекундах) для данного метода. По истечении таймаута будут возвращены кэшированные данные или локальный резервный вариант. Обратите внимание, что в редких случаях метод может завершиться с небольшой задержкой относительно значения, указанного в loadTimeoutMs, так как операция может включать несколько запросов под капотом.

Не хардкодьте ID продуктов! Поскольку флоу настраиваются удалённо, доступные продукты, их количество и специальные предложения (например, бесплатные пробные периоды) могут меняться со временем. Убедитесь, что ваш код учитывает эти сценарии.

Например, если изначально вы получаете 2 продукта, приложение должно отображать их. Но если позднее вы получите 3 продукта, приложение должно показать все 3 без каких-либо изменений в коде. Единственное, что нужно хардкодить, — это ID плейсмента.

Параметры ответа:

Параметр	Описание
Flow	Объект AdaptyFlow, содержащий плейсмент, идентификаторы (id, variationId), название, вариации пейвола (paywalls) и массив remoteConfigs (по одной записи на каждую настроенную локаль). Чтобы получить продукты для флоу, вызовите getPaywallProducts({ flow }).

Получение продуктов

После того как вы получили флоу, можно запросить массив продуктов, соответствующих ему:

try {
  const products = await adapty.getPaywallProducts({ flow });
  // the requested products list
} catch (error) {
  console.error('Failed to fetch products:', error);
}

Параметры ответа:

Параметр	Описание
Products	Список объектов AdaptyPaywallProduct с идентификатором продукта, названием, ценой, валютой, длительностью подписки и рядом других свойств.
При реализации собственного дизайна пейвола вам, скорее всего, понадобятся свойства объекта AdaptyPaywallProduct. Ниже приведены наиболее часто используемые свойства; полный список доступных свойств см. в связанной документации.
Свойство	Описание
-------------------------	-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
Title	Чтобы отобразить название продукта, используйте product.localizedTitle. Обратите внимание: локализация основана на стране стора, выбранной пользователем, а не на локали устройства.
Price	Чтобы отобразить цену в локализованном формате, используйте product.price?.localizedString. Локализация основана на локали устройства. Также можно получить цену как число через product.price?.amount — значение будет в местной валюте. Для получения символа валюты используйте product.price?.currencySymbol.
Subscription Period	Чтобы отобразить период (например, неделя, месяц, год и т. д.), используйте product.subscription?.localizedSubscriptionPeriod. Локализация основана на локали устройства. Для программного получения периода подписки используйте product.subscription?.subscriptionPeriod. Оттуда можно обратиться к свойству unit, чтобы получить единицу периода ('day', 'week', 'month', 'year' или 'unknown'). Свойство numberOfUnits даёт количество единиц периода. Например, для квартальной подписки в unit будет 'month', а в numberOfUnits — 3.
Introductory Offer	Чтобы показать значок или другой индикатор наличия introductory offer у подписки, проверьте свойство product.subscription?.offer?.phases. Это список, который может содержать до двух фаз скидки: фазу бесплатного пробного периода и фазу вводной цены. Каждый объект фазы содержит следующие полезные свойства: • paymentMode: строка со значениями 'free_trial', 'pay_as_you_go', 'pay_up_front' и 'unknown'. Бесплатные пробные периоды имеют тип 'free_trial'. • price: цена со скидкой в виде числа. Для бесплатных пробных периодов ожидайте 0. • localizedNumberOfPeriods: строка, локализованная по локали устройства, описывающая длительность предложения. Например, для трёхдневного пробного периода в этом поле будет '3 days'. • subscriptionPeriod: позволяет получить отдельные детали периода предложения — работает так же, как описано в предыдущем разделе. • localizedSubscriptionPeriod: отформатированный период подписки скидки для локали пользователя.

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

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

try {
  const flow = await adapty.getFlowForDefaultAudience({ 
    placementId: 'YOUR_PLACEMENT_ID', 
    params: {
      fetchPolicy: 'reload_revalidating_cache_data' // Load from server, fallback to cache
    }
  });
  // the requested flow
} catch (error) {
  console.error('Failed to fetch default audience flow:', error);
}

Параметр	Наличие	Описание
placementId	обязательный	Идентификатор плейсмента. Это значение вы указываете при создании плейсмента в дашборде Adapty.
params.fetchPolicy	опциональный по умолчанию: 'reload_revalidating_cache_data'	По умолчанию SDK пытается загрузить данные с сервера и возвращает кешированные данные при сбое. Мы рекомендуем этот вариант, так как он гарантирует, что пользователи всегда получают самые актуальные данные. Однако если вы предполагаете, что у ваших пользователей нестабильное интернет-соединение, рассмотрите использование 'return_cache_data_else_load': в этом случае возвращаются кешированные данные, если они есть. Пользователи могут не получить самые свежие данные, зато загрузка будет быстрее независимо от качества соединения. Кеш регулярно обновляется, поэтому его безопасно использовать в течение сессии, чтобы избежать лишних сетевых запросов. Обратите внимание: кеш сохраняется при перезапуске приложения и очищается только при переустановке или ручной очистке.

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

Прежде чем начать получать пейволы и продукты в мобильном приложении (нажмите, чтобы развернуть)

1. Создайте продукты в дашборде Adapty.

2. Создайте пейвол и добавьте в него продукты в дашборде Adapty.

3. Создайте плейсменты и добавьте пейвол в плейсмент в дашборде Adapty.

4. Установите Adapty SDK в своё мобильное приложение.

Получение информации о пейволе

В Adapty продукт объединяет в себе продукты из App Store и Google Play. Эти кроссплатформенные продукты подключаются к пейволам, что позволяет отображать их в нужных плейсментах вашего мобильного приложения.

Чтобы показать продукты, необходимо получить пейвол из одного из ваших плейсментов с помощью метода getPaywall.

try {
  const paywall = await adapty.getPaywall({ 
    placementId: 'YOUR_PLACEMENT_ID', 
    locale: 'en',
    params: {
      fetchPolicy: 'reload_revalidating_cache_data', // Load from server, fallback to cache
      loadTimeoutMs: 5000 // 5 second timeout
    }
  });
  // the requested paywall
} catch (error) {
  console.error('Failed to fetch paywall:', error);
}

Параметр	Обязательность	Описание
placementId	обязательный	Идентификатор плейсмента. Это значение, которое вы указали при создании плейсмента в дашборде Adapty.
locale	опциональный по умолчанию: en	Идентификатор локализации пейвола. Ожидается код языка, состоящий из одного или нескольких подтегов, разделённых символом минус (-). Первый подтег — язык, второй — регион. Пример: en означает английский, pt-br — бразильский португальский. Подробнее о кодах локалей и рекомендациях по их использованию см. в разделе Локализации и коды локалей.
params.fetchPolicy	опциональный по умолчанию: 'reload_revalidating_cache_data'	По умолчанию SDK пытается загрузить данные с сервера и возвращает кешированные данные в случае сбоя. Мы рекомендуем этот вариант, поскольку он гарантирует, что пользователи всегда получают актуальные данные. Однако если у ваших пользователей нестабильное интернет-соединение, рассмотрите использование 'return_cache_data_else_load' — оно возвращает кешированные данные, если они существуют. В этом случае пользователи могут получать не самые свежие данные, но загрузка будет быстрее независимо от качества соединения. Кеш регулярно обновляется, поэтому его безопасно использовать в течение сессии, чтобы сократить количество сетевых запросов. Обратите внимание, что кеш сохраняется после перезапуска приложения и очищается только при его переустановке или вручную.
params.loadTimeoutMs	опциональный по умолчанию: 5000 мс	Это значение ограничивает таймаут (в миллисекундах) для данного метода. При достижении таймаута будут возвращены кешированные данные или локальный резервный пейвол. Обратите внимание, что в редких случаях метод может завершиться с небольшой задержкой относительно значения, указанного в loadTimeoutMs, поскольку операция может включать несколько запросов под капотом.
Не прописывайте идентификаторы продуктов в коде. Единственный ID, который нужно хардкодить, — это ID плейсмента. Пейволы настраиваются удалённо, поэтому количество продуктов и доступных предложений может измениться в любой момент. Приложение должно обрабатывать эти изменения динамически — если сегодня пейвол возвращает два продукта, а завтра три, все они должны отображаться без изменений в коде.

Параметры ответа:

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

Получение продуктов

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

try {
  const products = await adapty.getPaywallProducts({ paywall });
  // the requested products list
} catch (error) {
  console.error('Failed to fetch products:', error);
}

Параметры ответа:

Параметр	Описание
Products	Список объектов AdaptyPaywallProduct с идентификатором продукта, названием, ценой, валютой, длительностью подписки и рядом других свойств.
При реализации собственного дизайна пейвола вам, скорее всего, понадобятся свойства объекта AdaptyPaywallProduct. Ниже приведены наиболее часто используемые из них, однако полный список всех доступных свойств можно найти в документации по ссылке.
Свойство	Описание
-------------------------	-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
Title	Чтобы отобразить название продукта, используйте product.localizedTitle. Локализация основана на выбранной пользователем стране стора, а не на локали устройства.
Price	Чтобы отобразить цену в локализованном формате, используйте product.price?.localizedString. Локализация основана на локали устройства. Цену как число можно получить через product.price?.amount — значение будет в местной валюте. Символ валюты доступен через product.price?.currencySymbol.
Subscription Period	Чтобы отобразить период (например, неделя, месяц, год и т. д.), используйте product.subscription?.localizedSubscriptionPeriod. Локализация основана на локали устройства. Для программного получения периода подписки используйте product.subscription?.subscriptionPeriod. Через свойство unit можно узнать единицу периода: 'day', 'week', 'month', 'year' или 'unknown'. Свойство numberOfUnits возвращает количество таких единиц. Например, для квартальной подписки в unit будет 'month', а в numberOfUnits — 3.
Introductory Offer	Чтобы отобразить бейдж или другой индикатор наличия introductory offer, используйте свойство product.subscription?.offer?.phases. Это список, который может содержать до двух фаз скидки: фазу бесплатного пробного периода и фазу вводной цены. Каждый объект фазы содержит следующие полезные свойства: • paymentMode: строка со значениями 'free_trial', 'pay_as_you_go', 'pay_up_front' и 'unknown'. Бесплатный пробный период имеет тип 'free_trial'. • price: сниженная цена в виде числа. Для бесплатного пробного периода здесь будет 0. • localizedNumberOfPeriods: строка, локализованная под локаль устройства и описывающая длительность предложения. Например, для трёхдневного пробного периода здесь будет '3 days'. • subscriptionPeriod: позволяет получить отдельные параметры периода предложения — работает так же, как описано в предыдущем разделе. • localizedSubscriptionPeriod: отформатированный период подписки скидки для локали пользователя.

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

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

try {
  const paywall = await adapty.getPaywallForDefaultAudience({ 
    placementId: 'YOUR_PLACEMENT_ID', 
    locale: 'en',
    params: {
      fetchPolicy: 'reload_revalidating_cache_data' // Load from server, fallback to cache
    }
  });
  // the requested paywall
} catch (error) {
  console.error('Failed to fetch default audience paywall:', error);
}

Параметр	Наличие	Описание
placementId	обязательный	Идентификатор плейсмента. Это значение вы указали при создании плейсмента в дашборде Adapty.
locale	необязательный по умолчанию: en	Идентификатор локализации пейвола. Ожидается языковой код, состоящий из одного или нескольких подтегов, разделённых символом минус (-). Первый подтег обозначает язык, второй — регион. Пример: en — английский язык, pt-br — бразильский португальский. Подробнее о кодах локалей и рекомендациях по их использованию см. в разделе Локализации и коды локалей.
params.fetchPolicy	необязательный по умолчанию: 'reload_revalidating_cache_data'	По умолчанию SDK пытается загрузить данные с сервера и возвращает кешированные данные в случае неудачи. Мы рекомендуем этот вариант, поскольку он гарантирует, что пользователи всегда получают актуальные данные. Однако если у ваших пользователей нестабильное интернет-соединение, рассмотрите вариант 'return_cache_data_else_load' — он возвращает кешированные данные, если они есть. В этом случае данные могут быть не самыми свежими, зато загрузка будет быстрее вне зависимости от качества связи. Кеш регулярно обновляется, поэтому его безопасно использовать в течение сессии, чтобы избежать лишних сетевых запросов. Обратите внимание: кеш сохраняется при перезапуске приложения и очищается только при его переустановке или ручной очистке.