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

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

想看看 Adapty SDK 在移动应用中的实际集成示例吗?欢迎查看我们的示例应用,其中演示了完整的集成流程,包括展示付费墙、完成购买以及其他基本功能。

在您开始获取应用中的流程和产品之前(点击展开)
  1. 在 Adapty 看板中创建您的产品

  2. 在 Adapty 看板中创建流程或付费墙并将产品加入其中

  3. 在 Adapty 看板中创建版位并将流程或付费墙加入版位

  4. 在移动应用中安装 Adapty SDK

获取流程信息

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

要展示产品,你需要通过 GetFlow 方法从某个版位获取 AdaptyFlow

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

Adapty.GetFlow(
    "YOUR_PLACEMENT_ID",
    AdaptyPlacementFetchPolicy.Default,
    TimeSpan.FromSeconds(5),
    (flow, error) => {
        if (error != null) {
            // handle the error
            return;
        }

        // flow - the requested flow
    }
);
参数是否必填描述
placementId必填版位的标识符。这是您在 Adapty 看板中创建版位时指定的值。
fetchPolicy默认值:AdaptyPlacementFetchPolicy.Default

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

但如果您认为用户的网络环境不稳定,可以考虑使用 AdaptyPlacementFetchPolicy.ReturnCacheDataElseLoad,当缓存数据存在时直接返回缓存。这种情况下用户获取的数据可能不是最新的,但无论网络状况如何,都能享受更快的加载速度。缓存会定期更新,因此在会话期间使用缓存以减少网络请求是安全的。

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

Adapty SDK 将流程和付费墙存储在两个层级中:上述定期更新的缓存,以及备用付费墙。我们还使用 CDN 加速流程和付费墙的加载,并设有独立的备用服务器以应对 CDN 不可访问的情况。该系统旨在确保您始终获取最新版本的流程和付费墙,同时在网络条件较差的情况下也能保证可靠性。

loadTimeout默认值:5 秒

该值限制此方法的超时时间。达到超时后,将返回缓存数据或本地备用数据。

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

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

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

返回参数:

参数描述
Flow一个 AdaptyFlow 对象,包含:流程标识符、付费墙变体(Paywalls — 每个变体都有其自己的产品标识符)、RemoteConfigs 列表(每个已配置的语言区域对应一条记录),以及其他若干属性。如需获取该流程的产品,请调用 GetPaywallProducts(flow)

在 v4 中,GetFlow 没有 locale 参数。当你使用 CreateFlowView 渲染流程时,本地化会自动解析。对于自定义付费墙,所有可用的语言环境会一起返回到 flow.RemoteConfigs 中——选择与用户设备或应用设置相匹配的语言环境。详情请参阅本地化与语言代码

获取产品

获取流程后,您可以查询与其对应的产品数组:

Adapty.GetPaywallProducts(flow, (products, error) => {
    if (error != null) {
        // handle the error
        return;
    }

    // products - the requested products array
});

响应参数:

参数描述
ProductsAdaptyPaywallProduct 对象列表,包含:产品标识符、产品名称、价格、货币、订阅时长及其他若干属性。

在实现自定义流程设计时,你可能需要访问 AdaptyPaywallProduct 对象中的这些属性。下面列出了最常用的属性。

属性描述
标题要显示产品标题,请使用 product.LocalizedTitle。请注意,本地化基于用户所选的商店国家/地区,而非设备本身的语言区域设置。
价格要显示本地化价格,请使用 product.Price.LocalizedString。该本地化基于设备的语言区域信息。您也可以通过 product.Price.Amount 以数字形式获取价格,值以本地货币表示。要获取对应的货币符号,请使用 product.Price.CurrencySymbol
订阅周期要显示周期(例如:周、月、年等),请使用 product.Subscription?.LocalizedPeriod,该本地化基于设备的语言区域设置。若要以编程方式获取订阅周期,请使用 product.Subscription?.Period,从中可访问 Unit 枚举以获取时长(即 AdaptySubscriptionPeriodUnit.DayAdaptySubscriptionPeriodUnit.WeekAdaptySubscriptionPeriodUnit.MonthAdaptySubscriptionPeriodUnit.YearAdaptySubscriptionPeriodUnit.Unknown)。NumberOfUnits 值表示周期单位的数量。例如,对于季度订阅,Unit 属性将显示 AdaptySubscriptionPeriodUnit.MonthNumberOfUnits 属性将显示 3
新用户优惠要显示徽标或其他指示器来表明订阅包含新用户优惠,请查看 product.Subscription?.Offer?.Phases 属性。这是一个最多可包含两个折扣阶段的列表:免费试用阶段和优惠价格阶段。每个阶段对象包含以下实用属性:
PaymentMode:枚举类型,取值为 AdaptyPaymentMode.FreeTrialAdaptyPaymentMode.PayAsYouGoAdaptyPaymentMode.PayUpFrontAdaptyPaymentMode.Unknown。免费试用类型为 AdaptyPaymentMode.FreeTrial
Price:一个 AdaptyPrice 对象,包含折扣价格——使用 Price.Amount 获取数字,使用 Price.LocalizedString 显示价格。对于免费试用,Price.Amount 的值为 0
LocalizedNumberOfPeriods:使用设备语言区域本地化的字符串,描述优惠的时长。例如,三天试用优惠将在此字段显示 "3 days"
SubscriptionPeriod:也可以通过此属性获取优惠周期的具体详情,其使用方式与前面章节中描述的订阅周期相同。
LocalizedSubscriptionPeriod:针对用户语言区域格式化后的折扣订阅周期。

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

