GS2-Deploy/CDK Reference of GS2-Enhance

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

Entity

Resources operated in Deploy process

Namespace

A namespace is a mechanism that allows multiple uses of the same service for different purposes within a single project. 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.

	Type	Required	Default	Value Limits	Description
namespaceId	string	✓		~ 1024 chars	Namespace GRN
name	string	✓		~ 128 chars	Namespace name
description	string			~ 1024 chars	Description
transactionSetting	TransactionSetting	✓			Transaction settings
enhanceScript	ScriptSetting				Script to be executed at the time of reinforcement
logSetting	LogSetting				Log output settings
createdAt	long	✓	Now		Datetime of creation Unix time, milliseconds Automatically configured on the server
updatedAt	long	✓	Now		Datetime of last update Unix time, milliseconds Automatically configured on the server
revision	long		0	0 ~ 9223372036854775805	Revision

GetAttr

Generation results of resources that can be obtained with the !GetAttr tag

	Type	Description
Item	Namespace	Namespace created

Implementation Example

Type: GS2::Enhance::Namespace
Properties:
  Name: namespace-0001
  Description: null
  TransactionSetting: 
    EnableAutoRun: true
    QueueNamespaceId: grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001
  EnhanceScript: 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/enhance"
    "github.com/openlyinc/pointy"
)

