获取 flow 与付费墙 - Capacitor

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

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

在开始于移动应用中展示流程和付费墙之前（点击展开）

1. 在 Adapty 看板中创建产品。
2. 在 Adapty 看板中创建流程/付费墙并将产品添加到其中。
3. 在 Adapty 看板中创建版位并将流程/付费墙添加到其中。
4. 在移动应用中安装 Adapty SDK。

获取流程/付费墙

如果你已经在 Flow Builder 或付费墙编辑工具中设计好了流程或付费墙，就不需要在移动端代码中手动处理渲染逻辑来将其展示给用户。这类流程或付费墙已经包含了展示内容和展示方式的完整配置。不过，你仍然需要通过版位获取其 ID 及视图配置，然后在移动应用中将其呈现出来。 尽早获取流程或付费墙并创建其视图——最好在展示前提前完成。createFlowView 方法会加载视图配置，并在后台开始下载和缓存图片。调用时机越早，下载所需的时间就越充裕。当你真正展示流程或付费墙时，其配置和图片可能已经缓存完毕，可以直接显示。

要获取流程或付费墙，请使用 getFlow 方法：

try {
  const flow = await adapty.getFlow({
    placementId: 'YOUR_PLACEMENT_ID',
  });
  // the requested flow/paywall
} catch (error) {
  // handle the error
}

参数：

参数	是否必填	描述
placementId	必填	目标版位的标识符。这是您在 Adapty 看板中创建版位时指定的值。
fetchPolicy	默认值：'reload_revalidating_cache_data'	通过可选的 params 对象传入。默认情况下，SDK 会尝试从服务器加载数据，若失败则返回缓存数据。我们推荐使用此方式，因为它能确保用户始终获取最新数据。 但如果您认为用户的网络环境不稳定，可以考虑使用 'return_cache_data_else_load'，在缓存存在时直接返回缓存数据。这样一来，用户获取的数据可能不是最新的，但无论网络状况如何，加载速度都会更快。缓存会定期更新，因此在会话期间使用缓存以减少网络请求是安全的。 请注意，缓存在应用重启后仍然保留，只有在重新安装应用或手动清除时才会被清空。 Adapty SDK 通过两层机制在本地存储付费墙：上述定期更新的缓存，以及备用付费墙。我们还使用 CDN 来加快付费墙的获取速度，并在 CDN 不可用时提供独立的备用服务器。该系统旨在确保您始终获取最新版本的付费墙，同时在网络条件较差的情况下也能保证可靠性。
loadTimeoutMs	默认值：5 秒	通过可选的 params 对象传入。该值限制此方法的超时时间。如果超时，将返回缓存数据或本地备用数据。 请注意，在极少数情况下，此方法的实际超时时间可能略晚于 loadTimeoutMs 中指定的值，因为该操作在底层可能包含多个不同的请求。
不要硬编码产品 ID。 你唯一需要硬编码的 ID 是版位 ID。流程和付费墙均在远程配置，因此产品数量和可用优惠随时可能发生变化。你的应用必须动态处理这些变化——如果付费墙今天返回两个产品，明天返回三个，应无需修改代码即可全部展示。

响应参数：

参数	描述
Flow	一个 AdaptyFlow 对象，包含流程的标识符（id、variationId）、名称、版位、付费墙变体（paywalls）以及远程配置（remoteConfigs）。

获取视图配置

如果版位是在 Flow Builder 或 Paywall Builder 中设计的，Adapty 会自动为您渲染 UI。使用 createFlowView 创建视图，然后展示流程或付费墙。如果版位是没有编辑工具 UI 的自定义付费墙，请改为将其作为远程配置付费墙处理。 在 Capacitor SDK 中，直接调用 createFlowView 即可——无需提前获取视图配置。

try {
  const view = await createFlowView(flow);
} catch (error) {
  // handle the error
}

参数：

参数	是否必填	描述
flow	必填	一个 AdaptyFlow 对象，用于获取所需流程/付费墙的控制器。
customTags	可选	定义自定义标签及其解析值的字典。自定义标签在内容中作为占位符使用，会动态替换为特定字符串，从而在流程/付费墙中实现个性化内容。详情请参阅付费墙编辑工具中的自定义标签主题。
prefetchProducts	可选	启用后可优化产品在屏幕上的显示时机。设为 true 时，AdaptyUI 将自动预加载所需产品。默认值：true。
android.enableSafeArea	可选	仅适用于 Android（在 iOS 上会被忽略）。嵌套在 android 键下。设为 true 时，流程视图会应用安全区域内边距。默认值：true。该默认值适用于大多数场景。

获取视图后，请展示流程/付费墙。

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

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

try {
  const flow = await adapty.getFlowForDefaultAudience({
    placementId: 'YOUR_PLACEMENT_ID',
  });
  // the requested flow/paywall
} catch (error) {
  // handle the error
}

参数	是否必填	描述
placementId	必填	版位的标识符。这是您在 Adapty 看板中创建版位时指定的值。
fetchPolicy	默认值：'reload_revalidating_cache_data'	通过可选的 params 对象传入。默认情况下，SDK 会尝试从服务器加载数据，若失败则返回缓存数据。我们推荐使用此方式，因为它能确保用户始终获取最新数据。 但如果您认为用户的网络环境不稳定，可以考虑使用 'return_cache_data_else_load'——若缓存数据存在则直接返回。这种情况下用户获取的数据可能不是最新的，但无论网络状况多差，加载速度都会更快。缓存会定期更新，因此在会话期间使用缓存来减少网络请求是安全可靠的。 请注意，缓存在应用重启后仍会保留，只有在卸载重装应用或手动清除时才会被清空。

