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

VerifyAction

検証アクション

Gs2Experience:VerifyRankByUserId

ユーザーIDを指定してランクを検証

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

説明
namespaceNamestringネームスペース名
userIdstring#{userId} と設定することでログイン中のユーザーIDに置換されます
experienceNamestring経験値モデルの名前
verifyTypeenum [
    “less”,
    “lessEqual”,
    “greater”,
    “greaterEqual”,
    “equal”,
    “notEqual”
]
検証の種類
propertyIdstringプロパティID
rankValuelong現在のランク
multiplyValueSpecifyingQuantitybool数量指定した際に、検証に使用する値も乗算するか
timeOffsetTokenstringタイムオフセットトークン

verifyType に指定する列挙型の定義

定義説明
lessランクが指定値未満であること
lessEqualランクが指定値以下であること
greaterランクが指定値超過であること
greaterEqualランクが指定値以上であること
equalランクが指定値と一致すること
notEqualランクが指定値と一致しないこと
{
    "action": "Gs2Experience:VerifyRankByUserId",
    "request": {
        "namespaceName": "[string]ネームスペース名",
        "userId": "[string]ユーザーID",
        "experienceName": "[string]経験値モデルの名前",
        "verifyType": "[string]検証の種類",
        "propertyId": "[string]プロパティID",
        "rankValue": "[long]現在のランク",
        "multiplyValueSpecifyingQuantity": "[bool]数量指定した際に、検証に使用する値も乗算するか",
        "timeOffsetToken": "[string]タイムオフセットトークン"
    }
}
action: Gs2Experience:VerifyRankByUserId
request:
  namespaceName: "[string]ネームスペース名"
  userId: "[string]ユーザーID"
  experienceName: "[string]経験値モデルの名前"
  verifyType: "[string]検証の種類"
  propertyId: "[string]プロパティID"
  rankValue: "[long]現在のランク"
  multiplyValueSpecifyingQuantity: "[bool]数量指定した際に、検証に使用する値も乗算するか"
  timeOffsetToken: "[string]タイムオフセットトークン"
transaction.service("experience").consume.verify_rank_by_user_id({
    namespaceName="[string]ネームスペース名",
    userId="[string]ユーザーID",
    experienceName="[string]経験値モデルの名前",
    verifyType="[string]検証の種類",
    propertyId="[string]プロパティID",
    rankValue="[long]現在のランク",
    multiplyValueSpecifyingQuantity="[bool]数量指定した際に、検証に使用する値も乗算するか",
    timeOffsetToken="[string]タイムオフセットトークン",
})

Gs2Experience:VerifyRankCapByUserId

ユーザーIDを指定してランクキャップを検証

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

説明
namespaceNamestringネームスペース名
userIdstring#{userId} と設定することでログイン中のユーザーIDに置換されます
experienceNamestring経験値モデルの名前
verifyTypeenum [
    “less”,
    “lessEqual”,
    “greater”,
    “greaterEqual”,
    “equal”,
    “notEqual”
]
検証の種類
propertyIdstringプロパティID
rankCapValuelong現在のランクキャップ
multiplyValueSpecifyingQuantitybool数量指定した際に、検証に使用する値も乗算するか
timeOffsetTokenstringタイムオフセットトークン

verifyType に指定する列挙型の定義

定義説明
lessランクが指定値未満であること
lessEqualランクが指定値以下であること
greaterランクが指定値超過であること
greaterEqualランクが指定値以上であること
equalランクが指定値と一致すること
notEqualランクが指定値と一致しないこと
{
    "action": "Gs2Experience:VerifyRankCapByUserId",
    "request": {
        "namespaceName": "[string]ネームスペース名",
        "userId": "[string]ユーザーID",
        "experienceName": "[string]経験値モデルの名前",
        "verifyType": "[string]検証の種類",
        "propertyId": "[string]プロパティID",
        "rankCapValue": "[long]現在のランクキャップ",
        "multiplyValueSpecifyingQuantity": "[bool]数量指定した際に、検証に使用する値も乗算するか",
        "timeOffsetToken": "[string]タイムオフセットトークン"
    }
}
action: Gs2Experience:VerifyRankCapByUserId
request:
  namespaceName: "[string]ネームスペース名"
  userId: "[string]ユーザーID"
  experienceName: "[string]経験値モデルの名前"
  verifyType: "[string]検証の種類"
  propertyId: "[string]プロパティID"
  rankCapValue: "[long]現在のランクキャップ"
  multiplyValueSpecifyingQuantity: "[bool]数量指定した際に、検証に使用する値も乗算するか"
  timeOffsetToken: "[string]タイムオフセットトークン"
