Transaction Action of GS2-Mission

VerifyAction

Gs2Mission:VerifyCompleteByUserId

Verify achievement status by specifying user ID

Actions for which quantity can be specified: NO

	Type	Description
namespaceName	string	Namespace name
missionGroupName	string	Mission Group Name
userId	string	Set `#{userId}` to replace the currently logged in user ID.
verifyType	enum [ “completed”, “notCompleted”, “received”, “notReceived”, “completedAndNotReceived” ]	Type of verification
missionTaskName	string	Task Name
multiplyValueSpecifyingQuantity	bool	Whether to multiply the value used for verification when specifying the quantity
timeOffsetToken	string	Time offset token

Enumeration type definition to specify as verifyType

Enumerator String Definition	Description
completed	Condition is achieved
notCompleted	Condition is not achieved
received	Reward has been received
notReceived	Reward has not been received
completedAndNotReceived	Condition is achieved and reward has not been received

{
    "action": "Gs2Mission:VerifyCompleteByUserId",
    "request": {
        "namespaceName": "[string]Namespace name",
        "missionGroupName": "[string]Mission Group Name",
        "userId": "[string]User Id",
        "verifyType": "[string]Type of verification",
        "missionTaskName": "[string]Task Name",
        "multiplyValueSpecifyingQuantity": "[bool]Whether to multiply the value used for verification when specifying the quantity",
        "timeOffsetToken": "[string]Time offset token"
    }
}

action: Gs2Mission:VerifyCompleteByUserId
request:
  namespaceName: "[string]Namespace name"
  missionGroupName: "[string]Mission Group Name"
  userId: "[string]User Id"
  verifyType: "[string]Type of verification"
  missionTaskName: "[string]Task Name"
  multiplyValueSpecifyingQuantity: "[bool]Whether to multiply the value used for verification when specifying the quantity"
  timeOffsetToken: "[string]Time offset token"

transaction.service("mission").consume.verify_complete_by_user_id({
    namespaceName="[string]Namespace name",
    missionGroupName="[string]Mission Group Name",
    userId="[string]User Id",
    verifyType="[string]Type of verification",
    missionTaskName="[string]Task Name",
    multiplyValueSpecifyingQuantity="[bool]Whether to multiply the value used for verification when specifying the quantity",
    timeOffsetToken="[string]Time offset token",
})

Gs2Mission:VerifyCounterValueByUserId

Verify counter value by specifying a user ID

Actions for which quantity can be specified: NO

	Type	Description
namespaceName	string	Namespace name
userId	string	Set `#{userId}` to replace the currently logged in user ID.
counterName	string	Counter Name
verifyType	enum [ “less”, “lessEqual”, “greater”, “greaterEqual”, “equal”, “notEqual” ]	Type of verification
scopeType	enum [ “resetTiming”, “verifyAction” ]	Scope type
resetType	enum [ “notReset”, “daily”, “weekly”, “monthly” ]	Reset timing
conditionName	string	Condition Name
value	long	Count value
multiplyValueSpecifyingQuantity	bool	Whether to multiply the value used for verification when specifying the quantity
timeOffsetToken	string	Time offset token

Enumeration type definition to specify as verifyType

Enumerator String Definition	Description
less	Counter value is less than the specified value
lessEqual	Counter value is less than or equal to the specified value
greater	Counter value is greater than the specified value
greaterEqual	Counter value is greater than or equal to the specified value
equal	Counter value is equal to the specified value
notEqual	Counter value is not equal to the specified value

Enumeration type definition to specify as scopeType

Enumerator String Definition	Description
resetTiming	Reset timing
verifyAction	Verify action

Enumeration type definition to specify as resetType

Enumerator String Definition	Description
notReset	Not resetting.
daily	Daily
weekly	Weekly
monthly	Monthly

{
    "action": "Gs2Mission:VerifyCounterValueByUserId",
    "request": {
        "namespaceName": "[string]Namespace name",
        "userId": "[string]User Id",
        "counterName": "[string]Counter Name",
        "verifyType": "[string]Type of verification",
        "scopeType": "[string]Scope type",
        "resetType": "[string]Reset timing",
        "conditionName": "[string]Condition Name",
        "value": "[long]Count value",
        "multiplyValueSpecifyingQuantity": "[bool]Whether to multiply the value used for verification when specifying the quantity",
        "timeOffsetToken": "[string]Time offset token"
    }
}

