在 Kotlin Multiplatform SDK 中获取付费墙编辑工具付费墙及其配置

在 Adapty 看板中使用新版付费墙编辑工具设计付费墙的视觉部分后,您可以在移动应用中展示该付费墙。此流程的第一步是获取与版位关联的付费墙及其视图配置,具体步骤如下所述。

请注意,本主题涉及使用付费墙编辑工具自定义的付费墙。如果您是手动实现付费墙,请参阅在移动应用中为远程配置付费墙获取付费墙和产品主题。

想了解 Adapty SDK 如何集成到移动应用中的真实示例?请查看我们的示例应用,其中展示了完整的配置过程,包括显示付费墙、完成购买以及其他基本功能。

在移动应用中展示付费墙之前(点击展开)
  1. 在 Adapty 看板中创建您的产品
  2. 在 Adapty 看板中创建付费墙并将产品添加到其中
  3. 在 Adapty 看板中创建版位并将付费墙添加到其中
  4. 在您的移动应用中安装 Adapty SDK

获取使用付费墙编辑工具设计的付费墙

如果您已使用付费墙编辑工具设计了付费墙,则无需在移动应用代码中处理其渲染逻辑即可向用户展示。此类付费墙同时包含展示内容和展示方式。但您仍需通过版位获取其 ID、视图配置,然后在移动应用中呈现它。

为确保最佳性能,请务必尽早获取付费墙及其视图配置,以便在向用户展示之前有足够时间下载图片。

使用 getPaywall 方法获取付费墙:

import com.adapty.kmp.Adapty
import com.adapty.kmp.models.AdaptyPaywallFetchPolicy

Adapty.getPaywall(
    placementId = "YOUR_PLACEMENT_ID",
    locale = "en",
    fetchPolicy = AdaptyPaywallFetchPolicy.Default,
    loadTimeout = 5.seconds
).onSuccess { paywall ->
    // the requested paywall
}.onError { error ->
    // handle the error
}

参数说明:

参数是否必填描述
placementId必填目标版位的标识符。这是您在 Adapty 看板中创建版位时指定的值。
locale

可选

默认值:en

付费墙本地化的标识符。此参数应为由一个或两个子标签组成的语言代码,子标签之间以减号(-)分隔。第一个子标签表示语言,第二个子标签表示地区。

示例:en 表示英语,pt-br 表示巴西葡萄牙语。

有关区域代码及使用建议,请参阅本地化与区域代码

fetchPolicy默认值:AdaptyPaywallFetchPolicy.Default

默认情况下,SDK 会尝试从服务器加载数据,若失败则返回缓存数据。我们推荐此方式,因为它能确保用户始终获取最新数据。

但如果您认为用户的网络连接不稳定,可以考虑使用 AdaptyPaywallFetchPolicy.ReturnCacheDataElseLoad,在缓存存在时返回缓存数据。在这种情况下,用户可能无法获取最新数据,但无论网络状况如何都能获得更快的加载速度。缓存会定期更新,因此在会话期间使用它以避免网络请求是安全的。

请注意,缓存在重启应用后保持不变,仅在卸载重装应用或手动清理时才会清除。

Adapty SDK 在本地以两层存储付费墙:上述定期更新的缓存和备用付费墙。我们还使用 CDN 更快地获取付费墙,以及在 CDN 不可达时使用独立的备用服务器。此系统旨在确保您始终获取最新版本的付费墙,同时在网络连接不佳的情况下也能保证可靠性。

loadTimeout默认值:5 秒

此值限制该方法的超时时间。如果达到超时,将返回缓存数据或本地备用数据。

请注意,在极少数情况下,此方法的超时时间可能略晚于 loadTimeout 中指定的时间,因为该操作在底层可能由多个不同请求组成。

对于 Kotlin Multiplatform:您可以使用扩展函数(如 5.seconds,其中 .seconds 来自 import com.adapty.utils.seconds)或 TimeInterval.seconds(5) 创建 TimeInterval。若不设置限制,请使用 TimeInterval.INFINITE

