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

ConsumeAction

Gs2Inventory:ConsumeItemSetByUserId

ユーザーIDを指定してインベントリのアイテムを消費

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

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

説明
namespaceNamestringネームスペース名
inventoryNamestringインベントリモデルの名前
userIdstring#{userId} と設定することでログイン中のユーザーIDに置換されます
itemNamestringアイテムモデルの名前
consumeCountlong消費する量
itemSetNamestringアイテムセットを識別する名前
{
    "action": "Gs2Inventory:ConsumeItemSetByUserId",
    "request": {
        "namespaceName": "[string]ネームスペース名",
        "inventoryName": "[string]インベントリモデルの名前",
        "userId": "[string]ユーザーID",
        "itemName": "[string]アイテムモデルの名前",
        "consumeCount": "[long]消費する量",
        "itemSetName": "[string]アイテムセットを識別する名前"
    }
}
action: Gs2Inventory:ConsumeItemSetByUserId
request:
  namespaceName: "[string]ネームスペース名"
  inventoryName: "[string]インベントリモデルの名前"
  userId: "[string]ユーザーID"
  itemName: "[string]アイテムモデルの名前"
  consumeCount: "[long]消費する量"
  itemSetName: "[string]アイテムセットを識別する名前"

Gs2Inventory:VerifyItemSetByUserId

ユーザーIDを指定して所持数量を検証

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

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

説明
namespaceNamestringネームスペース名
userIdstring#{userId} と設定することでログイン中のユーザーIDに置換されます
inventoryNamestringインベントリモデル名
itemNamestringアイテムモデルの名前
verifyTypeenum [’less’, ’lessEqual’, ‘greater’, ‘greaterEqual’, ’equal’, ’notEqual’]検証の種類
itemSetNamestringアイテムセットを識別する名前
countlong所持数量
{
    "action": "Gs2Inventory:VerifyItemSetByUserId",
    "request": {
        "namespaceName": "[string]ネームスペース名",
        "userId": "[string]ユーザーID",
        "inventoryName": "[string]インベントリモデル名",
        "itemName": "[string]アイテムモデルの名前",
        "verifyType": "[string]検証の種類",
        "itemSetName": "[string]アイテムセットを識別する名前",
        "count": "[long]所持数量"
    }
}
action: Gs2Inventory:VerifyItemSetByUserId
request:
  namespaceName: "[string]ネームスペース名"
  userId: "[string]ユーザーID"
  inventoryName: "[string]インベントリモデル名"
  itemName: "[string]アイテムモデルの名前"
  verifyType: "[string]検証の種類"
  itemSetName: "[string]アイテムセットを識別する名前"
  count: "[long]所持数量"

Gs2Inventory:VerifyReferenceOfByUserId

ユーザーIDを指定して参照元に関する検証

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

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

説明
namespaceNamestringネームスペース名
inventoryNamestringインベントリモデルの名前
userIdstring#{userId} と設定することでログイン中のユーザーIDに置換されます
itemNamestringアイテムモデルの名前
itemSetNamestringアイテムセットを識別する名前
referenceOfstringこの所持品の参照元
verifyTypeenum [’not_entry’, ‘already_entry’, ’empty’, ’not_empty’]検証の種類
{
    "action": "Gs2Inventory:VerifyReferenceOfByUserId",
    "request": {
        "namespaceName": "[string]ネームスペース名",
        "inventoryName": "[string]インベントリモデルの名前",
        "userId": "[string]ユーザーID",
        "itemName": "[string]アイテムモデルの名前",
        "itemSetName": "[string]アイテムセットを識別する名前",
        "referenceOf": "[string]この所持品の参照元",
        "verifyType": "[string]検証の種類"
    }
}
action: Gs2Inventory:VerifyReferenceOfByUserId
request:
  namespaceName: "[string]ネームスペース名"
  inventoryName: "[string]インベントリモデルの名前"
  userId: "[string]ユーザーID"
  itemName: "[string]アイテムモデルの名前"
  itemSetName: "[string]アイテムセットを識別する名前"
  referenceOf: "[string]この所持品の参照元"
  verifyType: "[string]検証の種類"

Gs2Inventory:ConsumeSimpleItemsByUserId

ユーザーIDを指定してシンプルインベントリのシンプルアイテムを消費

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

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