action: Gs2Mission:VerifyCounterValueByUserId
request:
  namespaceName: "[string]Namespace name"
  userId: "[string]User Id"
  counterName: "[string]Counter Name"
  verifyType: "[string]Type of verification"
  scopeType: "[string]Scope type"
  resetType: "[string]Reset timing"
  conditionName: "[string]Condition Name"
  value: "[long]Count value"
  multiplyValueSpecifyingQuantity: "[bool]Whether to multiply the value used for verification when specifying the quantity"
  timeOffsetToken: "[string]Time offset token"

transaction.service("mission").consume.verify_counter_value_by_user_id({
    namespaceName="[string]Namespace name",
    userId="[string]User Id",
    counterName="[string]Counter Name",
    verifyType="[string]Type of verification",
    scopeType="[string]Scope type",
    resetType="[string]Reset timing",
    conditionName="[string]Condition Name",
    value="[long]Count value",
    multiplyValueSpecifyingQuantity="[bool]Whether to multiply the value used for verification when specifying the quantity",
    timeOffsetToken="[string]Time offset token",
})

ConsumeAction

Gs2Mission:ReceiveByUserId

Receive rewards for mission accomplishment

Actions for which quantity can be specified: NO

Reversible action: YES

	Type	Description
namespaceName	string	Namespace name
missionGroupName	string	Mission Group Name
missionTaskName	string	Task Name
userId	string	Set `#{userId}` to replace the currently logged in user ID.
timeOffsetToken	string	Time offset token

{
    "action": "Gs2Mission:ReceiveByUserId",
    "request": {
        "namespaceName": "[string]Namespace name",
        "missionGroupName": "[string]Mission Group Name",
        "missionTaskName": "[string]Task Name",
        "userId": "[string]User Id",
        "timeOffsetToken": "[string]Time offset token"
    }
}

action: Gs2Mission:ReceiveByUserId
request:
  namespaceName: "[string]Namespace name"
  missionGroupName: "[string]Mission Group Name"
  missionTaskName: "[string]Task Name"
  userId: "[string]User Id"
  timeOffsetToken: "[string]Time offset token"

transaction.service("mission").consume.receive_by_user_id({
    namespaceName="[string]Namespace name",
    missionGroupName="[string]Mission Group Name",
    missionTaskName="[string]Task Name",
    userId="[string]User Id",
    timeOffsetToken="[string]Time offset token",
})

Gs2Mission:BatchReceiveByUserId

Receive rewards for multiple mission tasks in bulk

Actions for which quantity can be specified: NO

Reversible action: NO

	Type	Description
namespaceName	string	Namespace name
missionGroupName	string	Mission Group Name
userId	string	Set `#{userId}` to replace the currently logged in user ID.
missionTaskNames	string[]	Task name list
timeOffsetToken	string	Time offset token

{
    "action": "Gs2Mission:BatchReceiveByUserId",
    "request": {
        "namespaceName": "[string]Namespace name",
        "missionGroupName": "[string]Mission Group Name",
        "userId": "[string]User Id",
        "missionTaskNames": [
            "[string]Task Name"
        ],
        "timeOffsetToken": "[string]Time offset token"
    }
}

action: Gs2Mission:BatchReceiveByUserId
request:
  namespaceName: "[string]Namespace name"
  missionGroupName: "[string]Mission Group Name"
  userId: "[string]User Id"
  missionTaskNames: 
  - "[string]Task Name"
  timeOffsetToken: "[string]Time offset token"

transaction.service("mission").consume.batch_receive_by_user_id({
    namespaceName="[string]Namespace name",
    missionGroupName="[string]Mission Group Name",
    userId="[string]User Id",
    missionTaskNames={
        "[string]Task Name"
    },
    timeOffsetToken="[string]Time offset token",
})

Gs2Mission:DecreaseCounterByUserId

Decrease counter by specifying a user ID

Actions for which quantity can be specified: YES

Reversible action: YES

	Type	Description
namespaceName	string	Namespace name
counterName	string	Counter Name
userId	string	Set `#{userId}` to replace the currently logged in user ID.
value	long	Value to be added
timeOffsetToken	string	Time offset token

{
    "action": "Gs2Mission:DecreaseCounterByUserId",
    "request": {
        "namespaceName": "[string]Namespace name",
        "counterName": "[string]Counter Name",
        "userId": "[string]User Id",
        "value": "[long]Value to be added",
        "timeOffsetToken": "[string]Time offset token"
    }
}

action: Gs2Mission:DecreaseCounterByUserId
request:
  namespaceName: "[string]Namespace name"
  counterName: "[string]Counter Name"
  userId: "[string]User Id"
  value: "[long]Value to be added"
  timeOffsetToken: "[string]Time offset token"

transaction.service("mission").consume.decrease_counter_by_user_id({
    namespaceName="[string]Namespace name",
    counterName="[string]Counter Name",
    userId="[string]User Id",
    value="[long]Value to be added",
    timeOffsetToken="[string]Time offset token",
})

