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

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

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




## エンティティ

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

### Namespace

ネームスペース<br>

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

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

#### Request

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

|  | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- | --- |
| name | string |  | ✓|  |  ~ 128文字 | ネームスペース名<br>ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 |
| description | string |  | |  |  ~ 1024文字 | 説明文 |
| isAutomaticDeletingEnabled | bool |  | | false |  | 自動削除<br>有効にすると、メッセージが開封（既読）された後にユーザーのメッセージ一覧から自動的に削除されます。クライアントからの明示的な削除操作なしに受け取り済みメッセージを削除し、受信ボックスを整理します。無効の場合、開封済みメッセージは手動で削除されるまで一覧に残ります。 |
| transactionSetting | [TransactionSetting](#transactionsetting) |  | |  |  | トランザクション設定<br>メッセージに添付された報酬を付与する際に使用される分散トランザクション処理の設定です。readAcquireActions を持つメッセージが開封されると、入手アクションが生成・実行されて報酬が配布されます。自動実行、アトミックコミット、非同期処理をサポートします。 |
| receiveMessageScript | [ScriptSetting](#scriptsetting) |  | |  |  | メッセージを受信したときに実行するスクリプトの設定<br>Script トリガーリファレンス - [`receiveMessage`](../script/#receivemessage) |
| readMessageScript | [ScriptSetting](#scriptsetting) |  | |  |  | メッセージを開封したときに実行するスクリプトの設定<br>Script トリガーリファレンス - [`readMessage`](../script/#readmessage) |
| deleteMessageScript | [ScriptSetting](#scriptsetting) |  | |  |  | メッセージを削除したときに実行するスクリプトの設定<br>Script トリガーリファレンス - [`deleteMessage`](../script/#deletemessage) |
| receiveNotification | [NotificationSetting](#notificationsetting) |  | |  |  | 受信通知<br>ユーザーの受信ボックスに新しいメッセージが配信されたときにトリガーされるプッシュ通知設定です。GS2-Gatewayを使用してゲームクライアントにリアルタイム通知を送信し、ポーリングなしで新着メッセージインジケーターの表示や受信ボックスの更新をUIで行えるようにします。 |
| logSetting | [LogSetting](#logsetting) |  | |  |  | ログの出力設定<br>メッセージ操作に関連するAPIリクエストおよびレスポンスログを出力するためのGS2-Logネームスペースを指定します。監査やデバッグ目的でメッセージの配信、開封、報酬受け取り、削除を追跡するのに役立ちます。 |

#### GetAttr

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

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

#### 実装例




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

Type: GS2::Inbox::Namespace
Properties:
  Name: namespace-0001
  Description: null
  IsAutomaticDeletingEnabled: null
  TransactionSetting: 
    EnableAutoRun: true
    QueueNamespaceId: grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001
  ReceiveMessageScript: null
  ReadMessageScript: null
  DeleteMessageScript: null
  ReceiveNotification: 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/inbox"
    "github.com/openlyinc/pointy"
)


SampleStack := core.NewStack()
inbox.NewNamespace(
    &SampleStack,
    "namespace-0001",
    inbox.NamespaceOptions{
        TransactionSetting: &core.TransactionSetting{
            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

```

**PHP**
```php

class SampleStack extends \Gs2Cdk\Core\Model\Stack
{
    function __construct() {
        parent::__construct();
        new \Gs2Cdk\Inbox\Model\Namespace_(
            stack: $this,
            name: "namespace-0001",
            options: new \Gs2Cdk\Inbox\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

```

**Java**
```java

class SampleStack extends io.gs2.cdk.core.model.Stack
{
    public SampleStack() {
        super();
        new io.gs2.cdk.inbox.model.Namespace(
                this,
                "namespace-0001",
                new io.gs2.cdk.inbox.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

```

**C#**
```csharp

public class SampleStack : Gs2Cdk.Core.Model.Stack
{
    public SampleStack() {
        new Gs2Cdk.Gs2Inbox.Model.Namespace(
            stack: this,
            name: "namespace-0001",
            options: new Gs2Cdk.Gs2Inbox.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

```

**TypeScript**
```typescript

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

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

```

**Python**
```python

from gs2_cdk import Stack, core, inbox

class SampleStack(Stack):

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

```


#### 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" であれば 有効 |

#### NotificationSetting

プッシュ通知に関する設定<br>

GS2 のマイクロサービス内で何らかのイベントが発生した際に、プッシュ通知を送信するための設定です。<br>
ここでいうプッシュ通知は GS2-Gateway の提供する WebSocket インターフェースを経由した処理であり、スマートフォンのプッシュ通知とは性質が異なります。<br>
たとえば、マッチメイキングが完了した時やフレンドリクエストが届いた時など、ゲームクライアントの操作とは関係なく状態が変化した際に GS2-Gateway を経由してプッシュ通知をすることで、ゲームクライアントは状態の変化を検知することができます。<br>

GS2-Gateway のプッシュ通知は通知先のデバイスがオフラインだった時に追加の処理としてモバイルプッシュ通知を送信できます。<br>
モバイルプッシュ通知をうまく利用すれば、マッチメイキング中にゲームを終了しても、モバイルプッシュ通知を使用してプレイヤーに通知し、ゲームに戻ってくるフローを実現できる可能性があります。

|  | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- | --- |
| gatewayNamespaceId | string |  |  | "grn:gs2:{region}:{ownerId}:gateway:default" |  ~ 1024文字 | プッシュ通知に使用する GS2-Gateway のネームスペース<br>「grn:gs2:」から始まる GRN 形式で GS2-Gateway のネームスペースIDを指定します。 |
| enableTransferMobileNotification | bool? |  |  | false |  | モバイルプッシュ通知へ転送するか<br>この通知を送信しようとした時、通知先のデバイスがオフラインだった場合、モバイルプッシュ通知へ転送するかどうかを指定します。 |
| sound | string | {enableTransferMobileNotification} == true |  |  |  ~ 1024文字 | モバイルプッシュ通知で使用するサウンドファイル名<br>ここで指定したサウンドファイル名は、モバイルプッシュ通知を送信する際に使用され、特別なサウンドで通知を出すことができます。<br>※ enableTransferMobileNotification が true であれば 有効 |
| enable | 文字列列挙型<br>enum {<br>&nbsp;&nbsp;"Enabled",<br>&nbsp;&nbsp;"Disabled"<br>}<br> |  |  | "Enabled" |  | プッシュ通知を有効にするか"Enabled": 有効 / "Disabled": 無効 /  |

#### 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で指定する必要があります。 |

---

### CurrentMessageMaster

現在アクティブなグローバルメッセージのマスターデータ<br>

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

JSONファイルを作成する方法として、マネージメントコンソール内にマスターデータエディタを提供しています。<br>
また、よりゲームの運営に相応しいツールを作成し、適切なフォーマットのJSONファイルを書き出すことでもサービスを利用可能です。
{{% alert title="Note" color="info" %}}
JSONファイルの形式については [GS2-Inbox マスターデータリファレンス](api_reference/inbox/master_data/) をご参照ください。
{{% /alert %}}

#### Request

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

|  | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- | --- |
| namespaceName | string |  | ✓|  |  ~ 128文字 | ネームスペース名<br>ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 |
| mode | 文字列列挙型<br>enum {<br>&nbsp;&nbsp;"direct",<br>&nbsp;&nbsp;"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 | [CurrentMessageMaster](../sdk#currentmessagemaster) | 更新された現在アクティブなグローバルメッセージのマスターデータ

#### 実装例




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

Type: GS2::Inbox::CurrentMessageMaster
Properties:
  NamespaceName: namespace-0001
  Mode: direct
  Settings: {
    "version": "2020-03-12",
    "globalMessages": [
      {
        "name": "message-0001",
        "metadata": "hoge"
      },
      {
        "name": "message-0002",
        "metadata": "fuga",
        "readAcquireActions": [
          {
            "action": "Gs2Inventory:AcquireItemSetByUserId",
            "request": {
              "namespaceName": "namespace-0001",
              "inventoryName": "inventory-0001",
              "itemName": "item-0001",
              "acquireCount": 1,
              "expiresAt": 0,
              "createNewItemSet": false,
              "itemSetName": "",
              "userId": "#{userId}"
            }
          }
        ],
        "expiresTimeSpan":
          {
            "days": 1,
            "hours": 2,
            "minutes": 3
          }
      },
      {
        "name": "message-0003",
        "metadata": "piyo"
      }
    ]
  }
  UploadToken: null

```

**Go**
```go

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


SampleStack := core.NewStack()
inbox.NewNamespace(
    &SampleStack,
    "namespace-0001",
    inbox.NamespaceOptions{},
).MasterData(
    []inbox.GlobalMessage{
        inbox.NewGlobalMessage(
            "message-0001",
            "hoge",
            inbox.GlobalMessageOptions{
            },
        ),
        inbox.NewGlobalMessage(
            "message-0002",
            "fuga",
            inbox.GlobalMessageOptions{
                ReadAcquireActions: []core.AcquireAction{
                    inventory.AcquireItemSetByUserId(
                        "namespace-0001",
                        "inventory-0001",
                        "item-0001",
                        1,
                        pointy.Int64(0),
                        pointy.Bool(false),
                        pointy.String(""),
                    ),
                },
                ExpiresTimeSpan: &inbox.TimeSpan{
                    Days: 1,
                    Hours: 2,
                    Minutes: 3,
                },
            },
        ),
        inbox.NewGlobalMessage(
            "message-0003",
            "piyo",
            inbox.GlobalMessageOptions{
            },
        ),
    },
)

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

```

**PHP**
```php

class SampleStack extends \Gs2Cdk\Core\Model\Stack
{
    function __construct() {
        parent::__construct();
        (new \Gs2Cdk\Inbox\Model\Namespace_(
            stack: $this,
            name: "namespace-0001"
        ))->masterData(
            [
                new \Gs2Cdk\Inbox\Model\GlobalMessage(
                    name:"message-0001",
                    metadata:"hoge"
                ),
                new \Gs2Cdk\Inbox\Model\GlobalMessage(
                    name:"message-0002",
                    metadata:"fuga",
                    options: new \Gs2Cdk\Inbox\Model\Options\GlobalMessageOptions(
                        readAcquireActions:[
                            new \Gs2Cdk\Inventory\StampSheet\AcquireItemSetByUserId(
                                namespaceName: "namespace-0001",
                                inventoryName: "inventory-0001",
                                itemName: "item-0001",
                                acquireCount: 1,
                                expiresAt: 0,
                                createNewItemSet: false,
                                itemSetName: "",
                                userId: "#{userId}"
                            ),
                        ],
                        expiresTimeSpan:new \Gs2Cdk\Inbox\Model\TimeSpan(
                            days: 1,
                            hours: 2,
                            minutes: 3,
                        )
                    )
                ),
                new \Gs2Cdk\Inbox\Model\GlobalMessage(
                    name:"message-0003",
                    metadata:"piyo"
                )
            ]
        );
    }
}

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

```

**Java**
```java

class SampleStack extends io.gs2.cdk.core.model.Stack
{
    public SampleStack() {
        super();
        new io.gs2.cdk.inbox.model.Namespace(
            this,
            "namespace-0001"
        ).masterData(
            Arrays.asList(
                new io.gs2.cdk.inbox.model.GlobalMessage(
                    "message-0001",
                    "hoge"
                ),
                new io.gs2.cdk.inbox.model.GlobalMessage(
                    "message-0002",
                    "fuga",
                    new io.gs2.cdk.inbox.model.options.GlobalMessageOptions()
                        .withReadAcquireActions(Arrays.asList(
                            new io.gs2.cdk.inventory.stampSheet.AcquireItemSetByUserId(
                                "namespace-0001",
                                "inventory-0001",
                                "item-0001",
                                1L,
                                0L,
                                false,
                                "",
                                "#{userId}"
                            )
                        ))
                        .withExpiresTimeSpan(new io.gs2.cdk.inbox.model.TimeSpan(
                            1,
                            2,
                            3
                        ))
                ),
                new io.gs2.cdk.inbox.model.GlobalMessage(
                    "message-0003",
                    "piyo"
                )
            )
        );
    }
}

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

```

**C#**
```csharp

public class SampleStack : Gs2Cdk.Core.Model.Stack
{
    public SampleStack() {
        new Gs2Cdk.Gs2Inbox.Model.Namespace(
            stack: this,
            name: "namespace-0001"
        ).MasterData(
            new Gs2Cdk.Gs2Inbox.Model.GlobalMessage[] {
                new Gs2Cdk.Gs2Inbox.Model.GlobalMessage(
                    name: "message-0001",
                    metadata: "hoge"
                ),
                new Gs2Cdk.Gs2Inbox.Model.GlobalMessage(
                    name: "message-0002",
                    metadata: "fuga",
                    options: new Gs2Cdk.Gs2Inbox.Model.Options.GlobalMessageOptions
                    {
                        readAcquireActions = new Gs2Cdk.Core.Model.AcquireAction[]
                        {
                            new Gs2Cdk.Gs2Inventory.StampSheet.AcquireItemSetByUserId(
                                namespaceName: "namespace-0001",
                                inventoryName: "inventory-0001",
                                itemName: "item-0001",
                                acquireCount: 1,
                                expiresAt: 0,
                                createNewItemSet: false,
                                itemSetName: "",
                                userId: "#{userId}"
                            )
                        },
                        expiresTimeSpan = new Gs2Cdk.Gs2Inbox.Model.TimeSpan_(
                            days: 1,
                            hours: 2,
                            minutes: 3
                        )
                    }
                ),
                new Gs2Cdk.Gs2Inbox.Model.GlobalMessage(
                    name: "message-0003",
                    metadata: "piyo"
                )
            }
        );
    }
}

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

```

**TypeScript**
```typescript

import core from "@/gs2cdk/core";
import inbox from "@/gs2cdk/inbox";
import inventory from "@/gs2cdk/inventory";

class SampleStack extends core.Stack
{
    public constructor() {
        super();
        new inbox.model.Namespace(
            this,
            "namespace-0001",
        ).masterData(
            [
                new inbox.model.GlobalMessage(
                    "message-0001",
                    "hoge"
                ),
                new inbox.model.GlobalMessage(
                    "message-0002",
                    "fuga",
                    {
                        readAcquireActions: [
                            new inventory.stampSheet.AcquireItemSetByUserId(
                                "namespace-0001",
                                "inventory-0001",
                                "item-0001",
                                1,
                                0,
                                false,
                                "",
                                null,
                                "#{userId}"
                            ),
                        ],
                        expiresTimeSpan: new inbox.model.TimeSpan(
                            1,
                            2,
                            3
                        )
                    }
                ),
                new inbox.model.GlobalMessage(
                    "message-0003",
                    "piyo"
                )
            ]
        );
    }
}

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

```

**Python**
```python

from gs2_cdk import Stack, core, inbox, inventory

class SampleStack(Stack):

    def __init__(self):
        super().__init__()
        inbox.Namespace(
            stack=self,
            name="namespace-0001",
        ).master_data(
            global_messages=[
                inbox.GlobalMessage(
                    name='message-0001',
                    metadata='hoge'
                ),
                inbox.GlobalMessage(
                    name='message-0002',
                    metadata='fuga',
                    options=inbox.GlobalMessageOptions(
                        read_acquire_actions = [
                            inventory.AcquireItemSetByUserId(
                                namespace_name='namespace-0001',
                                inventory_name='inventory-0001',
                                item_name='item-0001',
                                acquire_count=1,
                                expires_at=0,
                                create_new_item_set=False,
                                item_set_name="",
                                user_id='#{userId}'
                            ),
                        ],
                        expires_time_span = inbox.TimeSpan(
                            days=1,
                            hours=2,
                            minutes=3,        
                        )
                    ),
                ),
                inbox.GlobalMessage(
                    name='message-0003',
                    metadata='piyo'
                ),
            ],
        )

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

```


#### GlobalMessage

グローバルメッセージ<br>

グローバルメッセージはゲームプレイヤー全体にメッセージを届ける仕組みです。<br>

グローバルメッセージには有効期間を設定でき、各ゲームプレイヤーはグローバルメッセージを受信する処理を実行することで<br>
有効期間内のグローバルメッセージの中で未受信のメッセージを自分のメッセージボックスにコピーします。

|  | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- | --- |
| globalMessageId | string |  | ※ |  |  ~ 1024文字 | 全ユーザーに向けたメッセージGRN<br>※ サーバーが自動で設定 |
| name | string |  | ✓ |  |  ~ 128文字 | グローバルメッセージ名<br>グローバルメッセージ固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 |
| metadata | string |  | ✓ |  |  ~ 4096文字 | メタデータ<br>メッセージのタイトル、本文、表示パラメータなどを含むJSON文字列など、グローバルメッセージの内容を表す任意のデータです。ユーザーがこのグローバルメッセージを受信すると、メタデータは受信ボックス内の個別メッセージにコピーされます。GS2はこの値を解釈しません。最大4096文字です。 |
| readAcquireActions | [List&lt;AcquireAction&gt;](#acquireaction) |  |  | [] | 0 ~ 100 items | 開封時入手アクション<br>このグローバルメッセージからコピーされたメッセージをユーザーが開封した際に実行される入手アクションのリストです。これらのアクションはメタデータとともに各ユーザーの個別メッセージにコピーされます。グローバルメッセージあたり最大100アクションです。 |
| expiresTimeSpan | [TimeSpan](#timespan) |  |  |  |  | 有効期限までの期間<br>ユーザーがこのグローバルメッセージを受信（コピー）した時刻から、コピーされたメッセージが期限切れとなり受信ボックスから自動削除されるまでの期間です。日、時間、分の組み合わせで指定します。有効期限に達するとメッセージは既読状態に関わらず削除され、未受け取りの添付報酬も含めて削除されます。 |
| messageReceptionPeriodEventId | string |  |  |  |  ~ 1024文字 | メッセージ受信期間イベントID<br>このグローバルメッセージを受信（ユーザーの受信ボックスにコピー）できる時間枠を定義するGS2-ScheduleイベントのGRNです。この期間外では、ユーザーがグローバルメッセージの受信操作をトリガーしてもメッセージは配信されません。期間限定のイベント告知や季節キャンペーン報酬に便利です。 |

#### TimeSpan

タイムスパン<br>

日、時間、分の組み合わせとして期間を表します。受信時刻を基準としたメッセージの有効期間を定義するために使用されます。例えば、7日、0時間、0分のタイムスパンは、ユーザーが受信してから正確に1週間後にメッセージが期限切れになることを意味します。

|  | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- | --- |
| days | int |  |  | 0 | 0 ~ 365 | 日数<br>このタイムスパンの日数です。時間と分と組み合わせて合計期間が計算されます。最大365日です。 |
| hours | int |  |  | 0 | 0 ~ 24 | 時間<br>このタイムスパンの時間数です。日数と分と組み合わせて合計期間が計算されます。最大24時間です。 |
| minutes | int |  |  | 0 | 0 ~ 60 | 分<br>このタイムスパンの分数です。日数と時間と組み合わせて合計期間が計算されます。最大60分です。 |

#### AcquireAction

入手アクション<br>

報酬としてメッセージに添付される単一の入手アクションを表します。アクションタイプ（例：インベントリへのアイテム追加、通貨増加）とそのリクエストパラメータで構成されます。メッセージが開封されると、これらのアクションがトランザクションに組み立てられ、実行されてユーザーに報酬が配布されます。

|  | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- | --- |
| action | 文字列列挙型<br>enum {<br>}<br> |  | ✓ |  |  | 入手アクションで実行するアクションの種類 |
| request | string |  | ✓ |  |  ~ 524288文字 | アクション実行時に使用されるリクエストのJSON文字列 |

---