GS2-Schedule
GS2-Deploy のテンプレートで使用できるリソース定義のリファレンス
GS2-Deploy リファレンス
エンティティ
Namespace
Namespace
Type: GS2::Schedule::Namespace
Properties:
Name: namespace1
Description: null
LogSetting:
LoggingNamespaceId: grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001
ネームスペース
ネームスペースは一つのプロジェクトで同じサービスを異なる用途で複数利用できるようにするための仕組みです。
GS2 のサービスは基本的にネームスペースというレイヤーがあり、ネームスペースが異なれば同じサービスでもまったく別のデータ空間として取り扱われます。
そのため、各サービスの利用を開始するにあたってネームスペースを作成する必要があります。
型 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|
name | string | ✓ | ~ 32文字 | ネームスペース名 | |
description | string | ~ 1024文字 | 説明文 | ||
logSetting | LogSetting | ログの出力設定 |
EventMaster
EventMaster
Type: GS2::Schedule::EventMaster
Properties:
NamespaceName: namespace1
Name: event-0001
Description: null
Metadata: null
ScheduleType: absolute
AbsoluteBegin: 10000
AbsoluteEnd: 20000
RepeatType: null
RepeatBeginDayOfMonth: 1
RepeatEndDayOfMonth: 2
RepeatBeginDayOfWeek: monday
RepeatEndDayOfWeek: sunday
RepeatBeginHour: 5
RepeatEndHour: 6
RelativeTriggerName: trigger-0001
RelativeDuration: 10000
イベントマスター
イベントの期間は絶対期間と相対期間の2種類存在します。
絶対期間は 2021年1月1日 00:00(UTC) ~ 2021年1月7日 23:59(UTC) のような固定の期間で、
相対期間は トリガーを引いたタイミングから 24時間 のようなゲームプレイヤー毎に異なる期間をイベント期間とするものです。
イベントには開催期間だけでなく、繰り返しが設定できるようになっており
イベント期間のうち、月曜日の 10:00 ~ 11:00 だけをイベント期間とするような設定も可能です。
型 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|
namespaceName | string | ✓ | ~ 32文字 | ネームスペース名 | |
name | string | ✓ | ~ 128文字 | イベントの種類名 | |
description | string | ~ 1024文字 | 説明文 | ||
metadata | string | ~ 2048文字 | メタデータ | ||
scheduleType | string | ✓ | ~ 128文字 | イベント期間の種類 | |
absoluteBegin | long | {scheduleType} == "absolute" | イベントの開始日時 | ||
absoluteEnd | long | {scheduleType} == "absolute" | イベントの終了日時 | ||
repeatType | string | {scheduleType} == "absolute" | "always" | ~ 128文字 | 繰り返しの種類 |
repeatBeginDayOfMonth | int | {repeatType} == "monthly" | 1 ~ 31 | イベントの繰り返し開始日 | |
repeatEndDayOfMonth | int | {repeatType} == "monthly" | 1 ~ 31 | イベントの繰り返し終了日 | |
repeatBeginDayOfWeek | string | {repeatType} == "weekly" | ~ 128文字 | イベントの繰り返し開始曜日 | |
repeatEndDayOfWeek | string | {repeatType} == "weekly" | ~ 128文字 | イベントの繰り返し終了曜日 | |
repeatBeginHour | int | {repeatType} in ["daily", "weekly", "monthly"] | ~ 23 | イベントの繰り返し開始時間 | |
repeatEndHour | int | {repeatType} in ["daily", "weekly", "monthly"] | ~ 23 | イベントの繰り返し終了時間 | |
relativeTriggerName | string | {scheduleType} == "relative" | ~ 128文字 | イベントの開始トリガー名 | |
relativeDuration | int | {scheduleType} == "relative" | ~ 2147483646 | イベントの開催期間(秒) |
CurrentEventMaster
CurrentEventMaster
Type: GS2::Schedule::CurrentEventMaster
Properties:
NamespaceName: namespace1
Settings: {
"version": "2019-03-31",
"events": [
{
"name": "event-0001",
"metadata": "EVENT_0001",
"scheduleType": "absolute",
"absoluteBegin": 10000,
"absoluteEnd": 20000
},
{
"name": "event-0002",
"metadata": "EVENT_0002",
"scheduleType": "relative",
"relativeTriggerName": "trigger-0001",
"relativeDuration": 30000
},
{
"name": "daily-0001",
"metadata": "EVENT_0003",
"scheduleType": "absolute",
"absoluteBegin": 1569369600000,
"absoluteEnd": 1569456000000,
"repeatType": "daily",
"repeatBeginHour": 1,
"repeatEndHour": 2
},
{
"name": "daily-0002",
"metadata": "EVENT_0004",
"scheduleType": "absolute",
"absoluteBegin": 1569369600000,
"absoluteEnd": 1569456000000,
"repeatType": "daily",
"repeatBeginHour": 3,
"repeatEndHour": 1
},
{
"name": "weekly-0001",
"metadata": "EVENT_0005",
"scheduleType": "absolute",
"absoluteBegin": 1569888000000,
"absoluteEnd": 1570406400000,
"repeatType": "weekly",
"repeatBeginDayOfWeek": "tuesday",
"repeatEndDayOfWeek": "wednesday",
"repeatBeginHour": 1,
"repeatEndHour": 2
},
{
"name": "weekly-0002",
"metadata": "EVENT_0006",
"scheduleType": "absolute",
"absoluteBegin": 1569888000000,
"absoluteEnd": 1570406400000,
"repeatType": "weekly",
"repeatBeginDayOfWeek": "wednesday",
"repeatEndDayOfWeek": "tuesday",
"repeatBeginHour": 3,
"repeatEndHour": 1
},
{
"name": "monthly-0001",
"metadata": "EVENT_0007",
"scheduleType": "absolute",
"absoluteBegin": 1570406400000,
"absoluteEnd": 1575158400000,
"repeatType": "monthly",
"repeatBeginDayOfMonth": 10,
"repeatEndDayOfMonth": 15,
"repeatBeginHour": 1,
"repeatEndHour": 2
},
{
"name": "monthly-0002",
"metadata": "EVENT_0008",
"scheduleType": "absolute",
"absoluteBegin": 1570406400000,
"absoluteEnd": 1575158400000,
"repeatType": "monthly",
"repeatBeginDayOfMonth": 16,
"repeatEndDayOfMonth": 9,
"repeatBeginHour": 3,
"repeatEndHour": 0
}
]
}
現在有効なマスターデータ
GS2ではマスターデータの管理にJSON形式のファイルを使用します。
ファイルをアップロードすることで、実際にサーバーに設定を反映することができます。
JSONファイルを作成する方法として、マネージメントコンソール上でのマスターデータエディタを提供していますが
よりゲームの運営に相応しいツールを作成し、適切なフォーマットのJSONファイルを書き出すことでもサービスを利用可能です。
JSONファイルの形式についてはドキュメントを参照ください。
型 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|
namespaceName | string | ✓ | ~ 32文字 | ネームスペース名 | |
settings | string | ✓ | ~ 5242880文字 | マスターデータ |