在 Capacitor SDK 中获取付费墙编辑工具的付费墙及其配置
在 Adapty 看板中使用新版付费墙编辑工具完成付费墙的视觉设计之后,你可以在移动应用中展示它。首先需要获取与版位关联的付费墙及其视图配置,具体步骤如下。
请注意,本文适用于通过付费墙编辑工具自定义的付费墙。如需了解如何获取远程配置付费墙,请参阅在移动应用中获取远程配置付费墙的付费墙与产品。
在移动应用中展示付费墙之前(点击展开)
- 在 Adapty 看板中创建产品。
- 在 Adapty 看板中创建付费墙并将产品添加到其中。
- 在 Adapty 看板中创建版位并将付费墙添加到其中。
- 在移动应用中安装 Adapty SDK。
获取使用付费墙编辑工具设计的付费墙
如果你已经使用付费墙编辑工具设计了付费墙,则无需在移动端代码中手动编写渲染逻辑来向用户展示它。这类付费墙已经包含了展示内容和展示方式的完整配置。不过,你仍需通过版位获取其 ID 和视图配置,然后在移动应用中将其呈现给用户。 为确保最佳性能,请尽早获取付费墙及其视图配置,以便在向用户展示之前有足够的时间完成图片下载。
使用 getPaywall 方法获取付费墙:
try {
const paywall = await adapty.getPaywall({
placementId: 'YOUR_PLACEMENT_ID',
locale: 'en',
});
// the requested paywall
} catch (error) {
// handle the error
}
参数:
| 参数 | 是否必填 | 描述 |
|---|---|---|
| placementId | 必填 | 目标版位的标识符。这是你在 Adapty 看板中创建版位时指定的值。 |
| locale | 可选 默认值: | 付费墙本地化的标识符。该参数应为语言代码,由一个或两个子标签组成,以连字符(-)分隔。第一个子标签表示语言,第二个子标签表示地区。 示例: 有关语言区域代码及推荐使用方式的更多信息,请参阅本地化与语言区域代码。 |
| params | 可选 | 获取付费墙时的附加参数。 |
| 不要硬编码产品 ID。 唯一需要硬编码的 ID 是版位 ID。付费墙在远程配置,因此产品数量和可用优惠随时可能变动。你的应用必须动态处理这些变化——如果今天付费墙返回两个产品,明天返回三个,应用应无需修改代码即可全部展示。 |
响应参数:
| 参数 | 描述 |
|---|---|
| Paywall | 一个 AdaptyPaywall 对象,包含产品 ID 列表、付费墙标识符、远程配置及其他若干属性。 |
获取使用付费墙编辑工具设计的付费墙视图配置
请确保在付费墙编辑工具中启用 Show on device 开关。如果未开启该选项,将无法获取视图配置。
获取付费墙后,检查它是否包含 ViewConfiguration,这表明该付费墙是使用付费墙编辑工具创建的。这将指导你如何展示付费墙。如果存在 ViewConfiguration,则将其视为付费墙编辑工具付费墙;否则,将其作为远程配置付费墙处理。
在 Capacitor SDK 中,无需手动获取视图配置,直接调用 createPaywallView 方法即可。
createPaywallView 方法的返回结果只能使用一次。如需再次使用,请重新调用 createPaywallView 方法。
if (paywall.hasViewConfiguration) {
try {
const view = await createPaywallView(paywall);
} catch (error) {
// handle the error
}
} else {
// use your custom logic
}
参数:
| 参数 | 是否必填 | 描述 |
|---|---|---|
| paywall | 必填 | 一个 AdaptyPaywall 对象,用于获取所需付费墙的控制器。 |
| customTags | 可选 | 定义自定义标签及其对应值的字典。自定义标签作为付费墙内容中的占位符,在运行时替换为指定字符串,实现付费墙内容的个性化展示。详情请参阅付费墙编辑工具中的”自定义标签”相关内容。 |
| prefetchProducts | 可选 | 开启后可优化产品在屏幕上的展示时机。设为 true 时,AdaptyUI 将自动预拉取所需产品数据。默认值:false。 |
如果你使用多种语言,请了解如何添加付费墙编辑工具本地化,以及如何正确使用语言区域代码(查看详情)。
获取视图后,请展示付费墙。
为默认目标受众获取付费墙以加快加载速度
通常情况下,付费墙的获取几乎是即时完成的,无需担心速度问题。但如果你配置了大量目标受众和付费墙,且用户的网络连接较差,获取付费墙的时间可能会超出预期。在这种情况下,你可能希望先展示一个默认付费墙,以确保流畅的用户体验,而不是让用户看到空白页面。
要解决此问题,您可以使用 getPaywallForDefaultAudience 方法,该方法会获取指定版位中所有用户目标受众的付费墙。但请务必了解,推荐的做法是使用 getPaywall 方法获取付费墙,详情请参阅上方的获取付费墙信息部分。
为什么我们推荐使用 getPaywall
getPaywallForDefaultAudience 方法存在以下几个明显缺点:
- 潜在的向后兼容性问题:如果你需要为不同的应用版本(当前版本和未来版本)展示不同的付费墙,你要么针对当前(旧版)版本设计付费墙,要么接受旧版用户可能遭遇付费墙无法渲染的问题。
- 精准定向能力的缺失:所有用户都将看到为 All Users 目标受众设计的同一个付费墙,这意味着你将失去个性化定向能力(包括基于国家、营销归因或自定义属性的定向)。
如果你愿意接受这些不足之处以换取更快的付费墙加载速度,请按如下方式使用
getPaywallForDefaultAudience方法。否则,请继续使用上文介绍的getPaywall方法。
try {
const paywall = await adapty.getPaywallForDefaultAudience({
placementId: 'YOUR_PLACEMENT_ID',
locale: 'en',
});
// the requested paywall
} catch (error) {
// handle the error
}
getPaywallForDefaultAudience 方法从 Capacitor SDK 2.11.2 版本开始支持。
| 参数 | 是否必填 | 描述 |
|---|---|---|
| placementId | 必填 | 版位的标识符。该值是你在 Adapty 看板中创建版位时指定的。 |
| locale | 可选 默认值: | 付费墙本地化的标识符。该参数应为一个语言代码,由一个或多个子标签组成,子标签之间用减号(-)分隔。第一个子标签表示语言,第二个子标签表示地区。 示例: 有关语言区域代码及推荐用法的更多信息,请参阅本地化与语言区域代码。 |
| params | 可选 | 获取付费墙时的附加参数。 |
自定义资源
要自定义付费墙中的图片和视频,请实现自定义资源。
主图和视频有预定义的 ID:hero_image 和 hero_video。在自定义资源包中,你通过这些 ID 来定位对应元素并自定义其行为。
对于其他图片和视频,你需要在 Adapty 看板中设置自定义 ID。
例如,你可以:
- 为部分用户展示不同的图片或视频。
- 在远程主图加载时,先显示本地预览图。
- 在播放视频前先显示预览图。
要使用此功能,请将 Adapty Capacitor SDK 升级到 3.8.0 或更高版本。
以下示例展示了如何通过简单字典提供自定义资源:
const customAssets: Record<string, AdaptyCustomAsset> = {
'custom_image': { type: 'image', relativeAssetPath: 'custom_image.png' },
'hero_video': {
type: 'video',
fileLocation: {
ios: { fileName: 'custom_video.mp4' },
android: { relativeAssetPath: 'videos/custom_video.mp4' }
}
}
};
view = await createPaywallView(paywall, { customAssets });
如果找不到某个素材,付费墙将回退到其默认外观。