‹ IAP Doc Home

IAP 集成指南

For the Javascript version of cocos2d-x v3.x - (all other versions)

新手 《iOS内购 - 账户信息填写》

  1. App Store Connect 帮助 - App 内购买项目配置流程
  2. https://www.jianshu.com/p/4f5f0b45b083
  3. http://xiaovv.me/2018/05/03/My-iOS-In-App-Purchase-Summarize/

集成

用如下命令来集成 SDKBOX IAP 插件,请确保您可以正常执行的 SDKBOX 安装器.

sdkbox import iap

~~从 China 服务器下载~~ 服务器已停止

如果你在中国, 并且下载插件的速度比较慢, 可以尝试使用位于中国的服务器来下载, 查询插件, 使用方法为在你的 sdkbox import 后加 --server china 及可, 比如:

sdkbox import xxx  --server china

xxx 为你的插件名字

重点注意事项

如果您升级到了 Xcode7, 则需要以下额外步骤来确保插件工作正常:

禁用应用程序安全传输策略

添加以下项到 plist:

<key>NSAppTransportSecurity</key>
<dict>
    <key>NSAllowsArbitraryLoads</key>
    <true/>
</dict>

添加后的文件内容看起来就像这样:

禁止 Bitcode 支持

您必须禁止 Bitcode 的支持,否则将会编译失败。

游戏全屏配置

如果您的游戏不同时支持横竖屏,则必须在 Xcode 中选中 Requires full screen,否则将不会通过 Apple 的审核。

canOpenURL 白名单

取决于您使用哪些插件。需要在 info.plistLSApplicationQueriesSchemes 下添加名单。

JSON 配置

SDKBOX 安装器会自动在您的工程中添加一个样例配置文件sdkbox_config.json.在您编译工程前,请修改里面的参数,用您自己的应用信息

现在给一个修改例子,您需要在iTunes Connect获取一个应用id,然后替换 <put the product id for ios here>,或者,在Google Play Console申请一个应用id,并替换<put your googleplay key here>

"ios" :
{
    "iap":{
        "items":{
            "remove_ads":{
                "id":"<put the product id for ios here>"
            }
        }
    }
},
"android":
{
    "iap":{
        "key":"<put your googleplay key here>",
        "items":{
            "coins":{ // 这是可消耗商品
                "id":"<put the product id for android here>"
            },
            "remove_ads":{
                "id":"<put the product id for android here>",
                "type":"non_consumable" // 这是不可消耗商品
            },
            "subscription_item":{
                "id":"<put the product id for android here>",
                "type":"subs" // 这是订阅商品
            }
        }
    }
}

注意: sdkbox_config.json 中的 Goolge IAP key 是从 Google Play Console 中取到的, Google Console->Developer Tools->Services & APIs, 请看如下截图:

SKPaymentTransactionStateDeferred 测试

SKPaymentTransactionStateDeferred 是 iOS IAP 订单的一个中间状态. 对于大部数开发者而言, 不用关心这个中间状态.

如果你需要测试 SKPaymentTransactionStateDeferred 的话,可以在 sdkbox_config.json 中添加 simulatesAskToBuyInSandbox 项, 如下:

"ios":
{
    "iap": {
        "simulatesAskToBuyInSandbox": true,
        "items": { ... }
    }
}

更多关于 SKPaymentTransactionStateDeferred

初始化时机

IAP 的初始化, 请注意以下几点:

  1. App 启动后, 尽量早地初始化 IAP .
  2. 请先 setListener , 再 init .
  3. 如果有多个插件, IAP 的 init 应首先调用.

使用

初始化 IAP

sdkbox.IAP.init();
#include "PluginIAPJS.hpp"
#include "PluginIAPJSHelper.h"
sc->addRegisterCallback(register_all_PluginIAPJS);
sc->addRegisterCallback(register_all_PluginIAPJS_helper);

获取最新的价格

在您的游戏开始时,最好先从商店中取最新的商品价格信息.

要获取最新的 IAP 数据,只需要简单地调用 sdkbox.IAP.refresh().

onProductRequestSuccess 购买成功会收到这个事件.

onProductRequestFailure 购买失败事件.

购买

购买调用 sdkbox.IAP.purchase(name)

注意: name 是在您的配置文件中 items 项的名字,不是您在 iTunes 或 GooglePlay Store中的产品id.

onSuccess 购买成功事件.

onFailure 购买失败事件.

onCanceled 用户取消购买会触发这个事件.

恢复购买

恢复购买调用 sdkbox.IAP.restore().

onRestored 恢复购买成功.

注意: onRestored 可能会触发多次

处理付费事件

您可以接收 IAP 事件, 不同事件对您的用户及 IAP 服务器做不同的处理.

sdkbox.IAP.setListener({
    onSuccess : function (product) {
        //Purchase success
    },
    onFailure : function (product, msg) {
        //Purchase failed
        //msg is the error message
    },
    onCanceled : function (product) {
        //Purchase was canceled by user
    },
    onRestored : function (product) {
        //Purchase restored
    },
    onProductRequestSuccess : function (products) {
        //Returns you the data for all the iap products
        //You can get each item using following method
        for (var i = 0; i < products.length; i++) {
            // loop
        }
    },
    onProductRequestFailure : function (msg) {
        //When product refresh request fails.
    }
});

