Отображение пейволов Paywall Builder в режиме Observer в iOS SDK

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

Этот раздел относится только к режиму Observer. Если вы не работаете в режиме Observer, обратитесь к разделу iOS — отображение пейволов, созданных в Paywall Builder.

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

Настройте первоначальную интеграцию Adapty с App Store. 2. Установите и настройте SDK. Убедитесь, что параметр observerMode установлен в true. Обратитесь к руководству по установке iOS SDK. 3. Создайте продукты в дашборде Adapty. 4. Настройте флоу или пейволы в билдерах и привяжите к ним продукты. 5. Создайте плейсменты и назначьте им флоу или пейволы. 6. Получите флоу и их конфигурацию в коде мобильного приложения.

Реализуйте объект AdaptyObserverModeResolver. Протокол не изменился по сравнению с SDK v3 — режим наблюдателя работает одинаково как для флоу, так и для пейвола:

func observerMode(didInitiatePurchase product: AdaptyPaywallProduct,
                  onStartPurchase: @escaping () -> Void,
                  onFinishPurchase: @escaping () -> Void) {
       // use the product object to handle the purchase
       // call onStartPurchase / onFinishPurchase to notify AdaptyUI about the purchase progress
}

func observerModeDidInitiateRestorePurchases(onStartRestore: @escaping () -> Void,
                                             onFinishRestore: @escaping () -> Void) {
       // call onStartRestore / onFinishRestore to notify AdaptyUI about the restore progress
}

Создайте объект конфигурации флоу, передав ваш resolver в качестве параметра observerModeResolver::

do {
    let flowConfiguration = try await AdaptyUI.getFlowConfiguration(
        forFlow: flow,
        observerModeResolver: <AdaptyObserverModeResolver>
    )
} catch {
    // handle the error
}

Параметры запроса:

Параметр	Наличие	Описание
forFlow	обязательный	Объект `AdaptyFlow`, полученный через `Adapty.getFlow(placementId:)`. См. Получение флоу и пейволов.
observerModeResolver	обязательный	Реализованный вами `AdaptyObserverModeResolver`.

Инициализируйте контроллер флоу с помощью AdaptyUI.flowController(with:delegate:):

import AdaptyUI

let visualFlow = try AdaptyUI.flowController(
    with: flowConfiguration,
    delegate: <AdaptyFlowControllerDelegate>
)

Параметры запроса:

Параметр	Наличие	Описание
flowConfiguration	required	Объект `AdaptyUI.FlowConfiguration`, содержащий визуальные детали флоу. См. Получение флоу и пейволов.
delegate	required	`AdaptyFlowControllerDelegate` для прослушивания событий флоу. См. Обработка событий флоу и пейвола.

Возвращаемые значения:

Объект	Описание
AdaptyFlowController	Объект, представляющий запрошенный экран флоу.

Отобразите контроллер:
```
present(visualFlow, animated: true)
```

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

В SwiftUI получите конфигурацию флоу с помощью резолвера и передайте её в модификатор .flow:

@State var flowPresented = false
@State var flowConfiguration: AdaptyUI.FlowConfiguration?

var body: some View {
    Text("Hello, AdaptyUI!")
        .flow(
            isPresented: $flowPresented,
            flowConfiguration: flowConfiguration,
            didPerformAction: { action in
                switch action {
                    case .close:
                        flowPresented = false
                    default:
                        break
                }
            },
            didFinishPurchase: { product, purchaseResult in /* dismiss, or do nothing to let the flow continue */ },
            didFailPurchase: { product, error in /* handle the error */ },
            didFinishRestore: { profile in /* check access level and dismiss */ },
            didFailRestore: { error in /* handle the error */ },
            didReceiveError: { error in flowPresented = false }
        )
        .task {
            flowConfiguration = try? await AdaptyUI.getFlowConfiguration(
                forFlow: flow,
                observerModeResolver: <AdaptyObserverModeResolver>
            )
        }
}

Параметр observerModeResolver: в getFlowConfiguration обеспечивает соблюдение вашей кастомной логики покупок в отображаемом флоу — сам модификатор использует те же коллбэки, что и полный режим.

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

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