响应参数:

参数描述
Paywall一个 AdaptyPaywall 对象,包含产品 ID 列表、付费墙标识符、远程配置及其他若干属性。

获取使用付费墙编辑工具设计的付费墙的视图配置

请确保在付费墙编辑工具中开启 Show on device 开关。如果未开启此选项,将无法获取视图配置。

获取付费墙后,检查其是否包含 ViewConfiguration,这表示该付费墙是使用付费墙编辑工具创建的。这将指导您如何展示该付费墙。如果存在 ViewConfiguration,则将其视为付费墙编辑工具付费墙;否则,将其作为远程配置付费墙处理

使用 createPaywallView 方法加载视图配置。

import com.adapty.kmp.AdaptyUI
import kotlin.time.Duration.Companion.seconds

if (paywall.hasViewConfiguration) {
    AdaptyUI.createPaywallView(
        paywall = paywall,
        loadTimeout = 5.seconds,
        preloadProducts = true
    ).onSuccess { paywallView ->
        // use paywallView
    }.onError { error ->
        // handle the error
    }
} else {
    // use your custom logic
}
参数是否必填描述
paywall必填用于获取目标付费墙控制器的 AdaptyPaywall 对象。
loadTimeout可选此值限制该方法的超时时间。如果达到超时,将返回缓存数据或本地备用数据。请注意,在极少数情况下,此方法的超时时间可能略晚于 loadTimeout 中指定的时间,因为该操作在底层可能由多个不同请求组成。您可以使用 kotlin.time.Duration.Companion 中的扩展函数,如 5.seconds
preloadProducts可选设置为 true 以预加载产品从而提升性能。启用后,产品将提前加载,减少展示付费墙所需的时间。
productPurchaseParams可选AdaptyProductIdentifierAdaptyPurchaseParameters 的映射。使用此参数为付费墙中的各个产品配置特定的购买参数,例如个性化优惠或订阅更新参数。

如果您使用多种语言,请了解如何添加付费墙编辑工具本地化

加载完成后,展示付费墙

为默认目标受众获取付费墙以加快获取速度

通常情况下,付费墙的获取几乎是即时完成的,您无需担心加速此过程。但是,如果您拥有大量目标受众和付费墙,且用户的网络连接较弱,付费墙的获取时间可能比预期更长。在这种情况下,您可能希望展示默认付费墙以确保流畅的用户体验,而不是完全不展示付费墙。

为解决这一问题,您可以使用 getPaywallForDefaultAudience 方法,该方法为所有用户目标受众获取指定版位的付费墙。但请务必了解,推荐的方式是使用 getPaywall 方法获取付费墙,详见上方的获取付费墙信息部分。

为什么我们推荐使用 getPaywall

getPaywallForDefaultAudience 方法存在一些显著缺点:

  • 潜在的向后兼容性问题:如果您需要为不同的应用版本(当前版本和未来版本)展示不同的付费墙,可能会面临挑战。您要么必须设计支持当前(旧版)的付费墙,要么接受使用当前(旧版)的用户可能遇到付费墙无法渲染的问题。
  • 失去精准定向:所有用户都将看到为所有用户目标受众设计的相同付费墙,这意味着您将失去个性化定向能力(包括基于国家、营销归因或您自己的自定义属性的定向)。

如果您愿意接受这些缺点以换取更快的付费墙获取速度,请按如下方式使用 getPaywallForDefaultAudience 方法。否则,请坚持使用上方介绍的 getPaywall

import com.adapty.kmp.Adapty
import com.adapty.kmp.models.AdaptyPaywall
import com.adapty.kmp.models.AdaptyPaywallFetchPolicy

Adapty.getPaywallForDefaultAudience(
    placementId = "YOUR_PLACEMENT_ID",
    locale = "en",
    fetchPolicy = AdaptyPaywallFetchPolicy.Default,
).onSuccess { paywall ->
    // the requested paywall
}.onError { error ->
    // handle the error
}
参数是否必填描述
placementId必填版位的标识符。这是您在 Adapty 看板中创建版位时指定的值。
locale