transaction.service("experience").consume.verify_rank_cap_by_user_id({
    namespaceName="[string]ネームスペース名",
    userId="[string]ユーザーID",
    experienceName="[string]経験値モデルの名前",
    verifyType="[string]検証の種類",
    propertyId="[string]プロパティID",
    rankCapValue="[long]現在のランクキャップ",
    multiplyValueSpecifyingQuantity="[bool]数量指定した際に、検証に使用する値も乗算するか",
    timeOffsetToken="[string]タイムオフセットトークン",
})

ConsumeAction

消費アクション

Gs2Experience:SubExperienceByUserId

ユーザーIDを指定して経験値を減算

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

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

説明
namespaceNamestringネームスペース名
userIdstring#{userId} と設定することでログイン中のユーザーIDに置換されます
experienceNamestring経験値モデルの名前
propertyIdstringプロパティID
experienceValuelong失う経験値
timeOffsetTokenstringタイムオフセットトークン
{
    "action": "Gs2Experience:SubExperienceByUserId",
    "request": {
        "namespaceName": "[string]ネームスペース名",
        "userId": "[string]ユーザーID",
        "experienceName": "[string]経験値モデルの名前",
        "propertyId": "[string]プロパティID",
        "experienceValue": "[long]失う経験値",
        "timeOffsetToken": "[string]タイムオフセットトークン"
    }
}
action: Gs2Experience:SubExperienceByUserId
request:
  namespaceName: "[string]ネームスペース名"
  userId: "[string]ユーザーID"
  experienceName: "[string]経験値モデルの名前"
  propertyId: "[string]プロパティID"
  experienceValue: "[long]失う経験値"
  timeOffsetToken: "[string]タイムオフセットトークン"
transaction.service("experience").consume.sub_experience_by_user_id({
    namespaceName="[string]ネームスペース名",
    userId="[string]ユーザーID",
    experienceName="[string]経験値モデルの名前",
    propertyId="[string]プロパティID",
    experienceValue="[long]失う経験値",
    timeOffsetToken="[string]タイムオフセットトークン",
})

Gs2Experience:SubRankCapByUserId

ユーザーIDを指定してランクキャップを減算

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

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

説明
namespaceNamestringネームスペース名
userIdstring#{userId} と設定することでログイン中のユーザーIDに置換されます
experienceNamestring経験値モデルの名前
propertyIdstringプロパティID
rankCapValuelong現在のランクキャップ
timeOffsetTokenstringタイムオフセットトークン
{
    "action": "Gs2Experience:SubRankCapByUserId",
    "request": {
        "namespaceName": "[string]ネームスペース名",
        "userId": "[string]ユーザーID",
        "experienceName": "[string]経験値モデルの名前",
        "propertyId": "[string]プロパティID",
        "rankCapValue": "[long]現在のランクキャップ",
        "timeOffsetToken": "[string]タイムオフセットトークン"
    }
}
action: Gs2Experience:SubRankCapByUserId
request:
  namespaceName: "[string]ネームスペース名"
  userId: "[string]ユーザーID"
  experienceName: "[string]経験値モデルの名前"
  propertyId: "[string]プロパティID"
  rankCapValue: "[long]現在のランクキャップ"
  timeOffsetToken: "[string]タイムオフセットトークン"
transaction.service("experience").consume.sub_rank_cap_by_user_id({
    namespaceName="[string]ネームスペース名",
    userId="[string]ユーザーID",
    experienceName="[string]経験値モデルの名前",
    propertyId="[string]プロパティID",
    rankCapValue="[long]現在のランクキャップ",
    timeOffsetToken="[string]タイムオフセットトークン",
})

AcquireAction

入手アクション

Gs2Experience:AddExperienceByUserId

ユーザーIDを指定して経験値を加算

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

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

