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

# GS2-SerialKey API リファレンス

シリアルコード機能




シリアルコードもしくは、キャンペーンコードを取り扱うためのサービスです。<br>
シリアルコードは一回使用したら使えなくなるのに対して、キャンペーンコードは全プレイヤーが同じコードを利用し、GS2-Limit の回数制限を使用するなどして何度も使用できないように制御する前提で利用します。<br>
シリアルコードを使用することで対価を得られる GS2-Exchange の交換レートを用意するなどして利用してください。

キャンペーンコードは、「ハロウィン2025」「SUMMER」のように人間にとって覚えやすい文字列を、運営側が任意に設定できるコードです。<br>
1つのコードを多数のプレイヤーが共有して引き換えに使用することを想定しています。

キャンペーンは GS2-Schedule のイベントと関連づけることで有効期間を設定することが可能です。<br>
有効期間の検証はトランザクションアクションを組み合わせて実現できます。

対象のキャンペーンと発行数量を指定してシリアルキーの発行処理を実行することで、シリアルキーが発行されます。<br>
発行処理は非同期ジョブとして実行され、`IssueJob` を介して進捗を確認できます。<br>
発行されたシリアルキーのリストはCSV形式でダウンロードが可能です。

実際にプレイヤーが利用できる状態が `ACTIVE` で、使用すると `USED` になります。<br>
運営サイドでシリアルキーを無効化すると `INACTIVE` になります。

[マイクロサービス紹介 / GS2-SerialKey](../../microservices/serial_key)



- [GS2-SerialKey Deploy/CDK リファレンス](/ja/api_reference/serial_key/deploy/)
  
- [GS2-SerialKey SDK API リファレンス](/ja/api_reference/serial_key/sdk/)
  
- [GS2-SerialKey SDK for Game Engine API リファレンス](/ja/api_reference/serial_key/game_engine/)
  
- [GS2-SerialKey トランザクションアクション](/ja/api_reference/serial_key/stamp_sheet/)
  
- [GS2-SerialKey マスターデータリファレンス](/ja/api_reference/serial_key/master_data/)