GS2-Inbox Deploy/CDK Reference

The template format used when creating stacks with GS2-Deploy, and implementation examples of template output in various languages using CDK

Entities

Resources targeted by the Deploy operation

Namespace

A Namespace allows multiple independent instances of the same service within a single project by separating data spaces and usage contexts. Each GS2 service is managed on a per-namespace basis. Even when using the same service, if the namespace differs, the data is treated as a completely independent data space.

Therefore, you must create a namespace before you can start using each service.

Request

Resource creation and update requests

	Type	Required	Default	Value Limits	Description
name	string	✓		~ 128 chars	Namespace name Namespace-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.).
description	string			~ 1024 chars	Description
isAutomaticDeletingEnabled	bool		false		Automatic Deletion When enabled, messages are automatically removed from the user’s message list after they are opened (read). This keeps the inbox clean by removing claimed messages without requiring an explicit delete operation from the client. When disabled, opened messages remain in the list until manually deleted.
transactionSetting	TransactionSetting				Transaction Setting Configuration for distributed transaction processing (transactions) used when granting rewards attached to messages. When a message with readAcquireActions is opened, transactions are generated and executed to deliver the rewards. Supports auto-run, atomic commit, and asynchronous processing.
receiveMessageScript	ScriptSetting				Script to run when a message is received Script Trigger Reference - `receiveMessage`
readMessageScript	ScriptSetting				Script to run when a message is opened Script Trigger Reference - `readMessage`
deleteMessageScript	ScriptSetting				Script to run when a message is deleted Script Trigger Reference - `deleteMessage`
receiveNotification	NotificationSetting				Receive Notification Push notification settings triggered when a new message is delivered to a user’s inbox. Uses GS2-Gateway to send real-time notifications to the game client, allowing the UI to display a new message indicator or refresh the inbox without polling.
logSetting	LogSetting				Log Output Setting Specifies the GS2-Log namespace for outputting API request and response logs related to message operations. Useful for tracking message delivery, opening, reward claims, and deletion for auditing and debugging purposes.

GetAttr

Resource creation results that can be retrieved using the !GetAttr tag

	Type	Description
Item	Namespace	Namespace created

Implementation Example

Type: GS2::Inbox::Namespace
Properties:
  Name: namespace-0001
  Description: null
  IsAutomaticDeletingEnabled: null
  TransactionSetting: 
    EnableAutoRun: true
    QueueNamespaceId: grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001
  ReceiveMessageScript: null
  ReadMessageScript: null
  DeleteMessageScript: null
  ReceiveNotification: null
  LogSetting: 
    LoggingNamespaceId: grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001

import (
    "github.com/gs2io/gs2-golang-cdk/core"
    "github.com/gs2io/gs2-golang-cdk/inbox"
    "github.com/openlyinc/pointy"
)


SampleStack := core.NewStack()
inbox.NewNamespace(
    &SampleStack,
    "namespace-0001",
    inbox.NamespaceOptions{
        TransactionSetting: &core.TransactionSetting{
            QueueNamespaceId: pointy.String("grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001"),
        },
        LogSetting: &core.LogSetting{
            LoggingNamespaceId: "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001",
        },
    },
)

println(SampleStack.Yaml())  // Generate Template

class SampleStack extends \Gs2Cdk\Core\Model\Stack
{
    function __construct() {
        parent::__construct();
        new \Gs2Cdk\Inbox\Model\Namespace_(
            stack: $this,
            name: "namespace-0001",
            options: new \Gs2Cdk\Inbox\Model\Options\NamespaceOptions(
                transactionSetting: new \Gs2Cdk\Core\Model\TransactionSetting(
                    new \Gs2Cdk\Core\Model\TransactionSettingOptions(
                        queueNamespaceId: "grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001"
                    )
                ),
                logSetting: new \Gs2Cdk\Core\Model\LogSetting(
                    loggingNamespaceId: "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
                )
            )
        );
    }
}

print((new SampleStack())->yaml());  // Generate Template

