Master Data Reference of GS2-Distributor

Reference of the format of master data and various models to be imported

Master Data Format

{
  "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 resources GRN that can be processed through GS2-Distributor"
      ]
    }
  ]
}

	Type	Condition	Required	Default	Value Limits	Description
version	string		✓	2019-03-01		Format version of master data
distributorModels	List<DistributorModel>				~ 100 items	Distributor Model Distributor Model is an entity that sets the policy when an entity’s acquisition exceeds its possession quota. By processing acquisitions through GS2-Distributor, overflow resources can be forwarded as GS2-Inbox messages.

Model

DistributorModel

Distributor Model

Distributor Model is an entity that sets the policy when an entity’s acquisition exceeds its possession quota. By processing acquisitions through GS2-Distributor, overflow resources can be forwarded as GS2-Inbox messages.

	Type	Required	Default	Value Limits	Description
distributorModelId	string	✓*		~ 1024 chars	Distributor Model GRN * Automatically configured on the server
name	string	✓		~ 128 chars	Distributor Model name Distributor Model-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.).
metadata	string			~ 2048 chars	Metadata Arbitrary values can be set in the metadata. 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
whiteListTargetIds	List<string>		[]	0 ~ 1000 items	Whitelist of target resources GRN that can be processed through GS2-Distributor Specify the GRN prefix of the target resources that can be processed for acquisition using this Distributor Model.