GS2-Mission マスターデータリファレンス
{
"version": "2019-05-28",
"groups": [
{
"name": "[string]ミッショングループ名",
"metadata": "[string?]メタデータ",
"tasks": [
{
"missionTaskId": "[string]ミッションタスクGRN",
"name": "[string]タスク名",
"metadata": "[string?]メタデータ",
"counterName": "[string]カウンター名",
"targetResetType": "[string?]目標リセットタイミング",
"targetValue": "[long]目標値",
"completeAcquireActions": [
{
"action": "[string]スタンプシートを使用して実行するアクションの種類",
"request": "[string]リクエストのJSON"
}
],
"challengePeriodEventId": "[string?]報酬が受け取り可能な期間を設定した GS2-Schedule イベントGRN",
"premiseMissionTaskName": "[string?]このタスクに挑戦するために達成しておく必要のあるタスクの名前"
}
],
"resetType": "[string]リセットタイミング",
"resetDayOfMonth": "[int]リセットをする日にち(月の日数を超える場合は、最終日として扱われます)",
"resetDayOfWeek": "[string]リセットする曜日",
"resetHour": "[int]リセット時刻",
"completeNotificationNamespaceId": "[string?]ネームスペースGRN"
}
],
"counters": [
{
"name": "[string]カウンター名",
"metadata": "[string?]メタデータ",
"scopes": [
{
"resetType": "[string]リセットタイミング",
"resetDayOfMonth": "[int]リセットをする日にち(月の日数を超える場合は、最終日として扱われます)",
"resetDayOfWeek": "[string]リセットする曜日",
"resetHour": "[int]リセット時刻"
}
],
"challengePeriodEventId": "[string?]カウンターの操作が可能な期間を設定した GS2-Schedule イベントGRN"
}
]
}
型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|---|
version | ✓ | 2019-05-28 | マスターデータのフォーマットバージョン | |||
groups | List<MissionGroupModel> | |||||
counters | List<CounterModel> |
CounterScopeModel
カウンターリセットタイミングモデル
型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|---|
resetType | enum [ “notReset”, “daily”, “weekly”, “monthly” ] | ✓ | ~ 128文字 | リセットタイミング | ||
resetDayOfMonth | int | {resetType} == “monthly” | ✓ | 1 ~ 31 | リセットをする日にち(月の日数を超える場合は、最終日として扱われます) | |
resetDayOfWeek | enum [ “sunday”, “monday”, “tuesday”, “wednesday”, “thursday”, “friday”, “saturday” ] | {resetType} == “weekly” | ✓ | ~ 128文字 | リセットする曜日 | |
resetHour | int | {resetType} in [“monthly”, “weekly”, “daily”] | ✓ | ~ 23 | リセット時刻 |
CounterModel
カウンターモデル
カウンターモデルはミッションタスクの達成条件に設定可能なエンティティです。 カウンターの値は複数のミッショングループから参照可能なため、1つのカウンターでウィークリーミッションとデイリーミッションといった複数のミッショングループの達成条件に設定ができます。
型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|---|
counterId | string | ✓ | ~ 1024文字 | カウンターモデルGRN | ||
name | string | ✓ | ~ 128文字 | カウンター名 | ||
metadata | string | ~ 1024文字 | メタデータ | |||
scopes | List<CounterScopeModel> | ✓ | [] | 1 ~ 100 items | カウンターのリセットタイミングリスト | |
challengePeriodEventId | string | ~ 1024文字 | カウンターの操作が可能な期間を設定した GS2-Schedule イベントGRN |
MissionGroupModel
ミッショングループモデル
ミッショングループはカウンターのリセットタイミングでタスクをグルーピングするエンティティです。 たとえば、デイリーミッションで1つのグループ。ウィークリーミッションで1つのグループとなります。
型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|---|
missionGroupId | string | ✓ | ~ 1024文字 | ミッショングループGRN | ||
name | string | ✓ | ~ 128文字 | ミッショングループ名 | ||
metadata | string | ~ 1024文字 | メタデータ | |||
tasks | List<MissionTaskModel> | ~ 1000 items | ミッションタスクリスト | |||
resetType | enum [ “notReset”, “daily”, “weekly”, “monthly” ] | ✓ | “notReset” | ~ 128文字 | リセットタイミング | |
resetDayOfMonth | int | {resetType} == “monthly” | ✓ | 1 ~ 31 | リセットをする日にち(月の日数を超える場合は、最終日として扱われます) | |
resetDayOfWeek | enum [ “sunday”, “monday”, “tuesday”, “wednesday”, “thursday”, “friday”, “saturday” ] | {resetType} == “weekly” | ✓ | ~ 128文字 | リセットする曜日 | |
resetHour | int | {resetType} in [“monthly”, “weekly”, “daily”] | ✓ | ~ 23 | リセット時刻 | |
completeNotificationNamespaceId | string | ~ 1024文字 | ネームスペースGRN |
MissionTaskModel
ミッションタスクモデル
ミッションタスクは関連付けたカウンターの値が一定を超えたら報酬が貰える条件を定義するエンティティです。
型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|---|
missionTaskId | string | ✓ | ~ 1024文字 | ミッションタスクGRN | ||
name | string | ✓ | ~ 128文字 | タスク名 | ||
metadata | string | ~ 1024文字 | メタデータ | |||
counterName | string | ✓ | ~ 128文字 | カウンター名 | ||
targetResetType | enum [ “notReset”, “daily”, “weekly”, “monthly” ] | ~ 128文字 | 目標リセットタイミング | |||
targetValue | long | ✓ | 1 ~ 9223372036854775805 | 目標値 | ||
completeAcquireActions | List<AcquireAction> | [] | ~ 100 items | ミッション達成時の報酬 | ||
challengePeriodEventId | string | ~ 1024文字 | 報酬が受け取り可能な期間を設定した GS2-Schedule イベントGRN | |||
premiseMissionTaskName | string | ~ 128文字 | このタスクに挑戦するために達成しておく必要のあるタスクの名前 |
ScopedValue
リセットタイミング
型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|---|
resetType | enum [ “notReset”, “daily”, “weekly”, “monthly” ] | ✓ | ~ 128文字 | リセットタイミング | ||
value | long | ✓ | 0 | ~ 9223372036854775805 | カウント | |
nextResetAt | long | 次回リセットタイミング | ||||
updatedAt | long | ✓ | 最終更新日時 |
AcquireAction
入手アクション