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

Adapty 看板中使用新版付费墙编辑工具完成付费墙的视觉设计后,您可以在移动应用中展示它。第一步是获取与版位关联的付费墙及其视图配置,具体步骤如下。

新版付费墙编辑工具需要 Unity SDK 3.3.0 或更高版本。

请注意,本文介绍的是使用付费墙编辑工具自定义的付费墙。如果您是手动实现付费墙,请参阅在移动应用中为远程配置付费墙获取付费墙和产品

想了解 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 应用中使用自定义计时器,可以直接向 SetCustomTimers 方法传入一个包含计时器 ID 及其结束时间的字典。示例如下:

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 看板中设置的开发者自定义计时器的计时器 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 不可用的情况。整套系统旨在确保你始终能获取最新版本的付费墙,同时在网络条件较差的情况下也能保证可靠性。