自定义资源

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

主图和视频有预定义的 ID：hero_image 和 hero_video。在自定义资源包中，通过这些 ID 定位相应元素并自定义其行为。

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

例如，您可以：

• 为部分用户展示不同的图片或视频。
• 在远程主图加载时显示本地预览图。
• 在视频播放前先显示预览图。 以下是通过简单字典提供自定义资源的示例：

const customAssets: Record<string, AdaptyCustomAsset> = {
  'custom_image': { type: 'image', relativeAssetPath: 'custom_image.png' },
  'hero_video': {
    type: 'video',
    fileLocation: {
      ios: { fileName: 'custom_video.mp4' },
      android: { relativeAssetPath: 'videos/custom_video.mp4' }
    }
  }
};

const view = await createFlowView(flow, { customAssets });

在 Adapty 看板中使用付费墙编辑工具完成付费墙的视觉设计后，你可以在移动应用中展示它。整个流程的第一步是获取与版位关联的付费墙及其视图配置，具体如下所述。 请注意，本主题涉及使用付费墙编辑工具自定义的付费墙。如需了解如何获取远程配置付费墙，请参阅在移动应用中获取远程配置付费墙的付费墙和产品主题。

在移动应用中展示付费墙之前（点击展开）

1. 在 Adapty 看板中创建您的产品。
2. 在 Adapty 看板中创建付费墙并将产品添加到其中。
3. 在 Adapty 看板中创建版位并将付费墙添加到其中。
4. 在您的移动应用中安装 Adapty SDK。

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

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

使用 getPaywall 方法获取付费墙：

try {
  const paywall = await adapty.getPaywall({
    placementId: 'YOUR_PLACEMENT_ID',
    locale: 'en',
  });
  // the requested paywall
} catch (error) {
  // handle the error
}

参数：

参数	是否必填	描述
placementId	必填	目标版位的标识符。这是您在 Adapty 看板中创建版位时指定的值。
locale	可选 默认值：en	付费墙本地化的标识符。该参数应为由一个或两个子标签组成的语言代码，子标签之间以连字符（-）分隔。第一个子标签表示语言，第二个子标签表示地区。 示例：en 表示英语，pt-br 表示巴西葡萄牙语。 有关语言区域代码及使用建议，请参阅本地化与语言区域代码。
params	可选	获取付费墙的附加参数。
不要硬编码产品 ID。 唯一需要硬编码的是版位 ID。付费墙是远程配置的，因此产品数量和可用优惠随时可能变化。你的应用必须动态处理这些变化——如果今天某个付费墙返回两个产品，明天返回三个，则无需修改代码即可全部展示。

返回参数：

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

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

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

在 Capacitor SDK 中，直接调用 createPaywallView 方法，无需手动先获取视图配置。

if (paywall.hasViewConfiguration) {
  try {
    const view = await createPaywallView(paywall);
  } catch (error) {
    // handle the error
  }
} else {
  // use your custom logic
}

参数：

参数	是否必填	描述
paywall	必填	一个 AdaptyPaywall 对象，用于获取目标付费墙的控制器。
customTags	选填	定义自定义标签及其对应值的字典。自定义标签作为付费墙内容中的占位符，在运行时动态替换为指定字符串，从而实现付费墙的个性化内容展示。详情请参阅付费墙编辑工具中的自定义标签相关文档。
prefetchProducts	选填	启用后可优化产品在屏幕上的展示时机。设为 true 时，AdaptyUI 将自动预加载所需产品。默认值：false。

获取视图后，展示付费墙。

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

通常情况下，付费墙的获取速度非常快，无需额外优化。但如果你配置了大量目标受众和付费墙，且用户的网络状况较差，获取付费墙可能会花费较长时间。在这种情况下，你可能希望先展示一个默认付费墙，以确保用户体验流畅，而不是什么都不显示。 为解决此问题，你可以使用 getPaywallForDefaultAudience 方法，该方法会获取指定版位中 All Users 目标受众对应的付费墙。但请务必注意，推荐的做法是通过 getPaywall 方法获取付费墙，详见上文获取付费墙信息章节。

try {
  const paywall = await adapty.getPaywallForDefaultAudience({
    placementId: 'YOUR_PLACEMENT_ID',
    locale: 'en',
  });
  // the requested paywall
} catch (error) {
  // handle the error
}

参数	是否必填	说明
placementId	必填	版位的标识符。这是您在 Adapty 看板中创建版位时指定的值。
locale	可选 默认值：en	付费墙本地化的标识符。该参数应为由一个或多个子标签组成的语言代码，子标签之间用减号（-）分隔。第一个子标签表示语言，第二个子标签表示地区。 示例：en 表示英语，pt-br 表示巴西葡萄牙语。 有关语言区域代码及推荐使用方式的更多信息，请参阅本地化与语言区域代码。
params	可选	获取付费墙时的附加参数。

自定义资源

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

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

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

例如，你可以：

• 为部分用户展示不同的图片或视频。
• 在远程主图加载时显示本地预览图。
• 在播放视频前先展示预览图。 以下是通过简单字典提供自定义资源的示例：

const customAssets: Record<string, AdaptyCustomAsset> = {
  'custom_image': { type: 'image', relativeAssetPath: 'custom_image.png' },
  'hero_video': {
    type: 'video',
    fileLocation: {
      ios: { fileName: 'custom_video.mp4' },
      android: { relativeAssetPath: 'videos/custom_video.mp4' }
    }
  }
};

view = await createPaywallView(paywall, { customAssets });