class SampleStack extends io.gs2.cdk.core.model.Stack
{
    public SampleStack() {
        super();
        new io.gs2.cdk.inbox.model.Namespace(
                this,
                "namespace-0001",
                new io.gs2.cdk.inbox.model.options.NamespaceOptions()
                        .withTransactionSetting(new io.gs2.cdk.core.model.TransactionSetting(
                            new io.gs2.cdk.core.model.options.TransactionSettingOptions()
                                .withQueueNamespaceId("grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001")
                        ))
                        .withLogSetting(new io.gs2.cdk.core.model.LogSetting(
                            "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
                        ))
        );
    }
}

System.out.println(new SampleStack().yaml());  // Generate Template

public class SampleStack : Gs2Cdk.Core.Model.Stack
{
    public SampleStack() {
        new Gs2Cdk.Gs2Inbox.Model.Namespace(
            stack: this,
            name: "namespace-0001",
            options: new Gs2Cdk.Gs2Inbox.Model.Options.NamespaceOptions
            {
                transactionSetting = new Gs2Cdk.Core.Model.TransactionSetting(
                    options: new Gs2Cdk.Core.Model.TransactionSettingOptions
                    {
                        queueNamespaceId = "grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001"
                    }
                ),
                logSetting = new Gs2Cdk.Core.Model.LogSetting(
                    loggingNamespaceId: "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
                )
            }
        );
    }
}

Debug.Log(new SampleStack().Yaml());  // Generate Template

import core from "@/gs2cdk/core";
import inbox from "@/gs2cdk/inbox";

class SampleStack extends core.Stack
{
    public constructor() {
        super();
        new inbox.model.Namespace(
            this,
            "namespace-0001",
            {
                transactionSetting: new core.TransactionSetting(
                    {
                        queueNamespaceId: "grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001"
                    }
                ),
                logSetting: new core.LogSetting(
                    "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
                )
            }
        );
    }
}

console.log(new SampleStack().yaml());  // Generate Template

from gs2_cdk import Stack, core, inbox

class SampleStack(Stack):

    def __init__(self):
        super().__init__()
        inbox.Namespace(
            stack=self,
            name='namespace-0001',
            options=inbox.NamespaceOptions(
                transaction_setting=core.TransactionSetting(
                    options=core.TransactionSettingOptions(
                        queue_namespace_id='grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001',
                    )
                ),
                log_setting=core.LogSetting(
                    logging_namespace_id='grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001',
                ),
            ),
        )

print(SampleStack().yaml())  # Generate Template

TransactionSetting

Transaction Setting

Transaction Setting controls how transactions are executed, including their consistency, asynchronous processing, and conflict avoidance mechanisms. Combining features like AutoRun, AtomicCommit, asynchronous execution using GS2-Distributor, batch application of script results, and asynchronous Acquire Actions via GS2-JobQueue enables robust transaction management tailored to game logic.

	Type	Condition	Default	Value Limits	Description
enableAutoRun	bool		false		Whether to automatically execute issued transactions on the server side
enableAtomicCommit	bool	{enableAutoRun} == true	false		Whether to commit the execution of transactions atomically * Applicable only if enableAutoRun is true
transactionUseDistributor	bool	{enableAtomicCommit} == true	false		Whether to execute transactions asynchronously * Applicable only if enableAtomicCommit is true
commitScriptResultInUseDistributor	bool	{transactionUseDistributor} == true	false		Whether to execute the commit processing of the script result asynchronously * Applicable only if transactionUseDistributor is true
acquireActionUseJobQueue	bool	{enableAtomicCommit} == true	false		Whether to use GS2-JobQueue to execute the acquire action * Applicable only if enableAtomicCommit is true
distributorNamespaceId	string		“grn:gs2:{region}:{ownerId}:distributor:default”	~ 1024 chars	GS2-Distributor Namespace GRN used to execute transactions
queueNamespaceId	string		“grn:gs2:{region}:{ownerId}:queue:default”	~ 1024 chars	GS2-JobQueue Namespace GRN used to execute transactions

ScriptSetting

Script Setting

In GS2, you can associate custom scripts with microservice events and execute them. This model holds the settings for triggering script execution.

There are two main ways to execute a script: synchronous execution and asynchronous execution. Synchronous execution blocks processing until the script has finished executing. Instead, you can use the script’s execution results to halt API execution or control the API’s response content.

In contrast, asynchronous execution does not block processing until the script has finished executing. However, because the script result cannot be used to stop the API execution or modify the API response, asynchronous execution does not affect the API response flow and is generally recommended.

