engine/design/task/STORE_Service – PlaygroundOSS

STORE_Service ¶

   <task pointer> = STORE_Service( "<store-callback>" )


   function <store-callback>(<task pointer>, <status>, <item-id>, <data>)

     -- <task pointer>  呼び出し元 STORE_Service タスクのポインタ
     -- <status>        コールバック理由
     -- <item-id>       対象商品の ID 文字列(不要な場合は長さ0の文字列になる)
     -- <data>          付加データ(現時点で、レシート情報以外には使用されていない)

   end

引数 ¶

<store-callback> AppStore からのステータスを受け取るコールバック関数名

戻り値 ¶

<task pointer> 生成された STORE_Service タスクのポインタ

解説 ¶

iOS/Android の課金サービスをサポートする。 iOS/Android の API を必要とするため、他環境の porting layer 上での動作は保証されない。

コールバックを登録した時点から中断された決済情報の回収が始まり、新規購入と同様にSTORE_PURCHASHEDのコールバックが中断された分だけlua側に返される。また、課金プラットフォームの挙動によっては購入処理で失敗結果が返された後に成功結果が投げ直されることもある。よって、スクリプト側では任意のタイミングでSTORE_PURCHASEDが呼ばれることを考慮して適宜レシートデータをキューイングするなどの実装を行う必要がある。

コマンド ¶

STORESERVICE_GET_PRODUCTS

商品のIDリスト(iOS: product id, Andrroid: sku id)を配列のjsonで指定し、プラットフォームに問い合わせて有効な商品リストを返却する。

STORESERVICE_GET_PRODUCTS

   pStore = STORE_Service(...)
   itemListJson = Conv_Lua2Json({"product.id.1", "product.id.2", ... }
   --  価格の文字列に通貨記号を自動で付加する場合はcurrency_modeをtrueにする。
   sysCommand(pStore, STORESERVICE_GET_PRODUCTS, itemListJson, <currency_mode>)

STORESERVICE_BUY_ITEMS

商品のIDを指定し、購入処理を開始する。以後のシーケンスはコールバックによって通知される。可変長パラメータとなっており、購入対象とするアイテムのIDを同時に複数指定することができる。

STORESERVICE_BUY_ITEMS

   pStore= STORE_Service(...)
   sysCommand(pStore, STORESERVICE_BUY_ITEMS, <item-id> [, <item-id> [, ... ]])

STORESERVICE_FINISH_TRANSACTION

決済情報のレシートデータ（iOS: Receipt, Android: PurchaseToken)をエンジンに渡し、購入処理が完了したことを通知する。これを行うまで決済は中断状態とみなされ、アプリを起動し直す度にSTORE_PURCHASHEDコールバックに同じレシートデータが渡され続ける。この処理を行うタイミングは、サーバーサイドが購入アイテム付与を正常に完了出来たと確証出来たタイミングに限られる。

STORESERVICE_FINISH_TRANSACTION

   sysCommand(pStore, STORESERVICE_FINISH_TRANSACTION,<receipt>)

コールバック解説 ¶

コールバックは、<status>にコールバック理由を添えて通知される。使用スクリプト側では、各コールバック理由に対応する処理が求められる。

STORE_GET_PRODUCTS/商品リスト取得

プラットフォームに商品リストを問い合わせた結果を返却する。

STORE_GET_PRODUCTS有効パラメータ

<data> 商品リストJSONデータ(Conv_Json2Luaでluaテーブルに要変換)

  {
    { 
      "id": <product id>, 
      "title": <商品タイトル>, 
      "description": <商品説明>, 
      "price": <値段の文字列>
    }, ...
}

STORE_FAILED/購入処理エラーもしくはキャンセル

購入処理がエラーもしくはキャンセルの扱いとなった通知。

STORE_FAILED 有効パラメータ
- <item-id> 購入処理がエラーまたはキャンセルとなったアイテムのID

STORE_PURCHASHING/購入処理中

現在購入処理中。

STORE_PURCHASHING 有効パラメータ
- <item-id> 購入処理中アイテムのID

STORE_PURCHASHED/購入処理成功

購入処理が終了し、処理は成功。レシートデータが通知されるので、適切に処理する必要がある。

STORE_PURCHASHED 有効パラメータ
- <item-id> 購入処理終了アイテムのID
- <data> 購入結果のレシートデータ文字列

STORE_RESTORE/リストア

既に購入済みのアイテムが再インストール後の購入などで再付与される。

STORE_RESTORE 有効パラメータ
- <item-id> リストア対象のアイテムID

STORE_RESTRE_COMPLETED/リストア終了

全てのリストア処理が完了した。

STORE_RESTORE_COMPLETED 有効パラメータ
- (なし)

STORE_RESTORE_FAILED/リストア失敗

リストア処理が失敗した。

STORE_RESTORE_FAILED 有効パラメータ
- (なし)