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

在开始之前，请确保：

1. 您已创建了用户引导。
2. 您已将用户引导添加到版位中。

获取用户引导

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

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

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

import { adapty } from '@adapty/capacitor';

try {
  const onboarding = await adapty.getOnboarding({ 
    placementId: 'YOUR_PLACEMENT_ID', 
    locale: 'en',
    params: {
      fetchPolicy: 'reload_revalidating_cache_data', // Load from server, fallback to cache
      loadTimeoutMs: 5000 // 5 second timeout
    }
  });
  console.log('Onboarding fetched successfully');
} catch (error) {
  console.error('Failed to fetch onboarding:', error);
}

然后，调用 createOnboardingView 方法来创建视图实例。

import { adapty, createOnboardingView } from '@adapty/capacitor';

if (onboarding.hasViewConfiguration) {
  try {
    const view = await createOnboardingView(onboarding);
    console.log('Onboarding view created successfully');
  } catch (error) {
    console.error('Failed to create onboarding view:', error);
  }
} else {
  // Use your custom logic
  console.log('Onboarding does not have view configuration');
}

参数：

参数	是否必填	描述
placementId	必填	目标版位的标识符。这是您在 Adapty 看板中创建版位时指定的值。
locale	可选 默认值：en	用户引导本地化的标识符。该参数应为由一个或两个子标签组成的语言代码，子标签之间用减号（-）分隔。第一个子标签表示语言，第二个表示地区。 示例：en 表示英语，pt-br 表示巴西葡萄牙语。 有关语言代码及推荐用法的更多信息，请参阅本地化与语言代码。
params.fetchPolicy	可选 默认值：'reload_revalidating_cache_data'	默认情况下，SDK 会尝试从服务器加载数据，失败时返回缓存数据。我们推荐此选项，因为它可确保用户始终获取最新数据。 但如果您认为用户网络不稳定，可以考虑使用 'return_cache_data_else_load'，在缓存存在时优先返回缓存数据。这样用户获得的数据可能不是最新的，但无论网络状况如何，加载速度都会更快。缓存会定期更新，因此在会话期间使用缓存以避免网络请求是安全的。 请注意，缓存在应用重启后仍然保留，只有在重新安装应用或手动清除时才会被清空。
params.loadTimeoutMs	可选 默认值：5000 毫秒	该值限制此方法的超时时间（以毫秒为单位）。如果达到超时，将返回缓存数据或本地备用数据。 请注意，在极少数情况下，此方法的实际超时时间可能略长于 loadTimeoutMs 中指定的值，因为该操作在底层可能包含多个请求。

响应参数：

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

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

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

为解决此问题，您可以使用 getOnboardingForDefaultAudience 方法，该方法会获取指定版位中所有用户目标受众的用户引导。但请务必了解，推荐的做法是使用 getOnboarding 方法获取用户引导，详见上方获取用户引导章节。

import { adapty } from '@adapty/capacitor';

try {
  const onboarding = await adapty.getOnboardingForDefaultAudience({ 
    placementId: 'YOUR_PLACEMENT_ID', 
    locale: 'en',
    params: {
      fetchPolicy: 'reload_revalidating_cache_data' // Load from server, fallback to cache
    }
  });
  console.log('Default audience onboarding fetched successfully');
} catch (error) {
  console.error('Failed to fetch default audience onboarding:', error);
}

参数：

参数	是否必填	描述
placementId	必填	目标版位的标识符。这是您在 Adapty 看板中创建版位时指定的值。
locale	可选 默认值：en	用户引导本地化的标识符。该参数应为由一个或两个子标签组成的语言代码，子标签之间用减号（-）分隔。第一个子标签表示语言，第二个表示地区。 示例：en 表示英语，pt-br 表示巴西葡萄牙语。 有关语言代码及推荐用法的更多信息，请参阅本地化与语言代码。
params.fetchPolicy	可选 默认值：'reload_revalidating_cache_data'	默认情况下，SDK 会尝试从服务器加载数据，失败时返回缓存数据。我们推荐此选项，因为它可确保用户始终获取最新数据。 但如果您认为用户网络不稳定，可以考虑使用 'return_cache_data_else_load'，在缓存存在时优先返回缓存数据。这样用户获得的数据可能不是最新的，但无论网络状况如何，加载速度都会更快。缓存会定期更新，因此在会话期间使用缓存以避免网络请求是安全的。 请注意，缓存在应用重启后仍然保留，只有在重新安装应用或手动清除时才会被清空。