Модели iOS SDK

Эта страница устарела. Актуальная документация по моделям SDK доступна в этом справочнике.

Интерфейсы

AdaptyOnboarding

Название	Тип	Описание
placement	AdaptyPlacement	Информация о плейсменте для онбординга
instanceIdentity	string	Уникальный идентификатор конфигурации онбординга
variationId	string	Идентификатор варианта, используемый для атрибуции событий этому онбордингу
name	string	Название онбординг-флоу
remoteConfig	AdaptyRemoteConfig (optional)	Опциональные пользовательские метаданные для онбординга
hasViewConfiguration	bool	Доступна ли конфигурация отображения для онбординга
viewConfiguration	AdaptyOnboarding.ViewConfiguration	Настройки визуальной конфигурации

AdaptyOnboardingScreen

Name	Type	Description
id	String	Уникальный идентификатор экрана
order	Int	Позиция экрана в потоке
content	AdaptyOnboardingContent	Контент для отображения на экране
actions	[AdaptyOnboardingAction]	Доступные действия для данного экрана

AdaptyOnboarding.ViewConfiguration

Name	Type	Description
responseLocale	AdaptyLocale	Локаль ответа
url	URL	URL конфигурации для онбординга

AdaptyPaywallProduct

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

Название	Тип	Описание
adaptyProductId	string	Уникальный идентификатор продукта в Adapty
vendorProductId	string	Уникальный идентификатор продукта из App Store Connect или Google Play Console
paywallProductIndex	int	Индекс продукта в рамках пейвола
variationId	string	Аналог свойства `variationId` родительского объекта AdaptyPaywall
paywallABTestName	string	Аналог свойства `abTestName` родительского объекта AdaptyPaywall
paywallName	string	Аналог свойства `name` родительского объекта AdaptyPaywall
subscriptionOffer	`AdaptySubscriptionOffer` (опционально)	Активное предложение по подписке для данного продукта (introductory offer, promotional offer или win-back offer)
webPaywallBaseUrl	URL (опционально)	Базовый URL для функциональности веб-пейвола
currencyCode	string (опционально)	Код валюты локали, используемой для форматирования цены продукта.
currencySymbol	string (опционально)	Символ валюты локали, используемой для форматирования цены продукта.
isFamilyShareable	bool	Булево значение, указывающее, доступен ли продукт для семейного доступа в App Store Connect. (Будет false для iOS ниже версии 14.0 и macOS ниже версии 11.0).
localizedDescription	string	Описание продукта.
localizedPrice	string (опционально)	Язык цены определяется предпочтительным языком, установленным на устройстве.
localizedSubscriptionPeriod	string (опционально)	Язык периода определяется предпочтительным языком, установленным на устройстве.
localizedTitle	string	Название продукта.
price	number	Стоимость продукта в местной валюте.
regionCode	string (опционально)	Код региона локали, используемой для форматирования цены продукта.
subscriptionGroupIdentifier	string (опционально)	Идентификатор группы подписок, к которой относится подписка. (Будет nil для iOS ниже версии 12.0 и macOS ниже версии 10.14).
subscriptionPeriod	`AdaptyProductSubscriptionPeriod` (опционально)	Детали периода для продуктов, являющихся подписками. (Будет nil для iOS ниже версии 11.2 и macOS ниже версии 10.14.4).

AdaptySubscriptionOffer

Информация о предложении по подписке.

Название	Тип	Описание
identifier	string (optional)	Уникальный идентификатор скидочного предложения для продукта
offerType	enum	Тип предложения. Возможные значения: `introductory`, `promotional`, `winBack`
subscriptionPeriod	`AdaptyProductSubscriptionPeriod`	Детали периода предложения
numberOfPeriods	number	Количество периодов, в течение которых действует скидка на продукт
paymentMode	enum	Режим оплаты для данной скидки на продукт. Возможные значения: `payAsYouGo`, `payUpFront`, `freeTrial`, `unknown`
localizedSubscriptionPeriod	string (optional)	Отформатированный период подписки со скидкой для локали пользователя
localizedNumberOfPeriods	string (optional)	Отформатированное количество периодов скидки для локали пользователя
price	number	Цена со скидкой в местной валюте
currencyCode	string (optional)	Код валюты локали, используемый для форматирования цены продукта
localizedPrice	string (optional)	Отформатированная цена скидки для локали пользователя

AdaptySubscriptionOffer.OfferType

Enum, представляющий тип предложения по подписке.

Значение	Описание
`introductory`	Introductory offer (скидка для новых пользователей)
`promotional`	Promotional offer (таргетированная скидка)
`winBack`	Win-back offer (скидка для возврата пользователей)

AdaptySubscriptionOffer.PaymentMode

Enum, представляющий режим оплаты для предложений по подписке.

