GS2-Schedule マスターデータリファレンス
マスターデータのフォーマットと インポートする各種モデルのリファレンス
{
"version": "2019-03-31",
"events": [
{
"name": "[string]イベントの種類名",
"metadata": "[string?]メタデータ",
"scheduleType": "[string]イベント期間の種類",
"absoluteBegin": "[long?]イベントの開始日時",
"absoluteEnd": "[long?]イベントの終了日時",
"relativeTriggerName": "[string]イベントのトリガー名",
"repeatSetting": {
"repeatType": "[string]繰り返しの種類",
"beginDayOfMonth": "[int]イベントの繰り返し開始日(月の日数を超える場合は、最終日として扱われます)",
"endDayOfMonth": "[int]イベントの繰り返し終了日(月の日数を超える場合は、最終日として扱われます)",
"beginDayOfWeek": "[string]イベントの繰り返し開始曜日",
"endDayOfWeek": "[string]イベントの繰り返し終了曜日",
"beginHour": "[int]イベントの繰り返し開始時間(単位:時)",
"endHour": "[int]イベントの繰り返し終了時間(単位:時)",
"anchorTimestamp": "[long]サイクルを開始する基準日",
"activeDays": "[int]サイクル内のアクティブな日数",
"inactiveDays": "[int]サイクル内のインアクティブな日数"
}
}
]
}
型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|---|
version | ✓ | 2019-03-31 | マスターデータのフォーマットバージョン | |||
events | List<Event> | ~ 100 items | イベント |
Event
イベント
イベントの期間は絶対期間と相対期間の2種類存在します。
絶対期間は 2021年1月1日 00:00(UTC) ~ 2021年1月7日 23:59(UTC) のような固定の期間で、
相対期間は トリガーを引いたタイミングから 24時間 のようなゲームプレイヤー毎に異なる期間をイベント期間とするものです。
イベントには開催期間だけでなく、繰り返しが設定できるようになっており
イベント期間のうち、月曜日の 10:00 ~ 11:00 だけをイベント期間とするような設定も可能です。
型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
eventId | string | ✓ | ~ 1024文字 | GS2-Schedule イベントGRN | ||||||||
name | string | ✓ | ~ 128文字 | イベントの種類名 | ||||||||
metadata | string | ~ 2048文字 | メタデータ | |||||||||
scheduleType | 文字列列挙型 enum { “absolute”, “relative” } | ✓ | ~ 128文字 | イベント期間の種類
| ||||||||
absoluteBegin | long | イベントの開始日時 (UNIX時間 単位:ミリ秒) | ||||||||||
absoluteEnd | long | イベントの終了日時 (UNIX時間 単位:ミリ秒) | ||||||||||
relativeTriggerName | string | {scheduleType} == “relative” | ✓ | ~ 128文字 | イベントのトリガー名 | |||||||
repeatSetting | RepeatSetting | ✓ | 繰り返し設定 |
RepeatSetting
繰り返し設定
イベント期間のうち、月曜日の 10:00 ~ 11:00 だけをイベント期間とするような設定をする際に利用します。
型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
repeatType | 文字列列挙型 enum { “always”, “daily”, “weekly”, “monthly”, “custom” } | ✓ | “always” | ~ 128文字 | 繰り返しの種類
| |||||||||||||||||
beginDayOfMonth | int | {repeatType} == “monthly” | ✓ | 1 ~ 31 | イベントの繰り返し開始日(月の日数を超える場合は、最終日として扱われます) | |||||||||||||||||
endDayOfMonth | int | {repeatType} == “monthly” | ✓ | 1 ~ 31 | イベントの繰り返し終了日(月の日数を超える場合は、最終日として扱われます) | |||||||||||||||||
beginDayOfWeek | 文字列列挙型 enum { “sunday”, “monday”, “tuesday”, “wednesday”, “thursday”, “friday”, “saturday” } | {repeatType} == “weekly” | ✓ | ~ 128文字 | イベントの繰り返し開始曜日
| |||||||||||||||||
endDayOfWeek | 文字列列挙型 enum { “sunday”, “monday”, “tuesday”, “wednesday”, “thursday”, “friday”, “saturday” } | {repeatType} == “weekly” | ✓ | ~ 128文字 | イベントの繰り返し終了曜日
| |||||||||||||||||
beginHour | int | {repeatType} in [“daily”, “weekly”, “monthly”] | ✓ | ~ 23 | イベントの繰り返し開始時間(単位:時) | |||||||||||||||||
endHour | int | {repeatType} in [“daily”, “weekly”, “monthly”] | ✓ | ~ 24 | イベントの繰り返し終了時間(単位:時) | |||||||||||||||||
anchorTimestamp | long | {repeatType} == “custom” | ✓ | サイクルを開始する基準日 (UNIX時間 単位:ミリ秒) | ||||||||||||||||||
activeDays | int | {repeatType} == “custom” | ✓ | 1 ~ 2147483646.0 | サイクル内のアクティブな日数 | |||||||||||||||||
inactiveDays | int | {repeatType} == “custom” | ✓ | ~ 2147483646.0 | サイクル内のインアクティブな日数 |
RepeatSchedule
スケジュールの繰り返し状態
型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|---|
repeatCount | int | ✓ | ~ 2147483646 | 繰り返し回数 | ||
currentRepeatStartAt | long | リピート中のイベントの開始日時 (UNIX時間 単位:ミリ秒) | ||||
currentRepeatEndAt | long | リピート中のイベントの終了日時 (UNIX時間 単位:ミリ秒) | ||||
lastRepeatEndAt | long | 前回のイベントの終了日時 (UNIX時間 単位:ミリ秒) | ||||
nextRepeatStartAt | long | 次回のイベントの開始日時 (UNIX時間 単位:ミリ秒) |