Promotion IAP

启用 Promotion IAP

如果你想使用 iOS Promoting IAP 的话:

  1. 实现 IAPListener 中的 onShouldAddStorePayment.
  2. itunes connect 网页中做相关配置

现在在 onShouldAddStorePayment 中,我们默认返回 true. 所以每次用户在 store 中点击,都会弹出购买提示。 如果你的应用有存在需要取消购买或延迟购买的情况,你需要在这个回调中实现自己的逻辑来返回 true 或 false.

Promotion IAP 设置

你可以设置 promotion iap 商品在不同手机显示不同的商品,或以不同的顺序显示:

  1. sdkbox.IAP.updateStorePromotionOrder(["remove_ads"]);
  2. sdkbox.IAP.updateStorePromotionVisibility('remove_ads', true);
  3. sdkbox.IAP.fetchStorePromotionOrder();
  4. sdkbox.IAP.fetchStorePromotionVisibility('remove_ads');

更多详情见Promoting IAP 官方文档

API Reference

Methods

sdkbox.IAP.init(jsonconfig);

Initialize SDKBox IAP

sdkbox.IAP.setDebug(debug);

Enable/disable debug logging

sdkbox.IAP.purchase(name);

Make a purchase request

@Param name is the name of the item specified in sdkbox_config.json
sdkbox.IAP.refresh();

Refresh the IAP data(title, price, description)

sdkbox.IAP.restore();

Restore purchase

sdkbox.IAP.setListener(listener);

Set listener for IAP

sdkbox.IAP.removeListener();

Remove listener for IAP

sdkbox.IAP.enableUserSideVerification();
sdkbox.IAP.isAutoFinishTransaction();

get auto invoke finishTransaction flag

sdkbox.IAP.setAutoFinishTransaction(b);

set auto invoke finishTransaction flag

sdkbox.IAP.finishTransaction(productid);

to invoke ios finishTransaction api

sdkbox.IAP.fetchStorePromotionOrder();
sdkbox.IAP.updateStorePromotionOrder(productNames);
sdkbox.IAP.fetchStorePromotionVisibility(productName);
sdkbox.IAP.updateStorePromotionVisibility(productName, visibility);
sdkbox.IAP.getPurchaseHistory();

get all purchase history, include cancelled, expired

sdkbox.IAP.getInitializedErrMsg();

get initialized error message

sdkbox.IAP.requestUpdateTransaction();

request all unfinish transaction, and retrigger onSuccess, onFailed or onCancel event with corresponding transaction.

just valid on iOS

e.g. if there have two transaction (one is success, on is canceled) havn't been finish, after invoke requestUpdateTransaction, onSuccess will trigger with the success transaction, onCancelled will trigger with the cancelled transaction.

Note: for most developer, this api is needn't, onSuccess, onFailed or onCancel will auto trigger when transaction updated.

Listeners

onInitialized(success);

Called when IAP initialized

onSuccess(p);

Called when an IAP processed successfully

onFailure(p, msg);

Called when an IAP fails

onCanceled(p);

Called when user canceled the IAP

onRestored(p);

Called when server returns the IAP items user already purchased @note this callback will be called multiple times if there are multiple IAP

onProductRequestSuccess(products);

Called the product request is successful, usually developers use product request to update the latest info(title, price) from IAP

onProductRequestFailure(msg);

Called when the product request fails

onRestoreComplete(ok, msg);

Called when the restore completed

onShouldAddStorePayment(productName);
onFetchStorePromotionOrder(productNames, error);
onFetchStorePromotionVisibility(productName, visibility, error);
onUpdateStorePromotionOrder(error);
onUpdateStorePromotionVisibility(error);
onPurchaseHistory(purchases);
onConsumed(product, error);
onDeferred(product);

Called when IAP pay deferred

Note: Pay deferred status is a middle status, for most developer, needn't case this status this status will change to success or failed or cancel, its final status is pending external action.

Please DO NOT finishTransaction when status is deferred.

手动集成

如果 SDKBOX 安装器 安装插件失败了,那么需要手动集成插件.如果安装器安装插件成功了,那么不需要,也没必要,按文档再手动集成一次.

下面列出的的步骤一般很少用到.如果你按下面的步骤完成了集成,请在完成集成后,再按步骤检查一次.

iOS 平台手动集成

Drag and drop the following frameworks from the plugins/ios folder of the IAP bundle into your Xcode project, check Copy items if needed when adding frameworks: 拖拽下列 framework 从 IAP 插件包的 plugins/ios 目录到您的 Xcode 工程中,在添加 frameworks 的时候,请勾选 Copy items if needed

sdkbox.framework

PluginIAP.framework

上面的 frameworks 依赖于其他 frameworks。如果您没有添加它们,您也需要添加下列这些 frameworks:

Security.framework

StoreKit.framework

SystemConfiguration.framework

