Master Data Reference of GS2-Distributor
Reference of the format of master data and various models to be imported
{
"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 | Required | Default | Value Limits | Description | |
|---|---|---|---|---|---|---|
| version | ✓ | 2019-03-01 | Format version of master data | |||
| distributorModels | List<DistributorModel> | ~ 100 items | 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. |
BatchRequestPayload
API Batch Request
| Type | Condition | Required | Default | Value Limits | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| requestId | string | ✓ | ~ 128 chars | Request ID | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| service | String Enum 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 |
BatchResultPayload
API Batch Result
| Type | Condition | Required | Default | Value Limits | 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
ConsumeActionResult
Consume action execution result
VerifyActionResult
Verify action execution result
DistributeResource
Distribute Resource
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 | Required | Default | Value Limits | 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> | [] | 0 ~ 1000 items | Whitelist of target resource GRNs that can be processed through the distributor |