Transaction Action of GS2-Enhance

Specification of verify/consume/acquire transaction actions

ConsumeAction

Gs2Enhance:DeleteProgressByUserId

Delete running enhancement by specifying a user ID

Whether the action allows quantity specification: NO

Whether the action is reversible: NO

	Type	Required	Value Limits	Description
namespaceName	string	✓	~ 128 chars	Namespace name Namespace-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.).
userId	string	✓	~ 128 chars	User ID Set `#{userId}` to replace the currently logged in user ID.
timeOffsetToken	string		~ 1024 chars	Time offset token

{
    "action": "Gs2Enhance:DeleteProgressByUserId",
    "request": {
        "namespaceName": "[string]Namespace name",
        "userId": "[string]User ID",
        "timeOffsetToken": "[string]Time offset token"
    }
}

action: Gs2Enhance:DeleteProgressByUserId
request:
  namespaceName: "[string]Namespace name"
  userId: "[string]User ID"
  timeOffsetToken: "[string]Time offset token"

transaction.service("enhance").consume.delete_progress_by_user_id({
    namespaceName="[string]Namespace name",
    userId="[string]User ID",
    timeOffsetToken="[string]Time offset token",
})

AcquireAction

Gs2Enhance:DirectEnhanceByUserId

Perform enhancement by specifying a user ID

Whether the action allows quantity specification: NO

Whether the action is reversible: NO

	Type	Required	Default	Value Limits	Description
namespaceName	string	✓		~ 128 chars	Namespace name Namespace-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.).
rateName	string	✓		~ 128 chars	Enhancement Rate Model Name Enhancement Rate Model-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.).
userId	string	✓		~ 128 chars	User ID Set `#{userId}` to replace the currently logged in user ID.
targetItemSetId	string	✓		~ 1024 chars	GRN for the enhanced Item Set
materials	List<Material>	✓		1 ~ 10 items	List of Material
config	List<Config>		[]	0 ~ 32 items	Set values to be applied to transaction variables
timeOffsetToken	string			~ 1024 chars	Time offset token

{
    "action": "Gs2Enhance:DirectEnhanceByUserId",
    "request": {
        "namespaceName": "[string]Namespace name",
        "rateName": "[string]Enhancement Rate Model Name",
        "userId": "[string]User ID",
        "targetItemSetId": "[string]GRN for the enhanced Item Set",
        "materials": [
            {
                "materialItemSetId": "[string]GRN of Item Set (quantity of items held per expiration date) that will be used as materials for enhancement",
                "count": "[int]Number of consumption"
            }
        ],
        "config": [
            {
                "key": "[string]Name",
                "value": "[string]Value"
            }
        ],
        "timeOffsetToken": "[string]Time offset token"
    }
}

action: Gs2Enhance:DirectEnhanceByUserId
request:
  namespaceName: "[string]Namespace name"
  rateName: "[string]Enhancement Rate Model Name"
  userId: "[string]User ID"
  targetItemSetId: "[string]GRN for the enhanced Item Set"
  materials: 
    - materialItemSetId: "[string]GRN of Item Set (quantity of items held per expiration date) that will be used as materials for enhancement"
      count: "[int]Number of consumption"
  config: 
    - key: "[string]Name"
      value: "[string]Value"
  timeOffsetToken: "[string]Time offset token"

transaction.service("enhance").acquire.direct_enhance_by_user_id({
    namespaceName="[string]Namespace name",
    rateName="[string]Enhancement Rate Model Name",
    userId="[string]User ID",
    targetItemSetId="[string]GRN for the enhanced Item Set",
    materials={
        {
            materialItemSetId="[string]GRN of Item Set (quantity of items held per expiration date) that will be used as materials for enhancement",
            count="[int]Number of consumption"
        }
    },
    config={
        {
            key="[string]Name",
            value="[string]Value"
        }
    },
    timeOffsetToken="[string]Time offset token",
})

Gs2Enhance:UnleashByUserId

Perform unleash by specifying a user ID

Used for enhancement processing to raise the grade of the resource managed by GS2-Grade. In particular, it is used for the type of unleash that raises the level cap by consuming the same type of item as a material.

Instead of consuming the specified material, the grade of the resource to be unleashed can be increased by 1. Even if the material resource has a resource such as experience value, the resource will not be inherited. If inheritance is required, the resource must be converted to a resource for inheritance in advance.

Whether the action allows quantity specification: NO

Whether the action is reversible: NO

	Type	Required	Default	Value Limits	Description