plugin/jsbindings 文件夹中所有的头文件和源文件都拷贝到你的工程的 Classes 文件夹中.

把刚刚拷贝的文件拖动到 Xcode 中或使用 File -> Add files to... 来添加.

Android 平台手动集成

拷贝文件

从插件安装包中的 plugin/android/libs 目录拷贝下列 jar 文件到您的工程的 proj.android/libs 目录。

PluginGooglePlay.jar

PluginIAP.jar

sdkbox.jar

plugin/android/jni 目录拷贝 pluginiap 以及 sdkbox 目录到您的工程的 proj.android/jni 目录。如果 sdkbox 目录在工程中已经存在,请覆盖它。

编辑 AndroidManifest.xml

在标签 application tag 上添加下列权限:

<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
<uses-permission android:name="com.android.vending.BILLING"/>

编辑 Android.mk

编辑 proj.android/jni/Android.mk

LOCAL_STATIC_LIBRARIES 添加额外的库:

LOCAL_STATIC_LIBRARIES += PluginIAP
LOCAL_STATIC_LIBRARIES += sdkbox

在所有 import-module 语句之前添加一条 call 语句:

$(call import-add-path,$(LOCAL_PATH))

在最后添加额外的 import-module 语句:

$(call import-module, ./sdkbox)
$(call import-module, ./pluginiap)

这意味着您的语句顺序看起来像是这样:

$(call import-add-path,$(LOCAL_PATH))
$(call import-module, ./sdkbox)
$(call import-module, ./pluginiap)

Note: 如果您使用的是 cocos2d-x 预编译库,那么保证这些语句在已有的 $(call import-module,./prebuilt-mk) 语句之上非常重要。

编辑 Application.mk (只限 Cocos2d-x v3.0 到 v3.2 版本)

编辑 proj.android/jni/Application.mk 保证 APP_STL 的定义正确。如果 Application.mk 包含了 APP_STL := c++_static 语句,那么这条语句应该被改为:

APP_STL := gnustl_static

plugin/jsbindings 文件夹中所有的头文件和源文件都拷贝到你的工程的 Classes 文件夹中.

把你刚刚拷贝的 .cpp 文件添加到 Android.mk 文件的的 LOCAL_SRC_FILES 项.比如

LOCAL_SRC_FILES := hellocpp/main.cpp \
                  ../../Classes/AppDelegate.cpp \
                  ../../Classes/HelloWorldScene.cpp \
                                    ../../Classes/NewSourceFile.cpp

修改 AppActivity.java

插件版本 >= 2.4.0.3

  1. 找到 AppActivity.java 文件
find . -name "AppActivity.java"
  1. extends Cocos2dxActivity 替换为 extends com.sdkbox.plugin.SDKBoxActivity

以下是 AppActivity.java 不同版本的引擎所在的目录:

cpp
  - proj.android/src/org/cocos2dx/cpp/AppActivity.java
  - proj.android-studio/app/src/org/cocos2dx/cpp/AppActivity.java
  - proj.android/app/src/org/cocos2dx/cpp/AppActivity.java ( from cocos2d-x 3.17)

lua
  - frameworks/runtime-src/proj.android/src/org/cocos2dx/lua/AppActivity.java
  - frameworks/runtime-src/proj.android-studio/app/src/org/cocos2dx/lua/AppActivity.java
  - frameworks/runtime-src/proj.android/app/src/org/cocos2dx/lua/AppActivity.java (from cocos2d-x 3.17)

js
  - frameworks/runtime-src/proj.android/src/org/cocos2dx/javascript/AppActivity.java
  - frameworks/runtime-src/proj.android/app/src/org/cocos2dx/javascript/AppActivity.java ( from cocos2d-x 3.17)

插件版本 < 2.4.0.3

Note: 当你使用 cocos2d-x 源代码时,不同的版本中 Cocos2dxActivity.java 文件的位置也不同。一个确定该文件位置的方法是查看 proj.android/project.properties 。比如:

android.library.reference.1=../../cocos2d-x/cocos/platform/android/java

在这个例子中, Cocos2dxActivity.java 文件应该在如下位置:

../../cocos2d-x/cocos/platform/android/java/src/org/cocos2dx/lib/Cocos2dxActivity.java
import android.content.Intent;
import com.sdkbox.plugin.SDKBox;
onLoadNativeLibraries();
SDKBox.init(this);
    @Override
    protected void onActivityResult(int requestCode, int resultCode, Intent data) {
          if(!SDKBox.onActivityResult(requestCode, resultCode, data)) {
            super.onActivityResult(requestCode, resultCode, data);
          }
    }
    @Override
    protected void onStart() {
          super.onStart();
          SDKBox.onStart();
    }
    @Override
    protected void onStop() {
          super.onStop();
          SDKBox.onStop();
    }
    @Override
    protected void onResume() {
          super.onResume();
          SDKBox.onResume();
    }
    @Override
    protected void onPause() {
          super.onPause();
          SDKBox.onPause();
    }
    @Override
    public void onBackPressed() {
          if(!SDKBox.onBackPressed()) {
            super.onBackPressed();
          }
    }