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

マスターデータのフォーマットと インポートする各種モデルのリファレンス

マスターデータのフォーマット

{
  "version": "2019-03-01",
  "distributorModels": [
    {
      "name": "[string]配信モデル名",
      "metadata": "[string?]メタデータ",
      "inboxNamespaceId": "[string?]あふれたリソースを転送する GS2-Inbox のネームスペースGRN",
      "whiteListTargetIds": [
        "[string]GS2-Distributorを通して処理出来る対象のリソースGRN"
      ]
    }
  ]
}
有効化条件必須デフォルト値の制限説明
versionstring
2019-03-01マスターデータのフォーマットバージョン
distributorModelsList<DistributorModel>~ 100 items配信モデル
配信モデルとはエンティティの入手時に所持枠を超えて入手した時のポリシーを設定するエンティティです。
GS2-Distributor を通して入手処理を行うことで、あふれたリソースを GS2-Inbox のメッセージとして転送することができます。

モデル

DistributorModel

配信モデル

配信モデルとはエンティティの入手時に所持枠を超えて入手した時のポリシーを設定するエンティティです。
GS2-Distributor を通して入手処理を行うことで、あふれたリソースを GS2-Inbox のメッセージとして転送することができます。

有効化条件必須デフォルト値の制限説明
distributorModelIdstring
✓*
~ 1024文字配信モデル GRN
※ サーバー側で自動的に設定
namestring
~ 128文字配信モデル名
配信モデル固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。
metadatastring~ 2048文字メタデータ
メタデータには任意の値を設定できます。
これらの値は GS2 の動作には影響しないため、ゲーム内で利用する情報の保存先として使用できます。
inboxNamespaceIdstring~ 1024文字あふれたリソースを転送する GS2-Inbox のネームスペース GRN
whiteListTargetIdsList<string>[]0 ~ 1000 itemsGS2-Distributorを通して処理出来る対象のリソースGRNのホワイトリスト
この配信モデルを使用して入手処理を行える対象となるリソースのGRNプレフィックスを指定します。