在 Capacitor SDK 中获取远程配置付费墙的付费墙和产品

在展示远程配置和自定义付费墙之前，你需要先获取相关信息。请注意，本主题仅涉及远程配置和自定义付费墙。如需了解如何获取 Flow Builder 流程或 Paywall Builder 付费墙及其配置，请参阅获取 Flow Builder 流程和 Paywall Builder 付费墙及其配置。

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

在移动应用中获取流程和产品之前（点击展开）

在 Adapty 看板中创建产品。
在 Adapty 看板中创建流程或付费墙并将产品添加到其中。
在 Adapty 看板中创建版位并将流程或付费墙添加到版位中。
在您的移动应用中安装 Adapty SDK。

获取流程信息

在 Adapty 中，产品是 App Store 和 Google Play 产品的统一组合。这些跨平台产品被整合到流程和付费墙中，让你能够在移动应用的特定版位中展示它们。

要展示产品，你需要通过 getFlow 方法从某个版位获取 AdaptyFlow。

不要硬编码产品 ID。 你唯一需要硬编码的是版位 ID。流程是远程配置的，因此产品数量和可用优惠随时可能变化。你的应用必须动态处理这些变化——如果今天流程返回两个产品，明天返回三个，则无需修改代码即可全部展示。


try {
  const flow = await adapty.getFlow({ 
    placementId: 'YOUR_PLACEMENT_ID', 
    params: {
      fetchPolicy: 'reload_revalidating_cache_data', // Load from server, fallback to cache
      loadTimeoutMs: 5000 // 5 second timeout
    }
  });
  // the requested flow
} catch (error) {
  console.error('Failed to fetch flow:', error);
}

参数是否必填描述

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

params.fetchPolicy

可选

默认值：'reload_revalidating_cache_data'

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

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

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

Adapty SDK 通过两层机制存储流程和付费墙：上述会定期更新的缓存，以及备用付费墙。我们还使用 CDN 来加快流程和付费墙的加载速度，并在 CDN 不可用时启用独立的备用服务器。该系统旨在确保您始终能获取最新版本的流程，同时在网络条件受限时也能保证可靠性。

params.loadTimeoutMs

可选

默认值：5000 ms

该值限制此方法的超时时间（毫秒）。若超时，将返回缓存数据或本地备用数据。

请注意，在极少数情况下，此方法的实际超时时间可能略晚于 loadTimeoutMs 中指定的值，因为该操作在底层可能包含多个不同的请求。

在 v4 中，getFlow 不再接受 locale 参数。对于自定义付费墙，所有可用的语言设置都会通过流程的远程配置（flow.remoteConfigs）返回——请从中选取与用户设备或应用设置相匹配的语言。

不要在代码中硬编码产品 ID！由于流程是远程配置的，可用产品的数量以及特殊优惠（例如免费试用）都可能随时间变化。请确保你的代码能够处理这些情况。

例如，如果最初获取到 2 个产品，你的应用应显示这 2 个产品；但如果后来获取到 3 个产品，你的应用无需修改代码即可显示全部 3 个。唯一需要硬编码的是版位 ID。

返回参数：

参数	描述
Flow	一个 `AdaptyFlow` 对象，包含版位、标识符（`id`、`variationId`）、名称、付费墙变体列表（`paywalls`）以及 `remoteConfigs` 数组（每个已配置的语言环境对应一条记录）。如需获取该流程的产品，请调用 `getPaywallProducts({ flow })`。

获取产品

获取到流程后，你可以查询与其对应的产品数组：


try {
  const products = await adapty.getPaywallProducts({ flow });
  // the requested products list
} catch (error) {
  console.error('Failed to fetch products:', error);
}

响应参数：

参数	说明
Products	`AdaptyPaywallProduct` 对象列表，包含：产品标识符、产品名称、价格、货币、订阅时长及其他若干属性。

在实现自定义付费墙设计时，您可能需要访问 AdaptyPaywallProduct 对象中的这些属性。以下列出了最常用的属性，完整属性详情请参阅链接文档。

