Master Data Reference of GS2-Schedule

Reference of the format of master data and various models to be imported
{
  "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"
      }
    }
  ]
}
TypeConditionRequireDefaultLimitationDescription
version
2019-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
scheduleTypeString Enum
enum {
    “absolute”,
    “relative”
}
~ 128 charsType of Event Period
Enumerator String DefinitionDescription
“absolute”Fixed period
“relative”Period by Player
absoluteBeginlongEvent start date and time (Unix time unit:milliseconds)
absoluteEndlongEvent end date and time (Unix time unit:milliseconds)
relativeTriggerNamestring{scheduleType} == “relative”
~ 128 charsEvent Start Trigger Name
repeatSettingRepeatSetting
Repeat setting

RepeatSetting

Repeat Setting

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

TypeConditionRequireDefaultLimitationDescription
repeatTypeString Enum
enum {
    “always”,
    “daily”,
    “weekly”,
    “monthly”,
    “custom”
}
“always”~ 128 charsType of repetition
Enumerator String DefinitionDescription
“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
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.)
beginDayOfWeekString Enum
enum {
    “sunday”,
    “monday”,
    “tuesday”,
    “wednesday”,
    “thursday”,
    “friday”,
    “saturday”
}
{repeatType} == “weekly”
~ 128 charsRepeat start day of event
Enumerator String DefinitionDescription
“sunday”Sunday
“monday”Monday
“tuesday”Tuesday
“wednesday”Wednesday
“thursday”Thuesday
“friday”Friday
“saturday”Saturday
endDayOfWeekString Enum
enum {
    “sunday”,
    “monday”,
    “tuesday”,
    “wednesday”,
    “thursday”,
    “friday”,
    “saturday”
}
{repeatType} == “weekly”
~ 128 charsRepeat event end day of the week
Enumerator String DefinitionDescription
“sunday”Sunday
“monday”Monday
“tuesday”Tuesday
“wednesday”Wednesday
“thursday”Thuesday
“friday”Friday
“saturday”Saturday
beginHourint{repeatType} in [“daily”, “weekly”, “monthly”]
~ 23Event repetition start time (in hours)
endHourint{repeatType} in [“daily”, “weekly”, “monthly”]
~ 24Event repetition end time (in hours)
anchorTimestamplong{repeatType} == “custom”
Anchor date to start the cycle (Unix time unit:milliseconds)
activeDaysint{repeatType} == “custom”
1 ~ 2147483646.0Number of active days in the cycle
inactiveDaysint{repeatType} == “custom”
~ 2147483646.0Number of inactive days in the cycle

RepeatSchedule

State of repeating schedule

TypeConditionRequireDefaultLimitationDescription
repeatCountint
~ 2147483646Number of times to repeat
currentRepeatStartAtlongStart date and time of repeating event (Unix time unit:milliseconds)
currentRepeatEndAtlongEnd date and time of repeating event (Unix time unit:milliseconds)
lastRepeatEndAtlongEnd date and time of last event (Unix time unit:milliseconds)
nextRepeatStartAtlongStart date and time of next event (Unix time unit:milliseconds)