There are two types of asynchronous execution methods: GS2-Script and Amazon EventBridge. By using Amazon EventBridge, you can write processing in languages other than Lua.

Type

Condition

Required

Default

Value Limits

Description

triggerScriptId

string

~ 1024 chars

GS2-Script script GRN executed synchronously when the API is executed

Must be specified in GRN format starting with “grn:gs2:”.

doneTriggerTargetType

String Enum
enum {
  “none”,
  “gs2_script”,
  “aws”
}

“none”

How to execute asynchronous scripts

Specifies the type of script to use for asynchronous execution.
You can choose from “Do not use asynchronous execution (none)”, “Use GS2-Script (gs2_script)”, and “Use Amazon EventBridge (aws)”.

Definition	Description
“none”	None
“gs2_script”	GS2-Script
“aws”	Amazon EventBridge

doneTriggerScriptId

string

{doneTriggerTargetType} == “gs2_script”

~ 1024 chars

GS2-Script script GRN for asynchronous execution

Must be specified in GRN format starting with “grn:gs2:”.

* Applicable only if doneTriggerTargetType is “gs2_script”

doneTriggerQueueNamespaceId

string

{doneTriggerTargetType} == “gs2_script”

~ 1024 chars

GS2-JobQueue namespace GRN to execute asynchronous execution scripts

If you want to execute asynchronous execution scripts via GS2-JobQueue instead of executing them directly, specify the GS2-JobQueue namespace GRN.
There are not many cases where GS2-JobQueue is required, so you generally do not need to specify it unless you have a specific reason.

* Applicable only if doneTriggerTargetType is “gs2_script”

NotificationSetting

Push Notification Settings

This is a setting for sending push notifications when an event occurs in a GS2 microservice. The push notification here refers to the processing via the WebSocket interface provided by GS2-Gateway, and is different from the push notification of a smartphone. For example, when a matchmaking is completed or a friend request is received, the GS2-Gateway can send a push notification via the WebSocket interface, and the game client can detect the change of the state.

GS2-Gateway’s push notifications can be used to forward notifications to mobile push notification services when the destination device is offline. By properly utilizing mobile push notifications, you can implement a flow in which players are notified even if they exit the game during matchmaking and later return to it.

Type

Condition

Required

Default

Value Limits

Description

gatewayNamespaceId

string

“grn:gs2:{region}:{ownerId}:gateway:default”

~ 1024 chars

GS2-Gateway namespace to use for push notifications

Specify the GS2-Gateway namespace ID in GRN format starting with “grn:gs2:”.

enableTransferMobileNotification

bool?

false

Whether to forward the notification as a mobile push notification

When this notification is sent and the destination device is offline, specify whether to forward it as a mobile push notification.

sound

string

{enableTransferMobileNotification} == true

~ 1024 chars

Sound file name to be used for mobile push notifications

The sound file name specified here is used when sending mobile push notifications, and you can send notifications with a special sound.

* Applicable only if enableTransferMobileNotification is true

enable

String Enum
enum {
“Enabled”,
“Disabled”
}

“Enabled”

Whether to enable push notifications

Definition	Description
“Enabled”	Enabled
“Disabled”	Disabled

LogSetting

Log Output Setting

Log Output Setting defines how log data is exported. This type holds the GS2-Log namespace identifier (Namespace ID) used to export log data. Specify the GS2-Log namespace where log data is collected and stored in the GRN format for the Log Namespace ID (loggingNamespaceId). Configuring this setting ensures that log data for API requests and responses occurring within the specified namespace is output to the target GS2-Log namespace. GS2-Log provides real-time logs that can be used for system monitoring, analysis, debugging, and other operational purposes.

	Type	Condition	Required	Default	Value Limits	Description
loggingNamespaceId	string		✓		~ 1024 chars	GS2-Log namespace GRN to output logs Must be specified in GRN format starting with “grn:gs2:”.

CurrentMessageMaster

Currently active Global Message master data

This master data describes the definitions of Global Messages currently active within the namespace. GS2 uses JSON format files for managing master data. By uploading these files, the master data settings are updated on the server.

To create JSON files, GS2 provides a master data editor within the management console. Additionally, you can create tools better suited for game operations and export JSON files in the appropriate format.