Значение	Описание
`payAsYouGo`	Оплата по мере использования (регулярные платежи)
`payUpFront`	Предоплата (единовременный платёж за несколько периодов)
`freeTrial`	Бесплатный пробный период (оплата не требуется)
`unknown`	Неизвестный режим оплаты

AdaptyProductSubscriptionPeriod

type AdaptyProductSubscriptionPeriod = {
  unit: 'day' | 'week' | 'month' | 'year';
  numberOfUnits: number;
};

Name	Type	Description
unit	AdaptyPeriodUnit	Единица времени, в которой задан период подписки. Возможные значения: `day`, `week`, `month`, `year` и `unknown`
numberOfUnits	number	Количество единиц периода

AdaptyProductSubscriptionPeriod.Unit

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

Значение	Описание
`day`	Ежедневный период подписки
`week`	Еженедельный период подписки
`month`	Ежемесячный период подписки
`year`	Ежегодный период подписки
`unknown`	Неизвестная единица периода

AdaptyPaywall.ViewConfiguration

Название	Тип	Описание
responseLocale	AdaptyLocale	Локаль ответа
url	URL	URL конфигурации пейвола

AdaptyProductIdentifier

(только Flutter) Структурированное представление идентификатора продукта в Flutter SDK, содержащее больше информации, чем простые строковые идентификаторы.

Название	Тип	Описание
vendorProductId	string	ID продукта от вендора в сторе (App Store Connect или Google Play Console).

AdaptyPaywall

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

Название	Тип	Описание
placement	AdaptyPlacement	Информация о плейсменте для пейвола
instanceIdentity	string	Идентификатор пейвола, настроенный в дашборде Adapty
variationId	string	Идентификатор варианта, используемый для атрибуции покупок к этому пейволу
name	string	Название пейвола
remoteConfig	AdaptyRemoteConfig (optional)	Пользовательская конфигурация, настроенная в дашборде Adapty для этого пейвола
hasViewConfiguration	bool	Указывает, доступна ли для пейвола конфигурация отображения
viewConfiguration	AdaptyPaywall.ViewConfiguration (optional)	Конфигурация отображения для пейвола
vendorProductIds	array of strings	Массив идентификаторов связанных продуктов
webPaywallBaseUrl	URL (optional)	Подробнее см. в гайде по реализации веб-пейвола в приложении.

AdaptyProfile

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

Название	Тип	Описание
profileId	string	Идентификатор пользователя в Adapty
customerUserId	string (Optional)	Идентификатор пользователя в вашей системе
customAttributes	dictionary	Пользовательские атрибуты, ранее заданные с помощью метода `.updateProfile()`
accessLevels	dictionary<string, `AccessLevel`>	Ключи — идентификаторы уровней доступа, настроенных вами в дашборде Adapty. Значения — информация об уровнях доступа. Может быть null, если у пользователя нет уровней доступа
subscriptions	dictionary<string, `Subscription` >	Ключи — идентификаторы продуктов в сторе. Значения — информация о подписках. Может быть null, если у пользователя нет подписок
nonSubscriptions	dictionary<string, [`NonSubscription` ]>	Ключи — идентификаторы продуктов в сторе. Значения — массивы с информацией о расходуемых покупках. Может быть null, если у пользователя нет покупок.

AdaptyProfile.AccessLevel

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

Название	Тип	Описание
id	string	Уникальный идентификатор уровня доступа, настроенный вами в дашборде Adapty
isActive	boolean	True, если уровень доступа активен. Как правило, это свойство используется для проверки наличия у пользователя доступа к премиум-функциям
vendorProductId	string	Идентификатор продукта в сторе, который открыл данный уровень доступа
store	string	Стор, через который была совершена покупка, открывшая этот уровень доступа. Возможные значения: `‘app_store'
activatedAt	Date	Время активации уровня доступа
startsAt	Date (optional)	Время начала действия уровня доступа (может быть в будущем)
renewedAt	Date (optional)	Время последнего продления уровня доступа
expiresAt	Date (optional)	Время истечения уровня доступа (может быть в прошлом или равно null для пожизненного доступа)
isLifetime	boolean	True, если уровень доступа действует бессрочно (без даты истечения)
willRenew	boolean	True, если автоматически продлеваемая подписка настроена на продление
isInGracePeriod	boolean	True, если автоматически продлеваемая подписка находится в льготном периоде
unsubscribedAt	Date (optional)	Время отмены автоматически продлеваемой подписки. Подписка при этом может оставаться активной — это означает лишь отключение автопродления. Принимает значение null, если пользователь повторно активирует подписку
billingIssueDetectedAt	Date (optional)	Время обнаружения проблемы с оплатой. Подписка при этом может оставаться активной. Принимает значение null после успешного списания средств
cancellationReason	string (Optional)	Причина отмены подписки. Возможные значения: `‘voluntarily_cancelled'
isRefund	boolean	True, если покупка была возвращена
activeIntroductoryOfferType	string (Optional)	Тип активного introductory offer. Если значение не равно null, это означает, что предложение было применено в текущем расчётном периоде подписки. Возможные значения: `‘free_trial'
activePromotionalOfferType	string (Optional)	Тип активного promotional offer. Если значение не равно null, это означает, что предложение было применено в текущем расчётном периоде подписки. Возможные значения: `‘free_trial'
activePromotionalOfferId	string (Optional)	Идентификатор активного promotional offer
offerId	string (Optional)	Идентификатор активного предложения
startsAt	Date (optional)	Время начала действия уровня доступа (может быть в будущем)

