Master Data Reference of GS2-SerialKey

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

Master Data Format

{
  "version": "2022-09-13",
  "campaignModels": [
    {
      "name": "[string]Campaign name",
      "metadata": "[string?]Metadata",
      "enableCampaignCode": "[bool]Whether to allow redemption with campaign code"
    }
  ]
}

	Type	Condition	Required	Default	Value Limits	Description
version	string		✓	2022-09-13		Format version of master data
campaignModels	List<CampaignModel>				~ 1000 items	Campaign Model The campaign model is used to define and manage campaigns, linking them to serial codes.

Model

CampaignModel

Campaign Model

The campaign model is used to define and manage campaigns, linking them to serial codes.

	Type	Required	Default	Value Limits	Description
campaignId	string	✓*		~ 1024 chars	Campaign Model GRN * Automatically configured on the server
name	string	✓		~ 128 chars	Campaign name
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.
enableCampaignCode	bool	✓	false		Whether to allow redemption with campaign code