GS2-Account スクリプト トリガー リファレンス

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

トリガー

createAccount

アカウント新規作成

同期実行スクリプト

アカウント新規作成処理の前に、スクリプトが同期実行されます。

Request
型説明
namespaceNamespaceネームスペース
accountAccountゲームプレイヤーアカウント
Result
型必須デフォルト値の制限説明
permitbool
✓
アカウントの作成を許可するか
実装例
-- Request
local namespace = args.namespace
local account = args.account

-- Business logic:
local permit = true

-- Result
result = {
  permit=permit
}

非同期実行スクリプト

アカウント新規作成処理の後に、スクリプトが非同期実行されます。

Request
型説明
namespaceNamespaceネームスペース
accountAccountゲームプレイヤーアカウント
実装例
-- Request
local namespace = args.namespace
local account = args.account

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

result = {
}

authentication

アカウントの認証

同期実行スクリプト

アカウントの認証処理の前に、スクリプトが同期実行されます。

Request
型説明
namespaceNamespaceネームスペース
accountAccountゲームプレイヤーアカウント
elapsedHoursint前回ログインからの経過時間
Result
型必須デフォルト値の制限説明
permitbool
✓
アカウントの認証を許可するか
forceboolfalseパスワード認証に失敗しても認証を通すか
実装例
-- Request
local namespace = args.namespace
local account = args.account
local elapsedHours = args.elapsedHours

-- Business logic:
local permit = true
local force = false

-- Result
result = {
  permit=permit,
  force=force
}

非同期実行スクリプト

アカウントの認証処理の後に、スクリプトが非同期実行されます。

Request
型説明
namespaceNamespaceネームスペース
accountAccountゲームプレイヤーアカウント
elapsedHoursint前回ログインからの経過時間
実装例
-- Request
local namespace = args.namespace
local account = args.account
local elapsedHours = args.elapsedHours

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

result = {
}

ban

アカウントBANの登録

同期実行スクリプト

アカウントBANの登録処理の前に、スクリプトが同期実行されます。

Request
型説明
namespaceNamespaceネームスペース
accountAccountゲームプレイヤーアカウント
addBanStatusBanStatus追加するアカウントBANステータス
Result
型必須デフォルト値の制限説明
permitbool
✓
アカウントBANの登録を許可するか
実装例
-- Request
local namespace = args.namespace
local account = args.account
local addBanStatus = args.addBanStatus

-- Business logic:
local permit = true

-- Result
result = {
  permit=permit
}

非同期実行スクリプト

アカウントBANの登録処理の後に、スクリプトが非同期実行されます。

Request
型説明
namespaceNamespaceネームスペース
accountAccountゲームプレイヤーアカウント
addBanStatusBanStatus追加するアカウントBANステータス
実装例
-- Request
local namespace = args.namespace
local account = args.account
local addBanStatus = args.addBanStatus

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

result = {
}

unBan

アカウントBANの解除

同期実行スクリプト

アカウントBANの解除処理の前に、スクリプトが同期実行されます。

Request
型説明
namespaceNamespaceネームスペース
accountAccountゲームプレイヤーアカウント
Result
型必須デフォルト値の制限説明
permitbool
✓
アカウントBANの解除を許可するか
実装例
-- Request
local namespace = args.namespace
local account = args.account

-- Business logic:
local permit = true

-- Result
result = {
  permit=permit
}

非同期実行スクリプト

アカウントBANの解除処理の後に、スクリプトが非同期実行されます。

Request
型説明
namespaceNamespaceネームスペース
accountAccountゲームプレイヤーアカウント
実装例
-- Request
local namespace = args.namespace
local account = args.account

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

result = {
}

requestDeletion

アカウント削除の申請

同期実行スクリプト

アカウント削除の申請処理の前に、スクリプトが同期実行されます。

Request
型説明
namespaceNamespaceネームスペース
accountAccountゲームプレイヤーアカウント
scheduledAtlong削除予定日時
Result
型必須デフォルト値の制限説明
permitbool
✓
アカウント削除の申請を許可するか
実装例
-- Request
local namespace = args.namespace
local account = args.account
local scheduledAt = args.scheduledAt

-- Business logic:
local permit = true

-- Result
result = {
  permit=permit
}

非同期実行スクリプト

アカウント削除の申請処理の後に、スクリプトが非同期実行されます。

Request
型説明
namespaceNamespaceネームスペース
accountAccountゲームプレイヤーアカウント
scheduledAtlong削除予定日時
実装例
-- Request
local namespace = args.namespace
local account = args.account
local scheduledAt = args.scheduledAt

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

result = {
}

cancelDeletion

アカウント削除の申請の取り消し

同期実行スクリプト

アカウント削除の申請の取り消し処理の前に、スクリプトが同期実行されます。