AdaptyProfile.Subscription

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

Название	Тип	Описание
store	string	Стор, в котором была совершена покупка, открывшая эту подписку. Возможные значения: `‘app_store'
vendorProductId	string	Идентификатор продукта в сторе, который открыл эту подписку
vendorTransactionId	string	Идентификатор транзакции покупки в сторе, которая открыла эту подписку
vendorOriginalTransactionId	string	Оригинальный идентификатор транзакции покупки в сторе, которая открыла эту подписку. Для автовозобновляемой подписки это будет идентификатор первой транзакции в данной подписке
isActive	boolean	True, если подписка активна
isLifetime	boolean	True, если подписка действует бессрочно (без даты окончания)
activatedAt	Date	Время активации подписки
renewedAt	Date (optional)	Время последнего продления подписки
expiresAt	Date (optional)	Время истечения подписки (может быть в прошлом или равно null для пожизненного доступа)
startsAt	Date (optional)	Время начала действия подписки (может быть в будущем)
unsubscribedAt	Date (optional)	Время отмены автовозобновляемой подписки. Подписка при этом может оставаться активной — это означает, что автопродление отключено. Будет равно null, если пользователь возобновил подписку
billingIssueDetectedAt	Date (optional)	Время обнаружения проблемы с оплатой. Подписка при этом может оставаться активной
willRenew	boolean	True, если автовозобновляемая подписка настроена на продление
isInGracePeriod	boolean	Находится ли автовозобновляемая подписка в льготном периоде
cancellationReason	string (Optional)	Причина отмены подписки. Возможные значения: `‘voluntarily_cancelled'
isRefund	bool	True, если покупка была возвращена
activeIntroductoryOfferType	string (Optional)	Тип активного introductory offer. Если значение не равно null, это означает, что предложение было применено в течение текущего периода подписки. Возможные значения: `‘free_trial'
activePromotionalOfferType	string (Optional)	Тип активного promotional offer. Если значение не равно null, это означает, что предложение было применено в течение текущего периода подписки. Возможные значения: `‘free_trial'
activePromotionalOfferId	string (Optional)	Идентификатор активного promotional offer
offerId	string (Optional)	Идентификатор активного предложения
isSandbox	bool	True, если продукт был приобретён в среде песочницы

AdaptyProfile.NonSubscription

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

Название	Тип	Описание
purchaseId	string	Идентификатор покупки в Adapty. Используйте его, чтобы убедиться, что вы уже обработали эту покупку (например, при отслеживании разовых покупок)
vendorProductId	string	Идентификатор продукта в сторе
vendorTransactionId	string (optional)	ID транзакции в сторе
store	string	Стор, в котором совершена покупка. Возможные значения: `‘app_store'
purchasedAt	Date	Дата покупки продукта
isRefund	boolean	True, если покупка была возвращена
isConsumable	boolean	True, если продукт является расходуемой покупкой (должен быть обработан только один раз)
isSandbox	boolean	True, если продукт был куплен в среде песочницы

AdaptySubscriptionUpdateParameters

(только Android) Параметры для замены одной подписки на другую.

Имя	Тип	Описание
oldSubVendorProductId	string	Идентификатор текущей подписки в Play Market, которую нужно заменить.
ReplacementMode	enum	Enum, соответствующий значениям `BillingFlowParams.ProrationMode`.

AdaptyPlacement

Информация о конфигурации плейсмента.

Название	Тип	Описание
id	string	Уникальный идентификатор плейсмента
audienceName	string	Название аудитории для этого плейсмента
revision	number	Текущая ревизия (версия) плейсмента
abTestName	string	Название родительского A/B-теста

AdaptyRemoteConfig

Информация о Remote Config для плейсмента.

Название	Тип	Описание
locale	string	Идентификатор локали
jsonString	string	Пользовательская JSON-строка, настроенная в дашборде Adapty
dictionary	[String: Any]?	Пользовательский словарь, настроенный в дашборде Adapty (аналогично `jsonString`)