Note

Please refer to GS2-Inbox Master Data Reference for the JSON file format.

Request

Resource creation and update requests

Type

Condition

Required

Default

Value Limits

Description

namespaceName

string

✓

~ 128 chars

Namespace name

Namespace-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.).

mode

String Enum
enum {
“direct”,
“preUpload”
}

“direct”

Update mode

Definition	Description
“direct”	Directly update master data
“preUpload”	Upload master data and then update

settings

string

{mode} == “direct”

✓*

~ 5242880 chars

Master Data

* Required if mode is “direct”

uploadToken

string

{mode} == “preUpload”

✓*

~ 1024 chars

Token obtained by pre-upload

Used to apply the uploaded master data.

* Required if mode is “preUpload”

GetAttr

Resource creation results that can be retrieved using the !GetAttr tag

	Type	Description
Item	CurrentMessageMaster	Updated master data of the currently active Global Messages

Implementation Example

Type: GS2::Inbox::CurrentMessageMaster
Properties:
  NamespaceName: namespace-0001
  Mode: direct
  Settings: {
    "version": "2020-03-12",
    "globalMessages": [
      {
        "name": "message-0001",
        "metadata": "hoge"
      },
      {
        "name": "message-0002",
        "metadata": "fuga",
        "readAcquireActions": [
          {
            "action": "Gs2Inventory:AcquireItemSetByUserId",
            "request": {
              "namespaceName": "namespace-0001",
              "inventoryName": "inventory-0001",
              "itemName": "item-0001",
              "acquireCount": 1,
              "expiresAt": 0,
              "createNewItemSet": false,
              "itemSetName": "",
              "userId": "#{userId}"
            }
          }
        ],
        "expiresTimeSpan":
          {
            "days": 1,
            "hours": 2,
            "minutes": 3
          }
      },
      {
        "name": "message-0003",
        "metadata": "piyo"
      }
    ]
  }
  UploadToken: null

import (
    "github.com/gs2io/gs2-golang-cdk/core"
    "github.com/gs2io/gs2-golang-cdk/inbox"
    "github.com/gs2io/gs2-golang-cdk/inventory"
    "github.com/openlyinc/pointy"
)


SampleStack := core.NewStack()
inbox.NewNamespace(
    &SampleStack,
    "namespace-0001",
    inbox.NamespaceOptions{},
).MasterData(
    []inbox.GlobalMessage{
        inbox.NewGlobalMessage(
            "message-0001",
            "hoge",
            inbox.GlobalMessageOptions{
            },
        ),
        inbox.NewGlobalMessage(
            "message-0002",
            "fuga",
            inbox.GlobalMessageOptions{
                ReadAcquireActions: []core.AcquireAction{
                    inventory.AcquireItemSetByUserId(
                        "namespace-0001",
                        "inventory-0001",
                        "item-0001",
                        1,
                        0,
                        pointy.Bool(false),
                        "",
                        "#{userId}",
                    ),
                },
                ExpiresTimeSpan: &inbox.TimeSpan{
                    Days: pointy.Int32(1),
                    Hours: pointy.Int32(2),
                    Minutes: pointy.Int32(3),
                },
            },
        ),
        inbox.NewGlobalMessage(
            "message-0003",
            "piyo",
            inbox.GlobalMessageOptions{
            },
        ),
    },
)

println(SampleStack.Yaml())  // Generate Template

class SampleStack extends \Gs2Cdk\Core\Model\Stack
{
    function __construct() {
        parent::__construct();
        (new \Gs2Cdk\Inbox\Model\Namespace_(
            stack: $this,
            name: "namespace-0001"
        ))->masterData(
            [
                new \Gs2Cdk\Inbox\Model\GlobalMessage(
                    name:"message-0001",
                    metadata:"hoge"
                ),
                new \Gs2Cdk\Inbox\Model\GlobalMessage(
                    name:"message-0002",
                    metadata:"fuga",
                    options: new \Gs2Cdk\Inbox\Model\Options\GlobalMessageOptions(
                        readAcquireActions:[
                            new \Gs2Cdk\Inventory\StampSheet\AcquireItemSetByUserId(
                                namespaceName: "namespace-0001",
                                inventoryName: "inventory-0001",
                                itemName: "item-0001",
                                acquireCount: 1,
                                expiresAt: 0,
                                createNewItemSet: false,
                                itemSetName: "",
                                userId: "#{userId}"
                            ),
                        ],
                        expiresTimeSpan:new \Gs2Cdk\Inbox\Model\TimeSpan(
                            days: 1,
                            hours: 2,
                            minutes: 3,
                        )
                    )
                ),
                new \Gs2Cdk\Inbox\Model\GlobalMessage(
                    name:"message-0003",
                    metadata:"piyo"
                )
            ]
        );
    }
}

