Модели React Native SDK

Danger

Эта страница устарела. Модели SDK можно найти в этом справочнике.

Интерфейсы

AdaptyOnboarding

Информация об онбординге.

НазваниеТипОписание
idstringИдентификатор онбординга, настроенный в дашборде Adapty
placementAdaptyPlacementПлейсмент, настроенный в дашборде Adapty
hasViewConfigurationbooleanЕсли true, можно получить объект представления и использовать его с библиотекой AdaptyUI
namestringНазвание онбординг-флоу
remoteConfigAdaptyRemoteConfig (optional)Remote Config, настроенный в дашборде Adapty для данного онбординга
variationIdstringИдентификатор варианта, используемый для атрибуции покупок к данному онбордингу
versionnumber (optional)Версия конфигурации онбординга
payloadDatastring (optional)Дополнительные данные полезной нагрузки
requestLocalestringЗапрошенная локаль для онбординга
onboardingBuilderAdaptyOnboardingBuilder (optional)Конфигурация Builder для онбординга

AdaptyOnboardingBuilder

НазваниеТипОписание
urlstringURL для конструктора онбординга
langstringЯзык для конструктора онбординга

AdaptyPaywallProduct

Информация о продукте.

НазваниеТипОписание
vendorProductIdstringУникальный идентификатор продукта из App Store Connect или Google Play Console
adaptyIdstringУникальный идентификатор продукта в Adapty
paywallVariationIdstringАналог свойства variationId родительского AdaptyPaywall
paywallABTestNamestringАналог свойства abTestName родительского AdaptyPaywall
paywallNamestringАналог свойства name родительского AdaptyPaywall
paywallProductIndexnumberИндекс продукта в пейволе
localizedDescriptionstringОписание продукта
localizedTitlestringНазвание продукта
regionCodestring (optional)Код региона локали, используемой для форматирования цены продукта. ISO 3166 ALPHA-2 (US, DE)
priceAdaptyPrice (optional)Стоимость продукта в местной валюте
subscriptionAdaptySubscriptionDetails (optional)Подробная информация о подписке (introductory offer, офферы и т.д.)
webPurchaseUrlstring (optional)URL для веб-покупки
payloadDatastring (optional)Дополнительные данные payload
iosobject (optional)Свойства, специфичные для iOS
ios.isFamilyShareablebooleanБулево значение, указывающее, доступен ли продукт для семейного доступа в App Store Connect. Будет равно false для iOS ниже 14.0 и macOS ниже 11.0. Только iOS.

AdaptyPrice

type AdaptyPrice = {
  amount: number;
  localizedString: string | null;
  currencyCode: string | null;
  currencySymbol: string | null;
};
ПолеТипОписание
amountnumberЧисловое значение цены продукта.
localizedStringstring | nullЛокализованная строка с ценой продукта.
currencyCodestring | nullБуквенный код валюты по стандарту ISO 4217. Например, USD.
currencySymbolstring | nullСимвол валюты. Например, $.
НазваниеТипОписание
:----------------:---------------:-------------------------------------------------------------------------------------------------------------------------------
amountnumberЦена в виде числа
currencyCodestring (optional)Код валюты локали, используемой для форматирования цены продукта. ISO 4217 (USD, EUR)
currencySymbolstring (optional)Символ валюты локали, используемой для форматирования цены продукта. ($, €)
localizedStringstring (optional)Язык цены определяется предпочтительным языком, заданным на устройстве. На Android — форматированная цена из Google Play в исходном виде

AdaptySubscriptionDetails

