在 Unity SDK 中获取付费墙编辑工具付费墙及其配置

在 Adapty 看板中使用新版付费墙编辑工具为您的付费墙设计视觉部分后,您可以在移动应用中显示它。此过程的第一步是获取与版位关联的付费墙及其视图配置,如下所述。

新版付费墙编辑工具需要 Unity SDK 3.3.0 或更高版本。如需在 Adapty SDK v2 中展示使用旧版付费墙编辑工具设计的付费墙,请参阅展示使用旧版付费墙编辑工具设计的付费墙

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

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

在您的移动应用中开始展示付费墙之前(点击展开)
  1. 在 Adapty 看板中创建您的产品
  2. 在 Adapty 看板中创建付费墙并将产品添加到其中
  3. 在 Adapty 看板中创建版位并将付费墙添加到其中
  4. 在您的移动应用中安装 Adapty SDK

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

如果您使用付费墙编辑工具设计了付费墙,则无需在移动应用代码中手动渲染即可向用户展示。此类付费墙同时包含展示内容和展示方式。尽管如此,您仍需通过版位获取其 ID、视图配置,然后在移动应用中展示它。

为确保最佳性能,请务必尽早获取付费墙及其视图配置,以便在向用户展示之前有足够的时间下载图片。

使用 GetPaywall 方法获取付费墙:

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 中指定的时间稍晚超时,因为该操作在底层可能由不同的请求组成。

响应参数:

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

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

请确保在付费墙编辑工具中启用 Show on device 开关。如果未开启此选项,将无法获取视图配置。

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

在 Unity SDK 中,无需手动预先获取视图配置,直接调用 CreatePaywallView 方法即可。

CreatePaywallView 方法的结果只能使用一次。如果需要再次使用,请重新调用 CreatePaywallView 方法。在不重新创建的情况下调用两次可能会导致 AdaptyUIError.viewAlreadyPresented 错误。

var parameters = new AdaptyUICreatePaywallViewParameters()
  .SetPreloadProducts(preloadProducts)
  .SetLoadTimeout(new TimeSpan(0, 0, 3));

AdaptyUI.CreatePaywallView(paywall, parameters, (view, error) => {
  // handle the result
});

参数:

参数是否必填描述
paywall必填一个 AdaptyPaywall 对象,用于获取所需付费墙的控制器。
loadTimeout默认值:5 秒此值限制该方法的超时时间。如果达到超时,将返回缓存数据或本地备用数据。请注意,在极少数情况下,此方法可能比 loadTimeout 中指定的时间稍晚超时,因为该操作在底层可能由不同的请求组成。
PreloadProducts可选提供 AdaptyPaywallProducts 数组以优化产品在屏幕上的显示时机。如果传入 nil,AdaptyUI 将自动获取所需产品。
CustomTags可选定义自定义标签及其解析值的字典。自定义标签作为付费墙内容中的占位符,动态替换为特定字符串,以实现付费墙中的个性化内容。详情请参阅付费墙编辑工具中的自定义标签主题。
CustomTimers可选定义自定义计时器及其结束日期的字典。自定义计时器允许您在付费墙中显示倒计时器。

如果您使用多种语言,请了解如何添加付费墙编辑工具本地化以及如何正确使用语言代码,详情请参阅此处

获取视图后,展示付费墙

自定义资源

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

主图和视频具有预定义的 ID:hero_imagehero_video。在自定义资源包中,您可以通过这些 ID 定位相应元素并自定义其行为。

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

例如,您可以:

  • 向部分用户显示不同的图片或视频。
  • 在远程主图加载时显示本地预览图。
  • 在播放视频前显示预览图。

要使用此功能,请将 Adapty Unity SDK 更新至 3.8.0 或更高版本。

以下是通过简单字典提供自定义资源的示例:

var customAssets = new Dictionary<string, AdaptyCustomAsset>
{
    { "custom_image", AdaptyCustomAsset.LocalImageFile("custom_assets/images/custom_image.png") },
    { "hero_video", AdaptyCustomAsset.LocalVideoFile("custom_assets/videos/custom_video.mp4") }
};

var parameters = new AdaptyUICreatePaywallViewParameters()
    .SetCustomAssets(customAssets)
    .SetLoadTimeout(new TimeSpan(0, 0, 3));

AdaptyUI.CreatePaywallView(paywall, parameters, (view, error) => {
    // handle the result
});

如果未找到某个资源,付费墙将回退至其默认外观。

设置开发者自定义计时器

要在 Unity 应用中使用自定义计时器,您可以将计时器 ID 及其结束日期的字典直接传递给 SetCustomTimers 方法。以下是一个示例:

var customTimers = new Dictionary<string, DateTime> {
    { "CUSTOM_TIMER_6H", DateTime.Now.AddHours(6) },
    { "CUSTOM_TIMER_NY", new DateTime(2025, 1, 1) }
};

var parameters = new AdaptyUICreatePaywallViewParameters()
    .SetCustomTimers(customTimers)
    .SetLoadTimeout(new TimeSpan(0, 0, 3));

AdaptyUI.CreatePaywallView(paywall, parameters, (view, error) => {
    // handle the result
});

在此示例中,CUSTOM_TIMER_NYCUSTOM_TIMER_6H 是您在 Adapty 看板中设置的开发者自定义计时器的 Timer ID。计时器解析器确保您的应用以正确的值动态更新每个计时器。例如:

  • CUSTOM_TIMER_NY:距计时器结束时间(如元旦)的剩余时间。
  • CUSTOM_TIMER_6H:用户打开付费墙后开始的 6 小时倒计时的剩余时间。

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

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

为解决此问题,您可以使用 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 不可达时使用独立的备用服务器。该系统旨在确保您始终获得最新版本的付费墙,同时在网络连接稀缺的情况下也能保证可靠性。