print((new SampleStack())->yaml());  // Generate Template

class SampleStack extends io.gs2.cdk.core.model.Stack
{
    public SampleStack() {
        super();
        new io.gs2.cdk.inbox.model.Namespace(
            this,
            "namespace-0001"
        ).masterData(
            Arrays.asList(
                new io.gs2.cdk.inbox.model.GlobalMessage(
                    "message-0001",
                    "hoge"
                ),
                new io.gs2.cdk.inbox.model.GlobalMessage(
                    "message-0002",
                    "fuga",
                    new io.gs2.cdk.inbox.model.options.GlobalMessageOptions()
                        .withReadAcquireActions(Arrays.asList(
                            new io.gs2.cdk.inventory.stampSheet.AcquireItemSetByUserId(
                                "namespace-0001",
                                "inventory-0001",
                                "item-0001",
                                1L,
                                0L,
                                false,
                                "",
                                "#{userId}"
                            )
                        ))
                        .withExpiresTimeSpan(new io.gs2.cdk.inbox.model.TimeSpan(
                            1,
                            2,
                            3
                        ))
                ),
                new io.gs2.cdk.inbox.model.GlobalMessage(
                    "message-0003",
                    "piyo"
                )
            )
        );
    }
}

System.out.println(new SampleStack().yaml());  // Generate Template

public class SampleStack : Gs2Cdk.Core.Model.Stack
{
    public SampleStack() {
        new Gs2Cdk.Gs2Inbox.Model.Namespace(
            stack: this,
            name: "namespace-0001"
        ).MasterData(
            new Gs2Cdk.Gs2Inbox.Model.GlobalMessage[] {
                new Gs2Cdk.Gs2Inbox.Model.GlobalMessage(
                    name: "message-0001",
                    metadata: "hoge"
                ),
                new Gs2Cdk.Gs2Inbox.Model.GlobalMessage(
                    name: "message-0002",
                    metadata: "fuga",
                    options: new Gs2Cdk.Gs2Inbox.Model.Options.GlobalMessageOptions
                    {
                        readAcquireActions = new Gs2Cdk.Core.Model.AcquireAction[]
                        {
                            new Gs2Cdk.Gs2Inventory.StampSheet.AcquireItemSetByUserId(
                                namespaceName: "namespace-0001",
                                inventoryName: "inventory-0001",
                                itemName: "item-0001",
                                acquireCount: 1,
                                expiresAt: 0,
                                createNewItemSet: false,
                                itemSetName: "",
                                userId: "#{userId}"
                            )
                        },
                        expiresTimeSpan = new Gs2Cdk.Gs2Inbox.Model.TimeSpan_(
                            days: 1,
                            hours: 2,
                            minutes: 3
                        )
                    }
                ),
                new Gs2Cdk.Gs2Inbox.Model.GlobalMessage(
                    name: "message-0003",
                    metadata: "piyo"
                )
            }
        );
    }
}

Debug.Log(new SampleStack().Yaml());  // Generate Template

import core from "@/gs2cdk/core";
import inbox from "@/gs2cdk/inbox";
import inventory from "@/gs2cdk/inventory";

class SampleStack extends core.Stack
{
    public constructor() {
        super();
        new inbox.model.Namespace(
            this,
            "namespace-0001",
        ).masterData(
            [
                new inbox.model.GlobalMessage(
                    "message-0001",
                    "hoge"
                ),
                new inbox.model.GlobalMessage(
                    "message-0002",
                    "fuga",
                    {
                        readAcquireActions: [
                            new inventory.stampSheet.AcquireItemSetByUserId(
                                "namespace-0001",
                                "inventory-0001",
                                "item-0001",
                                1,
                                0,
                                false,
                                "",
                                "#{userId}"
                            ),
                        ],
                        expiresTimeSpan: new inbox.model.TimeSpan(
                            1,
                            2,
                            3
                        )
                    }
                ),
                new inbox.model.GlobalMessage(
                    "message-0003",
                    "piyo"
                )
            ]
        );
    }
}

