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",
"absoluteBegin": "[long?]Event start date and time",
"absoluteEnd": "[long?]Event end date and time",
"relativeTriggerName": "[string]Event Start Trigger Name",
"repeatSetting": {
"repeatType": "[string]Type of repetition",
"beginDayOfMonth": "[int]Event repeat start date (If the value exceeds the days of the month, it is treated as the last day.)",
"endDayOfMonth": "[int]Event repeat end date (If the value exceeds the days of the month, it is treated as the last day.)",
"beginDayOfWeek": "[string]Repeat start day of event",
"endDayOfWeek": "[string]Repeat event end day of the week",
"beginHour": "[int]Event repetition start time (in hours)",
"endHour": "[int]Event repetition end time (in hours)",
"anchorTimestamp": "[long]Anchor date to start the cycle",
"activeDays": "[int]Number of active days in the cycle",
"inactiveDays": "[int]Number of inactive days in the cycle"
}
}
]
}
Type | Condition | Require | Default | Limitation | Description | |
---|---|---|---|---|---|---|
version | ✓ | 2019-03-31 | Format version of master data | |||
events | List<Event> | ~ 100 items | 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 | GS2-Schedule Event GRN | ||
name | string | ✓ | ~ 128 chars | Event Type Name | ||
metadata | string | ~ 2048 chars | metadata | |||
scheduleType | enum { “absolute”, “relative” } | ✓ | ~ 128 chars | Type of Event Period | ||
absoluteBegin | long | Event start date and time (Unix time unit:milliseconds) | ||||
absoluteEnd | long | Event end date and time (Unix time unit:milliseconds) | ||||
relativeTriggerName | string | {scheduleType} == “relative” | ✓ | ~ 128 chars | Event Start Trigger Name | |
repeatSetting | RepeatSetting | ✓ | Repeat setting |
Enumeration type definition to specify as scheduleType
Enumerator String Definition | Description |
---|---|
absolute | Fixed period |
relative | Period by Player |
RepeatSetting
Repeat Setting
There are two types of event durations: absolute and relative.
Type | Condition | Require | Default | Limitation | Description | |
---|---|---|---|---|---|---|
repeatType | enum { “always”, “daily”, “weekly”, “monthly”, “custom” } | ✓ | “always” | ~ 128 chars | Type of repetition | |
beginDayOfMonth | 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.) | |
endDayOfMonth | 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.) | |
beginDayOfWeek | enum { “sunday”, “monday”, “tuesday”, “wednesday”, “thursday”, “friday”, “saturday” } | {repeatType} == “weekly” | ✓ | ~ 128 chars | Repeat start day of event | |
endDayOfWeek | enum { “sunday”, “monday”, “tuesday”, “wednesday”, “thursday”, “friday”, “saturday” } | {repeatType} == “weekly” | ✓ | ~ 128 chars | Repeat event end day of the week | |
beginHour | int | {repeatType} in [“daily”, “weekly”, “monthly”] | ✓ | ~ 23 | Event repetition start time (in hours) | |
endHour | int | {repeatType} in [“daily”, “weekly”, “monthly”] | ✓ | ~ 24 | Event repetition end time (in hours) | |
anchorTimestamp | long | {repeatType} == “custom” | ✓ | Anchor date to start the cycle (Unix time unit:milliseconds) | ||
activeDays | int | {repeatType} == “custom” | ✓ | 1 ~ 2147483646.0 | Number of active days in the cycle | |
inactiveDays | int | {repeatType} == “custom” | ✓ | 1 ~ 2147483646.0 | Number of inactive days in the cycle |
Enumeration type definition to specify as repeatType
Enumerator String Definition | Description |
---|---|
always | Event period Always |
daily | Every day during the event period from X:00 to X:00 |
weekly | Every X days of the week from X:00 to X:00 during the event period |
monthly | Xth day of each month during the event period from X:00 to X:00 |
custom | Starting from the reference date, active for X days and inactive for Y days during the event period |
Enumeration type definition to specify as beginDayOfWeek
Enumerator String Definition | Description |
---|---|
sunday | Sunday |
monday | Monday |
tuesday | Tuesday |
wednesday | Wednesday |
thursday | Thuesday |
friday | Friday |
saturday | Saturday |
Enumeration type definition to specify as endDayOfWeek
Enumerator String Definition | Description |
---|---|
sunday | Sunday |
monday | Monday |
tuesday | Tuesday |
wednesday | Wednesday |
thursday | Thuesday |
friday | Friday |
saturday | Saturday |
RepeatSchedule
State of repeating schedule
Type | Condition | Require | Default | Limitation | Description | |
---|---|---|---|---|---|---|
repeatCount | int | ✓ | ~ 2147483646 | Number of times to repeat | ||
currentRepeatStartAt | long | Start date and time of repeating event (Unix time unit:milliseconds) | ||||
currentRepeatEndAt | long | End date and time of repeating event (Unix time unit:milliseconds) | ||||
lastRepeatEndAt | long | End date and time of last event (Unix time unit:milliseconds) | ||||
nextRepeatStartAt | long | Start date and time of next event (Unix time unit:milliseconds) |