Request
型説明
namespaceNamespaceネームスペース
accountAccountゲームプレイヤーアカウント
reasonenum [
“user”,
“login”,
“admin”
]
取り消しの理由
「ゲームプレイヤーによる取り消し(user)」は、ゲームプレイヤーによる取り消しです。
「猶予期間中のログインによる取り消し(login)」は、猶予期間中にログインしたときの動作が「削除を取り消してログインする(cancel)」のときに、削除予定の間に認証したことによる取り消しです。
「管理者による取り消し(admin)」は、ユーザーIDを指定した取り消しです。
Result
型必須デフォルト値の制限説明
permitbool
✓
アカウント削除の申請の取り消しを許可するか
実装例
-- Request
local namespace = args.namespace
local account = args.account
local reason = args.reason

-- Business logic:
local permit = true

-- Result
result = {
  permit=permit
}

非同期実行スクリプト

アカウント削除の申請の取り消し処理の後に、スクリプトが非同期実行されます。

Request
型説明
namespaceNamespaceネームスペース
accountAccountゲームプレイヤーアカウント
reasonenum [
“user”,
“login”,
“admin”
]
取り消しの理由
「ゲームプレイヤーによる取り消し(user)」は、ゲームプレイヤーによる取り消しです。
「猶予期間中のログインによる取り消し(login)」は、猶予期間中にログインしたときの動作が「削除を取り消してログインする(cancel)」のときに、削除予定の間に認証したことによる取り消しです。
「管理者による取り消し(admin)」は、ユーザーIDを指定した取り消しです。
実装例
-- Request
local namespace = args.namespace
local account = args.account
local reason = args.reason

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

result = {
}

executeDeletion

アカウントの削除

同期実行スクリプト

アカウントの削除処理の前に、スクリプトが同期実行されます。

Request
型説明
namespaceNamespaceネームスペース
accountAccountゲームプレイヤーアカウント
dataUserIdstringデータ保持用ユーザーID
削除するユーザーデータを保持しているユーザーIDです。
ネームスペースでログイン用ユーザーIDとデータ保持用ユーザーIDを分けている場合はデータオーナーのユーザーID、それ以外の場合はアカウントのユーザーIDと同じ値になります。
Result
型必須デフォルト値の制限説明
permitbool
✓
使用しません
アカウントの削除はスクリプトで止めることができないため、この値は無視されます。
スクリプトが失敗すると削除を後回しにして再試行するため、同じアカウントに対してスクリプトが複数回実行されることがあります。スクリプトは冪等にしてください。
削除が 13 回失敗すると、以降はスクリプトを実行せずに削除を進めます。
実装例
-- Request
local namespace = args.namespace
local account = args.account
local dataUserId = args.dataUserId

-- Business logic:
local permit = true

-- Result
result = {
  permit=permit
}

非同期実行スクリプト

アカウントの削除処理の後に、スクリプトが非同期実行されます。

Request
型説明
namespaceNamespaceネームスペース
accountAccountゲームプレイヤーアカウント
dataUserIdstringデータ保持用ユーザーID
削除するユーザーデータを保持しているユーザーIDです。
ネームスペースでログイン用ユーザーIDとデータ保持用ユーザーIDを分けている場合はデータオーナーのユーザーID、それ以外の場合はアカウントのユーザーIDと同じ値になります。
実装例
-- Request
local namespace = args.namespace
local account = args.account
local dataUserId = args.dataUserId

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

result = {
}

createTakeOver

引き継ぎ情報登録

同期実行スクリプト

引き継ぎ情報登録処理の前に、スクリプトが同期実行されます。

Request
型説明
namespaceNamespaceネームスペース
takeOverTakeOver引き継ぎ情報
accountAccountゲームプレイヤーアカウント
Result
型必須デフォルト値の制限説明
permitbool
✓
引き継ぎ情報登録を許可するか
実装例
-- Request
local namespace = args.namespace
local takeOver = args.takeOver
local account = args.account

-- Business logic:
local permit = true

-- Result
result = {
  permit=permit
}

非同期実行スクリプト

引き継ぎ情報登録処理の後に、スクリプトが非同期実行されます。

Request
型説明
namespaceNamespaceネームスペース
takeOverTakeOver引き継ぎ情報
accountAccountゲームプレイヤーアカウント
実装例
-- Request
local namespace = args.namespace
local takeOver = args.takeOver
local account = args.account

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

result = {
}

doTakeOver

引き継ぎ実行

同期実行スクリプト

引き継ぎ実行処理の前に、スクリプトが同期実行されます。

Request
型説明
namespaceNamespaceネームスペース
accountAccountゲームプレイヤーアカウント
takeOverTakeOver引き継ぎ情報
Result
型必須デフォルト値の制限説明
permitbool
✓
引き継ぎ実行を許可するか
forceboolfalseパスワード認証に失敗しても認証を通すか
実装例
-- Request
local namespace = args.namespace
local account = args.account
local takeOver = args.takeOver

-- Business logic:
local permit = true
local force = false

-- Result
result = {
  permit=permit,
  force=force
}

非同期実行スクリプト

引き継ぎ実行処理の後に、スクリプトが非同期実行されます。

Request
型説明
namespaceNamespaceネームスペース
accountAccountゲームプレイヤーアカウント
takeOverTakeOver引き継ぎ情報
実装例
-- Request
local namespace = args.namespace
local account = args.account
local takeOver = args.takeOver

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

result = {
}