属性	描述
标题	要显示产品标题，请使用 `product.localizedTitle`。请注意，本地化基于用户所选的应用商店国家/地区，而非设备本身的语言环境。
价格	要显示本地化价格，请使用 `product.price?.localizedString`。该本地化基于设备的语言环境信息。你也可以通过 `product.price?.amount` 以数字形式获取价格，值以当地货币表示。要获取对应的货币符号，请使用 `product.price?.currencySymbol`。
订阅周期	要显示订阅周期（如周、月、年等），请使用 `product.subscription?.localizedSubscriptionPeriod`，该本地化基于设备的语言环境。要以编程方式获取订阅周期，请使用 `product.subscription?.subscriptionPeriod`，从中可访问 `unit` 属性获取周期单位（即 `'day'`、`'week'`、`'month'`、`'year'` 或 `'unknown'`）。`numberOfUnits` 值表示周期单位的数量。例如，对于季度订阅，`unit` 属性值为 `'month'`，`numberOfUnits` 值为 `3`。
新用户优惠	要显示表示订阅包含新用户优惠的标签或其他指示器，请查看 `product.subscription?.offer?.phases` 属性。这是一个列表，最多可包含两个折扣阶段：免费试用阶段和优惠价格阶段。每个阶段对象包含以下实用属性： • `paymentMode`：字符串类型，取值为 `'free_trial'`、`'pay_as_you_go'`、`'pay_up_front'` 和 `'unknown'`。免费试用类型为 `'free_trial'`。 • `price`：折扣价格（数字类型）。免费试用时该值为 `0`。 • `localizedNumberOfPeriods`：使用设备语言环境本地化的字符串，描述优惠时长。例如，三天试用优惠在此字段中显示为 `'3 days'`。 • `subscriptionPeriod`：你也可以通过此属性获取优惠周期的详细信息，其使用方式与上一节中描述的订阅周期相同。 • `localizedSubscriptionPeriod`：按用户语言环境格式化的折扣订阅周期。

使用默认目标受众流程加速流程获取

通常情况下，流程的获取几乎是即时完成的，无需为此担心。但如果你的版位和目标受众数量较多，且用户网络连接较弱，流程的获取时间可能会比预期长。在这种情况下，你可能希望展示一个默认流程，以确保良好的用户体验，而不是什么都不显示。为了解决这个问题，您可以使用 getFlowForDefaultAudience 方法，该方法会获取指定版位中 All Users 目标受众的流程。但需要特别注意的是，推荐的方式是通过 getFlow 方法来获取流程，详情请参阅上方的获取流程信息章节。

为什么我们推荐使用 getFlow

getFlowForDefaultAudience 方法存在以下几个明显的缺陷：

潜在的向后兼容性问题：如果你需要针对不同的应用版本（当前版本和未来版本）展示不同的流程，可能会遇到挑战。你要么必须设计同时兼容当前（旧版）版本的流程，要么接受使用当前（旧版）的用户可能遇到流程无法渲染的问题。
失去精准定向：所有用户都会看到针对 All Users 目标受众设计的同一流程，这意味着你将失去个性化定向能力（包括基于国家、营销归因或自定义属性的定向）。如果您愿意接受这些不足之处以换取更快的流程获取速度，请按如下方式使用 getFlowForDefaultAudience 方法。否则，请继续使用上文介绍的 getFlow。


try {
  const flow = await adapty.getFlowForDefaultAudience({ 
    placementId: 'YOUR_PLACEMENT_ID', 
    params: {
      fetchPolicy: 'reload_revalidating_cache_data' // Load from server, fallback to cache
    }
  });
  // the requested flow
} catch (error) {
  console.error('Failed to fetch default audience flow:', error);
}

参数是否必填描述

placementId 必填版位的标识符。这是你在 Adapty 看板中创建版位时指定的值。

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

params.fetchPolicy

可选

默认值：'reload_revalidating_cache_data'

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

但如果你认为用户的网络连接不稳定，可以考虑使用 'return_cache_data_else_load'，在缓存存在时直接返回缓存数据。这种情况下，用户获取的数据可能不是最新的，但加载速度更快，不受网络状况影响。缓存会定期更新，因此在会话期间使用缓存来减少网络请求是安全的。

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

在展示远程配置和自定义付费墙之前，你需要先获取相关信息。请注意，本节内容涉及远程配置和自定义付费墙。如需了解如何获取付费墙编辑工具定制的付费墙，请参阅获取付费墙编辑工具的付费墙及其配置。

在移动应用中获取付费墙和产品之前（点击展开）

在 Adapty 看板中创建产品。
在 Adapty 看板中创建付费墙并将产品添加到付费墙。
在 Adapty 看板中创建版位并将付费墙添加到版位。
在你的移动应用中安装 Adapty SDK。

获取付费墙信息

在 Adapty 中，产品是 App Store 和 Google Play 产品的组合。这些跨平台产品被集成到付费墙中，使您能够在特定的移动应用版位中展示它们。

要显示产品，您需要使用 getPaywall 方法从某个版位获取付费墙。


try {
  const paywall = await adapty.getPaywall({ 
    placementId: 'YOUR_PLACEMENT_ID', 
    locale: 'en',
    params: {
      fetchPolicy: 'reload_revalidating_cache_data', // Load from server, fallback to cache
      loadTimeoutMs: 5000 // 5 second timeout
    }
  });
  // the requested paywall
} catch (error) {
  console.error('Failed to fetch paywall:', error);
}

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

