> For the complete documentation index, see [llms.txt](/llms.txt)

# GS2-Enhance Deploy/CDK リファレンス

GS2-Deployのスタックを作成する際に使用するテンプレートのフォーマットと、CDKによる各種言語のテンプレート出力の実装例




## エンティティ

Deploy処理で操作の対象となるリソース

### Namespace

ネームスペース<br>

ネームスペースは、一つのプロジェクト内で同じサービスを異なる用途で複数利用するためのエンティティです。<br>
GS2 の各サービスはネームスペース単位で管理されます。ネームスペースが異なれば、同じサービスでも完全に独立したデータ空間として扱われます。<br>

そのため、各サービスの利用を開始するにあたってネームスペースを作成する必要があります。

#### Request

リソースの生成・更新リクエスト

|  | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- | --- |
| name | string |  | ✓|  |  ~ 128文字 | ネームスペース名<br>ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 |
| description | string |  | |  |  ~ 1024文字 | 説明文 |
| transactionSettingV2 | [TransactionSettingV2](#transactionsettingv2) |  | |  |  | トランザクション設定（V2）<br>このネームスペースが発行するトランザクションをどのように実行するかを決める設定です。設定する項目は、実行に使用する GS2-Distributor のネームスペースと、トランザクションに含まれるアクションを 1 件ずつ実行して先に実行されたアクションの結果を後続のアクションから使えるようにするか、まとめて同時に実行してレスポンスタイムを短くするか、の 2 つだけです。<br>新しく作成するネームスペースではこちらを設定してください。これに置き換えられて非推奨となった `transactionSetting` は、こちらが設定されていない間だけ使用されます。 |
| enhanceScript | [ScriptSetting](#scriptsetting) |  | |  |  | 強化時に実行するスクリプトの設定<br>Script トリガーリファレンス - [`enhance`](../script/#enhance) |
| logSetting | [LogSetting](#logsetting) |  | |  |  | ログの出力設定<br>強化操作のログデータを GS2-Log に出力するための設定です。GS2-Log のネームスペースを指定することで、強化および限界突破操作の API リクエスト・レスポンスログを収集できます。 |

#### GetAttr

[!GetAttr](/articles/tech/deploy/#getattr)タグで取得可能なリソースの生成結果

| | 型 | 説明 |
| --- | --- | --- |
| Item | [Namespace](../sdk#namespace) | 作成したネームスペース

#### 実装例




**GS2-Deploy(YAML)**
```yaml

Type: GS2::Enhance::Namespace
Properties:
  Name: namespace-0001
  Description: null
  TransactionSettingV2: null
  EnhanceScript: null
  LogSetting: 
    LoggingNamespaceId: grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001

```

**Go**
```go

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


SampleStack := core.NewStack()
enhance.NewNamespace(
    &SampleStack,
    "namespace-0001",
    enhance.NamespaceOptions{
        LogSetting: &core.LogSetting{
            LoggingNamespaceId: "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001",
        },
    },
)

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

```

**PHP**
```php

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(
                logSetting: new \Gs2Cdk\Core\Model\LogSetting(
                    loggingNamespaceId: "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
                )
            )
        );
    }
}

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

```

**Java**
```java

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()
                        .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

```

**C#**
```csharp

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
            {
                logSetting = new Gs2Cdk.Core.Model.LogSetting(
                    loggingNamespaceId: "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
                )
            }
        );
    }
}

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

```

**TypeScript**
```typescript

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",
            {
                logSetting: new core.LogSetting(
                    "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
                )
            }
        );
    }
}

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

```

**Python**
```python

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(
                log_setting=core.LogSetting(
                    logging_namespace_id='grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001',
                ),
            ),
        )

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

```


### TransactionSettingV2

トランザクション設定（V2）<br>

トランザクション設定（V2）は、ネームスペースが発行するトランザクションをどのように実行するかを決める設定です。<br>

設定する項目は次の 2 つだけです。<br>

- `distributorNamespaceId`: トランザクションの実行に使用する GS2-Distributor のネームスペース<br>
- `enableParallelExecution`: トランザクションに含まれるアクションを 1 件ずつ実行するか、まとめて同時に実行するか<br>

どちらを選んでも、トランザクションは発行された時点でサーバーが実行し、成否はトランザクション全体でひとつになります。あるアクションが失敗した場合は、それまでに実行されたアクションもろとも取り消され、1 つも反映されません。トランザクションの実行方法に関するそれ以外の項目は推奨構成に固定されているため、設定する必要はありません。<br>

1 件ずつ実行する場合（既定 / `enableParallelExecution` が `false`）、各アクションは先に実行されたアクションの書き込みを踏まえて動作します。アクションは verify・consume・acquire の順に実行され、次のことができます。<br>

- 1 つのトランザクションの中で、同じ行を複数のアクションから更新する（まとめて同時に実行する場合は失敗します）<br>
- 先に実行されたアクションの書き込みを読む。List や Query の結果でも、入れ子になったトランザクションの内側でも読めます<br>
- `%{Gs2Xxx:ActionName.path[0].field}` を使って、先に実行された verify や consume アクションの結果を、後続の verify・consume・acquire アクションの引数として渡す<br>

代わりに、レスポンスタイムは各アクションの実行時間の合計になり、1 つのトランザクションに含められるアクションは最大 20 件になります。また、各フェーズの中での実行順はアクション名、次に対象リソースの順で決まるため、リクエストに並べた順序で実行順を指定することはできません。実行は最初に失敗したアクションで停止します。<br>

まとめて同時に実行する場合（`enableParallelExecution` が `true`）、アクションは同一のデータスナップショットに対して並列に実行されるため、レスポンスタイムは最も遅いアクション 1 件分で済み、アクション数の上限もありません。<br>

代わりに、あるアクションから他のアクションの書き込みを読むことはできず、同じ行を 2 つのアクションが書き換えるとトランザクションは `database:transaction:same.resource`（400）で失敗します。同一トランザクション内で同じデータを 2 つ以上のアクションが書き換えないことを保証できる場合にだけ選択してください。`%{...}` は先行するフェーズ（verify → consume → acquire の順）の結果だけを参照でき、同じフェーズ内のアクションへの参照は解決されずにそのまま残ります。`%{...}` を含むフェーズは先行するフェーズの完了を待ってから実行されるため、その分だけレスポンスタイムが伸びます。<br>

トランザクション設定は、トランザクション設定（V2）に置き換えられた非推奨の設定で、トランザクション設定（V2）が存在しなかった頃に作成されたネームスペースのために残されています。トランザクション設定（V2）が設定されていない間だけ適用され、トランザクション設定（V2）を設定するとそちらが優先されます。トランザクション設定で可能だった、トランザクションをクライアント実行のスタンプシートとして実行する・GS2-Distributor による AutoRun の非同期実行を行う・入手アクションを GS2-JobQueue に畳み込む、という 3 つの挙動は、こちらではあえて提供していません。

|  | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- | --- |
| distributorNamespaceId | string |  |  | "grn:gs2:{region}:{ownerId}:distributor:default" |  ~ 1024文字 | トランザクションの実行に使用する GS2-Distributor ネームスペースGRN |
| enableParallelExecution | bool |  |  | false |  | アクションを直列ではなく並列に実行するか |

### ScriptSetting

スクリプト設定<br>

GS2 ではマイクロサービスのイベントに関連づけて、カスタムスクリプトを実行することができます。<br>
このモデルは、スクリプトの実行をトリガーするための設定を保持します。<br>

スクリプトの実行方式は大きく2種類あり、それは「同期実行」と「非同期実行」です。<br>
同期実行は、スクリプトの実行が完了するまで処理がブロックされます。<br>
代わりに、スクリプトの実行結果を使って API の実行を止めたり、API のレスポンス内容を制御することができます。<br>

一方、非同期実行ではスクリプトの完了を待つために処理がブロックされることはありません。<br>
ただし、スクリプトの実行結果を利用して API の実行を停止したり、API の応答内容を変更することはできません。<br>
非同期実行は API の応答フローに影響を与えないため、原則として非同期実行を推奨します。<br>

非同期実行には実行方式が2種類あり、GS2-Script と Amazon EventBridge があります。<br>
Amazon EventBridge を使用することで、Lua 以外の言語で処理を記述することができます。

|  | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- | --- |
| triggerScriptId | string |  |  |  |  ~ 1024文字 | API 実行時に同期的に実行される GS2-Script のスクリプトGRN<br>「grn:gs2:」ではじまる GRN 形式のIDで指定する必要があります。 |
| doneTriggerTargetType | 文字列列挙型<br>enum {<br>"none",<br>"gs2_script",<br>"aws"<br>}<br> |  |  | "none" |  | 非同期スクリプトの実行方法<br>非同期実行で使用するスクリプトの種類を指定します。<br>「非同期実行のスクリプトを使用しない(none)」「GS2-Scriptを使用する(gs2_script)」「Amazon EventBridgeを使用する(aws)」が選択できます。none: なし / gs2_script: GS2-Script / aws: Amazon EventBridge /  |
| doneTriggerScriptId | string | {doneTriggerTargetType} == "gs2_script" |  |  |  ~ 1024文字 | 非同期実行する GS2-Script スクリプトGRN<br>「grn:gs2:」ではじまる GRN 形式のIDで指定する必要があります。<br>※ doneTriggerTargetType が "gs2_script" であれば 有効 |
| doneTriggerQueueNamespaceId | string | {doneTriggerTargetType} == "gs2_script" |  |  |  ~ 1024文字 | 非同期実行スクリプトを実行する GS2-JobQueue ネームスペースGRN<br>非同期実行スクリプトを直接実行するのではなく、GS2-JobQueue を経由する場合は GS2-JobQueue のネームスペースGRN を指定します。<br>GS2-JobQueue を利用する理由は多くはありませんので、特に理由がなければ指定する必要はありません。<br>※ doneTriggerTargetType が "gs2_script" であれば 有効 |

### LogSetting

ログの出力設定<br>

ログデータの出力設定を管理します。この型は、ログデータを書き出すために使用される GS2-Log ネームスペースの識別子（Namespace ID）を保持します。<br>
ログネームスペースID(loggingNamespaceId)には、ログデータを収集し保存する GS2-Log のネームスペースを、GRNの形式で指定します。<br>
この設定をすることで、設定されたネームスペース内で発生したAPIリクエスト・レスポンスのログデータが、対象の GS2-Log ネームスペース側へ出力されるようになります。<br>
GS2-Log ではリアルタイムでログが提供され、システムの監視や分析、デバッグなどに利用できます。

|  | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- | --- |
| loggingNamespaceId | string |  | ✓ |  |  ~ 1024文字 | ログを出力する GS2-Log のネームスペースGRN<br>「grn:gs2:」ではじまる GRN 形式のIDで指定する必要があります。 |

### TransactionSetting

トランザクション設定<br>

トランザクション設定は非推奨です。トランザクション設定（V2）がこれに置き換わります。トランザクション設定（V2）が存在しなかった頃に作成されたネームスペースのために残されており、トランザクション設定（V2）が設定されていない間だけ適用されます。新しく作成するネームスペースでは使用しないでください。<br>

この設定は、トランザクションの実行に関わる要素――自動実行（AutoRun）、アトミック実行（AtomicCommit）、GS2-Distributor を利用した非同期実行、スクリプト結果の一括適用、GS2-JobQueue による入手アクションの非同期化、直列実行――をそれぞれ個別の項目として公開しているため、推奨構成以外の組み合わせも作れます。その推奨構成を 1 つの設定としてまとめたものがトランザクション設定（V2）です。トランザクション設定を使い続けるのは、トランザクション設定（V2）が提供しない挙動――トランザクションをクライアント実行のスタンプシートとして実行する、GS2-Distributor による AutoRun の非同期実行を行う、入手アクションを GS2-JobQueue に畳み込む――にすでに依存しているネームスペースに限ってください。

|  | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- | --- |
| enableAutoRun | bool |  |  | false |  | 発行したトランザクションをサーバーサイドで自動的に実行するか |
| enableAtomicCommit | bool | {enableAutoRun} == true |  | false |  | トランザクションの実行をアトミックにコミットするか<br>※ enableAutoRun が true であれば 有効 |
| transactionUseDistributor | bool | {enableAtomicCommit} == true |  | false |  | トランザクションを非同期処理で実行する<br>※ enableAtomicCommit が true であれば 有効 |
| commitScriptResultInUseDistributor | bool | {transactionUseDistributor} == true |  | false |  | スクリプトの結果コミット処理を非同期処理で実行するか<br>※ transactionUseDistributor が true であれば 有効 |
| acquireActionUseJobQueue | bool | {enableAtomicCommit} == true |  | false |  | 入手アクションを実行する際に GS2-JobQueue を使用するか<br>※ enableAtomicCommit が true であれば 有効 |
| enableSequentialExecution | bool | {enableAtomicCommit} == true |  | false |  | アトミックコミットのアクションを直列に実行し、同じ行を複数のアクションで更新できるようにするか<br>※ enableAtomicCommit が true であれば 有効 |
| distributorNamespaceId | string |  |  | "grn:gs2:{region}:{ownerId}:distributor:default" |  ~ 1024文字 | トランザクションの実行に使用する GS2-Distributor ネームスペースGRN |
| queueNamespaceId | string |  |  | "grn:gs2:{region}:{ownerId}:queue:default" |  ~ 1024文字 | トランザクションの実行に使用する GS2-JobQueue のネームスペースGRN |

---

### CurrentRateMaster

現在アクティブなレートモデルのマスターデータ<br>

現在ネームスペース内で有効な、レートモデルの定義を記述したマスターデータです。<br>
GS2ではマスターデータの管理にJSON形式のファイルを使用します。<br>
ファイルをアップロードすることで、実際にサーバーに設定を反映することができます。<br>

JSONファイルを作成する方法として、マネージメントコンソール内にマスターデータエディタを提供しています。<br>
また、よりゲームの運営に相応しいツールを作成し、適切なフォーマットのJSONファイルを書き出すことでもサービスを利用可能です。
**ℹ️ Note**

JSONファイルの形式については [GS2-Enhance マスターデータリファレンス](api_reference/enhance/master_data/) をご参照ください。

#### Request

リソースの生成・更新リクエスト

|  | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- | --- |
| namespaceName | string |  | ✓|  |  ~ 128文字 | ネームスペース名<br>ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 |
| mode | 文字列列挙型<br>enum {<br>"direct",<br>"preUpload"<br>}<br> |  | | "direct" |  | 更新モードdirect: マスターデータを直接更新 / preUpload: マスターデータをアップロードしてから更新 /  |
| settings | string | {mode} == "direct" | ✓※|  |  ~ 5242880 バイト (5MB) | マスターデータ<br>※ mode が "direct" であれば必須 |
| uploadToken | string | {mode} == "preUpload" | ✓※|  |  ~ 1024文字 | 事前アップロードで取得したトークン<br>アップロードしたマスターデータを適用するために使用されます。<br>※ mode が "preUpload" であれば必須 |

#### GetAttr

[!GetAttr](/articles/tech/deploy/#getattr)タグで取得可能なリソースの生成結果

| | 型 | 説明 |
| --- | --- | --- |
| Item | [CurrentRateMaster](../sdk#currentratemaster) | 更新された現在アクティブなレートモデルのマスターデータ

#### 実装例




**GS2-Deploy(YAML)**
```yaml

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

```

**Go**
```go

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

```

**PHP**
```php

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

```

**Java**
```java

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

```

**C#**
```csharp

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

```

**TypeScript**
```typescript

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

```

**Python**
```python

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

強化レートモデル<br>

強化レートは強化に使用する素材と強化対象を定義したデータです。<br>

素材データ、強化対象データは共に GS2-Inventory で管理されている必要があります。<br>
強化で得られる経験値は GS2-Inventory のメタデータにJSON形式で記録します。<br>
ここではメタデータのどの階層に経験値の値が格納されているかを記載する必要があります。<br>

強化時に一定の確率で `大成功` といった形で入手できる経験値量に補正値をかけることができます。<br>
その抽選確率もこのエンティティで定義します。<br>

`targetInventoryModelId` には強化対象となるアイテムを保持するインベントリモデルを、`materialInventoryModelId` には素材として使用できるアイテムを保持するインベントリモデルを指定します。<br>
両者は別のインベントリモデルにできるため、キャラクターを強化対象とし、強化専用アイテムを素材とするような構成が可能です。<br>

各素材が提供する経験値は素材アイテムのアイテムモデルのメタデータに記述し、その JSON のどこに値が入っているかを `acquireExperienceHierarchy` で指定します。<br>
`{ "aaa": { "bbb": { "experienceValue": 100 } } }` のような構造であれば `[ "aaa", "bbb", "experienceValue" ]` と指定します。階層は最大10段まで指定できます。<br>

得られた経験値は `experienceModelId` で指定した GS2-Experience の経験値モデルに加算されます。<br>
加算先のプロパティIDは、強化対象アイテムのプロパティIDに `acquireExperienceSuffix` を付与したものになります。これにより、1つのアイテムにキャラクターレベルの `level` と好感度の `like` のような複数種類の経験値を持たせられます。<br>

`bonusRates` には、獲得経験値にかける倍率の重み付き抽選を定義します。<br>
各エントリーは倍率（1.5 なら150%）と排出重みを持ち、強化を実行するたびに重み付き抽選で1つが選ばれます。エントリーは最大1,000件まで登録できます。

|  | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- | --- |
| rateModelId | string |  | ※ |  |  ~ 1024文字 | 強化レートモデルGRN<br>※ サーバーが自動で設定 |
| name | string |  | ✓ |  |  ~ 128文字 | 強化レートモデル名<br>強化レートモデル固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 |
| description | string |  |  |  |  ~ 1024文字 | 説明文 |
| metadata | string |  |  |  |  ~ 2048文字 | メタデータ<br>メタデータには任意の値を設定できます。<br>これらの値は GS2 の動作には影響しないため、ゲーム内で利用する情報の保存先として使用できます。 |
| targetInventoryModelId | string |  | ✓ |  |  ~ 1024文字 | 強化対象に使用できる GS2-Inventory インベントリモデルの GRN<br>強化対象となるアイテムを保持する GS2-Inventory のインベントリモデルを指定します。強化されるアイテムはこのインベントリモデルに属している必要があります。 |
| acquireExperienceSuffix | string |  | ✓ |  |  ~ 1024文字 | GS2-Experience で入手した経験値を格納するプロパティID に付与するサフィックス<br>アイテムのプロパティ ID の末尾に追加され、経験値が保存される GS2-Experience のプロパティ ID を構成する文字列です。同じアイテムに複数の経験値種別を持たせることができます（例: キャラクターレベルの "level"、好感度の "like"）。 |
| materialInventoryModelId | string |  | ✓ |  |  ~ 1024文字 | 強化の素材に使用できる GS2-Inventory インベントリモデル GRN<br>強化素材として使用できるアイテムを保持する GS2-Inventory のインベントリモデルを指定します。各素材が提供する経験値は、acquireExperienceHierarchy で指定された JSON 階層を使用してアイテムモデルのメタデータに定義されます。 |
| acquireExperienceHierarchy | List&lt;string&gt; |  |  |  | 0 ~ 10 items | ItemModelのメタデータに格納する、入手経験値を定義するJSONデータの階層構造の定義<br>GS2-EnhanceにはGS2-Inventoryと連携して強化を行う仕組みがあり、ItemModelのメタデータにJSON形式で、強化素材として使用した場合の経験値量を設定します。<br>例えば、{ "aaa": { "bbb": { "experienceValue": 100 } } } というような構造のデータ定義でメタデータに設定したい場合は、[ "aaa", "bbb", "experienceValue" ] のように指定します。<br>詳細は [マイクロサービス紹介 / GS2-Enhance](/microservices/enhance/#強化レート) の項で解説しています。 |
| experienceModelId | string |  | ✓ |  |  ~ 1024文字 | 強化の結果得られる GS2-Experience 経験値モデル GRN<br>強化で得られた経験値が記録される GS2-Experience の経験値モデルを指定します。経験値は、対象アイテムのプロパティ ID と acquireExperienceSuffix を組み合わせて識別されるプロパティに加算されます。 |
| bonusRates | [List&lt;BonusRate&gt;](#bonusrate) |  |  |  | 0 ~ 1000 items | 経験値獲得量ボーナス<br>強化時のボーナス経験値倍率の重み付き抽選を定義します。各エントリは倍率（例: 1.5 で 150%）と排出重みを指定します。強化実行時に重み付き抽選で1つのエントリが選択され、「大成功」ボーナスが獲得経験値に適用されるかどうかが決定されます。 |

### BonusRate

経験値獲得量ボーナス<br>

強化時の経験値ボーナス倍率を決定する重み付き抽選の単一エントリを定義します。異なる倍率と重みを持つ複数のエントリを設定することで、制御された確率による「大成功」や「超成功」の仕組みを実装できます。

|  | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- | --- |
| rate | float |  |  | 1.0 | 0 ~ 10000 | 経験値ボーナスの倍率 (1.0 = ボーナスなし)<br>このエントリが抽選された際に基本経験値に適用される倍率です。1.0 はボーナスなしの通常強化、1.5 は経験値 150%（大成功）、2.0 は経験値 200%（超成功）などを意味します。 |
| weight | int |  |  | 1 | 0 ~ 2147483645 | 抽選重み<br>ボーナスレートを選択する重み付き抽選で使用される相対的な重みです。値が大きいほど、このボーナスレートが選択される確率が高くなります。実際の確率は、この重みをボーナスレートリスト内のすべての重みの合計で割った値になります。 |

### UnleashRateModel

限界突破レートモデル<br>

アイテムの限界突破（解放）条件を定義します。<br>

ここでいう限界突破とは、同種のアイテムを素材として消費することで GS2-Grade で管理するグレードを引き上げる強化処理です。<br>
グレードが上がると GS2-Experience 側のランクキャップが引き上げられ、対象をより高いレベルまで育成できるようになります。<br>

`targetInventoryModelId` には、限界突破の対象となるアイテムを保持する GS2-Inventory のインベントリモデルを指定します。<br>
限界突破するアイテムと、素材として消費する同種アイテムの両方がこのインベントリモデルに属している必要があります。<br>
`gradeModelId` には、対象アイテムのグレードを追跡する GS2-Grade のグレードモデルを指定します。限界突破に成功すると、そのグレードが1引き上げられます。<br>

`gradeEntries` には、各グレードに到達するために消費する同種アイテムの数をグレードごとに定義します。エントリーは1件以上1,000件まで登録できます。<br>
たとえばグレード1は1個、グレード2は3個のように設定することで、限界突破の段階ごとにコストを個別に制御できます。<br>

素材として消費したリソースは、そのリソースが保持していた内容ごと失われます。<br>
素材が経験値などのリソースを持っていたとしても対象へは引き継がれないため、引き継ぎが必要な場合は事前に引き継ぎ用のリソースへ変換しておく必要があります。

|  | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- | --- |
| unleashRateModelId | string |  | ※ |  |  ~ 1024文字 | 限界突破レートモデルGRN<br>※ サーバーが自動で設定 |
| name | string |  | ✓ |  |  ~ 128文字 | 限界突破レートモデル名<br>限界突破レートモデル固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 |
| description | string |  |  |  |  ~ 1024文字 | 説明文 |
| metadata | string |  |  |  |  ~ 2048文字 | メタデータ<br>メタデータには任意の値を設定できます。<br>これらの値は GS2 の動作には影響しないため、ゲーム内で利用する情報の保存先として使用できます。 |
| targetInventoryModelId | string |  | ✓ |  |  ~ 1024文字 | 限界突破対象に使用できる GS2-Inventory インベントリモデル GRN<br>限界突破対象となるアイテムを保持する GS2-Inventory のインベントリモデルを指定します。限界突破するアイテムと素材として消費する同種アイテムの両方がこのインベントリモデルに属している必要があります。 |
| gradeModelId | string |  | ✓ |  |  ~ 1024文字 | グレードモデル GRN<br>対象アイテムの限界突破レベルを追跡する GS2-Grade のグレードモデルを指定します。限界突破が成功すると、このグレードモデル内でアイテムのグレードが加算されます。 |
| groupKeyHierarchy | List&lt;string&gt; |  |  | [] | 0 ~ 10 items | ItemModel のメタデータに格納する、グループキーを定義する JSON データの階層構造<br>グループキーは装備の部位のようにアイテムモデルを分類する値で、レシピが素材と限界突破対象を比べるときに使います。<br>{ "unleash": { "group": "weapon" } } のような構造のメタデータであれば、[ "unleash", "group" ] と指定します。<br>値は文字列である必要があります。レシピで「同じグループ」や targetGroupKeys を使う場合は必須です。 |
| gradeEntries | [List&lt;UnleashRateEntryModel&gt;](#unleashrateentrymodel) |  | ✓ |  | 1 ~ 1000 items | グレードエントリーリスト<br>限界突破の各グレードレベルに対する素材コストを定義します。各エントリはグレード値と、そのグレードに到達するために消費する必要がある同種アイテム数をマッピングします。例えば、グレード1は複製1個、グレード2は複製3個のように設定できます。 |

### UnleashRateEntryModel

限界突破レートエントリモデル<br>

限界突破の進行における単一グレードレベルの素材コストを定義します。各エントリは対象となるグレード値と、そのグレードを達成するために消費する必要がある同種アイテムの数を指定します。

|  | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- | --- |
| gradeValue | long |  | ✓ |  | 1 ~ 1000 | 対象グレード<br>このエントリがコストを定義するグレード値です。このグレードレベルへの限界突破を実行する際、needCount で指定された数のアイテムが消費されます。 |
| type | 文字列列挙型<br>enum {<br>"simple",<br>"recipe"<br>}<br> |  |  | "simple" |  | 素材条件の種類<br>「シンプル(simple)」は、限界突破対象と同じアイテムモデルの複製を needCount 個消費します。従来の挙動です。<br>「レシピ(recipe)」は、プレイヤーがレシピを1つ選び、選んだレシピで定義された素材を消費します。simple: シンプル / recipe: レシピ /  |
| needCount | int | {type} == "simple" | ✓※ |  | 1 ~ 1000 | 同種のアイテムを何個消費するか<br>対象グレードへの限界突破を実行するために消費する必要がある同種アイテムの数です。これらのアイテムは、限界突破されるアイテムと同じアイテムモデルのものです。<br>※ type が "simple" であれば 必須 |
| recipes | [List&lt;UnleashRecipe&gt;](#unleashrecipe) | {type} == "recipe" | ✓※ |  | 1 ~ 10 items | レシピリスト<br>type が「レシピ」のときに使用します。限界突破の実行時、プレイヤーはこの中からレシピを1つ選びます。<br>※ type が "recipe" であれば 必須 |

### UnleashRecipe

限界突破レシピ<br>

グレードを1段引き上げる方法の1つです。グレードエントリに複数のレシピがある場合、プレイヤーはそのうち1つを選び、選んだレシピの素材はすべて必要になります。

|  | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- | --- |
| name | string |  | ✓ |  |  ~ 128文字 | レシピ名<br>グレードエントリの中で一意な名前です。限界突破の実行時、プレイヤーはこの名前でレシピを指定します。 |
| metadata | string |  |  |  |  ~ 2048文字 | メタデータ<br>メタデータには任意の値を設定できます。<br>これらの値は GS2 の動作には影響しないため、ゲーム内で利用する情報の保存先として使用できます。 |
| targetGroupKeys | List&lt;string&gt; |  |  | [] | 0 ~ 10 items | このレシピを使える限界突破対象のグループキー<br>空の場合は、どの限界突破対象にも使えます。<br>値がある場合は、限界突破対象のアイテムモデルのグループキーが含まれるときだけ使えます。グループキーは限界突破レートモデルの groupKeyHierarchy を使ってアイテムモデルのメタデータから読み取ります。 |
| materials | [List&lt;UnleashMaterial&gt;](#unleashmaterial) |  | ✓ |  | 1 ~ 10 items | このレシピが必要とする素材<br>このレシピを使うと、すべての素材が消費されます。 |

### UnleashMaterial

限界突破素材<br>

レシピが必要とする素材の1種類を定義します。<br>
「個体(individual)」は、装備の複製のように、プレイヤーが選んだアイテムセットを消費します。<br>
「数量(quantity)」は、汎用強化素材のように、設定で決まるアイテムを数量で消費します。

|  | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- | --- |
| name | string |  | ✓ |  |  ~ 128文字 | 素材名<br>レシピの中で一意な名前です。限界突破の実行時、プレイヤーは個体素材ごとにこの名前でアイテムセットを指定します。 |
| materialType | 文字列列挙型<br>enum {<br>"individual",<br>"quantity"<br>}<br> |  | ✓ |  |  | 素材の種類<br>「個体(individual)」は、プレイヤーが選んだアイテムセットを消費します。<br>「数量(quantity)」は、設定で決まるアイテムを数量で消費します。individual: 個体 / quantity: 数量 /  |
| individualSetting | [UnleashIndividualMaterialSetting](#unleashindividualmaterialsetting) | {materialType} == "individual" | ✓※ |  |  | 個体素材設定<br>materialType が「個体」のときに使用します。<br>※ materialType が "individual" であれば 必須 |
| quantitySetting | [UnleashQuantityMaterialSetting](#unleashquantitymaterialsetting) | {materialType} == "quantity" | ✓※ |  |  | 数量素材設定<br>materialType が「数量」のときに使用します。<br>※ materialType が "quantity" であれば 必須 |

### UnleashIndividualMaterialSetting

個体素材設定<br>

装備の複製のように、アイテムセットを個体として消費する素材を定義します。<br>
どのアイテムセットを消費するかはプレイヤーが選び、選ばれたアイテムセットは限界突破対象のアイテムと同じインベントリモデルに属している必要があります。<br>
個体ごとに GS2-Grade のグレードを持てるため、素材のグレードを条件にすることもできます。

|  | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- | --- |
| matchType | 文字列列挙型<br>enum {<br>"sameItem",<br>"sameGroup"<br>}<br> |  | ✓ |  |  | 素材と限界突破対象の一致条件<br>「同じアイテム(sameItem)」は、限界突破対象と同じアイテムモデルのアイテムセットだけを受け付けます。<br>「同じグループ(sameGroup)」は、アイテムモデルのグループキーが限界突破対象のアイテムモデルと同じアイテムセットを受け付けます。グループキーは限界突破レートモデルの groupKeyHierarchy を使ってアイテムモデルのメタデータから読み取ります。sameItem: 同じアイテム / sameGroup: 同じグループ /  |
| gradeCondition | 文字列列挙型<br>enum {<br>"any",<br>"sameAsTarget",<br>"equal"<br>}<br> |  |  | "any" |  | 素材のグレード条件<br>「問わない(any)」は素材のグレードを確認しません。<br>「限界突破対象と同じ(sameAsTarget)」は、素材のグレードが限界突破対象の現在のグレードと同じであることを求めます。<br>「指定値と一致(equal)」は、素材のグレードが gradeValue で指定した値であることを求めます。<br>グレードは限界突破レートモデルのグレードモデルを使い、トランザクションの中で GS2-Grade により検証されます。any: 問わない / sameAsTarget: 限界突破対象と同じ / equal: 指定値と一致 /  |
| gradeValue | long | {gradeCondition} == "equal" | ✓※ |  | 0 ~ 1000 | 素材に求めるグレード<br>gradeCondition が「指定値と一致」のときに使用します。<br>※ gradeCondition が "equal" であれば 必須 |
| count | int |  | ✓ |  | 1 ~ 1000 | 消費するアイテムセットの数<br>この素材としてプレイヤーが指定する必要があるアイテムセットの数です。各アイテムセットは1個ずつ消費されます。 |

### UnleashQuantityMaterialSetting

数量素材設定<br>

汎用強化素材のように、数量で消費する素材を定義します。<br>
プレイヤーはアイテムを選ばず、消費するアイテムモデルはこの設定で決まり、指定した数量が消費されます。<br>
GS2-Inventory の通常のインベントリとシンプルインベントリの両方を使用できます。

|  | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- | --- |
| matchType | 文字列列挙型<br>enum {<br>"sameGroup",<br>"specified"<br>}<br> |  | ✓ |  |  | 消費するアイテムモデルの決め方<br>「同じグループ(sameGroup)」は、materialInventoryModelId のインベントリの中で、グループキーが限界突破対象のアイテムモデルと同じアイテムモデルを消費します。該当するアイテムモデルはちょうど1つである必要があります。<br>「指定(specified)」は、itemModelId で指定したアイテムモデルを消費します。sameGroup: 同じグループ / specified: 指定 /  |
| materialInventoryModelId | string | {matchType} == "sameGroup" | ✓※ |  |  ~ 1024文字 | 素材を探す GS2-Inventory インベントリモデル GRN<br>matchType が「同じグループ」のときに使用します。シンプルインベントリモデルの GRN も指定できます。<br>※ matchType が "sameGroup" であれば 必須 |
| itemModelId | string | {matchType} == "specified" | ✓※ |  |  ~ 1024文字 | 消費する GS2-Inventory アイテムモデル GRN<br>matchType が「指定」のときに使用します。シンプルアイテムモデルの GRN も指定できます。<br>※ matchType が "specified" であれば 必須 |
| count | int |  | ✓ |  | 1 ~ 2147483645 | 消費する数量 |

---