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文字 | メソッド名 |
service に指定する列挙型の定義
| 定義 | 説明 |
|---|---|
| account | GS2-Account |
| adReward | GS2-AdReward |
| auth | GS2-Auth |
| buff | GS2-Buff |
| chat | GS2-Chat |
| datastore | GS2-Datastore |
| deploy | GS2-Deploy |
| dictionary | GS2-Dictionary |
| distributor | GS2-Distributor |
| enchant | GS2-Enchant |
| enhance | GS2-Enhance |
| exchange | GS2-Exchange |
| experience | GS2-Experience |
| formation | GS2-Formation |
| friend | GS2-Friend |
| gateway | GS2-Gateway |
| grade | GS2-Grade |
| guard | GS2-Guard |
| guild | GS2-Guild |
| identifier | GS2-Identifier |
| idle | GS2-Idle |
| inbox | GS2-Inbox |
| inventory | GS2-Inventory |
| jobQueue | GS2-JobQueue |
| key | GS2-Key |
| limit | GS2-Limit |
| lock | GS2-Lock |
| log | GS2-Log |
| loginReward | GS2-LoginReward |
| lottery | GS2-Lottery |
| matchmaking | GS2-Matchmaking |
| megaField | GS2-MegaField |
| mission | GS2-Mission |
| money | GS2-Money |
| money2 | GS2-Money2 |
| news | GS2-News |
| quest | GS2-Quest |
| ranking | GS2-Ranking |
| ranking2 | GS2-Ranking2 |
| realtime | GS2-Realtime |
| schedule | GS2-Schedule |
| script | GS2-Script |
| seasonRating | GS2-SeasonRating |
| serialKey | GS2-SerialKey |
| showcase | GS2-Showcase |
| skillTree | GS2-SkillTree |
| stamina | GS2-Stamina |
| stateMachine | GS2-StateMachine |
| version | GS2-Version |
BatchResultPayload
API一括実行結果
| 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
|---|---|---|---|---|---|---|
| requestId | string | ✓ | ~ 128文字 | リクエストID | ||
| statusCode | int | ✓ | 100 ~ 1000 | ステータスコード | ||
| resultPayload | string | ✓ | ~ 10240文字 | レスポンス |
AcquireAction
入手アクション
ConsumeAction
消費アクション
VerifyAction
検証アクション
AcquireActionResult
入手アクションの実行結果
| 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
|---|---|---|---|---|---|---|
| action | enum { } | ✓ | ~ 128文字 | 入手アクションで実行するアクションの種類 | ||
| acquireRequest | string | ✓ | ~ 1048576文字 | リクエストのJSON | ||
| statusCode | int | ~ 999 | ステータスコード | |||
| acquireResult | string | ~ 1048576文字 | 結果内容 |
action に指定する列挙型の定義
| 定義 | 説明 |
|---|
ConsumeActionResult
消費アクションの実行結果
| 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
|---|---|---|---|---|---|---|
| action | enum { } | ✓ | ~ 128文字 | 消費アクションで実行するアクションの種類 | ||
| consumeRequest | string | ✓ | ~ 1048576文字 | リクエストのJSON | ||
| statusCode | int | ~ 999 | ステータスコード | |||
| consumeResult | string | ~ 1048576文字 | 結果内容 |
action に指定する列挙型の定義
| 定義 | 説明 |
|---|
VerifyActionResult
検証アクションの実行結果
| 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
|---|---|---|---|---|---|---|
| action | enum { } | ✓ | ~ 128文字 | 検証アクションで実行するアクションの種類 | ||
| verifyRequest | string | ✓ | ~ 1048576文字 | リクエストのJSON | ||
| statusCode | int | ~ 999 | ステータスコード | |||
| verifyResult | string | ~ 1048576文字 | 結果内容 |
action に指定する列挙型の定義
| 定義 | 説明 |
|---|
DistributeResource
リソース配布