data class AdaptySubscriptionDetails(
    val isAutoRenewEnabled: Boolean,
    val isSandbox: Boolean,
    val activatedAt: Date,
    val renewedAt: Date?,
    val expiresAt: Date?,
    val startsAt: Date?,
    val cancellationReason: AdaptyCancellationReason?,
    val billingIssueDetectedAt: Date?,
    val vendorProductId: String,
    val vendorTransactionId: String?,
    val vendorOriginalTransactionId: String?,
    val offer: AdaptySubscriptionOffer?,
    val category: AdaptySubscriptionPeriod.Unit,
)
НазваниеТипОписание
subscriptionPeriodAdaptySubscriptionPeriodДетали периода для продуктов, являющихся подписками. Будет null для iOS версии ниже 11.2 и macOS версии ниже 10.14.4.
localizedSubscriptionPeriodstring (optional)Язык периода определяется предпочтительным языком, установленным на устройстве
offerAdaptySubscriptionOfferId (optional)Предложение по подписке, если доступно для автообновляемой подписки
iosobject (optional)Свойства, специфичные для iOS
ios.subscriptionGroupIdentifierstring (optional)Идентификатор группы подписок, к которой относится подписка. Будет null для iOS версии ниже 12.0 и macOS версии ниже 10.14. Только iOS.
androidobject (optional)Свойства, специфичные для Android
android.basePlanIdstringИдентификатор базового плана. Только Android.
android.renewalTypestring (optional)Тип продления. Возможные значения: 'prepaid', 'autorenewable'. Только Android.

AdaptySubscriptionPeriod

AdaptySubscriptionPeriod — это объект, описывающий длительность периода подписки. Он содержит следующие свойства:

ПараметрТипОписание
unitAdaptyPeriodUnitЕдиница измерения длительности: .day, .week, .month, .year, .unknown
numberOfUnitsIntКоличество единиц в периоде
NameTypeDescription
:------------:---------------:-------------------------------------------------------------------------------------------------------------------------------
numberOfUnitsnumberКоличество единиц периода
unitProductPeriodЕдиница времени, в которой задан период подписки. Возможные значения: day, week, month, year

AdaptySubscriptionOffer

Модель подписочного предложения для продуктов.

НазваниеТипОписание
identifierAdaptySubscriptionOfferIdИдентификатор подписочного предложения
phasesмассив AdaptyDiscountPhaseМассив фаз скидки
androidobject (optional)Свойства, специфичные для Android
android.offerTagsмассив строк (optional)Теги, связанные с этим предложением

AdaptySubscriptionOfferId

НазваниеТипОписание
idstring (optional)Идентификатор promotional offer или win-back offer
typestringТип offer. Возможные значения: introductory, promotional, win_back

AdaptyDiscountPhase

НазваниеТипОписание
localizedNumberOfPeriodsstring (optional)Форматированное количество периодов скидки для локали пользователя
localizedSubscriptionPeriodstring (optional)Форматированный период подписки скидки для локали пользователя
numberOfPeriodsnumberКоличество периодов, в течение которых доступна скидка на продукт
priceAdaptyPriceЦена скидки на продукт в местной валюте
subscriptionPeriodAdaptySubscriptionPeriodИнформация о периоде скидки на продукт
paymentModeOfferTypeСпособ оплаты для данной скидки на продукт. Возможные значения: free_trial, pay_as_you_go, pay_up_front

AdaptyPaywall

Информация о пейволе.

НазваниеТипОписание
placementAdaptyPlacementПлейсмент, настроенный в дашборде Adapty
hasViewConfigurationbooleanЕсли true, можно получить объект представления и использовать его с библиотекой AdaptyUI
namestringНазвание пейвола
remoteConfigAdaptyRemoteConfig (optional)Remote Config, настроенный в дашборде Adapty для этого пейвола
variationIdstringИдентификатор варианта, используемый для атрибуции покупок к этому пейволу
productsarray of ProductReference (deprecated)Массив базовой информации о продуктах (устарело, используйте productIdentifiers)
productIdentifiersarray of AdaptyProductIdentifierМассив идентификаторов продуктов для этого пейвола
idstringИдентификатор пейвола, настроенный в дашборде Adapty
versionnumber (optional)Версия конфигурации пейвола
webPurchaseUrlstring (optional)URL для веб-покупок
payloadDatastring (optional)Дополнительные данные полезной нагрузки
requestLocalestringЗапрошенная локаль для пейвола
paywallBuilderAdaptyPaywallBuilder (optional)Конфигурация Paywall Builder для пейвола

AdaptyPaywallBuilder

NameTypeDescription
idstringID пейвола в Paywall Builder
langstringЯзык пейвола в Paywall Builder

AdaptyPlacement

