获取流程与付费墙 - Unity

GetFlow 获取的内容
流程 在 Flow Builder 中构建——在设备上原生渲染,无需 WebView
Paywall Builder 付费墙 所有现有的 Paywall Builder 内容

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

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

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

获取流程/付费墙

如果你已经使用流程编辑工具或付费墙编辑工具设计好了流程或付费墙,则无需在移动端代码中手动处理其渲染逻辑来向用户展示。这类流程或付费墙本身已包含展示内容和展示方式的完整配置。不过,你仍需通过版位获取其 ID 及视图配置,然后在移动应用中将其呈现出来。

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

使用 GetFlow 方法获取流程或付费墙:

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

        // flow - the requested flow/paywall
    }
);

参数:

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

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

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

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

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

loadTimeout默认值:5 秒

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

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

响应参数:

参数描述
Flow一个 AdaptyFlow 对象,包含版位、标识符(InstanceIdentityVariationId)、名称、付费墙变体(Paywalls — 由 AdaptyFlowPaywall 组成的列表)以及远程配置(RemoteConfigs — 每个语言区域对应一条记录的列表)。如需预加载产品、自定义 UI 或以编程方式检查产品,请调用 GetPaywallProducts(flow)

获取视图配置

获取流程或付费墙后,使用 CreateFlowView 方法一步完成视图配置的加载和视图的创建。无需单独检查任何标志:如果版位是在 Flow Builder(流程)或付费墙编辑工具(付费墙)中设计的,CreateFlowView 会返回可直接展示的视图。如果版位是没有编辑工具 UI 的自定义付费墙,CreateFlowView 将返回错误——将其作为远程配置付费墙处理

请确保在 Flow Builder 中开启 Show on device 开关。如果未开启此选项,将无法获取视图配置。

var parameters = new AdaptyUICreateFlowViewParameters()
    .SetPreloadProducts(true)
    .SetLoadTimeout(TimeSpan.FromSeconds(5));

AdaptyUI.CreateFlowView(flow, parameters, (view, error) => {
    if (error != null) {
        // the flow has no view configured, or view creation failed
        return;
    }

    // use view
});
参数是否必填描述
flow必填通过 Adapty.GetFlow 获取的 AdaptyFlow 对象。
Locale选填用于渲染流程或付费墙的编辑工具本地化标识符,例如 enpt-br。流程在创建视图时完成本地化,因此这是选择本地化语言的唯一时机。SDK 不会读取设备语言:若省略此参数,流程将以 en 渲染;若流程没有 en 本地化版本,则使用其默认语言。代码必须与流程的本地化代码完全匹配。详见使用本地化和语言代码
LoadTimeout选填限制该方法的超时时间。达到超时后,将返回缓存数据或本地备用数据。注意,在极少数情况下,由于该方法底层可能包含多个请求,实际超时时间可能略晚于 LoadTimeout 中指定的值。
PreloadProducts选填设为 true 可提前加载产品以提升性能。启用后,产品将预先加载,从而减少显示流程或付费墙所需的时间。
ProductPurchaseParameters选填仅限 Android(iOS 上忽略)。AdaptyProductIdentifierAdaptyPurchaseParameters 的字典。用于为流程或付费墙中的各个产品配置特定购买参数,例如个性化优惠或订阅更新参数。
EnableSafeAreaPaddings选填仅限 Android(iOS 上忽略)。设为 true 时,流程视图将应用安全区域内边距。默认值:true,适用于大多数场景。

如果您使用多种语言,请了解如何添加付费墙编辑工具本地化

加载完成后,展示流程或付费墙

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

通常,流程和付费墙的加载几乎是即时的,无需担心速度问题。但如果您的目标受众和版位数量较多,且用户网络状况较差,加载流程或付费墙的时间可能会比预期更长。在这种情况下,您可能希望显示一个默认流程或付费墙,以确保用户体验流畅,而不是什么都不显示。

为了解决这个问题,您可以使用 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,在缓存数据存在时直接返回缓存。这样用户获取的数据可能不是最新的,但加载速度会更快,不受网络波动影响。缓存会定期更新,因此在会话期间使用缓存来避免网络请求是安全的。

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

自定义资源

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

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

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

例如,你可以:

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

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

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 AdaptyUICreateFlowViewParameters()
    .SetCustomAssets(customAssets)
    .SetLoadTimeout(TimeSpan.FromSeconds(3));

AdaptyUI.CreateFlowView(flow, 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(2026, 1, 1) }
};

var parameters = new AdaptyUICreateFlowViewParameters()
    .SetCustomTimers(customTimers)
    .SetLoadTimeout(TimeSpan.FromSeconds(3));

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

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

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

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 不可用时提供独立的备用服务器。该系统旨在确保您始终获取最新版本的付费墙,同时在网络条件较差的情况下也能保证可靠性。