如果你已经创建了流程或在旧版付费墙编辑工具中创建了付费墙,则无需担心如何在移动应用代码中渲染它以向用户展示。此类流程或付费墙已包含展示内容及展示方式的完整配置。
Warning
本指南适用于由 Adapty 渲染的流程和付费墙。自定义付费墙和 观察者模式 的处理方式有所不同。
要获取下面使用的 flowConfiguration 对象,请参阅获取流程与付费墙。
要在设备屏幕上显示可视化流程,必须先进行配置。调用 AdaptyUI.getFlowView() 方法或直接创建 AdaptyFlowView:
val flowView = AdaptyUI.getFlowView(
activity,
flowConfiguration,
products,
eventListener,
insets,
customAssets,
tagResolver,
timerResolver,
)
val flowView =
AdaptyFlowView(activity) // or retrieve it from xml
...
with(flowView) {
showFlow(
flowConfiguration,
products,
eventListener,
insets,
customAssets,
tagResolver,
timerResolver,
)
}
AdaptyFlowView flowView = AdaptyUI.getFlowView(
activity,
flowConfiguration,
products,
eventListener,
insets,
customAssets,
tagResolver,
timerResolver
);
AdaptyFlowView flowView =
new AdaptyFlowView(activity); //add to the view hierarchy if needed, or you receive it from xml
...
flowView.showFlow(flowConfiguration, products, eventListener, insets, customAssets, tagResolver, timerResolver, observerModeHandler, customElementsResolver);
<com.adapty.ui.AdaptyFlowView xmlns:android="http://schemas.android.com/apk/res/android"
android:layout_width="match_parent"
android:layout_height="match_parent" />
视图成功创建后,你可以将其添加到视图层级中并在设备屏幕上显示。
如果你获取 AdaptyFlowView 时不是通过调用 AdaptyUI.getFlowView(),还需要额外调用 .showFlow() 方法。
要在设备屏幕上显示可视化流程,你需要先对其进行配置。请使用以下可组合函数:
AdaptyFlowScreen(
flowConfiguration,
products,
eventListener,
insets,
customAssets,
tagResolver,
timerResolver,
)
请求参数:
| 参数 | 是否必填 | 描述 |
|---|
| flowConfiguration | 必填 | 提供一个 AdaptyUI.FlowConfiguration 对象,包含流程的视觉细节。使用 AdaptyUI.getFlowConfiguration(flow) 方法加载。详情请参阅获取视图配置。 |
| products | 可选 | 提供一个 AdaptyPaywallProduct 数组,以优化产品在屏幕上的显示时机。如果传入 null,AdaptyUI 将自动获取所需产品。 |
| eventListener | 可选 | 提供一个 AdaptyFlowEventListener 以监听流程事件。建议继承 AdaptyFlowDefaultEventListener 以简化使用。详情请参阅处理流程与付费墙事件。 |
| insets | 可选 | Insets 是流程周围的间距,用于防止可点击元素被系统栏遮挡。 默认值为 Unspecified,即 Adapty 将自动调整 insets,适用于全屏边到边流程。 如果你的流程不是边到边布局,可能需要设置自定义 insets。具体方法请参阅下方修改流程 insets 部分。 |
| customAssets | 可选 | 传入一个 AdaptyCustomAssets 对象,以在运行时替换流程或付费墙中的图片和视频。详情请参阅自定义资源。 |
| tagResolver | 可选 | 一个 AdaptyUiTagResolver,用于为流程中的自定义标签返回应用的具体值。详情请参阅向流程传递数据。 |
| timerResolver | 可选 | 一个 AdaptyUiTimerResolver,根据计时器 ID 返回流程中每个开发者自定义计时器的结束时间。默认值为 AdaptyUiTimerResolver.Default,从屏幕打开起倒计时一小时。详情请参阅使用开发者自定义计时器。 |
| customElementsResolver | 可选 SDK 4.4+ | 一个 AdaptyCustomElementsResolver,用于为流程中的自定义元素返回应用的原生视图,将替换该流程视图中的全局解析器。详情请参阅显示自定义元素。 |
Tip
想查看 Adapty SDK 集成到移动应用的真实示例?请参阅我们的示例应用,其中演示了完整的配置流程,包括显示付费墙、发起购买以及其他基本功能。
修改流程边距
边距是指流程周围的空白区域,用于防止可点击元素被系统栏遮挡。默认情况下,Adapty 会自动调整边距,非常适合全面屏流程。
如果你的流程不是全面屏,可以自定义边距:
- 如果状态栏和导航栏都不与
AdaptyFlowView 重叠,请使用 AdaptyFlowInsets.None。
- 对于更复杂的场景,例如流程与顶部状态栏重叠但不与底部重叠,可以仅将
bottomInset 设置为 0,如下例所示:
//create extension function
fun View.onReceiveSystemBarsInsets(action: (insets: Insets) -> Unit) {
ViewCompat.setOnApplyWindowInsetsListener(this) { _, insets ->
val systemBarInsets = insets.getInsets(WindowInsetsCompat.Type.systemBars())
ViewCompat.setOnApplyWindowInsetsListener(this, null)
action(systemBarInsets)
insets
}
}
//and then use it with the view
flowView.onReceiveSystemBarsInsets { insets ->
val flowInsets = AdaptyFlowInsets.vertical(insets.top, 0)
flowView.showFlow(
flowConfiguration,
products,
eventListener,
flowInsets,
customAssets,
tagResolver,
timerResolver,
)
}
...
ViewCompat.setOnApplyWindowInsetsListener(flowView, (view, insets) -> {
Insets systemBarInsets = insets.getInsets(WindowInsetsCompat.Type.systemBars());
ViewCompat.setOnApplyWindowInsetsListener(flowView, null);
AdaptyFlowInsets flowInsets =
AdaptyFlowInsets.vertical(systemBarInsets.top, 0);
flowView.showFlow(flowConfiguration, products, eventListener, flowInsets, AdaptyCustomAssets.Empty,
AdaptyUiTagResolver.Default, AdaptyUiTimerResolver.Default, null, null);
return insets;
});
使用开发者自定义计时器
本节适用于在 Flow & Paywall Builder 中行为设置为 Developer defined 的计时器。在编辑工具中,每个此类计时器都有一个 Timer ID(请参阅让你的应用设置结束日期),你的应用需要为其设置结束日期。代码中使用的 Timer ID 必须与编辑工具中的完全一致,包括字母大小写和空格。如果两者不匹配,计时器将无法从应用获取结束日期。
要设置结束日期,请创建一个 AdaptyUiTimerResolver。它为每个 Timer ID 返回一个 Date(即结束日期)。以下是示例:
...
val customTimers = mapOf(
"CUSTOM_TIMER_NY" to Calendar.getInstance().apply {
set(get(Calendar.YEAR) + 1, Calendar.JANUARY, 1, 0, 0, 0)
}.time, // next New Year's Day
)
val timerResolver = AdaptyUiTimerResolver { timerId ->
customTimers[timerId] ?: AdaptyUiTimerResolver.Default.timerEndAtDate(timerId) // in 1 hour
}
...
Calendar newYear = Calendar.getInstance();
newYear.set(newYear.get(Calendar.YEAR) + 1, Calendar.JANUARY, 1, 0, 0, 0); // next New Year's Day
Map<String, Date> customTimers = new HashMap<>();
customTimers.put("CUSTOM_TIMER_NY", newYear.getTime());
AdaptyUiTimerResolver timerResolver = timerId -> {
Date date = customTimers.get(timerId);
return date != null ? date : AdaptyUiTimerResolver.Default.timerEndAtDate(timerId); // in 1 hour
};
将 timerResolver 传入 AdaptyUI.getFlowView、AdaptyFlowView.showFlow 或 AdaptyFlowScreen,方法与本页开头的示例相同。
在此示例中,CUSTOM_TIMER_NY 是编辑工具中开发者自定义计时器的 Timer ID。该计时器显示距离下一个元旦的剩余时间,例如 13d 09h 03m 34s。
每次打开包含计时器的页面时,SDK 都会调用解析器。如果解析器返回的是过去的日期,计时器会立即显示零,并触发其 On timer end 事件。若未传入解析器,SDK 默认使用 AdaptyUiTimerResolver.Default,该解析器从页面打开时开始倒计时一小时。
创建一个 AdaptyUiTagResolver,为流程中的每个自定义标签返回应用中对应的值:
val customTags = mapOf("username" to "DragonSlayer42")
val tagResolver = AdaptyUiTagResolver { tag -> customTags[tag] }
Map<String, String> customTags = new HashMap<>();
customTags.put("username", "DragonSlayer42");
AdaptyUiTagResolver tagResolver = customTags::get;
在此示例中,username 是 flow 中自定义标签的名称。用户将看到”DragonSlayer42”替代该标签显示。
将解析器传入 AdaptyUI.getFlowView、AdaptyFlowView.showFlow 或 AdaptyFlowScreen 的 tagResolver 参数中。
更改流程加载指示器颜色
您可以通过以下方式覆盖加载指示器的默认颜色:
<style name="AppTheme" parent="android:Theme.Material.Light.NoActionBar">
<item name="adapty_progressIndicatorColor">@color/yourColor</item>
</style>
如果您已使用付费墙编辑工具自定义了付费墙,则无需在移动应用代码中手动处理其渲染逻辑来向用户展示。此类付费墙已包含展示内容及展示方式的全部配置。
Warning
本指南仅适用于使用旧版付费墙编辑工具为 Adapty SDK 3.x 构建的付费墙,需要 SDK v3.0。展示为 SDK 2.x 或更早版本构建的付费墙、自定义付费墙,或在 Observer 模式下展示付费墙的方式有所不同。
要获取下文中使用的 viewConfiguration 对象,请参阅获取付费墙编辑工具付费墙及其配置。
要在设备屏幕上显示可视化付费墙,必须先对其进行配置。为此,调用 AdaptyUI.getPaywallView() 方法,或直接创建 AdaptyPaywallView:
val paywallView = AdaptyUI.getPaywallView(
activity,
viewConfiguration,
products,
eventListener,
insets,
personalizedOfferResolver,
tagResolver,
timerResolver,
)
val paywallView =
AdaptyPaywallView(activity) // or retrieve it from xml
...
with(paywallView) {
showPaywall(
viewConfiguration,
products,
eventListener,
insets,
personalizedOfferResolver,
tagResolver,
timerResolver,
)
}
AdaptyPaywallView paywallView = AdaptyUI.getPaywallView(
activity,
viewConfiguration,
products,
eventListener,
insets,
personalizedOfferResolver,
tagResolver,
timerResolver
);
AdaptyPaywallView paywallView =
new AdaptyPaywallView(activity); //add to the view hierarchy if needed, or you receive it from xml
...
paywallView.showPaywall(viewConfiguration, products, eventListener, insets, personalizedOfferResolver, tagResolver, timerResolver);
<com.adapty.ui.AdaptyPaywallView xmlns:android="http://schemas.android.com/apk/res/android"
android:layout_width="match_parent"
android:layout_height="match_parent" />
视图成功创建后,你可以将其添加到视图层级中,并在设备屏幕上显示出来。
如果你获取 AdaptyPaywallView 的方式_不是_通过调用 AdaptyUI.getPaywallView(),还需要额外调用 .showPaywall() 方法。
要在设备屏幕上显示可视化付费墙,必须先对其进行配置。请使用以下可组合函数:
AdaptyPaywallScreen(
viewConfiguration,
products,
eventListener,
insets,
personalizedOfferResolver,
tagResolver,
timerResolver,
)
请求参数:
| 参数 | 是否必填 | 描述 |
|---|
| viewConfiguration | 必填 | 提供一个包含付费墙视觉详情的 AdaptyUI.LocalizedViewConfiguration 对象。使用 Adapty.getViewConfiguration(paywall) 方法加载该对象。详情请参阅获取付费墙的视觉配置主题。 |
| products | 可选 | 提供一个 AdaptyPaywallProduct 数组,以优化产品在屏幕上的显示时机。如果传入 null,AdaptyUI 将自动获取所需产品。 |
| eventListener | 可选 | 提供一个 AdaptyUiEventListener 以监听付费墙事件。推荐继承 AdaptyUiDefaultEventListener 以简化使用。详情请参阅处理付费墙事件主题。 |
| insets | 可选 | Insets 是付费墙周围的间距,用于防止可点击元素被系统栏遮挡。 默认值为 UNSPECIFIED,即 Adapty 将自动调整 insets,非常适合全屏边到边付费墙。 如果你的付费墙不是边到边布局,可能需要设置自定义 insets。具体方法请参阅下方的更改付费墙 insets 部分。 |
| personalizedOfferResolver | 可选 | 如需标记个性化定价(了解更多),请实现 AdaptyUiPersonalizedOfferResolver 并传入你自己的逻辑,将 AdaptyPaywallProduct 映射为 true(表示该产品价格已个性化)或 false。 |
| tagResolver | 可选 | 使用 AdaptyUiTagResolver 解析付费墙文本中的自定义标签。该解析器接收一个标签参数,并将其解析为对应的字符串。详情请参阅付费墙编辑工具中的自定义标签主题。 |
| timerResolver | 可选 | 如果你要使用自定义计时器功能,请在此处传入对应的解析器。 |
Tip
想查看 Adapty SDK 集成到移动应用的真实示例?请参阅我们的示例应用,其中演示了完整的配置流程,包括显示付费墙、发起购买以及其他基本功能。
更改付费墙边距
边距是付费墙周围的空白区域,用于防止可点击元素被系统栏遮挡。默认情况下,Adapty 会自动调整边距,这对全屏付费墙效果很好。
如果你的付费墙不是全屏布局,可能需要自定义边距:
- 如果状态栏和导航栏都不与
AdaptyPaywallView 重叠,请使用 AdaptyPaywallInsets.NONE。
- 对于更复杂的自定义场景,例如付费墙与顶部状态栏重叠但不与底部重叠,可以仅将
bottomInset 设置为 0,如下例所示:
//create extension function
fun View.onReceiveSystemBarsInsets(action: (insets: Insets) -> Unit) {
ViewCompat.setOnApplyWindowInsetsListener(this) { _, insets ->
val systemBarInsets = insets.getInsets(WindowInsetsCompat.Type.systemBars())
ViewCompat.setOnApplyWindowInsetsListener(this, null)
action(systemBarInsets)
insets
}
}
//and then use it with the view
paywallView.onReceiveSystemBarsInsets { insets ->
val paywallInsets = AdaptyPaywallInsets.vertical(insets.top, 0)
paywallView.showPaywall(
viewConfiguration,
products,
eventListener,
paywallInsets,
personalizedOfferResolver,
tagResolver,
timerResolver,
)
}
...
ViewCompat.setOnApplyWindowInsetsListener(paywallView, (view, insets) -> {
Insets systemBarInsets = insets.getInsets(WindowInsetsCompat.Type.systemBars());
ViewCompat.setOnApplyWindowInsetsListener(paywallView, null);
AdaptyPaywallInsets paywallInsets =
AdaptyPaywallInsets.of(systemBarInsets.top, 0);
paywallView.showPaywall(paywall, products, viewConfiguration, paywallInsets, productTitleResolver);
return insets;
});
使用开发者自定义计时器
要在移动应用中使用开发者自定义计时器,请创建一个 timerResolver 对象——这是一个字典或映射,用于将自定义计时器与付费墙渲染时替换它们的字符串值进行配对。示例如下:
...
val customTimers = mapOf(
"CUSTOM_TIMER_NY" to Calendar.getInstance(TimeZone.getDefault()).apply { set(2025, 0, 1) }.time, // New Year 2025
)
val timerResolver = AdaptyUiTimerResolver { timerId ->
customTimers.getOrElse(timerId, { Date(System.currentTimeMillis() + 3600 * 1000L) /* in 1 hour */ } )
}
...
Map<String, Date> customTimers = new HashMap<>();
customTimers.put(
"CUSTOM_TIMER_NY",
new Calendar.Builder().setTimeZone(TimeZone.getDefault()).setDate(2025, 0, 1).build().getTime()
);
AdaptyUiTimerResolver timerResolver = new AdaptyUiTimerResolver() {
@NonNull
@Override
public Date timerEndAtDate(@NonNull String timerId) {
Date date = customTimers.get(timerId);
return date != null ? date : new Date(System.currentTimeMillis() + 3600 * 1000L); /* 1小时后 */
}
};
在此示例中,CUSTOM_TIMER_NY 是您在 Adapty 看板中设置的开发者自定义计时器的计时器 ID。timerResolver 确保您的应用动态更新计时器,显示正确的值——例如 13d 09h 03m 34s(计算方式为计时器结束时间(如元旦)减去当前时间)。
要在移动应用中使用自定义标签,需创建一个 tagResolver 对象——一个将自定义标签与渲染付费墙时用于替换它们的字符串值配对的字典或映射。示例如下:
val customTags = mapOf("USERNAME" to "John")
val tagResolver = AdaptyUiTagResolver { tag -> customTags[tag] }
Map<String, String> customTags = new HashMap<>();
customTags.put("USERNAME", "John");
AdaptyUiTagResolver tagResolver = customTags::get;
在此示例中,USERNAME 是你在 Adapty 看板中以 <USERNAME/> 格式输入的自定义标签。tagResolver 会确保应用将该自定义标签动态替换为指定的值——例如 John。
建议在展示付费墙之前创建并填充 tagResolver。准备好后,将其传入用于展示付费墙的 AdaptyUI 方法。
更改付费墙加载指示器颜色
您可以通过以下方式覆盖加载指示器的默认颜色:
<style name="AppTheme" parent="android:Theme.Material.Light.NoActionBar">
<item name="adapty_progressIndicatorColor">@color/yourColor</item>
</style>