GS2-Deploy/CDK Reference of GS2-Mission

Entities

Namespace

Namespace

Namespace is a mechanism that allows multiple uses of the same service for different purposes within a single project. Basically, GS2 services have a layer called namespace, and different namespaces are treated as completely different data spaces, even for the same service.

Therefore, it is necessary to create a namespace before starting to use each service.

TypeRequireDefaultLimitationDescription
namestring~ 32 charsNamespace name
descriptionstring~ 1024 charsDescription
transactionSettingTransactionSettingTransaction settings
missionCompleteScriptScriptSettingScript to run when a mission is accomplished
counterIncrementScriptScriptSettingScript to run when the counter rises
receiveRewardsScriptScriptSettingScript to run when a reward is received
completeNotificationNotificationSettingPush notifications when mission tasks are accomplished
logSettingLogSettingLog output settings

GetAttr

TypeDescription
ItemNamespaceCreated namespace

Implementation Example

Type: GS2::Mission::Namespace
Properties:
  Name: namespace1
  Description: null
  TransactionSetting: 
    EnableAutoRun: false
    QueueNamespaceId: grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001
    KeyId: grn:gs2:ap-northeast-1:YourOwnerId:key:namespace1:key:key-0001
  MissionCompleteScript: null
  CounterIncrementScript: null
  ReceiveRewardsScript: null
  CompleteNotification: null
  LogSetting: 
    LoggingNamespaceId: grn:gs2:ap-northeast-1:YourOwnerId:log:namespace1
from gs2_cdk import Stack, core, mission

class SampleStack(Stack):

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

