/ja/tags/script/ Recent content in Script on Game Server Services | Docs Hugo ja /ja/articles/script/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/articles/script/ GS2-Scriptの拡張スクリプト（Lua言語）で使用可能な拡張メソッドです。 GS2-Script のサンドボックス内で利用できる Lua 標準ライブラリには制限があります。 load / require / dofile / pcall のような外部リソースを読み込んだり、エラーを内部でハンドリングしたりする関数は使用できません。 os ライブラリも安全のため、os.time() のみが利用可能です。 table / string / math ライブラリは概ねそのまま利用できます。 util.table_to_json Luaのテーブル型（配列）を、JSON形式の文字列に変換します。 Request 引数名 型 説明 table table Luaテーブル Result メンバ名 型 説明 isError bool エラーの有無 statusCode int ステータスコード errorMessage string エラーメッセージ result string 変換結果のJSON文字列 Sample Code result = util.table_to_json({a="a", b=1, c=false}) if result.isError then fail(result['statusCode'], result['errorMessage']) end json_str = result["result"] Output {"a":"a","b":1,"c":false} util.json_to_table JSON形式の文字列を、Luaのテーブル型（配列）に変換します。 Request 引数名 型 説明 jsonText string JSON形式の文字列 disableNumberStringToNumber bool JSON内に文字列型で数値が格納されていた時に数値型に変換しない(default: false) Result メンバ名 型 説明 isError bool エラーの有無 statusCode int ステータスコード errorMessage string エラーメッセージ result table 変換結果のLuaテーブル Sample Code result = util. /ja/overview/workflow/coding/extend/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/overview/workflow/coding/extend/ GS2 は様々な機能をマイクロサービスとして提供しています。 しかし、場合によっては機能を拡張したいと感じる場面があるかもしれません。 GS2-Script は Lua 言語を利用したスクリプティング機能を提供し、GS2 のマイクロサービスの機能を拡張できます。 GS2-Script に記述したスクリプトは任意のタイミングで呼び出せるようなものではなく、GS2 の各マイクロサービスが定義するトリガーに応じて実行されます。 たとえば、GS2-Account には以下のトリガーが存在します。 アカウント新規作成 認証実行 引き継ぎ情報登録 引き継ぎ実行 それぞれ、スクリプトの実行タイミングとして「同期処理」「非同期処理」が利用できます。 アカウント新規作成時に実行されるスクリプトの例 Request 型 説明 namespace Namespace ネームスペース account Account ゲームプレイヤーアカウント Result 型 必須 デフォルト 値の制限 説明 permit bool ✓ アカウントの作成を許可するか 実装例 namespace = args.namespace account = args.account result = { permit=permit } GS2-Script の同期処理 トリガーに対して同期処理を設定すると、スクリプトの実行が完了するまでAPIの処理はブロックされます。 スクリプトの実行時間分、APIの応答速度が落ちる代わりに 「スクリプトから結果を改竄」したり「処理を止める」ことができます。 もう少し具体的な例を示すと、スクリプトからクエストの入手経験値量を 2倍 に書き換えたり、クエストの開始処理で編成されたパーティに特定のキャラクターが含まれていない場合はエラー応答させることができます。 GS2-Script の非同期処理 トリガーに対して非同期処理を設定すると、APIが応答した後に非同期処理でスクリプトが実行されます。 アイテムの所持数量でランキングを実現したい場合、アイテムを入手・消費した際のトリガーに非同期スクリプトを割り当てることで、 APIの応答速度を損なうことなく、スクリプト内からアイテムの所持数量をスコアとしてランキングに登録するような処理ができます。 Amazon Event Bridge の非同期処理 GS2 は非同期処理の実装方法として、AWS が提供する 「Amazon Event Bridge」 が利用できます。 「Amazon Event Bridge」 の利用方法については別途資料を参考にしてください。 /ja/api_reference/account/sdk/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/account/sdk/ モデル Namespace ネームスペース ネームスペースは、一つのプロジェクト内で同じサービスを異なる用途で複数利用するためのエンティティです。 GS2 の各サービスはネームスペース単位で管理されます。ネームスペースが異なれば、同じサービスでも完全に独立したデータ空間として扱われます。 そのため、各サービスの利用を開始するにあたってネームスペースを作成する必要があります。 詳細 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceId string ※ ~ 1024文字 ネームスペース GRN ※ サーバーが自動で設定 name string ✓ ~ 128文字 ネームスペース名ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 description string ~ 1024文字 説明文 transactionSetting TransactionSetting トランザクション設定 changePasswordIfTakeOver bool false アカウント引き継ぎ時にパスワードを変更するかアカウント引き継ぎ時にパスワードを変更するかどうかを指定します。この設定により、アカウント引き継ぎを実行した後に引き継ぎ前のデバイスからのログインを制限することができます。 differentUserIdForLoginAndDataRetention bool false ログインに使用するユーザーIDとデータの保持に使用するユーザーIDを異なるものにするログイン用ユーザーIDとデータ保持用ユーザーIDを分けるかどうかを指定します。この設定により、プラットフォーマーが規定する個人情報保護の要件を少ない工数で満たせる可能性があります。※このパラメータは、ネームスペースの作成時にのみ設定が可能です。 createAccountScript ScriptSetting アカウント新規作成したときに実行するスクリプトアカウント作成のカスタムロジックを実装するのに使用されます。Script トリガーリファレンス - createAccount authenticationScript ScriptSetting 認証したときに実行するスクリプト認証プロセスのカスタマイズに役立ちます。Script トリガーリファレンス - authentication createTakeOverScript ScriptSetting 引き継ぎ情報登録したときに実行するスクリプト引き継ぎ情報を初めて登録した時に報酬を与えるために、GS2-Mission のカウンターを上昇するなどのカスタムロジックを追加するのに使用されます。Script トリガーリファレンス - createTakeOver doTakeOverScript ScriptSetting 引き継ぎ実行したときに実行するスクリプト引き継ぎ処理の追加ロジックを実装するのに役立ちます。Script トリガーリファレンス - doTakeOver banScript ScriptSetting アカウントBANステータスを追加したときに実行するスクリプトScript トリガーリファレンス - ban unBanScript ScriptSetting アカウントBANステータスを解除したときに実行するスクリプトScript トリガーリファレンス - unBan logSetting LogSetting ログの出力設定ログデータの出力設定を管理します。この型は、ログデータを書き出すために使用される GS2-Log のネームスペース情報を保持します。 createdAt long ※ 現在時刻 作成日時UNIX 時間・ミリ秒※ サーバーが自動で設定 updatedAt long ※ 現在時刻 最終更新日時UNIX 時間・ミリ秒※ サーバーが自動で設定 revision long 0 0 ~ 9223372036854775805 リビジョン 関連するメソッド: describeNamespaces - ネームスペースの一覧を取得 createNamespace - ネームスペースを新規作成 getNamespace - ネームスペースを取得 updateNamespace - ネームスペースを更新 deleteNamespace - ネームスペースを削除 TransactionSetting トランザクション設定 /ja/api_reference/ad_reward/sdk/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/ad_reward/sdk/ モデル Namespace ネームスペース ネームスペースは、一つのプロジェクト内で同じサービスを異なる用途で複数利用するためのエンティティです。 GS2 の各サービスはネームスペース単位で管理されます。ネームスペースが異なれば、同じサービスでも完全に独立したデータ空間として扱われます。 そのため、各サービスの利用を開始するにあたってネームスペースを作成する必要があります。 詳細 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceId string ※ ~ 1024文字 ネームスペース GRN ※ サーバーが自動で設定 name string ✓ ~ 128文字 ネームスペース名ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 description string ~ 1024文字 説明文 transactionSetting TransactionSetting トランザクション設定広告視聴報酬の付与時に実行される分散トランザクションの実行方法を制御する設定です。自動実行、アトミックコミット、非同期処理などのオプションが含まれます。 admob AdMob AdMob の設定AdMob に関連する広告の設定やパラメータを管理します。 unityAd UnityAd Unity Ads の設定Unity Ads に関連する広告の設定やパラメータを管理します。 appLovinMaxes List<AppLovinMax> 0 ~ 10 items AppLovin MAX の設定AppLovin MAX に関連する広告の設定やパラメータを管理します。 acquirePointScript ScriptSetting ポイント入手時に実行するスクリプトの設定Script トリガーリファレンス - acquirePoint consumePointScript ScriptSetting ポイント消費時に実行するスクリプトの設定Script トリガーリファレンス - consumePoint changePointNotification NotificationSetting ✓ 広告視聴によりポイントが変動したときのプッシュ通知広告視聴によるポイント変動時のプッシュ通知設定です。ポイントが変動した際にゲームクライアントに通知するための設定を保持します。この設定を行わなければ、獲得したポイントが即時にゲームに反映されません。 logSetting LogSetting ログの出力設定ログデータの出力設定を管理します。この型は、ログデータを書き出すために使用される GS2-Log のネームスペース情報を保持します。 createdAt long ※ 現在時刻 作成日時UNIX 時間・ミリ秒※ サーバーが自動で設定 updatedAt long ※ 現在時刻 最終更新日時UNIX 時間・ミリ秒※ サーバーが自動で設定 revision long 0 0 ~ 9223372036854775805 リビジョン 関連するメソッド: describeNamespaces - ネームスペースの一覧を取得 createNamespace - ネームスペースを新規作成 getNamespace - ネームスペースを取得 updateNamespace - ネームスペースを更新 deleteNamespace - ネームスペースを削除 TransactionSetting トランザクション設定 /ja/api_reference/auth/sdk/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/auth/sdk/ モデル AccessToken アクセストークン ユーザー認証後に発行されるアクセストークンを管理するモデルです。 アクセストークンは、ユーザーがサービスにログインしている間、そのセッションの身元を証明するために使用されます。 トークンには有効期限が設定されており、期限切れになると再認証が必要になります。 詳細 型 有効化条件 必須 デフォルト 値の制限 説明 token string ✓ ~ 1024文字 アクセストークンアクセスを認証するためのトークンです。このトークンはシステムによって自動的に生成され、ユーザーのセッションを識別します。 userId string ✓ ~ 128文字 ユーザーID federationFromUserId string ~ 128文字 フェデレーション元のユーザーIDIDフェデレーションを開始した元のユーザーIDです。IDフェデレーションにより別のユーザーとして操作を行う場合、このフィールドに操作元のユーザーIDが格納されます。 expire long 現在時刻から1時間後の絶対時刻 有効期限トークンの有効期限を示すタイムスタンプです。この期限が過ぎると、トークンは無効になります。UNIX 時間・ミリ秒 timeOffset int 0 0 ~ 315360000 現在時刻に対する補正値（現在時刻を起点とした秒数）時刻補正値は、サーバーの現在時刻との差分を秒単位で表します。この値はゲーム内のイベントや機能が特定の時間に合わせて動作する際に使用されます。 メソッド login ユーザーIDを指定してGS2にログイン 指定したユーザーIDでGS2にログインし、アクセストークンを取得します。 本APIは信頼出来るゲームサーバーから呼び出されることを想定しています。 ユーザーIDの値の検証処理が存在しないため、クライアントから呼び出すのは不適切です。 オプションでタイムオフセット（秒単位）を指定すると、ログインしたユーザーの現在時刻を擬似的に進めることができ、未来のイベントスケジュールのテストに活用できます。 返却されるアクセストークンには有効期限があり、期限を過ぎると無効になります。 詳細 Request 型 有効化条件 必須 デフォルト 値の制限 説明 userId string ✓ ~ 128文字 ユーザーID timeOffset int 0 0 ~ 315360000 現在時刻に対する補正値（現在時刻を起点とした秒数）時刻補正値は、サーバーの現在時刻との差分を秒単位で表します。この値はゲーム内のイベントや機能が特定の時間に合わせて動作する際に使用されます。 timeOffsetToken string ~ 1024文字 タイムオフセットトークン Result 型 説明 token string アクセストークンアクセスを認証するためのトークンです。このトークンはシステムによって自動的に生成され、ユーザーのセッションを識別します。 userId string ユーザーID expire long 有効期限トークンの有効期限を示すタイムスタンプです。この期限が過ぎると、トークンは無効になります。UNIX 時間・ミリ秒 実装例 Language: Go PHP Java C# TypeScript Python GS2-Script GS2-Script(Async) import " /ja/api_reference/buff/sdk/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/buff/sdk/ モデル Namespace ネームスペース ネームスペースは、一つのプロジェクト内で同じサービスを異なる用途で複数利用するためのエンティティです。 GS2 の各サービスはネームスペース単位で管理されます。ネームスペースが異なれば、同じサービスでも完全に独立したデータ空間として扱われます。 そのため、各サービスの利用を開始するにあたってネームスペースを作成する必要があります。 詳細 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceId string ※ ~ 1024文字 ネームスペース GRN ※ サーバーが自動で設定 name string ✓ ~ 128文字 ネームスペース名ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 description string ~ 1024文字 説明文 transactionSetting TransactionSetting トランザクション設定バフの適用結果に基づいて実行される分散トランザクションの実行方法を制御する設定です。自動実行、アトミックコミット、非同期処理などのオプションが含まれます。 applyBuffScript ScriptSetting バフを適用する際に実行するスクリプトの設定Script トリガーリファレンス - apply logSetting LogSetting ログの出力設定バフ操作のログデータを GS2-Log に出力するための設定です。APIリクエスト・レスポンスのログを収集する GS2-Log のネームスペースを指定します。 createdAt long ※ 現在時刻 作成日時UNIX 時間・ミリ秒※ サーバーが自動で設定 updatedAt long ※ 現在時刻 最終更新日時UNIX 時間・ミリ秒※ サーバーが自動で設定 revision long 0 0 ~ 9223372036854775805 リビジョン 関連するメソッド: describeNamespaces - ネームスペースの一覧を取得 createNamespace - ネームスペースを新規作成 getNamespace - ネームスペースを取得 updateNamespace - ネームスペースを更新 deleteNamespace - ネームスペースを削除 TransactionSetting トランザクション設定 /ja/api_reference/chat/sdk/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/chat/sdk/ モデル Namespace ネームスペース ネームスペースは、一つのプロジェクト内で同じサービスを異なる用途で複数利用するためのエンティティです。 GS2 の各サービスはネームスペース単位で管理されます。ネームスペースが異なれば、同じサービスでも完全に独立したデータ空間として扱われます。 そのため、各サービスの利用を開始するにあたってネームスペースを作成する必要があります。 詳細 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceId string ※ ~ 1024文字 ネームスペース GRN ※ サーバーが自動で設定 name string ✓ ~ 128文字 ネームスペース名ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 description string ~ 1024文字 説明文 transactionSetting TransactionSetting トランザクション設定チャットサービス内でのトランザクションの処理方法を制御する設定です。 allowCreateRoom bool true ゲームプレイヤーによるルームの作成を許可するかゲーム運営側があらかじめルームを作成しておいて、ゲームプレイヤーはそのルームを購読する形式の場合は「false」を指定します。逆に、ゲームプレイヤーが自由にルームを作成して、他のプレイヤーを招待して遊ぶ形式の場合は「true」を指定します。 messageLifeTimeDays int 1 1 ~ 30 メッセージ保持期間(日数)ルーム内のメッセージを保持する日数。 postMessageScript ScriptSetting メッセージを投稿したときに実行するスクリプトの設定Script トリガーリファレンス - postMessage createRoomScript ScriptSetting ルームを作成したときに実行するスクリプトの設定Script トリガーリファレンス - createRoom deleteRoomScript ScriptSetting ルームを削除したときに実行するスクリプトの設定Script トリガーリファレンス - deleteRoom subscribeRoomScript ScriptSetting ルームを購読したときに実行するスクリプトの設定Script トリガーリファレンス - subscribeRoom unsubscribeRoomScript ScriptSetting ルームの購読を解除したときに実行するスクリプトの設定Script トリガーリファレンス - unsubscribeRoom postNotification NotificationSetting ✓ 購読しているルームに新しい投稿がきたときのプッシュ通知購読中のルームに新しいメッセージが投稿された際に GS2-Gateway 経由でプッシュ通知を送信するための設定です。この設定がなければ、クライアントは新しいメッセージを検出するためにルームをポーリングする必要があります。 logSetting LogSetting ログの出力設定ログデータの出力設定を管理します。この型は、ログデータを書き出すために使用される GS2-Log のネームスペース情報を保持します。 createdAt long ※ 現在時刻 作成日時UNIX 時間・ミリ秒※ サーバーが自動で設定 updatedAt long ※ 現在時刻 最終更新日時UNIX 時間・ミリ秒※ サーバーが自動で設定 revision long 0 0 ~ 9223372036854775805 リビジョン 関連するメソッド: describeNamespaces - ネームスペースの一覧を取得 createNamespace - ネームスペースを新規作成 getNamespace - ネームスペースを取得 updateNamespace - ネームスペースを更新 deleteNamespace - ネームスペースを削除 TransactionSetting トランザクション設定 /ja/api_reference/datastore/sdk/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/datastore/sdk/ モデル Namespace ネームスペース ネームスペースは、一つのプロジェクト内で同じサービスを異なる用途で複数利用するためのエンティティです。 GS2 の各サービスはネームスペース単位で管理されます。ネームスペースが異なれば、同じサービスでも完全に独立したデータ空間として扱われます。 そのため、各サービスの利用を開始するにあたってネームスペースを作成する必要があります。 詳細 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceId string ※ ~ 1024文字 ネームスペース GRN ※ サーバーが自動で設定 name string ✓ ~ 128文字 ネームスペース名ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 description string ~ 1024文字 説明文 transactionSetting TransactionSetting トランザクション設定データストア操作時の分散トランザクションの実行方法を制御する設定です。自動実行、アトミックコミット、非同期処理などのオプションをサポートします。 doneUploadScript ScriptSetting アップロード完了報告時に実行するスクリプトの設定Script トリガーリファレンス - doneUpload logSetting LogSetting ログの出力設定データストア操作のログデータを GS2-Log に出力するための設定です。GS2-Log のネームスペースを指定することで、データオブジェクトのアップロード・ダウンロード・アクセス権変更などの API リクエスト・レスポンスログを収集できます。 createdAt long ※ 現在時刻 作成日時UNIX 時間・ミリ秒※ サーバーが自動で設定 updatedAt long ※ 現在時刻 最終更新日時UNIX 時間・ミリ秒※ サーバーが自動で設定 revision long 0 0 ~ 9223372036854775805 リビジョン 関連するメソッド: describeNamespaces - ネームスペースの一覧を取得 createNamespace - ネームスペースを新規作成 getNamespace - ネームスペースを取得 updateNamespace - ネームスペースを更新 deleteNamespace - ネームスペースを削除 TransactionSetting トランザクション設定 /ja/api_reference/deploy/sdk/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/deploy/sdk/ モデル GitHubCheckoutSetting GitHubからマスターデータをチェックアウトする設定 GitHub リポジトリからテンプレートやマスターデータファイルを直接取得するための設定です。コミットハッシュ・ブランチ名・タグ名による参照をサポートし、認証には GS2-Key の GitHub API キーが必要です。 詳細 型 有効化条件 必須 デフォルト 値の制限 説明 apiKeyId string ✓ ~ 1024文字 GitHub APIキーの GRN repositoryName string ✓ ~ 1024文字 リポジトリ名ファイルを取得する GitHub リポジトリ名です。“owner/repo” 形式で指定します。 sourcePath string ✓ ~ 1024文字 マスターデータ（JSON）ファイルのパスリポジトリ内の対象ファイルへのファイルパスです。例えば、“data/master.json” や “deploy/template.yaml” のように指定します。 referenceType 文字列列挙型 enum { “commit_hash”, “branch”, “tag” } ✓ コードの取得元ファイルのチェックアウトに使用する Git 参照の種類です。commit_hash は再現性のために特定のコミットから取得、branch はブランチの最新を取得、tag はタグ付きリリースから取得します。定義説明“commit_hash”コミットハッシュ“branch”ブランチ“tag”タグ commitHash string {referenceType} == “commit_hash” ✓※ ~ 1024文字 コミットハッシュチェックアウトする Git コミットの完全な SHA です。常に同一バージョンのファイルが取得されることを保証し、デプロイの再現性を提供します。※ referenceType が “commit_hash” であれば 必須 branchName string {referenceType} == “branch” ✓※ ~ 1024文字 ブランチ名チェックアウトする Git ブランチ名です。このブランチの最新コミットからファイルが取得されます。※ referenceType が “branch” であれば 必須 tagName string {referenceType} == “tag” ✓※ ~ 1024文字 タグ名チェックアウトする Git タグ名です。タグは通常リリースバージョンのマークに使用され、デプロイの安定した参照ポイントを提供します。※ referenceType が “tag” であれば 必須 関連するメソッド: createStackFromGitHub - GitHub からスタックを新規作成 updateStackFromGitHub - GitHub からスタックを更新 Resource リソース /ja/api_reference/dictionary/sdk/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/dictionary/sdk/ モデル Namespace ネームスペース ネームスペースは、一つのプロジェクト内で同じサービスを異なる用途で複数利用するためのエンティティです。 GS2 の各サービスはネームスペース単位で管理されます。ネームスペースが異なれば、同じサービスでも完全に独立したデータ空間として扱われます。 そのため、各サービスの利用を開始するにあたってネームスペースを作成する必要があります。 詳細 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceId string ※ ~ 1024文字 ネームスペース GRN ※ サーバーが自動で設定 name string ✓ ~ 128文字 ネームスペース名ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 description string ~ 1024文字 説明文 transactionSetting TransactionSetting トランザクション設定図鑑エントリー登録処理時の分散トランザクションの実行方法を制御する設定です。自動実行、アトミックコミット、非同期処理などのオプションをサポートします。 entryScript ScriptSetting エントリー登録時に実行するスクリプトの設定Script トリガーリファレンス - entry duplicateEntryScript string ~ 1024文字 登録済みのエントリーを再度登録しようとしたときに実行するスクリプトGRNScript トリガーリファレンス - duplicateEntry logSetting LogSetting ログの出力設定図鑑操作のログデータを GS2-Log に出力するための設定です。GS2-Log のネームスペースを指定することで、エントリー登録・お気に入り操作など図鑑関連の API リクエスト・レスポンスログを収集できます。 createdAt long ※ 現在時刻 作成日時UNIX 時間・ミリ秒※ サーバーが自動で設定 updatedAt long ※ 現在時刻 最終更新日時UNIX 時間・ミリ秒※ サーバーが自動で設定 revision long 0 0 ~ 9223372036854775805 リビジョン 関連するメソッド: describeNamespaces - ネームスペースの一覧を取得 createNamespace - ネームスペースを新規作成 getNamespace - ネームスペースを取得 updateNamespace - ネームスペースを更新 deleteNamespace - ネームスペースを削除 TransactionSetting トランザクション設定 /ja/api_reference/distributor/sdk/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/distributor/sdk/ モデル Namespace ネームスペース ネームスペースは、一つのプロジェクト内で同じサービスを異なる用途で複数利用するためのエンティティです。 GS2 の各サービスはネームスペース単位で管理されます。ネームスペースが異なれば、同じサービスでも完全に独立したデータ空間として扱われます。 そのため、各サービスの利用を開始するにあたってネームスペースを作成する必要があります。 詳細 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceId string ※ ~ 1024文字 ネームスペース GRN ※ サーバーが自動で設定 name string ✓ ~ 128文字 ネームスペース名ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 description string ~ 1024文字 説明文 transactionSetting TransactionSetting トランザクション設定リソース配布処理時の分散トランザクションの実行方法を制御する設定です。自動実行、アトミックコミット、非同期処理などのオプションをサポートします。 assumeUserId string ~ 1024文字 GS2-Identifier ユーザー GRN autoRunStampSheetNotification NotificationSetting ✓ トランザクションの自動実行が完了したときのプッシュ通知(旧仕様)トランザクションがサーバーサイドで自動実行完了した際に GS2-Gateway 経由でプッシュ通知を送信するための設定です。これは旧仕様であり、新仕様では autoRunTransactionNotification を使用してください。 autoRunTransactionNotification NotificationSetting ✓ トランザクションの自動実行が完了したときのプッシュ通知分散トランザクションがサーバーサイドで自動実行完了した際に GS2-Gateway 経由でプッシュ通知を送信するための設定です。トランザクション結果をクライアントに通知し、ローカル状態を適切に更新できるようにします。 logSetting LogSetting ログの出力設定ディストリビューター操作のログデータを GS2-Log に出力するための設定です。GS2-Log のネームスペースを指定することで、リソース配布・入手アクション実行・トランザクション処理の API リクエスト・レスポンスログを収集できます。 createdAt long ※ 現在時刻 作成日時UNIX 時間・ミリ秒※ サーバーが自動で設定 updatedAt long ※ 現在時刻 最終更新日時UNIX 時間・ミリ秒※ サーバーが自動で設定 revision long 0 0 ~ 9223372036854775805 リビジョン 関連するメソッド: describeNamespaces - ネームスペースの一覧を取得 createNamespace - ネームスペースを新規作成 getNamespace - ネームスペースを取得 updateNamespace - ネームスペースを更新 deleteNamespace - ネームスペースを削除 TransactionSetting トランザクション設定 /ja/api_reference/enchant/sdk/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/enchant/sdk/ モデル Namespace ネームスペース ネームスペースは、一つのプロジェクト内で同じサービスを異なる用途で複数利用するためのエンティティです。 GS2 の各サービスはネームスペース単位で管理されます。ネームスペースが異なれば、同じサービスでも完全に独立したデータ空間として扱われます。 そのため、各サービスの利用を開始するにあたってネームスペースを作成する必要があります。 詳細 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceId string ※ ~ 1024文字 ネームスペース GRN ※ サーバーが自動で設定 name string ✓ ~ 128文字 ネームスペース名ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 description string ~ 1024文字 説明文 transactionSetting TransactionSetting ✓ トランザクション設定エンチャントパラメータ操作時のトランザクションの処理方法を制御する設定です。 logSetting LogSetting ログの出力設定エンチャント操作のログデータを GS2-Log に出力するための設定です。GS2-Log のネームスペースを指定することで、バランスパラメータおよびレアリティパラメータ操作の API リクエスト・レスポンスログを収集できます。 createdAt long ※ 現在時刻 作成日時UNIX 時間・ミリ秒※ サーバーが自動で設定 updatedAt long ※ 現在時刻 最終更新日時UNIX 時間・ミリ秒※ サーバーが自動で設定 revision long 0 0 ~ 9223372036854775805 リビジョン 関連するメソッド: describeNamespaces - ネームスペースの一覧を取得 createNamespace - ネームスペースを新規作成 getNamespace - ネームスペースを取得 updateNamespace - ネームスペースを更新 deleteNamespace - ネームスペースを削除 TransactionSetting トランザクション設定 /ja/api_reference/enhance/sdk/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/enhance/sdk/ モデル Namespace ネームスペース ネームスペースは、一つのプロジェクト内で同じサービスを異なる用途で複数利用するためのエンティティです。 GS2 の各サービスはネームスペース単位で管理されます。ネームスペースが異なれば、同じサービスでも完全に独立したデータ空間として扱われます。 そのため、各サービスの利用を開始するにあたってネームスペースを作成する必要があります。 詳細 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceId string ※ ~ 1024文字 ネームスペース GRN ※ サーバーが自動で設定 name string ✓ ~ 128文字 ネームスペース名ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 description string ~ 1024文字 説明文 transactionSetting TransactionSetting ✓ トランザクション設定強化操作時の分散トランザクションの実行方法を制御する設定です。自動実行、アトミックコミット、非同期処理などのオプションをサポートします。 enhanceScript ScriptSetting 強化時に実行するスクリプトの設定Script トリガーリファレンス - enhance logSetting LogSetting ログの出力設定強化操作のログデータを GS2-Log に出力するための設定です。GS2-Log のネームスペースを指定することで、強化および限界突破操作の API リクエスト・レスポンスログを収集できます。 createdAt long ※ 現在時刻 作成日時UNIX 時間・ミリ秒※ サーバーが自動で設定 updatedAt long ※ 現在時刻 最終更新日時UNIX 時間・ミリ秒※ サーバーが自動で設定 revision long 0 0 ~ 9223372036854775805 リビジョン 関連するメソッド: describeNamespaces - ネームスペースの一覧を取得 createNamespace - ネームスペースを新規作成 getNamespace - ネームスペースを取得 updateNamespace - ネームスペースを更新 deleteNamespace - ネームスペースを削除 TransactionSetting トランザクション設定 /ja/api_reference/exchange/sdk/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/exchange/sdk/ モデル Namespace ネームスペース ネームスペースは、一つのプロジェクト内で同じサービスを異なる用途で複数利用するためのエンティティです。 GS2 の各サービスはネームスペース単位で管理されます。ネームスペースが異なれば、同じサービスでも完全に独立したデータ空間として扱われます。 そのため、各サービスの利用を開始するにあたってネームスペースを作成する必要があります。 詳細 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceId string ※ ~ 1024文字 ネームスペース GRN ※ サーバーが自動で設定 name string ✓ ~ 128文字 ネームスペース名ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 description string ~ 1024文字 説明文 enableDirectExchange bool true 直接交換 API の呼び出しを許可する有効にすると、クライアントが交換 API を直接呼び出してリソース交換を実行できます。無効にすると、トランザクションアクション経由でのみ交換がトリガーされ、交換発生のサーバーサイド制御がより厳密になります。 enableAwaitExchange bool false 交換結果の受け取りに待ち時間の発生する交換機能を利用するか有効にすると、await タイミングタイプの交換レートモデルが利用可能になります。これらの交換は報酬を受け取る前に実時間の経過が必要で、プレイヤーが結果を待つ必要のあるクラフトや生産系の仕組みを実現できます。 transactionSetting TransactionSetting ✓ トランザクション設定交換操作時の分散トランザクションの実行方法を制御する設定です。自動実行、アトミックコミット、非同期処理などのオプションをサポートします。 exchangeScript ScriptSetting 交換を実行しようとしたときに実行するスクリプトの設定Script トリガーリファレンス - exchange incrementalExchangeScript ScriptSetting レート上昇型交換を実行しようとしたときに実行するスクリプトの設定Script トリガーリファレンス - incrementalExchange acquireAwaitScript ScriptSetting 待機方式の交換処理で、待機が完了し報酬を受け取ろうとしたときに実行するスクリプトの設定Script トリガーリファレンス - acquireAwait logSetting LogSetting ログの出力設定交換操作のログデータを GS2-Log に出力するための設定です。GS2-Log のネームスペースを指定することで、交換、コスト上昇型交換、待機操作の API リクエスト・レスポンスログを収集できます。 createdAt long ※ 現在時刻 作成日時UNIX 時間・ミリ秒※ サーバーが自動で設定 updatedAt long ※ 現在時刻 最終更新日時UNIX 時間・ミリ秒※ サーバーが自動で設定 revision long 0 0 ~ 9223372036854775805 リビジョン 関連するメソッド: describeNamespaces - ネームスペースの一覧を取得 createNamespace - ネームスペースを新規作成 getNamespace - ネームスペースを取得 updateNamespace - ネームスペースを更新 deleteNamespace - ネームスペースを削除 TransactionSetting トランザクション設定 /ja/api_reference/experience/sdk/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/experience/sdk/ モデル Namespace ネームスペース ネームスペースは、一つのプロジェクト内で同じサービスを異なる用途で複数利用するためのエンティティです。 GS2 の各サービスはネームスペース単位で管理されます。ネームスペースが異なれば、同じサービスでも完全に独立したデータ空間として扱われます。 そのため、各サービスの利用を開始するにあたってネームスペースを作成する必要があります。 詳細 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceId string ※ ~ 1024文字 ネームスペース GRN ※ サーバーが自動で設定 name string ✓ ~ 128文字 ネームスペース名ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 description string ~ 1024文字 説明文 transactionSetting TransactionSetting トランザクション設定経験値操作時の分散トランザクションの実行方法を制御する設定です。自動実行、アトミックコミット、非同期処理などのオプションをサポートします。 rankCapScriptId string ~ 1024文字 ランクキャップを動的に決定するスクリプト GRN Script トリガーリファレンス - / rankCapScript changeExperienceScript ScriptSetting 経験値変化したときに実行するスクリプトの設定Script トリガーリファレンス - changeExperience changeRankScript ScriptSetting ランク変化したときに実行するスクリプトの設定Script トリガーリファレンス - changeRank changeRankCapScript ScriptSetting ランクキャップ変化したときに実行するスクリプトの設定Script トリガーリファレンス - changeRankCap overflowExperienceScript string ~ 1024文字 経験値あふれしたときに実行するスクリプトGRNScript トリガーリファレンス - overflowExperience logSetting LogSetting ログの出力設定経験値操作のログデータを GS2-Log に出力するための設定です。GS2-Log のネームスペースを指定することで、経験値変動、ランクアップ、ランクキャップ変更の API リクエスト・レスポンスログを収集できます。 createdAt long ※ 現在時刻 作成日時UNIX 時間・ミリ秒※ サーバーが自動で設定 updatedAt long ※ 現在時刻 最終更新日時UNIX 時間・ミリ秒※ サーバーが自動で設定 revision long 0 0 ~ 9223372036854775805 リビジョン 関連するメソッド: describeNamespaces - ネームスペースの一覧を取得 createNamespace - ネームスペースを新規作成 getNamespace - ネームスペースを取得 updateNamespace - ネームスペースを更新 deleteNamespace - ネームスペースを削除 TransactionSetting トランザクション設定 /ja/api_reference/formation/sdk/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/formation/sdk/ モデル Namespace ネームスペース ネームスペースは、一つのプロジェクト内で同じサービスを異なる用途で複数利用するためのエンティティです。 GS2 の各サービスはネームスペース単位で管理されます。ネームスペースが異なれば、同じサービスでも完全に独立したデータ空間として扱われます。 そのため、各サービスの利用を開始するにあたってネームスペースを作成する必要があります。 詳細 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceId string ※ ~ 1024文字 ネームスペース GRN ※ サーバーが自動で設定 name string ✓ ~ 128文字 ネームスペース名ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 description string ~ 1024文字 説明文 transactionSetting TransactionSetting トランザクション設定編成操作時のトランザクションの処理方法を制御する設定です。 updateMoldScript ScriptSetting フォームの保存領域のキャパシティを更新するときに実行するスクリプトの設定Script トリガーリファレンス - updateMold updateFormScript ScriptSetting フォームを更新するときに実行するスクリプトの設定Script トリガーリファレンス - updateForm updatePropertyFormScript ScriptSetting プロパティフォームを更新するときに実行するスクリプトの設定Script トリガーリファレンス - updatePropertyForm logSetting LogSetting ログの出力設定編成操作のログデータを GS2-Log に出力するための設定です。GS2-Log のネームスペースを指定することで、フォーム更新、保存領域キャパシティ変更、プロパティフォーム変更の API リクエスト・レスポンスログを収集できます。 createdAt long ※ 現在時刻 作成日時UNIX 時間・ミリ秒※ サーバーが自動で設定 updatedAt long ※ 現在時刻 最終更新日時UNIX 時間・ミリ秒※ サーバーが自動で設定 revision long 0 0 ~ 9223372036854775805 リビジョン 関連するメソッド: describeNamespaces - ネームスペースの一覧を取得 createNamespace - ネームスペースを新規作成 getNamespace - ネームスペースを取得 updateNamespace - ネームスペースを更新 deleteNamespace - ネームスペースを削除 TransactionSetting トランザクション設定 /ja/api_reference/freeze/sdk/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/freeze/sdk/ モデル Output ステージ更新進捗出力 ステージバージョン更新操作中に生成されるログエントリを表します。各出力は更新プロセスのステップやイベントを記録します。出力は 30 日後に自動的にクリーンアップされます。 詳細 型 有効化条件 必須 デフォルト 値の制限 説明 outputId string ※ ~ 1024文字 ステージ更新進捗出力 GRN ※ サーバーが自動で設定 name string ✓ UUID ~ 36文字 出力名ステージ更新進捗出力の一意な名前を保持します。名前は UUID（Universally Unique Identifier）フォーマットで自動的に生成され、各ステージ更新進捗出力を識別するために使用されます。 text string ✓ ~ 1048576文字 テキストステージ更新プロセス中の特定のステップやイベントを記述するログメッセージ内容です。バージョン切り替え操作のステータス情報、エラー詳細、進捗指標などを含む場合があります。 createdAt long ※ 現在時刻 日時 revision long 0 0 ~ 9223372036854775805 リビジョン 関連するメソッド: describeOutputs - ステージ更新進捗出力の一覧を取得 getOutput - ステージ更新進捗出力を取得 Stage ステージ ステージとはプログラムバージョンを固定する環境情報です。 1つのプロジェクトに対して複数のステージを持つことができます。 ステージはソースステージを持ち、ソースステージで固定されたバージョンへと切り替えることが可能です。 この仕組みを利用することで まずは dev ステージに最新のバージョンを取り込んで開発者レベルで動作確認をして、 問題がなさそうであれば dev ステージをソースステージとしている stg ステージへ反映し、 /ja/api_reference/friend/sdk/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/friend/sdk/ モデル Namespace ネームスペース ネームスペースは、一つのプロジェクト内で同じサービスを異なる用途で複数利用するためのエンティティです。 GS2 の各サービスはネームスペース単位で管理されます。ネームスペースが異なれば、同じサービスでも完全に独立したデータ空間として扱われます。 そのため、各サービスの利用を開始するにあたってネームスペースを作成する必要があります。 詳細 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceId string ※ ~ 1024文字 ネームスペース GRN ※ サーバーが自動で設定 name string ✓ ~ 128文字 ネームスペース名ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 description string ~ 1024文字 説明文 transactionSetting TransactionSetting トランザクション設定フレンド操作時のトランザクションの処理方法を制御する設定です。 followScript ScriptSetting フォローされたときに実行するスクリプトの設定Script トリガーリファレンス - follow unfollowScript ScriptSetting アンフォローされたときに実行するスクリプトの設定Script トリガーリファレンス - unfollow sendRequestScript ScriptSetting フレンドリクエストを発行したときに実行するスクリプトの設定Script トリガーリファレンス - sendRequest cancelRequestScript ScriptSetting フレンドリクエストをキャンセルしたときに実行するスクリプトの設定Script トリガーリファレンス - cancelRequest acceptRequestScript ScriptSetting フレンドリクエストを承諾したときに実行するスクリプトの設定Script トリガーリファレンス - acceptRequest rejectRequestScript ScriptSetting フレンドリクエストを拒否したときに実行するスクリプトの設定Script トリガーリファレンス - rejectRequest deleteFriendScript ScriptSetting フレンドを削除したときに実行するスクリプトの設定Script トリガーリファレンス - deleteFriend updateProfileScript ScriptSetting プロフィールを更新したときに実行するスクリプトの設定Script トリガーリファレンス - updateProfile followNotification NotificationSetting フォローされたときのプッシュ通知他のプレイヤーにフォローされたときにプッシュ通知を送信する設定です。フォローされたプレイヤーが GS2-Gateway 経由でリアルタイムに通知を受け取ることができます。 receiveRequestNotification NotificationSetting ✓ フレンドリクエストが届いたときのプッシュ通知他のプレイヤーからフレンドリクエストを受信したときにプッシュ通知を送信する設定です。受信者が GS2-Gateway 経由で迅速に応答できるようにします。 cancelRequestNotification NotificationSetting ✓ 受け取ったフレンドリクエストがキャンセルされたときのプッシュ通知以前受信したフレンドリクエストが送信者によってキャンセルされたときにプッシュ通知を送信する設定です。保留中のリクエストが存在しなくなったことを受信者に通知します。 acceptRequestNotification NotificationSetting ✓ フレンドリクエストが承認されたときのプッシュ通知送信したフレンドリクエストが受信者によって承認されたときにプッシュ通知を送信する設定です。承認後、両プレイヤーが互いのフレンドリストに追加されます。 rejectRequestNotification NotificationSetting ✓ フレンドリクエストが拒否されたときのプッシュ通知送信したフレンドリクエストが受信者によって拒否されたときにプッシュ通知を送信する設定です。フレンドリクエストは送信ボックスと受信ボックスの両方から削除されます。 deleteFriendNotification NotificationSetting ✓ フレンドが削除されたときのプッシュ通知他のプレイヤーのフレンドリストから削除されたときにプッシュ通知を送信する設定です。フレンド関係は双方で解消されます。 logSetting LogSetting ログの出力設定フレンド操作のログデータを GS2-Log に出力するための設定です。GS2-Log のネームスペースを指定することで、フォロー/アンフォロー、フレンドリクエスト、プロフィール更新の API リクエスト・レスポンスログを収集できます。 createdAt long ※ 現在時刻 作成日時UNIX 時間・ミリ秒※ サーバーが自動で設定 updatedAt long ※ 現在時刻 最終更新日時UNIX 時間・ミリ秒※ サーバーが自動で設定 revision long 0 0 ~ 9223372036854775805 リビジョン 関連するメソッド: describeNamespaces - ネームスペースの一覧を取得 createNamespace - ネームスペースを新規作成 getNamespace - ネームスペースを取得 updateNamespace - ネームスペースを更新 deleteNamespace - ネームスペースを削除 TransactionSetting トランザクション設定 /ja/api_reference/gateway/sdk/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/gateway/sdk/ モデル Namespace ネームスペース ネームスペースは、一つのプロジェクト内で同じサービスを異なる用途で複数利用するためのエンティティです。 GS2 の各サービスはネームスペース単位で管理されます。ネームスペースが異なれば、同じサービスでも完全に独立したデータ空間として扱われます。 そのため、各サービスの利用を開始するにあたってネームスペースを作成する必要があります。 詳細 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceId string ※ ~ 1024文字 ネームスペース GRN ※ サーバーが自動で設定 name string ✓ ~ 128文字 ネームスペース名ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 description string ~ 1024文字 説明文 transactionSetting TransactionSetting トランザクション設定ゲートウェイ操作時のトランザクションの処理方法を制御する設定です。 firebaseSecret string ~ 1024文字 Firebase の通知送信に使用するシークレットトークンFirebase Cloud Messaging (FCM) のサーバーキーまたはシークレットトークンです。対象プレイヤーがオフラインでゲーム内の WebSocket 通知を受信できない場合に、モバイルプッシュ通知への転送を有効にするために必要です。 logSetting LogSetting ログの出力設定ゲートウェイ操作のログデータを GS2-Log に出力するための設定です。GS2-Log のネームスペースを指定することで、WebSocket セッション管理、通知配信、Firebase トークン操作の API リクエスト・レスポンスログを収集できます。 createdAt long ※ 現在時刻 作成日時UNIX 時間・ミリ秒※ サーバーが自動で設定 updatedAt long ※ 現在時刻 最終更新日時UNIX 時間・ミリ秒※ サーバーが自動で設定 revision long 0 0 ~ 9223372036854775805 リビジョン 関連するメソッド: describeNamespaces - ネームスペースの一覧を取得 createNamespace - ネームスペースを新規作成 getNamespace - ネームスペースを取得 updateNamespace - ネームスペースを更新 deleteNamespace - ネームスペースを削除 TransactionSetting トランザクション設定 /ja/api_reference/grade/sdk/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/grade/sdk/ モデル Namespace ネームスペース ネームスペースは、一つのプロジェクト内で同じサービスを異なる用途で複数利用するためのエンティティです。 GS2 の各サービスはネームスペース単位で管理されます。ネームスペースが異なれば、同じサービスでも完全に独立したデータ空間として扱われます。 そのため、各サービスの利用を開始するにあたってネームスペースを作成する必要があります。 詳細 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceId string ※ ~ 1024文字 ネームスペース GRN ※ サーバーが自動で設定 name string ✓ ~ 128文字 ネームスペース名ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 description string ~ 1024文字 説明文 transactionSetting TransactionSetting トランザクション設定グレード操作時の分散トランザクションの実行方法を制御する設定です。自動実行、アトミックコミット、非同期処理などのオプションをサポートします。 changeGradeScript ScriptSetting グレードが変化したときに実行するスクリプトの設定Script トリガーリファレンス - changeGrade logSetting LogSetting ログの出力設定グレード操作のログデータを GS2-Log に出力するための設定です。GS2-Log のネームスペースを指定することで、グレード変更やランクキャップ更新の API リクエスト・レスポンスログを収集できます。 createdAt long ※ 現在時刻 作成日時UNIX 時間・ミリ秒※ サーバーが自動で設定 updatedAt long ※ 現在時刻 最終更新日時UNIX 時間・ミリ秒※ サーバーが自動で設定 revision long 0 0 ~ 9223372036854775805 リビジョン 関連するメソッド: describeNamespaces - ネームスペースの一覧を取得 createNamespace - ネームスペースを新規作成 getNamespace - ネームスペースを取得 updateNamespace - ネームスペースを更新 deleteNamespace - ネームスペースを削除 TransactionSetting トランザクション設定 /ja/api_reference/guard/sdk/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/guard/sdk/ モデル Namespace ネームスペース ネームスペースは、一つのプロジェクト内で同じサービスを異なる用途で複数利用するためのエンティティです。 GS2 の各サービスはネームスペース単位で管理されます。ネームスペースが異なれば、同じサービスでも完全に独立したデータ空間として扱われます。 そのため、各サービスの利用を開始するにあたってネームスペースを作成する必要があります。 詳細 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceId string ※ ~ 1024文字 ネームスペース GRN ※ サーバーが自動で設定 name string ✓ ~ 128文字 ネームスペース名ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 description string ~ 1024文字 説明文 blockingPolicy BlockingPolicyModel ✓ ブロッキングポリシーGS2 サービスへのアクセスを制御するこのネームスペースのセキュリティポリシー設定です。アクセス可能なサービス、地理的制限ルール、匿名IP検知、ホスティングプロバイダーIP検知、レピュテーションベースのIPフィルタリング、カスタムIPアドレスの許可/拒否リストを定義します。 createdAt long ※ 現在時刻 作成日時UNIX 時間・ミリ秒※ サーバーが自動で設定 updatedAt long ※ 現在時刻 最終更新日時UNIX 時間・ミリ秒※ サーバーが自動で設定 revision long 0 0 ~ 9223372036854775805 リビジョン 関連するメソッド: describeNamespaces - ネームスペースの一覧を取得 createNamespace - ネームスペースを新規作成 getNamespace - ネームスペースを取得 updateNamespace - ネームスペースを更新 deleteNamespace - ネームスペースを削除 BlockingPolicyModel ブロッキングポリシー /ja/api_reference/guild/sdk/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/guild/sdk/ モデル Namespace ネームスペース ネームスペースは、一つのプロジェクト内で同じサービスを異なる用途で複数利用するためのエンティティです。 GS2 の各サービスはネームスペース単位で管理されます。ネームスペースが異なれば、同じサービスでも完全に独立したデータ空間として扱われます。 そのため、各サービスの利用を開始するにあたってネームスペースを作成する必要があります。 詳細 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceId string ※ ~ 1024文字 ネームスペース GRN ※ サーバーが自動で設定 name string ✓ ~ 128文字 ネームスペース名ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 description string ~ 1024文字 説明文 transactionSetting TransactionSetting トランザクション設定ギルド操作時の分散トランザクションの実行方法を制御する設定です。自動実行、アトミックコミット、非同期処理などのオプションをサポートします。 changeNotification NotificationSetting ギルド変更通知ギルド情報（表示名、属性、参加ポリシーなど）が更新されたときに GS2-Gateway 経由で送信されるプッシュ通知です。ギルドメンバーがギルドの変更についてリアルタイムで更新を受け取ることができます。 joinNotification NotificationSetting メンバー参加通知新しいメンバーがギルドに参加したときに GS2-Gateway 経由で送信されるプッシュ通知です。自由参加または参加リクエストの承認によるものの両方に対応します。既存メンバーが新規追加を通知されるようになります。 leaveNotification NotificationSetting メンバー離脱通知メンバーがギルドから離脱または除籍されたときに GS2-Gateway 経由で送信されるプッシュ通知です。自発的な脱退とギルドマスターによる追放の両方に対応します。 changeMemberNotification NotificationSetting メンバー変更通知ギルドメンバーの情報（ロール、メタデータ）が更新されたときに GS2-Gateway 経由で送信されるプッシュ通知です。メタデータの変更でこの通知がトリガーされるかどうかは changeMemberNotificationIgnoreChangeMetadata で制御できます。 changeMemberNotificationIgnoreChangeMetadata bool? false メンバーの情報が更新されたときの通知を発行する際にメタデータの変更を無視する receiveRequestNotification NotificationSetting リクエスト受信通知ユーザーからの新しい参加リクエストをギルドが受信したときに GS2-Gateway 経由で送信されるプッシュ通知です。ギルドマスターや権限を持つメンバーが承認待ちのリクエストを通知されるようになります。 removeRequestNotification NotificationSetting リクエスト削除通知ギルド参加リクエストが削除されたときに GS2-Gateway 経由で送信されるプッシュ通知です。送信者によるキャンセル、ギルドによる拒否、または承認（リクエスト削除とメンバー追加）のいずれかに対応します。 createGuildScript ScriptSetting ギルドを作成するときに実行するスクリプトの設定Script トリガーリファレンス - createGuild updateGuildScript ScriptSetting ギルドを更新するときに実行するスクリプトの設定Script トリガーリファレンス - updateGuild joinGuildScript ScriptSetting ギルドに参加するときに実行するスクリプトの設定Script トリガーリファレンス - joinGuild receiveJoinRequestScript ScriptSetting ギルドに参加申請を受け付けたときに実行するスクリプトの設定Script トリガーリファレンス - receiveJoinRequest leaveGuildScript ScriptSetting ギルドを脱退するときに実行するスクリプトの設定Script トリガーリファレンス - leaveGuild changeRoleScript ScriptSetting メンバーに割り当てているロールを変更するときに実行するスクリプトの設定Script トリガーリファレンス - changeRole deleteGuildScript ScriptSetting ギルドを削除するときに実行するスクリプトの設定Script トリガーリファレンス - deleteGuild logSetting LogSetting ログの出力設定ギルド操作のログデータを GS2-Log に出力するための設定です。GS2-Log のネームスペースを指定することで、ギルド作成、参加、脱退、ロール変更の API リクエスト・レスポンスログを収集できます。 createdAt long ※ 現在時刻 作成日時UNIX 時間・ミリ秒※ サーバーが自動で設定 updatedAt long ※ 現在時刻 最終更新日時UNIX 時間・ミリ秒※ サーバーが自動で設定 revision long 0 0 ~ 9223372036854775805 リビジョン 関連するメソッド: describeNamespaces - ネームスペースの一覧を取得 createNamespace - ネームスペースを新規作成 getNamespace - ネームスペースを取得 updateNamespace - ネームスペースを更新 deleteNamespace - ネームスペースを削除 TransactionSetting トランザクション設定 /ja/api_reference/identifier/sdk/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/identifier/sdk/ モデル Identifier クレデンシャル GS2 の API にアクセスするために使用されるクレデンシャルです。 クレデンシャルはクライアントIDとクライアントシークレットからなり、クレデンシャルを使用したアクセスは、クレデンシャルの所有者となるユーザーの権限に基づいてアクセス制限が施されます。 詳細 型 有効化条件 必須 デフォルト 値の制限 説明 clientId string ✓ UUID ~ 256文字 クライアントID userName string ✓ ~ 128文字 ユーザー名このクレデンシャルを所有するGS2-Identifierユーザーの名前です。クレデンシャルはこのユーザーにアタッチされたセキュリティポリシーに基づいて権限を継承します。 clientSecret string ✓ UUID ~ 100文字 クライアントシークレット createdAt long ※ 現在時刻 作成日時UNIX 時間・ミリ秒※ サーバーが自動で設定 revision long 0 0 ~ 9223372036854775805 リビジョン 関連するメソッド: describeIdentifiers - クレデンシャルの一覧を取得 createIdentifier - クレデンシャルを新規作成 getIdentifier - クレデンシャルを取得 deleteIdentifier - クレデンシャルを削除 Password パスワード マネージメントコンソールにユーザーの権限に基づいてログインするためのパスワードです。 パスワードを設定することで、1つのプロジェクトに異なるアカウントからログインでき、なおかつアクセスできる情報に制限をかけることができます。 詳細 型 有効化条件 必須 デフォルト 値の制限 説明 passwordId string ※ ~ 1024文字 パスワード GRN ※ サーバーが自動で設定 userId string ✓ ~ 1024文字 GS2-Identifier ユーザー GRN userName string ✓ ~ 128文字 ユーザー名このパスワードを所有するGS2-Identifierユーザーの名前です。ユーザーはこのユーザー名と対応するパスワードでマネージメントコンソールにログインし、ユーザーにアタッチされたセキュリティポリシーに基づいてアクセスが制限されます。 enableTwoFactorAuthentication 文字列列挙型 /ja/api_reference/idle/sdk/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/idle/sdk/ モデル Namespace ネームスペース ネームスペースは、一つのプロジェクト内で同じサービスを異なる用途で複数利用するためのエンティティです。 GS2 の各サービスはネームスペース単位で管理されます。ネームスペースが異なれば、同じサービスでも完全に独立したデータ空間として扱われます。 そのため、各サービスの利用を開始するにあたってネームスペースを作成する必要があります。 詳細 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceId string ※ ~ 1024文字 ネームスペース GRN ※ サーバーが自動で設定 name string ✓ ~ 128文字 ネームスペース名ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 description string ~ 1024文字 説明文 transactionSetting TransactionSetting ✓ トランザクション設定放置報酬の付与時のトランザクションの処理方法を制御する設定です。 receiveScript ScriptSetting 報酬を受け取ったときに実行するスクリプトの設定Script トリガーリファレンス - receive overrideAcquireActionsScriptId string ~ 1024文字 放置報酬の入手アクションを動的に決定するスクリプト GRN Script トリガーリファレンス - overrideAcquireActions logSetting LogSetting ログの出力設定放置報酬操作に関連するAPIリクエストおよびレスポンスログを出力するためのGS2-Logネームスペースを指定します。放置ステータスの作成、報酬の受け取り、タイミング問題のデバッグに役立ちます。 createdAt long ※ 現在時刻 作成日時UNIX 時間・ミリ秒※ サーバーが自動で設定 updatedAt long ※ 現在時刻 最終更新日時UNIX 時間・ミリ秒※ サーバーが自動で設定 revision long 0 0 ~ 9223372036854775805 リビジョン 関連するメソッド: describeNamespaces - ネームスペースの一覧を取得 createNamespace - ネームスペースを新規作成 getNamespace - ネームスペースを取得 updateNamespace - ネームスペースを更新 deleteNamespace - ネームスペースを削除 TransactionSetting トランザクション設定 /ja/api_reference/inbox/sdk/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/inbox/sdk/ モデル Namespace ネームスペース ネームスペースは、一つのプロジェクト内で同じサービスを異なる用途で複数利用するためのエンティティです。 GS2 の各サービスはネームスペース単位で管理されます。ネームスペースが異なれば、同じサービスでも完全に独立したデータ空間として扱われます。 そのため、各サービスの利用を開始するにあたってネームスペースを作成する必要があります。 詳細 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceId string ※ ~ 1024文字 ネームスペース GRN ※ サーバーが自動で設定 name string ✓ ~ 128文字 ネームスペース名ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 description string ~ 1024文字 説明文 isAutomaticDeletingEnabled bool false 自動削除有効にすると、メッセージが開封（既読）された後にユーザーのメッセージ一覧から自動的に削除されます。クライアントからの明示的な削除操作なしに受け取り済みメッセージを削除し、受信ボックスを整理します。無効の場合、開封済みメッセージは手動で削除されるまで一覧に残ります。 transactionSetting TransactionSetting トランザクション設定メッセージに添付された報酬を付与する際に使用される分散トランザクション処理の設定です。readAcquireActions を持つメッセージが開封されると、入手アクションが生成・実行されて報酬が配布されます。自動実行、アトミックコミット、非同期処理をサポートします。 receiveMessageScript ScriptSetting メッセージを受信したときに実行するスクリプトの設定Script トリガーリファレンス - receiveMessage readMessageScript ScriptSetting メッセージを開封したときに実行するスクリプトの設定Script トリガーリファレンス - readMessage deleteMessageScript ScriptSetting メッセージを削除したときに実行するスクリプトの設定Script トリガーリファレンス - deleteMessage receiveNotification NotificationSetting 受信通知ユーザーの受信ボックスに新しいメッセージが配信されたときにトリガーされるプッシュ通知設定です。GS2-Gatewayを使用してゲームクライアントにリアルタイム通知を送信し、ポーリングなしで新着メッセージインジケーターの表示や受信ボックスの更新をUIで行えるようにします。 logSetting LogSetting ログの出力設定メッセージ操作に関連するAPIリクエストおよびレスポンスログを出力するためのGS2-Logネームスペースを指定します。監査やデバッグ目的でメッセージの配信、開封、報酬受け取り、削除を追跡するのに役立ちます。 createdAt long ※ 現在時刻 作成日時UNIX 時間・ミリ秒※ サーバーが自動で設定 updatedAt long ※ 現在時刻 最終更新日時UNIX 時間・ミリ秒※ サーバーが自動で設定 revision long 0 0 ~ 9223372036854775805 リビジョン 関連するメソッド: describeNamespaces - ネームスペースの一覧を取得 createNamespace - ネームスペースを新規作成 getNamespace - ネームスペースを取得 updateNamespace - ネームスペースを更新 deleteNamespace - ネームスペースを削除 TransactionSetting トランザクション設定 /ja/api_reference/inventory/sdk/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/inventory/sdk/ モデル Namespace ネームスペース ネームスペースは、一つのプロジェクト内で同じサービスを異なる用途で複数利用するためのエンティティです。 GS2 の各サービスはネームスペース単位で管理されます。ネームスペースが異なれば、同じサービスでも完全に独立したデータ空間として扱われます。 そのため、各サービスの利用を開始するにあたってネームスペースを作成する必要があります。 詳細 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceId string ※ ~ 1024文字 ネームスペース GRN ※ サーバーが自動で設定 name string ✓ ~ 128文字 ネームスペース名ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 description string ~ 1024文字 説明文 transactionSetting TransactionSetting トランザクション設定アイテムの入手や消費などのインベントリ操作に対する分散トランザクション処理を設定します。シームレスな実行のための自動実行モード、複数リソースの一貫した操作のためのアトミックコミット、大規模な報酬配布のための非同期処理をサポートします。 acquireScript ScriptSetting アイテムを入手したときに実行するスクリプトの設定Script トリガーリファレンス - acquire overflowScript ScriptSetting 入手上限に当たって入手できなかったときに実行するスクリプトの設定Script トリガーリファレンス - overflowDone consumeScript ScriptSetting アイテムを消費するときに実行するスクリプトの設定Script トリガーリファレンス - consume simpleItemAcquireScript ScriptSetting シンプルアイテムを入手したときに実行するスクリプトの設定Script トリガーリファレンス - simpleItemAcquire simpleItemConsumeScript ScriptSetting シンプルアイテムを消費するときに実行するスクリプトの設定Script トリガーリファレンス - simpleItemConsume bigItemAcquireScript ScriptSetting 巨大アイテムを入手したときに実行するスクリプトの設定Script トリガーリファレンス - bigItemAcquire bigItemConsumeScript ScriptSetting 巨大アイテムを消費するときに実行するスクリプトの設定Script トリガーリファレンス - bigItemConsume logSetting LogSetting ログの出力設定インベントリ操作のAPIリクエスト・レスポンスログを出力するためのGS2-Logネームスペースを指定します。デバッグや分析のためにアイテムの入手、消費、容量変更の追跡に便利です。 createdAt long ※ 現在時刻 作成日時UNIX 時間・ミリ秒※ サーバーが自動で設定 updatedAt long ※ 現在時刻 最終更新日時UNIX 時間・ミリ秒※ サーバーが自動で設定 revision long 0 0 ~ 9223372036854775805 リビジョン 関連するメソッド: describeNamespaces - ネームスペースの一覧を取得 createNamespace - ネームスペースを新規作成 getNamespace - ネームスペースを取得 updateNamespace - ネームスペースを更新 deleteNamespace - ネームスペースを削除 TransactionSetting トランザクション設定 /ja/api_reference/job_queue/sdk/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/job_queue/sdk/ モデル Namespace ネームスペース ネームスペースは、一つのプロジェクト内で同じサービスを異なる用途で複数利用するためのエンティティです。 GS2 の各サービスはネームスペース単位で管理されます。ネームスペースが異なれば、同じサービスでも完全に独立したデータ空間として扱われます。 そのため、各サービスの利用を開始するにあたってネームスペースを作成する必要があります。 詳細 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceId string ※ ~ 1024文字 ネームスペース GRN ※ サーバーが自動で設定 name string ✓ ~ 128文字 ネームスペース名ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 description string ~ 1024文字 説明文 transactionSetting TransactionSetting トランザクション設定ジョブキュー操作時のトランザクションの処理方法を制御する設定です。 enableAutoRun bool false サーバーサイドで自動的にジョブを実行するか有効にすると、登録されたジョブはクライアントがポーリングして実行する必要なく、サーバーサイドで自動的に実行されます。無効の場合、クライアントは明示的にrun APIを呼び出してジョブを処理する必要があり、pushNotificationで新しいジョブの通知を受け取ることができます。 runNotification NotificationSetting ✓ 実行通知ジョブキューのジョブが実行された際のGS2-Gatewayを介したプッシュ通知設定です。通知にはジョブの結果が含まれ、クライアントは追加のAPI呼び出しなしに報酬の表示やエラー処理を行えます。 pushNotification NotificationSetting !{enableAutoRun} プッシュ通知新しいジョブがジョブキューに登録された際のGS2-Gatewayを介したプッシュ通知設定です。enableAutoRunが無効の場合のみ利用可能です。新しく登録されたジョブを処理するためにクライアントにrun APIの呼び出しを促すために使用されます。※ enableAutoRun が “false” であれば 有効 logSetting LogSetting ログの出力設定ジョブキュー操作のAPIリクエスト・レスポンスログを出力するためのGS2-Logネームスペースを指定します。デバッグや分析のためにジョブの登録、実行、リトライ、失敗の追跡に便利です。 createdAt long ※ 現在時刻 作成日時UNIX 時間・ミリ秒※ サーバーが自動で設定 updatedAt long ※ 現在時刻 最終更新日時UNIX 時間・ミリ秒※ サーバーが自動で設定 revision long 0 0 ~ 9223372036854775805 リビジョン 関連するメソッド: describeNamespaces - ネームスペースの一覧を取得 createNamespace - ネームスペースを新規作成 getNamespace - ネームスペースを取得 updateNamespace - ネームスペースを更新 deleteNamespace - ネームスペースを削除 TransactionSetting トランザクション設定 /ja/api_reference/key/sdk/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/key/sdk/ モデル Namespace ネームスペース ネームスペースは、一つのプロジェクト内で同じサービスを異なる用途で複数利用するためのエンティティです。 GS2 の各サービスはネームスペース単位で管理されます。ネームスペースが異なれば、同じサービスでも完全に独立したデータ空間として扱われます。 そのため、各サービスの利用を開始するにあたってネームスペースを作成する必要があります。 詳細 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceId string ※ ~ 1024文字 ネームスペース GRN ※ サーバーが自動で設定 name string ✓ ~ 128文字 ネームスペース名ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 description string ~ 1024文字 説明文 logSetting LogSetting ログの出力設定暗号鍵操作のAPIリクエスト・レスポンスログを出力するためのGS2-Logネームスペースを指定します。暗号化・復号リクエストなどの鍵使用の監査に便利です。 createdAt long ※ 現在時刻 作成日時UNIX 時間・ミリ秒※ サーバーが自動で設定 updatedAt long ※ 現在時刻 最終更新日時UNIX 時間・ミリ秒※ サーバーが自動で設定 revision long 0 0 ~ 9223372036854775805 リビジョン 関連するメソッド: describeNamespaces - ネームスペースの一覧を取得 createNamespace - ネームスペースを新規作成 getNamespace - ネームスペースを取得 updateNamespace - ネームスペースを更新 deleteNamespace - ネームスペースを削除 LogSetting ログの出力設定 /ja/api_reference/limit/sdk/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/limit/sdk/ モデル Namespace ネームスペース ネームスペースは、一つのプロジェクト内で同じサービスを異なる用途で複数利用するためのエンティティです。 GS2 の各サービスはネームスペース単位で管理されます。ネームスペースが異なれば、同じサービスでも完全に独立したデータ空間として扱われます。 そのため、各サービスの利用を開始するにあたってネームスペースを作成する必要があります。 詳細 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceId string ※ ~ 1024文字 ネームスペース GRN ※ サーバーが自動で設定 name string ✓ ~ 128文字 ネームスペース名ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 description string ~ 1024文字 説明文 transactionSetting TransactionSetting トランザクション設定カウントアップやカウンターリセットなどの回数制限操作時のトランザクションの処理方法を制御する設定です。 countUpScript ScriptSetting カウントアップするときに実行するスクリプトの設定Script トリガーリファレンス - countUp logSetting LogSetting ログの出力設定回数制限操作のAPIリクエスト・レスポンスログを出力するためのGS2-Logネームスペースを指定します。デバッグや分析のためにカウンターの増加、リセット、制限チェックの追跡に便利です。 createdAt long ※ 現在時刻 作成日時UNIX 時間・ミリ秒※ サーバーが自動で設定 updatedAt long ※ 現在時刻 最終更新日時UNIX 時間・ミリ秒※ サーバーが自動で設定 revision long 0 0 ~ 9223372036854775805 リビジョン 関連するメソッド: describeNamespaces - ネームスペースの一覧を取得 createNamespace - ネームスペースを新規作成 getNamespace - ネームスペースを取得 updateNamespace - ネームスペースを更新 deleteNamespace - ネームスペースを削除 TransactionSetting トランザクション設定 /ja/api_reference/lock/sdk/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/lock/sdk/ モデル Namespace ネームスペース ネームスペースは、一つのプロジェクト内で同じサービスを異なる用途で複数利用するためのエンティティです。 GS2 の各サービスはネームスペース単位で管理されます。ネームスペースが異なれば、同じサービスでも完全に独立したデータ空間として扱われます。 そのため、各サービスの利用を開始するにあたってネームスペースを作成する必要があります。 詳細 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceId string ※ ~ 1024文字 ネームスペース GRN ※ サーバーが自動で設定 name string ✓ ~ 128文字 ネームスペース名ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 description string ~ 1024文字 説明文 logSetting LogSetting ログの出力設定 createdAt long ※ 現在時刻 作成日時UNIX 時間・ミリ秒※ サーバーが自動で設定 updatedAt long ※ 現在時刻 最終更新日時UNIX 時間・ミリ秒※ サーバーが自動で設定 revision long 0 0 ~ 9223372036854775805 リビジョン 関連するメソッド: describeNamespaces - ネームスペースの一覧を取得 createNamespace - ネームスペースを新規作成 getNamespace - ネームスペースを取得 updateNamespace - ネームスペースを更新 deleteNamespace - ネームスペースを削除 LogSetting ログの出力設定 /ja/api_reference/log/sdk/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/log/sdk/ モデル Namespace ネームスペース ネームスペースは、一つのプロジェクト内で同じサービスを異なる用途で複数利用するためのエンティティです。 GS2 の各サービスはネームスペース単位で管理されます。ネームスペースが異なれば、同じサービスでも完全に独立したデータ空間として扱われます。 そのため、各サービスの利用を開始するにあたってネームスペースを作成する必要があります。 詳細 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceId string ※ ~ 1024文字 ネームスペース GRN ※ サーバーが自動で設定 name string ✓ ~ 128文字 ネームスペース名ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 description string ~ 1024文字 説明文 type 文字列列挙型 enum { “gs2”, “bigquery”, “firehose” } “gs2” ログの書き出し方法ログデータのエクスポート先を決定します。“gs2” はGS2のマネージドストレージにログを保存し、組み込みの検索・分析機能を利用できます。“bigquery” はGoogle BigQueryにログをエクスポートして高度な分析を行えます。“firehose” はAmazon Kinesis Data Firehoseにログをストリーミングし、S3やRedshiftなどのAWS送信先に配信します。定義説明“gs2”GS2による管理“bigquery”BigQuery への書き出し“firehose”Kinesis Firehose への書き出し gcpCredentialJson string {type} == “bigquery” ✓※ ~ 5120文字 GCPのクレデンシャルBigQueryへのログエクスポート時の認証に使用するGCPクレデンシャルJSONです。サービスアカウントには対象データセットに対するBigQuery Data Editor権限が必要です。※ type が “bigquery” であれば 必須 bigQueryDatasetName string {type} == “bigquery” ✓※ ~ 1024文字 BigQueryのデータセット名ログデータのエクスポート先となるBigQueryデータセットの名前です。データセットは提供されたクレデンシャルに関連付けられたGCPプロジェクト内にあらかじめ存在している必要があります。※ type が “bigquery” であれば 必須 logExpireDays int {type} in [“gs2”, “bigquery”] ✓※ 0 ~ 3650 ログの保存期間(日)ログデータを保持する日数です。この期間を超えたログは自動的に削除されます。エクスポート方法が “gs2” または “bigquery” の場合に適用されます。最大3650日（約10年）まで設定可能です。※ type が “gs2”,“bigquery"であれば 必須 awsRegion string {type} == “firehose” ✓※ ~ 256文字 AWSのリージョンKinesis Data Firehose配信ストリームが存在するAWSリージョンです（例：us-east-1、ap-northeast-1）。※ type が “firehose” であれば 必須 awsAccessKeyId string {type} == “firehose” ✓※ ~ 256文字 AWSのアクセスキーIDKinesis Data Firehoseへの認証に使用するAWSアクセスキーIDです。IAMユーザーには、指定されたFirehose配信ストリームへのレコード送信権限が必要です。※ type が “firehose” であれば 必須 awsSecretAccessKey string {type} == “firehose” ✓※ ~ 256文字 AWSのシークレットアクセスキーKinesis Data Firehose認証のためにアクセスキーIDと対になるAWSシークレットアクセスキーです。※ type が “firehose” であれば 必須 firehoseStreamName string {type} == “firehose” ✓※ ~ 256文字 Kinesis Firehose のストリーム名ログデータの送信先となるKinesis Data Firehose配信ストリームの名前です。※ type が “firehose” であれば 必須 firehoseCompressData 文字列列挙型 /ja/api_reference/login_reward/sdk/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/login_reward/sdk/ モデル Namespace ネームスペース ネームスペースは、一つのプロジェクト内で同じサービスを異なる用途で複数利用するためのエンティティです。 GS2 の各サービスはネームスペース単位で管理されます。ネームスペースが異なれば、同じサービスでも完全に独立したデータ空間として扱われます。 そのため、各サービスの利用を開始するにあたってネームスペースを作成する必要があります。 詳細 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceId string ※ ~ 1024文字 ネームスペース GRN ※ サーバーが自動で設定 name string ✓ ~ 128文字 ネームスペース名ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 description string ~ 1024文字 説明文 transactionSetting TransactionSetting ✓ トランザクション設定このネームスペース内で報酬トランザクションがどのように実行されるかの設定。 receiveScript ScriptSetting 報酬を受け取るときに実行するスクリプトの設定Script トリガーリファレンス - receive logSetting LogSetting ログの出力設定APIリクエスト・レスポンスのログを GS2-Log に出力するための設定。設定すると、ログインボーナスの操作（受け取り、取り逃がし救済など）がモニタリングと分析のためにログ出力されます。 createdAt long ※ 現在時刻 作成日時UNIX 時間・ミリ秒※ サーバーが自動で設定 updatedAt long ※ 現在時刻 最終更新日時UNIX 時間・ミリ秒※ サーバーが自動で設定 revision long 0 0 ~ 9223372036854775805 リビジョン 関連するメソッド: describeNamespaces - ネームスペースの一覧を取得 createNamespace - ネームスペースを新規作成 getNamespace - ネームスペースを取得 updateNamespace - ネームスペースを更新 deleteNamespace - ネームスペースを削除 TransactionSetting トランザクション設定 /ja/api_reference/lottery/sdk/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/lottery/sdk/ モデル Namespace ネームスペース ネームスペースは、一つのプロジェクト内で同じサービスを異なる用途で複数利用するためのエンティティです。 GS2 の各サービスはネームスペース単位で管理されます。ネームスペースが異なれば、同じサービスでも完全に独立したデータ空間として扱われます。 そのため、各サービスの利用を開始するにあたってネームスペースを作成する必要があります。 詳細 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceId string ※ ~ 1024文字 ネームスペース GRN ※ サーバーが自動で設定 name string ✓ ~ 128文字 ネームスペース名ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 description string ~ 1024文字 説明文 transactionSetting TransactionSetting ✓ トランザクション設定抽選操作時のトランザクションの処理方法を制御する設定です。抽選では入手アクションを通じてユーザーに景品を付与するトランザクションが発行されます。 lotteryTriggerScriptId string ~ 1024文字 抽選を実行した際に呼び出される GS2-Script のスクリプト GRN Script トリガーリファレンス - lottery logSetting LogSetting ログの出力設定抽選操作のAPIリクエスト・レスポンスログを出力するためのGS2-Logネームスペースを指定します。デバッグや分析のために抽選結果、景品配布、ボックスガチャの状態追跡に便利です。 createdAt long ※ 現在時刻 作成日時UNIX 時間・ミリ秒※ サーバーが自動で設定 updatedAt long ※ 現在時刻 最終更新日時UNIX 時間・ミリ秒※ サーバーが自動で設定 revision long 0 0 ~ 9223372036854775805 リビジョン 関連するメソッド: describeNamespaces - ネームスペースの一覧を取得 createNamespace - ネームスペースを新規作成 getNamespace - ネームスペースを取得 updateNamespace - ネームスペースを更新 deleteNamespace - ネームスペースを削除 TransactionSetting トランザクション設定 /ja/api_reference/matchmaking/sdk/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/matchmaking/sdk/ モデル Namespace ネームスペース ネームスペースは、一つのプロジェクト内で同じサービスを異なる用途で複数利用するためのエンティティです。 GS2 の各サービスはネームスペース単位で管理されます。ネームスペースが異なれば、同じサービスでも完全に独立したデータ空間として扱われます。 そのため、各サービスの利用を開始するにあたってネームスペースを作成する必要があります。 詳細 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceId string ※ ~ 1024文字 ネームスペース GRN ※ サーバーが自動で設定 name string ✓ ~ 128文字 ネームスペース名ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 description string ~ 1024文字 説明文 transactionSetting TransactionSetting トランザクション設定マッチメイキング操作時のトランザクションの処理方法を制御する設定です。 enableRating bool false レーティング計算機能の有効化Glicko-2 ベースのレーティング計算機能を有効にするかどうか。有効にすると、プレイヤーは Vote システムを通じて対戦結果を送信し、レーティングが自動的に更新されます。RatingModel マスターデータの設定が必要です。デフォルトは false です。 enableDisconnectDetection 文字列列挙型 enum { “disable”, “enable” } “disable” 切断検知マッチメイキング中のプレイヤーが待機中であることを定期的に報告する必要があるかを制御します。有効にすると、プレイヤーが設定されたタイムアウト期間内にキープアライブを送信しない場合、ギャザリングから自動的に退出処理されます。これにより「ゴースト」プレイヤーがマッチメイキングの完了をブロックすることを防ぎます。デフォルトは “disable” です。定義説明“disable”無効“enable”有効 disconnectDetectionTimeoutSeconds int {enableDisconnectDetection} == “enable” ✓※ 15 ~ 600 切断検知タイムアウト（秒）キープアライブ報告なしにプレイヤーを切断とみなしギャザリングから退出させるまでの待機秒数。切断検知が有効な場合のみ適用されます。15 から 600 秒の範囲で指定します。※ enableDisconnectDetection が “enable” であれば 必須 createGatheringTriggerType 文字列列挙型 /ja/api_reference/mega_field/sdk/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/mega_field/sdk/ モデル Namespace ネームスペース ネームスペースは、一つのプロジェクト内で同じサービスを異なる用途で複数利用するためのエンティティです。 GS2 の各サービスはネームスペース単位で管理されます。ネームスペースが異なれば、同じサービスでも完全に独立したデータ空間として扱われます。 そのため、各サービスの利用を開始するにあたってネームスペースを作成する必要があります。 詳細 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceId string ※ ~ 1024文字 ネームスペース GRN ※ サーバーが自動で設定 name string ✓ ~ 128文字 ネームスペース名ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 description string ~ 1024文字 説明文 logSetting LogSetting ログの出力設定 createdAt long ※ 現在時刻 作成日時UNIX 時間・ミリ秒※ サーバーが自動で設定 updatedAt long ※ 現在時刻 最終更新日時UNIX 時間・ミリ秒※ サーバーが自動で設定 revision long 0 0 ~ 9223372036854775805 リビジョン 関連するメソッド: describeNamespaces - ネームスペースの一覧を取得 createNamespace - ネームスペースを新規作成 getNamespace - ネームスペースを取得 updateNamespace - ネームスペースを更新 deleteNamespace - ネームスペースを削除 LogSetting ログの出力設定 /ja/api_reference/mission/sdk/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/mission/sdk/ モデル Namespace ネームスペース ネームスペースは、一つのプロジェクト内で同じサービスを異なる用途で複数利用するためのエンティティです。 GS2 の各サービスはネームスペース単位で管理されます。ネームスペースが異なれば、同じサービスでも完全に独立したデータ空間として扱われます。 そのため、各サービスの利用を開始するにあたってネームスペースを作成する必要があります。 詳細 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceId string ※ ~ 1024文字 ネームスペース GRN ※ サーバーが自動で設定 name string ✓ ~ 128文字 ネームスペース名ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 description string ~ 1024文字 説明文 transactionSetting TransactionSetting ✓ トランザクション設定ミッション達成報酬の付与時に使用される分散トランザクションの設定です。 missionCompleteScript ScriptSetting ミッションを達成したときに実行するスクリプトの設定Script トリガーリファレンス - missionComplete counterIncrementScript ScriptSetting カウンターが上昇したときに実行するスクリプトの設定Script トリガーリファレンス - counterIncrement receiveRewardsScript ScriptSetting 報酬を受け取ったときに実行するスクリプトの設定Script トリガーリファレンス - receiveRewards completeNotification NotificationSetting ✓ ミッションのタスクを達成したときのプッシュ通知ミッションタスクの達成条件が満たされた際に GS2-Gateway を通じて配信されるプッシュ通知の設定です。ゲームクライアントが達成状況を即座にUIに反映できるようにします。 logSetting LogSetting ログの出力設定このネームスペースに対するAPIリクエスト・レスポンスログの出力先となる GS2-Log のネームスペースを指定します。カウンターの増加、ミッション達成、報酬受け取りのデバッグに役立ちます。 createdAt long ※ 現在時刻 作成日時UNIX 時間・ミリ秒※ サーバーが自動で設定 updatedAt long ※ 現在時刻 最終更新日時UNIX 時間・ミリ秒※ サーバーが自動で設定 revision long 0 0 ~ 9223372036854775805 リビジョン 関連するメソッド: describeNamespaces - ネームスペースの一覧を取得 createNamespace - ネームスペースを新規作成 getNamespace - ネームスペースを取得 updateNamespace - ネームスペースを更新 deleteNamespace - ネームスペースを削除 TransactionSetting トランザクション設定 /ja/api_reference/money/sdk/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/money/sdk/ モデル Namespace ネームスペース ネームスペースは、一つのプロジェクト内で同じサービスを異なる用途で複数利用するためのエンティティです。 GS2 の各サービスはネームスペース単位で管理されます。ネームスペースが異なれば、同じサービスでも完全に独立したデータ空間として扱われます。 そのため、各サービスの利用を開始するにあたってネームスペースを作成する必要があります。 詳細 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceId string ※ ~ 1024文字 ネームスペース GRN ※ サーバーが自動で設定 name string ✓ ~ 128文字 ネームスペース名ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 description string ~ 1024文字 説明文 transactionSetting TransactionSetting トランザクション設定マネー操作時のトランザクションの処理方法を制御する設定です。 priority 文字列列挙型 enum { “free”, “paid” } ✓ 消費優先度ウォレットから通貨を消費する際に、有償通貨と無償通貨のどちらを先に消費するかを決定します。“free” に設定すると、無償通貨（単価=0）が先に消費され、次に単価の高い有償通貨が消費されます。“paid” に設定すると、単価の高い有償通貨が先に消費され、次に無償通貨が消費されます。定義説明“free”無償通貨を優先して使用する“paid”有償通貨を優先して使用する shareFree bool ✓ 無償通貨の共有無償通貨をすべてのウォレットスロット間で共有するかどうか。有効にすると、無償通貨の残高がスロット0から他のすべてのスロットに同期され、異なるプラットフォームのプレイヤーが同じ無償通貨プールを共有できます。有償通貨はこの設定に関係なく、常にスロットごとに別々に管理されます。 currency 文字列列挙型 enum { “JPY”, “USD”, “TWD” } ✓ 通貨の種類価格設定と資金決済法の遵守計算に使用される実世界の通貨。有償通貨の価値追跡と返金義務の計算における測定単位を決定します。ネームスペース作成後は変更できません。定義説明“JPY”日本円“USD”米ドル“TWD”台湾ドル appleKey string ~ 1024文字 Apple AppStore のバンドルIDApple AppStore の購入レシートを検証するために使用される iOS アプリの Bundle ID。iOS デバイスからのアプリ内購入を受け付ける場合に必要です。 googleKey string ~ 5120文字 Google PlayStore の秘密鍵Google Play の購入レシートを検証するために使用されるサービスアカウントの秘密鍵。Android デバイスからのアプリ内購入を受け付ける場合に必要です。 enableFakeReceipt bool false フェイクレシートの有効化テスト目的で Unity Editor が生成するフェイク購入レシートを受け付けるかどうか。開発・テスト環境でのみ有効にし、不正な通貨付与を防ぐため本番環境では必ず無効にする必要があります。デフォルトは false です。 createWalletScript ScriptSetting ウォレット作成時スクリプト新しいウォレットが初めて作成されたときに実行するスクリプト。ウォレットは初回アクセス時に自動作成されるため、プレイヤーが通貨システムに初めてアクセスした際にこのスクリプトがトリガーされます。 depositScript ScriptSetting 残高加算時スクリプトウォレットに通貨が加算されたときに実行するスクリプト。有償通貨の加算（ストア購入）と無償通貨の付与の両方でトリガーされます。 withdrawScript ScriptSetting 残高消費時スクリプトウォレットから通貨が消費されたときに実行するスクリプト。消費優先度の設定に従って有償通貨または無償通貨が差し引かれる際にトリガーされます。 balance double 0. /ja/api_reference/money2/sdk/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/money2/sdk/ モデル Namespace ネームスペース ネームスペースは、一つのプロジェクト内で同じサービスを異なる用途で複数利用するためのエンティティです。 GS2 の各サービスはネームスペース単位で管理されます。ネームスペースが異なれば、同じサービスでも完全に独立したデータ空間として扱われます。 そのため、各サービスの利用を開始するにあたってネームスペースを作成する必要があります。 詳細 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceId string ※ ~ 1024文字 ネームスペース GRN ※ サーバーが自動で設定 name string ✓ ~ 128文字 ネームスペース名ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 description string ~ 1024文字 説明文 transactionSetting TransactionSetting トランザクション設定通貨の入金・出金時に使用される分散トランザクションの設定です。 currencyUsagePriority 文字列列挙型 enum { “PrioritizeFree”, “PrioritizePaid” } ✓ 消費優先度ウォレットから出金する際に有償通貨と無償通貨のどちらを先に消費するかを決定します。“PrioritizeFree” は無償通貨を優先し、“PrioritizePaid” は有償通貨を優先します。定義説明“PrioritizeFree”無償通貨を優先して使用する“PrioritizePaid”有償通貨を優先して使用する sharedFreeCurrency bool ✓ 無償通貨を異なるスロットで共有するか有効にすると、無償通貨の残高がすべてのウォレットスロット（プラットフォーム）間で共有されます。有償通貨はスロットごとに分離されたままです。この設定はネームスペース作成時のみ設定可能で、後から変更できません。 platformSetting PlatformSetting ✓ ストアプラットフォーム設定サポートされている各ストアプラットフォーム（Apple App Store、Google Play、テスト用Fake）の設定です。各プラットフォームでのレシート検証に必要な認証情報やキーを含みます。 depositBalanceScript ScriptSetting ウォレット残高を加算したときに実行するスクリプトの設定Script トリガーリファレンス - deposit withdrawBalanceScript ScriptSetting ウォレット残高を消費したときに実行するスクリプトの設定Script トリガーリファレンス - withdraw verifyReceiptScript ScriptSetting レシート検証を実行したときに実行するスクリプトの設定Script トリガーリファレンス - verifyReceipt subscribeScript string ~ 1024文字 期間課金を新規契約するときに実行する GS2-Script スクリプトGRN(ユーザーの紐づけ変更時には呼び出されない/一度契約失効後に再度契約した場合も呼び出される)Script トリガーリファレンス - subscribe renewScript string ~ 1024文字 期間課金を更新するときに実行する GS2-Script スクリプトGRNScript トリガーリファレンス - renew unsubscribeScript string ~ 1024文字 期間課金を解約するときに実行する GS2-Script スクリプトGRN(ユーザーの紐づけ変更時には呼び出されない)Script トリガーリファレンス - unsubscribe takeOverScript ScriptSetting 期間課金に紐づけられたユーザーを変更するときに実行するスクリプトの設定Script トリガーリファレンス - takeOver changeSubscriptionStatusNotification NotificationSetting 期間課金の契約状況が変化したときのプッシュ通知サブスクリプションのステータスが変化した際（有効化、更新、解約、期限切れ、取り消しなど）に GS2-Gateway を通じて配信されるプッシュ通知の設定です。ゲームクライアントがサブスクリプション状態の変化にリアルタイムで対応できるようにします。 logSetting LogSetting ログの出力設定このネームスペースに対するAPIリクエスト・レスポンスログの出力先となる GS2-Log のネームスペースを指定します。入金、出金、レシート検証、サブスクリプションイベントの追跡に役立ちます。 createdAt long ※ 現在時刻 作成日時UNIX 時間・ミリ秒※ サーバーが自動で設定 updatedAt long ※ 現在時刻 最終更新日時UNIX 時間・ミリ秒※ サーバーが自動で設定 revision long 0 0 ~ 9223372036854775805 リビジョン 関連するメソッド: describeNamespaces - ネームスペースの一覧を取得 createNamespace - ネームスペースを新規作成 getNamespace - ネームスペースを取得 updateNamespace - ネームスペースを更新 deleteNamespace - ネームスペースを削除 TransactionSetting トランザクション設定 /ja/api_reference/news/sdk/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/news/sdk/ モデル Namespace ネームスペース ネームスペースは、一つのプロジェクト内で同じサービスを異なる用途で複数利用するためのエンティティです。 GS2 の各サービスはネームスペース単位で管理されます。ネームスペースが異なれば、同じサービスでも完全に独立したデータ空間として扱われます。 そのため、各サービスの利用を開始するにあたってネームスペースを作成する必要があります。 詳細 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceId string ※ ~ 1024文字 ネームスペース GRN ※ サーバーが自動で設定 name string ✓ ~ 128文字 ネームスペース名ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 description string ~ 1024文字 説明文 version string ~ 1024文字 バージョンデプロイされたニュースコンテンツの現在のバージョン識別子。新しい記事データがアップロードまたは GitHub リポジトリから同期されると自動的に更新されます。この値は機密情報であり、クライアントには公開されません。 logSetting LogSetting ログの出力設定APIリクエスト・レスポンスのログを GS2-Log に出力するための設定。設定すると、ニュース操作（記事取得、コンテンツ生成、Cookie 発行など）がモニタリングと分析のためにログ出力されます。 createdAt long ※ 現在時刻 作成日時UNIX 時間・ミリ秒※ サーバーが自動で設定 updatedAt long ※ 現在時刻 最終更新日時UNIX 時間・ミリ秒※ サーバーが自動で設定 revision long 0 0 ~ 9223372036854775805 リビジョン 関連するメソッド: describeNamespaces - ネームスペースの一覧を取得 createNamespace - ネームスペースを新規作成 getNamespace - ネームスペースを取得 updateNamespace - ネームスペースを更新 deleteNamespace - ネームスペースを削除 LogSetting ログの出力設定 /ja/api_reference/quest/sdk/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/quest/sdk/ モデル Namespace ネームスペース ネームスペースは、一つのプロジェクト内で同じサービスを異なる用途で複数利用するためのエンティティです。 GS2 の各サービスはネームスペース単位で管理されます。ネームスペースが異なれば、同じサービスでも完全に独立したデータ空間として扱われます。 そのため、各サービスの利用を開始するにあたってネームスペースを作成する必要があります。 詳細 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceId string ※ ~ 1024文字 ネームスペース GRN ※ サーバーが自動で設定 name string ✓ ~ 128文字 ネームスペース名ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 description string ~ 1024文字 説明文 transactionSetting TransactionSetting ✓ トランザクション設定クエスト報酬の付与時のトランザクションの処理方法を制御する設定です。 startQuestScript ScriptSetting クエスト開始したときに実行するスクリプトの設定Script トリガーリファレンス - startQuest completeQuestScript ScriptSetting クエストクリアしたときに実行するスクリプトの設定Script トリガーリファレンス - completeQuest failedQuestScript ScriptSetting クエスト失敗したときに実行するスクリプトの設定Script トリガーリファレンス - failedQuest logSetting LogSetting ログの出力設定APIリクエスト・レスポンスログの出力先となる GS2-Log のネームスペースを指定します。クエストの開始・クリア・失敗イベントの追跡に使用されます。 createdAt long ※ 現在時刻 作成日時UNIX 時間・ミリ秒※ サーバーが自動で設定 updatedAt long ※ 現在時刻 最終更新日時UNIX 時間・ミリ秒※ サーバーが自動で設定 revision long 0 0 ~ 9223372036854775805 リビジョン 関連するメソッド: describeNamespaces - ネームスペースの一覧を取得 createNamespace - ネームスペースを新規作成 getNamespace - ネームスペースを取得 updateNamespace - ネームスペースを更新 deleteNamespace - ネームスペースを削除 TransactionSetting トランザクション設定 /ja/api_reference/ranking/sdk/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/ranking/sdk/ モデル Namespace ネームスペース ネームスペースは、一つのプロジェクト内で同じサービスを異なる用途で複数利用するためのエンティティです。 GS2 の各サービスはネームスペース単位で管理されます。ネームスペースが異なれば、同じサービスでも完全に独立したデータ空間として扱われます。 そのため、各サービスの利用を開始するにあたってネームスペースを作成する必要があります。 詳細 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceId string ※ ~ 1024文字 ネームスペース GRN ※ サーバーが自動で設定 name string ✓ ~ 128文字 ネームスペース名ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 description string ~ 1024文字 説明文 transactionSetting TransactionSetting トランザクション設定ランキング操作時のトランザクションの処理方法を制御する設定です。 lastCalculatedAts List<CalculatedAt> [] 0 ~ 1000 items 最終集計日時リスト各カテゴリーのグローバルランキングが最後に集計された日時を記録するタイムスタンプのリスト。カテゴリーごとに1エントリが維持され、再集計が完了すると対応するエントリが更新されます（新規カテゴリーの場合は新しいエントリが追加されます）。 logSetting LogSetting ログ出力設定ランキング関連の操作ログを GS2-Log に出力するための設定。設定すると、スコア登録、ランキング取得、購読変更などのアクションが分析や監査のために記録されます。 createdAt long ※ 現在時刻 作成日時UNIX 時間・ミリ秒※ サーバーが自動で設定 updatedAt long ※ 現在時刻 最終更新日時UNIX 時間・ミリ秒※ サーバーが自動で設定 revision long 0 0 ~ 9223372036854775805 リビジョン 関連するメソッド: describeNamespaces - ネームスペースの一覧を取得 createNamespace - ネームスペースを新規作成 getNamespace - ネームスペースを取得 updateNamespace - ネームスペースを更新 deleteNamespace - ネームスペースを削除 TransactionSetting トランザクション設定 /ja/api_reference/ranking2/sdk/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/ranking2/sdk/ モデル Namespace ネームスペース ネームスペースは、一つのプロジェクト内で同じサービスを異なる用途で複数利用するためのエンティティです。 GS2 の各サービスはネームスペース単位で管理されます。ネームスペースが異なれば、同じサービスでも完全に独立したデータ空間として扱われます。 そのため、各サービスの利用を開始するにあたってネームスペースを作成する必要があります。 詳細 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceId string ※ ~ 1024文字 ネームスペース GRN ※ サーバーが自動で設定 name string ✓ ~ 128文字 ネームスペース名ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 description string ~ 1024文字 説明文 transactionSetting TransactionSetting ✓ トランザクション設定ランキング報酬の付与に使用される分散トランザクションの設定です。入手アクションを自動実行するオートラン、全体の成否を保証するアトミックコミットをサポートします。 logSetting LogSetting ログの出力設定APIリクエスト・レスポンスログの出力先となる GS2-Log のネームスペースを指定します。スコア登録やランキング報酬配布の追跡に使用されます。 createdAt long ※ 現在時刻 作成日時UNIX 時間・ミリ秒※ サーバーが自動で設定 updatedAt long ※ 現在時刻 最終更新日時UNIX 時間・ミリ秒※ サーバーが自動で設定 revision long 0 0 ~ 9223372036854775805 リビジョン 関連するメソッド: describeNamespaces - ネームスペースの一覧を取得 createNamespace - ネームスペースを新規作成 getNamespace - ネームスペースを取得 updateNamespace - ネームスペースを更新 deleteNamespace - ネームスペースを削除 TransactionSetting トランザクション設定 /ja/api_reference/realtime/sdk/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/realtime/sdk/ モデル Namespace ネームスペース ネームスペースは、一つのプロジェクト内で同じサービスを異なる用途で複数利用するためのエンティティです。 GS2 の各サービスはネームスペース単位で管理されます。ネームスペースが異なれば、同じサービスでも完全に独立したデータ空間として扱われます。 そのため、各サービスの利用を開始するにあたってネームスペースを作成する必要があります。 詳細 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceId string ※ ~ 1024文字 ネームスペース GRN ※ サーバーが自動で設定 name string ✓ ~ 128文字 ネームスペース名ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 description string ~ 1024文字 説明文 transactionSetting TransactionSetting トランザクション設定リアルタイム操作時のトランザクションの処理方法を制御する設定です。 serverType 文字列列挙型 enum { “relay” } ✓ サーバの種類リアルタイム通信のためにプロビジョニングするゲームサーバーのタイプ。現在は “relay” モードをサポートしており、接続されたゲームクライアント間でメッセージを転送するパケットリレーサーバーを提供します。定義説明“relay”パケットリレー serverSpec 文字列列挙型 enum { “realtime1.nano” } ✓ サーバのスペックプロビジョニングされるゲームサーバーのハードウェアスペックティア。各ルームのサーバーインスタンスに割り当てられるコンピューティングリソース（CPU、メモリ）を決定します。現在 “realtime1.nano” をサポートしています。定義説明“realtime1.nano”realtime1.nano createNotification NotificationSetting ルーム作成完了通知ルームのプロビジョニングが完了し、接続可能になったときにトリガーされるプッシュ通知設定。ルーム作成は非同期で行われ（IPアドレス、ポート、暗号鍵は少し遅れて割り当てられる）、この通知によりクライアントにルームが接続受付可能になったことを通知します。 logSetting LogSetting ログ出力設定リアルタイム関連の操作ログを GS2-Log に出力するための設定。設定すると、ルーム作成、接続イベント、メッセージリレーのアクティビティなどが分析やデバッグのために記録されます。 createdAt long ※ 現在時刻 作成日時UNIX 時間・ミリ秒※ サーバーが自動で設定 updatedAt long ※ 現在時刻 最終更新日時UNIX 時間・ミリ秒※ サーバーが自動で設定 revision long 0 0 ~ 9223372036854775805 リビジョン 関連するメソッド: describeNamespaces - ネームスペースの一覧を取得 createNamespace - ネームスペースを新規作成 getNamespace - ネームスペースを取得 updateNamespace - ネームスペースを更新 deleteNamespace - ネームスペースを削除 TransactionSetting トランザクション設定 /ja/api_reference/schedule/sdk/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/schedule/sdk/ モデル Namespace ネームスペース ネームスペースは、一つのプロジェクト内で同じサービスを異なる用途で複数利用するためのエンティティです。 GS2 の各サービスはネームスペース単位で管理されます。ネームスペースが異なれば、同じサービスでも完全に独立したデータ空間として扱われます。 そのため、各サービスの利用を開始するにあたってネームスペースを作成する必要があります。 詳細 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceId string ※ ~ 1024文字 ネームスペース GRN ※ サーバーが自動で設定 name string ✓ ~ 128文字 ネームスペース名ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 description string ~ 1024文字 説明文 transactionSetting TransactionSetting トランザクション設定スケジュール操作時のトランザクションの処理方法を制御する設定です。 logSetting LogSetting ログ出力設定スケジュール関連の操作ログを GS2-Log に出力するための設定。設定すると、イベントクエリ、トリガー発動、トリガー削除などのアクションが分析や監査のために記録されます。 createdAt long ※ 現在時刻 作成日時UNIX 時間・ミリ秒※ サーバーが自動で設定 updatedAt long ※ 現在時刻 最終更新日時UNIX 時間・ミリ秒※ サーバーが自動で設定 revision long 0 0 ~ 9223372036854775805 リビジョン 関連するメソッド: describeNamespaces - ネームスペースの一覧を取得 createNamespace - ネームスペースを新規作成 getNamespace - ネームスペースを取得 updateNamespace - ネームスペースを更新 deleteNamespace - ネームスペースを削除 TransactionSetting トランザクション設定 /ja/api_reference/script/sdk/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/script/sdk/ モデル Namespace ネームスペース ネームスペースは、一つのプロジェクト内で同じサービスを異なる用途で複数利用するためのエンティティです。 GS2 の各サービスはネームスペース単位で管理されます。ネームスペースが異なれば、同じサービスでも完全に独立したデータ空間として扱われます。 そのため、各サービスの利用を開始するにあたってネームスペースを作成する必要があります。 詳細 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceId string ※ ~ 1024文字 ネームスペース GRN ※ サーバーが自動で設定 name string ✓ ~ 128文字 ネームスペース名ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 description string ~ 1024文字 説明文 transactionSetting TransactionSetting トランザクション設定スクリプトがトランザクションアクションを返す際に使用される分散トランザクションの設定です。 logSetting LogSetting ログの出力設定APIリクエスト・レスポンスログの出力先となる GS2-Log のネームスペースを指定します。スクリプトの呼び出しとその結果の追跡に使用されます。 createdAt long ※ 現在時刻 作成日時UNIX 時間・ミリ秒※ サーバーが自動で設定 updatedAt long ※ 現在時刻 最終更新日時UNIX 時間・ミリ秒※ サーバーが自動で設定 revision long 0 0 ~ 9223372036854775805 リビジョン 関連するメソッド: describeNamespaces - ネームスペースの一覧を取得 createNamespace - ネームスペースを新規作成 getNamespace - ネームスペースを取得 updateNamespace - ネームスペースを更新 deleteNamespace - ネームスペースを削除 TransactionSetting トランザクション設定 /ja/api_reference/season_rating/sdk/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/season_rating/sdk/ モデル Namespace ネームスペース ネームスペースは、一つのプロジェクト内で同じサービスを異なる用途で複数利用するためのエンティティです。 GS2 の各サービスはネームスペース単位で管理されます。ネームスペースが異なれば、同じサービスでも完全に独立したデータ空間として扱われます。 そのため、各サービスの利用を開始するにあたってネームスペースを作成する必要があります。 詳細 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceId string ※ ~ 1024文字 ネームスペース GRN ※ サーバーが自動で設定 name string ✓ ~ 128文字 ネームスペース名ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 description string ~ 1024文字 説明文 transactionSetting TransactionSetting ✓ トランザクション設定シーズンレーティング結果の適用時に使用されるトランザクション処理の設定。 logSetting LogSetting ログ出力設定投票用紙の発行、投票の提出、レーティング計算などのシーズンレーティング操作のログ出力設定。設定した場合、操作ログが指定した GS2-Log ネームスペースに出力されます。 createdAt long ※ 現在時刻 作成日時UNIX 時間・ミリ秒※ サーバーが自動で設定 updatedAt long ※ 現在時刻 最終更新日時UNIX 時間・ミリ秒※ サーバーが自動で設定 revision long 0 0 ~ 9223372036854775805 リビジョン 関連するメソッド: describeNamespaces - ネームスペースの一覧を取得 createNamespace - ネームスペースを新規作成 getNamespace - ネームスペースを取得 updateNamespace - ネームスペースを更新 deleteNamespace - ネームスペースを削除 TransactionSetting トランザクション設定 /ja/api_reference/serial_key/sdk/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/serial_key/sdk/ モデル Namespace ネームスペース ネームスペースは、一つのプロジェクト内で同じサービスを異なる用途で複数利用するためのエンティティです。 GS2 の各サービスはネームスペース単位で管理されます。ネームスペースが異なれば、同じサービスでも完全に独立したデータ空間として扱われます。 そのため、各サービスの利用を開始するにあたってネームスペースを作成する必要があります。 詳細 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceId string ※ ~ 1024文字 ネームスペース GRN ※ サーバーが自動で設定 name string ✓ ~ 128文字 ネームスペース名ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 description string ~ 1024文字 説明文 transactionSetting TransactionSetting トランザクション設定シリアルキー操作時のトランザクションの処理方法を制御する設定です。 logSetting LogSetting ログの出力設定シリアルコードの発行・使用に関する API リクエスト・レスポンスログを出力する GS2-Log のネームスペースを指定します。 createdAt long ※ 現在時刻 作成日時UNIX 時間・ミリ秒※ サーバーが自動で設定 updatedAt long ※ 現在時刻 最終更新日時UNIX 時間・ミリ秒※ サーバーが自動で設定 revision long 0 0 ~ 9223372036854775805 リビジョン 関連するメソッド: describeNamespaces - ネームスペースの一覧を取得 createNamespace - ネームスペースを新規作成 getNamespace - ネームスペースを取得 updateNamespace - ネームスペースを更新 deleteNamespace - ネームスペースを削除 TransactionSetting トランザクション設定 /ja/api_reference/showcase/sdk/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/showcase/sdk/ モデル Namespace ネームスペース ネームスペースは、一つのプロジェクト内で同じサービスを異なる用途で複数利用するためのエンティティです。 GS2 の各サービスはネームスペース単位で管理されます。ネームスペースが異なれば、同じサービスでも完全に独立したデータ空間として扱われます。 そのため、各サービスの利用を開始するにあたってネームスペースを作成する必要があります。 詳細 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceId string ※ ~ 1024文字 ネームスペース GRN ※ サーバーが自動で設定 name string ✓ ~ 128文字 ネームスペース名ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 description string ~ 1024文字 説明文 transactionSetting TransactionSetting ✓ トランザクション設定陳列棚操作時のトランザクションの処理方法を制御する設定です。 buyScript ScriptSetting 購入を実行しようとしたときに実行するスクリプトの設定Script トリガーリファレンス - buy logSetting LogSetting ログの出力設定陳列棚の閲覧や商品購入に関する API リクエスト・レスポンスログを出力する GS2-Log のネームスペースを指定します。 createdAt long ※ 現在時刻 作成日時UNIX 時間・ミリ秒※ サーバーが自動で設定 updatedAt long ※ 現在時刻 最終更新日時UNIX 時間・ミリ秒※ サーバーが自動で設定 revision long 0 0 ~ 9223372036854775805 リビジョン 関連するメソッド: describeNamespaces - ネームスペースの一覧を取得 createNamespace - ネームスペースを新規作成 getNamespace - ネームスペースを取得 updateNamespace - ネームスペースを更新 deleteNamespace - ネームスペースを削除 TransactionSetting トランザクション設定 /ja/api_reference/skill_tree/sdk/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/skill_tree/sdk/ モデル Namespace ネームスペース ネームスペースは、一つのプロジェクト内で同じサービスを異なる用途で複数利用するためのエンティティです。 GS2 の各サービスはネームスペース単位で管理されます。ネームスペースが異なれば、同じサービスでも完全に独立したデータ空間として扱われます。 そのため、各サービスの利用を開始するにあたってネームスペースを作成する必要があります。 詳細 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceId string ※ ~ 1024文字 ネームスペース GRN ※ サーバーが自動で設定 name string ✓ ~ 128文字 ネームスペース名ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 description string ~ 1024文字 説明文 transactionSetting TransactionSetting ✓ トランザクション設定ノード解放・拘束操作の実行時に使用されるトランザクション処理の設定。消費アクション（解放コスト）と入手アクション（拘束時の返却）が GS2 トランザクションシステムを通じてどのように処理されるかを定義します。 releaseScript ScriptSetting ノード開放時に実行するスクリプトの設定Script トリガーリファレンス - release restrainScript ScriptSetting ノード開放状態を未解放状態に戻すときに実行するスクリプトの設定Script トリガーリファレンス - restrain logSetting LogSetting ログ出力設定ノード解放・拘束・リセットなどのスキルツリー操作のログ出力設定。設定した場合、操作ログが指定した GS2-Log ネームスペースに出力されます。 createdAt long ※ 現在時刻 作成日時UNIX 時間・ミリ秒※ サーバーが自動で設定 updatedAt long ※ 現在時刻 最終更新日時UNIX 時間・ミリ秒※ サーバーが自動で設定 revision long 0 0 ~ 9223372036854775805 リビジョン 関連するメソッド: describeNamespaces - ネームスペースの一覧を取得 createNamespace - ネームスペースを新規作成 getNamespace - ネームスペースを取得 updateNamespace - ネームスペースを更新 deleteNamespace - ネームスペースを削除 TransactionSetting トランザクション設定 /ja/api_reference/stamina/sdk/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/stamina/sdk/ モデル Namespace ネームスペース ネームスペースは、一つのプロジェクト内で同じサービスを異なる用途で複数利用するためのエンティティです。 GS2 の各サービスはネームスペース単位で管理されます。ネームスペースが異なれば、同じサービスでも完全に独立したデータ空間として扱われます。 そのため、各サービスの利用を開始するにあたってネームスペースを作成する必要があります。 詳細 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceId string ※ ~ 1024文字 ネームスペース GRN ※ サーバーが自動で設定 name string ✓ ~ 128文字 ネームスペース名ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 description string ~ 1024文字 説明文 transactionSetting TransactionSetting トランザクション設定スタミナ操作時のトランザクションの処理方法を制御する設定です。 overflowTriggerScript string ~ 1024文字 オーバーフロートリガースクリプト回復時にスタミナがオーバーフローした際に呼び出す GS2-Script の GRN。時間ベースの回復でスタミナが最大値を超える場合にトリガーされ、余剰分のカスタム処理（例：オーバーフロー分をアイテムに変換）が可能です。Script トリガーリファレンス - overflow logSetting LogSetting ログの出力設定スタミナの消費、回復、オーバーフローなどの操作を GS2-Log に記録するためのログ出力設定。 createdAt long ※ 現在時刻 作成日時UNIX 時間・ミリ秒※ サーバーが自動で設定 updatedAt long ※ 現在時刻 最終更新日時UNIX 時間・ミリ秒※ サーバーが自動で設定 revision long 0 0 ~ 9223372036854775805 リビジョン 関連するメソッド: describeNamespaces - ネームスペースの一覧を取得 createNamespace - ネームスペースを新規作成 getNamespace - ネームスペースを取得 updateNamespace - ネームスペースを更新 deleteNamespace - ネームスペースを削除 TransactionSetting トランザクション設定 /ja/api_reference/state_machine/sdk/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/state_machine/sdk/ モデル Namespace ネームスペース ネームスペースは、一つのプロジェクト内で同じサービスを異なる用途で複数利用するためのエンティティです。 GS2 の各サービスはネームスペース単位で管理されます。ネームスペースが異なれば、同じサービスでも完全に独立したデータ空間として扱われます。 そのため、各サービスの利用を開始するにあたってネームスペースを作成する必要があります。 詳細 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceId string ※ ~ 1024文字 ネームスペース GRN ※ サーバーが自動で設定 name string ✓ ~ 128文字 ネームスペース名ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 description string ~ 1024文字 説明文 supportSpeculativeExecution 文字列列挙型 enum { “enable”, “disable” } “disable” 投機的実行をサポートするか有効にすると、ステートマシン定義と乱数状態が Status エンティティに埋め込まれ、クライアントがサーバー確認前にローカルで状態遷移をシミュレーションできるようになります。transactionSetting の設定が必要です。定義説明“enable”有効“disable”無効 transactionSetting TransactionSetting {supportSpeculativeExecution} == “enable” トランザクション設定ステートマシンの emit アクション実行時のトランザクションの処理方法を制御する設定です。投機的実行を有効にする場合に必要です。※ supportSpeculativeExecution が “enable” であれば 有効 startScript ScriptSetting ステートマシンを起動したときに実行するスクリプトの設定Script トリガーリファレンス - start passScript ScriptSetting ステートマシンが正常終了したときに実行するスクリプトの設定Script トリガーリファレンス - pass errorScript ScriptSetting ステートマシンが異常終了したときに実行するスクリプトの設定Script トリガーリファレンス - error lowestStateMachineVersion long ステートマシンの最低バージョン実行可能なステートマシンの最低バージョンです。この値より古いバージョンのステートマシンで作成された Status インスタンスは拒否され、すべての実行中インスタンスが最新の定義を使用することが保証されます。 logSetting LogSetting ログの出力設定ステートマシンの実行、状態遷移、emit イベントに関する API リクエスト・レスポンスログを出力する GS2-Log のネームスペースを指定します。 createdAt long ※ 現在時刻 作成日時UNIX 時間・ミリ秒※ サーバーが自動で設定 updatedAt long ※ 現在時刻 最終更新日時UNIX 時間・ミリ秒※ サーバーが自動で設定 revision long 0 0 ~ 9223372036854775805 リビジョン 関連するメソッド: describeNamespaces - ネームスペースの一覧を取得 createNamespace - ネームスペースを新規作成 getNamespace - ネームスペースを取得 updateNamespace - ネームスペースを更新 deleteNamespace - ネームスペースを削除 TransactionSetting トランザクション設定 /ja/api_reference/version/sdk/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/version/sdk/ モデル Namespace ネームスペース ネームスペースは、一つのプロジェクト内で同じサービスを異なる用途で複数利用するためのエンティティです。 GS2 の各サービスはネームスペース単位で管理されます。ネームスペースが異なれば、同じサービスでも完全に独立したデータ空間として扱われます。 そのため、各サービスの利用を開始するにあたってネームスペースを作成する必要があります。 詳細 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceId string ※ ~ 1024文字 ネームスペース GRN ※ サーバーが自動で設定 name string ✓ ~ 128文字 ネームスペース名ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 description string ~ 1024文字 説明文 transactionSetting TransactionSetting トランザクション設定バージョンチェック操作時のトランザクションの処理方法を制御する設定です。 assumeUserId string ✓ ~ 1024文字 バージョンチェックを通過した場合に昇格する GS2-Identifier ユーザー GRN バージョンチェックが通過した際に権限を引き受ける GS2-Identifier ユーザーです。バージョン検証が成功した後、システムがユーザーに代わって認可されたアクション（アクセスの付与など）を実行できるようにします。 acceptVersionScript ScriptSetting バージョンを承認したときに実行するスクリプトの設定Script トリガーリファレンス - acceptVersion checkVersionTriggerScriptId string ~ 1024文字 バージョンチェック処理を実行する GS2-Script スクリプト GRN Script トリガーリファレンス - checkVersion logSetting LogSetting ログの出力設定バージョンチェックおよびバージョン承認操作に関する API リクエスト・レスポンスログを出力する GS2-Log のネームスペースを指定します。 createdAt long ※ 現在時刻 作成日時UNIX 時間・ミリ秒※ サーバーが自動で設定 updatedAt long ※ 現在時刻 最終更新日時UNIX 時間・ミリ秒※ サーバーが自動で設定 revision long 0 0 ~ 9223372036854775805 リビジョン 関連するメソッド: describeNamespaces - ネームスペースの一覧を取得 createNamespace - ネームスペースを新規作成 getNamespace - ネームスペースを取得 updateNamespace - ネームスペースを更新 deleteNamespace - ネームスペースを削除 TransactionSetting トランザクション設定 /ja/api_reference/account/script/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/account/script/ トリガー createAccount アカウント新規作成 同期実行スクリプト アカウント新規作成処理の前に、スクリプトが同期実行されます。 Request 型 説明 namespace Namespace ネームスペース account Account ゲームプレイヤーアカウント Result 型 必須 デフォルト 値の制限 説明 permit bool ✓ アカウントの作成を許可するか 実装例 Lua -- Request local namespace = args.namespace local account = args.account -- Business logic: local permit = true -- Result result = { permit=permit } 非同期実行スクリプト アカウント新規作成処理の後に、スクリプトが非同期実行されます。 Request 型 説明 namespace Namespace ネームスペース account Account ゲームプレイヤーアカウント 実装例 Lua -- Request local namespace = args.namespace local account = args. /ja/api_reference/ad_reward/script/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/ad_reward/script/ トリガー acquirePoint ポイント獲得 同期実行スクリプト ポイント獲得処理の前に、スクリプトが同期実行されます。 Request 型 説明 namespace Namespace ネームスペース point Point 獲得処理前ポイント acquirePointValue long 獲得ポイント量 Result 型 必須 デフォルト 値の制限 説明 permit bool ✓ ポイント獲得を許可するか overridePointValue long 0 ~ 2147483645 上書きする獲得ポイント量 実装例 Lua -- Request local namespace = args.namespace local point = args.point local acquirePointValue = args.acquirePointValue -- Business logic: local permit = true local overridePointValue = 0 -- Result result = { permit=permit, overridePointValue=overridePointValue } 非同期実行スクリプト ポイント獲得処理の後に、スクリプトが非同期実行されます。 /ja/api_reference/buff/script/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/buff/script/ トリガー apply バフの適用 同期実行スクリプト バフの適用処理の前に、スクリプトが同期実行されます。 Request 型 説明 namespace Namespace ネームスペース buffEntryModel BuffEntryModel バフエントリーモデル userId string ユーザーID Result 型 必須 デフォルト 値の制限 説明 permit bool ✓ バフの適用を許可するか overrideBuffRate float ✓ 0 ~ 100 バフに適用する上書きレート (倍率) 実装例 Lua -- Request local namespace = args.namespace local buffEntryModel = args.buffEntryModel local userId = args.userId -- Business logic: local permit = true local overrideBuffRate = 0 -- Result result = { permit=permit, overrideBuffRate=overrideBuffRate } 非同期実行スクリプト バフの適用処理の後に、スクリプトが非同期実行されます。 /ja/api_reference/chat/script/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/chat/script/ トリガー createRoom ルーム作成 同期実行スクリプト ルーム作成処理の前に、スクリプトが同期実行されます。 Request 型 説明 namespace Namespace ネームスペース room Room ルーム Result 型 必須 デフォルト 値の制限 説明 permit bool ✓ ルーム作成を許可するか 実装例 Lua -- Request local namespace = args.namespace local room = args.room -- Business logic: local permit = true -- Result result = { permit=permit } 非同期実行スクリプト ルーム作成処理の後に、スクリプトが非同期実行されます。 Request 型 説明 namespace Namespace ネームスペース room Room ルーム 実装例 Lua -- Request local namespace = args.namespace local room = args. /ja/api_reference/datastore/script/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/datastore/script/ トリガー doneUpload データオブジェクトのアップロード完了を報告する 同期実行スクリプト データオブジェクトのアップロード完了を報告する処理の前に、スクリプトが同期実行されます。 Request 型 説明 namespace Namespace ネームスペース dataObject DataObject データオブジェクト objectUrl string アップロードしたオブジェクトのURL Result 型 必須 デフォルト 値の制限 説明 permit bool ✓ データオブジェクトのアップロード完了報告 を許可するか 実装例 Lua -- Request local namespace = args.namespace local dataObject = args.dataObject local objectUrl = args.objectUrl -- Business logic: local permit = true -- Result result = { permit=permit } 非同期実行スクリプト データオブジェクトのアップロード完了を報告する処理の後に、スクリプトが非同期実行されます。 Request 型 説明 namespace Namespace ネームスペース dataObject DataObject データオブジェクト 実装例 Lua -- Request local namespace = args. /ja/api_reference/dictionary/script/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/dictionary/script/ トリガー entry エントリー登録 同期実行スクリプト エントリー登録処理の前に、スクリプトが同期実行されます。 Request 型 説明 namespace Namespace ネームスペース entryModels EntryModel[] エントリーモデルのリスト userId string ユーザーID Result 型 必須 デフォルト 値の制限 説明 permit bool ✓ エントリー登録を許可するか 実装例 Lua -- Request local namespace = args.namespace local entryModels = args.entryModels local userId = args.userId -- Business logic: local permit = true -- Result result = { permit=permit } 非同期実行スクリプト エントリー登録処理の後に、スクリプトが非同期実行されます。 Request 型 説明 namespace Namespace ネームスペース entryModels EntryModel[] エントリーモデルのリスト userId string ユーザーID 実装例 Lua -- Request local namespace = args. /ja/api_reference/enhance/script/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/enhance/script/ トリガー enhance 強化実行 同期実行スクリプト 強化実行処理の前に、スクリプトが同期実行されます。 Request 型 説明 namespace Namespace ネームスペース rateModel RateModel 強化レートモデル targetItemSetId string 強化対象のアイテムセットのGRN bonusRate float 経験値ボーナスの倍率(1.0=ボーナスなし) experienceValue long 入手経験値量 Result 型 必須 デフォルト 値の制限 説明 permit bool ✓ 強化実行を許可するか overrideExperienceValue long 0 ~ 2147483645 上書きする入手経験値量 実装例 Lua -- Request local namespace = args.namespace local rateModel = args.rateModel local targetItemSetId = args.targetItemSetId local bonusRate = args.bonusRate local experienceValue = args.experienceValue -- Business logic: local permit = true local overrideExperienceValue = 0 -- Result result = { permit=permit, overrideExperienceValue=overrideExperienceValue } 非同期実行スクリプト 強化実行処理の後に、スクリプトが非同期実行されます。 /ja/api_reference/exchange/script/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/exchange/script/ トリガー exchange 交換 同期実行スクリプト 交換処理の前に、スクリプトが同期実行されます。 Request 型 説明 namespace Namespace ネームスペース rateModel RateModel 交換レートモデル userId string 交換を実行しているユーザーID count int 交換量 config Config[] トランザクションの変数に適用する設定値 Result 型 必須 デフォルト 値の制限 説明 permit bool ✓ 交換を許可するか rateMode string ✓ “float” 倍率モード rate float 1.0 0 ~ 1000 入手量の倍率 logRate LogRate 対数を使用した入手量補正 実装例 Lua -- Request local namespace = args.namespace local rateModel = args.rateModel local userId = args.userId local count = args.count local config = args. /ja/api_reference/experience/script/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/experience/script/ トリガー rankCapScript ランクキャップ取得 同期実行スクリプト ランクキャップ取得処理の前に、スクリプトが同期実行されます。 Request 型 説明 namespace Namespace ネームスペース experienceModel ExperienceModel 経験値モデル userId string ユーザーID propertyId string プロパティIDユーザースコープ内でこのステータスを一意に識別する開発者定義の識別子です。経験値を持つ GS2-Inventory のアイテムセット GRN や GS2-Dictionary のエントリー GRN の末尾に経験値モデルのサフィックスを付与した値を使用することを推奨します。 Result 型 必須 デフォルト 値の制限 説明 rankCap long ✓ 0 ~ 2147483645 ランクキャップ 実装例 Lua -- Request local namespace = args.namespace local experienceModel = args.experienceModel local userId = args.userId local propertyId = args.propertyId -- Business logic: local rankCap = 0 -- Result result = { rankCap=rankCap } changeExperience 経験値変化 /ja/api_reference/formation/script/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/formation/script/ トリガー updateMold フォームの保存領域のキャパシティ更新 同期実行スクリプト フォームの保存領域のキャパシティ更新処理の前に、スクリプトが同期実行されます。 Request 型 説明 namespace Namespace ネームスペース mold Mold 更新前のフォームの保存領域 afterMold Mold 更新後のフォームの保存領域 Result 型 必須 デフォルト 値の制限 説明 permit bool ✓ フォームの保存領域のキャパシティ更新 を許可するか 実装例 Lua -- Request local namespace = args.namespace local mold = args.mold local afterMold = args.afterMold -- Business logic: local permit = true -- Result result = { permit=permit } 非同期実行スクリプト フォームの保存領域のキャパシティ更新処理の後に、スクリプトが非同期実行されます。 Request 型 説明 namespace Namespace ネームスペース mold Mold フォームの保存領域 実装例 Lua -- Request local namespace = args. /ja/api_reference/friend/script/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/friend/script/ トリガー updateProfile プロフィールの更新 同期実行スクリプト プロフィールの更新処理の前に、スクリプトが同期実行されます。 Request 型 説明 namespace Namespace ネームスペース profile Profile プロフィール oldProfile Profile 更新前のプロフィール publicProfile string 新しい公開されるプロフィール followerProfile string 新しいフォロワー向けに公開されるプロフィール friendProfile string 新しいフレンド向けに公開されるプロフィール Result 型 必須 デフォルト 値の制限 説明 permit bool ✓ プロフィールの更新 を許可するか 実装例 Lua -- Request local namespace = args.namespace local profile = args.profile local oldProfile = args.oldProfile local publicProfile = args.publicProfile local followerProfile = args.followerProfile local friendProfile = args.friendProfile -- Business logic: local permit = true -- Result result = { permit=permit } 非同期実行スクリプト プロフィールの更新処理の後に、スクリプトが非同期実行されます。 /ja/api_reference/grade/script/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/grade/script/ トリガー changeGrade グレード変化 同期実行スクリプト グレード変化処理の前に、スクリプトが同期実行されます。 Request 型 説明 namespace Namespace ネームスペース gradeModel GradeModel グレードモデル status Status 変化前ステータス afterStatus Status 変化後ステータス Result 型 必須 デフォルト 値の制限 説明 permit bool ✓ グレード変化 を許可するか overrideGradeValue long ✓ 0 ~ 2147483645 上書きするグレード値 実装例 Lua -- Request local namespace = args.namespace local gradeModel = args.gradeModel local status = args.status local afterStatus = args.afterStatus -- Business logic: local permit = true local overrideGradeValue = 0 -- Result result = { permit=permit, overrideGradeValue=overrideGradeValue } 非同期実行スクリプト グレード変化処理の後に、スクリプトが非同期実行されます。 /ja/api_reference/guild/script/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/guild/script/ トリガー createGuild ギルド作成 同期実行スクリプト ギルド作成処理の前に、スクリプトが同期実行されます。 Request 型 説明 namespace Namespace ネームスペース guildModel GuildModel ギルドモデル guild Guild ギルド Result 型 必須 デフォルト 値の制限 説明 permit bool ✓ ギルド作成 を許可するか 実装例 Lua -- Request local namespace = args.namespace local guildModel = args.guildModel local guild = args.guild -- Business logic: local permit = true -- Result result = { permit=permit } 非同期実行スクリプト ギルド作成処理の後に、スクリプトが非同期実行されます。 Request 型 説明 namespace Namespace ネームスペース guildModel GuildModel ギルドモデル guild Guild ギルド 実装例 Lua -- Request local namespace = args. /ja/api_reference/idle/script/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/idle/script/ トリガー receive 報酬受け取り 同期実行スクリプト 報酬受け取り処理の前に、スクリプトが同期実行されます。 Request 型 説明 namespace Namespace ネームスペース category CategoryModel カテゴリーモデル userId string 報酬受け取りを実行しているユーザーID status Status ステータス acquireActions AcquireAction[] 報酬 config Config[] トランザクションの変数に適用する設定値 Result 型 必須 デフォルト 値の制限 説明 permit bool ✓ 報酬受け取りを許可するか rate float 1.0 0 ~ 1000 入手量の倍率 実装例 Lua -- Request local namespace = args.namespace local category = args.category local userId = args.userId local status = args.status local acquireActions = args.acquireActions local config = args. /ja/api_reference/inbox/script/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/inbox/script/ トリガー receiveMessage メッセージ受信 同期実行スクリプト メッセージ受信処理の前に、スクリプトが同期実行されます。 Request 型 説明 namespace Namespace ネームスペース message Message メッセージ Result 型 必須 デフォルト 値の制限 説明 permit bool ✓ メッセージ受信 を許可するか overrideMetadata string 0 ~ 4096文字 上書きするメタデータ 実装例 Lua -- Request local namespace = args.namespace local message = args.message -- Business logic: local permit = true local overrideMetadata = "" -- Result result = { permit=permit, overrideMetadata=overrideMetadata } 非同期実行スクリプト メッセージ受信処理の後に、スクリプトが非同期実行されます。 Request 型 説明 namespace Namespace ネームスペース message Message メッセージ 実装例 Lua -- Request local namespace = args. /ja/api_reference/inventory/script/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/inventory/script/ トリガー acquire アイテム入手 同期実行スクリプト アイテム入手処理の前に、スクリプトが同期実行されます。 Request 型 説明 namespace Namespace ネームスペース inventory Inventory インベントリ itemSets ItemSet[] アイテムセットのリスト acquireItemName string 入手したアイテムモデル名 userId string ユーザーID acquireCount long 入手数量 expiresAt long 有効期限UNIX 時間・ミリ秒 Result 型 必須 デフォルト 値の制限 説明 permit bool ✓ アイテム入手を許可するか overrideAcquireCount int 0 ~ 2147483645 実際に適用する入手量 実装例 Lua -- Request local namespace = args.namespace local inventory = args.inventory local itemSets = args.itemSets local acquireItemName = args.acquireItemName local userId = args.userId local acquireCount = args. /ja/api_reference/limit/script/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/limit/script/ トリガー countUp カウントアップ 同期実行スクリプト カウントアップ処理の前に、スクリプトが同期実行されます。 Request 型 説明 namespace Namespace ネームスペース limitModel LimitModel 回数制限モデル counter Counter カウンター userId string ユーザーID countUpValue int カウントアップする量 maxValue int カウントアップを許容する最大値 Result 型 必須 デフォルト 値の制限 説明 permit bool ✓ カウントアップを許可するか 実装例 Lua -- Request local namespace = args.namespace local limitModel = args.limitModel local counter = args.counter local userId = args.userId local countUpValue = args.countUpValue local maxValue = args.maxValue -- Business logic: local permit = true -- Result result = { permit=permit } 非同期実行スクリプト カウントアップ処理の後に、スクリプトが非同期実行されます。 /ja/api_reference/login_reward/script/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/login_reward/script/ トリガー receive 受け取り 同期実行スクリプト 受け取り処理の前に、スクリプトが同期実行されます。 Request 型 説明 namespace Namespace ネームスペース bonusModel BonusModel ログインボーナスモデル userId string 受け取りを実行しているユーザーID receiveStep int 受け取ったステップ config Config[] トランザクションの変数に適用する設定値 Result 型 必須 デフォルト 値の制限 説明 permit bool ✓ 受け取りを許可するか 実装例 Lua -- Request local namespace = args.namespace local bonusModel = args.bonusModel local userId = args.userId local receiveStep = args.receiveStep local config = args.config -- Business logic: local permit = true -- Result result = { permit=permit } 非同期実行スクリプト 受け取り処理の後に、スクリプトが非同期実行されます。 /ja/api_reference/lottery/script/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/lottery/script/ トリガー lottery 抽選 同期実行スクリプト 抽選処理の前に、スクリプトが同期実行されます。 Request 型 説明 namespace Namespace ネームスペース lotteryModel LotteryModel 抽選モデル drawnPrizes DrawnPrize[] 抽選結果の景品リスト boxItems BoxItems ボックスの状態（景品と残数・初期数量の情報） Result 型 必須 デフォルト 値の制限 説明 permit bool ✓ 抽選 を許可するか overrideDrawnPrizes DrawnPrize[] 0 ~ 1000 items 上書きする抽選結果の景品リスト 実装例 Lua -- Request local namespace = args.namespace local lotteryModel = args.lotteryModel local drawnPrizes = args.drawnPrizes local boxItems = args.boxItems -- Business logic: local permit = true local overrideDrawnPrizes = {} -- Result result = { permit=permit, overrideDrawnPrizes=overrideDrawnPrizes } choicePrizeTable 排出確率テーブルを動的に変化させる /ja/api_reference/matchmaking/script/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/matchmaking/script/ トリガー createGathering ギャザリング新規作成 同期実行スクリプト ギャザリング新規作成処理の前に、スクリプトが同期実行されます。 Request 型 説明 namespace Namespace ネームスペース gathering Gathering ギャザリング 実装例 Lua -- Request local namespace = args.namespace local gathering = args.gathering -- Business logic: -- Result result = { } completeMatchmaking マッチメイキング完了 同期実行スクリプト マッチメイキング完了処理の前に、スクリプトが同期実行されます。 Request 型 説明 namespace Namespace ネームスペース gathering Gathering ギャザリング 実装例 Lua -- Request local namespace = args.namespace local gathering = args.gathering -- Business logic: -- Result result = { } changeRating レーティングの値変化 /ja/api_reference/mission/script/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/mission/script/ トリガー missionComplete ミッション達成 同期実行スクリプト ミッション達成処理の前に、スクリプトが同期実行されます。 Request 型 説明 namespace Namespace ネームスペース missionGroupModel MissionGroupModel ミッショングループ oldComplete Complete 達成前の達成状況 newComplete Complete 達成後の達成状況 completeTaskNames [] 達成したタスク名のリスト Result 型 必須 デフォルト 値の制限 説明 permit bool ✓ ミッション達成 を許可するか 実装例 Lua -- Request local namespace = args.namespace local missionGroupModel = args.missionGroupModel local oldComplete = args.oldComplete local newComplete = args.newComplete local completeTaskNames = args.completeTaskNames -- Business logic: local permit = true -- Result result = { permit=permit } 非同期実行スクリプト ミッション達成処理の後に、スクリプトが非同期実行されます。 /ja/api_reference/money/script/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/money/script/ トリガー createWallet ウォレット新規作成 同期実行スクリプト ウォレット新規作成処理の前に、スクリプトが同期実行されます。 Request 型 説明 namespace Namespace ネームスペース wallet Wallet ウォレット Result 型 必須 デフォルト 値の制限 説明 permit bool ✓ ウォレットの作成を許可するか initialAmount int ✓ 0 ~ 2147483645 ウォレットの初期残高 - 無償付与として加算されます 実装例 Lua -- Request local namespace = args.namespace local wallet = args.wallet -- Business logic: local permit = true local initialAmount = 0 -- Result result = { permit=permit, initialAmount=initialAmount } 非同期実行スクリプト ウォレット新規作成処理の後に、スクリプトが非同期実行されます。 Request 型 説明 namespace Namespace ネームスペース wallet Wallet ウォレット 実装例 Lua -- Request local namespace = args. /ja/api_reference/money2/script/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/money2/script/ トリガー deposit ウォレット残高加算 同期実行スクリプト ウォレット残高加算処理の前に、スクリプトが同期実行されます。 Request 型 説明 namespace Namespace ネームスペース oldWallet Wallet 加算前のウォレット newWallet Wallet 加算後のウォレット transactions DepositTransaction[] 発生したトランザクションリスト count int 残高の加算量 Result 型 必須 デフォルト 値の制限 説明 permit bool ✓ ウォレット残高加算を許可するか 実装例 Lua -- Request local namespace = args.namespace local oldWallet = args.oldWallet local newWallet = args.newWallet local transactions = args.transactions local count = args.count -- Business logic: local permit = true -- Result result = { permit=permit } 非同期実行スクリプト ウォレット残高加算処理の後に、スクリプトが非同期実行されます。 /ja/api_reference/quest/script/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/quest/script/ トリガー startQuest クエスト開始 同期実行スクリプト クエスト開始処理の前に、スクリプトが同期実行されます。 Request 型 説明 namespace Namespace ネームスペース questGroupModel QuestGroupModel クエストグループモデル questModel QuestModel クエストモデル randomSeed long 乱数シード rewards Reward[] クエストで得られる報酬リスト userId string ユーザーID config Config[] トランザクションの変数に適用する設定値 Result 型 必須 デフォルト 値の制限 説明 permit bool ✓ クエスト開始を許可するか overrideRandomSeed long 0 ~ 9223372036854775805 乱数シード overrideRewards Reward[] 0 ~ 1000 items クエストで得られる報酬リスト 実装例 Lua -- Request local namespace = args.namespace local questGroupModel = args.questGroupModel local questModel = args.questModel local randomSeed = args. /ja/api_reference/showcase/script/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/showcase/script/ トリガー buy 購入 同期実行スクリプト 購入処理の前に、スクリプトが同期実行されます。 Request 型 説明 namespace Namespace ネームスペース showcase Showcase 陳列棚モデル displayItem DisplayItem 陳列商品モデル userId string 購入を実行しているユーザーID quantity int 購入量 config Config[] トランザクションの変数に適用する設定値 Result 型 必須 デフォルト 値の制限 説明 permit bool ✓ 購入を許可するか 実装例 Lua -- Request local namespace = args.namespace local showcase = args.showcase local displayItem = args.displayItem local userId = args.userId local quantity = args.quantity local config = args.config -- Business logic: local permit = true -- Result result = { permit=permit } 非同期実行スクリプト 購入処理の後に、スクリプトが非同期実行されます。 /ja/api_reference/skill_tree/script/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/skill_tree/script/ トリガー release ノードを解放 同期実行スクリプト ノードを解放処理の前に、スクリプトが同期実行されます。 Request 型 説明 namespace Namespace ネームスペース oldStatus Status 更新前のステータス newStatus Status 更新後のステータス userId string ユーザーID nodeModelNames [] ノードモデル名のリスト Result 型 必須 デフォルト 値の制限 説明 permit bool ✓ ノードを解放を許可するか 実装例 Lua -- Request local namespace = args.namespace local oldStatus = args.oldStatus local newStatus = args.newStatus local userId = args.userId local nodeModelNames = args.nodeModelNames -- Business logic: local permit = true -- Result result = { permit=permit } 非同期実行スクリプト ノードを解放処理の後に、スクリプトが非同期実行されます。 /ja/api_reference/stamina/script/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/stamina/script/ トリガー overflow スタミナ最大値のオーバーフロー 同期実行スクリプト スタミナ最大値のオーバーフロー処理の前に、スクリプトが同期実行されます。 Request 型 説明 namespace Namespace ネームスペース staminaModel StaminaModel スタミナモデル stamina Stamina スタミナ overflowValue long 溢れた量 実装例 Lua -- Request local namespace = args.namespace local staminaModel = args.staminaModel local stamina = args.stamina local overflowValue = args.overflowValue -- Business logic: -- Result result = { } /ja/api_reference/state_machine/script/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/state_machine/script/ トリガー start ステートマシンを開始 同期実行スクリプト ステートマシンを開始処理の前に、スクリプトが同期実行されます。 Request 型 説明 namespace Namespace ネームスペース stateMachineMaster StateMachineMaster ステートマシンマスターデータ status Status ステータス userId string ユーザーID parameters string ステートマシンに渡す引数 Result 型 必須 デフォルト 値の制限 説明 permit bool ✓ 開始を許可するか 実装例 Lua -- Request local namespace = args.namespace local stateMachineMaster = args.stateMachineMaster local status = args.status local userId = args.userId local parameters = args.parameters -- Business logic: local permit = true -- Result result = { permit=permit } 非同期実行スクリプト ステートマシンを開始処理の後に、スクリプトが非同期実行されます。 /ja/api_reference/version/script/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/version/script/ トリガー acceptVersion バージョン承認 同期実行スクリプト バージョン承認処理の前に、スクリプトが同期実行されます。 Request 型 説明 namespace Namespace ネームスペース versionModel VersionModel バージョンモデル acceptVersion AcceptVersion 承認したバージョン currentAcceptVersion AcceptVersion 現在承認しているバージョン Result 型 必須 デフォルト 値の制限 説明 permit bool ✓ バージョン承認を許可するか 実装例 Lua -- 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 承認したバージョン 実装例 Lua -- Request local namespace = args.