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)"
      },
      "repeatType": "[string]Type of repetition",
      "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]Event repetition start time (in hours)",
      "repeatEndHour": "[int]Event repetition end time (in hours)"
    }
  ]
}
TypeConditionRequireDefaultLimitationDescription
version2019-03-31Format version of master data
eventsList<Event>~ 100 itemsEvent

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.

TypeConditionRequireDefaultLimitationDescription
eventIdstring~ 1024 charsGS2-Schedule Event GRN
namestring~ 128 charsEvent Type Name
metadatastring~ 2048 charsmetadata
scheduleTypeenum [
“absolute”,
“relative”
]
~ 128 charsType of Event Period
absoluteBeginlongEvent start date and time
absoluteEndlongEvent end date and time
relativeTriggerNamestring{scheduleType} == “relative”~ 128 charsEvent Start Trigger Name
repeatSettingRepeatSettingRepeat setting
repeatTypeenum [
“always”,
“daily”,
“weekly”,
“monthly”
]
“always”~ 128 charsType of repetition
repeatBeginDayOfMonthint{repeatType} == “monthly”1 ~ 31Event repeat start date (If the value exceeds the days of the month, it is treated as the last day.)
repeatEndDayOfMonthint{repeatType} == “monthly”1 ~ 31Event repeat end date (If the value exceeds the days of the month, it is treated as the last day.)
repeatBeginDayOfWeekenum [
“sunday”,
“monday”,
“tuesday”,
“wednesday”,
“thursday”,
“friday”,
“saturday”
]
{repeatType} == “weekly”~ 128 charsRepeat start day of event
repeatEndDayOfWeekenum [
“sunday”,
“monday”,
“tuesday”,
“wednesday”,
“thursday”,
“friday”,
“saturday”
]
{repeatType} == “weekly”~ 128 charsRepeat event end day of the week
repeatBeginHourint{repeatType} in [“daily”, “weekly”, “monthly”]~ 23Event repetition start time (in hours)
repeatEndHourint{repeatType} in [“daily”, “weekly”, “monthly”]~ 23Event repetition end time (in hours)

RepeatSetting

Repeat Setting

There are two types of event durations: absolute and relative.

TypeConditionRequireDefaultLimitationDescription
repeatTypeenum [
“always”,
“daily”,
“weekly”,
“monthly”
]
“always”~ 128 charsType of repetition
beginDayOfMonthint{repeatType} == “monthly”1 ~ 31Event repeat start date (If the value exceeds the days of the month, it is treated as the last day.)
endDayOfMonthint{repeatType} == “monthly”1 ~ 31Event repeat end date (If the value exceeds the days of the month, it is treated as the last day.)
beginDayOfWeekenum [
“sunday”,
“monday”,
“tuesday”,
“wednesday”,
“thursday”,
“friday”,
“saturday”
]
{repeatType} == “weekly”~ 128 charsRepeat start day of event
endDayOfWeekenum [
“sunday”,
“monday”,
“tuesday”,
“wednesday”,
“thursday”,
“friday”,
“saturday”
]
{repeatType} == “weekly”~ 128 charsRepeat event end day of the week
beginHourint{repeatType} in [“daily”, “weekly”, “monthly”]~ 23Event repetition start time (in hours)
endHourint{repeatType} in [“daily”, “weekly”, “monthly”]~ 23Event repetition end time (in hours)

RepeatSchedule

TypeConditionRequireDefaultLimitationDescription
repeatCountint~ 2147483646Number of times to repeat
currentRepeatStartAtlongStart date and time of repeating event
currentRepeatEndAtlongEnd date and time of repeating event
lastRepeatEndAtlongEnd date and time of last event
nextRepeatStartAtlongStart date and time of next event