GS2-Distributor マスターデータリファレンス
マスターデータのフォーマットと インポートする各種モデルのリファレンス
{
"version": "2019-03-01",
"distributorModels": [
{
"name": "[string]配信設定名",
"metadata": "[string?]メタデータ",
"inboxNamespaceId": "[string?]あふれたリソースを転送する GS2-Inbox のネームスペースGRN",
"whiteListTargetIds": [
"[string]ディストリビューターを通して処理出来る対象のリソースGRN"
]
}
]
}
| 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
|---|---|---|---|---|---|---|
| version | ✓ | 2019-03-01 | マスターデータのフォーマットバージョン | |||
| distributorModels | List<DistributorModel> | ~ 100 items | 配信設定モデル |
DistributorModel
配信設定モデル
配信設定とはエンティティの入手時に所持枠を超えて入手した時のポリシーを設定するエンティティです。
GS2-Distributor を通して入手処理を行うことで、あふれたリソースを GS2-Inbox のメッセージとして転送することができます。
| 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
|---|---|---|---|---|---|---|
| distributorModelId | string | ✓ | ~ 1024文字 | 配信設定GRN | ||
| name | string | ✓ | ~ 128文字 | 配信設定名 | ||
| metadata | string | ~ 2048文字 | メタデータ | |||
| inboxNamespaceId | string | ~ 1024文字 | あふれたリソースを転送する GS2-Inbox のネームスペースGRN | |||
| whiteListTargetIds | List<string> | [] | ~ 1000 items | ディストリビューターを通して処理出来る対象のリソースGRNのホワイトリスト |
BatchRequestPayload
API一括実行リクエスト
| 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| requestId | string | ✓ | ~ 128文字 | リクエストID | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| service | 文字列列挙型 enum { “account”, “adReward”, “auth”, “buff”, “chat”, “datastore”, “deploy”, “dictionary”, “distributor”, “enchant”, “enhance”, “exchange”, “experience”, “formation”, “friend”, “gateway”, “grade”, “guard”, “guild”, “identifier”, “idle”, “inbox”, “inventory”, “jobQueue”, “key”, “limit”, “lock”, “log”, “loginReward”, “lottery”, “matchmaking”, “megaField”, “mission”, “money”, “money2”, “news”, “quest”, “ranking”, “ranking2”, “realtime”, “schedule”, “script”, “seasonRating”, “serialKey”, “showcase”, “skillTree”, “stamina”, “stateMachine”, “version” } | ✓ | ~ 128文字 | マイクロサービス名
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| methodName | string | ✓ | ~ 128文字 | メソッド名 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| parameter | string | ✓ | ~ 10240文字 | メソッド名 |
BatchResultPayload
API一括実行結果
| 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
|---|---|---|---|---|---|---|
| requestId | string | ✓ | ~ 128文字 | リクエストID | ||
| statusCode | int | ✓ | 100 ~ 1000 | ステータスコード | ||
| resultPayload | string | ✓ | ~ 10240文字 | レスポンス |
AcquireAction
入手アクション
ConsumeAction
消費アクション
VerifyAction
検証アクション
AcquireActionResult
入手アクションの実行結果
ConsumeActionResult
消費アクションの実行結果
VerifyActionResult
検証アクションの実行結果
DistributeResource
リソース配布