在 Android SDK 中获取用户引导
在 Adapty 看板中使用编辑工具设计好用户引导的视觉部分后,您可以在 Android 应用中展示它。该流程的第一步是获取与版位关联的用户引导及其视图配置,具体如下所述。
开始之前,请确保:
- 您已安装 Adapty Android SDK 3.8.0 或更高版本。
- 您已创建用户引导。
- 您已将用户引导添加到版位。
获取用户引导
当您使用我们的无代码编辑工具创建用户引导时,它会以容器的形式存储,其中包含应用需要获取和展示的配置。该容器管理整个体验——显示哪些内容、如何呈现,以及如何处理用户交互(如问卷回答或表单输入)。容器还会自动追踪分析事件,因此您无需单独实现视图追踪。
为获得最佳性能,请尽早获取用户引导配置,以便图片在展示给用户之前有足够的时间下载。
要获取用户引导,请使用 getOnboarding 方法:
Adapty.getOnboarding("YOUR_PLACEMENT_ID") { result ->
when (result) {
is AdaptyResult.Success -> {
val onboarding = result.value
// the requested onboarding
}
is AdaptyResult.Error -> {
val error = result.error
// handle the error
}
}
}
参数说明:
| 参数 | 是否必填 | 描述 |
|---|---|---|
| placementId | 必填 | 所需版位的标识符。这是您在 Adapty 看板中创建版位时指定的值。 |
| locale | 可选 默认值: | 用户引导本地化的标识符。该参数应为由连字符(-)分隔的一个或两个子标签组成的语言代码。第一个子标签表示语言,第二个子标签表示地区。 示例: 有关语言区域代码及推荐使用方式的更多信息,请参阅本地化与语言区域代码。 |
| fetchPolicy | 默认值:.reloadRevalidatingCacheData | 默认情况下,SDK 会尝试从服务器加载数据,若加载失败则返回缓存数据。我们推荐此选项,因为它能确保用户始终获得最新数据。 但如果您认为用户的网络连接不稳定,可以考虑使用 请注意,缓存在应用重启后仍会保留,只有在重新安装应用或手动清理时才会被清除。 Adapty SDK 在本地以两层方式存储用户引导:上述定期更新的缓存和备用用户引导。我们还使用 CDN 来更快地获取用户引导,并在 CDN 不可访问时使用独立的备用服务器。该系统旨在确保您始终获得最新版本的用户引导,同时在网络连接不佳的情况下也能保证可靠性。 |
| loadTimeout | 默认值:5 秒 | 此值限制该方法的超时时间。如果超时,将返回缓存数据或本地备用数据。 请注意,在极少数情况下,该方法的实际超时时间可能略晚于 对于 Android:您可以使用扩展函数创建 |
响应参数:
| 参数 | 描述 |
|---|---|
| Onboarding | 一个 AdaptyOnboarding 对象,包含:用户引导标识符和配置、远程配置以及其他若干属性。 |
使用默认目标受众用户引导加速获取
通常情况下,用户引导的获取几乎是即时的,因此您无需担心加速此过程。但如果您有大量目标受众和用户引导,且用户的网络连接较弱,则获取用户引导可能需要比预期更长的时间。在这种情况下,您可能希望展示默认用户引导,以确保流畅的用户体验,而不是不显示任何用户引导。
为解决此问题,您可以使用 getOnboardingForDefaultAudience 方法,该方法为所有用户目标受众获取指定版位的用户引导。但请务必理解,推荐的方式是通过 getOnboarding 方法获取用户引导,详见上方获取用户引导部分。
请考虑使用 getOnboarding 而非 getOnboardingForDefaultAudience,因为后者存在以下重要限制:
- 兼容性问题:在支持多个应用版本时可能产生问题,需要兼容向后设计,否则旧版本可能显示异常。
- 无个性化:仅显示”所有用户”目标受众的内容,无法基于国家、归因或自定义属性进行定向。
如果对您的使用场景而言,更快的获取速度优先于这些缺点,请按如下所示使用 getOnboardingForDefaultAudience。否则,请按上方所述使用 getOnboarding。
Adapty.getOnboardingForDefaultAudience("YOUR_PLACEMENT_ID") { result ->
when (result) {
is AdaptyResult.Success -> {
val onboarding = result.value
// Handle successful onboarding retrieval
}
is AdaptyResult.Error -> {
val error = result.error
// Handle error case
}
}
}
参数说明:
| 参数 | 是否必填 | 描述 |
|---|---|---|
| placementId | 必填 | 所需版位的标识符。这是您在 Adapty 看板中创建版位时指定的值。 |
| locale | 可选 默认值: | 用户引导本地化的标识符。该参数应为由连字符(-)分隔的一个或两个子标签组成的语言代码。第一个子标签表示语言,第二个子标签表示地区。 示例: 有关语言区域代码及推荐使用方式的更多信息,请参阅本地化与语言区域代码。 |
| fetchPolicy | 默认值:.reloadRevalidatingCacheData | 默认情况下,SDK 会尝试从服务器加载数据,若加载失败则返回缓存数据。我们推荐此选项,因为它能确保用户始终获得最新数据。 但如果您认为用户的网络连接不稳定,可以考虑使用 请注意,缓存在应用重启后仍会保留,只有在重新安装应用或手动清理时才会被清除。 Adapty SDK 在本地以两层方式存储用户引导:上述定期更新的缓存和备用用户引导。我们还使用 CDN 来更快地获取用户引导,并在 CDN 不可访问时使用独立的备用服务器。该系统旨在确保您始终获得最新版本的用户引导,同时在网络连接不佳的情况下也能保证可靠性。 |