Master Data Reference of GS2-Distributor
{
"version": "2019-03-01",
"distributorModels": [
{
"name": "[string]Delivery setting name",
"metadata": "[string?]metadata",
"inboxNamespaceId": "[string?]GS2-Inbox namespace GRN to transfer overflow resources",
"whiteListTargetIds": [
"[string]Target resources GRNs that can be processed through the distributor"
]
}
]
}
| Type | Condition | Require | Default | Limitation | Description | |
|---|---|---|---|---|---|---|
| version | ✓ | 2019-03-01 | Format version of master data | |||
| distributorModels | List<DistributorModel> | ~ 100 items | Delivery Setting Model |
DistributorModel
Delivery Setting Model
A delivery setting is an entity that sets the policy when an entity’s acquisition exceeds its possession quota. By processing acquisitions through GS2-Distributor, overflow resources can be forwarded as GS2-Inbox messages.
| Type | Condition | Require | Default | Limitation | Description | |
|---|---|---|---|---|---|---|
| distributorModelId | string | ✓ | ~ 1024 chars | Delivery Setting GRN | ||
| name | string | ✓ | ~ 128 chars | Delivery setting name | ||
| metadata | string | ~ 2048 chars | metadata | |||
| inboxNamespaceId | string | ~ 1024 chars | GS2-Inbox namespace GRN to transfer overflow resources | |||
| whiteListTargetIds | List<string> | [] | ~ 1000 items | Whitelist of target resource GRNs that can be processed through the distributor |
BatchRequestPayload
API Batch Request
| Type | Condition | Require | Default | Limitation | Description | |
|---|---|---|---|---|---|---|
| requestId | string | ✓ | ~ 128 chars | Request 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 chars | Service | ||
| methodName | string | ✓ | ~ 128 chars | Method Name | ||
| parameter | string | ✓ | ~ 10240 chars | Method Name |
Enumeration type definition to specify as service
| Enumerator String Definition | Description |
|---|---|
| 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 Batch Result
| Type | Condition | Require | Default | Limitation | Description | |
|---|---|---|---|---|---|---|
| requestId | string | ✓ | ~ 128 chars | Request ID | ||
| statusCode | int | ✓ | 100 ~ 1000 | Status Code | ||
| resultPayload | string | ✓ | ~ 10240 chars | Response |
AcquireAction
Acquire Action
ConsumeAction
Consume Action
VerifyAction
Verify Action
AcquireActionResult
Acquire action execution result
| Type | Condition | Require | Default | Limitation | Description | |
|---|---|---|---|---|---|---|
| action | enum { } | ✓ | ~ 128 chars | Types of actions to be performed in the acquire action | ||
| acquireRequest | string | ✓ | ~ 1048576 chars | JSON of request | ||
| statusCode | int | ~ 999 | Status code | |||
| acquireResult | string | ~ 1048576 chars | Result payload |
Enumeration type definition to specify as action
| Enumerator String Definition | Description |
|---|
ConsumeActionResult
Consume action execution result
| Type | Condition | Require | Default | Limitation | Description | |
|---|---|---|---|---|---|---|
| action | enum { } | ✓ | ~ 128 chars | Types of actions to be performed in the consume action | ||
| consumeRequest | string | ✓ | ~ 1048576 chars | JSON of request | ||
| statusCode | int | ~ 999 | Status code | |||
| consumeResult | string | ~ 1048576 chars | Result payload |
Enumeration type definition to specify as action
| Enumerator String Definition | Description |
|---|
VerifyActionResult
Verify action execution result
| Type | Condition | Require | Default | Limitation | Description | |
|---|---|---|---|---|---|---|
| action | enum { } | ✓ | ~ 128 chars | Types of actions to be performed in the verify task | ||
| verifyRequest | string | ✓ | ~ 1048576 chars | JSON of request | ||
| statusCode | int | ~ 999 | Status code | |||
| verifyResult | string | ~ 1048576 chars | Result payload |
Enumeration type definition to specify as action
| Enumerator String Definition | Description |
|---|
DistributeResource
Distribute Resource