説明
namespaceNamestringネームスペース名
inventoryNamestringシンプルインベントリモデル名
userIdstring#{userId} と設定することでログイン中のユーザーIDに置換されます
consumeCountsConsumeCount[]シンプルアイテムの消費数量リスト
{
    "action": "Gs2Inventory:ConsumeSimpleItemsByUserId",
    "request": {
        "namespaceName": "[string]ネームスペース名",
        "inventoryName": "[string]シンプルインベントリモデル名",
        "userId": "[string]ユーザーID",
        "consumeCounts": [
            {
                "itemName": "[string]シンプルアイテムモデルの名前",
                "count": "[long]消費する量"
            }
        ]
    }
}
action: Gs2Inventory:ConsumeSimpleItemsByUserId
request:
  namespaceName: "[string]ネームスペース名"
  inventoryName: "[string]シンプルインベントリモデル名"
  userId: "[string]ユーザーID"
  consumeCounts: 
  - itemName: "[string]シンプルアイテムモデルの名前"
    count: "[long]消費する量"

Gs2Inventory:VerifySimpleItemByUserId

ユーザーIDを指定して所持数量を検証

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

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

説明
namespaceNamestringネームスペース名
userIdstring#{userId} と設定することでログイン中のユーザーIDに置換されます
inventoryNamestringシンプルインベントリモデル名
itemNamestringシンプルアイテムモデルの名前
verifyTypeenum [’less’, ’lessEqual’, ‘greater’, ‘greaterEqual’, ’equal’, ’notEqual’]検証の種類
countlong所持数量
{
    "action": "Gs2Inventory:VerifySimpleItemByUserId",
    "request": {
        "namespaceName": "[string]ネームスペース名",
        "userId": "[string]ユーザーID",
        "inventoryName": "[string]シンプルインベントリモデル名",
        "itemName": "[string]シンプルアイテムモデルの名前",
        "verifyType": "[string]検証の種類",
        "count": "[long]所持数量"
    }
}
action: Gs2Inventory:VerifySimpleItemByUserId
request:
  namespaceName: "[string]ネームスペース名"
  userId: "[string]ユーザーID"
  inventoryName: "[string]シンプルインベントリモデル名"
  itemName: "[string]シンプルアイテムモデルの名前"
  verifyType: "[string]検証の種類"
  count: "[long]所持数量"

Gs2Inventory:ConsumeBigItemByUserId

ユーザーIDを指定して巨大インベントリの巨大アイテムを消費

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

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

説明
namespaceNamestringネームスペース名
inventoryNamestring巨大インベントリモデル名
userIdstring#{userId} と設定することでログイン中のユーザーIDに置換されます
itemNamestring巨大アイテムモデル名
consumeCountstring巨大アイテムの消費数量
{
    "action": "Gs2Inventory:ConsumeBigItemByUserId",
    "request": {
        "namespaceName": "[string]ネームスペース名",
        "inventoryName": "[string]巨大インベントリモデル名",
        "userId": "[string]ユーザーID",
        "itemName": "[string]巨大アイテムモデル名",
        "consumeCount": "[string]巨大アイテムの消費数量"
    }
}
action: Gs2Inventory:ConsumeBigItemByUserId
request:
  namespaceName: "[string]ネームスペース名"
  inventoryName: "[string]巨大インベントリモデル名"
  userId: "[string]ユーザーID"
  itemName: "[string]巨大アイテムモデル名"
  consumeCount: "[string]巨大アイテムの消費数量"

Gs2Inventory:VerifyBigItemByUserId

ユーザーIDを指定して所持数量を検証

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

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

説明
namespaceNamestringネームスペース名
userIdstring#{userId} と設定することでログイン中のユーザーIDに置換されます
inventoryNamestring巨大インベントリモデル名
itemNamestring巨大アイテムモデルの名前
verifyTypeenum [’less’, ’lessEqual’, ‘greater’, ‘greaterEqual’, ’equal’, ’notEqual’]検証の種類
countstring所持数量
{
    "action": "Gs2Inventory:VerifyBigItemByUserId",
    "request": {
        "namespaceName": "[string]ネームスペース名",
        "userId": "[string]ユーザーID",
        "inventoryName": "[string]巨大インベントリモデル名",
        "itemName": "[string]巨大アイテムモデルの名前",
        "verifyType": "[string]検証の種類",
        "count": "[string]所持数量"
    }
}
action: Gs2Inventory:VerifyBigItemByUserId
request:
  namespaceName: "[string]ネームスペース名"
  userId: "[string]ユーザーID"
  inventoryName: "[string]巨大インベントリモデル名"
  itemName: "[string]巨大アイテムモデルの名前"
  verifyType: "[string]検証の種類"
  count: "[string]所持数量"

