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 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 | Required | Default | Value Limits | Description | |
|---|---|---|---|---|---|---|
| version | string | ✓ | 2019-03-31 | Format version of master data | ||
| events | List<Event> | ~ 100 items | 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. |
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 | Required | Default | Value Limits | Description | |||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| eventId | string | ✓ | ~ 1024 chars | GS2-Schedule Event GRN | ||||||||
| name | string | ✓ | ~ 128 chars | Event Name | ||||||||
| metadata | string | ~ 2048 chars | Metadata | |||||||||
| scheduleType | String Enum enum { “absolute”, “relative” } | ✓ | ~ 128 chars | Type of Event Period
| ||||||||
| absoluteBegin | long | Event start date and time | ||||||||||
| absoluteEnd | long | Event end date and time | ||||||||||
| relativeTriggerName | string | {scheduleType} == “relative” | ✓* | ~ 128 chars | Event Start Trigger Name When setting an event period for each game player, specify the name of the trigger that serves as the starting point for the event under relative.* Required if scheduleType is “relative” | |||||||
| repeatSetting | RepeatSetting | ✓ | Repeat setting |
RepeatSetting
Repeat Setting
This setting is used when configuring the event period to apply only to Mondays from 10:00 AM to 11:00 AM.
| Type | Condition | Required | Default | Value Limits | Description | |||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| repeatType | String Enum 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.) * Required if repeatType is “monthly” | |||||||||||||||||
| 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.) * Required if repeatType is “monthly” | |||||||||||||||||
| beginDayOfWeek | String Enum enum { “sunday”, “monday”, “tuesday”, “wednesday”, “thursday”, “friday”, “saturday” } | {repeatType} == “weekly” | ✓* | ~ 128 chars | Repeat start day of event
* Required if repeatType is “weekly” | |||||||||||||||||
| endDayOfWeek | String Enum enum { “sunday”, “monday”, “tuesday”, “wednesday”, “thursday”, “friday”, “saturday” } | {repeatType} == “weekly” | ✓* | ~ 128 chars | Repeat event end day of the week
* Required if repeatType is “weekly” | |||||||||||||||||
| beginHour | int | {repeatType} in [“daily”, “weekly”, “monthly”] | ✓* | 0 ~ 23 | Event repetition start time (in hours) * Required if repeatType is “daily”,“weekly”,“monthly” | |||||||||||||||||
| endHour | int | {repeatType} in [“daily”, “weekly”, “monthly”] | ✓* | 0 ~ 24 | Event repetition end time (in hours) * Required if repeatType is “daily”,“weekly”,“monthly” | |||||||||||||||||
| anchorTimestamp | long | {repeatType} == “custom” | ✓* | Anchor date to start the cycle * Required if repeatType is “custom” | ||||||||||||||||||
| activeDays | int | {repeatType} == “custom” | ✓* | 1 ~ 2147483646 | Number of active days in the cycle * Required if repeatType is “custom” | |||||||||||||||||
| inactiveDays | int | {repeatType} == “custom” | ✓* | 0 ~ 2147483646 | Number of inactive days in the cycle * Required if repeatType is “custom” |
RepeatSchedule
State of repeating schedule
| Type | Condition | Required | Default | Value Limits | Description | |
|---|---|---|---|---|---|---|
| repeatCount | int | ✓ | 0 ~ 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 |