Настройте начальную интеграцию Adapty с Google Play и с App Store. 2. Установите и настройте Adapty SDK. Убедитесь, что параметр observerMode установлен в значение true. Обратитесь к нашим инструкциям для конкретных фреймворков: iOS. 3. Создайте продукты в дашборде Adapty. 4. Настройте пейволы, добавьте к ним продукты и кастомизируйте их с помощью Paywall Builder в дашборде Adapty. 5. Создайте плейсменты и назначьте им пейволы в дашборде Adapty. 6. Получите пейволы Paywall Builder и их конфигурацию в коде вашего мобильного приложения.

Реализуйте объект AdaptyObserverModeResolver:

func observerMode(didInitiatePurchase product: AdaptyPaywallProduct,
                  onStartPurchase: @escaping () -> Void,
                  onFinishPurchase: @escaping () -> Void) {
       // use the product object to handle the purchase
       // use the onStartPurchase and onFinishPurchase callbacks to notify AdaptyUI about the process of the purchase
}

func observerModeDidInitiateRestorePurchases(onStartRestore: @escaping () -> Void,
                                             onFinishRestore: @escaping () -> Void) {
       // use the onStartRestore and onFinishRestore callbacks to notify AdaptyUI about the process of the restore
}

Событие observerMode(didInitiatePurchase:onStartPurchase:onFinishPurchase:) уведомит вас о том, что пользователь инициировал покупку. В ответ на этот колбэк вы можете запустить собственный флоу покупки.

Событие observerModeDidInitiateRestorePurchases(onStartRestore:onFinishRestore:) уведомит вас о том, что пользователь инициировал восстановление покупок. В ответ на этот колбэк вы можете запустить собственный флоу восстановления. Также не забудьте вызывать следующие колбэки, чтобы уведомить AdaptyUI о процессе покупки или восстановления. Это необходимо для корректной работы пейвола — например, для отображения загрузчика:

Callback	Описание
onStartPurchase()	Колбэк необходимо вызвать, чтобы уведомить AdaptyUI о начале покупки.
onFinishPurchase()	Колбэк необходимо вызвать, чтобы уведомить AdaptyUI о завершении покупки.
onStartRestore()	Колбэк необходимо вызвать, чтобы уведомить AdaptyUI о начале восстановления покупок.
onFinishRestore()	Колбэк необходимо вызвать, чтобы уведомить AdaptyUI о завершении восстановления покупок.

Создайте объект конфигурации пейвола:

do {
    let paywallConfiguration = try AdaptyUI.getPaywallConfiguration(
     forPaywall: <paywall object>, 
     observerModeResolver: <AdaptyObserverModeResolver>
     )
} catch {
    // handle the error
}

Параметры запроса:

Параметр	Наличие	Описание
Paywall	обязательный	Объект `AdaptyPaywall` для получения контроллера нужного пейвола.
ObserverModeResolver	обязательный	Объект `AdaptyObserverModeResolver`, реализованный на предыдущем шаге.

Инициализируйте визуальный пейвол, который хотите отобразить, с помощью метода .paywallController(for:products:viewConfiguration:delegate:):
```
import AdaptyUI

let visualPaywall = AdaptyUI.paywallController(
    with: <paywall configuration object>,
    delegate: <AdaptyPaywallControllerDelegate>
)
```

Параметры запроса:

Параметр	Наличие	Описание
Paywall Configuration	обязательный	Объект `AdaptyUI.PaywallConfiguration`, содержащий визуальные данные пейвола. Используйте метод `AdaptyUI.getPaywallConfiguration(forPaywall:locale:)`. Подробнее см. в разделе Получение пейволов Paywall Builder и их конфигурации.
Delegate	обязательный	Объект `AdaptyPaywallControllerDelegate` для прослушивания событий пейвола. Подробнее см. в разделе Обработка событий пейвола.
Возвращает:

Объект	Описание
AdaptyPaywallController	Объект, представляющий запрошенный экран пейвола

После успешного создания объекта его можно отобразить следующим образом:

present(visualPaywall, animated: true)

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

