GS2-SerialKey Master Data Reference

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

Master Data Format

{
  "version": "2022-09-13",
  "campaignModels": [
    {
      "name": "[string]Campaign Model 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
A Campaign Model is used to define and manage campaigns, linking them to serial codes.

Models

CampaignModel

Campaign Model

A Campaign Model is used to define and manage campaigns, linking them to serial codes.

Type Condition Required Default Value Limits Description
campaignId string
*
 ~ 1024 chars GRN of the Campaign Model
* Set automatically by the server
name string
✓
 ~ 128 chars Campaign Model 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
When enabled, users can redeem rewards using a shared campaign code (the campaign name) instead of individual serial codes. This allows a single code to be used by multiple users.