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

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

deposit

ウォレット残高加算実行前にGS2-Scriptを呼び出すイベントトリガー

Request

	型	説明
namespace	Namespace	ネームスペース
oldWallet	Wallet	加算前のウォレット
newWallet	Wallet	加算後のウォレット
transactions	DepositTransaction[]	発生したトランザクションリスト
count	int	残高の加算量

Result

	型	必須	デフォルト	値の制限	説明
permit	bool	✓			ウォレット残高加算を許可するか

実装例

namespace = args.namespace
oldWallet = args.oldWallet
newWallet = args.newWallet
transactions = args.transactions
count = args.count

result = {
  permit=permit
}

depositDone

ウォレット残高加算実行後にGS2-Scriptを呼び出すイベントトリガー

Request

	型	説明
namespace	Namespace	ネームスペース
oldWallet	Wallet	加算前のウォレット
newWallet	Wallet	加算後のウォレット
transactions	DepositTransaction[]	発生したトランザクションリスト
count	int	残高の加算量

Result

	型	必須	デフォルト	値の制限	説明

実装例

namespace = args.namespace
oldWallet = args.oldWallet
newWallet = args.newWallet
transactions = args.transactions
count = args.count

result = {
}

withdraw

ウォレット残高消費実行前にGS2-Scriptを呼び出すイベントトリガー

Request

	型	説明
namespace	Namespace	ネームスペース
oldWallet	Wallet	消費前のウォレット
newWallet	Wallet	消費後のウォレット
transactions	DepositTransaction[]	発生したトランザクションリスト
count	int	残高の消費量

Result

	型	必須	デフォルト	値の制限	説明
permit	bool	✓			ウォレット残高の消費を許可するか

実装例

namespace = args.namespace
oldWallet = args.oldWallet
newWallet = args.newWallet
transactions = args.transactions
count = args.count

result = {
  permit=permit
}

withdrawDone

ウォレット残高消費実行後にGS2-Scriptを呼び出すイベントトリガー

Request

	型	説明
namespace	Namespace	ネームスペース
oldWallet	Wallet	消費前のウォレット
newWallet	Wallet	消費後のウォレット
transactions	DepositTransaction[]	発生したトランザクションリスト
count	int	残高の消費量

Result

	型	必須	デフォルト	値の制限	説明

実装例

namespace = args.namespace
oldWallet = args.oldWallet
newWallet = args.newWallet
transactions = args.transactions
count = args.count

result = {
}

新規契約時実行時にGS2-Scriptを呼び出すイベントトリガー

Request

	型	説明
namespace	Namespace	ネームスペース
contentModel	StoreSubscriptionContentModel	期間課金ストアコンテンツモデル
transaction	SubscribeTransaction	期間課金状態
userId	string	ユーザーID
ttlAt	long	GS2-Schedule のトリガーに反映する有効期限

Result

	型	必須	デフォルト	値の制限	説明

実装例

namespace = args.namespace
contentModel = args.contentModel
transaction = args.transaction
userId = args.userId
ttlAt = args.ttlAt

result = {
}

renew

契約更新時実行時にGS2-Scriptを呼び出すイベントトリガー

Request

	型	説明
namespace	Namespace	ネームスペース
contentModel	StoreSubscriptionContentModel	期間課金ストアコンテンツモデル
transaction	SubscribeTransaction	期間課金状態
userId	string	ユーザーID
ttlAt	long	GS2-Schedule のトリガーに反映する有効期限

Result

	型	必須	デフォルト	値の制限	説明

実装例

namespace = args.namespace
contentModel = args.contentModel
transaction = args.transaction
userId = args.userId
ttlAt = args.ttlAt

result = {
}

unsubscribe

契約解除時実行時にGS2-Scriptを呼び出すイベントトリガー

Request

	型	説明
namespace	Namespace	ネームスペース
contentModel	StoreSubscriptionContentModel	期間課金ストアコンテンツモデル
transaction	SubscribeTransaction	期間課金状態
userId	string	ユーザーID

Result

	型	必須	デフォルト	値の制限	説明

実装例

namespace = args.namespace
contentModel = args.contentModel
transaction = args.transaction
userId = args.userId

result = {
}

takeOver

割り当てユーザー変更時実行前にGS2-Scriptを呼び出すイベントトリガー

Request

	型	説明
namespace	Namespace	ネームスペース
contentModel	StoreSubscriptionContentModel	期間課金ストアコンテンツモデル
transaction	SubscribeTransaction	期間課金状態
fromUserId	string	ユーザーID
toUserId	string	ユーザーID
elapsedHours	int	前回割り当てユーザー変更からの経過時間（時）

Result

	型	必須	デフォルト	値の制限	説明
permit	bool	✓			割り当てユーザー変更を許可するか

実装例

namespace = args.namespace
contentModel = args.contentModel
transaction = args.transaction
fromUserId = args.fromUserId
toUserId = args.toUserId
elapsedHours = args.elapsedHours

result = {
  permit=permit
}

takeOverDone

割り当てユーザー変更時実行後にGS2-Scriptを呼び出すイベントトリガー

Request

	型	説明
namespace	Namespace	ネームスペース
contentModel	StoreSubscriptionContentModel	期間課金ストアコンテンツモデル
transaction	SubscribeTransaction	期間課金状態
fromUserId	string	ユーザーID
toUserId	string	ユーザーID
elapsedHours	int	前回割り当てユーザー変更からの経過時間（時）

Result

	型	必須	デフォルト	値の制限	説明

実装例

namespace = args.namespace
contentModel = args.contentModel
transaction = args.transaction
fromUserId = args.fromUserId
toUserId = args.toUserId
elapsedHours = args.elapsedHours

result = {
}