Чтобы отобразить визуальный пейвол на экране устройства, используйте модификатор .paywall в SwiftUI:

@State var paywallPresented = false

var body: some View {
	Text("Hello, AdaptyUI!")
			.paywall(
          isPresented: $paywallPresented,
          paywallConfiguration: <paywall configuration object>,
          didPerformAction: { action in
              switch action {
                  case .close:
                      paywallPresented = false
                  default:
                      // Handle other actions
                      break
              }
          },
          didFinishRestore: { profile in /* check access level and dismiss */  },
          didFailRestore: { error in /* handle the error */ },
          didFailRendering: { error in paywallPresented = false }
      )
}

Параметры запроса:

Параметр	Наличие	Описание
Paywall Configuration	обязательный	Объект `AdaptyUI.PaywallConfiguration`, содержащий визуальные параметры пейвола. Используйте метод `AdaptyUI.getPaywallConfiguration(forPaywall:locale:)`. Подробнее см. в разделе Получение пейволов Paywall Builder и их конфигурации.
Products	необязательный	Передайте массив объектов `AdaptyPaywallProduct`, чтобы оптимизировать время отображения продуктов на экране. Если передать `nil`, AdaptyUI автоматически загрузит необходимые продукты.
TagResolver	необязательный	Задайте словарь пользовательских тегов и их значений. Пользовательские теги служат плейсхолдерами в контенте пейвола и динамически заменяются конкретными строками для персонализации содержимого. Подробнее см. в разделе «Пользовательские теги в Paywall Builder».
ObserverModeResolver	необязательный	Объект `AdaptyObserverModeResolver`, реализованный на предыдущем шаге.
Параметры замыкания:

Параметр замыкания	Описание
didFinishRestore	Вызывается, если Adapty.restorePurchases() выполняется успешно.
didFailRestore	Вызывается, если Adapty.restorePurchases() завершается с ошибкой.
didFailRendering	Вызывается, если в процессе отрисовки интерфейса возникает ошибка.
Обратитесь к разделу iOS - Обработка событий за описанием других параметров замыкания.

Before you start presenting paywalls (Click to Expand)

Настройте базовую интеграцию Adapty с Google Play и с App Store.
Установите и настройте Adapty SDK. Обязательно задайте параметру observerMode значение true. Смотрите инструкции для конкретных фреймворков: iOS, React Native, Flutter и Unity.
Создайте продукты в дашборде Adapty.
Настройте пейволы, добавьте к ним продукты и кастомизируйте их с помощью Paywall Builder в дашборде Adapty.
Создайте плейсменты и привяжите к ним пейволы в дашборде Adapty.
Загрузите пейволы Paywall Builder и их конфигурацию в коде вашего мобильного приложения.

Реализуйте объект AdaptyObserverModeDelegate:

func paywallController(_ controller: AdaptyPaywallController,
                       didInitiatePurchase product: AdaptyPaywallProduct,
                       onStartPurchase: @escaping () -> Void,
                       onFinishPurchase: @escaping () -> Void) {
       // use the product object to handle the purchase
       // use the onStartPurchase and onFinishPurchase callbacks to notify AdaptyUI about the process of the purchase
}

paywallController(_:didInitiatePurchase:onStartPurchase:onFinishPurchase:) уведомляет о том, что пользователь инициировал покупку. В ответ на это событие вы можете запустить собственный флоу покупки.

Также не забудьте вызвать следующие колбэки, чтобы уведомить AdaptyUI о ходе покупки. Это необходимо для корректного поведения пейвола, например для отображения лоадера:

Callback	Description
onStartPurchase	Этот коллбэк нужно вызвать, чтобы уведомить AdaptyUI о начале покупки.
onFinishPurchase	Этот коллбэк нужно вызвать, чтобы уведомить AdaptyUI о завершении покупки.

Инициализируйте визуальный пейвол, который нужно отобразить, с помощью метода .paywallController(for:products:viewConfiguration:delegate:observerModeDelegate:):

   import AdaptyUI
   
   let visualPaywall = AdaptyUI.paywallController(
       for: <paywall object>,
       products: <paywall products array>,
       viewConfiguration: <LocalizedViewConfiguration>,
       delegate: <AdaptyPaywallControllerDelegate>
       observerModeDelegate: <AdaptyObserverModeDelegate>
   )

