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

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

ConsumeAction

消費アクション

Gs2AdReward:ConsumePointByUserId

ユーザーIDを指定してポイントを消費

指定されたユーザーIDから指定された数のポイントを減算し、更新後のポイント情報を返します。
要求された消費量に対してポイントが不足している場合はエラーが返されます。
ネームスペースの消費スクリプト設定に GS2-Script が設定されている場合、ポイント減算前にスクリプトが実行され、カスタムバリデーションや消費量の変更が可能です。
ポイント減算後、ネームスペース設定で変更通知が構成されている場合は通知が送信されます。

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

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

型有効化条件必須デフォルト値の制限説明
namespaceNamestring
✓
~ 128文字ネームスペース名
ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。
userIdstring
✓
~ 128文字ユーザーID
#{userId} と設定することでログイン中のユーザーIDに置換されます。
pointlong
✓
1 ~ 9223372036854775805消費するポイント
timeOffsetTokenstring~ 1024文字タイムオフセットトークン
{
    "action": "Gs2AdReward:ConsumePointByUserId",
    "request": {
        "namespaceName": "[string]ネームスペース名",
        "userId": "[string]ユーザーID",
        "point": "[long]消費するポイント",
        "timeOffsetToken": "[string]タイムオフセットトークン"
    }
}
action: Gs2AdReward:ConsumePointByUserId
request:
  namespaceName: "[string]ネームスペース名"
  userId: "[string]ユーザーID"
  point: "[long]消費するポイント"
  timeOffsetToken: "[string]タイムオフセットトークン"
transaction.service("adReward").consume.consume_point_by_user_id({
    namespaceName="[string]ネームスペース名",
    userId="[string]ユーザーID",
    point="[long]消費するポイント",
    timeOffsetToken="[string]タイムオフセットトークン",
})

AcquireAction

入手アクション

Gs2AdReward:AcquirePointByUserId

ユーザーIDを指定してポイントを入手

指定されたユーザーIDに指定された数のポイントを追加し、更新後のポイント情報を返します。
ユーザーのポイントレコードが存在しない場合、ポイント追加前に新しいレコードが自動的に作成されます。
ネームスペースの入手スクリプト設定に GS2-Script が設定されている場合、ポイント追加前にスクリプトが実行され、カスタムバリデーションや入手量の変更が可能です。
ポイント追加後、ネームスペース設定で変更通知が構成されている場合は通知が送信されます。

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

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

型有効化条件必須デフォルト値の制限説明
namespaceNamestring
✓
~ 128文字ネームスペース名
ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。
userIdstring
✓
~ 128文字ユーザーID
#{userId} と設定することでログイン中のユーザーIDに置換されます。
pointlong
✓
1 ~ 9223372036854775805入手するポイント
timeOffsetTokenstring~ 1024文字タイムオフセットトークン
{
    "action": "Gs2AdReward:AcquirePointByUserId",
    "request": {
        "namespaceName": "[string]ネームスペース名",
        "userId": "[string]ユーザーID",
        "point": "[long]入手するポイント",
        "timeOffsetToken": "[string]タイムオフセットトークン"
    }
}
action: Gs2AdReward:AcquirePointByUserId
request:
  namespaceName: "[string]ネームスペース名"
  userId: "[string]ユーザーID"
  point: "[long]入手するポイント"
  timeOffsetToken: "[string]タイムオフセットトークン"
transaction.service("adReward").acquire.acquire_point_by_user_id({
    namespaceName="[string]ネームスペース名",
    userId="[string]ユーザーID",
    point="[long]入手するポイント",
    timeOffsetToken="[string]タイムオフセットトークン",
})