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

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

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




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


**JSON**
```json
{
  "version": "2022-09-13",
  "campaignModels": [
    {
      "name": "[string]キャンペーンモデル名",
      "metadata": "[string?]メタデータ",
      "enableCampaignCode": "[bool]キャンペーンコードによる引き換えを許可するか"
    }
  ]
}
```


|  | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- | --- |
| version | string | | ✓ | 2022-09-13 | | マスターデータのフォーマットバージョン |
| campaignModels | [List&lt;CampaignModel&gt;](#campaignmodel) |  |  |  |  ~ 1000 items | キャンペーンモデル<br>キャンペーンモデルはキャンペーンを定義し、シリアルコードと紐づけて管理するために使用されます。 |

## モデル

### CampaignModel

キャンペーンモデル<br>

キャンペーンモデルはキャンペーンを定義し、シリアルコードと紐づけて管理するために使用されます。

|  | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- | --- |
| campaignId | string |  | ※ |  |  ~ 1024文字 | キャンペーンモデルGRN<br>※ サーバーが自動で設定 |
| name | string |  | ✓ |  |  ~ 128文字 | キャンペーンモデル名 |
| metadata | string |  |  |  |  ~ 2048文字 | メタデータ<br>メタデータには任意の値を設定できます。<br>これらの値は GS2 の動作には影響しないため、ゲーム内で利用する情報の保存先として使用できます。 |
| enableCampaignCode | bool |  |  | false |  | キャンペーンコードによる引き換えを許可するか<br>有効にすると、個別のシリアルコードではなく共通のキャンペーンコード（キャンペーン名）を使って報酬を引き換えられるようになります。これにより、1つのコードを複数のユーザーが使用できます。 |

---