获取流程与付费墙 - Android

getFlow 获取的内容
流程 在 Flow Builder 中构建——在设备上原生渲染,无需 WebView
Paywall Builder 付费墙 所有现有的 Paywall Builder 内容

设计好流程或付费墙编辑工具付费墙之后,你可以在移动应用中展示它。第一步是获取与版位关联的流程或付费墙及其视图配置,具体如下所述。

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

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

获取流程/付费墙

如果你已经使用流程编辑器或付费墙编辑工具设计了流程或付费墙,则无需在移动应用代码中手动处理渲染逻辑来向用户展示它。此类流程或付费墙已包含展示内容和展示方式的完整定义。不过,你仍需通过版位获取其 ID 及视图配置,然后在移动应用中进行呈现。 为了确保最佳性能,请尽早获取流程或付费墙及其视图配置,以便在向用户展示之前有足够的时间下载图片。

使用 getFlow 方法获取流程或付费墙:

参数:

参数是否必填描述
placementId必填目标版位的标识符。这是你在 Adapty 看板中创建版位时指定的值。
fetchPolicy默认值:.reloadRevalidatingCacheData

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

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

请注意,重启应用后缓存依然保留,只有在重新安装应用或手动清理时才会被清除。

Adapty SDK 通过两层机制在本地存储流程和付费墙:上述定期更新的缓存,以及备用付费墙。我们还使用 CDN 加速获取,并配备了独立的备用服务器以应对 CDN 不可用的情况。整套系统旨在确保你始终获取最新版本,同时在网络条件较差的情况下也能保证可靠性。

loadTimeout默认值:5 秒

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

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

对于 Android:你可以使用扩展函数创建 TimeInterval(例如 5.seconds,其中 .seconds 来自 import com.adapty.utils.seconds),或者使用 TimeInterval.seconds(5)。如需不设限制,请使用 TimeInterval.INFINITE

参数描述
:--------:----------
Flow一个 AdaptyFlow 对象,包含版位信息、标识符(idvariationId)、名称、远程配置,以及 hasViewConfiguration 标志(用于指示该流程是否包含视图配置)。如需为预加载、自定义 UI 或程序化检查获取实际产品,请调用 getPaywallProducts(flow)

获取视图配置

获取流程或付费墙之后,通过 flow.hasViewConfiguration 检查其是否包含视图配置。该标志用于区分版位在 Adapty 看板中的设计方式:

  • true — 该版位是在 Flow Builder(流程)或 付费墙编辑工具(付费墙)中设计的,Adapty 会为您渲染 UI。请继续执行以下步骤,获取视图配置并展示流程或付费墙
  • false — 该版位是没有编辑工具 UI 的自定义付费墙。将其作为远程配置付费墙处理

请确保在 Flow Builder 中启用 Show on device 开关。如果未开启此选项,将无法获取视图配置。

如果您使用多种语言,请了解如何添加编辑工具本地化,以及如何正确使用语言区域代码,详见此处

加载完成后,展示流程或付费墙

获取默认目标受众的流程或付费墙以加速加载

通常情况下,流程和付费墙的获取几乎是即时完成的,无需担心速度问题。但如果你配置了大量目标受众和版位,且用户的网络连接较差,获取流程或付费墙可能会比预期耗时更长。在这种情况下,你可能希望优先展示默认流程或付费墙,以保障流畅的用户体验,而不是让用户看到空白页面。 为了解决这个问题,您可以使用 getFlowForDefaultAudience 方法,该方法会获取指定版位中针对 All Users 目标受众的流程或付费墙。但请务必了解,推荐的做法是通过 getFlow 方法来获取流程或付费墙,详情请参阅上方的获取流程/付费墙部分。

为什么我们推荐使用 getFlow