print(SampleStack().yaml())  # Generate Template
class SampleStack extends \Gs2Cdk\Core\Model\Stack
{
    function __construct() {
        parent::__construct();
        new \Gs2Cdk\Mission\Model\Namespace_(
            stack: $this,
            name: "namespace-0001",
            options: new \Gs2Cdk\Mission\Model\Options\NamespaceOptions(
                transactionSetting: new \Gs2Cdk\Core\Model\TransactionSetting(
                    enableAutoRun: False,
                    distributorNamespaceId: ,
                    queueNamespaceId: "grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001",
                    options: new \Gs2Cdk\Core\Model\Options\TransactionSettingOptions(
                        keyId: "grn:gs2:ap-northeast-1:YourOwnerId:key:namespace-0001:key:key-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.mission.model.Namespace(
            this,
            "namespace-0001",
            new io.gs2.cdk.mission.model.options.NamespaceOptions() {
                {
                    transactionSetting = new io.gs2.cdk.core.model.TransactionSetting(
                        false,
                        ,
                        "grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001",
                        new io.gs2.cdk.core.model.options.TransactionSettingOptions(
                            "grn:gs2:ap-northeast-1:YourOwnerId:key:namespace-0001:key:key-0001"
                        )
                    );
                    logSetting = new io.gs2.cdk.core.model.LogSetting(
                        "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
                    );
                }
            }
        );
    }
}

System.out.println(new SampleStack().yaml());  // Generate Template
import core from "@/gs2cdk/core";
import mission from "@/gs2cdk/mission";

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

console.log(new SampleStack().yaml());  // Generate Template
public class SampleStack : Gs2Cdk.Core.Model.Stack
{
    public SampleStack() {
        new Gs2Cdk.Gs2Mission.Model.Namespace(
            this,
            "namespace-0001",
            new Gs2Cdk.Gs2Mission.Model.Options.NamespaceOptions {
                transactionSetting = new Gs2Cdk.Core.Model.TransactionSetting(
                    false,
                    ,
                    "grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001",
                    new Gs2Cdk.Core.Model.Options.TransactionSettingOptions(
                        KeyId = "grn:gs2:ap-northeast-1:YourOwnerId:key:namespace-0001:key:key-0001"
                    }
                ),
                logSetting = new Gs2Cdk.Core.Model.LogSetting(
                    "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
                ),
            }
        );
    }
}

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

CurrentMissionMaster

Currently available master data

GS2 uses JSON format files for master data management. By uploading the file, you can actually reflect the settings on the server.

We provide a master data editor on the management console as a way to create JSON files, but you can also create JSON files using the The service can also be used by creating a tool more appropriate for game management and exporting a JSON file in the appropriate format.

Please refer to the documentation for the format of the JSON file.

TypeRequireDefaultLimitationDescription
namespaceNamestring~ 32 charsNamespace name
settingsstring~ 5242880 charsMaster data

GetAttr

TypeDescription
ItemCurrentMissionMasterUpdated and currently available Mission Master

Implementation Example

Type: GS2::Mission::CurrentMissionMaster
Properties:
  NamespaceName: namespace1
  Settings: {
    "version": "2019-05-28",
    "groups": [
      {
        "name": "daily",
        "metadata": "DAILY",
        "tasks": [
          {
            "name": "quest_x10",
            "metadata": "QUEST_X10",
            "counterName": "quest_complete",
            "targetValue": 10,
            "completeAcquireActions": [
              {
                "action": "Gs2Experience:AddExperienceByUserId",
                "request": "{\\"experienceName\\": \\"basic\\", \\"userId\\": \\"#{userId}\\", \\"experienceModelName\\": \\"player\\", \\"propertyId\\": \\"player\\", \\"experienceValue\\": 10}"
              }
            ]
          },
          {
            "name": "quest_x20",
            "metadata": "QUEST_X20",
            "counterName": "quest_complete",
            "premiseMissionTaskName": "quest_x10",
            "targetValue": 20,
            "completeAcquireActions": [
              {
                "action": "Gs2Experience:AddExperienceByUserId",
                "request": "{\\"experienceName\\": \\"basic\\", \\"userId\\": \\"#{userId}\\", \\"experienceModelName\\": \\"player\\", \\"propertyId\\": \\"player\\", \\"experienceValue\\": 20}"
              }
            ]
          },
          {
            "name": "gacha",
            "metadata": "GACHA",
            "counterName": "lot_gacha",
            "targetValue": 1,
            "completeAcquireActions": [
              {
                "action": "Gs2Experience:AddExperienceByUserId",
                "request": "{\\"experienceName\\": \\"basic\\", \\"userId\\": \\"#{userId}\\", \\"experienceModelName\\": \\"player\\", \\"propertyId\\": \\"player\\", \\"experienceValue\\": 30}"
              }
            ]
          }
        ],
        "resetType": "daily",
        "resetHour": 10
      },
      {
        "name": "weekly",
        "metadata": "WEEKLY",
        "tasks": [
          {
            "name": "quest_x100",
            "metadata": "QUEST_X100",
            "counterName": "quest_complete",
            "targetValue": 100,
            "completeAcquireActions": [
              {
                "action": "Gs2Experience:AddExperienceByUserId",
                "request": "{\\"experienceName\\": \\"basic\\", \\"userId\\": \\"#{userId}\\", \\"experienceModelName\\": \\"player\\", \\"propertyId\\": \\"player\\", \\"experienceValue\\": 40}"
              }
            ]
          },
          {
            "name": "quest_x1000",
            "metadata": "QUEST_X1000",
            "counterName": "quest_complete",
            "premiseMissionTaskName": "quest_x100",
            "targetValue": 1000,
            "completeAcquireActions": [
              {
                "action": "Gs2Experience:AddExperienceByUserId",
                "request": "{\\"experienceName\\": \\"basic\\", \\"userId\\": \\"#{userId}\\", \\"experienceModelName\\": \\"player\\", \\"propertyId\\": \\"player\\", \\"experienceValue\\": 50}"
              }
            ]
          }
        ],
        "resetType": "weekly",
        "resetDayOfWeek": "monday",
        "resetHour": 10
      },
      {
        "name": "story",
        "metadata": "STORY",
        "tasks": [
          {
            "name": "quest_1-1",
            "metadata": "QUEST_1-1",
            "counterName": "quest1",
            "targetValue": 1
          },
          {
            "name": "quest_1-2",
            "metadata": "QUEST_1-2",
            "counterName": "quest1",
            "premiseMissionTaskName": "quest_1-1",
            "targetValue": 1
          },
          {
            "name": "quest_1-3",
            "metadata": "QUEST_1-3",
            "counterName": "quest1",
            "premiseMissionTaskName": "quest_1-2",
            "targetValue": 1
          },
          {
            "name": "quest_1-4",
            "metadata": "QUEST_1-4",
            "counterName": "quest1",
            "premiseMissionTaskName": "quest_1-3",
            "targetValue": 1
          },
          {
            "name": "quest_2-1",
            "metadata": "QUEST_2-1",
            "counterName": "quest2",
            "premiseMissionTaskName": "quest_1-4",
            "targetValue": 1
          }
        ],
        "resetType": "notReset"
      }
    ],
    "counters": [
      {
        "name": "quest_complete",
        "metadata": "QUEST_COMPLETE",
        "scopes": [
          {
            "resetType": "daily",
            "resetHour": 5
          },
          {
            "resetType": "weekly",
            "resetDayOfWeek": "monday",
            "resetHour": 5
          }
        ]
      },
      {
        "name": "lot_gacha",
        "metadata": "LOT_GACHA",
        "scopes": [
          {
            "resetType": "daily",
            "resetHour": 5
          }
        ]
      },
      {
        "name": "quest1",
        "metadata": "QUEST1",
        "scopes": [
          {
            "resetType": "notReset"
          }
        ]
      },
      {
        "name": "quest2",
        "metadata": "QUEST2",
        "scopes": [
          {
            "resetType": "notReset"
          }
        ]
      }
    ]
  }
from gs2_cdk import Stack, core, mission

class SampleStack(Stack):

    def __init__(self):
        super().__init__()
        mission.Namespace(
            stack=self,
            # omission
        ).master_data(
            [
                mission.MissionGroupModel(
                    name='daily',
                    reset_type='daily',
                    options=mission.MissionGroupModelOptions(
                        metadata='DAILY',
                        tasks=[    {'name': 'quest_x10', 'metadata': 'QUEST_X10', 'counterName': 'quest_complete', 'targetValue': 10, 'completeAcquireActions': [{'action': 'Gs2Experience:AddExperienceByUserId', 'request': '{"experienceName": "basic", "userId": "#{userId}", "experienceModelName": "player", "propertyId": "player", "experienceValue": 10}'}]},
                            {'name': 'quest_x20', 'metadata': 'QUEST_X20', 'counterName': 'quest_complete', 'premiseMissionTaskName': 'quest_x10', 'targetValue': 20, 'completeAcquireActions': [{'action': 'Gs2Experience:AddExperienceByUserId', 'request': '{"experienceName": "basic", "userId": "#{userId}", "experienceModelName": "player", "propertyId": "player", "experienceValue": 20}'}]},
                            {'name': 'gacha', 'metadata': 'GACHA', 'counterName': 'lot_gacha', 'targetValue': 1, 'completeAcquireActions': [{'action': 'Gs2Experience:AddExperienceByUserId', 'request': '{"experienceName": "basic", "userId": "#{userId}", "experienceModelName": "player", "propertyId": "player", "experienceValue": 30}'}]},
                            ],
                        reset_hour=10,
                    ),
                ),
                mission.MissionGroupModel(
                    name='weekly',
                    reset_type='weekly',
                    options=mission.MissionGroupModelOptions(
                        metadata='WEEKLY',
                        tasks=[    {'name': 'quest_x100', 'metadata': 'QUEST_X100', 'counterName': 'quest_complete', 'targetValue': 100, 'completeAcquireActions': [{'action': 'Gs2Experience:AddExperienceByUserId', 'request': '{"experienceName": "basic", "userId": "#{userId}", "experienceModelName": "player", "propertyId": "player", "experienceValue": 40}'}]},
                            {'name': 'quest_x1000', 'metadata': 'QUEST_X1000', 'counterName': 'quest_complete', 'premiseMissionTaskName': 'quest_x100', 'targetValue': 1000, 'completeAcquireActions': [{'action': 'Gs2Experience:AddExperienceByUserId', 'request': '{"experienceName": "basic", "userId": "#{userId}", "experienceModelName": "player", "propertyId": "player", "experienceValue": 50}'}]},
                            ],
                        reset_day_of_week='monday',
                        reset_hour=10,
                    ),
                ),
                mission.MissionGroupModel(
                    name='story',
                    reset_type='notReset',
                    options=mission.MissionGroupModelOptions(
                        metadata='STORY',
                        tasks=[    {'name': 'quest_1-1', 'metadata': 'QUEST_1-1', 'counterName': 'quest1', 'targetValue': 1},
                            {'name': 'quest_1-2', 'metadata': 'QUEST_1-2', 'counterName': 'quest1', 'premiseMissionTaskName': 'quest_1-1', 'targetValue': 1},
                            {'name': 'quest_1-3', 'metadata': 'QUEST_1-3', 'counterName': 'quest1', 'premiseMissionTaskName': 'quest_1-2', 'targetValue': 1},
                            {'name': 'quest_1-4', 'metadata': 'QUEST_1-4', 'counterName': 'quest1', 'premiseMissionTaskName': 'quest_1-3', 'targetValue': 1},
                            {'name': 'quest_2-1', 'metadata': 'QUEST_2-1', 'counterName': 'quest2', 'premiseMissionTaskName': 'quest_1-4', 'targetValue': 1},
                            ],
                    ),
                ),
            ],
            [
                mission.CounterModel(
                    name='quest_complete',
                    scopes=[    {'resetType': 'daily', 'resetHour': 5},
                        {'resetType': 'weekly', 'resetDayOfWeek': 'monday', 'resetHour': 5},
                        ],
                    options=mission.CounterModelOptions(
                        metadata='QUEST_COMPLETE',
                    ),
                ),
                mission.CounterModel(
                    name='lot_gacha',
                    scopes=[    {'resetType': 'daily', 'resetHour': 5},
                        ],
                    options=mission.CounterModelOptions(
                        metadata='LOT_GACHA',
                    ),
                ),
                mission.CounterModel(
                    name='quest1',
                    scopes=[    {'resetType': 'notReset'},
                        ],
                    options=mission.CounterModelOptions(
                        metadata='QUEST1',
                    ),
                ),
                mission.CounterModel(
                    name='quest2',
                    scopes=[    {'resetType': 'notReset'},
                        ],
                    options=mission.CounterModelOptions(
                        metadata='QUEST2',
                    ),
                ),
            ],
        )

print(SampleStack().yaml())  # Generate Template
class SampleStack extends \Gs2Cdk\Core\Model\Stack
{
    function __construct() {
        parent::__construct();
        (new \Gs2Cdk\Mission\Model\Namespace_(
            stack: $this,
            // omission
        ))->masterData(
            [
                new \Gs2Cdk\Mission\Model\MissionGroupModel(
                    name:"daily",
                    resetType: \Gs2Cdk\Mission\Model\Enums\CurrentMissionMasterResetType::DAILY
                    options: new \Gs2Cdk\Mission\Model\Options\MissionGroupModelOptions(
                        metadata:"DAILY",
                        tasks:[    {'name': 'quest_x10', 'metadata': 'QUEST_X10', 'counterName': 'quest_complete', 'targetValue': 10, 'completeAcquireActions': [{'action': 'Gs2Experience:AddExperienceByUserId', 'request': '{"experienceName": "basic", "userId": "#{userId}", "experienceModelName": "player", "propertyId": "player", "experienceValue": 10}'}]},
                        {'name': 'quest_x20', 'metadata': 'QUEST_X20', 'counterName': 'quest_complete', 'premiseMissionTaskName': 'quest_x10', 'targetValue': 20, 'completeAcquireActions': [{'action': 'Gs2Experience:AddExperienceByUserId', 'request': '{"experienceName": "basic", "userId": "#{userId}", "experienceModelName": "player", "propertyId": "player", "experienceValue": 20}'}]},
                        {'name': 'gacha', 'metadata': 'GACHA', 'counterName': 'lot_gacha', 'targetValue': 1, 'completeAcquireActions': [{'action': 'Gs2Experience:AddExperienceByUserId', 'request': '{"experienceName": "basic", "userId": "#{userId}", "experienceModelName": "player", "propertyId": "player", "experienceValue": 30}'}]},
                        ],
                        resetHour:10,
                    ),
                ),
                new \Gs2Cdk\Mission\Model\MissionGroupModel(
                    name:"weekly",
                    resetType: \Gs2Cdk\Mission\Model\Enums\CurrentMissionMasterResetType::WEEKLY
                    options: new \Gs2Cdk\Mission\Model\Options\MissionGroupModelOptions(
                        metadata:"WEEKLY",
                        tasks:[    {'name': 'quest_x100', 'metadata': 'QUEST_X100', 'counterName': 'quest_complete', 'targetValue': 100, 'completeAcquireActions': [{'action': 'Gs2Experience:AddExperienceByUserId', 'request': '{"experienceName": "basic", "userId": "#{userId}", "experienceModelName": "player", "propertyId": "player", "experienceValue": 40}'}]},
                        {'name': 'quest_x1000', 'metadata': 'QUEST_X1000', 'counterName': 'quest_complete', 'premiseMissionTaskName': 'quest_x100', 'targetValue': 1000, 'completeAcquireActions': [{'action': 'Gs2Experience:AddExperienceByUserId', 'request': '{"experienceName": "basic", "userId": "#{userId}", "experienceModelName": "player", "propertyId": "player", "experienceValue": 50}'}]},
                        ],
                        resetDayOfWeek:"monday",
                        resetHour:10,
                    ),
                ),
                new \Gs2Cdk\Mission\Model\MissionGroupModel(
                    name:"story",
                    resetType: \Gs2Cdk\Mission\Model\Enums\CurrentMissionMasterResetType::NOT_RESET
                    options: new \Gs2Cdk\Mission\Model\Options\MissionGroupModelOptions(
                        metadata:"STORY",
                        tasks:[    {'name': 'quest_1-1', 'metadata': 'QUEST_1-1', 'counterName': 'quest1', 'targetValue': 1},
                        {'name': 'quest_1-2', 'metadata': 'QUEST_1-2', 'counterName': 'quest1', 'premiseMissionTaskName': 'quest_1-1', 'targetValue': 1},
                        {'name': 'quest_1-3', 'metadata': 'QUEST_1-3', 'counterName': 'quest1', 'premiseMissionTaskName': 'quest_1-2', 'targetValue': 1},
                        {'name': 'quest_1-4', 'metadata': 'QUEST_1-4', 'counterName': 'quest1', 'premiseMissionTaskName': 'quest_1-3', 'targetValue': 1},
                        {'name': 'quest_2-1', 'metadata': 'QUEST_2-1', 'counterName': 'quest2', 'premiseMissionTaskName': 'quest_1-4', 'targetValue': 1},
                        ],
                    ),
                ),
            ],
            [
                new \Gs2Cdk\Mission\Model\CounterModel(
                    name:"quest_complete",
                    scopes:[    {'resetType': 'daily', 'resetHour': 5},
                    {'resetType': 'weekly', 'resetDayOfWeek': 'monday', 'resetHour': 5},
                    ],
                    options: new \Gs2Cdk\Mission\Model\Options\CounterModelOptions(
                        metadata:"QUEST_COMPLETE",
                    ),
                ),
                new \Gs2Cdk\Mission\Model\CounterModel(
                    name:"lot_gacha",
                    scopes:[    {'resetType': 'daily', 'resetHour': 5},
                    ],
                    options: new \Gs2Cdk\Mission\Model\Options\CounterModelOptions(
                        metadata:"LOT_GACHA",
                    ),
                ),
                new \Gs2Cdk\Mission\Model\CounterModel(
                    name:"quest1",
                    scopes:[    {'resetType': 'notReset'},
                    ],
                    options: new \Gs2Cdk\Mission\Model\Options\CounterModelOptions(
                        metadata:"QUEST1",
                    ),
                ),
                new \Gs2Cdk\Mission\Model\CounterModel(
                    name:"quest2",
                    scopes:[    {'resetType': 'notReset'},
                    ],
                    options: new \Gs2Cdk\Mission\Model\Options\CounterModelOptions(
                        metadata:"QUEST2",
                    ),
                ),
            ],
        );
    }
}

print((new SampleStack())->yaml());  // Generate Template
class SampleStack extends io.gs2.cdk.core.model.Stack
{
    public SampleStack() {
        super();
        new io.gs2.cdk.mission.model.Namespace(
            this,
            // omission
        ).masterData(
            Arrays.asList(
                new io.gs2.cdk.mission.model.MissionGroupModel(
                    "daily",
                    Daily,
                    new io.gs2.cdk.mission.model.options.MissionGroupModelOptions() {
                        {
                            metadata: "DAILY";
                            tasks: Arrays.asList(
                                {'name': 'quest_x10', 'metadata': 'QUEST_X10', 'counterName': 'quest_complete', 'targetValue': 10, 'completeAcquireActions': [{'action': 'Gs2Experience:AddExperienceByUserId', 'request': '{"experienceName": "basic", "userId": "#{userId}", "experienceModelName": "player", "propertyId": "player", "experienceValue": 10}'}]},
                            {'name': 'quest_x20', 'metadata': 'QUEST_X20', 'counterName': 'quest_complete', 'premiseMissionTaskName': 'quest_x10', 'targetValue': 20, 'completeAcquireActions': [{'action': 'Gs2Experience:AddExperienceByUserId', 'request': '{"experienceName": "basic", "userId": "#{userId}", "experienceModelName": "player", "propertyId": "player", "experienceValue": 20}'}]},
                            {'name': 'gacha', 'metadata': 'GACHA', 'counterName': 'lot_gacha', 'targetValue': 1, 'completeAcquireActions': [{'action': 'Gs2Experience:AddExperienceByUserId', 'request': '{"experienceName": "basic", "userId": "#{userId}", "experienceModelName": "player", "propertyId": "player", "experienceValue": 30}'}]}
                            );
                            resetHour: 10;
                        }
                    }
                ),
                new io.gs2.cdk.mission.model.MissionGroupModel(
                    "weekly",
                    Weekly,
                    new io.gs2.cdk.mission.model.options.MissionGroupModelOptions() {
                        {
                            metadata: "WEEKLY";
                            tasks: Arrays.asList(
                                {'name': 'quest_x100', 'metadata': 'QUEST_X100', 'counterName': 'quest_complete', 'targetValue': 100, 'completeAcquireActions': [{'action': 'Gs2Experience:AddExperienceByUserId', 'request': '{"experienceName": "basic", "userId": "#{userId}", "experienceModelName": "player", "propertyId": "player", "experienceValue": 40}'}]},
                            {'name': 'quest_x1000', 'metadata': 'QUEST_X1000', 'counterName': 'quest_complete', 'premiseMissionTaskName': 'quest_x100', 'targetValue': 1000, 'completeAcquireActions': [{'action': 'Gs2Experience:AddExperienceByUserId', 'request': '{"experienceName": "basic", "userId": "#{userId}", "experienceModelName": "player", "propertyId": "player", "experienceValue": 50}'}]}
                            );
                            resetDayOfWeek: "monday";
                            resetHour: 10;
                        }
                    }
                ),
                new io.gs2.cdk.mission.model.MissionGroupModel(
                    "story",
                    NotReset,
                    new io.gs2.cdk.mission.model.options.MissionGroupModelOptions() {
                        {
                            metadata: "STORY";
                            tasks: Arrays.asList(
                                {'name': 'quest_1-1', 'metadata': 'QUEST_1-1', 'counterName': 'quest1', 'targetValue': 1},
                            {'name': 'quest_1-2', 'metadata': 'QUEST_1-2', 'counterName': 'quest1', 'premiseMissionTaskName': 'quest_1-1', 'targetValue': 1},
                            {'name': 'quest_1-3', 'metadata': 'QUEST_1-3', 'counterName': 'quest1', 'premiseMissionTaskName': 'quest_1-2', 'targetValue': 1},
                            {'name': 'quest_1-4', 'metadata': 'QUEST_1-4', 'counterName': 'quest1', 'premiseMissionTaskName': 'quest_1-3', 'targetValue': 1},
                            {'name': 'quest_2-1', 'metadata': 'QUEST_2-1', 'counterName': 'quest2', 'premiseMissionTaskName': 'quest_1-4', 'targetValue': 1}
                            );
                        }
                    }
                )
            ),
            Arrays.asList(
                new io.gs2.cdk.mission.model.CounterModel(
                    "quest_complete",
                    Arrays.asList(
                        {'resetType': 'daily', 'resetHour': 5},
                    {'resetType': 'weekly', 'resetDayOfWeek': 'monday', 'resetHour': 5}
                    ),
                    new io.gs2.cdk.mission.model.options.CounterModelOptions() {
                        {
                            metadata: "QUEST_COMPLETE";
                        }
                    }
                ),
                new io.gs2.cdk.mission.model.CounterModel(
                    "lot_gacha",
                    Arrays.asList(
                        {'resetType': 'daily', 'resetHour': 5}
                    ),
                    new io.gs2.cdk.mission.model.options.CounterModelOptions() {
                        {
                            metadata: "LOT_GACHA";
                        }
                    }
                ),
                new io.gs2.cdk.mission.model.CounterModel(
                    "quest1",
                    Arrays.asList(
                        {'resetType': 'notReset'}
                    ),
                    new io.gs2.cdk.mission.model.options.CounterModelOptions() {
                        {
                            metadata: "QUEST1";
                        }
                    }
                ),
                new io.gs2.cdk.mission.model.CounterModel(
                    "quest2",
                    Arrays.asList(
                        {'resetType': 'notReset'}
                    ),
                    new io.gs2.cdk.mission.model.options.CounterModelOptions() {
                        {
                            metadata: "QUEST2";
                        }
                    }
                )
            )
        );
    }
}

System.out.println(new SampleStack().yaml());  // Generate Template
import core from "@/gs2cdk/core";
import mission from "@/gs2cdk/mission";

class SampleStack extends core.Stack
{
    public constructor() {
        super();
        new mission.model.Namespace(
            this,
            // omission
        ).masterData(
            [
                new mission.model.MissionGroupModel(
                    "daily",
                    mission.model.CurrentMissionMasterResetType.DAILY,
                    {
                        metadata: "DAILY",
                        tasks: [
                                {'name': 'quest_x10', 'metadata': 'QUEST_X10', 'counterName': 'quest_complete', 'targetValue': 10, 'completeAcquireActions': [{'action': 'Gs2Experience:AddExperienceByUserId', 'request': '{"experienceName": "basic", "userId": "#{userId}", "experienceModelName": "player", "propertyId": "player", "experienceValue": 10}'}]},
                            {'name': 'quest_x20', 'metadata': 'QUEST_X20', 'counterName': 'quest_complete', 'premiseMissionTaskName': 'quest_x10', 'targetValue': 20, 'completeAcquireActions': [{'action': 'Gs2Experience:AddExperienceByUserId', 'request': '{"experienceName": "basic", "userId": "#{userId}", "experienceModelName": "player", "propertyId": "player", "experienceValue": 20}'}]},
                            {'name': 'gacha', 'metadata': 'GACHA', 'counterName': 'lot_gacha', 'targetValue': 1, 'completeAcquireActions': [{'action': 'Gs2Experience:AddExperienceByUserId', 'request': '{"experienceName": "basic", "userId": "#{userId}", "experienceModelName": "player", "propertyId": "player", "experienceValue": 30}'}]}
                            ],
                        resetHour: 10
                    }
                ),
                new mission.model.MissionGroupModel(
                    "weekly",
                    mission.model.CurrentMissionMasterResetType.WEEKLY,
                    {
                        metadata: "WEEKLY",
                        tasks: [
                                {'name': 'quest_x100', 'metadata': 'QUEST_X100', 'counterName': 'quest_complete', 'targetValue': 100, 'completeAcquireActions': [{'action': 'Gs2Experience:AddExperienceByUserId', 'request': '{"experienceName": "basic", "userId": "#{userId}", "experienceModelName": "player", "propertyId": "player", "experienceValue": 40}'}]},
                            {'name': 'quest_x1000', 'metadata': 'QUEST_X1000', 'counterName': 'quest_complete', 'premiseMissionTaskName': 'quest_x100', 'targetValue': 1000, 'completeAcquireActions': [{'action': 'Gs2Experience:AddExperienceByUserId', 'request': '{"experienceName": "basic", "userId": "#{userId}", "experienceModelName": "player", "propertyId": "player", "experienceValue": 50}'}]}
                            ],
                        resetDayOfWeek: "monday",
                        resetHour: 10
                    }
                ),
                new mission.model.MissionGroupModel(
                    "story",
                    mission.model.CurrentMissionMasterResetType.NOT_RESET,
                    {
                        metadata: "STORY",
                        tasks: [
                                {'name': 'quest_1-1', 'metadata': 'QUEST_1-1', 'counterName': 'quest1', 'targetValue': 1},
                            {'name': 'quest_1-2', 'metadata': 'QUEST_1-2', 'counterName': 'quest1', 'premiseMissionTaskName': 'quest_1-1', 'targetValue': 1},
                            {'name': 'quest_1-3', 'metadata': 'QUEST_1-3', 'counterName': 'quest1', 'premiseMissionTaskName': 'quest_1-2', 'targetValue': 1},
                            {'name': 'quest_1-4', 'metadata': 'QUEST_1-4', 'counterName': 'quest1', 'premiseMissionTaskName': 'quest_1-3', 'targetValue': 1},
                            {'name': 'quest_2-1', 'metadata': 'QUEST_2-1', 'counterName': 'quest2', 'premiseMissionTaskName': 'quest_1-4', 'targetValue': 1}
                            ]
                    }
                )
            ],
            [
                new mission.model.CounterModel(
                    "quest_complete",
                    [
                        {'resetType': 'daily', 'resetHour': 5},
                    {'resetType': 'weekly', 'resetDayOfWeek': 'monday', 'resetHour': 5}
                    ],
                    {
                        metadata: "QUEST_COMPLETE"
                    }
                ),
                new mission.model.CounterModel(
                    "lot_gacha",
                    [
                        {'resetType': 'daily', 'resetHour': 5}
                    ],
                    {
                        metadata: "LOT_GACHA"
                    }
                ),
                new mission.model.CounterModel(
                    "quest1",
                    [
                        {'resetType': 'notReset'}
                    ],
                    {
                        metadata: "QUEST1"
                    }
                ),
                new mission.model.CounterModel(
                    "quest2",
                    [
                        {'resetType': 'notReset'}
                    ],
                    {
                        metadata: "QUEST2"
                    }
                )
            ]
        );
    }
}

console.log(new SampleStack().yaml());  // Generate Template
public class SampleStack : Gs2Cdk.Core.Model.Stack
{
    public SampleStack() {
        new Gs2Cdk.Gs2Mission.Model.Namespace(
            this,
            // omission
        ).MasterData(
            new [] {
                new Gs2Cdk.Gs2Mission.Model.MissionGroupModel(
                    "daily",
                    Gs2Cdk.Gs2Mission.Model.Enums.CurrentMissionMasterResetType.Daily,
                    new Gs2Cdk.Gs2Mission.Model.Options.MissionGroupModelOptions {
                        metadata = "DAILY",
                        tasks = new Gs2Cdk.Gs2Mission.Model.MissionTaskModel[] {
                            {'name': 'quest_x10', 'metadata': 'QUEST_X10', 'counterName': 'quest_complete', 'targetValue': 10, 'completeAcquireActions': [{'action': 'Gs2Experience:AddExperienceByUserId', 'request': '{"experienceName": "basic", "userId": "#{userId}", "experienceModelName": "player", "propertyId": "player", "experienceValue": 10}'}]},
                        {'name': 'quest_x20', 'metadata': 'QUEST_X20', 'counterName': 'quest_complete', 'premiseMissionTaskName': 'quest_x10', 'targetValue': 20, 'completeAcquireActions': [{'action': 'Gs2Experience:AddExperienceByUserId', 'request': '{"experienceName": "basic", "userId": "#{userId}", "experienceModelName": "player", "propertyId": "player", "experienceValue": 20}'}]},
                        {'name': 'gacha', 'metadata': 'GACHA', 'counterName': 'lot_gacha', 'targetValue': 1, 'completeAcquireActions': [{'action': 'Gs2Experience:AddExperienceByUserId', 'request': '{"experienceName": "basic", "userId": "#{userId}", "experienceModelName": "player", "propertyId": "player", "experienceValue": 30}'}]}
                        },
                        resetHour = 10,
                    }
                ),
                new Gs2Cdk.Gs2Mission.Model.MissionGroupModel(
                    "weekly",
                    Gs2Cdk.Gs2Mission.Model.Enums.CurrentMissionMasterResetType.Weekly,
                    new Gs2Cdk.Gs2Mission.Model.Options.MissionGroupModelOptions {
                        metadata = "WEEKLY",
                        tasks = new Gs2Cdk.Gs2Mission.Model.MissionTaskModel[] {
                            {'name': 'quest_x100', 'metadata': 'QUEST_X100', 'counterName': 'quest_complete', 'targetValue': 100, 'completeAcquireActions': [{'action': 'Gs2Experience:AddExperienceByUserId', 'request': '{"experienceName": "basic", "userId": "#{userId}", "experienceModelName": "player", "propertyId": "player", "experienceValue": 40}'}]},
                        {'name': 'quest_x1000', 'metadata': 'QUEST_X1000', 'counterName': 'quest_complete', 'premiseMissionTaskName': 'quest_x100', 'targetValue': 1000, 'completeAcquireActions': [{'action': 'Gs2Experience:AddExperienceByUserId', 'request': '{"experienceName": "basic", "userId": "#{userId}", "experienceModelName": "player", "propertyId": "player", "experienceValue": 50}'}]}
                        },
                        resetDayOfWeek = "monday",
                        resetHour = 10,
                    }
                ),
                new Gs2Cdk.Gs2Mission.Model.MissionGroupModel(
                    "story",
                    Gs2Cdk.Gs2Mission.Model.Enums.CurrentMissionMasterResetType.NotReset,
                    new Gs2Cdk.Gs2Mission.Model.Options.MissionGroupModelOptions {
                        metadata = "STORY",
                        tasks = new Gs2Cdk.Gs2Mission.Model.MissionTaskModel[] {
                            {'name': 'quest_1-1', 'metadata': 'QUEST_1-1', 'counterName': 'quest1', 'targetValue': 1},
                        {'name': 'quest_1-2', 'metadata': 'QUEST_1-2', 'counterName': 'quest1', 'premiseMissionTaskName': 'quest_1-1', 'targetValue': 1},
                        {'name': 'quest_1-3', 'metadata': 'QUEST_1-3', 'counterName': 'quest1', 'premiseMissionTaskName': 'quest_1-2', 'targetValue': 1},
                        {'name': 'quest_1-4', 'metadata': 'QUEST_1-4', 'counterName': 'quest1', 'premiseMissionTaskName': 'quest_1-3', 'targetValue': 1},
                        {'name': 'quest_2-1', 'metadata': 'QUEST_2-1', 'counterName': 'quest2', 'premiseMissionTaskName': 'quest_1-4', 'targetValue': 1}
                        },
                    }
                )
            },
            new [] {
                new Gs2Cdk.Gs2Mission.Model.CounterModel(
                    "quest_complete",
                    new Gs2Cdk.Gs2Mission.Model.CounterScopeModel[] {
                        {'resetType': 'daily', 'resetHour': 5},
                    {'resetType': 'weekly', 'resetDayOfWeek': 'monday', 'resetHour': 5}
                    },
                    new Gs2Cdk.Gs2Mission.Model.Options.CounterModelOptions {
                        metadata = "QUEST_COMPLETE",
                    }
                ),
                new Gs2Cdk.Gs2Mission.Model.CounterModel(
                    "lot_gacha",
                    new Gs2Cdk.Gs2Mission.Model.CounterScopeModel[] {
                        {'resetType': 'daily', 'resetHour': 5}
                    },
                    new Gs2Cdk.Gs2Mission.Model.Options.CounterModelOptions {
                        metadata = "LOT_GACHA",
                    }
                ),
                new Gs2Cdk.Gs2Mission.Model.CounterModel(
                    "quest1",
                    new Gs2Cdk.Gs2Mission.Model.CounterScopeModel[] {
                        {'resetType': 'notReset'}
                    },
                    new Gs2Cdk.Gs2Mission.Model.Options.CounterModelOptions {
                        metadata = "QUEST1",
                    }
                ),
                new Gs2Cdk.Gs2Mission.Model.CounterModel(
                    "quest2",
                    new Gs2Cdk.Gs2Mission.Model.CounterScopeModel[] {
                        {'resetType': 'notReset'}
                    },
                    new Gs2Cdk.Gs2Mission.Model.Options.CounterModelOptions {
                        metadata = "QUEST2",
                    }
                )
            }
        );
    }
}

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

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 send additional processing to mobile push notifications when the destination device is offline. If you use mobile push notifications well, you may be able to realize a flow in which you can notify the player by using mobile push notifications even if you end the game during matchmaking and return to the game.

TypeRequireDefaultLimitationDescription
gatewayNamespaceIdstring“grn:gs2:{region}:{ownerId}:gateway:default”~ 1024 charsGS2-Gateway namespace to use for push notifications
enableTransferMobileNotificationbool?falseForwarding to mobile push notification
soundstring{enableTransferMobileNotification} == true~ 1024 charsSound file name to be used for mobile push notifications

CounterScopeModel

Counter Reset Timing Model

TypeRequireDefaultLimitationDescription
resetTypeenum [
“notReset”,
“daily”,
“weekly”,
“monthly”
]
~ 128 charsReset timing
resetDayOfMonthint{resetType} == “monthly”1 ~ 31Date to reset (If the value exceeds the days of the month, it is treated as the last day.)
resetDayOfWeekenum [
“sunday”,
“monday”,
“tuesday”,
“wednesday”,
“thursday”,
“friday”,
“saturday”
]
{resetType} == “weekly”~ 128 charsDay of the week to reset
resetHourint{resetType} in [“monthly”, “weekly”, “daily”]~ 23Hour of Reset

ScopedValue

Reset timing

TypeRequireDefaultLimitationDescription
resetTypeenum [
“notReset”,
“daily”,
“weekly”,
“monthly”
]
~ 128 charsReset timing
valuelong0~ 9223372036854775805Count value
nextResetAtlongNext reset timing
updatedAtlongDatetime of last update

TargetCounterModel

Target Counter

Information about the counter that serves as the achievement goal for the mission

TypeRequireDefaultLimitationDescription
counterNamestring~ 128 charsCounter Name
resetTypeenum [
“notReset”,
“daily”,
“weekly”,
“monthly”
]
~ 128 charsTarget Reset timing
valuelong1 ~ 9223372036854775805Target value

AcquireAction

Acquire Action

TypeRequireDefaultLimitationDescription
actionenum [
"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:UnlockIncrementalExchangeByUserId",
"Gs2Exchange:CreateAwaitByUserId",
"Gs2Exchange:SkipByUserId",
"Gs2Experience:AddExperienceByUserId",
"Gs2Experience:SetExperienceByUserId",
"Gs2Experience:AddRankCapByUserId",
"Gs2Experience:SetRankCapByUserId",
"Gs2Experience:MultiplyAcquireActionsByUserId",
"Gs2Formation:AddMoldCapacityByUserId",
"Gs2Formation:SetMoldCapacityByUserId",
"Gs2Formation:AcquireActionsToFormProperties",
"Gs2Formation:SetFormByUserId",
"Gs2Formation:AcquireActionsToPropertyFormProperties",
"Gs2Grade:AddGradeByUserId",
"Gs2Grade:ApplyRankCapByUserId",
"Gs2Grade:MultiplyAcquireActionsByUserId",
"Gs2Guild:IncreaseMaximumCurrentMaximumMemberCountByGuildName",
"Gs2Guild:SetMaximumCurrentMaximumMemberCountByGuildName",
"Gs2Idle:IncreaseMaximumIdleMinutesByUserId",
"Gs2Idle:SetMaximumIdleMinutesByUserId",
"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",
"Gs2Quest:CreateProgressByUserId",
"Gs2Schedule:TriggerByUserId",
"Gs2SerialKey:RevertUseByUserId",
"Gs2Showcase:DecrementPurchaseCountByUserId",
"Gs2Showcase:ForceReDrawByUserId",
"Gs2SkillTree:MarkReleaseByUserId",
"Gs2Stamina:RecoverStaminaByUserId",
"Gs2Stamina:RaiseMaxValueByUserId",
"Gs2Stamina:SetMaxValueByUserId",
"Gs2Stamina:SetRecoverIntervalByUserId",
"Gs2Stamina:SetRecoverValueByUserId",
"Gs2StateMachine:StartStateMachineByUserId",
]
~ 128 charsTypes of actions to be performed in the stamp sheet
requeststring~ 1048576 charsJSON of request

ConsumeAction

Consume Action

TypeRequireDefaultLimitationDescription
actionenum [
"Gs2AdReward:ConsumePointByUserId",
"Gs2Dictionary:DeleteEntriesByUserId",
"Gs2Dictionary:VerifyEntryByUserId",
"Gs2Enchant:VerifyRarityParameterStatusByUserId",
"Gs2Enhance:DeleteProgressByUserId",
"Gs2Exchange:DeleteAwaitByUserId",
"Gs2Experience:SubExperienceByUserId",
"Gs2Experience:SubRankCapByUserId",
"Gs2Experience:VerifyRankByUserId",
"Gs2Experience:VerifyRankCapByUserId",
"Gs2Formation:SubMoldCapacityByUserId",
"Gs2Grade:SubGradeByUserId",
"Gs2Grade:VerifyGradeByUserId",
"Gs2Grade:VerifyGradeUpMaterialByUserId",
"Gs2Guild:DecreaseMaximumCurrentMaximumMemberCountByGuildName",
"Gs2Idle:DecreaseMaximumIdleMinutesByUserId",
"Gs2Inbox:OpenMessageByUserId",
"Gs2Inbox:DeleteMessageByUserId",
"Gs2Inventory:VerifyInventoryCurrentMaxCapacityByUserId",
"Gs2Inventory:ConsumeItemSetByUserId",
"Gs2Inventory:VerifyItemSetByUserId",
"Gs2Inventory:VerifyReferenceOfByUserId",
"Gs2Inventory:ConsumeSimpleItemsByUserId",
"Gs2Inventory:VerifySimpleItemByUserId",
"Gs2Inventory:ConsumeBigItemByUserId",
"Gs2Inventory:VerifyBigItemByUserId",
"Gs2JobQueue:DeleteJobByUserId",
"Gs2Limit:CountUpByUserId",
"Gs2Limit:VerifyCounterByUserId",
"Gs2LoginReward:MarkReceivedByUserId",
"Gs2Mission:ReceiveByUserId",
"Gs2Mission:DecreaseCounterByUserId",
"Gs2Mission:VerifyCounterValueByUserId",
"Gs2Money:WithdrawByUserId",
"Gs2Money:RecordReceipt",
"Gs2Quest:DeleteProgressByUserId",
"Gs2Schedule:DeleteTriggerByUserId",
"Gs2Schedule:VerifyEventByUserId",
"Gs2SerialKey:UseByUserId",
"Gs2Showcase:IncrementPurchaseCountByUserId",
"Gs2SkillTree:MarkRestrainByUserId",
"Gs2Stamina:DecreaseMaxValueByUserId",
"Gs2Stamina:ConsumeStaminaByUserId",
]
~ 128 charsTypes of actions to be performed in the stamp task
requeststring~ 1048576 charsJSON of request

Config

Configration

Set values to be applied to stamp sheet variables

TypeRequireDefaultLimitationDescription
keystring~ 64 charsName
valuestring~ 51200 charsValue

LogSetting

Log setting

This type manages log output settings. This type holds the identifier of the log namespace used to output log data. The log namespace ID specifies the GS2-Log namespace to aggregate and store the log data. Through this setting, API request and response log data under this namespace will be output to the target GS2-Log. GS2-Log provides logs in real time, which can be used for system monitoring, analysis, debugging, etc.

TypeRequireDefaultLimitationDescription
loggingNamespaceIdstring~ 1024 charsNamespace GRN

GitHubCheckoutSetting

Setup to check out master data from GitHub

TypeRequireDefaultLimitationDescription
apiKeyIdstring~ 1024 charsGitHub API key GRN
repositoryNamestring~ 1024 charsRepository Name
sourcePathstring~ 1024 charsSource code file path
referenceTypeenum [
“commit_hash”,
“branch”,
“tag”
]
~ 128 charsSource of code
commitHashstring{referenceType} == “commit_hash”~ 1024 charsCommit hash
branchNamestring{referenceType} == “branch”~ 1024 charsBranch Name
tagNamestring{referenceType} == “tag”~ 1024 charsTag Name

ScriptSetting

Script settings

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 execution result to stop the execution of the API or to tamper with the result of the API.

On the other hand, asynchronous execution does not block processing until the script has finished executing. Instead, you can use the script execution result to stop the execution of the API or to tamper with the result of the API. However, asynchronous execution does not block processing until the script has finished executing, so it is generally recommended to use asynchronous execution.

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.

TypeRequireDefaultLimitationDescription
triggerScriptIdstring~ 1024 charsScript GRN
doneTriggerTargetTypeenum [
“none”,
“gs2_script”,
“aws”
]
“none”~ 128 charsNotification of Completion
doneTriggerScriptIdstring{doneTriggerTargetType} == “gs2_script”~ 1024 charsScript GRN
doneTriggerQueueNamespaceIdstring{doneTriggerTargetType} == “gs2_script”~ 1024 charsNamespace GRN

TransactionSetting

Transaction settings

TypeRequireDefaultLimitationDescription
enableAutoRunboolfalseAutomatically run issued stamp sheets on the server side, or
distributorNamespaceIdstring“grn:gs2:{region}:{ownerId}:distributor:default”~ 1024 charsGS2-Distributor namespace used for stamp sheet execution
keyIdstring!{enableAutoRun}“grn:gs2:{region}:{ownerId}:key:default:key:default”~ 1024 charsGS2-Key encryption key used to sign the stamp sheet
queueNamespaceIdstring“grn:gs2:{region}:{ownerId}:queue:default”~ 1024 charsNamespace in GS2-JobQueue used to run the stamp sheet