通常情况下,流程的获取几乎是即时完成的,无需担心速度问题。但是,当你的版位和目标受众数量较多,且用户网络连接较弱时,流程获取可能会比预期更慢。在这种情况下,你可能希望展示一个默认流程,以确保良好的用户体验,而不是什么都不显示。

要解决这个问题,您可以使用 GetFlowForDefaultAudience 方法,该方法会获取指定版位中 All Users 目标受众的流程。但请务必了解,推荐的方式是通过 GetFlow 方法来获取流程,详见上方的获取流程信息章节。

为什么我们推荐使用 GetFlow

GetFlowForDefaultAudience 方法存在以下几个明显缺陷:

  • 潜在的向后兼容性问题:如果需要针对不同的应用版本(当前版本和未来版本)展示不同的流程,可能会遇到挑战。你要么必须设计兼容当前(旧版)版本的流程,要么接受使用当前(旧版)版本的用户可能遇到流程无法渲染的问题。
  • 失去精准定向:所有用户都将看到专为 All Users 目标受众设计的同一个流程,这意味着你将失去个性化定向能力(包括基于国家/地区、营销归因或自定义属性的定向)。

如果您愿意接受这些缺点以换取更快的流程获取速度,请按如下方式使用 GetFlowForDefaultAudience 方法。否则,请继续使用上文所述的 GetFlow

Adapty.GetFlowForDefaultAudience(
    "YOUR_PLACEMENT_ID",
    AdaptyPlacementFetchPolicy.Default,
    (flow, error) => {
        if (error != null) {
            // handle the error
            return;
        }

        // flow - the requested flow
    }
);
参数是否必填描述
placementId必填版位的标识符。这是您在 Adapty 看板中创建版位时指定的值。
fetchPolicy默认值:AdaptyPlacementFetchPolicy.Default

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

但如果您认为用户的网络环境不稳定,可以考虑使用 AdaptyPlacementFetchPolicy.ReturnCacheDataElseLoad,在缓存数据存在时优先返回缓存。这种情况下,用户获取的数据可能不是最新的,但无论网络状况多差,加载速度都会更快。缓存会定期更新,因此在会话期间使用缓存以减少网络请求是安全可靠的。

请注意,重启应用不会清除缓存,仅在卸载重装或手动清理时才会清空。

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

想看看 Adapty SDK 在移动应用中的实际集成示例吗?欢迎查看我们的示例应用,其中演示了完整的集成流程,包括展示付费墙、完成购买以及其他基本功能。

在您的移动应用中开始获取付费墙和产品之前(点击展开)
  1. 在 Adapty 看板中创建您的产品

  2. 在 Adapty 看板中创建付费墙并将产品添加到付费墙

  3. 在 Adapty 看板中创建版位并将付费墙添加到版位

  4. 在移动应用中安装 Adapty SDK

获取付费墙信息

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

要展示产品,您需要使用 getPaywall 方法从某个版位中获取付费墙

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

Adapty.GetPaywall("YOUR_PLACEMENT_ID", "en", (paywall, error) => {
  if(error != null) {
    // handle the error
    return;
  }
  
  // paywall - the resulting object
});
参数是否必需描述
placementId必需版位的标识符。这是您在 Adapty 看板中创建版位时指定的值。
locale

可选

默认值:en

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

示例:en 表示英语,pt-br 表示巴西葡萄牙语。

有关语言环境代码及推荐使用方式的更多信息,请参阅本地化与语言环境代码

fetchPolicy默认值:.reloadRevalidatingCacheData

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

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

请注意,缓存在应用重启后仍然有效,只有在应用卸载重装或手动清理时才会被清除。

Adapty SDK 将付费墙存储在两个层级中:上述定期更新的缓存和备用付费墙。我们还使用 CDN 加速付费墙的获取,并在 CDN 不可用时使用独立的备用服务器。该系统旨在确保您始终获得最新版本的付费墙,同时即使在网络连接稀缺的情况下也能保证可靠性。

loadTimeout默认值:5 秒