getFlowForDefaultAudience 方法存在以下几个明显的缺点:

  • 潜在的向后兼容性问题:如果需要为不同的应用版本(当前版本和未来版本)展示不同的流程,可能会面临挑战。你要么设计出兼容当前(旧版)版本的流程,要么接受使用当前(旧版)版本的用户可能遇到流程无法渲染的问题。
  • 失去精准定向:所有用户都将看到为 All Users 目标受众设计的同一流程,这意味着你将失去个性化定向能力(包括基于国家、营销归因或自定义属性的定向)。 如果您愿意接受这些缺点以换取更快的流程或付费墙获取速度,请按如下方式使用 getFlowForDefaultAudience 方法。否则请继续使用上文介绍的 getFlow
参数是否必填描述
placementId必填版位的标识符。这是你在 Adapty 看板中创建版位时指定的值。
fetchPolicy默认值:.reloadRevalidatingCacheData

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

不过,如果你认为用户的网络环境不稳定,可以考虑使用 .returnCacheDataElseLoad——当缓存存在时直接返回缓存数据。这种方式下用户获取的数据可能不是最新的,但无论网络状况多差,加载速度都会更快。缓存会定期更新,因此在会话期间使用缓存来减少网络请求是安全可靠的。

请注意,缓存在应用重启后仍会保留,仅在应用重新安装或手动清除时才会被清空。

自定义资源

要自定义流程或付费墙中的图片和视频,请实现自定义资源。

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

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

例如,您可以:

  • 向部分用户展示不同的图片或视频。
  • 在远程主图加载时,先显示本地预览图。
  • 在视频播放前显示预览图。 以下是通过简单字典提供自定义资源的示例:
val customAssets = AdaptyCustomAssets.of(
    "hero_image" to
            AdaptyCustomImageAsset.remote(
                url = "https://example.com/image.jpg",
                preview = AdaptyCustomImageAsset.file(
                    FileLocation.fromAsset("images/hero_image_preview.png"),
                )
            ),
    "hero_video" to
            AdaptyCustomVideoAsset.file(
                FileLocation.fromResId(requireContext(), R.raw.custom_video),
                preview = AdaptyCustomImageAsset.file(
                    FileLocation.fromResId(requireContext(), R.drawable.video_preview),
                ),
            ),
)

val flowView = AdaptyUI.getFlowView(
    activity,
    flowConfiguration,
    products,
    eventListener,
    insets,
    customAssets,
)

如果找不到资源,流程将回退到其默认外观。

对于视频,您可以选择传入 resolution,在视频加载前预留布局空间并设置宽高比(width / height):

AdaptyCustomVideoAsset.file(
    FileLocation.fromResId(requireContext(), R.raw.custom_video),
    preview = AdaptyCustomImageAsset.file(
        FileLocation.fromResId(requireContext(), R.drawable.video_preview),
    ),
    resolution = AdaptyCustomVideoAsset.Resolution(width = 1080, height = 1920),
)

Adapty 看板中使用新版付费墙编辑工具完成付费墙的视觉设计后,你可以在移动应用中展示它。第一步是获取与版位关联的付费墙及其视图配置,具体方法如下。

新版付费墙编辑工具需要 Android SDK 3.0 或更高版本。

请注意,本文档适用于通过付费墙编辑工具自定义的付费墙。如果您是手动实现付费墙,请参阅在移动应用中获取远程配置付费墙的付费墙与产品

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

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

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

如果你已经使用付费墙编辑工具设计了付费墙,则无需在移动端代码中手动渲染并展示给用户。这类付费墙已经包含了展示内容和展示方式的完整配置。不过,你仍需通过版位获取其 ID、视图配置,然后在移动应用中将其呈现出来。 为确保最佳性能,请尽早获取付费墙及其视图配置,以便在向用户展示之前有足够的时间下载图片。

使用 getPaywall 方法获取付费墙:

参数:

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

可选

默认值:en

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

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

有关语言区域代码及推荐使用方式的更多信息,请参阅本地化与语言区域代码

fetchPolicy默认值:.reloadRevalidatingCacheData

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

