イベントマスタフォーマット

イベントのマスターデータはGS2マネージメントコンソールでイベント情報を登録し、エクスポートすることで生成できます。

これによって、開発環境用のスケジュールと製品環境のスケジュールで同じデータを2度登録する手間を省けます。

また、エクスポートされるデータはただの JSON 形式のデータですので、GS2マネージメントコンソールを通さずに自作のツールでスケジュールマスタを作成することも可能です。

マスターデータは以下のフォーマットで定義されます。

{
  "version": "2017-12-01",
  "events": [
    {
      "name": "event-0001",
      "meta": "meta",
      "type": "absolute",
      "absoluteBegin": 0,
      "absoluteEnd": 1893456000
    },
    {
      "name": "event-0002",
      "meta": "meta2",
      "type": "relative",
      "relativeSpan": 3000,
      "relativeTriggerName": "trigger-0001"
    }
  ]
}

version には現時点では 『2017-12-01』 を指定してください。

将来フォーマットが変更されたときに読み込むフォーマットバージョンを確定するのに使用します。

events にはイベントのリストを定義します。

1つのスケジュールで最大10個のイベントを登録出来ます。

name にはイベントの名前を設定します。

GS2-SDK の DescribeEvent や GetEvent でイベントデータを取得する際に使用出来ます。

meta にはイベントの内容に関するメタ情報を256バイト以内の文字列で指定出来ます。

type にはイベントの期間の種類を指定します。

固定期間の場合は absolute。ユーザ毎に異なる期間を指定したい場合は relative を指定します。

absolute を指定した場合には追加で

absoluteBegin と absoluteEnd を指定する必要があります。これらは開始・終了日時を unixtime で指定します。

relative を指定した場合には追加で

relativeTriggerName と relativeSpan を指定する必要があります。

これらは、イベントの開始トリガーとなるトリガー名と、トリガーを引いてから何分間イベント開催期間とするかを指定します。