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"
    }
  ]
}
有効化条件必須デフォルト値の制限説明
version2019-05-28マスターデータのフォーマットバージョン
groupsList<MissionGroupModel>
countersList<CounterModel>

CounterScopeModel

有効化条件必須デフォルト値の制限説明
resetTypeenum [’notReset’, ‘daily’, ‘weekly’, ‘monthly’]~ 128文字リセットタイミング
resetDayOfMonthint{resetType} == “monthly”1 ~ 31リセットをする日にち(月の日数を超える場合は、最終日として扱われます)
resetDayOfWeekenum [‘sunday’, ‘monday’, ’tuesday’, ‘wednesday’, ’thursday’, ‘friday’, ‘saturday’]{resetType} == “weekly”~ 128文字リセットする曜日
resetHourint{resetType} in [“monthly”, “weekly”, “daily”]~ 23リセット時刻

CounterModel

カウンターモデル

カウンターモデルはミッションタスクの達成条件に設定可能なエンティティです。 カウンターの値は複数のミッショングループから参照可能なため、1つのカウンターでウィークリーミッションとデイリーミッションといった複数のミッショングループの達成条件に設定ができます。

有効化条件必須デフォルト値の制限説明
counterIdstring~ 1024文字カウンターモデルGRN
namestring~ 128文字カウンター名
metadatastring~ 1024文字メタデータ
scopesList<CounterScopeModel>[]カウンターのリセットタイミングリスト
challengePeriodEventIdstring~ 1024文字カウンターの操作が可能な期間を設定した GS2-Schedule イベントGRN

MissionGroupModel

ミッショングループモデル

ミッショングループはカウンターのリセットタイミングでタスクをグルーピングするエンティティです。 たとえば、デイリーミッションで1つのグループ。ウィークリーミッションで1つのグループとなります。

有効化条件必須デフォルト値の制限説明
missionGroupIdstring~ 1024文字ミッショングループGRN
namestring~ 128文字ミッショングループ名
metadatastring~ 1024文字メタデータ
tasksList<MissionTaskModel>ミッションタスクリスト
resetTypeenum [’notReset’, ‘daily’, ‘weekly’, ‘monthly’]“notReset”~ 128文字リセットタイミング
resetDayOfMonthint{resetType} == “monthly”1 ~ 31リセットをする日にち(月の日数を超える場合は、最終日として扱われます)
resetDayOfWeekenum [‘sunday’, ‘monday’, ’tuesday’, ‘wednesday’, ’thursday’, ‘friday’, ‘saturday’]{resetType} == “weekly”~ 128文字リセットする曜日
resetHourint{resetType} in [“monthly”, “weekly”, “daily”]~ 23リセット時刻
completeNotificationNamespaceIdstring~ 1024文字ネームスペースGRN

MissionTaskModel

ミッションタスクモデル

ミッションタスクは関連付けたカウンターの値が一定を超えたら報酬が貰える条件を定義するエンティティです。

有効化条件必須デフォルト値の制限説明
missionTaskIdstring~ 1024文字ミッションタスクGRN
namestring~ 128文字タスク名
metadatastring~ 1024文字メタデータ
counterNamestring~ 128文字カウンター名
targetResetTypeenum [’notReset’, ‘daily’, ‘weekly’, ‘monthly’]~ 128文字目標リセットタイミング
targetValuelong1 ~ 9223372036854775805目標値
completeAcquireActionsList<AcquireAction>[]ミッション達成時の報酬
challengePeriodEventIdstring~ 1024文字報酬が受け取り可能な期間を設定した GS2-Schedule イベントGRN
premiseMissionTaskNamestring~ 128文字このタスクに挑戦するために達成しておく必要のあるタスクの名前

ScopedValue

有効化条件必須デフォルト値の制限説明
resetTypeenum [’notReset’, ‘daily’, ‘weekly’, ‘monthly’]~ 128文字リセットタイミング
valuelong0~ 9223372036854775805カウント
nextResetAtlong次回リセットタイミング
updatedAtlong最終更新日時

AcquireAction

有効化条件必須デフォルト値の制限説明
actionenum []~ 128文字スタンプシートを使用して実行するアクションの種類
requeststring~ 1048576文字リクエストのJSON