AcquireAction

Gs2Inventory:AddCapacityByUserId

キャパシティサイズを加算

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

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

説明
namespaceNamestringネームスペース名
inventoryNamestringインベントリモデル名
userIdstring#{userId} と設定することでログイン中のユーザーIDに置換されます
addCapacityValueint加算するキャパシティサイズ
{
    "action": "Gs2Inventory:AddCapacityByUserId",
    "request": {
        "namespaceName": "[string]ネームスペース名",
        "inventoryName": "[string]インベントリモデル名",
        "userId": "[string]ユーザーID",
        "addCapacityValue": "[int]加算するキャパシティサイズ"
    }
}
action: Gs2Inventory:AddCapacityByUserId
request:
  namespaceName: "[string]ネームスペース名"
  inventoryName: "[string]インベントリモデル名"
  userId: "[string]ユーザーID"
  addCapacityValue: "[int]加算するキャパシティサイズ"

Gs2Inventory:SetCapacityByUserId

キャパシティサイズを設定

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

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

説明
namespaceNamestringネームスペース名
inventoryNamestringインベントリモデル名
userIdstring#{userId} と設定することでログイン中のユーザーIDに置換されます
newCapacityValueintインベントリの新しい最大キャパシティ
{
    "action": "Gs2Inventory:SetCapacityByUserId",
    "request": {
        "namespaceName": "[string]ネームスペース名",
        "inventoryName": "[string]インベントリモデル名",
        "userId": "[string]ユーザーID",
        "newCapacityValue": "[int]インベントリの新しい最大キャパシティ"
    }
}
action: Gs2Inventory:SetCapacityByUserId
request:
  namespaceName: "[string]ネームスペース名"
  inventoryName: "[string]インベントリモデル名"
  userId: "[string]ユーザーID"
  newCapacityValue: "[int]インベントリの新しい最大キャパシティ"

Gs2Inventory:AcquireItemSetByUserId

アイテムをインベントリに追加

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

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

説明
namespaceNamestringネームスペース名
inventoryNamestringインベントリモデル名
itemNamestringアイテムモデルの名前
userIdstring#{userId} と設定することでログイン中のユーザーIDに置換されます
acquireCountlong入手する量
expiresAtlong有効期限
createNewItemSetbool既存の ItemSet に空きがあったとしても、新しい ItemSet を作成するか
itemSetNamestringアイテムセットを識別する名前
{
    "action": "Gs2Inventory:AcquireItemSetByUserId",
    "request": {
        "namespaceName": "[string]ネームスペース名",
        "inventoryName": "[string]インベントリモデル名",
        "itemName": "[string]アイテムモデルの名前",
        "userId": "[string]ユーザーID",
        "acquireCount": "[long]入手する量",
        "expiresAt": "[long]有効期限",
        "createNewItemSet": "[bool]既存の ItemSet に空きがあったとしても、新しい ItemSet を作成するか",
        "itemSetName": "[string]アイテムセットを識別する名前"
    }
}
action: Gs2Inventory:AcquireItemSetByUserId
request:
  namespaceName: "[string]ネームスペース名"
  inventoryName: "[string]インベントリモデル名"
  itemName: "[string]アイテムモデルの名前"
  userId: "[string]ユーザーID"
  acquireCount: "[long]入手する量"
  expiresAt: "[long]有効期限"
  createNewItemSet: "[bool]既存の ItemSet に空きがあったとしても、新しい ItemSet を作成するか"
  itemSetName: "[string]アイテムセットを識別する名前"

Gs2Inventory:AddReferenceOfByUserId

ユーザーIDを指定して参照元を追加

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

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

