GS2-Deploy/CDK Reference of GS2-SkillTree

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~ 128 charsNamespace name
descriptionstring~ 1024 charsDescription
transactionSettingTransactionSettingTransaction settings
releaseScriptScriptSettingScript to run when a node is released
restrainScriptScriptSettingScript to run when a node is restrained
logSettingLogSettingLog output settings

GetAttr

TypeDescription
ItemNamespaceNamespace created

Implementation Example

Type: GS2::SkillTree::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
  ReleaseScript: null
  RestrainScript: null
  LogSetting: 
    LoggingNamespaceId: grn:gs2:ap-northeast-1:YourOwnerId:log:namespace1
from gs2_cdk import Stack, core, skill_tree

class SampleStack(Stack):

    def __init__(self):
        super().__init__()
        skill_tree.Namespace(
            stack=self,
            name="namespace-0001",
            options=skill_tree.NamespaceOptions(
                transaction_setting=core.TransactionSetting(
                    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\SkillTree\Model\Namespace_(
            stack: $this,
            name: "namespace-0001",
            options: new \Gs2Cdk\SkillTree\Model\Options\NamespaceOptions(
                transactionSetting: new \Gs2Cdk\Core\Model\TransactionSetting(
                    enableAutoRun: True,
                    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.skillTree.model.Namespace(
            this,
            "namespace-0001",
            new io.gs2.cdk.skillTree.model.options.NamespaceOptions() {
                {
                    transactionSetting = new io.gs2.cdk.core.model.TransactionSetting(){
                        {
                            queueNamespaceId = "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(
                        loggingNamespaceId = "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
                    );
                }
            }
        );
    }
}

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

class SampleStack extends core.Stack
{
    public constructor() {
        super();
        new skillTree.model.Namespace(
            this,
            "namespace-0001",
            {
                transactionSetting: new core.TransactionSetting(
                    ,
                    "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.Gs2SkillTree.Model.Namespace(
            this,
            "namespace-0001",
            new Gs2Cdk.Gs2SkillTree.Model.Options.NamespaceOptions {
                transactionSetting = new Gs2Cdk.Core.Model.TransactionSetting(
                    new Gs2Cdk.Core.Model.Options.TransactionSettingOptions {
                        queueNamespaceId = "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(
                    LoggingNamespaceId = "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
                )
            }
        );
    }
}

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

CurrentTreeMaster

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.

TypeRequireDefaultLimitationDescription
namespaceNamestring~ 128 charsNamespace name
settingsstring~ 5242880 charsMaster data

GetAttr

TypeDescription
ItemCurrentTreeMasterUpdated and currently available status settings

Implementation Example

Type: GS2::SkillTree::CurrentTreeMaster
Properties:
  NamespaceName: namespace1
  Settings: {
    "version": "2023-09-06",
    "nodeModels": [
      {
        "name": "node-0001",
        "releaseConsumeActions": [
          {
            "action": "Gs2Inventory:ConsumeItemSetByUserId",
            "request": "{\"namespaceName\": \"namespace-0001\", \"inventoryName\": \"item\", \"itemName\": \"item-0001\", \"userId\": \"#{userId}\", \"consumeCount\": 10}"
          }
        ],
        "restrainReturnRate": 0.5,
        "metadata": "NODE-0001"
      },
      {
        "name": "node-0002",
        "releaseConsumeActions": [
          {
            "action": "Gs2Inventory:ConsumeItemSetByUserId",
            "request": "{\"namespaceName\": \"namespace-0001\", \"inventoryName\": \"item\", \"itemName\": \"item-0001\", \"userId\": \"#{userId}\", \"consumeCount\": 15}"
          }
        ],
        "restrainReturnRate": 0.5,
        "metadata": "NODE-0002",
        "premiseNodeNames": [
          "node-0001"
        ]
      },
      {
        "name": "node-0003",
        "releaseConsumeActions": [
          {
            "action": "Gs2Inventory:ConsumeItemSetByUserId",
            "request": "{\"namespaceName\": \"namespace-0001\", \"inventoryName\": \"item\", \"itemName\": \"item-0001\", \"userId\": \"#{userId}\", \"consumeCount\": 20}"
          },
          {
            "action": "Gs2Inventory:ConsumeItemSetByUserId",
            "request": "{\"namespaceName\": \"namespace-0001\", \"inventoryName\": \"item\", \"itemName\": \"item-0002\", \"userId\": \"#{userId}\", \"consumeCount\": 2}"
          }
        ],
        "restrainReturnRate": 0.5,
        "metadata": "NODE-0003",
        "premiseNodeNames": [
          "node-0002"
        ]
      }
    ]
  }
from gs2_cdk import Stack, core, skill_tree

class SampleStack(Stack):

    def __init__(self):
        super().__init__()
        skill_tree.Namespace(
            stack=self,
            # omission
        ).master_data(
            node_models=[
                skill_tree.NodeModel(
                    name='node-0001',
                    release_consume_actions=[
                            skill_tree.ConsumeAction(
                                action='Gs2Inventory:ConsumeItemSetByUserId',
                                request='{"namespaceName": "namespace-0001", "inventoryName": "item", "itemName": "item-0001", "userId": "#{userId}", "consumeCount": 10}'
                            ),
                        ],
                    restrain_return_rate=0.5,
                    options=skill_tree.NodeModelOptions(
                        metadata='NODE-0001',
                    ),
                ),
                skill_tree.NodeModel(
                    name='node-0002',
                    release_consume_actions=[
                            skill_tree.ConsumeAction(
                                action='Gs2Inventory:ConsumeItemSetByUserId',
                                request='{"namespaceName": "namespace-0001", "inventoryName": "item", "itemName": "item-0001", "userId": "#{userId}", "consumeCount": 15}'
                            ),
                        ],
                    restrain_return_rate=0.5,
                    options=skill_tree.NodeModelOptions(
                        metadata='NODE-0002',
                        premise_node_names=[
                            'node-0001',
                        ],
                    ),
                ),
                skill_tree.NodeModel(
                    name='node-0003',
                    release_consume_actions=[
                            skill_tree.ConsumeAction(
                                action='Gs2Inventory:ConsumeItemSetByUserId',
                                request='{"namespaceName": "namespace-0001", "inventoryName": "item", "itemName": "item-0001", "userId": "#{userId}", "consumeCount": 20}'
                            ),
                            skill_tree.ConsumeAction(
                                action='Gs2Inventory:ConsumeItemSetByUserId',
                                request='{"namespaceName": "namespace-0001", "inventoryName": "item", "itemName": "item-0002", "userId": "#{userId}", "consumeCount": 2}'
                            ),
                        ],
                    restrain_return_rate=0.5,
                    options=skill_tree.NodeModelOptions(
                        metadata='NODE-0003',
                        premise_node_names=[
                            'node-0002',
                        ],
                    ),
                ),
            ],
        )

print(SampleStack().yaml())  # Generate Template
class SampleStack extends \Gs2Cdk\Core\Model\Stack
{
    function __construct() {
        parent::__construct();
        (new \Gs2Cdk\SkillTree\Model\Namespace_(
            stack: $this,
            // omission
        ))->masterData(
            [
                new \Gs2Cdk\SkillTree\Model\NodeModel(
                    name:"node-0001",
                    releaseConsumeActions:[
                        new \Gs2Cdk\Core\Model\ConsumeAction(
                            action: "Gs2Inventory:ConsumeItemSetByUserId",
                            request: "{\"namespaceName\": \"namespace-0001\", \"inventoryName\": \"item\", \"itemName\": \"item-0001\", \"userId\": \"#{userId}\", \"consumeCount\": 10}"
                        ),
                    ],
                    restrainReturnRate:0.5,
                    options: new \Gs2Cdk\SkillTree\Model\Options\NodeModelOptions(
                        metadata:"NODE-0001"
                    )
                ),
                new \Gs2Cdk\SkillTree\Model\NodeModel(
                    name:"node-0002",
                    releaseConsumeActions:[
                        new \Gs2Cdk\Core\Model\ConsumeAction(
                            action: "Gs2Inventory:ConsumeItemSetByUserId",
                            request: "{\"namespaceName\": \"namespace-0001\", \"inventoryName\": \"item\", \"itemName\": \"item-0001\", \"userId\": \"#{userId}\", \"consumeCount\": 15}"
                        ),
                    ],
                    restrainReturnRate:0.5,
                    options: new \Gs2Cdk\SkillTree\Model\Options\NodeModelOptions(
                        metadata:"NODE-0002",
                        premiseNodeNames:[
                            "node-0001",
                        ]
                    )
                ),
                new \Gs2Cdk\SkillTree\Model\NodeModel(
                    name:"node-0003",
                    releaseConsumeActions:[
                        new \Gs2Cdk\Core\Model\ConsumeAction(
                            action: "Gs2Inventory:ConsumeItemSetByUserId",
                            request: "{\"namespaceName\": \"namespace-0001\", \"inventoryName\": \"item\", \"itemName\": \"item-0001\", \"userId\": \"#{userId}\", \"consumeCount\": 20}"
                        ),
                        new \Gs2Cdk\Core\Model\ConsumeAction(
                            action: "Gs2Inventory:ConsumeItemSetByUserId",
                            request: "{\"namespaceName\": \"namespace-0001\", \"inventoryName\": \"item\", \"itemName\": \"item-0002\", \"userId\": \"#{userId}\", \"consumeCount\": 2}"
                        ),
                    ],
                    restrainReturnRate:0.5,
                    options: new \Gs2Cdk\SkillTree\Model\Options\NodeModelOptions(
                        metadata:"NODE-0003",
                        premiseNodeNames:[
                            "node-0002",
                        ]
                    )
                )
            ]
        );
    }
}

print((new SampleStack())->yaml());  // Generate Template
class SampleStack extends io.gs2.cdk.core.model.Stack
{
    public SampleStack() {
        super();
        new io.gs2.cdk.skillTree.model.Namespace(
            this,
            // omission
        ).masterData(
            Arrays.asList(
                new io.gs2.cdk.skillTree.model.NodeModel(
                    "node-0001",
                    Arrays.asList(
                        new io.gs2.cdk.core.consume_action(
                            "Gs2Inventory:ConsumeItemSetByUserId",
                            "{\"namespaceName\": \"namespace-0001\", \"inventoryName\": \"item\", \"itemName\": \"item-0001\", \"userId\": \"#{userId}\", \"consumeCount\": 10}"
                        )
                    ),
                    0.5f,
                    new io.gs2.cdk.skillTree.model.options.NodeModelOptions() {
                        {
                            metadata: "NODE-0001";
                        }
                    }
                ),
                new io.gs2.cdk.skillTree.model.NodeModel(
                    "node-0002",
                    Arrays.asList(
                        new io.gs2.cdk.core.consume_action(
                            "Gs2Inventory:ConsumeItemSetByUserId",
                            "{\"namespaceName\": \"namespace-0001\", \"inventoryName\": \"item\", \"itemName\": \"item-0001\", \"userId\": \"#{userId}\", \"consumeCount\": 15}"
                        )
                    ),
                    0.5f,
                    new io.gs2.cdk.skillTree.model.options.NodeModelOptions() {
                        {
                            metadata: "NODE-0002";
                            premiseNodeNames: Arrays.asList(
                                "node-0001"
                            );
                        }
                    }
                ),
                new io.gs2.cdk.skillTree.model.NodeModel(
                    "node-0003",
                    Arrays.asList(
                        new io.gs2.cdk.core.consume_action(
                            "Gs2Inventory:ConsumeItemSetByUserId",
                            "{\"namespaceName\": \"namespace-0001\", \"inventoryName\": \"item\", \"itemName\": \"item-0001\", \"userId\": \"#{userId}\", \"consumeCount\": 20}"
                        ),
                        new io.gs2.cdk.core.consume_action(
                            "Gs2Inventory:ConsumeItemSetByUserId",
                            "{\"namespaceName\": \"namespace-0001\", \"inventoryName\": \"item\", \"itemName\": \"item-0002\", \"userId\": \"#{userId}\", \"consumeCount\": 2}"
                        )
                    ),
                    0.5f,
                    new io.gs2.cdk.skillTree.model.options.NodeModelOptions() {
                        {
                            metadata: "NODE-0003";
                            premiseNodeNames: Arrays.asList(
                                "node-0002"
                            );
                        }
                    }
                )
            )
        );
    }
}

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

class SampleStack extends core.Stack
{
    public constructor() {
        super();
        new skillTree.model.Namespace(
            this,
            // omission
        ).masterData(
            [
                new skillTree.model.NodeModel(
                    "node-0001",
                    [
                        new ConsumeAction(
                            "Gs2Inventory:ConsumeItemSetByUserId",
                            "{\"namespaceName\": \"namespace-0001\", \"inventoryName\": \"item\", \"itemName\": \"item-0001\", \"userId\": \"#{userId}\", \"consumeCount\": 10}"
                        ),
                    ],
                    0.5,
                    {
                        metadata: "NODE-0001"
                    }
                ),
                new skillTree.model.NodeModel(
                    "node-0002",
                    [
                        new ConsumeAction(
                            "Gs2Inventory:ConsumeItemSetByUserId",
                            "{\"namespaceName\": \"namespace-0001\", \"inventoryName\": \"item\", \"itemName\": \"item-0001\", \"userId\": \"#{userId}\", \"consumeCount\": 15}"
                        ),
                    ],
                    0.5,
                    {
                        metadata: "NODE-0002",
                        premiseNodeNames: [
                            "node-0001",
                        ]
                    }
                ),
                new skillTree.model.NodeModel(
                    "node-0003",
                    [
                        new ConsumeAction(
                            "Gs2Inventory:ConsumeItemSetByUserId",
                            "{\"namespaceName\": \"namespace-0001\", \"inventoryName\": \"item\", \"itemName\": \"item-0001\", \"userId\": \"#{userId}\", \"consumeCount\": 20}"
                        ),
                        new ConsumeAction(
                            "Gs2Inventory:ConsumeItemSetByUserId",
                            "{\"namespaceName\": \"namespace-0001\", \"inventoryName\": \"item\", \"itemName\": \"item-0002\", \"userId\": \"#{userId}\", \"consumeCount\": 2}"
                        ),
                    ],
                    0.5,
                    {
                        metadata: "NODE-0003",
                        premiseNodeNames: [
                            "node-0002",
                        ]
                    }
                )
            ]
        );
    }
}

console.log(new SampleStack().yaml());  // Generate Template
public class SampleStack : Gs2Cdk.Core.Model.Stack
{
    public SampleStack() {
        new Gs2Cdk.Gs2SkillTree.Model.Namespace(
            this,
            // omission
        ).MasterData(
            new [] {
                new Gs2Cdk.Gs2SkillTree.Model.NodeModel(
                    "node-0001",
                    new Gs2Cdk.Gs2SkillTree.Model.ConsumeAction[] {
                        new Gs2Cdk.Core.Model.ConsumeAction(
                            action: "Gs2Inventory:ConsumeItemSetByUserId",
                            request: "{\"namespaceName\": \"namespace-0001\", \"inventoryName\": \"item\", \"itemName\": \"item-0001\", \"userId\": \"#{userId}\", \"consumeCount\": 10}"
                        ),
                    },
                    0.5f,
                    new Gs2Cdk.Gs2SkillTree.Model.Options.NodeModelOptions {
                        metadata = "NODE-0001"
                    }
                ),
                new Gs2Cdk.Gs2SkillTree.Model.NodeModel(
                    "node-0002",
                    new Gs2Cdk.Gs2SkillTree.Model.ConsumeAction[] {
                        new Gs2Cdk.Core.Model.ConsumeAction(
                            action: "Gs2Inventory:ConsumeItemSetByUserId",
                            request: "{\"namespaceName\": \"namespace-0001\", \"inventoryName\": \"item\", \"itemName\": \"item-0001\", \"userId\": \"#{userId}\", \"consumeCount\": 15}"
                        ),
                    },
                    0.5f,
                    new Gs2Cdk.Gs2SkillTree.Model.Options.NodeModelOptions {
                        metadata = "NODE-0002",
                        premiseNodeNames = new string[] {
                            "node-0001",
                        }
                    }
                ),
                new Gs2Cdk.Gs2SkillTree.Model.NodeModel(
                    "node-0003",
                    new Gs2Cdk.Gs2SkillTree.Model.ConsumeAction[] {
                        new Gs2Cdk.Core.Model.ConsumeAction(
                            action: "Gs2Inventory:ConsumeItemSetByUserId",
                            request: "{\"namespaceName\": \"namespace-0001\", \"inventoryName\": \"item\", \"itemName\": \"item-0001\", \"userId\": \"#{userId}\", \"consumeCount\": 20}"
                        ),
                        new Gs2Cdk.Core.Model.ConsumeAction(
                            action: "Gs2Inventory:ConsumeItemSetByUserId",
                            request: "{\"namespaceName\": \"namespace-0001\", \"inventoryName\": \"item\", \"itemName\": \"item-0002\", \"userId\": \"#{userId}\", \"consumeCount\": 2}"
                        ),
                    },
                    0.5f,
                    new Gs2Cdk.Gs2SkillTree.Model.Options.NodeModelOptions {
                        metadata = "NODE-0003",
                        premiseNodeNames = new string[] {
                            "node-0002",
                        }
                    }
                )
            }
        );
    }
}

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

Config

Configration

Set values to be applied to transaction variables

TypeRequireDefaultLimitationDescription
keystring~ 64 charsName
valuestring~ 51200 charsValue

ConsumeAction

Consume Action

TypeRequireDefaultLimitationDescription
actionenum {
"Gs2Matchmaking:VerifyIncludeParticipantByUserId",
"Gs2AdReward:ConsumePointByUserId",
"Gs2Dictionary:DeleteEntriesByUserId",
"Gs2Distributor:IfExpressionByUserId",
"Gs2Enhance:DeleteProgressByUserId",
"Gs2Exchange:DeleteAwaitByUserId",
"Gs2Experience:SubExperienceByUserId",
"Gs2Experience:SubRankCapByUserId",
"Gs2Formation:SubMoldCapacityByUserId",
"Gs2Grade:SubGradeByUserId",
"Gs2Guild:DecreaseMaximumCurrentMaximumMemberCountByGuildName",
"Gs2Idle:DecreaseMaximumIdleMinutesByUserId",
"Gs2Inbox:OpenMessageByUserId",
"Gs2Inbox:DeleteMessageByUserId",
"Gs2Inventory:ConsumeItemSetByUserId",
"Gs2Inventory:ConsumeSimpleItemsByUserId",
"Gs2Inventory:ConsumeBigItemByUserId",
"Gs2JobQueue:DeleteJobByUserId",
"Gs2Limit:CountUpByUserId",
"Gs2LoginReward:MarkReceivedByUserId",
"Gs2Mission:ReceiveByUserId",
"Gs2Mission:BatchReceiveByUserId",
"Gs2Mission:DecreaseCounterByUserId",
"Gs2Money:WithdrawByUserId",
"Gs2Money:RecordReceipt",
"Gs2Money2:WithdrawByUserId",
"Gs2Money2:VerifyReceiptByUserId",
"Gs2Quest:DeleteProgressByUserId",
"Gs2Ranking2:CreateGlobalRankingReceivedRewardByUserId",
"Gs2Ranking2:CreateClusterRankingReceivedRewardByUserId",
"Gs2Schedule:DeleteTriggerByUserId",
"Gs2SerialKey:UseByUserId",
"Gs2SerialKey:VerifyCodeByUserId",
"Gs2Showcase:IncrementPurchaseCountByUserId",
"Gs2SkillTree:MarkRestrainByUserId",
"Gs2Stamina:DecreaseMaxValueByUserId",
"Gs2Stamina:ConsumeStaminaByUserId",
}
~ 128 charsTypes of actions to be performed in the consume action
requeststring~ 1048576 charsJSON of request

VerifyAction

Verify Action

TypeRequireDefaultLimitationDescription
actionenum {
"Gs2Dictionary:VerifyEntryByUserId",
"Gs2Distributor:AndExpressionByUserId",
"Gs2Distributor:OrExpressionByUserId",
"Gs2Enchant:VerifyRarityParameterStatusByUserId",
"Gs2Experience:VerifyRankByUserId",
"Gs2Experience:VerifyRankCapByUserId",
"Gs2Grade:VerifyGradeByUserId",
"Gs2Grade:VerifyGradeUpMaterialByUserId",
"Gs2Guild:VerifyCurrentMaximumMemberCountByGuildName",
"Gs2Guild:VerifyIncludeMemberByUserId",
"Gs2Inventory:VerifyInventoryCurrentMaxCapacityByUserId",
"Gs2Inventory:VerifyItemSetByUserId",
"Gs2Inventory:VerifyReferenceOfByUserId",
"Gs2Inventory:VerifySimpleItemByUserId",
"Gs2Inventory:VerifyBigItemByUserId",
"Gs2Limit:VerifyCounterByUserId",
"Gs2Mission:VerifyCompleteByUserId",
"Gs2Mission:VerifyCounterValueByUserId",
"Gs2Schedule:VerifyTriggerByUserId",
"Gs2Schedule:VerifyEventByUserId",
}
~ 128 charsTypes of actions to be performed in the verify task
requeststring~ 1048576 charsJSON of request

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:CreateAwaitByUserId",
"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",
"Gs2Script:InvokeScript",
"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 acquire action
requeststring~ 1048576 charsJSON of request

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

Enumeration type definition to specify as referenceType

Enumerator String DefinitionDescription
commit_hashCommit hash
branchBranch
tagTag

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

Enumeration type definition to specify as doneTriggerTargetType

Enumerator String DefinitionDescription
noneNone
gs2_scriptGS2-Script
awsAmazon EventBridge

TransactionSetting

Transaction settings

TypeRequireDefaultLimitationDescription
enableAutoRunboolfalseAutomatically run issued transactions on the server side, or
distributorNamespaceIdstring“grn:gs2:{region}:{ownerId}:distributor:default”~ 1024 charsGS2-Distributor namespace used for transaction execution
queueNamespaceIdstring“grn:gs2:{region}:{ownerId}:queue:default”~ 1024 charsNamespace in GS2-JobQueue used to run the transaction

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