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]サイクル内のインアクティブな日数"
      }
    }
  ]
}
有効化条件必須デフォルト値の制限説明
version2019-03-31マスターデータのフォーマットバージョン
eventsList<Event>~ 100 itemsイベント

Event

イベント

イベントの期間は絶対期間と相対期間の2種類存在します。
絶対期間は 2021年1月1日 00:00(UTC) ~ 2021年1月7日 23:59(UTC) のような固定の期間で、
相対期間は トリガーを引いたタイミングから 24時間 のようなゲームプレイヤー毎に異なる期間をイベント期間とするものです。

イベントには開催期間だけでなく、繰り返しが設定できるようになっており
イベント期間のうち、月曜日の 10:00 ~ 11:00 だけをイベント期間とするような設定も可能です。

有効化条件必須デフォルト値の制限説明
eventIdstring~ 1024文字GS2-Schedule イベントGRN
namestring~ 128文字イベントの種類名
metadatastring~ 2048文字メタデータ
scheduleTypeenum {
    “absolute”,
    “relative”
}
~ 128文字イベント期間の種類
absoluteBeginlongイベントの開始日時 (UNIX時間 単位:ミリ秒)
absoluteEndlongイベントの終了日時 (UNIX時間 単位:ミリ秒)
relativeTriggerNamestring{scheduleType} == “relative”~ 128文字イベントのトリガー名
repeatSettingRepeatSetting繰り返し設定

scheduleType に指定する列挙型の定義

定義説明
absolute固定期間
relativeプレイヤー別期間

RepeatSetting

繰り返し設定

イベント期間のうち、月曜日の 10:00 ~ 11:00 だけをイベント期間とするような設定をする際に利用します。

有効化条件必須デフォルト値の制限説明
repeatTypeenum {
    “always”,
    “daily”,
    “weekly”,
    “monthly”,
    “custom”
}
“always”~ 128文字繰り返しの種類
beginDayOfMonthint{repeatType} == “monthly”1 ~ 31イベントの繰り返し開始日(月の日数を超える場合は、最終日として扱われます)
endDayOfMonthint{repeatType} == “monthly”1 ~ 31イベントの繰り返し終了日(月の日数を超える場合は、最終日として扱われます)
beginDayOfWeekenum {
    “sunday”,
    “monday”,
    “tuesday”,
    “wednesday”,
    “thursday”,
    “friday”,
    “saturday”
}
{repeatType} == “weekly”~ 128文字イベントの繰り返し開始曜日
endDayOfWeekenum {
    “sunday”,
    “monday”,
    “tuesday”,
    “wednesday”,
    “thursday”,
    “friday”,
    “saturday”
}
{repeatType} == “weekly”~ 128文字イベントの繰り返し終了曜日
beginHourint{repeatType} in [“daily”, “weekly”, “monthly”]~ 23イベントの繰り返し開始時間(単位:時)
endHourint{repeatType} in [“daily”, “weekly”, “monthly”]~ 24イベントの繰り返し終了時間(単位:時)
anchorTimestamplong{repeatType} == “custom”サイクルを開始する基準日 (UNIX時間 単位:ミリ秒)
activeDaysint{repeatType} == “custom”1 ~ 2147483646.0サイクル内のアクティブな日数
inactiveDaysint{repeatType} == “custom”1 ~ 2147483646.0サイクル内のインアクティブな日数

repeatType に指定する列挙型の定義

定義説明
alwaysイベント期間 常時
dailyイベント期間のうち 毎日X時~X時
weeklyイベント期間のうち 毎週X曜日 X時~X時
monthlyイベント期間のうち 毎月X日 X時~X時
custom基準日から始まり、イベント期間中、X日アクティブ、Y日インアクティブを繰り返す

beginDayOfWeek に指定する列挙型の定義

定義説明
sunday日曜日
monday月曜日
tuesday火曜日
wednesday水曜日
thursday木曜日
friday金曜日
saturday土曜日

endDayOfWeek に指定する列挙型の定義

定義説明
sunday日曜日
monday月曜日
tuesday火曜日
wednesday水曜日
thursday木曜日
friday金曜日
saturday土曜日

RepeatSchedule

スケジュールの繰り返し状態

有効化条件必須デフォルト値の制限説明
repeatCountint~ 2147483646繰り返し回数
currentRepeatStartAtlongリピート中のイベントの開始日時 (UNIX時間 単位:ミリ秒)
currentRepeatEndAtlongリピート中のイベントの終了日時 (UNIX時間 単位:ミリ秒)
lastRepeatEndAtlong前回のイベントの終了日時 (UNIX時間 単位:ミリ秒)
nextRepeatStartAtlong次回のイベントの開始日時 (UNIX時間 単位:ミリ秒)