不要硬编码产品 ID。 您唯一应该硬编码的 ID 是版位 ID。付费墙是远程配置的，因此产品数量和可用优惠随时可能发生变化。您的应用必须动态处理这些变化——如果付费墙今天返回两个产品，明天返回三个，则应在不修改代码的情况下全部显示。

响应参数：

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

获取产品

获得付费墙后，您可以查询与其对应的产品数组：


try {
  const products = await adapty.getPaywallProducts({ paywall });
  // the requested products list
} catch (error) {
  console.error('Failed to fetch products:', error);
}

响应参数：

参数	描述
Products	`AdaptyPaywallProduct` 对象列表，包含：产品标识符、产品名称、价格、货币、订阅时长及其他若干属性。
在实现自定义付费墙设计时，你可能需要访问 `AdaptyPaywallProduct` 对象中的这些属性。以下列出了最常用的属性，完整属性列表请参阅链接文档。
属性	描述
-------------------------	----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
Title	要显示产品标题，请使用 `product.localizedTitle`。请注意，本地化基于用户所选的商店国家/地区，而非设备本身的语言区域设置。
Price	要显示本地化的价格，请使用 `product.price?.localizedString`。该本地化基于设备的语言区域信息。您也可以通过 `product.price?.amount` 以数字形式获取价格，该值以本地货币为单位。要获取对应的货币符号，请使用 `product.price?.currencySymbol`。
Subscription Period	要显示订阅周期（例如周、月、年等），请使用 `product.subscription?.localizedSubscriptionPeriod`。该本地化基于设备的语言区域设置。要以编程方式获取订阅周期，请使用 `product.subscription?.subscriptionPeriod`。通过该属性可访问 `unit` 属性以获取时间单位（即 `'day'`、`'week'`、`'month'`、`'year'` 或 `'unknown'`）。`numberOfUnits` 值表示周期单位的数量。例如，对于季度订阅，`unit` 属性值为 `'month'`，`numberOfUnits` 属性值为 `3`。
Introductory Offer	要显示订阅包含新用户优惠的标识或其他指示器，请查看 `product.subscription?.offer?.phases` 属性。这是一个最多包含两个折扣阶段的列表：免费试用阶段和优惠价格阶段。每个阶段对象包含以下实用属性： • `paymentMode`：字符串类型，可能的值为 `'free_trial'`、`'pay_as_you_go'`、`'pay_up_front'` 和 `'unknown'`。免费试用对应 `'free_trial'` 类型。 • `price`：以数字表示的折扣价格。免费试用时该值为 `0`。 • `localizedNumberOfPeriods`：使用设备语言区域本地化的字符串，描述优惠的持续时长。例如，三天试用优惠在此字段中显示为 `'3 days'`。 • `subscriptionPeriod`：您也可以通过此属性获取优惠周期的具体详情，其使用方式与上一节中订阅周期的描述相同。 • `localizedSubscriptionPeriod`：以用户语言区域格式化的折扣订阅周期。

使用默认目标受众付费墙加速付费墙获取

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

为此，您可以使用 getPaywallForDefaultAudience 方法，该方法为 All Users 目标受众获取指定版位的付费墙。但请务必了解，推荐的方式仍是使用 getPaywall 方法获取付费墙，详见上方的获取付费墙信息部分。

为什么我们推荐使用 getPaywall

getPaywallForDefaultAudience 方法存在一些显著缺点：

潜在的向后兼容性问题：如果您需要为不同版本的应用（当前版本和未来版本）显示不同的付费墙，可能会面临挑战。您要么必须设计支持当前（旧版）应用版本的付费墙，要么接受使用当前（旧版）应用版本的用户可能遇到付费墙无法渲染的问题。
定向能力丧失：所有用户都将看到为 All Users 目标受众设计的同一付费墙，这意味着您将失去个性化定向能力（包括基于国家/地区、营销归因或您自定义属性的定向）。

如果您愿意接受这些缺点以换取更快的付费墙获取速度，请按如下方式使用 getPaywallForDefaultAudience 方法。否则，请坚持使用上述 getPaywall 方法。


try {
  const paywall = await adapty.getPaywallForDefaultAudience({ 
    placementId: 'YOUR_PLACEMENT_ID', 
    locale: 'en',
    params: {
      fetchPolicy: 'reload_revalidating_cache_data' // Load from server, fallback to cache
    }
  });
  // the requested paywall
} catch (error) {
  console.error('Failed to fetch default audience paywall:', error);
}

参数是否必填说明

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

locale

可选

默认值：en

付费墙本地化的标识符。此参数应为由一个或多个子标签组成的语言代码，子标签之间用减号（-）分隔。第一个子标签表示语言，第二个子标签表示地区。

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

有关语言区域代码及我们建议使用方式的更多信息，请参阅本地化与语言区域代码。

params.fetchPolicy

可选

默认值：'reload_revalidating_cache_data'

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

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

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