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

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

トリガー

acceptVersion

バージョン承認

同期実行スクリプト

バージョン承認処理の前に、スクリプトが同期実行されます。

Request
説明
namespace Namespace ネームスペース
versionModel VersionModel バージョンモデル
acceptVersion AcceptVersion 承認したバージョン
currentAcceptVersion AcceptVersion 現在承認しているバージョン
Result
必須 デフォルト 値の制限 説明
permit bool
バージョン承認を許可するか
実装例
-- Request
local namespace = args.namespace
local versionModel = args.versionModel
local acceptVersion = args.acceptVersion
local currentAcceptVersion = args.currentAcceptVersion

-- Business logic:
local permit = true

-- Result
result = {
  permit=permit
}

非同期実行スクリプト

バージョン承認処理の後に、スクリプトが非同期実行されます。

Request
説明
namespace Namespace ネームスペース
versionModel VersionModel バージョンモデル
acceptVersion AcceptVersion 承認したバージョン
実装例
-- Request
local namespace = args.namespace
local versionModel = args.versionModel
local acceptVersion = args.acceptVersion

-- 非同期スクリプトは通常、API のレスポンスには影響を与えません。
-- ログ出力や分析、外部通知などに使用します。

result = {
}

checkVersion

バージョンチェック

同期実行スクリプト

バージョンチェック処理の前に、スクリプトが同期実行されます。

Request
説明
namespace Namespace ネームスペース
versionModel VersionModel バージョンモデル
currentVersion Version 現在のバージョン
userId string ユーザーID
warning Status 通常のバージョンチェックの結果 警告になった場合
error Status 通常のバージョンチェックの結果 エラーになった場合
Result
必須 デフォルト 値の制限 説明
overrideWarning Status 上書きするバージョンチェックの結果 警告
overrideError Status 上書きするバージョンチェックの結果 エラー
実装例
-- Request
local namespace = args.namespace
local versionModel = args.versionModel
local currentVersion = args.currentVersion
local userId = args.userId
local warning = args.warning
local error = args.error

-- Business logic:
local overrideWarning = nil
local overrideError = nil

-- Result
result = {
  overrideWarning=overrideWarning,
  overrideError=overrideError
}