/ja/tags/master-data/ Recent content in Master Data on Game Server Services | Docs Hugo ja /ja/articles/master_data/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/articles/master_data/ 用語の定義 用語 意味 モデルマスター マスターデータエディタが一時的に登録する ゲームプレイヤーごとに変わらないデータ モデル ゲーム内から使用する ゲームプレイヤーごとに変わらないデータ プロパティ モデルをもとに作成したゲームプレイヤーごとに異なるデータ ゲームを構成する要素には、所持アイテムのパラメータやクエストの構成データなど、 ゲームプレイヤーごとには変わらないデータがあります。 このようなデータをGS2では モデル と呼んでいます。 そして、モデルをもとにゲームプレイヤーの所持するデータになったものを プロパティ と呼んでいます。 一般的なマスターデータは GS2 においては モデル にあたり、GS2 においては モデルマスター という概念が存在します。 モデル / モデルマスター の違いは、データの内容は同一ですが、実際にゲームからアクセスされる状態にあるかどうか、という違いがあります。 graph TD subgraph "管理用データ" Master[モデルマスター] end subgraph "実行用データ" Model[モデル] end subgraph "プレイヤーデータ" Property[プロパティ] end Master -- "エクスポート/反映 (Current)" --> Model Model -- "インスタンス化" --> Property GS2 の管理画面上で編集できるデータは モデルマスター で、それを実際にゲーム内から使用できる状態に変換すると モデル に変わります。 この変換の工程が必要な理由は、 モデルマスター に対する変更を一括してゲーム内に反映するためです。 この工程がない場合、管理画面でデータを更新していく過程で、途中のデータがゲーム内に反映されてしまうことになります。 マスターデータの作成 この変換工程は、すべての モデルマスター を一旦 JSON 形式のファイルにエクスポートし、そのJSONファイルをアップロードすることで一括して モデル として反映する仕組みになっています。 GS2 の管理画面で モデルマスター を操作して JSON 形式のファイルにエクスポートして利用しても構いませんが、Excel や独自の管理ツールを作成し GS2 上に モデルマスター を一切登録せずに モデル にデータを反映することもできます。 /ja/api_reference/account/master_data/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/account/master_data/ マスターデータのフォーマット JSON { "version": "2024-07-30", "takeOverTypeModels": [ { "type": "[int]スロット番号", "metadata": "[string?]メタデータ", "openIdConnectSetting": { "configurationPath": "[string]OpenID Connect 設定 URL", "clientId": "[string]クライアントID", "clientSecret": "[string]クライアントシークレット", "appleTeamId": "[string]Apple Developer チームID", "appleKeyId": "[string]Apple に登録済みのキーID", "applePrivateKeyPem": "[string]Apple から受け取った秘密鍵", "doneEndpointUrl": "[string?]認証完了時に遷移するURL", "additionalScopeValues": [ { "key": "[string]名前", "value": "[string?]値" } ], "additionalReturnValues": [ "[string]OpenID Connect で取得する追加の返却値" ] } } ] } 型 有効化条件 必須 デフォルト 値の制限 説明 version string ✓ 2024-07-30 マスターデータのフォーマットバージョン takeOverTypeModels List<TakeOverTypeModel> ~ 1000 items 引き継ぎ情報タイプモデル引き継ぎ情報を定義するモデルです。引き継ぎ情報とは、デバイスの機種変更やプラットフォーム間のアカウントの移動・共有時に使用する情報です。個人を識別するユニークな文字列とパスワードで構成され、その適切な組み合わせを入力することで、Account(匿名アカウント)を取得することができます。1つの Account に対して複数の引き継ぎ情報を設定できます。複数の引き継ぎ情報を設定するにはそれぞれ異なるスロットを指定する必要があります。スロットには0～1024を指定できますので、最大1025種類の引き継ぎ情報を設定可能です。具体的な用例としては 0 には Sign in with Apple のアカウント情報を、1 には Google のアカウント情報を保存するようにする。というような使い方が想定されています。あくまでこの引き継ぎ情報はデータホルダーであり、ソーシャルアカウントとの認証の仕組みは別途用意する必要があります。 モデル TakeOverTypeModel 引き継ぎ情報タイプモデル /ja/api_reference/buff/master_data/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/buff/master_data/ マスターデータのフォーマット JSON { "version": "2024-04-15", "buffEntryModels": [ { "name": "[string]バフエントリーモデル名", "metadata": "[string?]メタデータ", "expression": "[string (enum)]バフの適用タイプ", "targetType": "[string (enum)]バフを適用する対象の種類", "targetModel": { "targetModelName": "[string]バフを適用するモデルの種類", "targetFieldName": "[string]バフの適用対象フィールド名", "conditionGrns": [ { "targetModelName": "[string]バフの適用条件のモデル名", "targetGrn": "[string]バフの適用条件GRN" } ], "rate": "[float]補正レート" }, "targetAction": { "targetActionName": "[string]バフを適用するアクションの種類", "targetFieldName": "[string]バフの適用対象フィールド名", "conditionGrns": [ { "targetModelName": "[string]バフの適用条件のモデル名", "targetGrn": "[string]バフの適用条件GRN" } ], "rate": "[float]レート" }, "priority": "[int]バフの適用優先度", "applyPeriodScheduleEventId": "[string?]バフを適用するイベントの開催期間GRN" } ] } 型 有効化条件 必須 デフォルト 値の制限 説明 version string ✓ 2024-04-15 マスターデータのフォーマットバージョン buffEntryModels List<BuffEntryModel> ~ 100 items バフエントリーモデルバフの適用量はバフエントリーモデルで管理し、同一の対象に対して複数のバフエントリーモデルを関連づけることが可能です。バフエントリーモデルの適用順番はバフエントリーモデルの priority で管理し、priority の値が小さいほど優先度が高くなります。バフの適用方式は3種類存在し「Rate Add」、「Mul」と「Value Add」があります。Rate Add はバフの適用レートに加算する命令、Mul はバフの適用レートに乗算する命令です。Value Add はバフの補正計算後の値に加算を行う命令です。たとえば、デフォルトのレートが 1. /ja/api_reference/chat/master_data/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/chat/master_data/ マスターデータのフォーマット JSON { "version": "2020-04-30", "categoryModels": [ { "category": "[int]カテゴリー", "rejectAccessTokenPost": "[string (enum)?]プレイヤーのアクセストークンを利用した投稿を拒否する" } ] } 型 有効化条件 必須 デフォルト 値の制限 説明 version string ✓ 2020-04-30 マスターデータのフォーマットバージョン categoryModels List<CategoryModel> ~ 1000 items カテゴリーモデルカテゴリーモデルは、チャットルームに投稿されるメッセージを分類するためのカテゴリーを定義します。各カテゴリーは数値で識別され、カテゴリーごとにプレイヤーのアクセストークンを使った投稿を許可するか拒否するかを設定できます。これにより、サーバーのみが投稿可能なシステムアナウンスカテゴリーなどのユースケースを実現できます。 モデル CategoryModel カテゴリーモデル カテゴリーモデルは、チャットルームに投稿されるメッセージを分類するためのカテゴリーを定義します。 各カテゴリーは数値で識別され、カテゴリーごとにプレイヤーのアクセストークンを使った投稿を許可するか拒否するかを設定できます。 これにより、サーバーのみが投稿可能なシステムアナウンスカテゴリーなどのユースケースを実現できます。 型 有効化条件 必須 デフォルト 値の制限 説明 categoryModelId string ※ ~ 1024文字 カテゴリーモデル GRN ※ サーバーが自動で設定 category int ✓ 0 ~ 2147483645 カテゴリーメッセージカテゴリーの数値識別子です。このカテゴリー番号で投稿されたメッセージは、プレイヤーの投稿を許可するかなど、このモデルで定義されたルールに従います。 rejectAccessTokenPost 文字列列挙型 enum { “Enabled”, “Disabled” } プレイヤーのアクセストークンを利用した投稿を拒否する有効にすると、このカテゴリーではサーバーサイドの API 呼び出し（ユーザーID指定）のみがメッセージを投稿できます。プレイヤーが直接投稿すべきでないシステムアナウンスやサーバー生成メッセージに有用です。定義説明“Enabled”アクセストークンを利用した投稿を拒否する“Disabled”アクセストークンを利用した投稿を許可する /ja/api_reference/dictionary/master_data/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/dictionary/master_data/ マスターデータのフォーマット JSON { "version": "2020-04-30", "entryModels": [ { "name": "[string]エントリーモデル名", "metadata": "[string?]メタデータ" } ] } 型 有効化条件 必須 デフォルト 値の制限 説明 version string ✓ 2020-04-30 マスターデータのフォーマットバージョン entryModels List<EntryModel> ~ 10000 items エントリーモデルエントリーモデルは、GS2-Dictionary において図鑑に記録可能な対象を定義するマスターデータです。各エントリーモデルは、モンスターやアイテム、アバターパーツなど、図鑑に記録されるエンティティの種類を表します。エントリーの所持状態は「記録済み / 未記録」の2値で管理され、同一エントリーモデルに対して数量やスタックの概念はありません。 モデル EntryModel エントリーモデル エントリーモデルは、GS2-Dictionary において図鑑に記録可能な対象を定義するマスターデータです。 各エントリーモデルは、モンスターやアイテム、アバターパーツなど、図鑑に記録されるエンティティの種類を表します。 エントリーの所持状態は「記録済み / 未記録」の2値で管理され、同一エントリーモデルに対して数量やスタックの概念はありません。 型 有効化条件 必須 デフォルト 値の制限 説明 entryModelId string ※ ~ 1024文字 エントリーモデル GRN ※ サーバーが自動で設定 name string ✓ ~ 128文字 エントリーモデル名 metadata string ~ 2048文字 メタデータメタデータには任意の値を設定できます。これらの値は GS2 の動作には影響しないため、ゲーム内で利用する情報の保存先として使用できます。 /ja/api_reference/distributor/master_data/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/distributor/master_data/ マスターデータのフォーマット JSON { "version": "2019-03-01", "distributorModels": [ { "name": "[string]配信モデル名", "metadata": "[string?]メタデータ", "inboxNamespaceId": "[string?]あふれたリソースを転送する GS2-Inbox のネームスペースGRN", "whiteListTargetIds": [ "[string]GS2-Distributorを通して処理出来る対象のリソースGRNプレフィックス" ] } ] } 型 有効化条件 必須 デフォルト 値の制限 説明 version string ✓ 2019-03-01 マスターデータのフォーマットバージョン distributorModels List<DistributorModel> ~ 100 items 配信モデル配信モデルとはリソースの入手時に所持枠を超えて入手した時のポリシーを設定するエンティティです。GS2-Distributor を通して入手処理を行うことで、あふれたリソースを GS2-Inbox のメッセージとして転送することができます。 モデル DistributorModel 配信モデル 配信モデルとはリソースの入手時に所持枠を超えて入手した時のポリシーを設定するエンティティです。 GS2-Distributor を通して入手処理を行うことで、あふれたリソースを GS2-Inbox のメッセージとして転送することができます。 型 有効化条件 必須 デフォルト 値の制限 説明 distributorModelId string ※ ~ 1024文字 配信モデル GRN ※ サーバーが自動で設定 name string ✓ ~ 128文字 配信モデル名配信モデル固有の名前。英数字および -(ハイフン) _(アンダースコア) . /ja/api_reference/enchant/master_data/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/enchant/master_data/ マスターデータのフォーマット JSON { "version": "2023-07-18", "balanceParameterModels": [ { "name": "[string]バランスパラメータモデル名", "metadata": "[string?]メタデータ", "totalValue": "[long]合計値", "initialValueStrategy": "[string (enum)]初期値の設定方針", "parameters": [ { "name": "[string]名前", "metadata": "[string?]メタデータ" } ] } ], "rarityParameterModels": [ { "name": "[string]レアリティパラメータモデル名", "metadata": "[string?]メタデータ", "maximumParameterCount": "[int]付与するパラメータの最大数", "parameterCounts": [ { "count": "[int]付与数", "weight": "[int]排出重み" } ], "parameters": [ { "name": "[string]名前", "metadata": "[string?]メタデータ", "resourceName": "[string]ゲーム内で使用するパラメータリソースの種類を表す名前（GS2の動作のためには使用しません）", "resourceValue": "[long]ゲーム内で使用するパラメータリソースの値（GS2の動作のためには使用しません）", "weight": "[int]排出重み" } ] } ] } 型 有効化条件 必須 デフォルト 値の制限 説明 version string ✓ 2023-07-18 マスターデータのフォーマットバージョン balanceParameterModels List<BalanceParameterModel> ~ 10000 items バランスパラメータモデルバランスパラメータの抽選条件を定義します。バランスパラメータは固定の合計値を複数のパラメータスロットに分配します。例えば、合計パワーが100の武器に対して ATK=60、DEF=30、SPD=10 のように配分されます。初期値の設定方針により値の割り当て方法が決まります：average は均等に分配し、lottery は合計値をランダムに配分します。 rarityParameterModels List<RarityParameterModel> ~ 10000 items レアリティパラメータモデルレアリティパラメータの抽選条件を定義します。レアリティパラメータは重み付き抽選システムを使用して、付与されるパラメータの数と割り当てられる具体的な値の両方を決定します。まず、付与数モデルのリストから重み付き抽選により埋めるパラメータスロット数が決定されます。次に、各スロットの値がパラメータ値モデルのリストから重み付き抽選で選択され、制御された確率分布によるランダムな装備属性を提供します。 モデル BalanceParameterModel バランスパラメータモデル /ja/api_reference/enhance/master_data/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/enhance/master_data/ マスターデータのフォーマット JSON { "version": "2020-08-22", "rateModels": [ { "name": "[string]強化レートモデル名", "description": "[string?]説明文", "metadata": "[string?]メタデータ", "targetInventoryModelId": "[string]強化対象に使用できる GS2-Inventory インベントリモデルの GRN", "acquireExperienceSuffix": "[string]GS2-Experience で入手した経験値を格納するプロパティID に付与するサフィックス", "materialInventoryModelId": "[string]強化の素材に使用できる GS2-Inventory インベントリモデル GRN", "acquireExperienceHierarchy": [ "[string]ItemModelのメタデータに格納する、入手経験値を定義するJSONデータの階層構造の定義" ], "experienceModelId": "[string]強化の結果得られる GS2-Experience 経験値モデル GRN", "bonusRates": [ { "rate": "[float]経験値ボーナスの倍率 (1.0 = ボーナスなし)", "weight": "[int]抽選重み" } ] } ], "unleashRateModels": [ { "name": "[string]限界突破レートモデル名", "description": "[string?]説明文", "metadata": "[string?]メタデータ", "targetInventoryModelId": "[string]限界突破対象に使用できる GS2-Inventory インベントリモデル GRN", "gradeModelId": "[string]グレードモデル GRN", "gradeEntries": [ { " /ja/api_reference/exchange/master_data/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/exchange/master_data/ マスターデータのフォーマット JSON { "version": "2019-08-19", "rateModels": [ { "name": "[string]交換レートモデル名", "metadata": "[string?]メタデータ", "verifyActions": [ { "action": "[string]検証アクションで実行するアクションの種類", "request": "[string]アクション実行時に使用されるリクエストのJSON文字列" } ], "consumeActions": [ { "action": "[string]消費アクションで実行するアクションの種類", "request": "[string]アクション実行時に使用されるリクエストのJSON文字列" } ], "timingType": "[string (enum)]交換の種類", "lockTime": "[int]交換実行から実際に報酬を受け取れるようになるまでの待ち時間（分）", "acquireActions": [ { "action": "[string]入手アクションで実行するアクションの種類", "request": "[string]アクション実行時に使用されるリクエストのJSON文字列" } ] } ], "incrementalRateModels": [ { "name": "[string]コスト上昇型交換レートモデルの名前", "metadata": "[string?]メタデータ", "consumeAction": { "action": "[string]消費アクションで実行するアクションの種類", "request": "[string]アクション実行時に使用されるリクエストのJSON文字列" }, "calculateType": "[string (enum)]コスト上昇量の計算方式", "baseValue": "[long]ベース値", "coefficientValue": "[long]係数", "calculateScriptId": "[string]コスト計算スクリプトのGRN", "exchangeCountId": " /ja/api_reference/experience/master_data/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/experience/master_data/ マスターデータのフォーマット JSON { "version": "2019-01-11", "experienceModels": [ { "name": "[string]経験値モデル名", "metadata": "[string?]メタデータ", "defaultExperience": "[long]経験値の初期値", "defaultRankCap": "[long]ランクキャップの初期値", "maxRankCap": "[long]ランクキャップの最大値", "rankThreshold": { "metadata": "[string?]メタデータ", "values": [ "[long]ランクアップ経験値閾値" ] }, "acquireActionRates": [ { "name": "[string]報酬加算テーブル名", "mode": "[string]報酬加算テーブルの種類", "rates": [ "[double]加算量(倍率)" ], "bigRates": [ "[string]加算量(倍率)" ] } ] } ] } 型 有効化条件 必須 デフォルト 値の制限 説明 version string ✓ 2019-01-11 マスターデータのフォーマットバージョン experienceModels List<ExperienceModel> ~ 100 items 経験値モデル経験値とランクシステムのルールを定義します。ランクアップに必要な経験値の閾値、デフォルトのランクキャップ、最大ランクキャップを設定します。ランクキャップはステータスが到達できる最大ランクを制限し、ステータスごとに最大ランクキャップまで引き上げることができます（例: 限界突破）。オプションで、現在のランクに基づいて報酬倍率を調整する入手アクションレートテーブルを含めることができます。 モデル ExperienceModel 経験値モデル 経験値とランクシステムのルールを定義します。ランクアップに必要な経験値の閾値、デフォルトのランクキャップ、最大ランクキャップを設定します。ランクキャップはステータスが到達できる最大ランクを制限し、ステータスごとに最大ランクキャップまで引き上げることができます（例: 限界突破）。オプションで、現在のランクに基づいて報酬倍率を調整する入手アクションレートテーブルを含めることができます。 /ja/api_reference/formation/master_data/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/formation/master_data/ マスターデータのフォーマット JSON { "version": "2019-09-09", "moldModels": [ { "name": "[string]フォームの保存領域モデルの名前", "metadata": "[string?]メタデータ", "initialMaxCapacity": "[int]フォームを保存できる初期キャパシティ", "maxCapacity": "[int]フォームを保存できる最大キャパシティ", "formModel": { "formModelId": "[string]フォームモデルGRN", "name": "[string]フォームモデル名", "metadata": "[string?]メタデータ", "slots": [ { "name": "[string]スロットモデル名", "propertyRegex": "[string]プロパティとして設定可能な値の正規表現", "metadata": "[string?]メタデータ" } ] } } ], "propertyFormModels": [ { "name": "[string]プロパティフォームモデル名", "metadata": "[string?]メタデータ", "slots": [ { "name": "[string]スロットモデル名", "propertyRegex": "[string]プロパティとして設定可能な値の正規表現", "metadata": "[string?]メタデータ" } ] } ] } 型 有効化条件 必須 デフォルト 値の制限 説明 version string ✓ 2019-09-09 マスターデータのフォーマットバージョン moldModels List<MoldModel> ~ 100 items フォームの保存領域モデルフォームの保存領域モデルは、パーティ編成であれば「火属性パーティ」「水属性パーティ」のような形で保存することを想定しています。保存できる領域の数は制限することができ、個別に拡張することもできます。 propertyFormModels List<PropertyFormModel> ~ 100 items プロパティフォームモデルプロパティフォームモデルは編成状況を表すエンティティです。Mold / Form との違いは、スロット数を定義して、各スロットに編成を記録するのが Mold / Form で、所有している装備に対してスキルを設定するような、数を事前に決めるのが難しい編成を表現するのに利用するのがプロパティフォームモデルです。 モデル FormModel フォームモデル /ja/api_reference/grade/master_data/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/grade/master_data/ マスターデータのフォーマット JSON { "version": "2023-12-25", "gradeModels": [ { "name": "[string]グレードモデル名", "metadata": "[string?]メタデータ", "defaultGrades": [ { "propertyIdRegex": "[string]プロパティID正規表現", "defaultGradeValue": "[long]デフォルトのグレード値" } ], "experienceModelId": "[string]GS2-Experience 経験値モデルGRN", "gradeEntries": [ { "metadata": "[string?]メタデータ", "rankCapValue": "[long]ランクキャップ値", "propertyIdRegex": "[string]プロパティID正規表現", "gradeUpPropertyIdRegex": "[string]グレードアップ用プロパティID正規表現" } ], "acquireActionRates": [ { "name": "[string]報酬加算テーブル名", "mode": "[string]報酬加算テーブルの種類", "rates": [ "[double]倍率値" ], "bigRates": [ "[string]倍率値（ビッグナンバー）" ] } ] } ] } 型 有効化条件 必須 デフォルト 値の制限 説明 version string ✓ 2023-12-25 マスターデータのフォーマットバージョン gradeModels List<GradeModel> ~ 100 items グレードモデルグレードモデルとは、キャラクターや装備のランクを示すエンティティで、グレードによって GS2-Experience のランクキャップを設定することができます。 モデル GradeModel グレードモデル /ja/api_reference/guild/master_data/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/guild/master_data/ マスターデータのフォーマット JSON { "version": "2024-04-25", "guildModels": [ { "name": "[string]ギルドモデル名", "metadata": "[string?]メタデータ", "defaultMaximumMemberCount": "[int]デフォルト最大メンバー数", "maximumMemberCount": "[int]最大メンバー数上限", "inactivityPeriodDays": "[int]無活動期間（日数）", "roles": [ { "name": "[string]ロールモデル名", "metadata": "[string?]メタデータ", "policyDocument": "[string]ポリシードキュメント" } ], "guildMasterRole": "[string]ギルドマスターロール名", "guildMemberDefaultRole": "[string]デフォルトメンバーロール名", "rejoinCoolTimeMinutes": "[int]再参加クールタイム（分）", "maxConcurrentJoinGuilds": "[int?]同時参加可能ギルド最大数", "maxConcurrentGuildMasterCount": "[int?]同時存在可能ギルドマスター最大数" } ] } 型 有効化条件 必須 デフォルト 値の制限 説明 version string ✓ 2024-04-25 マスターデータのフォーマットバージョン guildModels List<GuildModel> ~ 100 items ギルドモデルギルドモデルとは、ギルドの加入可能最大人数の設定や、ギルド内での役職ごとの権限設定を持つエンティティです。 モデル GuildModel ギルドモデル ギルドモデルとは、ギルドの加入可能最大人数の設定や、ギルド内での役職ごとの権限設定を持つエンティティです。 型 有効化条件 必須 デフォルト 値の制限 説明 guildModelId string ※ ~ 1024文字 ギルドモデル GRN ※ サーバーが自動で設定 name string ✓ ~ 128文字 ギルドモデル名ギルドモデル固有の名前。英数字および -(ハイフン) _(アンダースコア) . /ja/api_reference/idle/master_data/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/idle/master_data/ マスターデータのフォーマット JSON { "version": "2023-06-06", "categoryModels": [ { "name": "[string]カテゴリーモデル名", "metadata": "[string?]メタデータ", "rewardIntervalMinutes": "[int]報酬間隔（分）", "defaultMaximumIdleMinutes": "[int]デフォルト最大放置時間（分）", "rewardResetMode": "[string (enum)]報酬リセットモード", "acquireActions": [ { "acquireActions": [ { "action": "[string]入手アクションで実行するアクションの種類", "request": "[string]アクション実行時に使用されるリクエストのJSON文字列" } ] } ], "idlePeriodScheduleId": "[string?]放置期間スケジュールID", "receivePeriodScheduleId": "[string?]受取期間スケジュールID" } ] } 型 有効化条件 必須 デフォルト 値の制限 説明 version string ✓ 2023-06-06 マスターデータのフォーマットバージョン categoryModels List<CategoryModel> ~ 100 items カテゴリーモデルカテゴリーモデルとは、放置報酬を得られる待機カテゴリーを設定するエンティティです。設定には、待機時間ごとの報酬や、最大待機時間などの情報が含まれます。 モデル CategoryModel カテゴリーモデル カテゴリーモデルとは、放置報酬を得られる待機カテゴリーを設定するエンティティです。 設定には、待機時間ごとの報酬や、最大待機時間などの情報が含まれます。 型 有効化条件 必須 デフォルト 値の制限 説明 categoryModelId string ※ ~ 1024文字 カテゴリーモデル GRN ※ サーバーが自動で設定 name string ✓ ~ 128文字 カテゴリーモデル名カテゴリーモデル固有の名前。英数字および -(ハイフン) _(アンダースコア) . /ja/api_reference/inbox/master_data/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/inbox/master_data/ マスターデータのフォーマット JSON { "version": "2020-03-12", "globalMessages": [ { "name": "[string]グローバルメッセージ名", "metadata": "[string]メタデータ", "readAcquireActions": [ { "action": "[string]入手アクションで実行するアクションの種類", "request": "[string]アクション実行時に使用されるリクエストのJSON文字列" } ], "expiresTimeSpan": { "days": "[int]日数", "hours": "[int]時間", "minutes": "[int]分" }, "messageReceptionPeriodEventId": "[string?]メッセージ受信期間イベントID" } ] } 型 有効化条件 必須 デフォルト 値の制限 説明 version string ✓ 2020-03-12 マスターデータのフォーマットバージョン globalMessages List<GlobalMessage> ~ 1000 items グローバルメッセージグローバルメッセージはゲームプレイヤー全体にメッセージを届ける仕組みです。グローバルメッセージには有効期間を設定でき、各ゲームプレイヤーはグローバルメッセージを受信する処理を実行することで有効期間内のグローバルメッセージの中で未受信のメッセージを自分のメッセージボックスにコピーします。 モデル GlobalMessage グローバルメッセージ グローバルメッセージはゲームプレイヤー全体にメッセージを届ける仕組みです。 グローバルメッセージには有効期間を設定でき、各ゲームプレイヤーはグローバルメッセージを受信する処理を実行することで 有効期間内のグローバルメッセージの中で未受信のメッセージを自分のメッセージボックスにコピーします。 型 有効化条件 必須 デフォルト 値の制限 説明 globalMessageId string ※ ~ 1024文字 全ユーザーに向けたメッセージ GRN ※ サーバーが自動で設定 name string ✓ ~ 128文字 グローバルメッセージ名グローバルメッセージ固有の名前。英数字および -(ハイフン) _(アンダースコア) . /ja/api_reference/inventory/master_data/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/inventory/master_data/ マスターデータのフォーマット JSON { "version": "2019-02-05", "inventoryModels": [ { "name": "[string]インベントリモデル名", "metadata": "[string?]メタデータ", "initialCapacity": "[int]初期サイズ", "maxCapacity": "[int]最大サイズ", "protectReferencedItem": "[bool?]参照元保護", "itemModels": [ { "itemModelId": "[string]アイテムモデルGRN", "name": "[string]アイテムモデル名", "metadata": "[string?]メタデータ", "stackingLimit": "[long]スタック可能な最大数量", "allowMultipleStacks": "[bool]複数スタック許可", "sortValue": "[int]表示順番" } ] } ], "simpleInventoryModels": [ { "name": "[string]シンプルインベントリモデル名", "metadata": "[string?]メタデータ", "simpleItemModels": [ { "itemModelId": "[string]シンプルアイテムモデルGRN", "name": "[string]シンプルアイテムモデル名", "metadata": "[string?]メタデータ" } ] } ], "bigInventoryModels": [ { "name": "[string]巨大インベントリモデル名", "metadata": "[string?]メタデータ", "bigItemModels": [ { "itemModelId": "[string]巨大アイテムモデルGRN", "name": " /ja/api_reference/limit/master_data/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/limit/master_data/ マスターデータのフォーマット JSON { "version": "2019-04-05", "limitModels": [ { "name": "[string]回数制限モデル名", "metadata": "[string?]メタデータ", "resetType": "[string (enum)]リセットタイミング", "resetDayOfMonth": "[int]リセット日", "resetDayOfWeek": "[string (enum)]リセット曜日", "resetHour": "[int]リセット時刻", "anchorTimestamp": "[long]経過日数のカウントをする基準日時", "days": "[int]リセットする日数" } ] } 型 有効化条件 必須 デフォルト 値の制限 説明 version string ✓ 2019-04-05 マスターデータのフォーマットバージョン limitModels List<LimitModel> ~ 100 items 回数制限モデル回数制限モデルには、使用回数をリセットするタイミングを設定できます。リセット間隔は 「毎日」「毎週」「毎月」「リセットしない」「一定日数」の 5 種類から選択できます。また、回数制限の最大値はマスターデータ側では固定しません。これは、ゲーム内のコンテキストに応じて、許可される最大回数を動的に変化させるためです。たとえばステップアップガチャのように、- 購入回数カウンターが 3 回未満 の場合に購入できる商品- 上記の商品が購入できない場合に、購入回数カウンターが 5 回未満 なら購入できる別の商品といったように、状況に応じて「最大回数」を切り替えられる設計を想定しています。 モデル LimitModel 回数制限モデル 回数制限モデルには、使用回数をリセットするタイミングを設定できます。 リセット間隔は 「毎日」「毎週」「毎月」「リセットしない」「一定日数」の 5 種類から選択できます。 また、回数制限の最大値はマスターデータ側では固定しません。 これは、ゲーム内のコンテキストに応じて、許可される最大回数を動的に変化させるためです。 たとえばステップアップガチャのように、 購入回数カウンターが 3 回未満 の場合に購入できる商品 /ja/api_reference/login_reward/master_data/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/login_reward/master_data/ マスターデータのフォーマット JSON { "version": "2023-07-11", "bonusModels": [ { "name": "[string]ログインボーナスモデル名", "metadata": "[string?]メタデータ", "mode": "[string (enum)]モード", "periodEventId": "[string?]期間イベントGRN", "resetHour": "[int]リセット時間（UTC）", "repeat": "[string (enum)]繰り返し", "rewards": [ { "acquireActions": [ { "action": "[string]入手アクションで実行するアクションの種類", "request": "[string]アクション実行時に使用されるリクエストのJSON文字列" } ] } ], "missedReceiveRelief": "[string (enum)]取り逃がし救済機能", "missedReceiveReliefVerifyActions": [ { "action": "[string]検証アクションで実行するアクションの種類", "request": "[string]アクション実行時に使用されるリクエストのJSON文字列" } ], "missedReceiveReliefConsumeActions": [ { "action": "[string]消費アクションで実行するアクションの種類", "request": "[string]アクション実行時に使用されるリクエストのJSON文字列" } ] } ] } 型 有効化条件 必須 デフォルト 値の制限 説明 version string ✓ 2023-07-11 マスターデータのフォーマットバージョン bonusModels List<BonusModel> ~ 100 items ログインボーナスモデルログインボーナスモデルにはログインボーナスの配布スケジュールを設定します。配布スケジュールには《スケジュールモード》と《ストリーミングモード》があります。スケジュールモードでは、GS2-Schedule のイベントの指定が必須で、そのイベントの開始日からの経過日数でボーナスの配布を行います。途中で撮り逃しが発生した場合、その分のボーナスは配布されません。ストリーミングモードでは、毎日ボーナスに設定された報酬を先頭から順番に配布します。ストリーミングモードでは繰り返しの設定が可能です。その場合、ストリームの終端に達した場合、先頭から再度配布を行います。スケジュールモード・ストリーミングモード 共に、取り逃がしの救済機能があります。一定のコストを支払うことで、取り逃がしたボーナスを受け取ることができます。ただし、GS2-Schedule のイベントが関連づけられている場合、イベントの開始日からの経過日数より先のボーナスは受け取ることができません。取り逃がし機能はストリーミングモードかつ繰り返しが有効な場合は使用することができません。スケジュールモード・ストリーミングモード 共に、設定可能なボーナスの最大日数は100日です。 モデル BonusModel ログインボーナスモデル /ja/api_reference/lottery/master_data/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/lottery/master_data/ マスターデータのフォーマット JSON { "version": "2019-02-21", "lotteryModels": [ { "name": "[string]抽選モデル名", "metadata": "[string?]メタデータ", "mode": "[string (enum)]抽選モード", "method": "[string (enum)]抽選方法", "prizeTableName": "[string]排出確率テーブルの名前", "choicePrizeTableScriptId": "[string]排出確率テーブルを決定する GS2-Script のスクリプトGRN" } ], "prizeTables": [ { "name": "[string]排出確率テーブル名", "metadata": "[string?]メタデータ", "prizes": [ { "prizeId": "[string]景品ID", "type": "[string]景品の種類", "acquireActions": [ { "action": "[string]入手アクションで実行するアクションの種類", "request": "[string]アクション実行時に使用されるリクエストのJSON文字列" } ], "drawnLimit": "[int?]最大排出数", "limitFailOverPrizeId": "[string]制限時フェイルオーバー景品ID", "prizeTableName": "[string]排出確率テーブルの名前", "weight": "[int]排出重み" } ] } ] } 型 有効化条件 必須 デフォルト 値の制限 説明 version string ✓ 2019-02-21 マスターデータのフォーマットバージョン lotteryModels List<LotteryModel> ~ 100 items 抽選モデル抽選モデルは排出方式や排出テーブルの参照方法を定義するエンティティです。排出方式は2種類用意されており、通常抽選は毎回一定の確率で抽選をする方式、Box抽選は箱の中にあらかじめ定義された数量の景品が入っており、抽選するたびに箱から景品を取り出していく抽選方式です。抽選処理を行うにあたって、排出確率テーブルを利用しますが、GS2-Script を使用すれば複数回抽選を実行した際に排出確率テーブルを一部だけ異なるテーブルに差し替えることができます。この仕組みを利用することで、10連ガチャで1回だけ異なる抽選確率テーブルを適用することが可能となります。 prizeTables List<PrizeTable> ~ 100 items 排出確率テーブル景品には、入手アクションを指定するか、別の排出確率テーブルを参照させることもできます。排出確率テーブルを入れ子にすることで、たとえば 1段目で SSR / SR / R などのレアリティを抽選し、2段目でそのレアリティに対応した具体的なコンテンツを抽選するといった設定が可能です。この仕組みにより、ゲーム全体としてのレアリティ別排出確率を調整しやすくなります。 モデル PrizeTable 排出確率テーブル /ja/api_reference/matchmaking/master_data/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/matchmaking/master_data/ マスターデータのフォーマット JSON { "version": "2020-06-24", "ratingModels": [ { "name": "[string]レーティングモデル名", "metadata": "[string?]メタデータ", "initialValue": "[int]レート値の初期値", "volatility": "[int]レーティングのボラティリティ" } ], "seasonModels": [ { "name": "[string]シーズンモデル名", "metadata": "[string?]メタデータ", "maximumParticipants": "[int]最大参加人数", "experienceModelId": "[string?]ティアー管理用の経験値モデルGRN", "challengePeriodEventId": "[string]チャレンジ期間イベントGRN" } ] } 型 有効化条件 必須 デフォルト 値の制限 説明 version string ✓ 2020-06-24 マスターデータのフォーマットバージョン ratingModels List<RatingModel> ~ 50 items レーティングモデルGS2 ではレーティングアルゴリズムとして Glicko-2 を採用しています。Glicko-2 には複数のパラメータがありますが、GS2-Matchmaking ではそれらを総合的に表す ボラティリティ という1つのパラメータに集約しています。ボラティリティ は変化の大きさを表すパラメータで、値が大きいほどレーティングの値の変動量が大きくなります。 seasonModels List<SeasonModel> ~ 50 items シーズンモデルシーズンマッチメイキングにおいて、一定期間有効な永続ギャザリングの期間・最大参加人数・ティアー連携設定を定義するマスターデータです。GS2-Schedule により期間を管理し、必要に応じて GS2-Experience と連携して同一ティアー内で永続ギャザリングを形成します。 モデル RatingModel レーティングモデル /ja/api_reference/mega_field/master_data/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/mega_field/master_data/ マスターデータのフォーマット JSON { "version": "2022-08-28", "areaModels": [ { "name": "[string]エリアモデル名", "metadata": "[string?]メタデータ", "layerModels": [ { "layerModelId": "[string]レイヤーモデルGRN", "name": "[string]レイヤーモデル名", "metadata": "[string?]メタデータ" } ] } ] } 型 有効化条件 必須 デフォルト 値の制限 説明 version string ✓ 2022-08-28 マスターデータのフォーマットバージョン areaModels List<AreaModel> ~ 50 items エリアは空間を分割するもので、同じ座標でもエリアが異なれば別空間として扱うことができます。 モデル AreaModel エリアは空間を分割するもので、同じ座標でもエリアが異なれば別空間として扱うことができます。 型 有効化条件 必須 デフォルト 値の制限 説明 areaModelId string ※ ~ 1024文字 エリアモデル GRN ※ サーバーが自動で設定 name string ✓ ~ 128文字 エリアモデル名 metadata string ~ 2048文字 メタデータメタデータには任意の値を設定できます。これらの値は GS2 の動作には影響しないため、ゲーム内で利用する情報の保存先として使用できます。 layerModels List<LayerModel> [] 0 ~ 1000 items レイヤーモデル一覧 LayerModel レイヤーは1つの空間内で複数の論理階層を実現します。 /ja/api_reference/mission/master_data/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/mission/master_data/ マスターデータのフォーマット JSON { "version": "2019-05-28", "groups": [ { "name": "[string]ミッショングループモデル名", "metadata": "[string?]メタデータ", "tasks": [ { "missionTaskId": "[string]ミッションタスクGRN", "name": "[string]ミッションタスクモデル名", "metadata": "[string?]メタデータ", "verifyCompleteType": "[string]達成条件種別", "targetCounter": { "counterName": "[string]カウンターモデル名", "scopeType": "[string]スコープの種類", "resetType": "[string?]目標リセットタイミング", "conditionName": "[string]条件名", "value": "[long]目標値" }, "verifyCompleteConsumeActions": [ { "action": "[string]検証アクションで実行するアクションの種類", "request": "[string]アクション実行時に使用されるリクエストのJSON文字列" } ], "completeAcquireActions": [ { "action": "[string]入手アクションで実行するアクションの種類", "request": "[string]アクション実行時に使用されるリクエストのJSON文字列" } ], "challengePeriodEventId": "[string?]報酬が受け取り可能な期間を設定した GS2-Schedule イベントGRN", "premiseMissionTaskName": "[string?]このタスクに挑戦するために達成しておく必要のあるタスクの名前", "counterName": "[string]カウンターモデル名", "targetResetType": "[string?]目標リセットタイミング", "targetValue": "[long]目標値" } ], "resetType": "[string (enum)]リセットタイミング" /ja/api_reference/money2/master_data/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/money2/master_data/ マスターデータのフォーマット JSON { "version": "2024-06-20", "storeContentModels": [ { "name": "[string]ストアコンテンツモデル名", "metadata": "[string?]メタデータ", "appleAppStore": { "productId": "[string?]プロダクトID" }, "googlePlay": { "productId": "[string?]プロダクトID" } } ], "storeSubscriptionContentModels": [ { "name": "[string]ストア定期課金コンテンツモデル名", "metadata": "[string?]メタデータ", "scheduleNamespaceId": "[string]サブスクリプション期間を連動させる GS2-Schedule のネームスペースGRN", "triggerName": "[string]サブスクリプション期間を反映するトリガー名", "triggerExtendMode": "[string (enum)]サブスクリプション期間をトリガーに反映する時のモード", "rollupHour": "[int]日跨ぎの時刻 (UTC)", "reallocateSpanDays": "[int]サブスクリプションの契約情報を他のユーザーに割り当て可能となる期間（日）", "appleAppStore": { "subscriptionGroupIdentifier": "[string?]サブスクリプショングループID" }, "googlePlay": { "productId": "[string?]プロダクトID" } } ] } 型 有効化条件 必須 デフォルト 値の制限 説明 version string ✓ 2024-06-20 マスターデータのフォーマットバージョン storeContentModels List<StoreContentModel> ~ 1000 items ストアコンテンツモデル各種ストアプラットフォームのコンテンツを格納するモデルです。 storeSubscriptionContentModels List<StoreSubscriptionContentModel> ~ 1000 items ストア定期課金コンテンツモデル各種ストアプラットフォームの定期課金コンテンツを格納するモデルです。 モデル StoreContentModel ストアコンテンツモデル /ja/api_reference/quest/master_data/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/quest/master_data/ マスターデータのフォーマット JSON { "version": "2019-05-14", "groups": [ { "name": "[string]クエストグループモデル名", "metadata": "[string?]メタデータ", "quests": [ { "questModelId": "[string]クエストモデルGRN", "name": "[string]クエストモデル名", "metadata": "[string?]メタデータ", "contents": [ { "metadata": "[string?]メタデータ", "completeAcquireActions": [ { "action": "[string]入手アクションで実行するアクションの種類", "request": "[string]アクション実行時に使用されるリクエストのJSON文字列" } ], "weight": "[int]抽選の重み" } ], "challengePeriodEventId": "[string?]挑戦可能期間イベントGRN", "firstCompleteAcquireActions": [ { "action": "[string]入手アクションで実行するアクションの種類", "request": "[string]アクション実行時に使用されるリクエストのJSON文字列" } ], "verifyActions": [ { "action": "[string]検証アクションで実行するアクションの種類", "request": "[string]アクション実行時に使用されるリクエストのJSON文字列" } ], "consumeActions": [ { "action": "[string]消費アクションで実行するアクションの種類", "request": "[string]アクション実行時に使用されるリクエストのJSON文字列" } ], "failedAcquireActions": [ { " /ja/api_reference/ranking/master_data/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/ranking/master_data/ マスターデータのフォーマット JSON { "version": "2019-09-17", "categories": [ { "name": "[string]カテゴリーモデル名", "metadata": "[string?]メタデータ", "minimumValue": "[long?]スコアの最小値", "maximumValue": "[long?]スコアの最大値", "sum": "[bool]合算モード", "orderDirection": "[string (enum)]ソート方向", "scope": "[string (enum)]ランキングの種類", "globalRankingSetting": { "uniqueByUserId": "[bool]ユーザーID毎にユニーク", "calculateIntervalMinutes": "[int]集計間隔（分）", "calculateFixedTiming": { "hour": "[int?]時", "minute": "[int?]分" }, "additionalScopes": [ { "name": "[string]スコープ名", "targetDays": "[long]集計対象日数" } ], "ignoreUserIds": [ "[string]ランキングに反映しないユーザーID" ], "generation": "[string?]世代" }, "entryPeriodEventId": "[string?]スコア登録期間イベントID", "accessPeriodEventId": "[string?]アクセス期間イベントID" } ] } 型 有効化条件 必須 デフォルト 値の制限 説明 version string ✓ 2019-09-17 マスターデータのフォーマットバージョン categories List<CategoryModel> ~ 1000 items カテゴリーモデルカテゴリー毎に異なるランキングを作成できます。カテゴリーには登録できるスコアの最小値・最大値を設定でき、その範囲外のスコアは破棄されます。ランキングを集計する際にスコアを小さいものを上位（昇順）にするか、大きいものを上位（降順）にするかを設定できます。ランキングの種類として グローバル と スコープ を選択できます。グローバルは全プレイヤーが同じ結果を参照するもので、スコープはフレンド内ランキングや、ギルド内ランキングのようなゲームプレイヤー毎に結果の異なるランキングです。グローバルランキングはカテゴリーごとにランキングの集計間隔を15分～24時間で設定できます。スコープランキングはリアルタイムで集計結果が反映されます。ランキングデータには世代という設定があり、世代を変更することで登録されたスコアをリセットすることができます。 モデル CategoryModel カテゴリーモデル /ja/api_reference/ranking2/master_data/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/ranking2/master_data/ マスターデータのフォーマット JSON { "version": "2024-05-30", "globalRankingModels": [ { "name": "[string]グローバルランキングモデル名", "metadata": "[string?]メタデータ", "minimumValue": "[long?]スコアの最小値", "maximumValue": "[long?]スコアの最大値", "sum": "[bool]スコア合算", "orderDirection": "[string (enum)]ソート方向", "entryPeriodEventId": "[string?]スコア登録可能期間イベントGRN", "rankingRewards": [ { "thresholdRank": "[int]順位閾値", "metadata": "[string?]メタデータ", "acquireActions": [ { "action": "[string]入手アクションで実行するアクションの種類", "request": "[string]アクション実行時に使用されるリクエストのJSON文字列" } ] } ], "accessPeriodEventId": "[string?]ランキングデータアクセス可能期間イベントGRN", "rewardCalculationIndex": "[string (enum)]報酬計算インデックス" } ], "clusterRankingModels": [ { "name": "[string]クラスターランキングモデル名", "metadata": "[string?]メタデータ", "clusterType": "[string (enum)]クラスタータイプ", "minimumValue": "[long?]スコアの最小値", "maximumValue": "[long?]スコアの最大値", "sum": "[bool]スコア合算", "orderDirection": "[string (enum)]ソート方向", "entryPeriodEventId": "[string?]スコア登録可能期間イベントGRN", "rankingRewards": [ { " /ja/api_reference/schedule/master_data/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/schedule/master_data/ マスターデータのフォーマット JSON { "version": "2019-03-31", "events": [ { "name": "[string]イベント名", "metadata": "[string?]メタデータ", "scheduleType": "[string (enum)]スケジュールタイプ", "absoluteBegin": "[long?]絶対開始日時", "absoluteEnd": "[long?]絶対終了日時", "relativeTriggerName": "[string]イベント開始トリガー名", "repeatSetting": { "repeatType": "[string]繰り返しの種類", "beginDayOfMonth": "[int]繰り返し開始日", "endDayOfMonth": "[int]繰り返し終了日", "beginDayOfWeek": "[string]繰り返し開始曜日", "endDayOfWeek": "[string]繰り返し終了曜日", "beginHour": "[int]繰り返し開始時（時）", "endHour": "[int]繰り返し終了時（時）", "anchorTimestamp": "[long]基準タイムスタンプ", "activeDays": "[int]アクティブ日数", "inactiveDays": "[int]インアクティブ日数" } } ] } 型 有効化条件 必須 デフォルト 値の制限 説明 version string ✓ 2019-03-31 マスターデータのフォーマットバージョン events List<Event> ~ 100 items イベントイベントの期間は絶対期間と相対期間の2種類存在します。絶対期間は 例えば YYYY年MM月DD日 00:00(UTC) ～ YYYY年MM月DD日 23:59(UTC) のような固定の期間で、相対期間は トリガーを引いたタイミングから 24時間 のようなゲームプレイヤー毎に異なる期間をイベント期間とするものです。イベントには開催期間だけでなく、繰り返しが設定できるようになっておりイベント期間のうち、月曜日の 10:00 ～ 11:00 だけをイベント期間とするような設定も可能です。 モデル Event イベント /ja/api_reference/season_rating/master_data/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/season_rating/master_data/ マスターデータのフォーマット JSON { "version": "2024-02-23", "seasonModels": [ { "name": "[string]シーズンモデル名", "metadata": "[string?]メタデータ", "tiers": [ { "metadata": "[string?]メタデータ", "raiseRankBonus": "[int]ランク昇格ボーナス", "entryFee": "[int]参加料", "minimumChangePoint": "[int]最小変動ポイント", "maximumChangePoint": "[int]最大変動ポイント" } ], "experienceModelId": "[string]経験値モデルID", "challengePeriodEventId": "[string?]チャレンジ期間イベントID" } ] } 型 有効化条件 必須 デフォルト 値の制限 説明 version string ✓ 2024-02-23 マスターデータのフォーマットバージョン seasonModels List<SeasonModel> ~ 50 items シーズンモデルシーズン期間中に適用されるティアー構造とポイント変動ルールを定義するマスターデータです。各ティアーごとのポイント変動範囲・参加料・ランクアップボーナスを設定し、ポイント管理に使用する Experience モデルを指定します。実際のポイントおよびティアーのユーザーデータは GS2-Experience によって管理されます。 モデル SeasonModel シーズンモデル シーズン期間中に適用されるティアー構造とポイント変動ルールを定義するマスターデータです。 各ティアーごとのポイント変動範囲・参加料・ランクアップボーナスを設定し、ポイント管理に使用する Experience モデルを指定します。 実際のポイントおよびティアーのユーザーデータは GS2-Experience によって管理されます。 型 有効化条件 必須 デフォルト 値の制限 説明 seasonModelId string ※ ~ 1024文字 シーズンモデル GRN ※ サーバーが自動で設定 name string ✓ ~ 128文字 シーズンモデル名シーズンモデル固有の名前。英数字および -(ハイフン) _(アンダースコア) . /ja/api_reference/serial_key/master_data/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/serial_key/master_data/ マスターデータのフォーマット JSON { "version": "2022-09-13", "campaignModels": [ { "name": "[string]キャンペーンモデル名", "metadata": "[string?]メタデータ", "enableCampaignCode": "[bool]キャンペーンコードによる引き換えを許可するか" } ] } 型 有効化条件 必須 デフォルト 値の制限 説明 version string ✓ 2022-09-13 マスターデータのフォーマットバージョン campaignModels List<CampaignModel> ~ 1000 items キャンペーンモデルキャンペーンモデルはキャンペーンを定義し、シリアルコードと紐づけて管理するために使用されます。 モデル CampaignModel キャンペーンモデル キャンペーンモデルはキャンペーンを定義し、シリアルコードと紐づけて管理するために使用されます。 型 有効化条件 必須 デフォルト 値の制限 説明 campaignId string ※ ~ 1024文字 キャンペーンモデル GRN ※ サーバーが自動で設定 name string ✓ ~ 128文字 キャンペーンモデル名 metadata string ~ 2048文字 メタデータメタデータには任意の値を設定できます。これらの値は GS2 の動作には影響しないため、ゲーム内で利用する情報の保存先として使用できます。 enableCampaignCode bool false キャンペーンコードによる引き換えを許可するか有効にすると、個別のシリアルコードではなく共通のキャンペーンコード（キャンペーン名）を使って報酬を引き換えられるようになります。これにより、1つのコードを複数のユーザーが使用できます。 /ja/api_reference/showcase/master_data/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/showcase/master_data/ マスターデータのフォーマット JSON { "version": "2019-04-04", "showcases": [ { "name": "[string]陳列棚名", "metadata": "[string?]メタデータ", "salesPeriodEventId": "[string?]陳列棚の販売期間を設定した GS2-Schedule のイベントGRN", "displayItems": [ { "displayItemId": "[string]陳列商品ID", "type": "[string]種類", "salesItem": { "name": "[string]商品名", "metadata": "[string?]メタデータ", "verifyActions": [ { "action": "[string]検証アクションで実行するアクションの種類", "request": "[string]アクション実行時に使用されるリクエストのJSON文字列" } ], "consumeActions": [ { "action": "[string]消費アクションで実行するアクションの種類", "request": "[string]アクション実行時に使用されるリクエストのJSON文字列" } ], "acquireActions": [ { "action": "[string]入手アクションで実行するアクションの種類", "request": "[string]アクション実行時に使用されるリクエストのJSON文字列" } ] }, "salesItemGroup": { "name": "[string]商品グループ名", "metadata": "[string?]メタデータ", "salesItems": [ { "name": "[string]商品名", "metadata": "[string?]メタデータ", " /ja/api_reference/skill_tree/master_data/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/skill_tree/master_data/ マスターデータのフォーマット JSON { "version": "2023-09-06", "nodeModels": [ { "name": "[string]ノードモデル名", "metadata": "[string?]メタデータ", "releaseVerifyActions": [ { "action": "[string]検証アクションで実行するアクションの種類", "request": "[string]アクション実行時に使用されるリクエストのJSON文字列" } ], "releaseConsumeActions": [ { "action": "[string]消費アクションで実行するアクションの種類", "request": "[string]アクション実行時に使用されるリクエストのJSON文字列" } ], "returnAcquireActions": [ { "action": "[string]入手アクションで実行するアクションの種類", "request": "[string]アクション実行時に使用されるリクエストのJSON文字列" } ], "restrainReturnRate": "[float]返却率", "premiseNodeNames": [ "[string]ノードモデル名" ] } ] } 型 有効化条件 必須 デフォルト 値の制限 説明 version string ✓ 2023-09-06 マスターデータのフォーマットバージョン nodeModels List<NodeModel> ~ 1000 items ノードモデルスキルツリー内のノードを定義するモデルで、解放コスト・前提条件・返却動作を含みます。各ノードには検証アクション（解放前の条件チェック）、消費アクション（支払うコスト）、先に解放が必要な前提ノードを設定できます。ノードを拘束（未解放状態に戻す）すると、消費したリソースが返却率に基づいて部分的に返却されます。返却入手アクションは消費アクションに返却率を乗じて自動的に計算されます。 モデル NodeModel ノードモデル スキルツリー内のノードを定義するモデルで、解放コスト・前提条件・返却動作を含みます。 各ノードには検証アクション（解放前の条件チェック）、消費アクション（支払うコスト）、先に解放が必要な前提ノードを設定できます。 /ja/api_reference/stamina/master_data/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/stamina/master_data/ マスターデータのフォーマット JSON { "version": "2019-02-14", "staminaModels": [ { "name": "[string]スタミナモデル名", "metadata": "[string?]メタデータ", "recoverIntervalMinutes": "[int]回復間隔（分）", "recoverValue": "[int]回復量", "initialCapacity": "[int]最大値の初期値", "isOverflow": "[bool]オーバーフロー可否", "maxCapacity": "[int]オーバーフロー時の最大値", "maxStaminaTable": { "name": "[string]スタミナ最大値テーブル名", "metadata": "[string?]メタデータ", "experienceModelId": "[string]経験値モデルID", "values": [ "[int]スタミナの最大値" ] }, "recoverIntervalTable": { "name": "[string]回復間隔テーブル名", "metadata": "[string?]メタデータ", "experienceModelId": "[string]経験値モデルID", "values": [ "[int?]スタミナの回復間隔（分）" ] }, "recoverValueTable": { "name": "[string]スタミナ回復量テーブル名", "metadata": "[string?]メタデータ", "experienceModelId": "[string]経験値モデルID", "values": [ "[int?]スタミナの回復量" ] } } ] } 型 有効化条件 必須 デフォルト 値の制限 説明 version string ✓ 2019-02-14 マスターデータのフォーマットバージョン staminaModels List<StaminaModel> ~ 100 items スタミナモデルスタミナの最大値や、回復間隔、回復量といったパラメータを定義できます。GS2-Experience と連動させて、最大値や回復量をコントロールすることもできます。 モデル StaminaModel スタミナモデル /ja/api_reference/version/master_data/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/api_reference/version/master_data/ マスターデータのフォーマット JSON { "version": "2019-10-09", "versionModels": [ { "name": "[string]バージョンモデル名", "metadata": "[string?]メタデータ", "scope": "[string (enum)]判定に使用するバージョン値の種類", "type": "[string (enum)]バージョンチェックモード", "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]メジャーバージョン", " /ja/articles/master_data/cicd/ Mon, 01 Jan 0001 00:00:00 +0000 /ja/articles/master_data/cicd/ マスターデータの更新作業を自動化することで、人為的なミスを減らし、開発サイクルを高速化できます。 自動化のフロー 一般的な自動化のフローは以下の通りです。 データ作成: Excel や Google スプレッドシート、CSV 等でマスターデータを作成。 変換: スプレッドシートから GS2 のマスターデータ形式（JSON）へ変換。 コミット: 変換後の JSON または GS2-Deploy のテンプレートを Git リポジトリへコミット。 デプロイ: CI ツール（GitHub Actions, CircleCI 等）が変更を検知し、GS2 へ反映。 デプロイの自動化 GS2-Deploy を使用する場合 GS2-Deploy のテンプレートにマスターデータを埋め込んでいる場合、CI から GS2-Deploy のスタックを更新することで反映できます。 GitHub Actions の例: jobs: deploy: runs-on: ubuntu-latest steps: - uses: actions/checkout@v2 - name: GS2 Deploy run: | # gs2-cli 等を使用してスタックを更新 gs2-cli deploy update-stack --stack-name master-data --template-file template.yaml マネージメントコンソールのエクスポート/インポートを使用する場合 各マイクロサービスの CurrentItemModelMaster を更新する API を呼び出すことで、JSON ファイルの内容を反映できます。