namespaceName	string	✓		~ 128 chars	Namespace name Namespace-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.).
rateName	string	✓		~ 128 chars	Enhancement Rate Model Name Enhancement Rate Model-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.).
userId	string	✓		~ 128 chars	User ID Set `#{userId}` to replace the currently logged in user ID.
targetItemSetId	string	✓		~ 1024 chars	GRN for the Item Set (item quantity held per expiration date) subject to limit break
materials	List<string>	✓		1 ~ 1000 items	List of materials that break the limit
config	List<Config>		[]	0 ~ 32 items	Set values to be applied to transaction variables
timeOffsetToken	string			~ 1024 chars	Time offset token

{
    "action": "Gs2Enhance:UnleashByUserId",
    "request": {
        "namespaceName": "[string]Namespace name",
        "rateName": "[string]Enhancement Rate Model Name",
        "userId": "[string]User ID",
        "targetItemSetId": "[string]GRN for the Item Set (item quantity held per expiration date) subject to limit break",
        "materials": [
            "[string]Material"
        ],
        "config": [
            {
                "key": "[string]Name",
                "value": "[string]Value"
            }
        ],
        "timeOffsetToken": "[string]Time offset token"
    }
}

action: Gs2Enhance:UnleashByUserId
request:
  namespaceName: "[string]Namespace name"
  rateName: "[string]Enhancement Rate Model Name"
  userId: "[string]User ID"
  targetItemSetId: "[string]GRN for the Item Set (item quantity held per expiration date) subject to limit break"
  materials: 
    - "[string]Material"
  config: 
    - key: "[string]Name"
      value: "[string]Value"
  timeOffsetToken: "[string]Time offset token"

transaction.service("enhance").acquire.unleash_by_user_id({
    namespaceName="[string]Namespace name",
    rateName="[string]Enhancement Rate Model Name",
    userId="[string]User ID",
    targetItemSetId="[string]GRN for the Item Set (item quantity held per expiration date) subject to limit break",
    materials={
        "[string]Material"
    },
    config={
        {
            key="[string]Name",
            value="[string]Value"
        }
    },
    timeOffsetToken="[string]Time offset token",
})

Gs2Enhance:CreateProgressByUserId

Start enhancement by specifying a user ID

Whether the action allows quantity specification: NO

Whether the action is reversible: YES

	Type	Required	Default	Value Limits	Description
namespaceName	string	✓		~ 128 chars	Namespace name Namespace-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.).
userId	string	✓		~ 128 chars	User ID Set `#{userId}` to replace the currently logged in user ID.
rateName	string	✓		~ 128 chars	Enhancement Rate Model Name
targetItemSetId	string	✓		~ 1024 chars	GRN for the enhanced Item Set
materials	List<Material>			0 ~ 10 items	List of materials
force	bool	✓	false		If there is an enhancement that has already been started, it can be discarded and started, or
timeOffsetToken	string			~ 1024 chars	Time offset token

{
    "action": "Gs2Enhance:CreateProgressByUserId",
    "request": {
        "namespaceName": "[string]Namespace name",
        "userId": "[string]User ID",
        "rateName": "[string]Enhancement Rate Model Name",
        "targetItemSetId": "[string]GRN for the enhanced Item Set",
        "materials": [
            {
                "materialItemSetId": "[string]GRN of Item Set (quantity of items held per expiration date) that will be used as materials for enhancement",
                "count": "[int]Number of consumption"
            }
        ],
        "force": "[bool]If there is an enhancement that has already been started, it can be discarded and started, or",
        "timeOffsetToken": "[string]Time offset token"
    }
}

action: Gs2Enhance:CreateProgressByUserId
request:
  namespaceName: "[string]Namespace name"
  userId: "[string]User ID"
  rateName: "[string]Enhancement Rate Model Name"
  targetItemSetId: "[string]GRN for the enhanced Item Set"
  materials: 
    - materialItemSetId: "[string]GRN of Item Set (quantity of items held per expiration date) that will be used as materials for enhancement"
      count: "[int]Number of consumption"
  force: "[bool]If there is an enhancement that has already been started, it can be discarded and started, or"
  timeOffsetToken: "[string]Time offset token"

transaction.service("enhance").acquire.create_progress_by_user_id({
    namespaceName="[string]Namespace name",
    userId="[string]User ID",
    rateName="[string]Enhancement Rate Model Name",
    targetItemSetId="[string]GRN for the enhanced Item Set",
    materials={
        {
            materialItemSetId="[string]GRN of Item Set (quantity of items held per expiration date) that will be used as materials for enhancement",
            count="[int]Number of consumption"
        }
    },
    force="[bool]If there is an enhancement that has already been started, it can be discarded and started, or",
    timeOffsetToken="[string]Time offset token",
})