GS2-Dictionary API Reference

Dictionary feature

Realize a database with binary values of “obtained” and “not obtained” for each player/entry, such as item and character index.

  • GS2-Dictionary can register up to 100 entries in a single API request.
  • GS2-Dictionary allows you to delete entries that have been recorded, or to verify whether a specific entry has been acquired (or not acquired). This enables operations such as resetting the possession status of limited-time event items, or restricting quests so that they can only be started when a specific item has been acquired.
  • Master data can be registered via the management console, imported from GitHub, or registered from CI using GS2-Deploy or various language CDKs.
  • GS2-Dictionary allows you to mark recorded entries as favorites. Use AddLikes or DeleteLikes to manage the favorites list, and use the Likes API to retrieve them or subscribe to change notifications. By using favorite information, you can implement filtering on the dictionary screen or prioritized display in the UI.
Introduction to Microservices / GS2-Dictionary
GS2-Dictionary SDK for Game Engine API Reference

Specifications of models and API references for GS2-Dictionary SDK for Game Engine

GS2-Dictionary SDK API Reference

Specification of models and API references for GS2-Dictionary SDK for various programming languages

GS2-Dictionary Script Trigger Reference

Reference for event triggers that call extended scripts

GS2-Dictionary Deploy/CDK Reference

The template format used when creating stacks with GS2-Deploy, and implementation examples of template output in various languages using CDK

GS2-Dictionary Master Data Reference

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

GS2-Dictionary Transaction Actions

Specification of verify/consume/acquire transaction actions