SampleStack := core.NewStack()
enhance.NewNamespace(
    &SampleStack,
    "namespace-0001",
    enhance.NamespaceOptions{
        TransactionSetting: core.NewTransactionSetting(
            core.TransactionSettingOptions{
                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\Enhance\Model\Namespace_(
            stack: $this,
            name: "namespace-0001",
            options: new \Gs2Cdk\Enhance\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.enhance.model.Namespace(
                this,
                "namespace-0001",
                new io.gs2.cdk.enhance.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.Gs2Enhance.Model.Namespace(
            stack: this,
            name: "namespace-0001",
            options: new Gs2Cdk.Gs2Enhance.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 enhance from "@/gs2cdk/enhance";

class SampleStack extends core.Stack
{
    public constructor() {
        super();
        new enhance.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, enhance

class SampleStack(Stack):

    def __init__(self):
        super().__init__()
        enhance.Namespace(
            stack=self,
            name='namespace-0001',
            options=enhance.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

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.

In contrast, asynchronous execution does not block processing until the script has finished executing. Since the script result cannot be used to stop the API execution or modify the API response, asynchronous execution does not affect the API’s response flow. For this reason, asynchronous execution 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

Script GRN of synchronous execution script

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

doneTriggerTargetType

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

✓

“none”

~ 128 chars

How to execute asynchronous scripts

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

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

doneTriggerScriptId

string

{doneTriggerTargetType} == “gs2_script”

~ 1024 chars

Script GRN of asynchronous execution script

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

* Enabled 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 is little reason to use GS2-JobQueue, so you don’t need to specify it unless you have a specific reason.

* Enabled if doneTriggerTargetType is “gs2_script”

LogSetting

Log Export Settings

Manages log data export settings. 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, and debugging.

	Type	Condition	Required	Default	Value Limits	Description
loggingNamespaceId	string		✓		~ 1024 chars	GS2-Log namespace GRN to output logs

TransactionSetting

Transaction settings

Transaction settings control how transactions are executed, their consistency, asynchronous processing, and conflict avoidance mechanisms. Combining features like AutoRun, AtomicCommit, Distributor, batch application of script results, and asynchronous acquisition actions via JobQueue enables robust transaction management tailored to game logic.

	Type	Condition	Required	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 * Required if enableAutoRun is true
transactionUseDistributor	bool	{enableAtomicCommit} == true	✓*	false		Whether to execute transactions asynchronously * Required if enableAtomicCommit is true
commitScriptResultInUseDistributor	bool	{transactionUseDistributor} == true	✓*	false		Whether to execute the commit processing of the script result asynchronously * Required if transactionUseDistributor is true
acquireActionUseJobQueue	bool	{enableAtomicCommit} == true	✓*	false		Whether to use GS2-JobQueue to execute the acquire action * Required if enableAtomicCommit is true
distributorNamespaceId	string		✓	“grn:gs2:{region}:{ownerId}:distributor:default”	~ 1024 chars	GS2-Distributor namespace used for transaction execution
queueNamespaceId	string		✓	“grn:gs2:{region}:{ownerId}:queue:default”	~ 1024 chars	Namespace in GS2-JobQueue used to run the transaction

CurrentRateMaster

Currently available enhanced rate masters

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

To create JSON files, we provide a master data editor within the management console. Additionally, you can utilize the service by creating tools more suited to game operations and exporting JSON files in the appropriate format.

Note

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

	Type	Condition	Required	Default	Value Limits	Description
namespaceId	string		✓		~ 1024 chars	Namespace GRN
settings	string		✓		~ 5242880 bytes (5MB)	Master Data

GetAttr

Generation results of resources that can be obtained with the !GetAttr tag

	Type	Description
Item	CurrentRateMaster	Updated and currently available enhanced rate settings

Implementation Example

Type: GS2::Enhance::CurrentRateMaster
Properties:
  NamespaceName: namespace-0001
  Mode: direct
  Settings: {
    "version": "2020-08-22",
    "rateModels": [
      {
        "name": "character-friendly",
        "targetInventoryModelId": "grn:inventory:character",
        "acquireExperienceSuffix": ":friendly",
        "materialInventoryModelId": "grn:inventory:sweet",
        "experienceModelId": "grn:experience:friendly",
        "metadata": "CHARACTER_FRIENDLY",
        "acquireExperienceHierarchy": [
          "taste"
        ],
        "bonusRates": [
          {
            "rate": 1,
            "weight": 90
          }
        ]
      },
      {
        "name": "character-level",
        "targetInventoryModelId": "grn:inventory:character",
        "acquireExperienceSuffix": ":level",
        "materialInventoryModelId": "grn:inventory:material",
        "experienceModelId": "grn:gs2:ap-northeast-1:YourOwnerId:experience:namespace-0001:model:level",
        "metadata": "CHARACTER_LEVEL",
        "acquireExperienceHierarchy": [
          "experience"
        ],
        "bonusRates": [
          {
            "rate": 1,
            "weight": 90
          },
          {
            "rate": 1.5,
            "weight": 9
          },
          {
            "rate": 2,
            "weight": 1
          }
        ]
      }
    ],
    "unleashRateModels": [
    ]
  }
  UploadToken: null

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

SampleStack := core.NewStack()
enhance.NewNamespace(
    &SampleStack,
    "namespace-0001",
    enhance.NamespaceOptions{},
).MasterData(
    []enhance.RateModel{
        enhance.NewRateModel(
            "character-friendly",
            "grn:inventory:character",
            ":friendly",
            "grn:inventory:sweet",
            "grn:experience:friendly",
            enhance.RateModelOptions{
                Metadata: pointy.String("CHARACTER_FRIENDLY"),
                AcquireExperienceHierarchy: []string{
                    "taste",
                },
                BonusRates: []enhance.BonusRate{
                    enhance.NewBonusRate(
                        1,
                        90,
                        enhance.BonusRateOptions{},
                    ),
                },
            },
        ),
        enhance.NewRateModel(
            "character-level",
            "grn:inventory:character",
            ":level",
            "grn:inventory:material",
            "grn:gs2:ap-northeast-1:YourOwnerId:experience:namespace-0001:model:level",
            enhance.RateModelOptions{
                Metadata: pointy.String("CHARACTER_LEVEL"),
                AcquireExperienceHierarchy: []string{
                    "experience",
                },
                BonusRates: []enhance.BonusRate{
                    enhance.NewBonusRate(
                        1,
                        90,
                        enhance.BonusRateOptions{},
                    ),
                    enhance.NewBonusRate(
                        1.5,
                        9,
                        enhance.BonusRateOptions{},
                    ),
                    enhance.NewBonusRate(
                        2,
                        1,
                        enhance.BonusRateOptions{},
                    ),
                },
            },
        ),
    },
    []enhance.UnleashRateModel{
    },
)

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

class SampleStack extends \Gs2Cdk\Core\Model\Stack
{
    function __construct() {
        parent::__construct();
        (new \Gs2Cdk\Enhance\Model\Namespace_(
            stack: $this,
            name: "namespace-0001"
        ))->masterData(
            [
                new \Gs2Cdk\Enhance\Model\RateModel(
                    name:"character-friendly",
                    targetInventoryModelId:"grn:inventory:character",
                    acquireExperienceSuffix:":friendly",
                    materialInventoryModelId:"grn:inventory:sweet",
                    experienceModelId:"grn:experience:friendly",
                    options: new \Gs2Cdk\Enhance\Model\Options\RateModelOptions(
                        metadata:"CHARACTER_FRIENDLY",
                        acquireExperienceHierarchy:[
                            "taste",
                        ],
                        bonusRates:[
                            new \Gs2Cdk\Enhance\Model\BonusRate(
                                rate: 1,
                                weight: 90,    
                            ),
                        ]
                    )
                ),
                new \Gs2Cdk\Enhance\Model\RateModel(
                    name:"character-level",
                    targetInventoryModelId:"grn:inventory:character",
                    acquireExperienceSuffix:":level",
                    materialInventoryModelId:"grn:inventory:material",
                    experienceModelId:"grn:gs2:ap-northeast-1:YourOwnerId:experience:namespace-0001:model:level",
                    options: new \Gs2Cdk\Enhance\Model\Options\RateModelOptions(
                        metadata:"CHARACTER_LEVEL",
                        acquireExperienceHierarchy:[
                            "experience",
                        ],
                        bonusRates:[
                            new \Gs2Cdk\Enhance\Model\BonusRate(
                                rate: 1,
                                weight: 90,    
                            ),
                            new \Gs2Cdk\Enhance\Model\BonusRate(
                                rate: 1.5,
                                weight: 9,    
                            ),
                            new \Gs2Cdk\Enhance\Model\BonusRate(
                                rate: 2,
                                weight: 1,    
                            ),
                        ]
                    )
                )
            ],
            [
            ]
        );
    }
}

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

class SampleStack extends io.gs2.cdk.core.model.Stack
{
    public SampleStack() {
        super();
        new io.gs2.cdk.enhance.model.Namespace(
            this,
            "namespace-0001"
        ).masterData(
            Arrays.asList(
                new io.gs2.cdk.enhance.model.RateModel(
                    "character-friendly",
                    "grn:inventory:character",
                    ":friendly",
                    "grn:inventory:sweet",
                    "grn:experience:friendly",
                    new io.gs2.cdk.enhance.model.options.RateModelOptions()
                        .withMetadata("CHARACTER_FRIENDLY")
                        .withAcquireExperienceHierarchy(Arrays.asList(
                            "taste"
                        ))
                        .withBonusRates(Arrays.asList(
                            new io.gs2.cdk.enhance.model.BonusRate(
                                1f,
                                90        
                            )
                        ))
                ),
                new io.gs2.cdk.enhance.model.RateModel(
                    "character-level",
                    "grn:inventory:character",
                    ":level",
                    "grn:inventory:material",
                    "grn:gs2:ap-northeast-1:YourOwnerId:experience:namespace-0001:model:level",
                    new io.gs2.cdk.enhance.model.options.RateModelOptions()
                        .withMetadata("CHARACTER_LEVEL")
                        .withAcquireExperienceHierarchy(Arrays.asList(
                            "experience"
                        ))
                        .withBonusRates(Arrays.asList(
                            new io.gs2.cdk.enhance.model.BonusRate(
                                1f,
                                90        
                            ),
                            new io.gs2.cdk.enhance.model.BonusRate(
                                1.5f,
                                9        
                            ),
                            new io.gs2.cdk.enhance.model.BonusRate(
                                2f,
                                1        
                            )
                        ))
                )
            ),
            Arrays.asList(
            )
        );
    }
}

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

public class SampleStack : Gs2Cdk.Core.Model.Stack
{
    public SampleStack() {
        new Gs2Cdk.Gs2Enhance.Model.Namespace(
            stack: this,
            name: "namespace-0001"
        ).MasterData(
            new Gs2Cdk.Gs2Enhance.Model.RateModel[] {
                new Gs2Cdk.Gs2Enhance.Model.RateModel(
                    name: "character-friendly",
                    targetInventoryModelId: "grn:inventory:character",
                    acquireExperienceSuffix: ":friendly",
                    materialInventoryModelId: "grn:inventory:sweet",
                    experienceModelId: "grn:experience:friendly",
                    options: new Gs2Cdk.Gs2Enhance.Model.Options.RateModelOptions
                    {
                        metadata = "CHARACTER_FRIENDLY",
                        acquireExperienceHierarchy = new string[]
                        {
                            "taste"
                        },
                        bonusRates = new Gs2Cdk.Gs2Enhance.Model.BonusRate[]
                        {
                            new Gs2Cdk.Gs2Enhance.Model.BonusRate(
                                rate: 1f,
                                weight: 90    
                            )
                        }
                    }
                ),
                new Gs2Cdk.Gs2Enhance.Model.RateModel(
                    name: "character-level",
                    targetInventoryModelId: "grn:inventory:character",
                    acquireExperienceSuffix: ":level",
                    materialInventoryModelId: "grn:inventory:material",
                    experienceModelId: "grn:gs2:ap-northeast-1:YourOwnerId:experience:namespace-0001:model:level",
                    options: new Gs2Cdk.Gs2Enhance.Model.Options.RateModelOptions
                    {
                        metadata = "CHARACTER_LEVEL",
                        acquireExperienceHierarchy = new string[]
                        {
                            "experience"
                        },
                        bonusRates = new Gs2Cdk.Gs2Enhance.Model.BonusRate[]
                        {
                            new Gs2Cdk.Gs2Enhance.Model.BonusRate(
                                rate: 1f,
                                weight: 90    
                            ),
                            new Gs2Cdk.Gs2Enhance.Model.BonusRate(
                                rate: 1.5f,
                                weight: 9    
                            ),
                            new Gs2Cdk.Gs2Enhance.Model.BonusRate(
                                rate: 2f,
                                weight: 1    
                            )
                        }
                    }
                )
            },
            new Gs2Cdk.Gs2Enhance.Model.UnleashRateModel[] {
            }
        );
    }
}

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

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

class SampleStack extends core.Stack
{
    public constructor() {
        super();
        new enhance.model.Namespace(
            this,
            "namespace-0001",
        ).masterData(
            [
                new enhance.model.RateModel(
                    "character-friendly",
                    "grn:inventory:character",
                    ":friendly",
                    "grn:inventory:sweet",
                    "grn:experience:friendly",
                    {
                        metadata: "CHARACTER_FRIENDLY",
                        acquireExperienceHierarchy: [
                            "taste",
                        ],
                        bonusRates: [
                            new enhance.model.BonusRate(
                                1,
                                90        
                            ),
                        ]
                    }
                ),
                new enhance.model.RateModel(
                    "character-level",
                    "grn:inventory:character",
                    ":level",
                    "grn:inventory:material",
                    "grn:gs2:ap-northeast-1:YourOwnerId:experience:namespace-0001:model:level",
                    {
                        metadata: "CHARACTER_LEVEL",
                        acquireExperienceHierarchy: [
                            "experience",
                        ],
                        bonusRates: [
                            new enhance.model.BonusRate(
                                1,
                                90        
                            ),
                            new enhance.model.BonusRate(
                                1.5,
                                9        
                            ),
                            new enhance.model.BonusRate(
                                2,
                                1        
                            ),
                        ]
                    }
                )
            ],
            [
            ]
        );
    }
}

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

from gs2_cdk import Stack, core, enhance

class SampleStack(Stack):

    def __init__(self):
        super().__init__()
        enhance.Namespace(
            stack=self,
            name="namespace-0001",
        ).master_data(
            rate_models=[
                enhance.RateModel(
                    name='character-friendly',
                    target_inventory_model_id='grn:inventory:character',
                    acquire_experience_suffix=':friendly',
                    material_inventory_model_id='grn:inventory:sweet',
                    experience_model_id='grn:experience:friendly',
                    options=enhance.RateModelOptions(
                        metadata = 'CHARACTER_FRIENDLY',
                        acquire_experience_hierarchy = [
                            'taste',
                        ],
                        bonus_rates = [
                            enhance.BonusRate(
                                rate=1,
                                weight=90,        
                            ),
                        ]
                    ),
                ),
                enhance.RateModel(
                    name='character-level',
                    target_inventory_model_id='grn:inventory:character',
                    acquire_experience_suffix=':level',
                    material_inventory_model_id='grn:inventory:material',
                    experience_model_id='grn:gs2:ap-northeast-1:YourOwnerId:experience:namespace-0001:model:level',
                    options=enhance.RateModelOptions(
                        metadata = 'CHARACTER_LEVEL',
                        acquire_experience_hierarchy = [
                            'experience',
                        ],
                        bonus_rates = [
                            enhance.BonusRate(
                                rate=1,
                                weight=90,        
                            ),
                            enhance.BonusRate(
                                rate=1.5,
                                weight=9,        
                            ),
                            enhance.BonusRate(
                                rate=2,
                                weight=1,        
                            ),
                        ]
                    ),
                ),
            ],
            unleash_rate_models=[
            ],
        )

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

RateModel

Enhancement Rate Model

The enhancement rate is data that defines the materials used for enhancement and the target of enhancement.

Both material data and enhancement target data must be managed in GS2-Inventory. The experience value obtained from the enhancement is recorded in GS2-Inventory metadata in JSON format. Here, it is necessary to describe at which level of the metadata the experience value is stored.

A correction value can be applied to the amount of experience value that can be obtained with a certain probability of great success during enhancement. The probability of that draw is also defined in this entity.

	Type	Required	Value Limits	Description
rateModelId	string	✓	~ 1024 chars	Enhance Rate Model GRN
name	string	✓	~ 128 chars	Enhanced Rate Name
description	string		~ 1024 chars	Description
metadata	string		~ 2048 chars	Metadata
targetInventoryModelId	string	✓	~ 1024 chars	GRN of inventory models usable for reinforcement targets
acquireExperienceSuffix	string	✓	~ 1024 chars	Suffix to be assigned to the property ID that stores the experience value obtained from GS2-Experience
materialInventoryModelId	string	✓	~ 1024 chars	GRN of item sets (quantity of items held per expiration date) that will be used as materials for enhancement.
acquireExperienceHierarchy	List<string>		0 ~ 10 items	Hierarchical structure of JSON data defining acquisition experience values to be stored in ItemModel metadata GS2-Enhance features a mechanism that works in conjunction with GS2-Inventory to perform enhancements. It sets the experience value when used as enhancement material in JSON format within the ItemModel metadata. For example, to define metadata with a structure like: { “aaa”: { “bbb”: { “experienceValue”: 100 } } } Specify it as: [ “aaa”, ‘bbb’, “experienceValue” ] Details are explained in the Microservices Introduction / GS2-Enhance section.
experienceModelId	string	✓	~ 1024 chars	Experience Model GRN
bonusRates	List<BonusRate>		0 ~ 1000 items	Experience gain bonus

BonusRate

Experience gain bonus

	Type	Condition	Required	Default	Value Limits	Description
rate	float		✓	1.0	0 ~ 10000	Experience bonus multiplier (1.0 = no bonus)
weight	int		✓	1	0 ~ 2147483645	lottery weight

UnleashRateModel

Unleash Rates

The limit breakthrough rate is the data that defines the limit breakthrough target and the GS2-Grade limit breakthrough model. The data for the limit breakthrough must be managed in GS2-Inventory.

	Type	Required	Value Limits	Description
unleashRateModelId	string	✓	~ 1024 chars	Unleash Rate Model GRN
name	string	✓	~ 128 chars	Unleash rate name
description	string		~ 1024 chars	Description
metadata	string		~ 2048 chars	Metadata
targetInventoryModelId	string	✓	~ 1024 chars	Inventory available for unleash targets
gradeModelId	string	✓	~ 1024 chars	Grade model
gradeEntries	List<UnleashRateEntryModel>	✓	1 ~ 1000 items	List of Grade Entry

UnleashRateEntryModel

Unleash rate entry model

	Type	Condition	Required	Default	Value Limits	Description
gradeValue	long		✓		1 ~ 1000	Target grade
needCount	int		✓		1 ~ 1000	How many items of the same type to consume