Параметры запроса:

Параметр	Обязательность	Описание
Paywall	обязательный	Объект `AdaptyPaywall` для получения контроллера нужного пейвола.
Products	необязательный	Передайте массив объектов `AdaptyPaywallProduct`, чтобы оптимизировать время отображения продуктов на экране. Если передать `nil`, AdaptyUI автоматически загрузит необходимые продукты.
ViewConfiguration	обязательный	Объект `AdaptyUI.LocalizedViewConfiguration`, содержащий визуальные настройки пейвола. Используйте метод `AdaptyUI.getViewConfiguration(paywall:locale:)`. Подробнее см. в разделе Получение пейволов Paywall Builder и их конфигурации.
Delegate	обязательный	Объект `AdaptyPaywallControllerDelegate` для обработки событий пейвола. Подробнее см. в разделе Обработка событий пейвола.
ObserverModeDelegate	обязательный	Объект `AdaptyObserverModeDelegate`, реализованный на предыдущем шаге.
TagResolver	необязательный	Определите словарь пользовательских тегов и их значений. Пользовательские теги служат плейсхолдерами в контенте пейвола и динамически заменяются конкретными строками для персонализации содержимого. Подробнее см. в разделе «Пользовательские теги в Paywall Builder».
Возвращает:

Объект	Описание
AdaptyPaywallController	Объект, представляющий запрошенный экран пейвола

После успешного создания объекта его можно отобразить следующим образом:

present(visualPaywall, animated: true)

Чтобы отобразить визуальный пейвол на экране устройства, используйте модификатор .paywall в SwiftUI:

@State var paywallPresented = false

var body: some View {
	Text("Hello, AdaptyUI!")
			.paywall(
          isPresented: $paywallPresented,
          paywall: <paywall object>,
          configuration: <LocalizedViewConfiguration>,
          didPerformAction: { action in
              switch action {
                  case .close:
                      paywallPresented = false
                  default:
                      // Handle other actions
                      break
              }
          },
          didFinishRestore: { profile in /* check access level and dismiss */  },
          didFailRestore: { error in /* handle the error */ },
          didFailRendering: { error in paywallPresented = false },
          observerModeDidInitiatePurchase: { product, onStartPurchase, onFinishPurchase in
              // use the product object to handle the purchase
              // use the onStartPurchase and onFinishPurchase callbacks to notify AdaptyUI about the process of the purchase
          }, 
      )
}

Параметры запроса:

Параметр	Обязательность	Описание
Paywall	обязательный	Объект `AdaptyPaywall` для получения контроллера нужного пейвола.
Product	необязательный	Передайте массив объектов `AdaptyPaywallProduct`, чтобы оптимизировать время отображения продуктов на экране. Если передать `nil`, AdaptyUI автоматически загрузит необходимые продукты.
Configuration	обязательный	Объект `AdaptyUI.LocalizedViewConfiguration`, содержащий визуальные параметры пейвола. Используйте метод `AdaptyUI.getViewConfiguration(paywall:locale:)`. Подробнее см. в разделе Получение пейволов Paywall Builder и их конфигурации.
TagResolver	необязательный	Задайте словарь пользовательских тегов и их значений. Пользовательские теги служат плейсхолдерами в содержимом пейвола и динамически заменяются конкретными строками для персонализации контента. Подробнее см. в разделе о пользовательских тегах в Paywall Builder.
Параметры замыкания:
Параметр closure	Описание
:----------------------------------	:----------------------------------------------------------------------------------------------
didFinishRestore	Вызывается, если Adapty.restorePurchases() выполняется успешно.
didFailRestore	Вызывается, если Adapty.restorePurchases() завершается с ошибкой.
didFailRendering	Вызывается, если во время отрисовки интерфейса возникает ошибка.
observerModeDidInitiatePurchase	Вызывается, когда пользователь инициирует покупку.
Дополнительные параметры замыкания описаны в разделе iOS - Обработка событий.

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