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

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

トリガー

acceptVersion

バージョン承認

同期実行スクリプト

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

Request
説明
namespaceNamespaceネームスペース
versionModelVersionModelバージョンモデル
acceptVersionAcceptVersion承認したバージョン
currentAcceptVersionAcceptVersion現在承認しているバージョン
Result
必須デフォルト値の制限説明
permitbool
バージョン承認を許可するか
実装例
-- 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
説明
namespaceNamespaceネームスペース
versionModelVersionModelバージョンモデル
acceptVersionAcceptVersion承認したバージョン
実装例
-- Request
local namespace = args.namespace
local versionModel = args.versionModel
local acceptVersion = args.acceptVersion

-- Asynchronous scripts typically do not affect the API response.
-- Use for logging, analytics, external notifications, etc.

result = {
}

checkVersion

バージョンチェック

同期実行スクリプト

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

Request
説明
namespaceNamespaceネームスペース
versionModelVersionModelバージョンモデル
currentVersionVersion現在のバージョン
userIdstringユーザーID
warningStatus通常のバージョンチェックの結果 警告になった場合
errorStatus通常のバージョンチェックの結果 エラーになった場合
Result
必須デフォルト値の制限説明
overrideWarningStatus上書きするバージョンチェックの結果 警告
overrideErrorStatus上書きするバージョンチェックの結果 エラー
実装例
-- 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
}