GS2-LoginReward Transaction Actions

Specification of verify/consume/acquire transaction actions

ConsumeAction

Gs2LoginReward:MarkReceivedByUserId

Mark as received by specifying a user ID

Manually marks a specific step as received for the specified user’s bonus model.

Supports quantity specification: NO

Whether the action is reversible: YES

	Type	Required	Value Limits	Description
namespaceName	string	✓	~ 128 chars	Namespace name Namespace-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.).
bonusModelName	string	✓	~ 128 chars	Bonus Model Name The name of the Login Bonus Model that this receive status is associated with. Links the user’s receive progress to a specific bonus model definition, determining which reward list and distribution rules apply.
userId	string	✓	~ 128 chars	User ID Set `#{userId}` to replace the currently logged in user ID.
stepNumber	int	✓	0 ~ 100	Step Number
timeOffsetToken	string		~ 1024 chars	Time offset token

{
    "action": "Gs2LoginReward:MarkReceivedByUserId",
    "request": {
        "namespaceName": "[string]Namespace name",
        "bonusModelName": "[string]Bonus Model Name",
        "userId": "[string]User ID",
        "stepNumber": "[int]Step Number",
        "timeOffsetToken": "[string]Time offset token"
    }
}

action: Gs2LoginReward:MarkReceivedByUserId
request:
  namespaceName: "[string]Namespace name"
  bonusModelName: "[string]Bonus Model Name"
  userId: "[string]User ID"
  stepNumber: "[int]Step Number"
  timeOffsetToken: "[string]Time offset token"

transaction.service("loginReward").consume.mark_received_by_user_id({
    namespaceName="[string]Namespace name",
    bonusModelName="[string]Bonus Model Name",
    userId="[string]User ID",
    stepNumber="[int]Step Number",
    timeOffsetToken="[string]Time offset token",
})

AcquireAction

Gs2LoginReward:DeleteReceiveStatusByUserId

Delete Receive Status by specifying a user ID

Deletes all receive status data for the specified user’s bonus model, completely resetting the bonus progress.

Supports 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 (.).
bonusModelName	string	✓	~ 128 chars	Bonus Model Name The name of the Login Bonus Model that this receive status is associated with. Links the user’s receive progress to a specific bonus model definition, determining which reward list and distribution rules apply.
userId	string	✓	~ 128 chars	User ID Set `#{userId}` to replace the currently logged in user ID.
timeOffsetToken	string		~ 1024 chars	Time offset token

{
    "action": "Gs2LoginReward:DeleteReceiveStatusByUserId",
    "request": {
        "namespaceName": "[string]Namespace name",
        "bonusModelName": "[string]Bonus Model Name",
        "userId": "[string]User ID",
        "timeOffsetToken": "[string]Time offset token"
    }
}

action: Gs2LoginReward:DeleteReceiveStatusByUserId
request:
  namespaceName: "[string]Namespace name"
  bonusModelName: "[string]Bonus Model Name"
  userId: "[string]User ID"
  timeOffsetToken: "[string]Time offset token"

transaction.service("loginReward").acquire.delete_receive_status_by_user_id({
    namespaceName="[string]Namespace name",
    bonusModelName="[string]Bonus Model Name",
    userId="[string]User ID",
    timeOffsetToken="[string]Time offset token",
})

Gs2LoginReward:UnmarkReceivedByUserId

Unmark as received by specifying a user ID

Reverses a previously marked step back to unreceived for the specified user’s bonus model. If the specified step was not marked as received, an error is returned.

Supports quantity specification: NO

Whether the action is reversible: YES

	Type	Required	Value Limits	Description
namespaceName	string	✓	~ 128 chars	Namespace name Namespace-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.).
bonusModelName	string	✓	~ 128 chars	Bonus Model Name The name of the Login Bonus Model that this receive status is associated with. Links the user’s receive progress to a specific bonus model definition, determining which reward list and distribution rules apply.
userId	string	✓	~ 128 chars	User ID Set `#{userId}` to replace the currently logged in user ID.
stepNumber	int	✓	0 ~ 100	Step Number
timeOffsetToken	string		~ 1024 chars	Time offset token

{
    "action": "Gs2LoginReward:UnmarkReceivedByUserId",
    "request": {
        "namespaceName": "[string]Namespace name",
        "bonusModelName": "[string]Bonus Model Name",
        "userId": "[string]User ID",
        "stepNumber": "[int]Step Number",
        "timeOffsetToken": "[string]Time offset token"
    }
}

action: Gs2LoginReward:UnmarkReceivedByUserId
request:
  namespaceName: "[string]Namespace name"
  bonusModelName: "[string]Bonus Model Name"
  userId: "[string]User ID"
  stepNumber: "[int]Step Number"
  timeOffsetToken: "[string]Time offset token"

transaction.service("loginReward").acquire.unmark_received_by_user_id({
    namespaceName="[string]Namespace name",
    bonusModelName="[string]Bonus Model Name",
    userId="[string]User ID",
    stepNumber="[int]Step Number",
    timeOffsetToken="[string]Time offset token",
})