type AdaptyPlacement = {
  id: string;
  name: string;
  abTestName: string | undefined;
  audienceName: string | undefined;
  revision: number;
  variationId: string;
};
НазваниеТипОписание
abTestNamestringНазвание родительского A/B-теста
audienceNamestringНазвание аудитории, к которой относится пейвол
idstringID плейсмента, настроенного в дашборде Adapty
revisionnumberТекущая ревизия (версия) пейвола. Каждое изменение пейвола создаёт новую ревизию
isTrackingPurchasesboolean (optional)Отслеживает ли плейсмент покупки
audienceVersionIdstringID версии аудитории

AdaptyRemoteConfig

NameTypeDescription
langstringИдентификатор локали пейвола
dataobjectПроизвольный словарь, настроенный в дашборде Adapty для этого пейвола
dataStringstringПроизвольная JSON-строка, настроенная в дашборде Adapty для этого пейвола

AdaptyProfile

Информация о статусе подписки и истории покупок пользователя.

НазваниеТипОписание
profileIdstringИдентификатор пользователя в Adapty
customerUserIdstring (optional)Идентификатор пользователя в вашей системе
customAttributesobjectРанее установленные пользовательские атрибуты через метод updateProfile
accessLevelsobject<string, AdaptyProfile.AccessLevel>Ключи — идентификаторы уровней доступа, настроенные вами в дашборде Adapty. Значения — объекты AccessLevel. Может быть null, если у пользователя нет уровней доступа
subscriptionsobject<string, AdaptyProfile.Subscription>Ключи — идентификаторы продуктов из App Store Connect. Значения — объекты Subscription. Может быть null, если у пользователя нет подписок
nonSubscriptionsobject<string, array of AdaptyProfile.NonSubscription>Ключи — идентификаторы продуктов из App Store Connect. Значения — массивы объектов NonSubscription. Может быть null, если у пользователя нет покупок

AdaptyProfile.AccessLevel

Информация об уровне доступа пользователя.

НазваниеТипОписание
idstringУникальный идентификатор уровня доступа, настроенный вами в дашборде Adapty
isActivebooleanАктивен ли уровень доступа. Как правило, достаточно проверить только это свойство, чтобы определить, есть ли у пользователя доступ к премиум-функциям
vendorProductIdstringИдентификатор продукта в App Store Connect, который открыл данный уровень доступа
storestringСтор, в котором была совершена покупка, открывшая данный уровень доступа. Возможные значения: app_store, play_store, adapty
activatedAtDateВремя активации уровня доступа
renewedAtDate (optional)Время последнего продления уровня доступа
expiresAtDate (optional)Время истечения уровня доступа (может быть в прошлом или равно null для пожизненного доступа)
isLifetimebooleanАктивен ли уровень доступа бессрочно (без даты истечения). Если значение равно true, проверять expires_at не нужно — можно просто проверить isActive
activeIntroductoryOfferTypestring (optional)Тип активного introductory offer. Возможные значения: free_trial, pay_as_you_go, pay_up_front. Если значение не равно null, это означает, что оффер был применён в течение текущего периода подписки
activePromotionalOfferTypestring (optional)Тип активного promotional offer. Возможные значения: free_trial, pay_as_you_go, pay_up_front. Если значение не равно null, это означает, что оффер был применён в течение текущего периода подписки
activePromotionalOfferIdstring (optional)Идентификатор активного promotional offer
offerIdstring (optional)Идентификатор оффера
willRenewbooleanНастроено ли автоматическое продление подписки
isInGracePeriodbooleanНаходится ли автообновляемая подписка в льготном периоде
unsubscribedAtDate (optional)Время отмены автообновляемой подписки. Подписка при этом может оставаться активной — это лишь означает, что автопродление отключено. Сбрасывается в null, если пользователь повторно активирует подписку
billingIssueDetectedAtDate (optional)Время обнаружения проблемы с оплатой. Подписка при этом может оставаться активной. Сбрасывается в null после успешного списания
startsAtDate (optional)Время начала действия данного уровня доступа (может быть в будущем)
cancellationReasonstring (optional)Причина отмены подписки. Возможные значения: voluntarily_cancelled, billing_error, refund, price_increase, product_was_not_available, unknown
isRefundbooleanБыл ли выполнен возврат средств за покупку
androidobject (optional)Свойства, специфичные для Android
android.offerIdstring (optional)Идентификатор оффера

