GS2-SerialKey API Reference

This service is for handling serial codes or campaign codes. Serial codes cannot be used once, while campaign codes are used on the premise that all players use the same code and that the code cannot be used more than once, for example, by using GS2-Limit’s limit on the number of times it can be used. Serial codes should be used by preparing a GS2-Exchange redemption rate that allows players to be compensated for the use of the serial code, for example.

A campaign code is a code in which the operator can freely set a string that is easy for humans to remember, such as “Halloween2025” or “SUMMER.” It is intended that many players share and redeem the same code.

By associating a campaign with a GS2-Schedule event, you can set its valid period. Validation of the valid period can be achieved by combining transaction actions.

Serial keys are issued by specifying the target campaign and the number to issue and running the issue process. The issue process runs as an asynchronous job, and progress can be checked through IssueJob. The list of issued serial keys can be downloaded in CSV format.

The state in which a player can actually use a serial key is ACTIVE, and it becomes USED once it has been used. If the operator invalidates a serial key, it becomes INACTIVE.