console.log(new SampleStack().yaml());  // Generate Template

from gs2_cdk import Stack, core, inbox, inventory

class SampleStack(Stack):

    def __init__(self):
        super().__init__()
        inbox.Namespace(
            stack=self,
            name="namespace-0001",
        ).master_data(
            global_messages=[
                inbox.GlobalMessage(
                    name='message-0001',
                    metadata='hoge'
                ),
                inbox.GlobalMessage(
                    name='message-0002',
                    metadata='fuga',
                    options=inbox.GlobalMessageOptions(
                        read_acquire_actions = [
                            inventory.AcquireItemSetByUserId(
                                namespace_name='namespace-0001',
                                inventory_name='inventory-0001',
                                item_name='item-0001',
                                acquire_count=1,
                                expires_at=0,
                                create_new_item_set=False,
                                item_set_name="",
                                user_id='#{userId}'
                            ),
                        ],
                        expires_time_span = inbox.TimeSpan(
                            days=1,
                            hours=2,
                            minutes=3,        
                        )
                    ),
                ),
                inbox.GlobalMessage(
                    name='message-0003',
                    metadata='piyo'
                ),
            ],
        )

print(SampleStack().yaml())  # Generate Template

GlobalMessage

Global Message

Global Message is a mechanism for delivering messages to all game players.

Global messages can have an expiration time, and each game player can receive a Global Message by executing the process of receiving a Global Message. Unreceived Global Messages within the validity period are copied to the player’s message box.

	Type	Required	Default	Value Limits	Description
globalMessageId	string	*		~ 1024 chars	Message GRN to all users * Set automatically by the server
name	string	✓		~ 128 chars	Global Message name Global Message-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.).
metadata	string	✓		~ 4096 chars	Metadata Arbitrary data representing the global message content, such as a JSON string containing the message title, body text, and display parameters. When a user receives this global message, the metadata is copied to the individual message in their inbox. GS2 does not interpret this value. Maximum 4096 characters.
readAcquireActions	List<AcquireAction>		[]	0 ~ 100 items	Read Acquire Actions The list of acquire actions to be executed when a user opens the message copied from this global message. These actions are copied along with the metadata to each user’s individual message. Up to 100 actions per global message.
expiresTimeSpan	TimeSpan				Expiration Time Span The duration from the time a user receives (copies) this global message until the copied message expires and is automatically deleted from their inbox. Specified as a combination of days, hours, and minutes. Messages are deleted regardless of read status when the expiration is reached, including any unclaimed attached rewards.
messageReceptionPeriodEventId	string			~ 1024 chars	Message Reception Period Event ID The GRN of a GS2-Schedule event that defines the time window during which this global message can be received (copied to users’ inboxes). Outside this period, the global message is not delivered even if a user triggers the receive global messages operation. Useful for time-limited event announcements or seasonal campaign rewards.

TimeSpan

Time Span

Represents a duration of time as a combination of days, hours, and minutes. Used to define the expiration period for messages relative to their reception time. For example, a TimeSpan of 7 days, 0 hours, 0 minutes means the message expires exactly one week after the user receives it.

	Type	Value Limits	Description
days	int	0 ~ 365	Days The number of days in this time span. Combined with hours and minutes to calculate the total duration. Maximum 365 days.
hours	int	0 ~ 24	Hours The number of hours in this time span. Combined with days and minutes to calculate the total duration. Maximum 24 hours.
minutes	int	0 ~ 60	Minutes The number of minutes in this time span. Combined with days and hours to calculate the total duration. Maximum 60 minutes.

AcquireAction

Acquire Action

Represents a single acquire action attached to a message as a reward. Consists of an action type (e.g., add items to inventory, increase currency) and its request parameters. When a message is opened, these actions are assembled into transactions and executed to deliver the rewards to the user.

	Type	Condition	Required	Default	Value Limits	Description