AdaptyProfile.Subscription

Информация о подписке пользователя.

НазваниеТипОписание
storestringСтор, в котором была совершена покупка. Возможные значения: app_store, play_store, adapty
vendorProductIdstringИдентификатор продукта в App Store Connect
vendorTransactionIdstringИдентификатор транзакции из App Store
vendorOriginalTransactionIdstringИдентификатор исходной транзакции из App Store. Для автовозобновляемой подписки это будет идентификатор первой транзакции в подписке
isActivebooleanАктивна ли подписка
isLifetimebooleanАктивна ли подписка бессрочно (без даты истечения). Если установлено значение true, проверять expires_at не нужно — достаточно проверить isActive
activatedAtDateВремя активации подписки
renewedAtDate (optional)Время продления подписки
expiresAtDate (optional)Время истечения подписки (может быть в прошлом или равно null для пожизненного доступа)
startsAtDate (optional)Время начала подписки (может быть в будущем)
unsubscribedAtDate (optional)Время отмены автовозобновляемой подписки. Подписка при этом может оставаться активной — это означает лишь отключение автопродления. Принимает значение null, если пользователь повторно активирует подписку
billingIssueDetectedAtDate (optional)Время обнаружения проблемы с оплатой (Apple не удалось списать средства с карты). Подписка при этом может оставаться активной. Принимает значение null при успешном списании
isInGracePeriodbooleanНаходится ли автовозобновляемая подписка в льготном периоде
isSandboxbooleanБыла ли покупка совершена в среде песочницы
isRefundbooleanБыл ли произведён возврат средств за покупку
willRenewbooleanНастроено ли автопродление подписки
activeIntroductoryOfferTypestring (optional)Тип активного introductory offer. Возможные значения: free_trial, pay_as_you_go, pay_up_front. Если значение не равно null, предложение было применено в течение текущего периода подписки
activePromotionalOfferTypestring (optional)Тип активного promotional offer. Возможные значения: free_trial, pay_as_you_go, pay_up_front. Если значение не равно null, предложение было применено в течение текущего периода подписки
activePromotionalOfferIdstring (optional)Идентификатор активного promotional offer
offerIdstring (optional)Идентификатор предложения
cancellationReasonstring (optional)Причина отмены подписки. Возможные значения: voluntarily_cancelled, billing_error, refund, price_increase, product_was_not_available, unknown

AdaptyProfile.NonSubscription

Информация о разовых покупках пользователя (не подписках).

НазваниеТипОписание
purchaseIdstringИдентификатор покупки в Adapty. Используйте его, чтобы убедиться, что эта покупка уже обработана (например, для отслеживания разовых покупок)
storestringСтор, в котором совершена покупка. Возможные значения: app_store, play_store, adapty
vendorProductIdstringИдентификатор продукта в App Store Connect
vendorTransactionIdstring (optional)Идентификатор транзакции из App Store
purchasedAtDateВремя покупки продукта
isSandboxbooleanПризнак того, что продукт был куплен в среде песочницы
isRefundbooleanПризнак того, что покупка была возвращена
isConsumablebooleanПризнак того, что продукт должен быть обработан только один раз. Если true, Adapty API вернёт эту покупку лишь однажды

ProductReference

НазваниеТипОписание
vendorIdstringVendor ID продукта
adaptyIdstringAdapty ID продукта
iosobject (optional)iOS-специфичные свойства
ios.promotionalOfferIdstring (optional)ID promotional offer. Только для iOS.
ios.winBackOfferIdstring (optional)ID win-back offer. Только для iOS.
androidobject (optional)Android-специфичные свойства
android.basePlanIdstring (optional)ID базового плана. Только для Android.
android.offerIdstring (optional)ID оффера. Только для Android.

AdaptyProductIdentifier

Интерфейс, представляющий идентификатор продукта с информацией о вендоре и платформе.

НазваниеТипОписание
vendorProductIdstringИдентификатор продукта, специфичный для вендора (например, ID продукта в App Store или Google Play)
basePlanIdstring (optional)Идентификатор базового плана для подписок Google Play (только Android)
adaptyProductIdstringВнутренний идентификатор продукта Adapty