但如果你认为用户的网络环境不稳定,可以考虑使用 .returnCacheDataElseLoad,在缓存存在时优先返回缓存数据。这种情况下,用户获取的数据可能不是最新的,但无论网络状况如何,加载速度都会更快。缓存会定期更新,因此在会话期间使用缓存以减少网络请求是安全的。

请注意,缓存在应用重启后依然保留,只有在应用重新安装或手动清理时才会被清除。

Adapty SDK 通过两层机制在本地存储付费墙:上述定期更新的缓存,以及备用付费墙。我们还使用 CDN 加速付费墙的加载,并在 CDN 不可用时提供独立的备用服务器。该系统旨在确保你始终获取最新版本的付费墙,同时在网络条件较差的情况下也能保证可靠性。

loadTimeout默认值:5 秒

该值用于限制此方法的超时时间。超时后将返回缓存数据或本地备用数据。

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

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

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

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

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

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

如果您使用多种语言,请了解如何添加付费墙编辑工具本地化,以及如何正确使用语言区域代码,详见此处

加载完成后,展示付费墙

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

通常情况下,付费墙的获取几乎是即时完成的,无需担心速度问题。但如果你配置了大量目标受众和付费墙,且用户的网络状况较差,获取付费墙的时间可能会超出预期。在这种情况下,你可能希望先展示一个默认付费墙,以保证流畅的用户体验,而不是让用户看到空白。 为解决此问题,您可以使用 getPaywallForDefaultAudience 方法,该方法会获取指定版位中所有用户目标受众的付费墙。但请务必注意,推荐的做法是通过 getPaywall 方法获取付费墙,详见上方获取付费墙信息章节。

为什么我们推荐使用 getPaywall

getPaywallForDefaultAudience 方法存在以下几个明显缺陷:

  • 潜在的向后兼容问题:如果需要为不同的应用版本(当前版本和未来版本)展示不同的付费墙,可能会遇到挑战。你要么将付费墙设计为兼容当前(旧版)版本,要么接受使用当前(旧版)版本的用户可能遇到付费墙无法渲染的问题。
  • 失去精准定向:所有用户都将看到为 All Users 目标受众设计的同一付费墙,这意味着你将失去个性化定向能力(包括基于国家、营销归因或自定义属性的定向)。 如果你愿意接受这些不足之处以换取更快的付费墙加载速度,可以按如下方式使用 getPaywallForDefaultAudience 方法。否则,请继续使用上文介绍的 getPaywall

getPaywallForDefaultAudience 方法从 Android SDK 2.11.3 开始支持。

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

可选

默认值:en

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

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

有关语言区域代码及推荐使用方式的更多信息,请参阅本地化与语言区域代码

fetchPolicy默认值:.reloadRevalidatingCacheData

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

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

请注意,重启应用后缓存依然保留,只有在重新安装应用或手动清除时才会被清空。

自定义资源

要自定义付费墙中的图片和视频,需要实现自定义资源。

主图和视频有预定义的 ID:hero_imagehero_video。在自定义资源包中,你可以通过这些 ID 来定位对应元素并自定义其行为。

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

例如,你可以:

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

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

以下是如何通过简单字典提供自定义资源的示例:

val customAssets = AdaptyCustomAssets.of(
    "hero_image" to
            AdaptyCustomImageAsset.remote(
                url = "https://example.com/image.jpg",
                preview = AdaptyCustomImageAsset.file(
                    FileLocation.fromAsset("images/hero_image_preview.png"),
                )
            ),
    "hero_video" to
            AdaptyCustomVideoAsset.file(
                FileLocation.fromResId(requireContext(), R.raw.custom_video),
                preview = AdaptyCustomImageAsset.file(
                    FileLocation.fromResId(requireContext(), R.drawable.video_preview),
                ),
            ),
)

val paywallView = AdaptyUI.getPaywallView(
    activity,
    viewConfiguration,
    products,
    eventListener,
    insets,
    customAssets,
)

如果找不到某个资源,付费墙将回退到其默认外观。