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

# GS2-Schedule API リファレンス

イベントスケジュール機能




ゲーム内のイベントの予定を管理します。

このサービスを単独で使うことはなく、 GS2-Showcase や GS2-Quest などと連携して、イベント開催期間のみストアに陳列する商品やクエストを実現します。

イベントの開催期間には2種類あります。

- 絶対期間は、全てのプレイヤーが同じ期間を共有します。「1月1日〜1月3日でニューイヤーイベントを開催する」といったケースで使用し、`absoluteBegin` / `absoluteEnd` をマスターデータで指定します。
- 相対期間は、プレイヤーごとに期間が異なります。「ゲーム開始から1週間」や「初めてボスを倒してから24時間」といったケースで使用します。トリガーを引く時に、すでにトリガーが引かれている場合のイベント期間の指定方法には複数の方式があります。

絶対期間／相対期間ともに、`RepeatSetting` を組み合わせることで「特定の曜日や時間帯のみ有効」「数日のサイクルで有効・無効を切り替える」といった繰り返しスケジュールを表現できます。

繰り返し設定を持つイベントについては、現在および直前の繰り返しサイクルの開始日時／終了日時を `RepeatSchedule` として取得できます。<br>
これにより、現在のサイクル内で報酬を何回受け取ったかといった集計や、次回サイクルまでの残り時間の表示が可能です。

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



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