将 Adapty Android SDK 迁移至 v. 4.0

Adapty Android SDK 4.0 引入了流程功能，并相应地对付费墙 API 进行了重命名。新 API 同时兼容新版流程编辑工具和现有的付费墙编辑工具——无需在 Adapty 看板端进行任何配置变更。

快速参考

v3	v4
`Adapty.getPaywall(placementId, locale)`	`Adapty.getFlow(placementId)`
`Adapty.getPaywallForDefaultAudience(placementId, locale)`	`Adapty.getFlowForDefaultAudience(placementId)`
`AdaptyUI.getViewConfiguration(paywall)`	`AdaptyUI.getFlowConfiguration(flow, locale)`
`AdaptyUI.LocalizedViewConfiguration`	`AdaptyUI.FlowConfiguration`
`Adapty.getPaywallProducts(paywall)`	`Adapty.getPaywallProducts(flow)`
`Adapty.logShowPaywall(paywall)`	`Adapty.logShowFlow(flow)`
`AdaptyPaywall`	`AdaptyFlow`
`AdaptyUI.getPaywallView(...)`	`AdaptyUI.getFlowView(...)`
`AdaptyPaywallView`	`AdaptyFlowView`
`AdaptyPaywallScreen` (Compose)	`AdaptyFlowScreen`
`showPaywall(...)`	`showFlow(...)`
`AdaptyPaywallInsets`	`AdaptyFlowInsets`
`AdaptyUiEventListener`	`AdaptyFlowEventListener`
`AdaptyUiDefaultEventListener`	`AdaptyFlowDefaultEventListener`
`onPaywallShown` / `onPaywallClosed`	`onFlowShown` / `onFlowClosed`
`onRenderingError`	`onError`
`Adapty.updateAttribution(attribution, source)` (`source: String`)	`Adapty.updateAttribution(attribution, source)` (`source: AdaptyAttributionSource`)
`Adapty.setIntegrationIdentifier(key, value)`	`Adapty.setIntegrationIdentifier(AdaptyIntegrationIdentifier)`
`AdaptyPaywallProduct` 保持原名不变——产品仍属于某个 flow，`getPaywallProducts` 现在接收 `AdaptyFlow` 参数。其他 `AdaptyFlowEventListener` 方法（`onProductSelected`、`onPurchaseStarted`、`onPurchaseFinished`、`onPurchaseFailure`、`onRestoreSuccess`、`onRestoreFailure`、`onActionPerformed`、`onAwaitingPurchaseParams`、`onLoadingProductsFailure` 等）保持原有名称和签名不变。

安装

将 adapty-bom 版本设置为 4.0.0（或更高版本）并同步项目。BOM 会自动为你解析匹配的 android-sdk 和 android-ui 版本。依赖项声明请参见安装 Adapty SDK。

已移除和废弃的 API

Adapty.makePurchase(activity, product, subscriptionUpdateParams, isOfferPersonalized, callback) — 已移除。此重载方法在 v3 中已废弃。请改用 AdaptyPurchaseParameters 传入相同的选项：

- Adapty.makePurchase(activity, product, subscriptionUpdateParams, isOfferPersonalized) { result -> /* ... */ }
+ val params = AdaptyPurchaseParameters.Builder()
+     .withSubscriptionUpdateParams(subscriptionUpdateParams)
+     .withOfferPersonalized(isOfferPersonalized)
+     .build()
+ Adapty.makePurchase(activity, product, params) { result -> /* ... */ }

用户引导已弃用。 AdaptyUI.getOnboardingView 和 AdaptyUI.getOnboardingConfiguration 在 4.0 中标记为 @Deprecated — 请将用户引导迁移到在流程编辑工具中构建的流程。

获取流程

getPaywall + getViewConfiguration → getFlow + getFlowConfiguration

获取返回类型从 AdaptyPaywall 变更为 AdaptyFlow，配置加载器从 AdaptyUI.getViewConfiguration 重命名为 AdaptyUI.getFlowConfiguration（返回 AdaptyUI.FlowConfiguration 而非 AdaptyUI.LocalizedViewConfiguration）。locale 参数从获取调用中移出，改为传入 getFlowConfiguration：