説明
namespaceNamestringネームスペース名
userIdstring#{userId} と設定することでログイン中のユーザーIDに置換されます
experienceNamestring経験値モデルの名前
propertyIdstringプロパティID
experienceValuelong獲得経験値
truncateExperienceWhenRankUpboolランクアップ時に残りの経験値を切り捨てるか
timeOffsetTokenstringタイムオフセットトークン
{
    "action": "Gs2Experience:AddExperienceByUserId",
    "request": {
        "namespaceName": "[string]ネームスペース名",
        "userId": "[string]ユーザーID",
        "experienceName": "[string]経験値モデルの名前",
        "propertyId": "[string]プロパティID",
        "experienceValue": "[long]獲得経験値",
        "truncateExperienceWhenRankUp": "[bool]ランクアップ時に残りの経験値を切り捨てるか",
        "timeOffsetToken": "[string]タイムオフセットトークン"
    }
}
action: Gs2Experience:AddExperienceByUserId
request:
  namespaceName: "[string]ネームスペース名"
  userId: "[string]ユーザーID"
  experienceName: "[string]経験値モデルの名前"
  propertyId: "[string]プロパティID"
  experienceValue: "[long]獲得経験値"
  truncateExperienceWhenRankUp: "[bool]ランクアップ時に残りの経験値を切り捨てるか"
  timeOffsetToken: "[string]タイムオフセットトークン"
transaction.service("experience").acquire.add_experience_by_user_id({
    namespaceName="[string]ネームスペース名",
    userId="[string]ユーザーID",
    experienceName="[string]経験値モデルの名前",
    propertyId="[string]プロパティID",
    experienceValue="[long]獲得経験値",
    truncateExperienceWhenRankUp="[bool]ランクアップ時に残りの経験値を切り捨てるか",
    timeOffsetToken="[string]タイムオフセットトークン",
})

Gs2Experience:SetExperienceByUserId

ユーザーIDを指定して経験値を設定

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

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

説明
namespaceNamestringネームスペース名
userIdstring#{userId} と設定することでログイン中のユーザーIDに置換されます
experienceNamestring経験値モデルの名前
propertyIdstringプロパティID
experienceValuelong累計獲得経験値
timeOffsetTokenstringタイムオフセットトークン
{
    "action": "Gs2Experience:SetExperienceByUserId",
    "request": {
        "namespaceName": "[string]ネームスペース名",
        "userId": "[string]ユーザーID",
        "experienceName": "[string]経験値モデルの名前",
        "propertyId": "[string]プロパティID",
        "experienceValue": "[long]累計獲得経験値",
        "timeOffsetToken": "[string]タイムオフセットトークン"
    }
}
action: Gs2Experience:SetExperienceByUserId
request:
  namespaceName: "[string]ネームスペース名"
  userId: "[string]ユーザーID"
  experienceName: "[string]経験値モデルの名前"
  propertyId: "[string]プロパティID"
  experienceValue: "[long]累計獲得経験値"
  timeOffsetToken: "[string]タイムオフセットトークン"
transaction.service("experience").acquire.set_experience_by_user_id({
    namespaceName="[string]ネームスペース名",
    userId="[string]ユーザーID",
    experienceName="[string]経験値モデルの名前",
    propertyId="[string]プロパティID",
    experienceValue="[long]累計獲得経験値",
    timeOffsetToken="[string]タイムオフセットトークン",
})

Gs2Experience:AddRankCapByUserId

ユーザーIDを指定してランクキャップを加算

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

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

説明
namespaceNamestringネームスペース名
userIdstring#{userId} と設定することでログイン中のユーザーIDに置換されます
experienceNamestring経験値モデルの名前
propertyIdstringプロパティID
rankCapValuelong現在のランクキャップ
timeOffsetTokenstringタイムオフセットトークン
{
    "action": "Gs2Experience:AddRankCapByUserId",
    "request": {
        "namespaceName": "[string]ネームスペース名",
        "userId": "[string]ユーザーID",
        "experienceName": "[string]経験値モデルの名前",
        "propertyId": "[string]プロパティID",
        "rankCapValue": "[long]現在のランクキャップ",
        "timeOffsetToken": "[string]タイムオフセットトークン"
    }
}
action: Gs2Experience:AddRankCapByUserId
request:
  namespaceName: "[string]ネームスペース名"
  userId: "[string]ユーザーID"
  experienceName: "[string]経験値モデルの名前"
  propertyId: "[string]プロパティID"
  rankCapValue: "[long]現在のランクキャップ"
  timeOffsetToken: "[string]タイムオフセットトークン"
