@amazon-devices/keplerscript-appstore-iap-lib
@amazon-devices/keplerscript-appstore-iap-lib
开放Beta测试文档 作为预发布开放Beta测试的一项内容,亚马逊提供了此技术文档。随着亚马逊收到反馈并对功能进行迭代,所描述的这些功能可能会发生变化。有关最新功能的信息,请参阅发布说明。
应用内购买 (IAP) API提供了与亚马逊应用商店购买框架进行交互的方法。
要实现IAP,必须执行以下操作:
开始使用
设置
-
将以下库依赖项添加到package.json文件的
dependencies部分。"@amazon-devices/keplerscript-appstore-iap-lib": "~2.13.0", -
在您的manifest.toml中,添加以下权限。
[wants] [[wants.service]] id = "com.amazon.iap.core.service" [[wants.module]] id = "/com.amazon.iap.core@IIAPCoreUI" [needs] [[needs.module]] id = "/com.amazon.kepler.appstore.iap.purchase.core@IAppstoreIAPPurchaseCoreService"
用法
购买服务
表示用于与亚马逊应用商店购买框架交互的主方法。
所有方法都使用Promise返回响应。
public purchase(purchaseRequestParams: IAPTypes.PurchaseParams): Promise<PurchaseResponse>;
有关更多信息,请参阅PurchasingService。
IAP API用法示例
以下示例展示如何使用IAP方法:
const triggerPurchase = (sku?: string): void => {
Logger.debug(`Item ${sku} clicked`);
PurchasingService.purchase({ sku: sku })
.then((res) => {
// 处理购买响应。
})
.then((user) => {
// 如果需要,为用户执行操作。
})
.catch((err) => {
// 处理异常(如果有)
});
return;
}
以下显示了getProductData方法的用法:
useEffect(() => { // 在呈现产品屏幕之前验证产品SKU
// ...
// 在呈现了组件时调用getProductData。
PurchasingService.getProductData({ skus: Constants.SKUS })
.then((res) => {
const [productData, unavailableSkus] = handleProductDataResponse(res);
})
.catch((err) => {
Logger.error(`调用getProductData时出现异常:${err}`);
});
}, []);
相关主题
API参考
类
- PurchasingService — 提供用于与亚马逊应用商店购买框架交互的主API。
接口
- CoinsReward — 包含亚马逊硬币相关数据,客户在购买关联产品后可能会获得亚马逊硬币奖励。
- ModifySubscriptionRequest — modifySubscription请求的输入参数。
- ModifySubscriptionResponse — 表示以下项的调用结果:
- NotifyFulfillmentRequest — 履行状态通知请求的输入参数。
- NotifyFulfillmentResponse — 表示以下项的调用结果:
- Price — 价格数据模型
- Product — 表示应用内产品,例如消费品、权利或订阅内容。检索
- ProductDataRequest — 产品数据获取请求的输入参数。
- ProductDataResponse — 表示以下项的调用结果:
- Promotion — 表示为以下项配置的促销:
- PromotionPlan — 表示促销计划,例如“尝鲜促销,每周3.00美元,持续3期”
- PurchaseRequest — 购买请求的输入参数。
- PurchaseResponse — 表示以下项的调用结果:
- PurchaseUpdatesRequest — 购买更新检索请求的输入参数。
- PurchaseUpdatesResponse — 表示以下项的调用结果:
- Receipt — 表示消费品、权利或订阅内容的购买以及续订
- RequestId — 表示任何应用内购买请求的ID。
- UserData — 表示用于应用内购买的客户的用户信息。
- UserDataRequest — 用户数据获取请求的输入参数。
- UserDataResponse — 表示以下项的调用结果:
- UserProfileAccessResponse — 表示以下项的调用结果:
枚举
- FulfillmentResult — 表示应用内购买的履行结果。
- LwaConsentStatus — 支持的LWA同意状态。
- ModifySubscriptionResponseCode — 表示以下项发起的modifySubscription请求所返回的响应代码:
- NotifyFulfillmentResponseCode — 表示通过以下项发起的履行通知请求所返回的响应代码:
- ProductDataResponseCode — 表示通过以下项发起的产品数据请求所返回的响应代码:
- ProductType — 表示产品的类型,可以是消费品、权利或订阅内容。
- ProrationMode — 订阅按比例分配模式。
- PurchaseResponseCode — 表示通过以下项发起的购买请求所返回的响应代码:
- PurchaseUpdatesResponseCode — 表示通过以下项发起的购买更新请求所返回的响应代码:
- UserDataResponseCode — 表示通过以下项发起的getUserData请求所返回的响应代码:
- UserProfileAccessConsentStatus — 支持的用户配置文件访问同意状态。
- UserProfileAccessResponseCode — 表示通过以下项发起的UserProfileAccess请求所返回的响应代码:
函数
- uselapProductData — useIapProductData挂钩通常在产品页面中调用,用于获取并显示IAP产品
- uselapPurchaseUpdates — 应在您的主屏幕组件中调用useIapPurchaseUpdates挂钩。此挂钩会自动调用
- uselapUserData — 应在您的主屏幕组件中调用useIapUserData挂钩。此挂钩会自动调用
Last updated: 2026年7月22日

