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

ConsumeAction

Gs2Limit:CountUpByUserId

ユーザIDを指定してカウントアップ

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

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

	型	説明
namespaceName	string	ネームスペース名
limitName	string	回数制限モデルの名前
counterName	string	カウンターの名前
userId	string	`#{userId}` と設定することでログイン中のユーザーIDに置換されます
countUpValue	int	カウントアップする量
maxValue	int	カウントアップを許容する最大値
timeOffsetToken	string	タイムオフセットトークン

{
    "action": "Gs2Limit:CountUpByUserId",
    "request": {
        "namespaceName": "[string]ネームスペース名",
        "limitName": "[string]回数制限モデルの名前",
        "counterName": "[string]カウンターの名前",
        "userId": "[string]ユーザーID",
        "countUpValue": "[int]カウントアップする量",
        "maxValue": "[int]カウントアップを許容する最大値",
        "timeOffsetToken": "[string]タイムオフセットトークン"
    }
}

action: Gs2Limit:CountUpByUserId
request:
  namespaceName: "[string]ネームスペース名"
  limitName: "[string]回数制限モデルの名前"
  counterName: "[string]カウンターの名前"
  userId: "[string]ユーザーID"
  countUpValue: "[int]カウントアップする量"
  maxValue: "[int]カウントアップを許容する最大値"
  timeOffsetToken: "[string]タイムオフセットトークン"

transaction.service("limit").consume.count_up_by_user_id({
    namespaceName="[string]ネームスペース名",
    limitName="[string]回数制限モデルの名前",
    counterName="[string]カウンターの名前",
    userId="[string]ユーザーID",
    countUpValue="[int]カウントアップする量",
    maxValue="[int]カウントアップを許容する最大値",
    timeOffsetToken="[string]タイムオフセットトークン",
})

Gs2Limit:VerifyCounterByUserId

ユーザーIDを指定してカウンター値を検証

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

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

	型	説明
namespaceName	string	ネームスペース名
userId	string	`#{userId}` と設定することでログイン中のユーザーIDに置換されます
limitName	string	回数制限モデルの名前
counterName	string	カウンターの名前
verifyType	enum [ “less”, “lessEqual”, “greater”, “greaterEqual”, “equal”, “notEqual” ]	検証の種類
count	int	カウント値
multiplyValueSpecifyingQuantity	bool	数量指定した際に、検証に使用する値も乗算するか
timeOffsetToken	string	タイムオフセットトークン

{
    "action": "Gs2Limit:VerifyCounterByUserId",
    "request": {
        "namespaceName": "[string]ネームスペース名",
        "userId": "[string]ユーザーID",
        "limitName": "[string]回数制限モデルの名前",
        "counterName": "[string]カウンターの名前",
        "verifyType": "[string]検証の種類",
        "count": "[int]カウント値",
        "multiplyValueSpecifyingQuantity": "[bool]数量指定した際に、検証に使用する値も乗算するか",
        "timeOffsetToken": "[string]タイムオフセットトークン"
    }
}

action: Gs2Limit:VerifyCounterByUserId
request:
  namespaceName: "[string]ネームスペース名"
  userId: "[string]ユーザーID"
  limitName: "[string]回数制限モデルの名前"
  counterName: "[string]カウンターの名前"
  verifyType: "[string]検証の種類"
  count: "[int]カウント値"
  multiplyValueSpecifyingQuantity: "[bool]数量指定した際に、検証に使用する値も乗算するか"
  timeOffsetToken: "[string]タイムオフセットトークン"

transaction.service("limit").consume.verify_counter_by_user_id({
    namespaceName="[string]ネームスペース名",
    userId="[string]ユーザーID",
    limitName="[string]回数制限モデルの名前",
    counterName="[string]カウンターの名前",
    verifyType="[string]検証の種類",
    count="[int]カウント値",
    multiplyValueSpecifyingQuantity="[bool]数量指定した際に、検証に使用する値も乗算するか",
    timeOffsetToken="[string]タイムオフセットトークン",
})

AcquireAction

Gs2Limit:CountDownByUserId

ユーザIDを指定してカウントダウン

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

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

	型	説明
namespaceName	string	ネームスペース名
limitName	string	回数制限モデルの名前
counterName	string	カウンターの名前
userId	string	`#{userId}` と設定することでログイン中のユーザーIDに置換されます
countDownValue	int	カウントダウンする量
timeOffsetToken	string	タイムオフセットトークン

{
    "action": "Gs2Limit:CountDownByUserId",
    "request": {
        "namespaceName": "[string]ネームスペース名",
        "limitName": "[string]回数制限モデルの名前",
        "counterName": "[string]カウンターの名前",
        "userId": "[string]ユーザーID",
        "countDownValue": "[int]カウントダウンする量",
        "timeOffsetToken": "[string]タイムオフセットトークン"
    }
}

action: Gs2Limit:CountDownByUserId
request:
  namespaceName: "[string]ネームスペース名"
  limitName: "[string]回数制限モデルの名前"
  counterName: "[string]カウンターの名前"
  userId: "[string]ユーザーID"
  countDownValue: "[int]カウントダウンする量"
  timeOffsetToken: "[string]タイムオフセットトークン"

transaction.service("limit").acquire.count_down_by_user_id({
    namespaceName="[string]ネームスペース名",
    limitName="[string]回数制限モデルの名前",
    counterName="[string]カウンターの名前",
    userId="[string]ユーザーID",
    countDownValue="[int]カウントダウンする量",
    timeOffsetToken="[string]タイムオフセットトークン",
})

Gs2Limit:DeleteCounterByUserId

ユーザIDを指定してカウンターを削除

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

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

	型	説明
namespaceName	string	ネームスペース名
limitName	string	回数制限モデルの名前
userId	string	`#{userId}` と設定することでログイン中のユーザーIDに置換されます
counterName	string	カウンターの名前
timeOffsetToken	string	タイムオフセットトークン

{
    "action": "Gs2Limit:DeleteCounterByUserId",
    "request": {
        "namespaceName": "[string]ネームスペース名",
        "limitName": "[string]回数制限モデルの名前",
        "userId": "[string]ユーザーID",
        "counterName": "[string]カウンターの名前",
        "timeOffsetToken": "[string]タイムオフセットトークン"
    }
}

action: Gs2Limit:DeleteCounterByUserId
request:
  namespaceName: "[string]ネームスペース名"
  limitName: "[string]回数制限モデルの名前"
  userId: "[string]ユーザーID"
  counterName: "[string]カウンターの名前"
  timeOffsetToken: "[string]タイムオフセットトークン"

transaction.service("limit").acquire.delete_counter_by_user_id({
    namespaceName="[string]ネームスペース名",
    limitName="[string]回数制限モデルの名前",
    userId="[string]ユーザーID",
    counterName="[string]カウンターの名前",
    timeOffsetToken="[string]タイムオフセットトークン",
})