Master Data Reference of GS2-Schedule
{
"version": "2019-03-31",
"events": [
{
"name": "[string]Event Type Name",
"metadata": "[string?]metadata",
"scheduleType": "[string]Type of Event Period",
"repeatType": "[string]Type of repetition",
"absoluteBegin": "[long]Event start date and time",
"absoluteEnd": "[long]Event end date and time",
"repeatBeginDayOfMonth": "[int]Event repeat start date (If the value exceeds the days of the month, it is treated as the last day.)",
"repeatEndDayOfMonth": "[int]Event repeat end date (If the value exceeds the days of the month, it is treated as the last day.)",
"repeatBeginDayOfWeek": "[string]Repeat start day of event",
"repeatEndDayOfWeek": "[string]Repeat event end day of the week",
"repeatBeginHour": "[int]Repeat event start time",
"repeatEndHour": "[int]Repeat event end time",
"relativeTriggerName": "[string]Trigger the start of the event"
}
]
}
Type | Condition | Require | Default | Limitation | Description | |
---|---|---|---|---|---|---|
version | ✓ | 2019-03-31 | Format version of master data | |||
events | List<Event> |
Event
Event
Two types of event durations exist: absolute and relative. Absolute periods are fixed periods, such as January 1, 2021 00:00(UTC) to January 7, 2021 23:59(UTC). A relative period is an event period that varies from one game player to another, such as 24 hours from the time the trigger is pulled.
The event can be set to repeat itself as well as the duration of the event. An event period can be set up so that only Monday from 10:00 to 11:00 is included in the event period.
Type | Condition | Require | Default | Limitation | Description | |
---|---|---|---|---|---|---|
eventId | string | ✓ | ~ 1024 chars | Event GRN | ||
name | string | ✓ | ~ 128 chars | Event Type Name | ||
metadata | string | ~ 2048 chars | metadata | |||
scheduleType | enum [‘absolute’, ‘relative’] | ✓ | ~ 128 chars | Type of Event Period | ||
repeatType | enum [‘always’, ‘daily’, ‘weekly’, ‘monthly’] | ✓ | “always” | ~ 128 chars | Type of repetition | |
absoluteBegin | long | {scheduleType} == “absolute” | ✓ | Event start date and time | ||
absoluteEnd | long | {scheduleType} == “absolute” | ✓ | Event end date and time | ||
repeatBeginDayOfMonth | int | {repeatType} == “monthly” | ✓ | 1 ~ 31 | Event repeat start date (If the value exceeds the days of the month, it is treated as the last day.) | |
repeatEndDayOfMonth | int | {repeatType} == “monthly” | ✓ | 1 ~ 31 | Event repeat end date (If the value exceeds the days of the month, it is treated as the last day.) | |
repeatBeginDayOfWeek | enum [‘sunday’, ‘monday’, ’tuesday’, ‘wednesday’, ’thursday’, ‘friday’, ‘saturday’] | {repeatType} == “weekly” | ✓ | ~ 128 chars | Repeat start day of event | |
repeatEndDayOfWeek | enum [‘sunday’, ‘monday’, ’tuesday’, ‘wednesday’, ’thursday’, ‘friday’, ‘saturday’] | {repeatType} == “weekly” | ✓ | ~ 128 chars | Repeat event end day of the week | |
repeatBeginHour | int | {repeatType} in [“daily”, “weekly”, “monthly”] | ✓ | ~ 23 | Repeat event start time | |
repeatEndHour | int | {repeatType} in [“daily”, “weekly”, “monthly”] | ✓ | ~ 23 | Repeat event end time | |
relativeTriggerName | string | {scheduleType} == “relative” | ✓ | ~ 128 chars | Trigger the start of the event |
RepeatSchedule
Type | Condition | Require | Default | Limitation | Description | |
---|---|---|---|---|---|---|
repeatCount | int | ✓ | ~ 2147483646 | Number of times to repeat | ||
currentRepeatStartAt | long | Start date and time of repeating event | ||||
currentRepeatEndAt | long | End date and time of repeating event | ||||
lastRepeatEndAt | long | End date and time of last event | ||||
nextRepeatStartAt | long | Start date and time of next event |