AdaptyProfileParameters

Параметры для обновления профиля пользователя.

НазваниеТипОписание
analyticsDisabledboolean (optional)Отключить ли аналитику
codableCustomAttributesobject (optional)Пользовательские атрибуты для установки
appTrackingTransparencyStatusAppTrackingTransparencyStatus (optional)Статус App Tracking Transparency
firstNamestring (optional)Имя пользователя
lastNamestring (optional)Фамилия пользователя
genderGender (optional)Пол пользователя
birthdaystring (optional)Дата рождения пользователя
emailstring (optional)Email пользователя
phoneNumberstring (optional)Номер телефона пользователя

AdaptyPurchaseResult

Union-тип, представляющий результат покупки.

НазваниеТипОписание
typestringТип результата. Возможные значения: pending, user_cancelled, success
profileAdaptyProfile (optional)Обновлённый профиль пользователя (присутствует только когда type равен success)

AdaptyAndroidPurchaseParams

Структура параметров покупки для Android.

НазваниеТипОписание
subscriptionUpdateParamsobject (optional)Параметры обновления подписки для Android
subscriptionUpdateParams.oldSubVendorProductIdstringИдентификатор продукта текущей подписки, которую нужно изменить
subscriptionUpdateParams.prorationModeAdaptyAndroidSubscriptionUpdateReplacementModeРежим пересчёта при обновлении подписки
isOfferPersonalizedboolean (optional)Является ли предложение персонализированным
obfuscatedAccountIdstring (optional)Обфусцированный идентификатор аккаунта
obfuscatedProfileIdstring (optional)Обфусцированный идентификатор профиля

AdaptyAndroidSubscriptionUpdateParameters

Параметры обновления подписки на Android (устарело).

НазваниеТипОписание
oldSubVendorProductIdstringИдентификатор продукта текущей подписки, которую нужно заменить
prorationModeAdaptyAndroidSubscriptionUpdateReplacementModeРежим пропорциональной замены при обновлении подписки
isOfferPersonalizedboolean (необязательно)Является ли предложение персонализированным (устарело, используйте AdaptyAndroidPurchaseParams)

Перечисления

VendorStore

  • app_store - Apple App Store
  • play_store - Google Play Store
  • adapty - Adapty

OfferType

  • free_trial - Бесплатный пробный период
  • pay_as_you_go - Оплата по мере использования
  • pay_up_front - Оплата вперёд

CancellationReason

  • voluntarily_cancelled - Пользователь отменил добровольно
  • billing_error - Ошибка при оплате
  • refund - Покупка возвращена
  • price_increase - Цена была повышена
  • product_was_not_available - Продукт был недоступен
  • unknown - Неизвестная причина

ProductPeriod

  • day - Период: день
  • week - Период: неделя
  • month - Период: месяц
  • year - Период: год

AdaptyAndroidSubscriptionUpdateReplacementMode

  • charge_full_price - Списать полную стоимость
  • deferred - Отложенный
  • without_proration - Без пропорционального расчёта
  • charge_prorated_price - Списать пропорциональную стоимость
  • with_time_proration - С пропорциональным расчётом по времени

FetchPolicy

  • reload_revalidating_cache_data - Всегда загружать данные с сервера
  • return_cache_data_else_load - Возвращать кэшированные данные, если они доступны, иначе загружать с сервера
  • return_cache_data_if_not_expired_else_load - Возвращать кэшированные данные, если они не устарели, иначе загружать с сервера

LogLevel

  • verbose - Логирует любую дополнительную информацию, которая может быть полезна при отладке
  • error - Логирует только ошибки
  • warn - Логирует сообщения от SDK, не вызывающие критических ошибок
  • info - Логирует различные информационные сообщения

Gender

  • f - Женский
  • m - Мужской
  • o - Другой

AppTrackingTransparencyStatus

  • 0 - Не определено
  • 1 - Ограничено
  • 2 - Отклонено
  • 3 - Разрешено
  • 4 - Неизвестно

RefundPreference

  • no_preference - Без предпочтений
  • grant - Одобрить возврат
  • decline - Отклонить возврат