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

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

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




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


**JSON**
```json
{
  "version": "2019-03-01",
  "distributorModels": [
    {
      "name": "[string]配信モデル名",
      "metadata": "[string?]メタデータ",
      "inboxNamespaceId": "[string?]あふれたリソースを転送する GS2-Inbox のネームスペースGRN",
      "whiteListTargetIds": [
        "[string]GS2-Distributorを通して処理出来る対象のリソースGRNプレフィックス"
      ]
    }
  ]
}
```


|  | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- | --- |
| version | string | | ✓ | 2019-03-01 | | マスターデータのフォーマットバージョン |
| distributorModels | [List&lt;DistributorModel&gt;](#distributormodel) |  |  |  |  ~ 100 items | 配信モデル<br>配信モデルとはリソースの入手時に所持枠を超えて入手した時のポリシーを設定するエンティティです。<br/>GS2-Distributor を通して入手処理を行うことで、あふれたリソースを GS2-Inbox のメッセージとして転送することができます。 |

## モデル

### DistributorModel

配信モデル<br>

配信モデルとはリソースの入手時に所持枠を超えて入手した時のポリシーを設定するエンティティです。<br>
GS2-Distributor を通して入手処理を行うことで、あふれたリソースを GS2-Inbox のメッセージとして転送することができます。

|  | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- | --- |
| distributorModelId | string |  | ※ |  |  ~ 1024文字 | 配信モデルGRN<br>※ サーバーが自動で設定 |
| name | string |  | ✓ |  |  ~ 128文字 | 配信モデル名<br>配信モデル固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 |
| metadata | string |  |  |  |  ~ 2048文字 | メタデータ<br>メタデータには任意の値を設定できます。<br/>これらの値は GS2 の動作には影響しないため、ゲーム内で利用する情報の保存先として使用できます。 |
| inboxNamespaceId | string |  |  |  |  ~ 1024文字 | あふれたリソースを転送する GS2-Inbox のネームスペースGRN<br>リソースの入手がプレイヤーの所持枠を超えた場合、あふれたリソースは指定された GS2-Inbox ネームスペースにメッセージとして転送されます。プレイヤーは後から受信箱からリソースを受け取ることができます。 |
| whiteListTargetIds | List&lt;string&gt; |  |  | [] | 0 ~ 1000 items | GS2-Distributorを通して処理出来る対象のリソースGRNのホワイトリスト<br>この配信モデルを使用して入手処理を行える対象となるリソースのGRNプレフィックスを指定します。 |

---