説明
namespaceNamestringネームスペース名
inventoryNamestringインベントリモデルの名前
userIdstring#{userId} と設定することでログイン中のユーザーIDに置換されます
itemNamestringアイテムモデルの名前
itemSetNamestringアイテムセットを識別する名前
referenceOfstringこの所持品の参照元
{
    "action": "Gs2Inventory:AddReferenceOfByUserId",
    "request": {
        "namespaceName": "[string]ネームスペース名",
        "inventoryName": "[string]インベントリモデルの名前",
        "userId": "[string]ユーザーID",
        "itemName": "[string]アイテムモデルの名前",
        "itemSetName": "[string]アイテムセットを識別する名前",
        "referenceOf": "[string]この所持品の参照元"
    }
}
action: Gs2Inventory:AddReferenceOfByUserId
request:
  namespaceName: "[string]ネームスペース名"
  inventoryName: "[string]インベントリモデルの名前"
  userId: "[string]ユーザーID"
  itemName: "[string]アイテムモデルの名前"
  itemSetName: "[string]アイテムセットを識別する名前"
  referenceOf: "[string]この所持品の参照元"

Gs2Inventory:DeleteReferenceOfByUserId

ユーザーIDを指定して参照元を削除

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

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

説明
namespaceNamestringネームスペース名
inventoryNamestringインベントリモデルの名前
userIdstring#{userId} と設定することでログイン中のユーザーIDに置換されます
itemNamestringアイテムモデルの名前
itemSetNamestringアイテムセットを識別する名前
referenceOfstringこの所持品の参照元
{
    "action": "Gs2Inventory:DeleteReferenceOfByUserId",
    "request": {
        "namespaceName": "[string]ネームスペース名",
        "inventoryName": "[string]インベントリモデルの名前",
        "userId": "[string]ユーザーID",
        "itemName": "[string]アイテムモデルの名前",
        "itemSetName": "[string]アイテムセットを識別する名前",
        "referenceOf": "[string]この所持品の参照元"
    }
}
action: Gs2Inventory:DeleteReferenceOfByUserId
request:
  namespaceName: "[string]ネームスペース名"
  inventoryName: "[string]インベントリモデルの名前"
  userId: "[string]ユーザーID"
  itemName: "[string]アイテムモデルの名前"
  itemSetName: "[string]アイテムセットを識別する名前"
  referenceOf: "[string]この所持品の参照元"

Gs2Inventory:AcquireSimpleItemsByUserId

シンプルアイテムをシンプルインベントリに追加

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

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

説明
namespaceNamestringネームスペース名
inventoryNamestringシンプルインベントリモデル名
userIdstring#{userId} と設定することでログイン中のユーザーIDに置換されます
acquireCountsAcquireCount[]シンプルアイテムの入手数量リスト
{
    "action": "Gs2Inventory:AcquireSimpleItemsByUserId",
    "request": {
        "namespaceName": "[string]ネームスペース名",
        "inventoryName": "[string]シンプルインベントリモデル名",
        "userId": "[string]ユーザーID",
        "acquireCounts": [
            {
                "itemName": "[string]シンプルアイテムモデルの名前",
                "count": "[long]入手する量"
            }
        ]
    }
}
action: Gs2Inventory:AcquireSimpleItemsByUserId
request:
  namespaceName: "[string]ネームスペース名"
  inventoryName: "[string]シンプルインベントリモデル名"
  userId: "[string]ユーザーID"
  acquireCounts: 
    - itemName: "[string]シンプルアイテムモデルの名前"
      count: "[long]入手する量"

Gs2Inventory:AcquireBigItemByUserId

巨大アイテムを巨大インベントリに追加

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

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

説明
namespaceNamestringネームスペース名
inventoryNamestring巨大インベントリモデル名
userIdstring#{userId} と設定することでログイン中のユーザーIDに置換されます
itemNamestring巨大アイテムモデル名
acquireCountstring巨大アイテムの入手数量
{
    "action": "Gs2Inventory:AcquireBigItemByUserId",
    "request": {
        "namespaceName": "[string]ネームスペース名",
        "inventoryName": "[string]巨大インベントリモデル名",
        "userId": "[string]ユーザーID",
        "itemName": "[string]巨大アイテムモデル名",
        "acquireCount": "[string]巨大アイテムの入手数量"
    }
}
action: Gs2Inventory:AcquireBigItemByUserId
request:
  namespaceName: "[string]ネームスペース名"
  inventoryName: "[string]巨大インベントリモデル名"
  userId: "[string]ユーザーID"
  itemName: "[string]巨大アイテムモデル名"
  acquireCount: "[string]巨大アイテムの入手数量"