/ja/tags/transaction-action/ Recent content in Transaction Action on Game Server Services | Docs Hugo ja /ja/api_reference/transaction/game_engine/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/transaction/game_engine/ トランザクションとは GS2 におけるトランザクション処理とは、「消費アクション」「入手アクション」として定義したリソースの交換処理を実行する塊を指します。 トランザクションを発行するAPIは、GS2-Exchange の交換実行関数(Exchange) であったり、GS2-Showcase の商品購入関数(Buy)であったり、GS2-Quest のクエスト開始関数(Start) のようなものがあります。 「消費アクション」はプレイヤーにとってデメリットとなるユーザーデータの操作、逆に「入手アクション」はプレイヤーにとってメリットとなるユーザーデータ操作を指します。 具体的には GS2-Inventory であれば、アイテムの消費が「消費アクション」、アイテムの入手が「入手アクション」となります。 もう少し変わった例を示すとすれば GS2-Inbox のメッセージの開封フラグを立てる操作を「消費アクション」、メッセージに添付されたアイテムを受け取るのが「入手アクション」となります。 GS2 ではユーザーデータを書き換えるトランザクションを発行して実行することを繰り返すことで、ゲームサイクルを実現すると理解してください。 トランザクションとスタンプシート GS2 では、トランザクション処理を「スタンプシート」という名前で呼んでいました。 そのため、コードやドキュメントの各所にそのような記述がみられます。 近年はこの名称は積極的に用いておらず「トランザクション処理」と呼んでいますが、同じものを指していると理解してください。 類似するワードとして「スタンプタスク」という名称もありますが、こちらはトランザクション内に含まれる「消費アクション」を指していました。 トランザクションの実行 GS2-Exchange の Exchange や、 GS2-Showcase の Buy を呼び出すと、EzTransactionDomain というオブジェクトが返されます。 EzTransactionDomain には Wait 関数が用意されており、この関数を呼び出すことで、トランザクション処理の完了を待つことができます。 ただし、トランザクション処理が完了するまでの時間に保証がないため、タイムアウトを実装することを強く推奨します。 Wait 関数には all という引数が用意されており、こちらに true を指定することで、トランザクション処理内で新しいトランザクションが発行された場合にそのトランザクションの実行完了も待つことが可能です。 Wait 関数を呼び出さない場合は、Gs2Domain::Dispatch を定期的に呼び出す必要があります。 Deep Dive ここから先はトランザクション処理の詳細な実装について解説します。 多くの開発者は以下に書かれている内容について理解する必要はありません。 消費アクションと入手アクションの実行順番 トランザクションに含まれる「消費アクション」を全て実行すると「入手アクション」が実行できるようになるように制御されています。 そのため、実行順番は「消費アクション」が先で、「入手アクション」が後になります。これはチート耐性を実現するために重要な仕様です。 このような処理の流れを、日本企業が決裁を行う「稟議」にたとえ、 いろいろな役職者（マイクロサービス）に許可をもらい（消費アクションを実行）稟議書にハンコを押してもらい、 全てのマイクロサービスに許可をもらうと本当にやりたかったこと（入手アクション）が実行できるということからスタンプシートと呼んでいました。 トランザクションの実行 GS2が提供しているマイクロサービスは、トランザクションに含まれる「消費アクション」や「入手アクション」を渡すことで、処理を実行する機能が備わっています。 しかし、トランザクションに含まれるアクションをどのマイクロサービスのどのAPIに渡すべきかはアクションの種類によって決定し、実行するのも一苦労です。 そこで、GS2-Distributor マイクロサービスが活躍します。 GS2-Distributor はトランザクションアクションを受け取ると、アクションの内容に応じて適切なマイクロサービスのAPIに転送する処理を持っています。 これによってあなたは何も考えずに、トランザクションデータを GS2-Distributor に渡すだけでトランザクションを実行できます。 エラー処理 次に考えるべきはエラーハンドリングです。GS2 は様々なマイクロサービスを提供しており、障害が発生するときはマイクロサービス単位で発生する可能性があります。 つまり、「消費アクション」の実行に成功したが「入手アクション」の実行に失敗した。というケースがありえます。 この場合は「入手アクション」が成功するまでリトライしなければ、プレイヤーが損をした状態で処理が止まってしまいます。 /ja/api_reference/transaction/sdk/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/transaction/sdk/ GS2-SDK for Game Engine のトランザクション処理について 基本的な考え方や処理の流れは for Game Engine のドキュメントを参照してください。 一方で、GS2-SDK では for Game Engine ほど手厚いサポートはありません。 具体的にはキャッシュ機能や EzTransactionDomain のような仕組みは用意されていません。 トランザクションの実行 自動実行が有効な場合 完了通知を受け取るためには明示的に GS2-Gateway にユーザーIDを設定する必要があります。 GS2-Gateway::setUserId 完了通知をハンドリングする必要があります。 Gs2WebSocketSession クラスに通知のハンドリング関数が用意されていますので、そちらを利用してください。 プログラミング言語によっては WebSocket クライアントの実装が無い可能性もあります。 GS2-Distributor からトランザクションの実行完了通知を受け取ったら、明示的に結果を取得する必要があります。 実行結果にはエラーが含まれている可能性があり、成功するまで実行結果は更新される可能性があります。 GS2-Distributor::getStampSheetResult GS2-JobQueue からジョブの実行完了通知を受け取ったら、明示的に結果を取得する必要があります。 実行結果にはエラーが含まれている可能性があり、tryNumber を指定しなければ最新の結果を取得できるため、それを利用して成功するまで待つ必要があります。 GS2-JobQueue::getJobResult 自動実行が無効な場合 GS2-Showcase::Buy のようなトランザクション発行APIを呼び出すと、stampSheet 変数にトランザクションデータが、stampSheetEncryptionKeyId にトランザクションデータの署名計算に使用した暗号鍵のIDが応答されます。 トランザクションデータと暗号鍵の情報を GS2-Distributor に渡して、明示的にトランザクションを実行する必要があります。 GS2-Log にログを残したい場合は、ログの書き出し設定を行った GS2-Distributor のネームスペースを指定して runStampSheetExpress を呼び出し、必要ない場合は runStampSheetExpressWithoutNamespace を呼び出します。 GS2-Distributor::runStampSheetExpress GS2-Distributor::runStampSheetExpressWithoutNamespace runStampSheetExpress または runStampSheetExpressWithoutNamespace の実行結果に stampSheet が含まれる場合はそのトランザクションも明示的に実行する必要があります。 スタンプシートの入手アクションが「Gs2JobQueue:PushByUserId」だった場合は、GS2-JobQueue も実行する必要があります。 GS2-JobQueue::run /ja/articles/tech/stamp_sheet/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/articles/tech/stamp_sheet/ GS2 には各サービス間を連携させるトランザクションの仕組みとして《スタンプシート》という仕組みを使用します。 GS2内のAPIのうち、プレイヤーにとってデメリットとなる操作を《消費アクション》と呼び、逆にプレイヤーにとってメリットのある操作を《入手アクション》と呼びます。 ゲーム内のストアで《1000ジェムを使用》して《ガチャを10回引く》という処理があったとしましょう。 この場合、《1000ジェムを使用》が消費アクションで、《ガチャを10回引く》を入手アクションと捉えることが可能です。 もう少し例をいくつか並べてみましょう。 《メッセージを既読にする》消費アクションを実行して《メッセージに添付されたジェム100個を受け取る》入手アクションを実行する 《スタミナを10消費する》消費アクションを実行して《クエスト1を開始状態にする》入手アクションを実行する 《クエスト1の開始状態を削除する》消費アクションを実行して《クエスト1のクリア報酬を入手する》入手アクションを実行する 《現在時刻で最終放置報酬受け取り時間を更新する》消費アクションを実行して《放置時間に応じた報酬を入手する》入手アクションを実行する 《毎日リセットされる回数制限カウンターを1上昇させる》消費アクションを実行して《1日1回した受け取れないアイテムを入手する》入手アクションを実行する このようにGS2において、全てのゲームサイクルは何かを消費して、何かを得ることで表現されています。 スタンプシートの仕組み スタンプシートは複数の《消費アクション》と1つの《入手アクション》で構成され、 スタンプシートの発行も ストア機能や、クエスト機能といった GS2 のマイクロサービスが行います。 発行するスタンプシートの内容は、ストア機能に登録した商品マスターデータなどから決定しています。 スタンプシートの実行は 《消費アクション》の実行 -> 《入手アクション》の実行 順番で処理されます。 この順番で処理することで、不正に《入手アクション》を何度も実行されることを防いでいます。 《消費アクション》を実行すると、GS2 の各機能を提供するマイクロサービスは実行済みを証明する署名を発行します。 《入手アクション》を実行する際には、全ての《消費アクション》で受け取った署名を一緒に送信します。 《入手アクション》を実行する前に署名検証を行い、全てが実行済みであることを確認できてから《入手アクション》を実行します。 サービスディスカバリ スタンプシートの《消費アクション》や《入手アクション》の内容に応じて、適切なマイクロサービスに処理を依頼する必要があります。 しかし、GS2 の機能は日々追加されており、《消費アクション》や《入手アクション》の種類は増え続けており、そのような分岐処理をメンテナンスするのは大変です。 そのため、GS2 には GS2-Distributor という、受け取ったスタンプシートを適切なマイクロサービスに転送するマイクロサービスを提供しています。 GS2-Distributor にスタンプシートを送信することで、スタンプシートの《消費アクション》や《入手アクション》の内容に応じて適切なマイクロサービスに転送する役割があります。 重複実行の防止 スタンプシートは重複実行できないように設計されています。 正しくは、GS2の全ての《消費アクション》や《入手アクション》のAPIには重複実行防止の仕組みが用意されています。 《消費アクション》や《入手アクション》のAPIは《Duplication Avoider》パラメーターを受け取れるようになっています。 ここに値を指定して API の処理が正常終了すると、応答内容が GS2 によって一定期間保存されます。 同一リクエストペイロードで、《Duplication Avoider》の指定がある場合、過去に《Duplication Avoider》の値が一致する処理を実行したことがある場合は、その結果を正常処理完了として応答して実際には処理を行わないようになっています。 そして、スタンプシートによる《消費アクション》や《入手アクション》の実行では、《Duplication Avoider》にはスタンプシート固有のIDである《トランザクションID》を指定することになっています。 それでは、重複実行防止 の仕組みがどのようなプロセスで実行されるのかを順を追ってみてみましょう。 まずは、以下のスタンプシートが存在すると仮定します。 消費アクション アイテムを1個消費 回数制限カウンターを1増加 入手アクション ジェムを10個入手 このスタンプシートを実行する場合、まずは《アイテムを1個消費》を実行します。 《アイテムを1個消費》の実行 アイテムが1個消費される。 サーバー側に「トランザクションID：XXX でアイテム消費成功」という記録が残る。 《回数制限カウンターを1増加》の実行 ここでネットワークエラーやサーバーエラーが発生し、処理が中断されたとします。 この時、アイテムはすでに消費された状態で止まっており、プレイヤーにとっては不利益な状態です。 スタンプシートのリトライ /ja/articles/tech/transaction/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/articles/tech/transaction/ GS2 が提供するマイクロサービスには概ねネームスペース設定に TransactionSetting というフィールドが存在します。 TransactionSetting は以下の構造を持ちます。 型 有効化条件 必須 デフォルト 値の制限 説明 enableAutoRun bool ✓ false 発行したトランザクションをサーバーサイドで自動的に実行するか enableAtomicCommit bool {enableAutoRun} == true ✓ false トランザクションの実行をアトミックにコミットするか enableAutoRun が true であれば 必須 transactionUseDistributor bool {enableAtomicCommit} == true ✓ false トランザクションを非同期処理で実行する enableAtomicCommit が true であれば 必須 commitScriptResultInUseDistributor bool {transactionUseDistributor} == true ✓ false スクリプトの結果コミット処理を非同期処理で実行するか transactionUseDistributor が true であれば 必須 acquireActionUseJobQueue bool {enableAtomicCommit} == true ✓ false 入手アクションを実行する際に GS2-JobQueue を使用するか enableAtomicCommit が true であれば 必須 distributorNamespaceId string ✓ “grn:gs2:{region}:{ownerId}:distributor:default” ~ 1024文字 トランザクションの実行に使用する GS2-Distributor ネームスペース queueNamespaceId string ✓ “grn:gs2:{region}:{ownerId}:queue:default” ~ 1024文字 トランザクションの実行に使用する GS2-JobQueue のネームスペース フィールドが多く、その用途も複雑ですのでこちらのドキュメントで詳細を説明します。 /ja/api_reference/ad_reward/stamp_sheet/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/ad_reward/stamp_sheet/ Consume Action 消費アクション Gs2AdReward:ConsumePointByUserId ユーザーIDを指定してポイントを消費 指定されたユーザーIDから指定された数のポイントを減算し、更新後のポイント情報を返します。 要求された消費量に対してポイントが不足している場合はエラーが返されます。 ネームスペースの消費スクリプト設定に GS2-Script が設定されている場合、ポイント減算前にスクリプトが実行され、カスタムバリデーションや消費量の変更が可能です。 ポイント減算後、ネームスペース設定で変更通知が構成されている場合は通知が送信されます。 数量指定可能なアクション：はい 反転可能なアクション：はい 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceName string ✓ ~ 128文字 ネームスペース名ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 userId string ✓ ~ 128文字 ユーザーID #{userId} と設定することでログイン中のユーザーIDに置換されます。 point long ✓ 1 ~ 9223372036854775805 消費するポイント timeOffsetToken string ~ 1024文字 タイムオフセットトークン Format: JSON YAML GS2-Script { "action": "Gs2AdReward:ConsumePointByUserId", "request": { "namespaceName": "[string]ネームスペース名", "userId": "[string]ユーザーID", "point": "[long]消費するポイント", "timeOffsetToken": "[string]タイムオフセットトークン" } } action: Gs2AdReward:ConsumePointByUserId request: namespaceName: " /ja/api_reference/dictionary/stamp_sheet/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/dictionary/stamp_sheet/ Verify Action 検証アクション Gs2Dictionary:VerifyEntryByUserId ユーザーIDを指定してエントリーを検証 指定されたユーザーが特定のエントリーを収集済みか未収集かを検証します。 検証タイプで条件を指定します：‘have’ はユーザーがエントリーを保有していることを確認し、‘havent’ は保有していないことを確認します。 検証に失敗した場合、エラーが返されます。 数量指定可能なアクション：いいえ 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceName string ✓ ~ 128文字 ネームスペース名ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 userId string ✓ ~ 128文字 ユーザーID #{userId} と設定することでログイン中のユーザーIDに置換されます。 entryModelName string ✓ ~ 128文字 エントリーモデル名エントリーモデル固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 verifyType 文字列列挙型 enum { “havent”, “have” } ✓ 検証の種類定義説明“havent”指定したエントリーを保有していないこと“have”指定したエントリーを保有していること timeOffsetToken string ~ 1024文字 タイムオフセットトークン Format: JSON YAML GS2-Script { "action": "Gs2Dictionary:VerifyEntryByUserId", "request": { "namespaceName": "[string]ネームスペース名", "userId": "[string]ユーザーID", " /ja/api_reference/distributor/stamp_sheet/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/distributor/stamp_sheet/ Verify Action 検証アクション Gs2Distributor:IfExpressionByUserId 条件を検証し、消費アクションの内容を切り替える 検証アクションを条件として評価し、結果に基づいて trueActions または falseActions の消費アクションリストを実行します。 これによりトランザクション内で条件分岐が可能になり、検証結果に応じて異なる消費アクションを実行できます。 multiplyValueSpecifyingQuantity が有効な場合、検証に使用される値も指定された数量で乗算されます。 数量指定可能なアクション：いいえ 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceName string ✓ ~ 128文字 ネームスペース名ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 userId string ✓ ~ 128文字 ユーザーID #{userId} と設定することでログイン中のユーザーIDに置換されます。 condition VerifyAction ✓ 条件 trueActions List<ConsumeAction> 0 ~ 10 items 条件が真のときに実行される消費アクションリスト falseActions List<ConsumeAction> 0 ~ 10 items 条件が偽のときに実行される消費アクションリスト multiplyValueSpecifyingQuantity bool true 数量指定した際に、検証に使用する値も乗算するか timeOffsetToken string ~ 1024文字 タイムオフセットトークン Format: JSON YAML GS2-Script { "action": " /ja/api_reference/enchant/stamp_sheet/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/enchant/stamp_sheet/ Verify Action 検証アクション Gs2Enchant:VerifyRarityParameterStatusByUserId ユーザーIDを指定してレアリティパラメータを検証 指定されたユーザーのレアリティパラメータの状態が指定された条件を満たすかどうかを検証します。 3つの検証タイプがサポートされています： ‘have’: 指定されたパラメータ値が状態に存在することを検証 ‘havent’: 指定されたパラメータ値が状態に存在しないことを検証 ‘count’: パラメータの数が指定された数と一致することを検証 他のアクションを実行する前の前提条件チェックとして使用できます。 数量指定可能なアクション：はい 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceName string ✓ ~ 128文字 ネームスペース名ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 parameterName string ✓ ~ 128文字 レアリティパラメータモデル名このステータスの抽選条件を定義するレアリティパラメータモデルの名前です。最大パラメータ数、付与数の抽選重み、値の抽選プールを指定するモデルを参照します。 userId string ✓ ~ 128文字 ユーザーID #{userId} と設定することでログイン中のユーザーIDに置換されます。 propertyId string ✓ ~ 1024文字 パラメータの保有元リソースのプロパティIDこれらのレアリティパラメータが紐付けられている特定のゲームリソース（例: 武器や装備アイテム）を識別します。通常、GS2-Inventory のアイテムなどのリソースをプロパティ ID で参照します。 verifyType 文字列列挙型 enum { “havent”, “have”, “count” } ✓ 検証の種類定義説明“havent”指定したパラメータを保有していないこと“have”指定したパラメータを保有していること“count”保有しているパラメータの数が指定数であること parameterValueName string {verifyType} in [“havent”, “have”] ✓※ ~ 64文字 名前この抽選エントリの識別子です。レアリティパラメータモデルの値プール内で一意である必要があります。抽選された際、この名前が結果のレアリティパラメータ値に保存されます。※ verifyType が “havent”,“have"であれば 必須 parameterCount int {verifyType} in [“count”] ✓※ 0 ~ 10 検証するパラメータの数 multiplyValueSpecifyingQuantity bool false 数量指定した際に、検証に使用する値も乗算するか timeOffsetToken string ~ 1024文字 タイムオフセットトークン Format: JSON YAML GS2-Script { " /ja/api_reference/enhance/stamp_sheet/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/enhance/stamp_sheet/ Consume Action 消費アクション Gs2Enhance:DeleteProgressByUserId ユーザーIDを指定して実行中の強化の進行情報を削除 指定されたユーザーの現在進行中の強化の進行情報レコードを削除します。 進行中の2フェーズ強化がキャンセルされ、事前計算された経験値とボーナスレートは破棄されます。 Start フェーズで既に消費された素材は自動的には返還されません。 数量指定可能なアクション：いいえ 反転可能なアクション：いいえ 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceName string ✓ ~ 128文字 ネームスペース名ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 userId string ✓ ~ 128文字 ユーザーID #{userId} と設定することでログイン中のユーザーIDに置換されます。 timeOffsetToken string ~ 1024文字 タイムオフセットトークン Format: JSON YAML GS2-Script { "action": "Gs2Enhance:DeleteProgressByUserId", "request": { "namespaceName": "[string]ネームスペース名", "userId": "[string]ユーザーID", "timeOffsetToken": "[string]タイムオフセットトークン" } } action: Gs2Enhance:DeleteProgressByUserId request: namespaceName: "[string]ネームスペース名" userId: "[string]ユーザーID" timeOffsetToken: "[string]タイムオフセットトークン" transaction.service("enhance").consume.delete_progress_by_user_id({ namespaceName="[string]ネームスペース名", userId="[string]ユーザーID", timeOffsetToken="[string]タイムオフセットトークン", }) Acquire Action 入手アクション /ja/api_reference/exchange/stamp_sheet/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/exchange/stamp_sheet/ Consume Action 消費アクション Gs2Exchange:DeleteAwaitByUserId ユーザーIDを指定して交換待機を削除 指定されたユーザーの交換待機レコードを削除します。 保留中の交換がキャンセルされ、まだ取得されていない報酬は放棄されます。 数量指定可能なアクション：いいえ 反転可能なアクション：いいえ 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceName string ✓ ~ 128文字 ネームスペース名ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 userId string ✓ ~ 128文字 ユーザーID #{userId} と設定することでログイン中のユーザーIDに置換されます。 awaitName string ✓ UUID ~ 36文字 交換待機の名前交換待機の一意な名前を保持します。名前は UUID（Universally Unique Identifier）フォーマットで自動的に生成され、交換待機を識別するために使用されます。 timeOffsetToken string ~ 1024文字 タイムオフセットトークン Format: JSON YAML GS2-Script { "action": "Gs2Exchange:DeleteAwaitByUserId", "request": { "namespaceName": "[string]ネームスペース名", "userId": "[string]ユーザーID", "awaitName": "[string]交換待機の名前", "timeOffsetToken": "[string]タイムオフセットトークン" } } action: Gs2Exchange:DeleteAwaitByUserId request: namespaceName: " /ja/api_reference/experience/stamp_sheet/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/experience/stamp_sheet/ Verify Action 検証アクション Gs2Experience:VerifyRankByUserId ユーザーIDを指定してランクを検証 指定されたユーザーの現在のランクが指定された値に対する条件を満たすことを検証します。 6つの比較演算子をサポート：less、lessEqual、greater、greaterEqual、equal、notEqual。 検証条件を満たさない場合はエラー（BadRequest）を返します。 数量指定可能なアクション：いいえ 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceName string ✓ ~ 128文字 ネームスペース名ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 userId string ✓ ~ 128文字 ユーザーID #{userId} と設定することでログイン中のユーザーIDに置換されます。 experienceName string ✓ ~ 128文字 経験値モデル名このステータスのランキングルールを定義する経験値モデルの名前です。どのランクアップ閾値テーブルとランクキャップ設定が適用されるかを決定します。 verifyType 文字列列挙型 enum { “less”, “lessEqual”, “greater”, “greaterEqual”, “equal”, “notEqual” } ✓ 検証の種類定義説明“less”ランクが指定値未満であること“lessEqual”ランクが指定値以下であること“greater”ランクが指定値超過であること“greaterEqual”ランクが指定値以上であること“equal”ランクが指定値と一致すること“notEqual”ランクが指定値と一致しないこと propertyId string ✓ ~ 1024文字 プロパティIDユーザースコープ内でこのステータスを一意に識別する開発者定義の識別子です。経験値を持つ GS2-Inventory のアイテムセット GRN や GS2-Dictionary のエントリー GRN の末尾に経験値モデルのサフィックスを付与した値を使用することを推奨します。 rankValue long 0 0 ~ 9223372036854775805 現在のランクランクアップ閾値テーブルを使用して累計経験値から算出されるランク（レベル）です。0 から開始し、経験値閾値を超えるごとに増加します。現在のランクキャップ値を超えることはできません。 multiplyValueSpecifyingQuantity bool false 数量指定した際に、検証に使用する値も乗算するか timeOffsetToken string ~ 1024文字 タイムオフセットトークン Format: JSON YAML GS2-Script { " /ja/api_reference/formation/stamp_sheet/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/formation/stamp_sheet/ Consume Action 消費アクション Gs2Formation:SubMoldCapacityByUserId ユーザーIDを指定してキャパシティサイズを減算 指定されたユーザーのフォームの保存領域（モールド）のキャパシティを減算します。キャパシティは0を下回りません。 数量指定可能なアクション：はい 反転可能なアクション：はい 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceName string ✓ ~ 128文字 ネームスペース名ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 userId string ✓ ~ 128文字 ユーザーID #{userId} と設定することでログイン中のユーザーIDに置換されます。 moldModelName string ✓ ~ 128文字 フォームの保存領域モデルの名前フォームの保存領域モデル固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 capacity int ✓ 0 ~ 2147483646 現在のキャパシティこの保存領域でこのプレイヤーが現在利用できるフォーム保存スロット数です。初期値は保存領域モデルの initialMaxCapacity に設定され、キャパシティ増加操作により maxCapacity まで拡張できます。 timeOffsetToken string ~ 1024文字 タイムオフセットトークン Format: JSON YAML GS2-Script { "action": "Gs2Formation:SubMoldCapacityByUserId", "request": { "namespaceName": "[string]ネームスペース名", "userId": "[string]ユーザーID", "moldModelName": " /ja/api_reference/friend/stamp_sheet/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/friend/stamp_sheet/ Acquire Action 入手アクション Gs2Friend:UpdateProfileByUserId ユーザーIDを指定してプロフィールを更新 指定されたユーザーのプロフィールを3つの異なる公開レベルで更新します（サーバーサイド操作）： publicProfile: すべてのユーザーに公開 followerProfile: フォロワーにのみ公開 friendProfile: フレンドにのみ公開 数量指定可能なアクション：いいえ 反転可能なアクション：いいえ 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceName string ✓ ~ 128文字 ネームスペース名ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 userId string ✓ ~ 128文字 ユーザーID #{userId} と設定することでログイン中のユーザーIDに置換されます。 publicProfile string ~ 1024文字 公開されるプロフィール関係性に関わらずすべてのプレイヤーに表示されるプロフィール情報です。通常、表示名、アバター、その他公開可能な情報に使用されます。 followerProfile string ~ 1024文字 フォロワー向けに公開されるプロフィールこのユーザーをフォローしているプレイヤーにのみ表示されるプロフィール情報です。公開プロフィールよりも詳細な情報（ゲームプレイ統計やステータスメッセージなど）を含むことができます。 friendProfile string ~ 1024文字 フレンド向けに公開されるプロフィール相互フレンド関係が成立しているプレイヤーにのみ表示されるプロフィール情報です。最もプライベートなプロフィールレベルで、連絡先やプライベートメッセージなどの個人情報の共有に適しています。 timeOffsetToken string ~ 1024文字 タイムオフセットトークン Format: JSON YAML GS2-Script { "action": "Gs2Friend:UpdateProfileByUserId", "request": { "namespaceName": "[string]ネームスペース名", "userId": "[string]ユーザーID", " /ja/api_reference/grade/stamp_sheet/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/grade/stamp_sheet/ Verify Action 検証アクション Gs2Grade:VerifyGradeByUserId ユーザーIDを指定してグレードを検証 指定されたユーザーのグレード値が指定された条件を満たすことを検証します（サーバーサイド操作）。 6つの比較演算子をサポートします：less（未満）、lessEqual（以下）、greater（超過）、greaterEqual（以上）、equal（一致）、notEqual（不一致）。 条件が満たされない場合、期待値と実際の値を含む説明的なエラーメッセージが返されます。 multiplyValueSpecifyingQuantity が true の場合、検証の閾値は指定された数量で乗算されます。 数量指定可能なアクション：いいえ 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceName string ✓ ~ 128文字 ネームスペース名ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 userId string ✓ ~ 128文字 ユーザーID #{userId} と設定することでログイン中のユーザーIDに置換されます。 gradeName string ✓ ~ 128文字 グレードモデル名このステータスが属するグレードモデルの名前です。グレードエントリのマッピング、連動する経験値モデル、報酬加算テーブルを含むグレードモデル定義を参照します。 verifyType 文字列列挙型 enum { “less”, “lessEqual”, “greater”, “greaterEqual”, “equal”, “notEqual” } ✓ 検証の種類定義説明“less”グレードが指定値未満であること“lessEqual”グレードが指定値以下であること“greater”グレードが指定値超過であること“greaterEqual”グレードが指定値以上であること“equal”グレードが指定値と一致すること“notEqual”グレードが指定値と一致しないこと propertyId string ✓ ~ 1024文字 プロパティIDこのグレードステータスの開発者定義の識別子で、ユーザーとグレードモデル内で一意です。連動する GS2-Experience ステータスのプロパティIDと同じ値を使用することを強く推奨します。これにより、グレード値とランクキャップの正しい同期が保証されます。 gradeValue long 1 1 ~ 9223372036854775805 現在のグレードこのステータスの現在のグレード値です。連動する GS2-Experience モデルのランクキャップを決定するために、グレードモデルのグレードエントリ配列のインデックスとして使用されます。この値が変更されると、関連する経験値ステータスのランクキャップが対応するグレードエントリで定義された値に自動更新されます。 multiplyValueSpecifyingQuantity bool false 数量指定した際に、検証に使用する値も乗算するか timeOffsetToken string ~ 1024文字 タイムオフセットトークン Format: JSON YAML GS2-Script { " /ja/api_reference/guild/stamp_sheet/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/guild/stamp_sheet/ Verify Action 検証アクション Gs2Guild:VerifyCurrentMaximumMemberCountByGuildName ギルド名を指定して最大参加可能人数を検証 選択された比較演算子を使用して、指定されたギルドの currentMaximumMemberCount を指定された値と比較検証します（サーバーサイド操作）。 サポートされる演算子：less、lessEqual、greater、greaterEqual、equal、notEqual。 数量指定可能なアクション：いいえ 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceName string ✓ ~ 128文字 ネームスペース名ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 guildModelName string ✓ ~ 128文字 ギルドモデル名ギルドモデル固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 guildName string ✓ ~ 128文字 ギルド名 verifyType 文字列列挙型 enum { “less”, “lessEqual”, “greater”, “greaterEqual”, “equal”, “notEqual” } ✓ 検証の種類定義説明“less”最大参加可能人数が指定値未満であること“lessEqual”最大参加可能人数が指定値以下であること“greater”最大参加可能人数が指定値超過であること“greaterEqual”最大参加可能人数が指定値以上であること“equal”最大参加可能人数が指定値と一致すること“notEqual”最大参加可能人数が指定値と一致しないこと value int 1 ~ 2147483646 最大参加可能人数 multiplyValueSpecifyingQuantity bool false 数量指定した際に、検証に使用する値も乗算するか Format: JSON YAML GS2-Script { "action": "Gs2Guild:VerifyCurrentMaximumMemberCountByGuildName", " /ja/api_reference/idle/stamp_sheet/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/idle/stamp_sheet/ Consume Action 消費アクション Gs2Idle:DecreaseMaximumIdleMinutesByUserId ユーザーIDを指定して最大待機時間を減算 指定されたカテゴリーにおけるユーザーの最大待機時間から指定された分数を減算します。 最大待機時間はゼロを下回ることはできません。 ステータスがまだ存在しない場合、減算を適用する前に自動的に作成されます。 数量指定可能なアクション：はい 反転可能なアクション：はい 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceName string ✓ ~ 128文字 ネームスペース名ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 userId string ✓ ~ 128文字 ユーザーID #{userId} と設定することでログイン中のユーザーIDに置換されます。 categoryName string ✓ ~ 128文字 カテゴリーモデル名このステータスが属するカテゴリーモデルの名前です。放置報酬計算に使用される報酬間隔、最大放置時間、入手アクション、スケジュール設定を含むカテゴリーモデル定義を参照します。 decreaseMinutes int 1 ~ 2147483646 最大待機時間を減らす分数 timeOffsetToken string ~ 1024文字 タイムオフセットトークン Format: JSON YAML GS2-Script { "action": "Gs2Idle:DecreaseMaximumIdleMinutesByUserId", "request": { "namespaceName": "[string]ネームスペース名", "userId": "[string]ユーザーID", "categoryName": "[string]カテゴリーモデル名", "decreaseMinutes": "[int]最大待機時間を減らす分数", "timeOffsetToken": "[string]タイムオフセットトークン" } } action: Gs2Idle:DecreaseMaximumIdleMinutesByUserId request: namespaceName: " /ja/api_reference/inbox/stamp_sheet/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/inbox/stamp_sheet/ Consume Action 消費アクション Gs2Inbox:OpenMessageByUserId ユーザーIDを指定してメッセージを開封済み化 指定されたユーザーの受信箱にある指定されたメッセージを既読（開封済み）としてマークします。 これは入手アクションを実行せずに isRead を true に設定する単純な状態遷移です。 既読にすると同時に関連する報酬を実行するには、代わりに Read API を使用してください。 数量指定可能なアクション：いいえ 反転可能なアクション：いいえ 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceName string ✓ ~ 128文字 ネームスペース名ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 userId string ✓ ~ 128文字 ユーザーID #{userId} と設定することでログイン中のユーザーIDに置換されます。 messageName string ✓ UUID ~ 36文字 メッセージ名メッセージの一意な名前を保持します。名前は UUID（Universally Unique Identifier）フォーマットで自動的に生成され、各メッセージを識別するために使用されます。 timeOffsetToken string ~ 1024文字 タイムオフセットトークン Format: JSON YAML GS2-Script { "action": "Gs2Inbox:OpenMessageByUserId", "request": { "namespaceName": "[string]ネームスペース名", "userId": "[string]ユーザーID", "messageName": "[string]メッセージ名", " /ja/api_reference/inventory/stamp_sheet/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/inventory/stamp_sheet/ Verify Action 検証アクション Gs2Inventory:VerifyInventoryCurrentMaxCapacityByUserId ユーザーIDを指定してインベントリの最大容量を検証 指定されたユーザーの現在の最大インベントリ容量が指定された条件を満たすことを検証します。 6つの比較演算子をサポートします：less、lessEqual、greater、greaterEqual、equal、notEqual。 検証にはバフ適用後の容量値（GS2-Buff からのアクティブなバフ効果を反映）が使用されます。 数量指定可能なアクション：はい 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceName string ✓ ~ 128文字 ネームスペース名ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 userId string ✓ ~ 128文字 ユーザーID #{userId} と設定することでログイン中のユーザーIDに置換されます。 inventoryName string ✓ ~ 128文字 インベントリモデル名このインベントリの構造と容量設定を定義するインベントリモデルの名前です。ユーザーのインベントリインスタンスをモデル定義にリンクし、使用可能なアイテムの種類と容量制限を決定します。 verifyType 文字列列挙型 enum { “less”, “lessEqual”, “greater”, “greaterEqual”, “equal”, “notEqual” } ✓ 検証の種類定義説明“less”現在のインベントリの最大容量が指定値未満であること“lessEqual”現在のインベントリの最大容量が指定値以下であること“greater”現在のインベントリの最大容量が指定値超過であること“greaterEqual”現在のインベントリの最大容量が指定値以上であること“equal”現在のインベントリの最大容量が指定値と一致すること“notEqual”現在のインベントリの最大容量が指定値と一致しないこと currentInventoryMaxCapacity int ✓ 0 ~ 2147483646 現在のインベントリの最大容量 multiplyValueSpecifyingQuantity bool true 数量指定した際に、検証に使用する値も乗算するか timeOffsetToken string ~ 1024文字 タイムオフセットトークン Format: JSON YAML GS2-Script { " /ja/api_reference/job_queue/stamp_sheet/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/job_queue/stamp_sheet/ Consume Action 消費アクション Gs2JobQueue:DeleteJobByUserId ユーザーIDを指定してジョブを削除 指定ユーザーのジョブキューから特定のジョブを削除します。 実行状態に関係なくジョブが削除されます。 数量指定可能なアクション：いいえ 反転可能なアクション：いいえ 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceName string ✓ ~ 128文字 ネームスペース名ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 userId string ✓ ~ 128文字 ユーザーID #{userId} と設定することでログイン中のユーザーIDに置換されます。 jobName string ✓ UUID ~ 36文字 ジョブの名前ジョブの一意な名前を保持します。名前は UUID（Universally Unique Identifier）フォーマットで自動的に生成され、各ジョブを識別するために使用されます。 timeOffsetToken string ~ 1024文字 タイムオフセットトークン Format: JSON YAML GS2-Script { "action": "Gs2JobQueue:DeleteJobByUserId", "request": { "namespaceName": "[string]ネームスペース名", "userId": "[string]ユーザーID", "jobName": "[string]ジョブの名前", "timeOffsetToken": "[string]タイムオフセットトークン" } } action: Gs2JobQueue:DeleteJobByUserId request: namespaceName: " /ja/api_reference/limit/stamp_sheet/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/limit/stamp_sheet/ Verify Action 検証アクション Gs2Limit:VerifyCounterByUserId ユーザーIDを指定してカウンター値を検証 指定されたユーザーのカウンター値が指定された条件を満たすことを検証します。 6つの比較演算子をサポートします：less、lessEqual、greater、greaterEqual、equal、notEqual。 数量指定可能なアクション：いいえ 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceName string ✓ ~ 128文字 ネームスペース名ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 userId string ✓ ~ 128文字 ユーザーID #{userId} と設定することでログイン中のユーザーIDに置換されます。 limitName string ✓ ~ 128文字 回数制限モデル名このカウンターが属する回数制限モデルの名前です。このカウンターの値に適用されるリセットスケジュール（毎日、毎週、毎月など）を決定します。 counterName string ✓ ~ 128文字 カウンターの名前回数制限モデル内でこのカウンターを一意に識別する名前です。同じ回数制限モデルを異なる名前の複数のカウンターで共有でき、個別の回数制限モデルを作成せずに別々の使用回数追跡（例：クエストごとや商品ごとに1カウンター）が可能です。 verifyType 文字列列挙型 enum { “less”, “lessEqual”, “greater”, “greaterEqual”, “equal”, “notEqual” } ✓ 検証の種類定義説明“less”カウンター値が指定値未満であること“lessEqual”カウンター値が指定値以下であること“greater”カウンター値が指定値超過であること“greaterEqual”カウンター値が指定値以上であること“equal”カウンター値が指定値と一致すること“notEqual”カウンター値が指定値と一致しないこと count int 0 0 ~ 2147483646 カウント値このカウンターの現在の使用回数です。countUp操作でインクリメントされ、その際に指定された最大値と比較されます。回数制限モデルのリセットタイミングに達すると自動的にゼロにリセットされます。 multiplyValueSpecifyingQuantity bool true 数量指定した際に、検証に使用する値も乗算するか timeOffsetToken string ~ 1024文字 タイムオフセットトークン Format: JSON YAML GS2-Script { " /ja/api_reference/login_reward/stamp_sheet/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/login_reward/stamp_sheet/ Consume Action 消費アクション Gs2LoginReward:MarkReceivedByUserId ユーザーIDを指定して受け取り済み化 指定されたユーザーのボーナスモデルで特定のステップを手動で受け取り済みにマークします。 数量指定可能なアクション：いいえ 反転可能なアクション：はい 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceName string ✓ ~ 128文字 ネームスペース名ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 bonusModelName string ✓ ~ 128文字 ボーナスモデル名この受け取り状態が紐づくログインボーナスモデルの名前。ユーザーの受け取り進捗を特定のボーナスモデル定義に関連づけ、どの報酬リストと配布ルールが適用されるかを決定します。 userId string ✓ ~ 128文字 ユーザーID #{userId} と設定することでログイン中のユーザーIDに置換されます。 stepNumber int ✓ 0 ~ 100 ステップ番号 timeOffsetToken string ~ 1024文字 タイムオフセットトークン Format: JSON YAML GS2-Script { "action": "Gs2LoginReward:MarkReceivedByUserId", "request": { "namespaceName": "[string]ネームスペース名", "bonusModelName": "[string]ボーナスモデル名", "userId": "[string]ユーザーID", "stepNumber": "[int]ステップ番号", "timeOffsetToken": "[string]タイムオフセットトークン" } } action: Gs2LoginReward:MarkReceivedByUserId request: namespaceName: " /ja/api_reference/lottery/stamp_sheet/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/lottery/stamp_sheet/ Acquire Action 入手アクション Gs2Lottery:DrawByUserId ユーザーIDを指定して抽選を実行 抽選モデルの設定に基づいて、指定されたユーザーの抽選を実行します。 抽選は2つの方式をサポートします：排出確率テーブルモード（事前定義された確率テーブルを使用）とスクリプトモード（GS2-Script で景品を決定）。 ボックス抽選モードでは、排出された景品はボックスから削除され再度排出されません。ボックスが空の場合は Empty エラーが返されます。 排出された景品はトランザクションとして発行されます。 数量指定可能なアクション：はい 反転可能なアクション：いいえ 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceName string ✓ ~ 128文字 ネームスペース名 lotteryName string ✓ ~ 128文字 抽選モデル名抽選モデル固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 userId string ✓ ~ 128文字 ユーザーID #{userId} と設定することでログイン中のユーザーIDに置換されます。 count int ✓ 1 ~ 1000 抽選回数 config List<Config> [] 0 ~ 1000 items トランザクションのプレースホルダに適用する設定値 timeOffsetToken string ~ 1024文字 タイムオフセットトークン Format: JSON YAML GS2-Script { "action": "Gs2Lottery:DrawByUserId", " /ja/api_reference/matchmaking/stamp_sheet/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/matchmaking/stamp_sheet/ Verify Action 検証アクション Gs2Matchmaking:VerifyIncludeParticipantByUserId ユーザーIDを指定して永続ギャザリングにユーザーIDが含まれているかを検証 指定されたユーザーがシーズンギャザリングに参加しているかどうかを検証します。 数量指定可能なアクション：いいえ 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceName string ✓ ~ 128文字 ネームスペース名ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 seasonName string ✓ ~ 128文字 シーズンモデル名シーズンモデル固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 season long ✓ 0 ~ 9223372036854775805 シーズン tier long ✓ 0 ~ 9223372036854775805 ティアー同程度のランクのプレイヤーをグルーピングするためのティアーレベル。SeasonModel で指定された GS2-Experience モデルにおけるプレイヤーのランクによって決定されます。プレイヤーは同じティアーのプレイヤーとのみマッチングされ、公平な対戦が保証されます。 seasonGatheringName string ✓ UUID ~ 128文字 シーズンギャザリング名シーズンギャザリング固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 userId string ✓ ~ 128文字 ユーザーID #{userId} と設定することでログイン中のユーザーIDに置換されます。 verifyType 文字列列挙型 enum { /ja/api_reference/mission/stamp_sheet/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/mission/stamp_sheet/ Verify Action 検証アクション Gs2Mission:VerifyCompleteByUserId ユーザーIDを指定してミッションの達成状況を検証 指定されたユーザーのミッションタスクの達成状況または受領状況を検証します。 数量指定可能なアクション：いいえ 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceName string ✓ ~ 128文字 ネームスペース名ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 missionGroupName string ✓ ~ 128文字 ミッショングループ名この達成状況レコードが属するミッショングループの名前です。ユーザーごと・ミッショングループごとに1つの達成状況レコードが存在します。 userId string ✓ ~ 128文字 ユーザーID #{userId} と設定することでログイン中のユーザーIDに置換されます。 verifyType 文字列列挙型 enum { “completed”, “notCompleted”, “received”, “notReceived”, “completedAndNotReceived” } ✓ 検証の種類定義説明“completed”条件が達成済みであること“notCompleted”条件が未達成であること“received”報酬を受け取り済みであること“notReceived”報酬が未受け取りであること“completedAndNotReceived”条件が達成済みで、報酬を未受け取りであること missionTaskName string ✓ ~ 128文字 ミッションタスクモデル名ミッションタスクモデル固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 multiplyValueSpecifyingQuantity bool false 数量指定した際に、検証に使用する値も乗算するか timeOffsetToken string ~ 1024文字 タイムオフセットトークン Format: JSON YAML GS2-Script { " /ja/api_reference/money/stamp_sheet/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/money/stamp_sheet/ Consume Action 消費アクション Gs2Money:WithdrawByUserId ユーザーIDを指定してウォレットから残高を消費 指定されたユーザーのウォレットから指定量の通貨を消費します。 paidOnly が false の場合、無償通貨が先に消費され、次に有償通貨が消費されます。 数量指定可能なアクション：はい 反転可能なアクション：はい 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceName string ✓ ~ 128文字 ネームスペース名ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 userId string ✓ ~ 128文字 ユーザーID #{userId} と設定することでログイン中のユーザーIDに置換されます。 slot int ✓ 0 ~ 100000000 スロット番号プラットフォームやコンテキストごとにウォレット残高を分離するための識別子。異なるスロットにより、別々の有償通貨プールを管理できます（例: iOS購入はスロット0、Androidはスロット1）。無償通貨はネームスペースの shareFree 設定により、全スロット間で共有することもできます。 count int ✓ 1 ~ 2147483646 消費する課金通貨の数量 paidOnly bool false 有償通貨のみを対象とするか timeOffsetToken string ~ 1024文字 タイムオフセットトークン Format: JSON YAML GS2-Script { "action": "Gs2Money:WithdrawByUserId", "request": { " /ja/api_reference/money2/stamp_sheet/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/money2/stamp_sheet/ Consume Action 消費アクション Gs2Money2:WithdrawByUserId ユーザーIDを指定してウォレットから残高を消費 指定されたユーザーのウォレットから指定量の通貨を消費します。 paidOnly が false の場合、無償通貨が先に消費され、次に有償通貨が消費されます。 数量指定可能なアクション：はい 反転可能なアクション：はい 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceName string ✓ ~ 128文字 ネームスペース名ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 userId string ✓ ~ 128文字 ユーザーID #{userId} と設定することでログイン中のユーザーIDに置換されます。 slot int ✓ 0 ~ 100000000 スロット番号ウォレットスロットを識別します。プラットフォーム間の残高共有が許可されていない場合、異なるスロットを使用してプラットフォームごとに通貨を分けて管理できます（例：iOS用とAndroid用）。 withdrawCount int ✓ 1 ~ 2147483646 消費する課金通貨の数量 paidOnly bool false 有償通貨のみを対象とするか timeOffsetToken string ~ 1024文字 タイムオフセットトークン Format: JSON YAML GS2-Script { "action": "Gs2Money2:WithdrawByUserId", "request": { "namespaceName": "[string]ネームスペース名", "userId": " /ja/api_reference/quest/stamp_sheet/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/quest/stamp_sheet/ Consume Action 消費アクション Gs2Quest:DeleteProgressByUserId ユーザーIDを指定してクエスト進行状況を削除 指定したユーザーの現在のクエスト進行状況を削除します。進行中のクエストをキャンセルし、新しいクエストを開始できるようにします。 数量指定可能なアクション：いいえ 反転可能なアクション：いいえ 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceName string ✓ ~ 128文字 ネームスペース名ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 userId string ✓ ~ 128文字 ユーザーID #{userId} と設定することでログイン中のユーザーIDに置換されます。 timeOffsetToken string ~ 1024文字 タイムオフセットトークン Format: JSON YAML GS2-Script { "action": "Gs2Quest:DeleteProgressByUserId", "request": { "namespaceName": "[string]ネームスペース名", "userId": "[string]ユーザーID", "timeOffsetToken": "[string]タイムオフセットトークン" } } action: Gs2Quest:DeleteProgressByUserId request: namespaceName: "[string]ネームスペース名" userId: "[string]ユーザーID" timeOffsetToken: "[string]タイムオフセットトークン" transaction.service("quest").consume.delete_progress_by_user_id({ namespaceName="[string]ネームスペース名", userId="[string]ユーザーID", timeOffsetToken="[string]タイムオフセットトークン", }) Acquire Action 入手アクション /ja/api_reference/ranking2/stamp_sheet/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/ranking2/stamp_sheet/ Verify Action 検証アクション Gs2Ranking2:VerifyGlobalRankingScoreByUserId ユーザーIDを指定してグローバルランキングのスコアを検証 指定したユーザーのグローバルランキングスコアを比較演算子（less, lessEqual, greater, greaterEqual, equal, notEqual）を使用して指定した値と比較検証します。 数量指定可能なアクション：はい 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceName string ✓ ~ 128文字 ネームスペース名ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 userId string ✓ ~ 128文字 ユーザーID #{userId} と設定することでログイン中のユーザーIDに置換されます。 rankingName string ✓ ~ 128文字 グローバルランキングモデル名グローバルランキングモデル固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 verifyType 文字列列挙型 enum { “less”, “lessEqual”, “greater”, “greaterEqual”, “equal”, “notEqual” } ✓ 検証の種類定義説明“less”スコアが指定値未満であること“lessEqual”スコアが指定値以下であること“greater”スコアが指定値超過であること“greaterEqual”スコアが指定値以上であること“equal”スコアが指定値と一致すること“notEqual”スコアが指定値と一致しないこと season long 0 ~ 9223372036854775805 シーズン score long ✓ 0 ~ 9223372036854775805 スコアユーザーが登録したスコア値です。ランキングモデルの minimumValue と maximumValue で定義された範囲内である必要があります。 multiplyValueSpecifyingQuantity bool true 数量指定した際に、検証に使用する値も乗算するか timeOffsetToken string ~ 1024文字 タイムオフセットトークン Format: JSON YAML GS2-Script { " /ja/api_reference/schedule/stamp_sheet/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/schedule/stamp_sheet/ Verify Action 検証アクション Gs2Schedule:VerifyTriggerByUserId ユーザーIDを指定してトリガーが引かれてからの経過時間を検証 指定したユーザーのトリガーの状態に関する条件を検証します。verifyType は ’notTriggerd’、’elapsed’、’notElapsed’ を設定できます。検証条件が満たされない場合はエラーを返します。 数量指定可能なアクション：いいえ 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceName string ✓ ~ 128文字 ネームスペース名ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 userId string ✓ ~ 128文字 ユーザーID #{userId} と設定することでログイン中のユーザーIDに置換されます。 triggerName string ✓ ~ 128文字 トリガー名トリガー固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 verifyType 文字列列挙型 enum { “notTriggerd”, “elapsed”, “notElapsed” } ✓ 検証の種類定義説明“notTriggerd”トリガーが引かれていない“elapsed”指定時間が経過している“notElapsed”指定時間が経過していない elapsedMinutes int {verifyType} in [“elapsed”, “notElapsed”] ✓※ 0 ~ 2147483646 経過時間(分)※ verifyType が “elapsed”,“notElapsed"であれば 必須 timeOffsetToken string ~ 1024文字 タイムオフセットトークン Format: JSON YAML GS2-Script { " /ja/api_reference/script/stamp_sheet/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/script/stamp_sheet/ Acquire Action 入手アクション Gs2Script:InvokeScript スクリプトを実行 指定されたLuaスクリプトを提供されたJSON引数で同期的に実行します。ステータスコード、戻り値、トランザクション情報、乱数状態、実行時間、標準出力を含む実行結果を返します。GS2サービス間のアトミック操作のためのトランザクション処理をサポートしています。 数量指定可能なアクション：いいえ 反転可能なアクション：いいえ 型 有効化条件 必須 デフォルト 値の制限 説明 scriptId string ✓ ~ 1024文字 スクリプト GRN userId string ~ 128文字 ユーザーID #{userId} と設定することでログイン中のユーザーIDに置換されます。 args string “{}” ~ 5242880文字 スクリプトに渡される引数 (JSON形式) randomStatus RandomStatus 乱数の状態 timeOffsetToken string ~ 1024文字 タイムオフセットトークン Format: JSON YAML GS2-Script { "action": "Gs2Script:InvokeScript", "request": { "scriptId": "[string]スクリプトGRN", "userId": "[string]ユーザーID", "args": "[string]スクリプトに渡される引数 (JSON形式)", "randomStatus": { "seed": "[long]乱数シード", "used": [ { "category": "[long]カテゴリ", "used": "[long]使用回数" } ] }, " /ja/api_reference/serial_key/stamp_sheet/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/serial_key/stamp_sheet/ Verify Action 検証アクション Gs2SerialKey:VerifyCodeByUserId ユーザーIDを指定してシリアルコードの有効性を確認 指定されたユーザーのシリアルコードを消費せずに検証します。特定のキャンペーンモデル名に対する検証をサポートし、コードがactive（未使用）かinactive（使用済み）かを確認できます。 数量指定可能なアクション：いいえ 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceName string ✓ ~ 128文字 ネームスペース名ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 userId string ✓ ~ 128文字 ユーザーID #{userId} と設定することでログイン中のユーザーIDに置換されます。 code string ✓ ~ 48文字 シリアルコード「XXXXX-XXXX-XXXXX-XXXX-XXXX」形式のシリアルコード文字列です。各コードは一意で、キャンペーン識別情報が含まれています。コードの形式とデータ長は固定で変更できません。 campaignModelName string ~ 128文字 キャンペーン名このシリアルコードが属するキャンペーンモデルの名前です。キャンペーン情報はシリアルコード自体に埋め込まれているため、コード使用時にはネームスペースを指定するだけで利用できます。 verifyType 文字列列挙型 enum { “active”, “inactive” } ✓ 検証タイプ定義説明“active”有効“inactive”無効 timeOffsetToken string ~ 1024文字 タイムオフセットトークン Format: JSON YAML GS2-Script { "action": "Gs2SerialKey:VerifyCodeByUserId", "request": { "namespaceName": "[string]ネームスペース名", "userId": "[string]ユーザーID", "code": "[string]シリアルコード", " /ja/api_reference/showcase/stamp_sheet/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/showcase/stamp_sheet/ Consume Action 消費アクション Gs2Showcase:IncrementPurchaseCountByUserId ユーザーIDを指定して購入回数を加算 指定されたユーザーのランダム陳列棚の特定の商品の購入回数を加算します。ローテーション期間ごとの購入制限を追跡するために使用されます。 数量指定可能なアクション：はい 反転可能なアクション：はい 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceName string ✓ ~ 128文字 ネームスペース名ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 showcaseName string ✓ ~ 128文字 ランダム陳列棚名 displayItemName string ✓ ~ 128文字 商品購入回数名購入回数を追跡するランダム陳列商品の名前です。ランダム陳列棚内の陳列商品名に対応します。 userId string ✓ ~ 128文字 ユーザーID #{userId} と設定することでログイン中のユーザーIDに置換されます。 count int ✓ 0 ~ 100 加算する購入回数 timeOffsetToken string ~ 1024文字 タイムオフセットトークン Format: JSON YAML GS2-Script { "action": "Gs2Showcase:IncrementPurchaseCountByUserId", "request": { "namespaceName": "[string]ネームスペース名", "showcaseName": "[string]ランダム陳列棚名", "displayItemName": "[string]商品購入回数名", " /ja/api_reference/skill_tree/stamp_sheet/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/skill_tree/stamp_sheet/ Consume Action 消費アクション Gs2SkillTree:MarkRestrainByUserId ユーザーIDを指定してノードの解放状態を未解放化 指定されたノードが拘束可能であることを検証し（依存するノードが解放状態でないことが必要です）、未解放としてマークします。 数量指定可能なアクション：いいえ 反転可能なアクション：はい 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceName string ✓ ~ 128文字 ネームスペース名ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 userId string ✓ ~ 128文字 ユーザーID #{userId} と設定することでログイン中のユーザーIDに置換されます。 propertyId string ✓ ~ 1024文字 プロパティIDユーザーごとに複数の独立したスキルツリーインスタンスを持つための識別子。同一ネームスペース内で、プレイヤーが異なるキャラクターやコンテキストに対して別々のスキルツリーを持つシナリオを実現します。最大1024文字。 nodeModelNames List<string> ✓ 1 ~ 1000 items ノードモデル名のリスト timeOffsetToken string ~ 1024文字 タイムオフセットトークン Format: JSON YAML GS2-Script { "action": "Gs2SkillTree:MarkRestrainByUserId", "request": { "namespaceName": "[string]ネームスペース名", "userId": "[string]ユーザーID", "propertyId": "[string]プロパティID", "nodeModelNames": [ "[string]ノードモデル名" ], "timeOffsetToken": " /ja/api_reference/stamina/stamp_sheet/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/stamina/stamp_sheet/ Verify Action 検証アクション Gs2Stamina:VerifyStaminaValueByUserId ユーザーIDを指定してスタミナ現在値を検証 指定されたユーザーの現在のスタミナ値が指定された条件を指定された閾値に対して満たすことを、状態を変更せずに検証します。 数量指定可能なアクション：はい 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceName string ✓ ~ 128文字 ネームスペース名ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 userId string ✓ ~ 128文字 ユーザーID #{userId} と設定することでログイン中のユーザーIDに置換されます。 staminaName string ✓ ~ 128文字 スタミナモデル名このスタミナインスタンスの回復パラメータ、容量、テーブル参照を定義する StaminaModel の名前。ユーザーごとのスタミナ状態を対応するモデル定義に紐づけます。 verifyType 文字列列挙型 enum { “less”, “lessEqual”, “greater”, “greaterEqual”, “equal”, “notEqual” } ✓ 検証の種類定義説明“less”現在値が指定値未満であること“lessEqual”現在値が指定値以下であること“greater”現在値が指定値超過であること“greaterEqual”現在値が指定値以上であること“equal”現在値が指定値と一致すること“notEqual”現在値が指定値と一致しないこと value int ✓ 0 ~ 2147483646 現在値 multiplyValueSpecifyingQuantity bool true 数量指定した際に、検証に使用する値も乗算するか timeOffsetToken string ~ 1024文字 タイムオフセットトークン Format: JSON YAML GS2-Script { " /ja/api_reference/state_machine/stamp_sheet/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/state_machine/stamp_sheet/ Acquire Action 入手アクション Gs2StateMachine:StartStateMachineByUserId ユーザーIDを指定してステートマシンを開始 最新のマスターバージョンを使用して、指定したユーザーの新しいステートマシンインスタンスを開始します。引数はJSONとして渡され、ステートマシン変数にパースされます。オプションのTTL（分単位）を設定できます。省略した場合、ステートマシンは約10年間有効です。 数量指定可能なアクション：いいえ 反転可能なアクション：いいえ 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceName string ✓ ~ 128文字 ネームスペース名ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 userId string ✓ ~ 128文字 ユーザーID #{userId} と設定することでログイン中のユーザーIDに置換されます。 args string “{}” ~ 4096文字 ステートマシンに渡す引数 ttl int 1 ~ 525600 有効期間(分) timeOffsetToken string ~ 1024文字 タイムオフセットトークン Format: JSON YAML GS2-Script { "action": "Gs2StateMachine:StartStateMachineByUserId", "request": { "namespaceName": "[string]ネームスペース名", "userId": "[string]ユーザーID", "args": "[string]ステートマシンに渡す引数", "ttl": "[int]有効期間(分)", "timeOffsetToken": "[string]タイムオフセットトークン" } } action: Gs2StateMachine:StartStateMachineByUserId request: namespaceName: "