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

{
  "version": "2019-10-09",
  "versionModels": [
    {
      "name": "[string]バージョンモデル名",
      "metadata": "[string?]メタデータ",
      "scope": "[string]判定に使用するバージョン値の種類",
      "type": "[string]バージョンチェックモード",
      "currentVersion": {
        "major": "[int]メジャーバージョン",
        "minor": "[int]マイナーバージョン",
        "micro": "[int]マイクロバージョン"
      },
      "warningVersion": {
        "major": "[int]メジャーバージョン",
        "minor": "[int]マイナーバージョン",
        "micro": "[int]マイクロバージョン"
      },
      "errorVersion": {
        "major": "[int]メジャーバージョン",
        "minor": "[int]マイナーバージョン",
        "micro": "[int]マイクロバージョン"
      },
      "scheduleVersions": [
        {
          "currentVersion": {
            "major": "[int]メジャーバージョン",
            "minor": "[int]マイナーバージョン",
            "micro": "[int]マイクロバージョン"
          },
          "warningVersion": {
            "major": "[int]メジャーバージョン",
            "minor": "[int]マイナーバージョン",
            "micro": "[int]マイクロバージョン"
          },
          "errorVersion": {
            "major": "[int]メジャーバージョン",
            "minor": "[int]マイナーバージョン",
            "micro": "[int]マイクロバージョン"
          },
          "scheduleEventId": "[string?]バージョンチェックを有効化する期間を設定した GS2-Schedule のイベントGRN"
        }
      ],
      "needSignature": "[bool]判定するバージョン値に署名検証を必要とするか",
      "signatureKeyId": "[string]暗号鍵GRN",
      "approveRequirement": "[string]承認の必要性"
    }
  ]
}
有効化条件必須デフォルト値の制限説明
version2019-10-09マスターデータのフォーマットバージョン
versionModelsList<VersionModel>~ 100 itemsバージョンモデル

VersionModel

バージョンモデル

ログインを受け入れるが、バージョンアップ出来ることを通知する警告バージョンと、ログインを受け入れないエラーバージョンを設定できます。

現在のバージョンをクライアントに申告させるのに、署名の有無を指定できます。
署名付きを選択した場合、クライアントは嘘のバージョン申告を出来なくなります。

有効化条件必須デフォルト値の制限説明
versionModelIdstring~ 1024文字バージョンモデルGRN
namestring~ 128文字バージョンモデル名
metadatastring~ 2048文字メタデータ
scopeenum {
    “passive”,
    “active”
}
~ 128文字判定に使用するバージョン値の種類
typeenum {
    “simple”,
    “schedule”
}
“simple”~ 128文字バージョンチェックモード
currentVersionVersion{type} == “simple” and {scope} == “active”現在のバージョン
warningVersionVersion{type} == “simple”バージョンアップを促すバージョン
errorVersionVersion{type} == “simple”バージョンチェックでエラーになるバージョン
scheduleVersionsList<ScheduleVersion>{type} == “schedule”~ 10 items時系列で切り替わるバージョンチェック内容リスト
needSignaturebool{scope} == “passive”判定するバージョン値に署名検証を必要とするか
signatureKeyIdstring{needSignature}~ 1024文字暗号鍵GRN
approveRequirementenum {
    “required”,
    “optional”
}
{scope} == “active”“required”~ 128文字承認の必要性

scope に指定する列挙型の定義

定義説明
passiveクライアントから送信
active過去明示的に承認したバージョン

type に指定する列挙型の定義

定義説明
simpleシンプル
schedule時系列切り替え

approveRequirement に指定する列挙型の定義

定義説明
required承認が必要
optional任意の承認

Status

バージョンの状態

バージョンの検証結果を表します。

有効化条件必須デフォルト値の制限説明
versionModelVersionModelバージョンモデル
currentVersionVersion現在のバージョン

TargetVersion

検証するバージョン

有効化条件必須デフォルト値の制限説明
versionNamestring~ 128文字バージョンモデル名
bodystring~ 1048576文字ボディ
signaturestring~ 256文字署名
versionVersion{signature} == ""バージョン

SignTargetVersion

署名対象バージョン

有効化条件必須デフォルト値の制限説明
regionstring~ 128文字リージョン
namespaceNamestring~ 128文字ネームスペース名
versionNamestring~ 128文字バージョンモデル名
versionVersionバージョン

Version

バージョン

有効化条件必須デフォルト値の制限説明
majorint~ 2147483646メジャーバージョン
minorint~ 2147483646マイナーバージョン
microint~ 2147483646マイクロバージョン

ScheduleVersion

時系列で切り替わるバージョン

有効化条件必須デフォルト値の制限説明
currentVersionVersion現在のバージョン
warningVersionVersionバージョンアップを促すバージョン
errorVersionVersionバージョンチェックでエラーになるバージョン
scheduleEventIdstring~ 1024文字バージョンチェックを有効化する期間を設定した GS2-Schedule のイベントGRN