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

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

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

{
  "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種類存在します。
絶対期間は 例えば YYYY年MM月DD日 00:00(UTC) ～ YYYY年MM月DD日 23:59(UTC) のような固定の期間で、
相対期間は トリガーを引いたタイミングから 24時間 のようなゲームプレイヤー毎に異なる期間をイベント期間とするものです。

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

モデル

Event

イベント

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

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

型有効化条件必須デフォルト値の制限説明
eventIdstring
※
~ 1024文字GS2-Schedule イベント GRN
※ サーバーが自動で設定
namestring
✓
~ 128文字イベント名
イベント固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。
metadatastring~ 2048文字メタデータ
メタデータには任意の値を設定できます。
これらの値は GS2 の動作には影響しないため、ゲーム内で利用する情報の保存先として使用できます。
scheduleType文字列列挙型
enum {
  “absolute”,
  “relative”
}
✓
スケジュールタイプ
イベント期間の定義方法を決定します。
“absolute” は全プレイヤー共通の固定開始・終了タイムスタンプを使用します。
“relative” はプレイヤーごとのトリガーを起点として使用し、パーソナライズされたイベント期間を実現します（例: 各プレイヤーの初回ログインから24時間）。
定義説明
“absolute”固定期間
“relative”プレイヤー毎に異なる期間
absoluteBeginlong絶対開始日時
絶対スケジューリングにおけるイベント期間の固定開始時刻。
全プレイヤーが同じ開始時刻を共有します。絶対イベントで未設定の場合、イベントは過去から開始されているものとして扱われます。
UNIX 時間（ミリ秒）で表現されます。
absoluteEndlong絶対終了日時
絶対スケジューリングにおけるイベント期間の固定終了時刻。
全プレイヤーが同じ終了時刻を共有します。絶対イベントで未設定の場合、イベントは終了しないものとして扱われます。
UNIX 時間（ミリ秒）で表現されます。
relativeTriggerNamestring{scheduleType} == “relative”
✓※
~ 128文字イベント開始トリガー名
ゲームプレイヤー毎にイベント期間を設定する (relative) 場合に、イベントの開始の起点とするトリガーの名前を指定します。
英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。
※ scheduleType が “relative” であれば 必須
repeatSettingRepeatSetting
✓
繰り返し設定
イベント期間内の繰り返し有効時間枠の設定。
アクティブ期間を特定の時間帯、曜日、月の日付、またはカスタムのアクティブ/インアクティブ日サイクルに絞り込むことができます。
繰り返しパターンなしでイベント期間全体を通してアクティブにするには repeatType を “always” に設定します。

RepeatSetting

繰り返し設定

イベント全体期間内の繰り返し有効時間枠を設定します。
5種類の繰り返しタイプをサポートします: “always”（イベント期間全体）、“daily”（毎日の特定時間帯）、“weekly”（毎週の特定曜日範囲＋時間帯）、
“monthly”（毎月の特定日範囲＋時間帯）、“custom”（基準日からのアクティブ/インアクティブ日数の交互サイクル）。
daily/weekly/monthly タイプで beginHour と endHour が同じ場合、終了時刻は翌日の同時刻として扱われます（つまり24時間フルウィンドウ）。

型有効化条件必須デフォルト値の制限説明
repeatType文字列列挙型
enum {
  “always”,
  “daily”,
  “weekly”,
  “monthly”,
  “custom”
}
“always”繰り返しの種類
イベント期間内に適用する繰り返しパターンのタイプ。
タイプによって必要な追加フィールドが異なります: daily/weekly/monthly は時間設定、weekly は曜日、monthly は日付、custom は基準日と日数が必要です。
未指定の場合は “always” がデフォルトとなります。
定義説明
“always”イベント期間中 常時有効
“daily”イベント期間のうち 毎日X時～X時
“weekly”イベント期間のうち 毎週 開始曜日～終了曜日 X時～X時
“monthly”イベント期間のうち 毎月 開始日～終了日 X時～X時
“custom”基準日から始まり、イベント期間中、X日アクティブ、Y日インアクティブを繰り返す
beginDayOfMonthint{repeatType} == “monthly”
✓※
1 ~ 31繰り返し開始日
繰り返しウィンドウが開始する月の日（1～31）。
指定した値がその月の日数を超える場合、その月の最終日として扱われます。
repeatType が “monthly” の場合のみ適用されます。
※ repeatType が “monthly” であれば 必須
endDayOfMonthint{repeatType} == “monthly”
✓※
1 ~ 31繰り返し終了日
繰り返しウィンドウが終了する月の日（1～31）。
指定した値がその月の日数を超える場合、その月の最終日として扱われます。
repeatType が “monthly” の場合のみ適用されます。
※ repeatType が “monthly” であれば 必須
beginDayOfWeek文字列列挙型
enum {
  “sunday”,
  “monday”,
  “tuesday”,
  “wednesday”,
  “thursday”,
  “friday”,
  “saturday”
}
{repeatType} == “weekly”
✓※
繰り返し開始曜日
繰り返しウィンドウが開始する曜日。
ウィンドウは週の境界をまたぐことができます（例: 金曜日～月曜日）。repeatType が “weekly” の場合のみ適用されます。
定義説明
“sunday”日曜日
“monday”月曜日
“tuesday”火曜日
“wednesday”水曜日
“thursday”木曜日
“friday”金曜日
“saturday”土曜日
※ repeatType が “weekly” であれば 必須
endDayOfWeek文字列列挙型
enum {
  “sunday”,
  “monday”,
  “tuesday”,
  “wednesday”,
  “thursday”,
  “friday”,
  “saturday”
}
{repeatType} == “weekly”
✓※
繰り返し終了曜日
繰り返しウィンドウが終了する曜日。
beginDayOfWeek と組み合わせて週間アクティブ期間を定義します。repeatType が “weekly” の場合のみ適用されます。
定義説明
“sunday”日曜日
“monday”月曜日
“tuesday”火曜日
“wednesday”水曜日
“thursday”木曜日
“friday”金曜日
“saturday”土曜日
※ repeatType が “weekly” であれば 必須
beginHourint{repeatType} in [“daily”, “weekly”, “monthly”]
✓※
0 ~ 23繰り返し開始時（時）
各サイクルで繰り返しウィンドウが開始する時刻（UTC、0～23）。
daily、weekly、monthly の繰り返しタイプで必須です。beginHour と endHour が同じ場合、ウィンドウは24時間（翌日の同時刻まで）となります。
※ repeatType が “daily”,“weekly”,“monthly"であれば 必須
endHourint{repeatType} in [“daily”, “weekly”, “monthly”]
✓※
0 ~ 24繰り返し終了時（時）
各サイクルで繰り返しウィンドウが終了する時刻（UTC、0～24）。
24 を指定すると翌日の深夜0時を表します。daily、weekly、monthly の繰り返しタイプで必須です。
※ repeatType が “daily”,“weekly”,“monthly"であれば 必須
anchorTimestamplong{repeatType} == “custom”
✓※
基準タイムスタンプ
カスタムのアクティブ/インアクティブサイクルが開始する基準日。
システムはこの基準日からの経過日数に基づいて、現在時刻がどのフェーズ（アクティブまたはインアクティブ）にあるかを計算します。
repeatType が “custom” の場合のみ適用されます。UNIX 時間（ミリ秒）で表現します。
※ repeatType が “custom” であれば 必須
activeDaysint{repeatType} == “custom”
✓※
1 ~ 2147483646アクティブ日数
カスタムサイクルの各周期でイベントがアクティブとなる連続日数。
アクティブ日数の後、inactiveDays で指定された日数だけイベントが非アクティブとなり、サイクルが繰り返されます。
repeatType が “custom” の場合のみ適用されます。最小1日。
※ repeatType が “custom” であれば 必須
inactiveDaysint{repeatType} == “custom”
✓※
0 ~ 2147483646インアクティブ日数
カスタムサイクルの各周期でイベントが非アクティブとなる連続日数。
アクティブ日数の後に続きます。ギャップなしの連続アクティブイベントにするには 0 を設定します。
repeatType が “custom” の場合のみ適用されます。最小0日。
※ repeatType が “custom” であれば 必須