可选

默认值:en

付费墙本地化的标识符。此参数应为由一个或多个子标签组成的语言代码,子标签之间以减号(-)分隔。第一个子标签表示语言,第二个子标签表示地区。

示例:en 表示英语,pt-br 表示巴西葡萄牙语。

有关区域代码及使用建议,请参阅本地化与区域代码

fetchPolicy默认值:AdaptyPaywallFetchPolicy.Default

默认情况下,SDK 会尝试从服务器加载数据,若失败则返回缓存数据。我们推荐此方式,因为它能确保用户始终获取最新数据。

但如果您认为用户的网络连接不稳定,可以考虑使用 AdaptyPaywallFetchPolicy.ReturnCacheDataElseLoad,在缓存存在时返回缓存数据。在这种情况下,用户可能无法获取最新数据,但无论网络状况如何都能获得更快的加载速度。缓存会定期更新,因此在会话期间使用它以避免网络请求是安全的。

请注意,缓存在重启应用后保持不变,仅在卸载重装应用或手动清理时才会清除。

自定义素材

要自定义付费墙中的图片和视频,请实现自定义素材。

主图和视频具有预定义的 ID:hero_imagehero_video。在自定义素材包中,您通过这些 ID 定位相应元素并自定义其行为。

对于其他图片和视频,您需要在 Adapty 看板中设置自定义 ID

例如,您可以:

  • 向部分用户展示不同的图片或视频。
  • 在远程主图加载时展示本地预览图。
  • 在播放视频前展示预览图。

要使用此功能,请将 Adapty SDK 更新至 3.7.0 或更高版本。

以下是通过映射提供自定义素材的示例:

Kotlin Multiplatform SDK 仅支持本地素材。对于远程内容,您应在使用自定义素材之前先将其下载并缓存到本地。

import com.adapty.kmp.AdaptyUI
import com.adapty.kmp.models.AdaptyCustomAsset
import kotlinx.coroutines.launch
// Import generated Res class for accessing resources
import myapp.composeapp.generated.resources.Res

viewModelScope.launch {
    // Get URIs for bundled resources using Res.getUri()
    val heroImagePath = Res.getUri("files/images/hero_image.png")
    val demoVideoPath = Res.getUri("files/videos/demo_video.mp4")

    // Or read image as byte data
    val imageByteData = Res.readBytes("files/images/avatar.png")

    // Create custom assets map
    val customAssets: Map<String, AdaptyCustomAsset> = mapOf(
        // Load image from app resources (bundled with the app)
        // Files should be placed in commonMain/composeResources/files/
        "hero_image" to AdaptyCustomAsset.localImageResource(
            path = heroImagePath
        ),

        // Or use image byte data
        "avatar" to AdaptyCustomAsset.localImageData(
            data = imageByteData
        ),

        // Load video from app resources
        "demo_video" to AdaptyCustomAsset.localVideoResource(
            path = demoVideoPath
        ),

        // Or use a video file from device storage
        "intro_video" to AdaptyCustomAsset.localVideoFile(
            path = "/path/to/local/video.mp4"
        ),

        // Apply custom brand colors
        "brand_primary" to AdaptyCustomAsset.color(
            colorHex = "#FF6B35"
        ),

        // Create gradient background
        "card_gradient" to AdaptyCustomAsset.linearGradient(
            colors = listOf("#1E3A8A", "#3B82F6", "#60A5FA"),
            stops = listOf(0.0f, 0.5f, 1.0f)
        )
    )

    // Use custom assets when creating paywall view
    AdaptyUI.createPaywallView(
        paywall = paywall,
        customAssets = customAssets
    ).onSuccess { paywallView ->
        // Present the paywall with custom assets
        paywallView.present()
    }.onError { error ->
        // Handle the error - paywall will fall back to default appearance
    }
}

如果某个素材未找到或加载失败,付费墙将回退至付费墙编辑工具中配置的默认外观。