该值限制此方法的超时时间。若达到超时时间,将返回缓存数据或本地备用数据。

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

不要硬编码产品 ID!由于付费墙是远程配置的,可用产品、产品数量以及特殊优惠(如免费试用)可能随时发生变化。请确保您的代码能够处理这些情况。
例如,如果您最初获取到 2 个产品,您的应用应显示这 2 个产品。但如果您后来获取到 3 个产品,您的应用应显示所有 3 个产品,而无需修改任何代码。唯一需要硬编码的是版位 ID。

响应参数:

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

获取产品

获取付费墙后,您可以查询与之对应的产品数组:

Adapty.GetPaywallProducts(paywall, (products, error) => {
  if(error != null) {
    // handle the error
    return;
  }
  
  // products - the requested products array
});

响应参数:

参数描述
ProductsAdaptyPaywallProduct 对象列表,包含:产品标识符、产品名称、价格、货币、订阅时长及其他多个属性。

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

属性描述
Title要显示产品名称,请使用 product.LocalizedTitle。注意,本地化是基于用户在商店中选择的国家/地区,而非设备本身的语言区域。
Price要显示本地化价格,请使用 product.Price.LocalizedString。此本地化基于设备的语言区域信息。你也可以通过 product.Price.Amount 以数字形式获取价格,该值以本地货币为单位。要获取对应的货币符号,请使用 product.Price.CurrencySymbol
Subscription Period要显示订阅周期(如周、月、年等),请使用 product.Subscription?.LocalizedPeriod,该值基于设备的语言区域进行本地化。若需以编程方式获取订阅周期,请使用 product.Subscription?.Period。从中可访问 Unit 枚举以获取时长单位(即 AdaptySubscriptionPeriodUnit.DayAdaptySubscriptionPeriodUnit.WeekAdaptySubscriptionPeriodUnit.MonthAdaptySubscriptionPeriodUnit.YearAdaptySubscriptionPeriodUnit.Unknown)。NumberOfUnits 值表示周期单位的数量。例如,对于季度订阅,Unit 属性值为 AdaptySubscriptionPeriodUnit.MonthNumberOfUnits 属性值为 3
Introductory Offer要显示徽章或其他标识表明订阅包含新用户优惠,请查看 product.Subscription?.Offer?.Phases 属性。该属性是一个列表,最多可包含两个折扣阶段:免费试用阶段和优惠价格阶段。每个阶段对象包含以下实用属性:
PaymentMode:枚举类型,可选值为 AdaptyPaymentMode.FreeTrialAdaptyPaymentMode.PayAsYouGoAdaptyPaymentMode.PayUpFrontAdaptyPaymentMode.Unknown。免费试用对应 AdaptyPaymentMode.FreeTrial 类型。
PriceAdaptyPrice 对象,包含折扣价格——使用 Price.Amount 获取数值,使用 Price.LocalizedString 进行展示。对于免费试用,Price.Amount 的值为 0
LocalizedNumberOfPeriods:根据设备语言区域本地化的字符串,描述优惠时长。例如,三天试用优惠在此字段中显示为 "3 days"
SubscriptionPeriod:也可通过此属性获取优惠周期的具体详情,其使用方式与上一节中描述订阅周期的方式相同。
LocalizedSubscriptionPeriod:根据用户语言区域格式化的折扣订阅周期字符串。

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

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

要解决此问题,您可以使用 GetPaywallForDefaultAudience 方法,该方法会获取指定版位中 All Users 目标受众的付费墙。但请务必了解,推荐的方式是通过 getPaywall 方法获取付费墙,详见上方获取付费墙章节。

建议使用 GetPaywall 而非 GetPaywallForDefaultAudience,因为后者存在以下重要限制:

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

如果更快的获取速度对你的使用场景来说利大于弊,请按下方示例使用 GetPaywallForDefaultAudience。否则,请使用 GetPaywall,详见上文

Adapty.GetPaywallForDefaultAudience("YOUR_PLACEMENT_ID", "en", (paywall, error) => {
  if(error != null) {
    // handle the error
    return;
  }
  
  // paywall - the resulting object
});

参数:

参数是否必需描述
placementId必需所需版位的标识符。这是您在 Adapty 看板中创建版位时指定的值。
locale

可选

默认值:en

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

示例:en 表示英语,pt-br 表示巴西葡萄牙语。

fetchPolicy默认值:.reloadRevalidatingCacheData

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

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

请注意,缓存在应用重启后仍然有效,只有在应用卸载重装或手动清理时才会被清除。

Adapty SDK 在本地将付费墙存储在两个层级中:上述定期更新的缓存和备用付费墙。我们还使用 CDN 加速付费墙的获取,并在 CDN 不可用时使用独立的备用服务器。该系统旨在确保您始终获得最新版本的付费墙,同时即使在网络连接稀缺的情况下也能保证可靠性。