transaction.service("experience").acquire.add_rank_cap_by_user_id({
    namespaceName="[string]ネームスペース名",
    userId="[string]ユーザーID",
    experienceName="[string]経験値モデルの名前",
    propertyId="[string]プロパティID",
    rankCapValue="[long]現在のランクキャップ",
    timeOffsetToken="[string]タイムオフセットトークン",
})

Gs2Experience:SetRankCapByUserId

ユーザーIDを指定してランクキャップを設定

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

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

説明
namespaceNamestringネームスペース名
userIdstring#{userId} と設定することでログイン中のユーザーIDに置換されます
experienceNamestring経験値モデルの名前
propertyIdstringプロパティID
rankCapValuelong現在のランクキャップ
timeOffsetTokenstringタイムオフセットトークン
{
    "action": "Gs2Experience:SetRankCapByUserId",
    "request": {
        "namespaceName": "[string]ネームスペース名",
        "userId": "[string]ユーザーID",
        "experienceName": "[string]経験値モデルの名前",
        "propertyId": "[string]プロパティID",
        "rankCapValue": "[long]現在のランクキャップ",
        "timeOffsetToken": "[string]タイムオフセットトークン"
    }
}
action: Gs2Experience:SetRankCapByUserId
request:
  namespaceName: "[string]ネームスペース名"
  userId: "[string]ユーザーID"
  experienceName: "[string]経験値モデルの名前"
  propertyId: "[string]プロパティID"
  rankCapValue: "[long]現在のランクキャップ"
  timeOffsetToken: "[string]タイムオフセットトークン"
transaction.service("experience").acquire.set_rank_cap_by_user_id({
    namespaceName="[string]ネームスペース名",
    userId="[string]ユーザーID",
    experienceName="[string]経験値モデルの名前",
    propertyId="[string]プロパティID",
    rankCapValue="[long]現在のランクキャップ",
    timeOffsetToken="[string]タイムオフセットトークン",
})

Gs2Experience:MultiplyAcquireActionsByUserId

ユーザーIDを指定して経験値の対象プロパティのランクに応じてリソースを加算

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

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

説明
namespaceNamestringネームスペース名
userIdstring#{userId} と設定することでログイン中のユーザーIDに置換されます
experienceNamestring経験値モデルの名前
propertyIdstringプロパティID
rateNamestring報酬加算テーブル名
acquireActionsAcquireAction[]入手アクションリスト
baseRatefloat基礎倍率
timeOffsetTokenstringタイムオフセットトークン
{
    "action": "Gs2Experience:MultiplyAcquireActionsByUserId",
    "request": {
        "namespaceName": "[string]ネームスペース名",
        "userId": "[string]ユーザーID",
        "experienceName": "[string]経験値モデルの名前",
        "propertyId": "[string]プロパティID",
        "rateName": "[string]報酬加算テーブル名",
        "acquireActions": [
            {
                "action": "[string]入手アクションで実行するアクションの種類",
                "request": "[string]リクエストのJSON"
            }
        ],
        "baseRate": "[float]基礎倍率",
        "timeOffsetToken": "[string]タイムオフセットトークン"
    }
}
action: Gs2Experience:MultiplyAcquireActionsByUserId
request:
  namespaceName: "[string]ネームスペース名"
  userId: "[string]ユーザーID"
  experienceName: "[string]経験値モデルの名前"
  propertyId: "[string]プロパティID"
  rateName: "[string]報酬加算テーブル名"
  acquireActions: 
    - action: "[string]入手アクションで実行するアクションの種類"
      request: "[string]リクエストのJSON"
  baseRate: "[float]基礎倍率"
  timeOffsetToken: "[string]タイムオフセットトークン"
transaction.service("experience").acquire.multiply_acquire_actions_by_user_id({
    namespaceName="[string]ネームスペース名",
    userId="[string]ユーザーID",
    experienceName="[string]経験値モデルの名前",
    propertyId="[string]プロパティID",
    rateName="[string]報酬加算テーブル名",
    acquireActions={
        {
            action="[string]入手アクションで実行するアクションの種類",
            request="[string]リクエストのJSON"
        }
    },
    baseRate="[float]基礎倍率",
    timeOffsetToken="[string]タイムオフセットトークン",
})