/tags/transaction-action/ Recent content in Transaction Action on Game Server Services | Docs Hugo en /api_reference/transaction/game_engine/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/transaction/game_engine/ What is Transaction Processing? Transaction processing in GS2 refers to the mass execution of exchanging resources defined as “consume action” and “get action”. APIs that issue transactions are such as GS2-Exchange’s exchange execution function (Exchange), GS2-Showcase’s product purchase function (Buy), and GS2-Quest’s quest start function (Start). Consumption actions" are user data operations that are disadvantageous to the player, while “acquisition actions” are user data operations that are beneficial to the player. /api_reference/transaction/sdk/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/transaction/sdk/ About GS2-SDK for Game Engine transaction processing Please refer to the for Game Engine document for the basic concept and processing flow. On the other hand, GS2-SDK does not provide as extensive support as for Game Engine. Specifically, there is no cache function or EzTransactionDomain. Transaction Execution If auto-execution is enabled You must explicitly set a user ID on GS2-Gateway in order to receive completion notifications. GS2-Gateway::setUserId Need to handle completion notification. /articles/tech/transaction/ Mon, 01 Jan 0001 00:00:00 +0000 /articles/tech/transaction/ The microservices provided by GS2 generally have a field named TransactionSetting in their namespace configuration. TransactionSetting has the following structure: 型 有効化条件 必須 デフォルト 値の制限 説明 enableAutoRun bool ✓ false Execute the issued transaction automatically on the server side enableAtomicCommit bool {enableAutoRun} == true ✓ false Commit the transaction atomically Required if enableAutoRun is true transactionUseDistributor bool {enableAtomicCommit} == true ✓ false Execute transactions asynchronously Required if enableAtomicCommit is true commitScriptResultInUseDistributor bool {transactionUseDistributor} == true ✓ false Execute the script’s result commit processing asynchronously /api_reference/ad_reward/stamp_sheet/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/ad_reward/stamp_sheet/ Consume Action Gs2AdReward:ConsumePointByUserId Consume Points by specifying a user ID Subtracts a specified number of points from the specified user ID and returns the updated point information. An error is returned if the user does not have enough points to cover the requested consumption amount. If a GS2-Script is configured in the namespace’s consume script settings, the script is executed before the point deduction, allowing custom validation or modification of the consume amount. /api_reference/dictionary/stamp_sheet/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/dictionary/stamp_sheet/ Verify Action Gs2Dictionary:VerifyEntryByUserId Verify Entry by specifying a user ID Verifies whether the specified user has or has not collected a specific entry. The verify type specifies the condition: ‘have’ checks that the user has the entry, ‘havent’ checks that the user does not have it. If the verification fails, an error is returned. Supports quantity specification: NO Type Condition Required Default Value Limits Description namespaceName string ✓ ~ 128 chars Namespace nameNamespace-specific name. /api_reference/distributor/stamp_sheet/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/distributor/stamp_sheet/ Verify Action Gs2Distributor:IfExpressionByUserId Validate the condition and switch the contents of the Consume Action Evaluates a verify action as a condition, and executes either the trueActions or falseActions list of consume actions based on the result. This enables conditional branching within a transaction, allowing different consume actions to be executed depending on the verification outcome. When multiplyValueSpecifyingQuantity is enabled, the values used for verification are also multiplied by the specified quantity. /api_reference/enchant/stamp_sheet/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/enchant/stamp_sheet/ Verify Action Gs2Enchant:VerifyRarityParameterStatusByUserId Verify rarity parameter by specifying a user ID Verifies that a rarity parameter status of the specified user meets the specified condition. Three verification types are supported: ‘have’: Verifies that the specified parameter value exists in the status ‘havent’: Verifies that the specified parameter value does not exist in the status ‘count’: Verifies that the number of parameters matches the specified count This can be used as a precondition check before executing other actions. /api_reference/enhance/stamp_sheet/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/enhance/stamp_sheet/ Consume Action Gs2Enhance:DeleteProgressByUserId Delete running enhancement by specifying a user ID Deletes the progress record of the enhancement currently in progress for the specified user. This cancels the ongoing 2-phase enhancement, discarding the pre-calculated experience and bonus rate. Materials that were already consumed during the Start phase are not automatically refunded. Supports quantity specification: NO Whether the action is reversible: NO Type Condition Required Default Value Limits Description namespaceName string ✓ ~ 128 chars Namespace nameNamespace-specific name. /api_reference/exchange/stamp_sheet/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/exchange/stamp_sheet/ Consume Action Gs2Exchange:DeleteAwaitByUserId Delete Exchange Await by specifying a user ID Deletes an exchange await record for the specified user. This cancels the pending exchange, and any rewards that have not yet been acquired are forfeited. Supports quantity specification: NO Whether the action is reversible: NO Type Condition Required Default Value Limits Description namespaceName string ✓ ~ 128 chars Namespace nameNamespace-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (. /api_reference/experience/stamp_sheet/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/experience/stamp_sheet/ Verify Action Gs2Experience:VerifyRankByUserId Verify rank by specifying a user ID Verifies that the specified user’s current rank satisfies a condition against a specified value. Supports six comparison operators: less, lessEqual, greater, greaterEqual, equal, notEqual. Returns an error (BadRequest) if the verification condition is not met. Supports quantity specification: NO Type Condition Required Default Value Limits Description namespaceName string ✓ ~ 128 chars Namespace nameNamespace-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (. /api_reference/formation/stamp_sheet/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/formation/stamp_sheet/ Consume Action Gs2Formation:SubMoldCapacityByUserId Subtract capacity size by specifying a user ID Decreases the capacity of the form storage area (mold) for the specified user. The capacity will not go below 0. Supports quantity specification: YES Whether the action is reversible: YES Type Condition Required Default Value Limits Description namespaceName string ✓ ~ 128 chars Namespace nameNamespace-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.). userId string ✓ ~ 128 chars User ID /api_reference/friend/stamp_sheet/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/friend/stamp_sheet/ Acquire Action Gs2Friend:UpdateProfileByUserId Update profile by specifying a user ID Updates the specified user’s profile with three distinct visibility levels (server-side operation): publicProfile: visible to all users followerProfile: visible only to followers friendProfile: visible only to friends Supports quantity specification: NO Whether the action is reversible: NO Type Condition Required Default Value Limits Description namespaceName string ✓ ~ 128 chars Namespace nameNamespace-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (. /api_reference/grade/stamp_sheet/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/grade/stamp_sheet/ Verify Action Gs2Grade:VerifyGradeByUserId Verify grade by specifying a user ID Verifies that the specified user’s grade value satisfies a specified condition (server-side operation). Supports six comparison operators: less, lessEqual, greater, greaterEqual, equal, and notEqual. If the condition is not met, an error is returned with a descriptive message including the expected and actual values. When multiplyValueSpecifyingQuantity is true, the verification threshold value is multiplied by the specified quantity. Supports quantity specification: NO /api_reference/guild/stamp_sheet/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/guild/stamp_sheet/ Verify Action Gs2Guild:VerifyCurrentMaximumMemberCountByGuildName Verify the maximum number of guild members by specifying a Guild name Verifies the specified guild’s currentMaximumMemberCount against the specified value using the chosen comparison operator (server-side operation). Supported operators: less, lessEqual, greater, greaterEqual, equal, notEqual. Supports quantity specification: NO Type Condition Required Default Value Limits Description namespaceName string ✓ ~ 128 chars Namespace nameNamespace-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.). guildModelName string ✓ ~ 128 chars Guild Model nameGuild Model-specific name. /api_reference/idle/stamp_sheet/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/idle/stamp_sheet/ Consume Action Gs2Idle:DecreaseMaximumIdleMinutesByUserId Decrease the maximum idle time by specifying a user ID Subtracts the specified number of minutes from the user’s maximum idle time for the given category. The maximum idle time cannot go below zero. If no status exists yet, it is automatically created before applying the decrease. Supports quantity specification: YES Whether the action is reversible: YES Type Condition Required Default Value Limits Description namespaceName string ✓ ~ 128 chars Namespace nameNamespace-specific name. /api_reference/inbox/stamp_sheet/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/inbox/stamp_sheet/ Consume Action Gs2Inbox:OpenMessageByUserId Marking messages as opened by specifying a user ID Marks the specified message as read (opened) in the specified user’s inbox. This is a simple state transition that sets isRead to true without executing any acquire actions. To mark as read and also execute associated rewards, use the Read API instead. Supports quantity specification: NO Whether the action is reversible: NO Type Condition Required Default Value Limits Description namespaceName string ✓ ~ 128 chars Namespace nameNamespace-specific name. /api_reference/inventory/stamp_sheet/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/inventory/stamp_sheet/ Verify Action Gs2Inventory:VerifyInventoryCurrentMaxCapacityByUserId Verify current max inventory capacity by specifying a user ID Verifies that the specified user’s current maximum inventory capacity satisfies the given condition. Supports 6 comparison operators: less, lessEqual, greater, greaterEqual, equal, notEqual. The verification uses the buffed capacity value (reflecting any active buff effects from GS2-Buff). Supports quantity specification: YES Type Condition Required Default Value Limits Description namespaceName string ✓ ~ 128 chars Namespace nameNamespace-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (. /api_reference/job_queue/stamp_sheet/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/job_queue/stamp_sheet/ Consume Action Gs2JobQueue:DeleteJobByUserId Delete a job by specifying a user ID Deletes a specific job from the specified user’s job queue. The job is removed regardless of its execution state. Supports quantity specification: NO Whether the action is reversible: NO Type Condition Required Default Value Limits Description namespaceName string ✓ ~ 128 chars Namespace nameNamespace-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.). userId string ✓ ~ 128 chars User ID /api_reference/limit/stamp_sheet/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/limit/stamp_sheet/ Verify Action Gs2Limit:VerifyCounterByUserId Verify Counter value by specifying a user ID Verifies that the specified user’s counter value satisfies the given condition. Supports 6 comparison operators: less, lessEqual, greater, greaterEqual, equal, notEqual. Supports quantity specification: NO Type Condition Required Default Value Limits Description namespaceName string ✓ ~ 128 chars Namespace nameNamespace-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.). userId string ✓ ~ 128 chars User ID /api_reference/login_reward/stamp_sheet/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/login_reward/stamp_sheet/ Consume Action Gs2LoginReward:MarkReceivedByUserId Mark as received by specifying a user ID Manually marks a specific step as received for the specified user’s bonus model. Supports quantity specification: NO Whether the action is reversible: YES Type Condition Required Default Value Limits Description namespaceName string ✓ ~ 128 chars Namespace nameNamespace-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.). bonusModelName string ✓ ~ 128 chars Bonus Model NameThe name of the Login Bonus Model that this receive status is associated with. /api_reference/lottery/stamp_sheet/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/lottery/stamp_sheet/ Acquire Action Gs2Lottery:DrawByUserId Execute a lottery by specifying a User ID Performs a lottery draw for the specified user based on the lottery model configuration. The lottery supports two methods: Prize Table mode (using predefined probability tables) and Script mode (using a GS2-Script to determine prizes). In box lottery mode, drawn prizes are removed from the box and cannot be drawn again. If the box is empty, an Empty error is returned. /api_reference/matchmaking/stamp_sheet/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/matchmaking/stamp_sheet/ Verify Action Gs2Matchmaking:VerifyIncludeParticipantByUserId Verify if persistent gathering includes user ID by specifying a user ID Verifies whether the specified user is or is not a participant of the season gathering. Supports quantity specification: NO Type Condition Required Default Value Limits Description namespaceName string ✓ ~ 128 chars Namespace nameNamespace-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.). seasonName string ✓ ~ 128 chars Season Model nameSeason Model-specific name. /api_reference/mission/stamp_sheet/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/mission/stamp_sheet/ Verify Action Gs2Mission:VerifyCompleteByUserId Verify Completion Status by specifying a user ID Verifies the completion or receipt status of a mission task for the specified user. Supports quantity specification: NO Type Condition Required Default Value Limits Description namespaceName string ✓ ~ 128 chars Namespace nameNamespace-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.). missionGroupName string ✓ ~ 128 chars Mission Group NameThe name of the mission group that this completion record belongs to. /api_reference/money/stamp_sheet/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/money/stamp_sheet/ Consume Action Gs2Money:WithdrawByUserId Consume balance from wallet by specifying a user ID Withdraws the specified amount of currency from the wallet for the specified user. If paidOnly is false, free currency is consumed first, then paid currency. Supports quantity specification: YES Whether the action is reversible: YES Type Condition Required Default Value Limits Description namespaceName string ✓ ~ 128 chars Namespace nameNamespace-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (. /api_reference/money2/stamp_sheet/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/money2/stamp_sheet/ Consume Action Gs2Money2:WithdrawByUserId Withdraw balance from Wallet by specifying a user ID Withdraws the specified amount of currency from the wallet for the specified user. If paidOnly is false, free currency is consumed first, then paid currency. Supports quantity specification: YES Whether the action is reversible: YES Type Condition Required Default Value Limits Description namespaceName string ✓ ~ 128 chars Namespace nameNamespace-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (. /api_reference/quest/stamp_sheet/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/quest/stamp_sheet/ Consume Action Gs2Quest:DeleteProgressByUserId Delete Quest Progress by specifying a user ID Deletes the current quest progress for the specified user. This cancels the quest in progress and allows starting a new quest. Supports quantity specification: NO Whether the action is reversible: NO Type Condition Required Default Value Limits Description namespaceName string ✓ ~ 128 chars Namespace nameNamespace-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.). userId string ✓ ~ 128 chars User ID /api_reference/ranking2/stamp_sheet/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/ranking2/stamp_sheet/ Verify Action Gs2Ranking2:VerifyGlobalRankingScoreByUserId Verify the score of the global ranking specifying User ID Verifies the global ranking score of the specified user against a specified value using comparison operators (less, lessEqual, greater, greaterEqual, equal, notEqual). Supports quantity specification: YES Type Condition Required Default Value Limits Description namespaceName string ✓ ~ 128 chars Namespace nameNamespace-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.). userId string ✓ ~ 128 chars User ID /api_reference/schedule/stamp_sheet/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/schedule/stamp_sheet/ Verify Action Gs2Schedule:VerifyTriggerByUserId Verify the elapsed time since the Trigger was pulled by specifying a user ID Verifies conditions related to the trigger’s state for the specified user. The verifyType can be: ’notTriggerd’, ’elapsed’, or ’notElapsed’. Returns an error if the verification condition is not met. Supports quantity specification: NO Type Condition Required Default Value Limits Description namespaceName string ✓ ~ 128 chars Namespace nameNamespace-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (. /api_reference/script/stamp_sheet/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/script/stamp_sheet/ Acquire Action Gs2Script:InvokeScript Execute the script Synchronously executes the specified Lua script with the provided JSON arguments. Returns the execution result including status code, return value, transaction information, random number state, execution time, and standard output. Supports transaction handling for atomic operations across GS2 services. Supports quantity specification: NO Whether the action is reversible: NO Type Condition Required Default Value Limits Description scriptId string ✓ ~ 1024 chars Script GRN userId string ~ 128 chars User ID /api_reference/serial_key/stamp_sheet/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/serial_key/stamp_sheet/ Verify Action Gs2SerialKey:VerifyCodeByUserId Verify the validity of the Serial Code by specifying a user ID Verifies a serial code for the specified user without consuming it. Supports verification against a specific campaign model name, and can check whether the code is active (unused) or inactive (already used). Supports quantity specification: NO Type Condition Required Default Value Limits Description namespaceName string ✓ ~ 128 chars Namespace nameNamespace-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (. /api_reference/showcase/stamp_sheet/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/showcase/stamp_sheet/ Consume Action Gs2Showcase:IncrementPurchaseCountByUserId Increment the number of times a Random Displayed Item has been purchased by specifying the user ID Increments the purchase count for a specific Random Displayed Item in the Random Showcase for the specified user. Used for tracking purchase limits per rotation period. Supports quantity specification: YES Whether the action is reversible: YES Type Condition Required Default Value Limits Description namespaceName string ✓ ~ 128 chars Namespace nameNamespace-specific name. /api_reference/skill_tree/stamp_sheet/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/skill_tree/stamp_sheet/ Consume Action Gs2SkillTree:MarkRestrainByUserId Revert a node to unreleased state by specifying a user ID Validates that the specified nodes can be restrained (no dependent nodes must be in released state), then marks them as unreleased. Supports quantity specification: NO Whether the action is reversible: YES Type Condition Required Default Value Limits Description namespaceName string ✓ ~ 128 chars Namespace nameNamespace-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (. /api_reference/stamina/stamp_sheet/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/stamina/stamp_sheet/ Verify Action Gs2Stamina:VerifyStaminaValueByUserId Verify the value of the current Stamina by specifying a user ID Validates that the current stamina value for the specified user meets the specified condition against the given threshold without modifying any state. Supports quantity specification: YES Type Condition Required Default Value Limits Description namespaceName string ✓ ~ 128 chars Namespace nameNamespace-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.). userId string ✓ ~ 128 chars User ID /api_reference/state_machine/stamp_sheet/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/state_machine/stamp_sheet/ Acquire Action Gs2StateMachine:StartStateMachineByUserId Start state machine by specifying a user ID Starts a new state machine instance for the specified user using the latest master version. Arguments are passed as JSON and parsed into state machine variables. An optional TTL (in minutes) can be set; if omitted, the state machine remains valid for approximately 10 years. Supports quantity specification: NO Whether the action is reversible: NO Type Condition Required Default Value Limits Description namespaceName string ✓ ~ 128 chars Namespace nameNamespace-specific name.