action	String Enum enum { "Gs2AdReward:AcquirePointByUserId", "Gs2Dictionary:AddEntriesByUserId", "Gs2Enchant:ReDrawBalanceParameterStatusByUserId", "Gs2Enchant:SetBalanceParameterStatusByUserId", "Gs2Enchant:ReDrawRarityParameterStatusByUserId", "Gs2Enchant:AddRarityParameterStatusByUserId", "Gs2Enchant:SetRarityParameterStatusByUserId", "Gs2Enhance:DirectEnhanceByUserId", "Gs2Enhance:UnleashByUserId", "Gs2Enhance:CreateProgressByUserId", "Gs2Exchange:ExchangeByUserId", "Gs2Exchange:IncrementalExchangeByUserId", "Gs2Exchange:CreateAwaitByUserId", "Gs2Exchange:AcquireForceByUserId", "Gs2Exchange:SkipByUserId", "Gs2Experience:AddExperienceByUserId", "Gs2Experience:SetExperienceByUserId", "Gs2Experience:AddRankCapByUserId", "Gs2Experience:SetRankCapByUserId", "Gs2Experience:MultiplyAcquireActionsByUserId", "Gs2Formation:AddMoldCapacityByUserId", "Gs2Formation:SetMoldCapacityByUserId", "Gs2Formation:AcquireActionsToFormProperties", "Gs2Formation:SetFormByUserId", "Gs2Formation:AcquireActionsToPropertyFormProperties", "Gs2Friend:UpdateProfileByUserId", "Gs2Grade:AddGradeByUserId", "Gs2Grade:ApplyRankCapByUserId", "Gs2Grade:MultiplyAcquireActionsByUserId", "Gs2Guild:IncreaseMaximumCurrentMaximumMemberCountByGuildName", "Gs2Guild:SetMaximumCurrentMaximumMemberCountByGuildName", "Gs2Idle:IncreaseMaximumIdleMinutesByUserId", "Gs2Idle:SetMaximumIdleMinutesByUserId", "Gs2Idle:ReceiveByUserId", "Gs2Inbox:SendMessageByUserId", "Gs2Inventory:AddCapacityByUserId", "Gs2Inventory:SetCapacityByUserId", "Gs2Inventory:AcquireItemSetByUserId", "Gs2Inventory:AcquireItemSetWithGradeByUserId", "Gs2Inventory:AddReferenceOfByUserId", "Gs2Inventory:DeleteReferenceOfByUserId", "Gs2Inventory:AcquireSimpleItemsByUserId", "Gs2Inventory:SetSimpleItemsByUserId", "Gs2Inventory:AcquireBigItemByUserId", "Gs2Inventory:SetBigItemByUserId", "Gs2JobQueue:PushByUserId", "Gs2Limit:CountDownByUserId", "Gs2Limit:DeleteCounterByUserId", "Gs2LoginReward:DeleteReceiveStatusByUserId", "Gs2LoginReward:UnmarkReceivedByUserId", "Gs2Lottery:DrawByUserId", "Gs2Lottery:ResetBoxByUserId", "Gs2Mission:RevertReceiveByUserId", "Gs2Mission:IncreaseCounterByUserId", "Gs2Mission:SetCounterByUserId", "Gs2Money:DepositByUserId", "Gs2Money:RevertRecordReceipt", "Gs2Money2:DepositByUserId", "Gs2Quest:CreateProgressByUserId", "Gs2Schedule:TriggerByUserId", "Gs2Schedule:ExtendTriggerByUserId", "Gs2Script:InvokeScript", "Gs2SerialKey:RevertUseByUserId", "Gs2SerialKey:IssueOnce", "Gs2Showcase:DecrementPurchaseCountByUserId", "Gs2Showcase:ForceReDrawByUserId", "Gs2SkillTree:MarkReleaseByUserId", "Gs2Stamina:RecoverStaminaByUserId", "Gs2Stamina:RaiseMaxValueByUserId", "Gs2Stamina:SetMaxValueByUserId", "Gs2Stamina:SetRecoverIntervalByUserId", "Gs2Stamina:SetRecoverValueByUserId", "Gs2StateMachine:StartStateMachineByUserId", }		✓			Type of action to be executed in the Acquire Action
request	string		✓		~ 524288 chars	JSON string of the request used when executing the action