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

# GS2-Distributor Master Data Reference

Reference for the master data format and the models to be imported




## Master Data Format


**JSON**
```json
{
  "version": "2019-03-01",
  "distributorModels": [
    {
      "name": "[string]Distributor Model name",
      "metadata": "[string?]Metadata",
      "inboxNamespaceId": "[string?]GS2-Inbox Namespace GRN to transfer overflow resources",
      "whiteListTargetIds": [
        "[string]target resource GRN prefix that can be processed through GS2-Distributor"
      ]
    }
  ]
}
```


|  | Type | Condition | Required | Default | Value Limits | Description |
| --- | --- | --- | --- | --- | --- | --- |
| version | string | | ✓ | 2019-03-01 | | Master data format version |
| distributorModels | [List&lt;DistributorModel&gt;](#distributormodel) |  |  |  |  ~ 100 items | Distributor Model<br>A Distributor Model is an entity that defines the policy applied when acquiring resources beyond the inventory capacity.<br>By processing acquisitions through GS2-Distributor, overflow resources can be forwarded as GS2-Inbox messages. |

## Models

### DistributorModel

Distributor Model

A Distributor Model is an entity that defines the policy applied when acquiring resources beyond the inventory capacity.
By processing acquisitions through GS2-Distributor, overflow resources can be forwarded as GS2-Inbox messages.

|  | Type | Condition | Required | Default | Value Limits | Description |
| --- | --- | --- | --- | --- | --- | --- |
| distributorModelId | string |  | * |  |  ~ 1024 chars | Distributor Model GRN<br>* Set automatically by the server |
| name | string |  | ✓ |  |  ~ 128 chars | Distributor Model name<br>Unique Distributor Model name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.). |
| metadata | string |  |  |  |  ~ 2048 chars | Metadata<br>Arbitrary values can be set in the metadata.<br>Since they do not affect GS2’s behavior, they can be used to store information used in the game. |
| inboxNamespaceId | string |  |  |  |  ~ 1024 chars | GS2-Inbox Namespace GRN to transfer overflow resources<br>When a resource acquisition exceeds the player's inventory capacity, the overflow resources are forwarded as a message to the specified GS2-Inbox Namespace. The player can then claim the resources from their inbox at a later time. |
| whiteListTargetIds | List&lt;string&gt; |  |  | [] | 0 ~ 1000 items | Whitelist of target resource GRN prefixes that can be processed through GS2-Distributor<br>Specify the GRN prefix of the target resources that can be processed for acquisition using this Distributor Model. |

---