获取用户引导及其配置

在 Adapty 控制台中使用编辑工具设计好用户引导的视觉部分后，您可以在移动应用中展示它。此过程的第一步是获取与版位关联的用户引导及其视图配置，具体如下所述。

开始之前，请确保：

您已安装 Adapty iOS、Android、React Native 或 Flutter SDK 3.8.0 或更高版本。
您已创建用户引导。
您已将用户引导添加到版位。

获取用户引导

当您使用我们的无代码编辑工具创建用户引导时，它会以容器的形式存储，其中包含应用需要获取并展示的配置。该容器管理整个体验——显示哪些内容、如何呈现，以及如何处理用户交互（如测验答案或表单输入）。容器还会自动追踪分析事件，因此您无需单独实现视图追踪。

为获得最佳性能，请尽早获取用户引导配置，以便在向用户展示之前有足够的时间下载图片。

要获取用户引导，请使用 getOnboarding 方法：

do {
    let onboarding = try await Adapty.getOnboarding(placementId: "YOUR_PLACEMENT_ID")
    // the requested onboarding
} catch {
    // handle the error
}

参数：

参数	是否必填	描述
placementId	必填	所需版位的标识符。这是您在 Adapty 控制台创建版位时指定的值。
locale	可选默认值：`en`	用户引导本地化的标识符。该参数应为由连字符（-）分隔的一个或两个子标签组成的语言代码。第一个子标签表示语言，第二个表示地区。示例：`en` 表示英语，`pt-br` 表示巴西葡萄牙语。有关语言代码及其推荐用法的更多信息，请参阅本地化与语言代码。
fetchPolicy	默认值：`.reloadRevalidatingCacheData`	默认情况下，SDK 会尝试从服务器加载数据，如果失败则返回缓存数据。我们推荐此选项，因为它能确保用户始终获取最新数据。但是，如果您认为用户的网络不稳定，可以考虑使用 `.returnCacheDataElseLoad`，在缓存数据存在时直接返回缓存。在这种情况下，用户可能无法获取最新数据，但无论网络状况如何，都能体验到更快的加载速度。缓存会定期更新，因此在会话期间使用缓存以避免网络请求是安全的。请注意，缓存在应用重启后仍然存在，只有在重新安装应用或手动清理时才会被清除。 Adapty SDK 在本地以两层方式存储用户引导：上述定期更新的缓存以及备用用户引导。我们还使用 CDN 加速用户引导的获取，并在 CDN 不可用时提供独立的备用服务器。该系统旨在确保您始终获取最新版本的用户引导，同时在网络连接有限的情况下也能保证可靠性。
loadTimeout	默认值：5 秒	该值限制此方法的超时时间。如果达到超时，将返回缓存数据或本地备用数据。请注意，在极少数情况下，此方法的超时可能略晚于 `loadTimeout` 中指定的时间，因为该操作在底层可能由多个不同的请求组成。

响应参数：

参数	描述
Onboarding	一个 `AdaptyOnboarding` 对象，包含：用户引导标识符和配置、远程配置以及其他几个属性。

通过默认目标受众用户引导加快获取速度

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

为此，您可以使用 getOnboardingForDefaultAudience 方法，该方法为所有用户目标受众获取指定版位的用户引导。但请务必了解，推荐的方式仍然是使用 getOnboarding 方法获取用户引导，详情请参阅上方的获取用户引导部分。

建议使用 getOnboarding 而非 getOnboardingForDefaultAudience，因为后者有以下重要限制：

兼容性问题：在支持多个应用版本时可能产生问题，需要设计向后兼容的方案，否则旧版本可能显示异常。
无个性化：仅显示”所有用户”目标受众的内容，无法基于国家、归因或自定义属性进行定向。

如果对您的使用场景而言，更快的获取速度足以抵消上述缺点，请按以下方式使用 getOnboardingForDefaultAudience。否则，请按上文所述使用 getOnboarding。

Adapty.getOnboardingForDefaultAudience(placementId: "YOUR_PLACEMENT_ID") { result in
    switch result {
        case let .success(onboarding):
            // the requested onboarding
        case let .failure(error):
            // handle the error
    }
}

参数：

参数是否必填描述

placementId 必填所需版位的标识符。这是您在 Adapty 控制台创建版位时指定的值。

locale

可选

默认值：en

用户引导本地化的标识符。该参数应为由连字符（-）分隔的一个或两个子标签组成的语言代码。第一个子标签表示语言，第二个表示地区。

示例：en 表示英语，pt-br 表示巴西葡萄牙语。

有关语言代码及其推荐用法的更多信息，请参阅本地化与语言代码。

fetchPolicy

默认值：.reloadRevalidatingCacheData

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

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

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

Adapty SDK 在本地以两层方式存储用户引导：上述定期更新的缓存以及备用用户引导。我们还使用 CDN 加速用户引导的获取，并在 CDN 不可用时提供独立的备用服务器。该系统旨在确保您始终获取最新版本的用户引导，同时在网络连接有限的情况下也能保证可靠性。