GS2-Schedule マスターデータリファレンス
{
"version": "2019-03-31",
"events": [
{
"name": "[string]イベントの種類名",
"metadata": "[string?]メタデータ",
"scheduleType": "[string]イベント期間の種類",
"repeatType": "[string]繰り返しの種類",
"absoluteBegin": "[long]イベントの開始日時",
"absoluteEnd": "[long]イベントの終了日時",
"repeatBeginDayOfMonth": "[int]イベントの繰り返し開始日(月の日数を超える場合は、最終日として扱われます)",
"repeatEndDayOfMonth": "[int]イベントの繰り返し終了日(月の日数を超える場合は、最終日として扱われます)",
"repeatBeginDayOfWeek": "[string]イベントの繰り返し開始曜日",
"repeatEndDayOfWeek": "[string]イベントの繰り返し終了曜日",
"repeatBeginHour": "[int]イベントの繰り返し開始時間",
"repeatEndHour": "[int]イベントの繰り返し終了時間",
"relativeTriggerName": "[string]イベントの開始トリガー"
}
]
}
型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|---|
version | ✓ | 2019-03-31 | マスターデータのフォーマットバージョン | |||
events | List<Event> |
Event
イベント
イベントの期間は絶対期間と相対期間の2種類存在します。 絶対期間は 2021年1月1日 00:00(UTC) ~ 2021年1月7日 23:59(UTC) のような固定の期間で、 相対期間は トリガーを引いたタイミングから 24時間 のようなゲームプレイヤー毎に異なる期間をイベント期間とするものです。
イベントには開催期間だけでなく、繰り返しが設定できるようになっており イベント期間のうち、月曜日の 10:00 ~ 11:00 だけをイベント期間とするような設定も可能です。
型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|---|
eventId | string | ✓ | ~ 1024文字 | イベントGRN | ||
name | string | ✓ | ~ 128文字 | イベントの種類名 | ||
metadata | string | ~ 2048文字 | メタデータ | |||
scheduleType | enum [‘absolute’, ‘relative’] | ✓ | ~ 128文字 | イベント期間の種類 | ||
repeatType | enum [‘always’, ‘daily’, ‘weekly’, ‘monthly’] | ✓ | “always” | ~ 128文字 | 繰り返しの種類 | |
absoluteBegin | long | {scheduleType} == “absolute” | ✓ | イベントの開始日時 | ||
absoluteEnd | long | {scheduleType} == “absolute” | ✓ | イベントの終了日時 | ||
repeatBeginDayOfMonth | int | {repeatType} == “monthly” | ✓ | 1 ~ 31 | イベントの繰り返し開始日(月の日数を超える場合は、最終日として扱われます) | |
repeatEndDayOfMonth | int | {repeatType} == “monthly” | ✓ | 1 ~ 31 | イベントの繰り返し終了日(月の日数を超える場合は、最終日として扱われます) | |
repeatBeginDayOfWeek | enum [‘sunday’, ‘monday’, ’tuesday’, ‘wednesday’, ’thursday’, ‘friday’, ‘saturday’] | {repeatType} == “weekly” | ✓ | ~ 128文字 | イベントの繰り返し開始曜日 | |
repeatEndDayOfWeek | enum [‘sunday’, ‘monday’, ’tuesday’, ‘wednesday’, ’thursday’, ‘friday’, ‘saturday’] | {repeatType} == “weekly” | ✓ | ~ 128文字 | イベントの繰り返し終了曜日 | |
repeatBeginHour | int | {repeatType} in [“daily”, “weekly”, “monthly”] | ✓ | ~ 23 | イベントの繰り返し開始時間 | |
repeatEndHour | int | {repeatType} in [“daily”, “weekly”, “monthly”] | ✓ | ~ 23 | イベントの繰り返し終了時間 | |
relativeTriggerName | string | {scheduleType} == “relative” | ✓ | ~ 128文字 | イベントの開始トリガー |
RepeatSchedule
型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|---|
repeatCount | int | ✓ | ~ 2147483646 | 繰り返し回数 | ||
currentRepeatStartAt | long | リピート中のイベントの開始日時 | ||||
currentRepeatEndAt | long | リピート中のイベントの終了日時 | ||||
lastRepeatEndAt | long | 前回のイベントの終了日時 | ||||
nextRepeatStartAt | long | 次回のイベントの開始日時 |