AcquireAction

Gs2Mission:RevertReceiveByUserId

Revert the status of mission accomplishment to unreceived

Actions for which quantity can be specified: NO

Reversible action: YES

	Type	Description
namespaceName	string	Namespace name
missionGroupName	string	Mission Group Name
missionTaskName	string	Task Name
userId	string	Set `#{userId}` to replace the currently logged in user ID.
timeOffsetToken	string	Time offset token

{
    "action": "Gs2Mission:RevertReceiveByUserId",
    "request": {
        "namespaceName": "[string]Namespace name",
        "missionGroupName": "[string]Mission Group Name",
        "missionTaskName": "[string]Task Name",
        "userId": "[string]User Id",
        "timeOffsetToken": "[string]Time offset token"
    }
}

action: Gs2Mission:RevertReceiveByUserId
request:
  namespaceName: "[string]Namespace name"
  missionGroupName: "[string]Mission Group Name"
  missionTaskName: "[string]Task Name"
  userId: "[string]User Id"
  timeOffsetToken: "[string]Time offset token"

transaction.service("mission").acquire.revert_receive_by_user_id({
    namespaceName="[string]Namespace name",
    missionGroupName="[string]Mission Group Name",
    missionTaskName="[string]Task Name",
    userId="[string]User Id",
    timeOffsetToken="[string]Time offset token",
})

Gs2Mission:IncreaseCounterByUserId

Increase counter by specifying a user ID

Actions for which quantity can be specified: YES

Reversible action: YES

	Type	Description
namespaceName	string	Namespace name
counterName	string	Counter Name
userId	string	Set `#{userId}` to replace the currently logged in user ID.
value	long	Value to be added
timeOffsetToken	string	Time offset token

{
    "action": "Gs2Mission:IncreaseCounterByUserId",
    "request": {
        "namespaceName": "[string]Namespace name",
        "counterName": "[string]Counter Name",
        "userId": "[string]User Id",
        "value": "[long]Value to be added",
        "timeOffsetToken": "[string]Time offset token"
    }
}

action: Gs2Mission:IncreaseCounterByUserId
request:
  namespaceName: "[string]Namespace name"
  counterName: "[string]Counter Name"
  userId: "[string]User Id"
  value: "[long]Value to be added"
  timeOffsetToken: "[string]Time offset token"

transaction.service("mission").acquire.increase_counter_by_user_id({
    namespaceName="[string]Namespace name",
    counterName="[string]Counter Name",
    userId="[string]User Id",
    value="[long]Value to be added",
    timeOffsetToken="[string]Time offset token",
})

Gs2Mission:SetCounterByUserId

Set counter by specifying a user ID

Actions for which quantity can be specified: NO

Reversible action: NO

	Type	Description
namespaceName	string	Namespace name
counterName	string	Counter Name
userId	string	Set `#{userId}` to replace the currently logged in user ID.
values	ScopedValue[]	List of values to be set
timeOffsetToken	string	Time offset token

{
    "action": "Gs2Mission:SetCounterByUserId",
    "request": {
        "namespaceName": "[string]Namespace name",
        "counterName": "[string]Counter Name",
        "userId": "[string]User Id",
        "values": [
            {
                "scopeType": "[string]Scope type",
                "resetType": "[string]Reset timing",
                "conditionName": "[string]Condition Name",
                "value": "[long]Count value",
                "nextResetAt": "[long]Next reset timing",
                "updatedAt": "[long]Datetime of last update"
            }
        ],
        "timeOffsetToken": "[string]Time offset token"
    }
}

action: Gs2Mission:SetCounterByUserId
request:
  namespaceName: "[string]Namespace name"
  counterName: "[string]Counter Name"
  userId: "[string]User Id"
  values: 
    - scopeType: "[string]Scope type"
      resetType: "[string]Reset timing"
      conditionName: "[string]Condition Name"
      value: "[long]Count value"
      nextResetAt: "[long]Next reset timing"
      updatedAt: "[long]Datetime of last update"
  timeOffsetToken: "[string]Time offset token"

transaction.service("mission").acquire.set_counter_by_user_id({
    namespaceName="[string]Namespace name",
    counterName="[string]Counter Name",
    userId="[string]User Id",
    values={
        {
            scopeType="[string]Scope type",
            resetType="[string]Reset timing",
            conditionName="[string]Condition Name",
            value="[long]Count value",
            nextResetAt="[long]Next reset timing",
            updatedAt="[long]Datetime of last update"
        }
    },
    timeOffsetToken="[string]Time offset token",
})