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

# GS2-Inbox マスターデータリファレンス

マスターデータのフォーマットと インポートする各種モデルのリファレンス




## マスターデータのフォーマット


**JSON**
```json
{
  "version": "2020-03-12",
  "globalMessages": [
    {
      "name": "[string]グローバルメッセージ名",
      "metadata": "[string]メタデータ",
      "readAcquireActions": [
        {
          "action": "[string]入手アクションで実行するアクションの種類",
          "request": "[string]アクション実行時に使用されるリクエストのJSON文字列"
        }
      ],
      "expiresTimeSpan": {
        "days": "[int]日数",
        "hours": "[int]時間",
        "minutes": "[int]分"
      },
      "messageReceptionPeriodEventId": "[string?]メッセージ受信期間イベントID"
    }
  ]
}
```


|  | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- | --- |
| version | string | | ✓ | 2020-03-12 | | マスターデータのフォーマットバージョン |
| globalMessages | [List&lt;GlobalMessage&gt;](#globalmessage) |  |  |  |  ~ 1000 items | グローバルメッセージ<br>グローバルメッセージはゲームプレイヤー全体にメッセージを届ける仕組みです。<br/><br/>グローバルメッセージには有効期間を設定でき、各ゲームプレイヤーはグローバルメッセージを受信する処理を実行することで<br/>有効期間内のグローバルメッセージの中で未受信のメッセージを自分のメッセージボックスにコピーします。 |

## モデル

### 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文字列 |

---