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

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

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




## エンティティ

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

### Namespace

ネームスペース<br>

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

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

#### Request

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

|  | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- | --- |
| name | string |  | ✓|  |  ~ 128文字 | ネームスペース名<br/>ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 |
| description | string |  | |  |  ~ 1024文字 | 説明文 |
| transactionSetting | [TransactionSetting](#transactionsetting) |  | |  |  | トランザクション設定<br/>マネー操作時のトランザクションの処理方法を制御する設定です。 |
| priority | 文字列列挙型<br>enum {<br>&nbsp;&nbsp;"free",<br>&nbsp;&nbsp;"paid"<br>}<br> |  | ✓|  |  | 消費優先度<br/>ウォレットから通貨を消費する際に、有償通貨と無償通貨のどちらを先に消費するかを決定します。<br/>"free" に設定すると、無償通貨（単価=0）が先に消費され、次に単価の高い有償通貨が消費されます。<br/>"paid" に設定すると、単価の高い有償通貨が先に消費され、次に無償通貨が消費されます。"free": 無償通貨を優先して使用する / "paid": 有償通貨を優先して使用する /  |
| shareFree | bool |  | ✓|  |  | 無償通貨の共有<br/>無償通貨をすべてのウォレットスロット間で共有するかどうか。<br/>有効にすると、無償通貨の残高がスロット0から他のすべてのスロットに同期され、異なるプラットフォームのプレイヤーが同じ無償通貨プールを共有できます。<br/>有償通貨はこの設定に関係なく、常にスロットごとに別々に管理されます。 |
| currency | 文字列列挙型<br>enum {<br>&nbsp;&nbsp;"JPY",<br>&nbsp;&nbsp;"USD",<br>&nbsp;&nbsp;"TWD"<br>}<br> |  | ✓|  |  | 通貨の種類<br/>価格設定と資金決済法の遵守計算に使用される実世界の通貨。<br/>有償通貨の価値追跡と返金義務の計算における測定単位を決定します。<br/>ネームスペース作成後は変更できません。"JPY": 日本円 / "USD": 米ドル / "TWD": 台湾ドル /  |
| appleKey | string |  | |  |  ~ 1024文字 | Apple App Store のバンドルID<br/>Apple App Store の購入レシートを検証するために使用される iOS アプリの Bundle ID。<br/>iOS デバイスからのアプリ内購入を受け付ける場合に必要です。 |
| googleKey | string |  | |  |  ~ 5120文字 | Google PlayStore の秘密鍵<br/>Google Play の購入レシートを検証するために使用されるサービスアカウントの秘密鍵。<br/>Android デバイスからのアプリ内購入を受け付ける場合に必要です。 |
| enableFakeReceipt | bool |  | | false |  | フェイクレシートの有効化<br/>テスト目的で Unity Editor が生成するフェイク購入レシートを受け付けるかどうか。<br/>開発・テスト環境でのみ有効にし、不正な通貨付与を防ぐため本番環境では必ず無効にする必要があります。<br/>デフォルトは false です。 |
| createWalletScript | [ScriptSetting](#scriptsetting) |  | |  |  | ウォレット作成時スクリプト<br/>新しいウォレットが初めて作成されたときに実行するスクリプト。<br/>ウォレットは初回アクセス時に自動作成されるため、プレイヤーが通貨システムに初めてアクセスした際にこのスクリプトがトリガーされます。 |
| depositScript | [ScriptSetting](#scriptsetting) |  | |  |  | 残高加算時スクリプト<br/>ウォレットに通貨が加算されたときに実行するスクリプト。<br/>有償通貨の加算（ストア購入）と無償通貨の付与の両方でトリガーされます。 |
| withdrawScript | [ScriptSetting](#scriptsetting) |  | |  |  | 残高消費時スクリプト<br/>ウォレットから通貨が消費されたときに実行するスクリプト。<br/>消費優先度の設定に従って有償通貨または無償通貨が差し引かれる際にトリガーされます。 |
| logSetting | [LogSetting](#logsetting) |  | |  |  | ログの出力設定<br/>APIリクエスト・レスポンスのログを GS2-Log に出力するための設定。<br/>設定すると、ウォレット操作（入金、消費、購入）がモニタリング、監査、分析のためにログ出力されます。 |

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

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

#### 実装例




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

Type: GS2::Money::Namespace
Properties:
  Name: namespace-0001
  Description: null
  TransactionSetting: null
  Priority: paid
  ShareFree: false
  Currency: USD
  AppleKey: null
  GoogleKey: null
  EnableFakeReceipt: null
  CreateWalletScript: null
  DepositScript: null
  WithdrawScript: 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/money"
)


SampleStack := core.NewStack()
money.NewNamespace(
    &SampleStack,
    "namespace-0001",
    money.NamespacePriorityPaid,
    false,
    money.NamespaceCurrencyUsd,
    money.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\Money\Model\Namespace_(
            stack: $this,
            name: "namespace-0001",
            priority: \Gs2Cdk\Money\Model\Enums\NamespacePriority::PAID,
            shareFree: false,
            currency: \Gs2Cdk\Money\Model\Enums\NamespaceCurrency::USD,
            options: new \Gs2Cdk\Money\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.money.model.Namespace(
                this,
                "namespace-0001",
                io.gs2.cdk.money.model.enums.NamespacePriority.PAID,
                false,
                io.gs2.cdk.money.model.enums.NamespaceCurrency.USD,
                new io.gs2.cdk.money.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.Gs2Money.Model.Namespace(
            stack: this,
            name: "namespace-0001",
            priority: Gs2Cdk.Gs2Money.Model.Enums.NamespacePriority.Paid,
            shareFree: false,
            currency: Gs2Cdk.Gs2Money.Model.Enums.NamespaceCurrency.Usd,
            options: new Gs2Cdk.Gs2Money.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 money from "@/gs2cdk/money";

class SampleStack extends core.Stack
{
    public constructor() {
        super();
        new money.model.Namespace(
            this,
            "namespace-0001",
            money.model.NamespacePriority.PAID,
            false,
            money.model.NamespaceCurrency.USD,
            {
                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, money

class SampleStack(Stack):

    def __init__(self):
        super().__init__()
        money.Namespace(
            stack=self,
            name='namespace-0001',
            priority=money.NamespacePriority.PAID,
            share_free=False,
            currency=money.NamespaceCurrency.USD,
            options=money.NamespaceOptions(
                log_setting=core.LogSetting(
                    logging_namespace_id='grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001',
                ),
            ),
        )

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

```




#### TransactionSetting

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

トランザクション設定は、トランザクションの実行方法・整合性・非同期処理・競合回避の仕組みを制御する設定です。<br>
自動実行（AutoRun）、アトミック実行（AtomicCommit）、GS2-Distributor を利用した非同期実行、スクリプト結果の一括適用、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 であれば 有効 |
| distributorNamespaceId | string |  |  | "grn:gs2:{region}:{ownerId}:distributor:default" |  ~ 1024文字 | トランザクションの実行に使用する GS2-Distributor ネームスペースGRN |
| queueNamespaceId | string |  |  | "grn:gs2:{region}:{ownerId}:queue:default" |  ~ 1024文字 | トランザクションの実行に使用する GS2-JobQueue のネームスペースGRN |

#### 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>&nbsp;&nbsp;"none",<br>&nbsp;&nbsp;"gs2_script",<br>&nbsp;&nbsp;"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で指定する必要があります。 |

---