GS2-LoginReward トランザクションアクション

検証/消費/入手の各トランザクションアクションの仕様

Consume Action

消費アクション

Gs2LoginReward:MarkReceivedByUserId

ユーザーIDを指定して受け取り済み化

指定されたユーザーのボーナスモデルで特定のステップを手動で受け取り済みにマークします。

数量指定可能なアクション：いいえ

反転可能なアクション：はい

	型	必須	値の制限	説明
namespaceName	string	✓	~ 128文字	ネームスペース名ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。
bonusModelName	string	✓	~ 128文字	ボーナスモデル名この受け取り状態が紐づくログインボーナスモデルの名前。ユーザーの受け取り進捗を特定のボーナスモデル定義に関連づけ、どの報酬リストと配布ルールが適用されるかを決定します。
userId	string	✓	~ 128文字	ユーザーID `#{userId}` と設定することでログイン中のユーザーIDに置換されます。
stepNumber	int	✓	0 ~ 100	ステップ番号
timeOffsetToken	string		~ 1024文字	タイムオフセットトークン

{
    "action": "Gs2LoginReward:MarkReceivedByUserId",
    "request": {
        "namespaceName": "[string]ネームスペース名",
        "bonusModelName": "[string]ボーナスモデル名",
        "userId": "[string]ユーザーID",
        "stepNumber": "[int]ステップ番号",
        "timeOffsetToken": "[string]タイムオフセットトークン"
    }
}

action: Gs2LoginReward:MarkReceivedByUserId
request:
  namespaceName: "[string]ネームスペース名"
  bonusModelName: "[string]ボーナスモデル名"
  userId: "[string]ユーザーID"
  stepNumber: "[int]ステップ番号"
  timeOffsetToken: "[string]タイムオフセットトークン"

transaction.service("loginReward").consume.mark_received_by_user_id({
    namespaceName="[string]ネームスペース名",
    bonusModelName="[string]ボーナスモデル名",
    userId="[string]ユーザーID",
    stepNumber="[int]ステップ番号",
    timeOffsetToken="[string]タイムオフセットトークン",
})

Acquire Action

入手アクション

Gs2LoginReward:DeleteReceiveStatusByUserId

ユーザーIDを指定して受け取り状態のリセット

指定されたユーザーのボーナスモデルの受け取り状態データを全て削除し、ボーナスの進捗を完全にリセットします。

数量指定可能なアクション：いいえ

反転可能なアクション：いいえ

	型	必須	値の制限	説明
namespaceName	string	✓	~ 128文字	ネームスペース名ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。
bonusModelName	string	✓	~ 128文字	ボーナスモデル名この受け取り状態が紐づくログインボーナスモデルの名前。ユーザーの受け取り進捗を特定のボーナスモデル定義に関連づけ、どの報酬リストと配布ルールが適用されるかを決定します。
userId	string	✓	~ 128文字	ユーザーID `#{userId}` と設定することでログイン中のユーザーIDに置換されます。
timeOffsetToken	string		~ 1024文字	タイムオフセットトークン

{
    "action": "Gs2LoginReward:DeleteReceiveStatusByUserId",
    "request": {
        "namespaceName": "[string]ネームスペース名",
        "bonusModelName": "[string]ボーナスモデル名",
        "userId": "[string]ユーザーID",
        "timeOffsetToken": "[string]タイムオフセットトークン"
    }
}

action: Gs2LoginReward:DeleteReceiveStatusByUserId
request:
  namespaceName: "[string]ネームスペース名"
  bonusModelName: "[string]ボーナスモデル名"
  userId: "[string]ユーザーID"
  timeOffsetToken: "[string]タイムオフセットトークン"

transaction.service("loginReward").acquire.delete_receive_status_by_user_id({
    namespaceName="[string]ネームスペース名",
    bonusModelName="[string]ボーナスモデル名",
    userId="[string]ユーザーID",
    timeOffsetToken="[string]タイムオフセットトークン",
})

Gs2LoginReward:UnmarkReceivedByUserId

ユーザーIDを指定して未受け取り化

指定されたユーザーのボーナスモデルで、受け取り済みにマークされたステップを未受け取りに戻します。
指定されたステップが受け取り済みでない場合、エラーが返されます。

数量指定可能なアクション：いいえ

反転可能なアクション：はい

	型	必須	値の制限	説明
namespaceName	string	✓	~ 128文字	ネームスペース名ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。
bonusModelName	string	✓	~ 128文字	ボーナスモデル名この受け取り状態が紐づくログインボーナスモデルの名前。ユーザーの受け取り進捗を特定のボーナスモデル定義に関連づけ、どの報酬リストと配布ルールが適用されるかを決定します。
userId	string	✓	~ 128文字	ユーザーID `#{userId}` と設定することでログイン中のユーザーIDに置換されます。
stepNumber	int	✓	0 ~ 100	ステップ番号
timeOffsetToken	string		~ 1024文字	タイムオフセットトークン

{
    "action": "Gs2LoginReward:UnmarkReceivedByUserId",
    "request": {
        "namespaceName": "[string]ネームスペース名",
        "bonusModelName": "[string]ボーナスモデル名",
        "userId": "[string]ユーザーID",
        "stepNumber": "[int]ステップ番号",
        "timeOffsetToken": "[string]タイムオフセットトークン"
    }
}

action: Gs2LoginReward:UnmarkReceivedByUserId
request:
  namespaceName: "[string]ネームスペース名"
  bonusModelName: "[string]ボーナスモデル名"
  userId: "[string]ユーザーID"
  stepNumber: "[int]ステップ番号"
  timeOffsetToken: "[string]タイムオフセットトークン"

transaction.service("loginReward").acquire.unmark_received_by_user_id({
    namespaceName="[string]ネームスペース名",
    bonusModelName="[string]ボーナスモデル名",
    userId="[string]ユーザーID",
    stepNumber="[int]ステップ番号",
    timeOffsetToken="[string]タイムオフセットトークン",
})