GS2-Money Script トリガーリファレンス

拡張スクリプトを呼び出す イベントトリガー のリファレンス

トリガー

createWallet

ウォレット新規作成

同期実行スクリプト

スクリプト、ウォレット新規作成の順に同期実行されます。

Request
説明
namespaceNamespaceネームスペース
walletWalletウォレット
Result
必須デフォルト値の制限説明
permitbool
ウォレットの作成を許可するか
initialAmountint
0 ~ 2147483645ウォレットの初期残高 - 無償付与として加算されます
実装例
namespace = args.namespace
wallet = args.wallet

result = {
  permit=permit,
  initialAmount=initialAmount
}

非同期実行スクリプト

ウォレット新規作成の実行後にスクリプトが非同期実行されます。

Request
説明
namespaceNamespaceネームスペース
walletWalletウォレット
Result
必須デフォルト値の制限説明
実装例
namespace = args.namespace
wallet = args.wallet

result = {
}

deposit

ウォレット残高加算

同期実行スクリプト

スクリプト、ウォレット残高加算の順に同期実行されます。

Request
説明
namespaceNamespaceネームスペース
oldWalletWallet加算前のウォレット
newWalletWallet加算後のウォレット
pricefloat購入価格
depositCountint付与する課金通貨の数量
Result
必須デフォルト値の制限説明
permitbool
ウォレット残高加算を許可するか
実装例
namespace = args.namespace
oldWallet = args.oldWallet
newWallet = args.newWallet
price = args.price
depositCount = args.depositCount

result = {
  permit=permit
}

非同期実行スクリプト

ウォレット残高加算の実行後にスクリプトが非同期実行されます。

Request
説明
namespaceNamespaceネームスペース
oldWalletWallet加算前のウォレット
newWalletWallet加算後のウォレット
pricefloat購入価格
depositCountint付与する課金通貨の数量
Result
必須デフォルト値の制限説明
実装例
namespace = args.namespace
oldWallet = args.oldWallet
newWallet = args.newWallet
price = args.price
depositCount = args.depositCount

result = {
}

withdraw

ウォレット残高消費

同期実行スクリプト

スクリプト、ウォレット残高消費の順に同期実行されます。

Request
説明
namespaceNamespaceネームスペース
oldWalletWallet消費前のウォレット
newWalletWallet消費後のウォレット
withdrawCountint消費する課金通貨の数量
paidOnlybool有償課金通貨のみを対象とするか
Result
必須デフォルト値の制限説明
permitbool
ウォレット残高消費を許可するか
実装例
namespace = args.namespace
oldWallet = args.oldWallet
newWallet = args.newWallet
withdrawCount = args.withdrawCount
paidOnly = args.paidOnly

result = {
  permit=permit
}

非同期実行スクリプト

ウォレット残高消費の実行後にスクリプトが非同期実行されます。

Request
説明
namespaceNamespaceネームスペース
oldWalletWallet消費前のウォレット
newWalletWallet消費後のウォレット
withdrawCountint消費する課金通貨の数量
paidOnlybool有償課金通貨のみを対象とするか
Result
必須デフォルト値の制限説明
実装例
namespace = args.namespace
oldWallet = args.oldWallet
newWallet = args.newWallet
withdrawCount = args.withdrawCount
paidOnly = args.paidOnly

result = {
}