- Adapty.getPaywall("YOUR_PLACEMENT_ID", locale = "en") { result ->
+ Adapty.getFlow("YOUR_PLACEMENT_ID") { result ->
      if (result is AdaptyResult.Success) {
-         val paywall = result.value
-         if (!paywall.hasViewConfiguration) return@getPaywall
-         AdaptyUI.getViewConfiguration(paywall) { configResult ->
+         val flow = result.value
+         if (!flow.hasViewConfiguration) return@getFlow
+         AdaptyUI.getFlowConfiguration(flow, locale = "en") { configResult ->
              if (configResult is AdaptyResult.Success) {
                  val flowConfiguration = configResult.value
              }
          }
      }
  }

getPaywallProducts(paywall) → getPaywallProducts(flow)

getPaywallProducts 现在接受由 Adapty.getFlow 返回的 AdaptyFlow：

- Adapty.getPaywallProducts(paywall) { result -> /* products */ }
+ Adapty.getPaywallProducts(flow) { result -> /* products */ }

跟踪流程浏览数据

logShowPaywall → logShowFlow

logShowPaywall 已重命名为 logShowFlow，现在接受 AdaptyFlow 而非 AdaptyPaywall。事件仍会记录在同一个实验变体下，因此现有的漏斗和 A/B 测试数据图表无需修改看板即可继续正常使用。

- Adapty.logShowPaywall(paywall)
+ Adapty.logShowFlow(flow)

与 v3 一样，当展示由流程编辑工具或付费墙编辑工具渲染的流程或付费墙时，无需手动调用此方法——Adapty 会自动追踪这些页面的浏览记录。

显示流程

getPaywallView / AdaptyPaywallView → getFlowView / AdaptyFlowView

重命名工厂方法和视图类型，并传入 AdaptyUI.FlowConfiguration：

- val paywallView = AdaptyUI.getPaywallView(
-     activity,
-     viewConfiguration,
-     products,
-     eventListener,
- )
+ val flowView = AdaptyUI.getFlowView(
+     activity,
+     flowConfiguration,
+     products,
+     eventListener,
+ )

如果直接创建视图，show 方法也需要重命名：

- val paywallView = AdaptyPaywallView(activity)
- paywallView.showPaywall(viewConfiguration, products, eventListener)
+ val flowView = AdaptyFlowView(activity)
+ flowView.showFlow(flowConfiguration, products, eventListener)

在 XML 布局中，更新视图标签：

- <com.adapty.ui.AdaptyPaywallView ... />
+ <com.adapty.ui.AdaptyFlowView ... />

可选参数 personalizedOfferResolver 已从 getFlowView / showFlow / AdaptyFlowScreen 中移除。如需标记个性化定价，请通过 onAwaitingPurchaseParams 为每个产品单独设置（AdaptyPurchaseParameters.Builder().withOfferPersonalized(true)）。新增的可选参数 customAssets 允许你在运行时覆盖图片和视频——详见自定义资源。

AdaptyPaywallScreen → AdaptyFlowScreen

在 Jetpack Compose 中，重命名 composable 并更新配置参数：

- AdaptyPaywallScreen(
-     viewConfiguration,
+ AdaptyFlowScreen(
+     flowConfiguration,
      products,
      eventListener,
  )

处理事件

事件监听器已从 AdaptyUiEventListener 重命名为 AdaptyFlowEventListener（AdaptyUiDefaultEventListener 也相应重命名为 AdaptyFlowDefaultEventListener）。大多数方法名保持不变；生命周期和渲染相关的回调已重命名：

- class YourListener : AdaptyUiDefaultEventListener() {
+ class YourListener : AdaptyFlowDefaultEventListener() {

-     override fun onPaywallShown(context: Context) {}
-     override fun onPaywallClosed() {}
+     override fun onFlowShown(context: Context) {}
+     override fun onFlowClosed() {}

-     override fun onRenderingError(error: AdaptyError, context: Context) {}
+     override fun onError(error: AdaptyError, context: Context) {}
  }

现有的处理器主体无需修改代码——只需重命名类型和重写方法即可。onError 触发的场景与 onRenderingError 相同，还额外涵盖其他非购买类运行时错误。完整的回调列表请参阅处理流程与付费墙事件。 v4 还新增了 onBackPressed(context): Boolean 回调，其默认行为也改变了系统返回键的处理方式。此前，返回键（或返回手势）会透传给 Activity 或 Fragment，通常会关闭付费墙。v4 中默认实现会消费该按键事件，因此系统返回键不再自动关闭流程——与 iOS 保持一致（iOS 上流程无法通过系统手势关闭）。请为用户提供明确的退出方式（添加 Close 按钮或 on_device_back 操作），或者重写 onBackPressed 并返回 false 以恢复旧有行为。详情请参阅系统返回键。默认购买处理器也不再自动关闭屏幕。在 v3 中，默认的 onPurchaseFinished 会在任何非用户主动取消的购买完成后（成功或待处理的购买）关闭付费墙。在 v4 中它是一个空操作，因此流程在购买完成后会保持打开状态，直到你手动关闭它——这与 iOS 的行为一致。如果你之前依赖自动关闭功能，请在购买完成后自行关闭屏幕。具体示例请参阅购买成功、取消或待处理。

归因与集成标识符

updateAttribution

source 参数从 String 类型变更为新的 AdaptyAttributionSource 类型，attribution 现在是 Map<String, Any>（同时也提供 JSON String 重载）。请使用以下预定义来源之一：

- Adapty.updateAttribution(attribution, "appsflyer") { error -> /* handle the error */ }
+ Adapty.updateAttribution(attribution, AdaptyAttributionSource.APPSFLYER) { error -> /* handle the error */ }

预定义来源：AdaptyAttributionSource.APPLE_ADS、.ADJUST、.APPSFLYER、.BRANCH、.TENJIN。如需使用其他来源，可通过字符串构建：AdaptyAttributionSource("your_source")。

setIntegrationIdentifier

setIntegrationIdentifier(key, value) 已被替换为接受一个或多个 AdaptyIntegrationIdentifier 值的方法。请使用便捷方法构建每个标识符，而不是传入原始字符串键：

- Adapty.setIntegrationIdentifier("appsflyer_id", appsFlyerId) { error -> /* handle the error */ }
+ Adapty.setIntegrationIdentifier(AdaptyIntegrationIdentifier.appsflyerId(appsFlyerId)) { error -> /* handle the error */ }

你可以在一次调用中设置多个标识符：

Adapty.setIntegrationIdentifier(
    listOf(
        AdaptyIntegrationIdentifier.appsflyerId(appsFlyerId),
        AdaptyIntegrationIdentifier.adjustDeviceId(adjustDeviceId),
    )
) { error -> /* handle the error */ }

将每个旧的键字符串替换为对应的便捷方法：

v3 键名	v4 `AdaptyIntegrationIdentifier` 方法
`"adjust_device_id"`	`adjustDeviceId(value)`
`"airbridge_device_id"`	`airbridgeDeviceId(value)`
`"amplitude_user_id"`	`amplitudeUserId(value)`
`"amplitude_device_id"`	`amplitudeDeviceId(value)`
`"appmetrica_device_id"`	`appmetricaDeviceId(value)`
`"appmetrica_profile_id"`	`appmetricaProfileId(value)`
`"appsflyer_id"`	`appsflyerId(value)`
`"branch_id"`	`branchId(value)`
`"facebook_anonymous_id"`	`facebookAnonymousId(value)`
`"firebase_app_instance_id"`	`firebaseAppInstanceId(value)`
`"mixpanel_user_id"`	`mixpanelUserId(value)`
`"one_signal_subscription_id"`	`oneSignalSubscriptionId(value)`
`"one_signal_player_id"`	`oneSignalPlayerId(value)`
`"posthog_distinct_user_id"`	`posthogDistinctUserId(value)`
`"pushwoosh_hwid"`	`pushwooshHWID(value)`
`"tenjin_analytics_installation_id"`	`tenjinAnalyticsInstallationId(value)`
对于不在此列表中的键，可以直接使用自定义 `Key` 来构建标识符：`AdaptyIntegrationIdentifier(AdaptyIntegrationIdentifier.Key("custom"), customValue)`。