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 のイベント"
}
],
"needSignature": "[bool]判定するバージョン値に署名検証を必要とするか",
"signatureKeyId": "[string]暗号鍵GRN"
}
]
}
| 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
---|
version | ✓ | | 2019-10-09 | マスターデータのフォーマットバージョン | | |
versionModels | List<VersionModel> | | | | | |
VersionModel
バージョンモデル
ログインを受け入れるが、バージョンアップ出来ることを通知する警告バージョンと、ログインを受け入れないエラーバージョンを設定できます。
現在のバージョンをクライアントに申告させるのに、署名の有無を指定できます。
署名付きを選択した場合、クライアントは嘘のバージョン申告を出来なくなります。
| 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
---|
versionModelId | string | | ✓ | | ~ 1024文字 | バージョンモデルGRN |
name | string | | ✓ | | ~ 128文字 | バージョンモデル名 |
metadata | string | | | | ~ 2048文字 | メタデータ |
scope | enum [‘passive’, ‘active’] | | ✓ | | ~ 128文字 | 判定に使用するバージョン値の種類 |
type | enum [‘simple’, ‘schedule’] | | ✓ | “simple” | ~ 128文字 | バージョンチェックモード |
currentVersion | Version | {type} == “simple” and {scope} == “active” | ✓ | | | 現在のバージョン |
warningVersion | Version | {type} == “simple” | ✓ | | | バージョンアップを促すバージョン |
errorVersion | Version | {type} == “simple” | ✓ | | | バージョンチェックを蹴るバージョン |
scheduleVersions | List<ScheduleVersion> | {type} == “schedule” | | | | 時系列で切り替わるバージョンチェック内容リスト |
needSignature | bool | {scope} == “passive” | ✓ | | | 判定するバージョン値に署名検証を必要とするか |
signatureKeyId | string | {needSignature} != none and {needSignature} | ✓ | | ~ 1024文字 | 暗号鍵GRN |
Status
TargetVersion
| 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
---|
versionName | string | | ✓ | | ~ 128文字 | バージョンの名前 |
body | string | | | | ~ 1048576文字 | ボディ |
signature | string | | | | ~ 256文字 | 署名 |
version | Version | {signature} == "" | ✓ | | | バージョン |
SignTargetVersion
| 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
---|
region | string | | ✓ | | ~ 128文字 | リージョン |
namespaceName | string | | ✓ | | ~ 128文字 | ネームスペース名 |
versionName | string | | ✓ | | ~ 128文字 | バージョンモデル名 |
version | Version | | ✓ | | | バージョン |
Version
| 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
---|
major | int | | ✓ | | ~ 2147483646 | メジャーバージョン |
minor | int | | ✓ | | ~ 2147483646 | マイナーバージョン |
micro | int | | ✓ | | ~ 2147483646 | マイクロバージョン |
ScheduleVersion
| 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
---|
currentVersion | Version | | ✓ | | | 現在のバージョン |
warningVersion | Version | | ✓ | | | バージョンアップを促すバージョン |
errorVersion | Version | | ✓ | | | バージョンチェックを蹴るバージョン |
scheduleEventId | string | | | | ~ 1024文字 | バージョンチェックを有効化する期間を設定した GS2-Schedule のイベント |