GS2-Schedule マスターデータリファレンス

マスターデータのフォーマットと インポートする各種モデルのリファレンス

マスターデータのフォーマット

{
  "version": "2019-03-31",
  "events": [
    {
      "name": "[string]イベント名",
      "metadata": "[string?]メタデータ",
      "scheduleType": "[string enum]イベント期間の種類",
      "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]サイクル内のインアクティブな日数"
      }
    }
  ]
}
有効化条件必須デフォルト値の制限説明
versionstring
2019-03-31マスターデータのフォーマットバージョン
eventsList<Event>~ 100 itemsイベント
イベントの期間は絶対期間と相対期間の2種類存在します。
絶対期間は 2021年1月1日 00:00(UTC) ~ 2021年1月7日 23:59(UTC) のような固定の期間で、
相対期間は トリガーを引いたタイミングから 24時間 のようなゲームプレイヤー毎に異なる期間をイベント期間とするものです。

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

モデル

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文字メタデータ
メタデータには任意の値を設定できます。
これらの値は GS2 の動作には影響しないため、ゲーム内で利用する情報の保存先として使用できます。
scheduleType文字列列挙型
enum {
  “absolute”,
  “relative”
}
イベント期間の種類
定義説明
“absolute”固定期間
“relative”プレイヤー別期間
absoluteBeginlongイベントの開始日時
absoluteEndlongイベントの終了日時
relativeTriggerNamestring{scheduleType} == “relative”
✓*
~ 128文字イベント開始トリガー名
ゲームプレイヤー毎にイベント期間を設定する (relative) 場合に、イベントの開始の起点とするトリガーの名前を指定します。
英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。

※ scheduleType が “relative” であれば 必須
repeatSettingRepeatSetting
繰り返し設定

RepeatSetting

繰り返し設定

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

有効化条件必須デフォルト値の制限説明
repeatType文字列列挙型
enum {
  “always”,
  “daily”,
  “weekly”,
  “monthly”,
  “custom”
}
“always”繰り返しの種類
定義説明
“always”イベント期間 常時
“daily”イベント期間のうち 毎日X時~X時
“weekly”イベント期間のうち 毎週 開始曜日~終了曜日 X時~X時
“monthly”イベント期間のうち 毎月 開始日~終了日 X時~X時
“custom”基準日から始まり、イベント期間中、X日アクティブ、Y日インアクティブを繰り返す
beginDayOfMonthint{repeatType} == “monthly”
✓*
1 ~ 31イベントの繰り返し開始日(月の日数を超える場合は、最終日として扱われます)
※ repeatType が “monthly” であれば 必須
endDayOfMonthint{repeatType} == “monthly”
✓*
1 ~ 31イベントの繰り返し終了日(月の日数を超える場合は、最終日として扱われます)
※ repeatType が “monthly” であれば 必須
beginDayOfWeek文字列列挙型
enum {
  “sunday”,
  “monday”,
  “tuesday”,
  “wednesday”,
  “thursday”,
  “friday”,
  “saturday”
}
{repeatType} == “weekly”
✓*
イベントの繰り返し開始曜日
定義説明
“sunday”日曜日
“monday”月曜日
“tuesday”火曜日
“wednesday”水曜日
“thursday”木曜日
“friday”金曜日
“saturday”土曜日

※ repeatType が “weekly” であれば 必須
endDayOfWeek文字列列挙型
enum {
  “sunday”,
  “monday”,
  “tuesday”,
  “wednesday”,
  “thursday”,
  “friday”,
  “saturday”
}
{repeatType} == “weekly”
✓*
イベントの繰り返し終了曜日
定義説明
“sunday”日曜日
“monday”月曜日
“tuesday”火曜日
“wednesday”水曜日
“thursday”木曜日
“friday”金曜日
“saturday”土曜日

※ repeatType が “weekly” であれば 必須
beginHourint{repeatType} in [“daily”, “weekly”, “monthly”]
✓*
0 ~ 23イベントの繰り返し開始時間(単位:時)
※ repeatType が “daily”,“weekly”,“monthly"であれば 必須
endHourint{repeatType} in [“daily”, “weekly”, “monthly”]
✓*
0 ~ 24イベントの繰り返し終了時間(単位:時)
※ repeatType が “daily”,“weekly”,“monthly"であれば 必須
anchorTimestamplong{repeatType} == “custom”
✓*
サイクルを開始する基準日
※ repeatType が “custom” であれば 必須
activeDaysint{repeatType} == “custom”
✓*
1 ~ 2147483646サイクル内のアクティブな日数
※ repeatType が “custom” であれば 必須
inactiveDaysint{repeatType} == “custom”
✓*
0 ~ 2147483646サイクル内のインアクティブな日数
※ repeatType が “custom” であれば 必須