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

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

VerifyAction

検証アクション

Gs2Inventory:VerifyInventoryCurrentMaxCapacityByUserId

ユーザーIDを指定してインベントリの最大容量を検証

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

有効化条件必須デフォルト値の制限説明
namespaceNamestring
~ 128文字ネームスペース名
ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。
userIdstring
~ 128文字ユーザーID
#{userId} と設定することでログイン中のユーザーIDに置換されます。
inventoryNamestring
~ 128文字インベントリモデル名
verifyType文字列列挙型
enum {
  “less”,
  “lessEqual”,
  “greater”,
  “greaterEqual”,
  “equal”,
  “notEqual”
}
検証の種類
定義説明
“less”現在のインベントリの最大容量が指定値未満であること
“lessEqual”現在のインベントリの最大容量が指定値以下であること
“greater”現在のインベントリの最大容量が指定値超過であること
“greaterEqual”現在のインベントリの最大容量が指定値以上であること
“equal”現在のインベントリの最大容量が指定値と一致すること
“notEqual”現在のインベントリの最大容量が指定値と一致しないこと
currentInventoryMaxCapacityint
0 ~ 2147483646現在のインベントリの最大容量
multiplyValueSpecifyingQuantitybool
true数量指定した際に、検証に使用する値も乗算するか
timeOffsetTokenstring~ 1024文字タイムオフセットトークン
{
    "action": "Gs2Inventory:VerifyInventoryCurrentMaxCapacityByUserId",
    "request": {
        "namespaceName": "[string]ネームスペース名",
        "userId": "[string]ユーザーID",
        "inventoryName": "[string]インベントリモデル名",
        "verifyType": "[string]検証の種類",
        "currentInventoryMaxCapacity": "[int]現在のインベントリの最大容量",
        "multiplyValueSpecifyingQuantity": "[bool]数量指定した際に、検証に使用する値も乗算するか",
        "timeOffsetToken": "[string]タイムオフセットトークン"
    }
}
action: Gs2Inventory:VerifyInventoryCurrentMaxCapacityByUserId
request:
  namespaceName: "[string]ネームスペース名"
  userId: "[string]ユーザーID"
  inventoryName: "[string]インベントリモデル名"
  verifyType: "[string]検証の種類"
  currentInventoryMaxCapacity: "[int]現在のインベントリの最大容量"
  multiplyValueSpecifyingQuantity: "[bool]数量指定した際に、検証に使用する値も乗算するか"
  timeOffsetToken: "[string]タイムオフセットトークン"
transaction.service("inventory").verify.verify_inventory_current_max_capacity_by_user_id({
    namespaceName="[string]ネームスペース名",
    userId="[string]ユーザーID",
    inventoryName="[string]インベントリモデル名",
    verifyType="[string]検証の種類",
    currentInventoryMaxCapacity="[int]現在のインベントリの最大容量",
    multiplyValueSpecifyingQuantity="[bool]数量指定した際に、検証に使用する値も乗算するか",
    timeOffsetToken="[string]タイムオフセットトークン",
})

Gs2Inventory:VerifyItemSetByUserId

ユーザーIDを指定してアイテムセットの所持数量の検証

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

有効化条件必須デフォルト値の制限説明
namespaceNamestring
~ 128文字ネームスペース名
ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。
userIdstring
~ 128文字ユーザーID
#{userId} と設定することでログイン中のユーザーIDに置換されます。
inventoryNamestring
~ 128文字インベントリモデル名
インベントリモデル固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。
itemNamestring
~ 128文字アイテムモデル名
verifyType文字列列挙型
enum {
  “less”,
  “lessEqual”,
  “greater”,
  “greaterEqual”,
  “equal”,
  “notEqual”
}
検証の種類
定義説明
“less”所持数量が指定値未満であること
“lessEqual”所持数量が指定値以下であること
“greater”所持数量が指定値超過であること
“greaterEqual”所持数量が指定値以上であること
“equal”所持数量が指定値と一致すること
“notEqual”所持数量が指定値と一致しないこと
itemSetNamestring~ 36文字アイテムセットを識別する名前
countlong
0 ~ 9223372036854775805所持数量
multiplyValueSpecifyingQuantitybool
true数量指定した際に、検証に使用する値も乗算するか
timeOffsetTokenstring~ 1024文字タイムオフセットトークン
{
    "action": "Gs2Inventory:VerifyItemSetByUserId",
    "request": {
        "namespaceName": "[string]ネームスペース名",
        "userId": "[string]ユーザーID",
        "inventoryName": "[string]インベントリモデル名",
        "itemName": "[string]アイテムモデル名",
        "verifyType": "[string]検証の種類",
        "itemSetName": "[string]アイテムセットを識別する名前",
        "count": "[long]所持数量",
        "multiplyValueSpecifyingQuantity": "[bool]数量指定した際に、検証に使用する値も乗算するか",
        "timeOffsetToken": "[string]タイムオフセットトークン"
    }
}
action: Gs2Inventory:VerifyItemSetByUserId
request:
  namespaceName: "[string]ネームスペース名"
  userId: "[string]ユーザーID"
  inventoryName: "[string]インベントリモデル名"
  itemName: "[string]アイテムモデル名"
  verifyType: "[string]検証の種類"
  itemSetName: "[string]アイテムセットを識別する名前"
  count: "[long]所持数量"
  multiplyValueSpecifyingQuantity: "[bool]数量指定した際に、検証に使用する値も乗算するか"
  timeOffsetToken: "[string]タイムオフセットトークン"
transaction.service("inventory").verify.verify_item_set_by_user_id({
    namespaceName="[string]ネームスペース名",
    userId="[string]ユーザーID",
    inventoryName="[string]インベントリモデル名",
    itemName="[string]アイテムモデル名",
    verifyType="[string]検証の種類",
    itemSetName="[string]アイテムセットを識別する名前",
    count="[long]所持数量",
    multiplyValueSpecifyingQuantity="[bool]数量指定した際に、検証に使用する値も乗算するか",
    timeOffsetToken="[string]タイムオフセットトークン",
})

Gs2Inventory:VerifyReferenceOfByUserId

ユーザーIDを指定してアイテムの参照元を検証

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

有効化条件必須デフォルト値の制限説明
namespaceNamestring
~ 128文字ネームスペース名
ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。
inventoryNamestring
~ 128文字インベントリモデル名
userIdstring
~ 128文字ユーザーID
#{userId} と設定することでログイン中のユーザーIDに置換されます。
itemNamestring
~ 128文字アイテムモデル名
itemSetNamestring
UUID~ 36文字アイテムセットを識別する名前
アイテムセットの一意な名前を保持します。
名前は UUID(Universally Unique Identifier)フォーマットで自動的に生成され、各アイテムセットを識別するために使用されます。
referenceOfstring
~ 1024文字この所持品の参照元
verifyType文字列列挙型
enum {
  “not_entry”,
  “already_entry”,
  “empty”,
  “not_empty”
}
検証の種類
定義説明
“not_entry”指定した参照元がまだ登録されていないこと
“already_entry”指定した参照元が既に登録されていること
“empty”参照元として登録されている要素がゼロであること
“not_empty”参照元として登録されている要素が1以上であること
timeOffsetTokenstring~ 1024文字タイムオフセットトークン
{
    "action": "Gs2Inventory:VerifyReferenceOfByUserId",
    "request": {
        "namespaceName": "[string]ネームスペース名",
        "inventoryName": "[string]インベントリモデル名",
        "userId": "[string]ユーザーID",
        "itemName": "[string]アイテムモデル名",
        "itemSetName": "[string]アイテムセットを識別する名前",
        "referenceOf": "[string]この所持品の参照元",
        "verifyType": "[string]検証の種類",
        "timeOffsetToken": "[string]タイムオフセットトークン"
    }
}
action: Gs2Inventory:VerifyReferenceOfByUserId
request:
  namespaceName: "[string]ネームスペース名"
  inventoryName: "[string]インベントリモデル名"
  userId: "[string]ユーザーID"
  itemName: "[string]アイテムモデル名"
  itemSetName: "[string]アイテムセットを識別する名前"
  referenceOf: "[string]この所持品の参照元"
  verifyType: "[string]検証の種類"
  timeOffsetToken: "[string]タイムオフセットトークン"
transaction.service("inventory").verify.verify_reference_of_by_user_id({
    namespaceName="[string]ネームスペース名",
    inventoryName="[string]インベントリモデル名",
    userId="[string]ユーザーID",
    itemName="[string]アイテムモデル名",
    itemSetName="[string]アイテムセットを識別する名前",
    referenceOf="[string]この所持品の参照元",
    verifyType="[string]検証の種類",
    timeOffsetToken="[string]タイムオフセットトークン",
})

Gs2Inventory:VerifySimpleItemByUserId

ユーザーIDを指定してシンプルアイテムの所持数量を検証

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

有効化条件必須デフォルト値の制限説明
namespaceNamestring
~ 128文字ネームスペース名
ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。
userIdstring
~ 128文字ユーザーID
#{userId} と設定することでログイン中のユーザーIDに置換されます。
inventoryNamestring
~ 128文字シンプルインベントリモデル名
シンプルインベントリモデル固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。
itemNamestring
~ 128文字シンプルアイテムモデル名
verifyType文字列列挙型
enum {
  “less”,
  “lessEqual”,
  “greater”,
  “greaterEqual”,
  “equal”,
  “notEqual”
}
検証の種類
定義説明
“less”所持数量が指定値未満であること
“lessEqual”所持数量が指定値以下であること
“greater”所持数量が指定値超過であること
“greaterEqual”所持数量が指定値以上であること
“equal”所持数量が指定値と一致すること
“notEqual”所持数量が指定値と一致しないこと
countlong
0 ~ 9223372036854775805所持数量
multiplyValueSpecifyingQuantitybool
true数量指定した際に、検証に使用する値も乗算するか
timeOffsetTokenstring~ 1024文字タイムオフセットトークン
{
    "action": "Gs2Inventory:VerifySimpleItemByUserId",
    "request": {
        "namespaceName": "[string]ネームスペース名",
        "userId": "[string]ユーザーID",
        "inventoryName": "[string]シンプルインベントリモデル名",
        "itemName": "[string]シンプルアイテムモデル名",
        "verifyType": "[string]検証の種類",
        "count": "[long]所持数量",
        "multiplyValueSpecifyingQuantity": "[bool]数量指定した際に、検証に使用する値も乗算するか",
        "timeOffsetToken": "[string]タイムオフセットトークン"
    }
}
action: Gs2Inventory:VerifySimpleItemByUserId
request:
  namespaceName: "[string]ネームスペース名"
  userId: "[string]ユーザーID"
  inventoryName: "[string]シンプルインベントリモデル名"
  itemName: "[string]シンプルアイテムモデル名"
  verifyType: "[string]検証の種類"
  count: "[long]所持数量"
  multiplyValueSpecifyingQuantity: "[bool]数量指定した際に、検証に使用する値も乗算するか"
  timeOffsetToken: "[string]タイムオフセットトークン"
transaction.service("inventory").verify.verify_simple_item_by_user_id({
    namespaceName="[string]ネームスペース名",
    userId="[string]ユーザーID",
    inventoryName="[string]シンプルインベントリモデル名",
    itemName="[string]シンプルアイテムモデル名",
    verifyType="[string]検証の種類",
    count="[long]所持数量",
    multiplyValueSpecifyingQuantity="[bool]数量指定した際に、検証に使用する値も乗算するか",
    timeOffsetToken="[string]タイムオフセットトークン",
})

Gs2Inventory:VerifyBigItemByUserId

ユーザーIDを指定して巨大アイテムの所持数量を検証

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

有効化条件必須デフォルト値の制限説明
namespaceNamestring
~ 128文字ネームスペース名
ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。
userIdstring
~ 128文字ユーザーID
#{userId} と設定することでログイン中のユーザーIDに置換されます。
inventoryNamestring
~ 128文字巨大インベントリモデル名
巨大インベントリモデル固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。
itemNamestring
~ 128文字巨大アイテムモデル名
verifyType文字列列挙型
enum {
  “less”,
  “lessEqual”,
  “greater”,
  “greaterEqual”,
  “equal”,
  “notEqual”
}
検証の種類
定義説明
“less”所持数量が指定値未満であること
“lessEqual”所持数量が指定値以下であること
“greater”所持数量が指定値超過であること
“greaterEqual”所持数量が指定値以上であること
“equal”所持数量が指定値と一致すること
“notEqual”所持数量が指定値と一致しないこと
countstring
~ 1024文字所持数量
最大1024桁までの整数値文字列
multiplyValueSpecifyingQuantitybool
true数量指定した際に、検証に使用する値も乗算するか
timeOffsetTokenstring~ 1024文字タイムオフセットトークン
{
    "action": "Gs2Inventory:VerifyBigItemByUserId",
    "request": {
        "namespaceName": "[string]ネームスペース名",
        "userId": "[string]ユーザーID",
        "inventoryName": "[string]巨大インベントリモデル名",
        "itemName": "[string]巨大アイテムモデル名",
        "verifyType": "[string]検証の種類",
        "count": "[string]所持数量",
        "multiplyValueSpecifyingQuantity": "[bool]数量指定した際に、検証に使用する値も乗算するか",
        "timeOffsetToken": "[string]タイムオフセットトークン"
    }
}
action: Gs2Inventory:VerifyBigItemByUserId
request:
  namespaceName: "[string]ネームスペース名"
  userId: "[string]ユーザーID"
  inventoryName: "[string]巨大インベントリモデル名"
  itemName: "[string]巨大アイテムモデル名"
  verifyType: "[string]検証の種類"
  count: "[string]所持数量"
  multiplyValueSpecifyingQuantity: "[bool]数量指定した際に、検証に使用する値も乗算するか"
  timeOffsetToken: "[string]タイムオフセットトークン"
transaction.service("inventory").verify.verify_big_item_by_user_id({
    namespaceName="[string]ネームスペース名",
    userId="[string]ユーザーID",
    inventoryName="[string]巨大インベントリモデル名",
    itemName="[string]巨大アイテムモデル名",
    verifyType="[string]検証の種類",
    count="[string]所持数量",
    multiplyValueSpecifyingQuantity="[bool]数量指定した際に、検証に使用する値も乗算するか",
    timeOffsetToken="[string]タイムオフセットトークン",
})

ConsumeAction

消費アクション

Gs2Inventory:ConsumeItemSetByUserId

ユーザーIDを指定してアイテムセットを消費

アイテムセットはアイテムモデル名、所持数量、有効期限等を保持します。

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

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

有効化条件必須デフォルト値の制限説明
namespaceNamestring
~ 128文字ネームスペース名
ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。
inventoryNamestring
~ 128文字インベントリモデル名
userIdstring
~ 128文字ユーザーID
#{userId} と設定することでログイン中のユーザーIDに置換されます。
itemNamestring
~ 128文字アイテムモデル名
consumeCountlong
1 ~ 9223372036854775805消費する量
itemSetNamestring~ 36文字アイテムセットを識別する名前
timeOffsetTokenstring~ 1024文字タイムオフセットトークン
{
    "action": "Gs2Inventory:ConsumeItemSetByUserId",
    "request": {
        "namespaceName": "[string]ネームスペース名",
        "inventoryName": "[string]インベントリモデル名",
        "userId": "[string]ユーザーID",
        "itemName": "[string]アイテムモデル名",
        "consumeCount": "[long]消費する量",
        "itemSetName": "[string]アイテムセットを識別する名前",
        "timeOffsetToken": "[string]タイムオフセットトークン"
    }
}
action: Gs2Inventory:ConsumeItemSetByUserId
request:
  namespaceName: "[string]ネームスペース名"
  inventoryName: "[string]インベントリモデル名"
  userId: "[string]ユーザーID"
  itemName: "[string]アイテムモデル名"
  consumeCount: "[long]消費する量"
  itemSetName: "[string]アイテムセットを識別する名前"
  timeOffsetToken: "[string]タイムオフセットトークン"
transaction.service("inventory").consume.consume_item_set_by_user_id({
    namespaceName="[string]ネームスペース名",
    inventoryName="[string]インベントリモデル名",
    userId="[string]ユーザーID",
    itemName="[string]アイテムモデル名",
    consumeCount="[long]消費する量",
    itemSetName="[string]アイテムセットを識別する名前",
    timeOffsetToken="[string]タイムオフセットトークン",
})

Gs2Inventory:ConsumeSimpleItemsByUserId

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

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

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

有効化条件必須デフォルト値の制限説明
namespaceNamestring
~ 128文字ネームスペース名
ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。
inventoryNamestring
~ 128文字シンプルインベントリモデル名
シンプルインベントリモデル固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。
userIdstring
~ 128文字ユーザーID
#{userId} と設定することでログイン中のユーザーIDに置換されます。
consumeCountsList<ConsumeCount>
1 ~ 100 itemsシンプルアイテムの消費数量のリスト
timeOffsetTokenstring~ 1024文字タイムオフセットトークン
{
    "action": "Gs2Inventory:ConsumeSimpleItemsByUserId",
    "request": {
        "namespaceName": "[string]ネームスペース名",
        "inventoryName": "[string]シンプルインベントリモデル名",
        "userId": "[string]ユーザーID",
        "consumeCounts": [
            {
                "itemName": "[string]シンプルアイテムモデル名",
                "count": "[long]消費する量"
            }
        ],
        "timeOffsetToken": "[string]タイムオフセットトークン"
    }
}
action: Gs2Inventory:ConsumeSimpleItemsByUserId
request:
  namespaceName: "[string]ネームスペース名"
  inventoryName: "[string]シンプルインベントリモデル名"
  userId: "[string]ユーザーID"
  consumeCounts: 
  - itemName: "[string]シンプルアイテムモデル名"
    count: "[long]消費する量"
  timeOffsetToken: "[string]タイムオフセットトークン"
transaction.service("inventory").consume.consume_simple_items_by_user_id({
    namespaceName="[string]ネームスペース名",
    inventoryName="[string]シンプルインベントリモデル名",
    userId="[string]ユーザーID",
    consumeCounts={
        {
            itemName="[string]シンプルアイテムモデル名",
            count="[long]消費する量"
        }
    },
    timeOffsetToken="[string]タイムオフセットトークン",
})

Gs2Inventory:ConsumeBigItemByUserId

ユーザーIDを指定して巨大アイテムを消費

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

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

有効化条件必須デフォルト値の制限説明
namespaceNamestring
~ 128文字ネームスペース名
ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。
inventoryNamestring
~ 128文字巨大インベントリモデル名
巨大インベントリモデル固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。
userIdstring
~ 128文字ユーザーID
#{userId} と設定することでログイン中のユーザーIDに置換されます。
itemNamestring
~ 128文字巨大アイテムモデル名
巨大アイテムモデル固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。
consumeCountstring
~ 1024文字巨大アイテムの消費数量
最大1024桁までの整数値文字列
timeOffsetTokenstring~ 1024文字タイムオフセットトークン
{
    "action": "Gs2Inventory:ConsumeBigItemByUserId",
    "request": {
        "namespaceName": "[string]ネームスペース名",
        "inventoryName": "[string]巨大インベントリモデル名",
        "userId": "[string]ユーザーID",
        "itemName": "[string]巨大アイテムモデル名",
        "consumeCount": "[string]巨大アイテムの消費数量",
        "timeOffsetToken": "[string]タイムオフセットトークン"
    }
}
action: Gs2Inventory:ConsumeBigItemByUserId
request:
  namespaceName: "[string]ネームスペース名"
  inventoryName: "[string]巨大インベントリモデル名"
  userId: "[string]ユーザーID"
  itemName: "[string]巨大アイテムモデル名"
  consumeCount: "[string]巨大アイテムの消費数量"
  timeOffsetToken: "[string]タイムオフセットトークン"
transaction.service("inventory").consume.consume_big_item_by_user_id({
    namespaceName="[string]ネームスペース名",
    inventoryName="[string]巨大インベントリモデル名",
    userId="[string]ユーザーID",
    itemName="[string]巨大アイテムモデル名",
    consumeCount="[string]巨大アイテムの消費数量",
    timeOffsetToken="[string]タイムオフセットトークン",
})

AcquireAction

入手アクション

Gs2Inventory:AddCapacityByUserId

ユーザーIDを指定してインベントリのキャパシティサイズを加算

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

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

有効化条件必須デフォルト値の制限説明
namespaceNamestring
~ 128文字ネームスペース名
ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。
inventoryNamestring
~ 128文字インベントリモデル名
userIdstring
~ 128文字ユーザーID
#{userId} と設定することでログイン中のユーザーIDに置換されます。
addCapacityValueint
1 ~ 2147483646加算するキャパシティサイズ
timeOffsetTokenstring~ 1024文字タイムオフセットトークン
{
    "action": "Gs2Inventory:AddCapacityByUserId",
    "request": {
        "namespaceName": "[string]ネームスペース名",
        "inventoryName": "[string]インベントリモデル名",
        "userId": "[string]ユーザーID",
        "addCapacityValue": "[int]加算するキャパシティサイズ",
        "timeOffsetToken": "[string]タイムオフセットトークン"
    }
}
action: Gs2Inventory:AddCapacityByUserId
request:
  namespaceName: "[string]ネームスペース名"
  inventoryName: "[string]インベントリモデル名"
  userId: "[string]ユーザーID"
  addCapacityValue: "[int]加算するキャパシティサイズ"
  timeOffsetToken: "[string]タイムオフセットトークン"
transaction.service("inventory").acquire.add_capacity_by_user_id({
    namespaceName="[string]ネームスペース名",
    inventoryName="[string]インベントリモデル名",
    userId="[string]ユーザーID",
    addCapacityValue="[int]加算するキャパシティサイズ",
    timeOffsetToken="[string]タイムオフセットトークン",
})

Gs2Inventory:SetCapacityByUserId

ユーザーIDを指定してインベントリのキャパシティサイズを設定

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

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

有効化条件必須デフォルト値の制限説明
namespaceNamestring
~ 128文字ネームスペース名
ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。
inventoryNamestring
~ 128文字インベントリモデル名
userIdstring
~ 128文字ユーザーID
#{userId} と設定することでログイン中のユーザーIDに置換されます。
newCapacityValueint
1 ~ 2147483646インベントリの新しい最大キャパシティ
timeOffsetTokenstring~ 1024文字タイムオフセットトークン
{
    "action": "Gs2Inventory:SetCapacityByUserId",
    "request": {
        "namespaceName": "[string]ネームスペース名",
        "inventoryName": "[string]インベントリモデル名",
        "userId": "[string]ユーザーID",
        "newCapacityValue": "[int]インベントリの新しい最大キャパシティ",
        "timeOffsetToken": "[string]タイムオフセットトークン"
    }
}
action: Gs2Inventory:SetCapacityByUserId
request:
  namespaceName: "[string]ネームスペース名"
  inventoryName: "[string]インベントリモデル名"
  userId: "[string]ユーザーID"
  newCapacityValue: "[int]インベントリの新しい最大キャパシティ"
  timeOffsetToken: "[string]タイムオフセットトークン"
transaction.service("inventory").acquire.set_capacity_by_user_id({
    namespaceName="[string]ネームスペース名",
    inventoryName="[string]インベントリモデル名",
    userId="[string]ユーザーID",
    newCapacityValue="[int]インベントリの新しい最大キャパシティ",
    timeOffsetToken="[string]タイムオフセットトークン",
})

Gs2Inventory:AcquireItemSetByUserId

ユーザーIDを指定してアイテムセットを入手

アイテムセットはアイテムモデル名、所持数量、有効期限等を保持します。

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

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

有効化条件必須デフォルト値の制限説明
namespaceNamestring
~ 128文字ネームスペース名
ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。
inventoryNamestring
~ 128文字インベントリモデル名
インベントリモデル固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。
itemNamestring
~ 128文字アイテムモデル名
userIdstring
~ 128文字ユーザーID
#{userId} と設定することでログイン中のユーザーIDに置換されます。
acquireCountlong
1 ~ 9223372036854775805入手する量
expiresAtlong
0有効期限
UNIX 時間・ミリ秒
createNewItemSetbool
false既存のアイテムセットに空きがあったとしても、新しいアイテムセットを作成するか
itemSetNamestring~ 36文字アイテムセットを識別する名前
timeOffsetTokenstring~ 1024文字タイムオフセットトークン
{
    "action": "Gs2Inventory:AcquireItemSetByUserId",
    "request": {
        "namespaceName": "[string]ネームスペース名",
        "inventoryName": "[string]インベントリモデル名",
        "itemName": "[string]アイテムモデル名",
        "userId": "[string]ユーザーID",
        "acquireCount": "[long]入手する量",
        "expiresAt": "[long]有効期限",
        "createNewItemSet": "[bool]既存のアイテムセットに空きがあったとしても、新しいアイテムセットを作成するか",
        "itemSetName": "[string]アイテムセットを識別する名前",
        "timeOffsetToken": "[string]タイムオフセットトークン"
    }
}
action: Gs2Inventory:AcquireItemSetByUserId
request:
  namespaceName: "[string]ネームスペース名"
  inventoryName: "[string]インベントリモデル名"
  itemName: "[string]アイテムモデル名"
  userId: "[string]ユーザーID"
  acquireCount: "[long]入手する量"
  expiresAt: "[long]有効期限"
  createNewItemSet: "[bool]既存のアイテムセットに空きがあったとしても、新しいアイテムセットを作成するか"
  itemSetName: "[string]アイテムセットを識別する名前"
  timeOffsetToken: "[string]タイムオフセットトークン"
transaction.service("inventory").acquire.acquire_item_set_by_user_id({
    namespaceName="[string]ネームスペース名",
    inventoryName="[string]インベントリモデル名",
    itemName="[string]アイテムモデル名",
    userId="[string]ユーザーID",
    acquireCount="[long]入手する量",
    expiresAt="[long]有効期限",
    createNewItemSet="[bool]既存のアイテムセットに空きがあったとしても、新しいアイテムセットを作成するか",
    itemSetName="[string]アイテムセットを識別する名前",
    timeOffsetToken="[string]タイムオフセットトークン",
})

Gs2Inventory:AcquireItemSetWithGradeByUserId

ユーザーIDを指定して GS2-Grade にグレードを設定しつつ、アイテムセットを1つ入手

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

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

有効化条件必須デフォルト値の制限説明
namespaceNamestring
~ 128文字ネームスペース名
ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。
inventoryNamestring
~ 128文字インベントリモデル名
インベントリモデル固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。
itemNamestring
~ 128文字アイテムモデル名
userIdstring
~ 128文字ユーザーID
#{userId} と設定することでログイン中のユーザーIDに置換されます。
gradeModelIdstring
~ 1024文字グレードモデルGRN
gradeValuelong
1 ~ 9223372036854775805設定するグレード値
timeOffsetTokenstring~ 1024文字タイムオフセットトークン
{
    "action": "Gs2Inventory:AcquireItemSetWithGradeByUserId",
    "request": {
        "namespaceName": "[string]ネームスペース名",
        "inventoryName": "[string]インベントリモデル名",
        "itemName": "[string]アイテムモデル名",
        "userId": "[string]ユーザーID",
        "gradeModelId": "[string]グレードモデルGRN",
        "gradeValue": "[long]設定するグレード値",
        "timeOffsetToken": "[string]タイムオフセットトークン"
    }
}
action: Gs2Inventory:AcquireItemSetWithGradeByUserId
request:
  namespaceName: "[string]ネームスペース名"
  inventoryName: "[string]インベントリモデル名"
  itemName: "[string]アイテムモデル名"
  userId: "[string]ユーザーID"
  gradeModelId: "[string]グレードモデルGRN"
  gradeValue: "[long]設定するグレード値"
  timeOffsetToken: "[string]タイムオフセットトークン"
transaction.service("inventory").acquire.acquire_item_set_with_grade_by_user_id({
    namespaceName="[string]ネームスペース名",
    inventoryName="[string]インベントリモデル名",
    itemName="[string]アイテムモデル名",
    userId="[string]ユーザーID",
    gradeModelId="[string]グレードモデルGRN",
    gradeValue="[long]設定するグレード値",
    timeOffsetToken="[string]タイムオフセットトークン",
})

Gs2Inventory:AddReferenceOfByUserId

ユーザーIDを指定してアイテムに参照元を追加

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

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

有効化条件必須デフォルト値の制限説明
namespaceNamestring
~ 128文字ネームスペース名
ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。
inventoryNamestring
~ 128文字インベントリモデル名
userIdstring
~ 128文字ユーザーID
#{userId} と設定することでログイン中のユーザーIDに置換されます。
itemNamestring
~ 128文字アイテムモデル名
itemSetNamestring
UUID~ 36文字アイテムセットを識別する名前
アイテムセットの一意な名前を保持します。
名前は UUID(Universally Unique Identifier)フォーマットで自動的に生成され、各アイテムセットを識別するために使用されます。
referenceOfstring
~ 1024文字この所持品の参照元
timeOffsetTokenstring~ 1024文字タイムオフセットトークン
{
    "action": "Gs2Inventory:AddReferenceOfByUserId",
    "request": {
        "namespaceName": "[string]ネームスペース名",
        "inventoryName": "[string]インベントリモデル名",
        "userId": "[string]ユーザーID",
        "itemName": "[string]アイテムモデル名",
        "itemSetName": "[string]アイテムセットを識別する名前",
        "referenceOf": "[string]この所持品の参照元",
        "timeOffsetToken": "[string]タイムオフセットトークン"
    }
}
action: Gs2Inventory:AddReferenceOfByUserId
request:
  namespaceName: "[string]ネームスペース名"
  inventoryName: "[string]インベントリモデル名"
  userId: "[string]ユーザーID"
  itemName: "[string]アイテムモデル名"
  itemSetName: "[string]アイテムセットを識別する名前"
  referenceOf: "[string]この所持品の参照元"
  timeOffsetToken: "[string]タイムオフセットトークン"
transaction.service("inventory").acquire.add_reference_of_by_user_id({
    namespaceName="[string]ネームスペース名",
    inventoryName="[string]インベントリモデル名",
    userId="[string]ユーザーID",
    itemName="[string]アイテムモデル名",
    itemSetName="[string]アイテムセットを識別する名前",
    referenceOf="[string]この所持品の参照元",
    timeOffsetToken="[string]タイムオフセットトークン",
})

Gs2Inventory:DeleteReferenceOfByUserId

ユーザーIDを指定してアイテムの参照元を削除

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

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

有効化条件必須デフォルト値の制限説明
namespaceNamestring
~ 128文字ネームスペース名
ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。
inventoryNamestring
~ 128文字インベントリモデル名
userIdstring
~ 128文字ユーザーID
#{userId} と設定することでログイン中のユーザーIDに置換されます。
itemNamestring
~ 128文字アイテムモデル名
itemSetNamestring
UUID~ 36文字アイテムセットを識別する名前
アイテムセットの一意な名前を保持します。
名前は UUID(Universally Unique Identifier)フォーマットで自動的に生成され、各アイテムセットを識別するために使用されます。
referenceOfstring
~ 1024文字この所持品の参照元
timeOffsetTokenstring~ 1024文字タイムオフセットトークン
{
    "action": "Gs2Inventory:DeleteReferenceOfByUserId",
    "request": {
        "namespaceName": "[string]ネームスペース名",
        "inventoryName": "[string]インベントリモデル名",
        "userId": "[string]ユーザーID",
        "itemName": "[string]アイテムモデル名",
        "itemSetName": "[string]アイテムセットを識別する名前",
        "referenceOf": "[string]この所持品の参照元",
        "timeOffsetToken": "[string]タイムオフセットトークン"
    }
}
action: Gs2Inventory:DeleteReferenceOfByUserId
request:
  namespaceName: "[string]ネームスペース名"
  inventoryName: "[string]インベントリモデル名"
  userId: "[string]ユーザーID"
  itemName: "[string]アイテムモデル名"
  itemSetName: "[string]アイテムセットを識別する名前"
  referenceOf: "[string]この所持品の参照元"
  timeOffsetToken: "[string]タイムオフセットトークン"
transaction.service("inventory").acquire.delete_reference_of_by_user_id({
    namespaceName="[string]ネームスペース名",
    inventoryName="[string]インベントリモデル名",
    userId="[string]ユーザーID",
    itemName="[string]アイテムモデル名",
    itemSetName="[string]アイテムセットを識別する名前",
    referenceOf="[string]この所持品の参照元",
    timeOffsetToken="[string]タイムオフセットトークン",
})

Gs2Inventory:AcquireSimpleItemsByUserId

ユーザーIDを指定してシンプルアイテムを入手

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

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

有効化条件必須デフォルト値の制限説明
namespaceNamestring
~ 128文字ネームスペース名
ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。
inventoryNamestring
~ 128文字シンプルインベントリモデル名
シンプルインベントリモデル固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。
userIdstring
~ 128文字ユーザーID
#{userId} と設定することでログイン中のユーザーIDに置換されます。
acquireCountsList<AcquireCount>
1 ~ 100 itemsシンプルアイテムの入手数量リスト
timeOffsetTokenstring~ 1024文字タイムオフセットトークン
{
    "action": "Gs2Inventory:AcquireSimpleItemsByUserId",
    "request": {
        "namespaceName": "[string]ネームスペース名",
        "inventoryName": "[string]シンプルインベントリモデル名",
        "userId": "[string]ユーザーID",
        "acquireCounts": [
            {
                "itemName": "[string]シンプルアイテムモデル名",
                "count": "[long]入手する量"
            }
        ],
        "timeOffsetToken": "[string]タイムオフセットトークン"
    }
}
action: Gs2Inventory:AcquireSimpleItemsByUserId
request:
  namespaceName: "[string]ネームスペース名"
  inventoryName: "[string]シンプルインベントリモデル名"
  userId: "[string]ユーザーID"
  acquireCounts: 
    - itemName: "[string]シンプルアイテムモデル名"
      count: "[long]入手する量"
  timeOffsetToken: "[string]タイムオフセットトークン"
transaction.service("inventory").acquire.acquire_simple_items_by_user_id({
    namespaceName="[string]ネームスペース名",
    inventoryName="[string]シンプルインベントリモデル名",
    userId="[string]ユーザーID",
    acquireCounts={
        {
            itemName="[string]シンプルアイテムモデル名",
            count="[long]入手する量"
        }
    },
    timeOffsetToken="[string]タイムオフセットトークン",
})

Gs2Inventory:SetSimpleItemsByUserId

ユーザーIDを指定してシンプルアイテムを設定

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

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

有効化条件必須デフォルト値の制限説明
namespaceNamestring
~ 128文字ネームスペース名
ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。
inventoryNamestring
~ 128文字シンプルインベントリモデル名
シンプルインベントリモデル固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。
userIdstring
~ 128文字ユーザーID
#{userId} と設定することでログイン中のユーザーIDに置換されます。
countsList<HeldCount>
1 ~ 100 itemsシンプルアイテムの所持数量リスト
timeOffsetTokenstring~ 1024文字タイムオフセットトークン
{
    "action": "Gs2Inventory:SetSimpleItemsByUserId",
    "request": {
        "namespaceName": "[string]ネームスペース名",
        "inventoryName": "[string]シンプルインベントリモデル名",
        "userId": "[string]ユーザーID",
        "counts": [
            {
                "itemName": "[string]シンプルアイテムモデル名",
                "count": "[long]所持数量"
            }
        ],
        "timeOffsetToken": "[string]タイムオフセットトークン"
    }
}
action: Gs2Inventory:SetSimpleItemsByUserId
request:
  namespaceName: "[string]ネームスペース名"
  inventoryName: "[string]シンプルインベントリモデル名"
  userId: "[string]ユーザーID"
  counts: 
    - itemName: "[string]シンプルアイテムモデル名"
      count: "[long]所持数量"
  timeOffsetToken: "[string]タイムオフセットトークン"
transaction.service("inventory").acquire.set_simple_items_by_user_id({
    namespaceName="[string]ネームスペース名",
    inventoryName="[string]シンプルインベントリモデル名",
    userId="[string]ユーザーID",
    counts={
        {
            itemName="[string]シンプルアイテムモデル名",
            count="[long]所持数量"
        }
    },
    timeOffsetToken="[string]タイムオフセットトークン",
})

Gs2Inventory:AcquireBigItemByUserId

ユーザーIDを指定して巨大アイテムを入手

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

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

有効化条件必須デフォルト値の制限説明
namespaceNamestring
~ 128文字ネームスペース名
ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。
inventoryNamestring
~ 128文字巨大インベントリモデル名
巨大インベントリモデル固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。
userIdstring
~ 128文字ユーザーID
#{userId} と設定することでログイン中のユーザーIDに置換されます。
itemNamestring
~ 128文字巨大アイテムモデル名
巨大アイテムモデル固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。
acquireCountstring
~ 1024文字巨大アイテムの入手数量
最大1024桁までの整数値
timeOffsetTokenstring~ 1024文字タイムオフセットトークン
{
    "action": "Gs2Inventory:AcquireBigItemByUserId",
    "request": {
        "namespaceName": "[string]ネームスペース名",
        "inventoryName": "[string]巨大インベントリモデル名",
        "userId": "[string]ユーザーID",
        "itemName": "[string]巨大アイテムモデル名",
        "acquireCount": "[string]巨大アイテムの入手数量",
        "timeOffsetToken": "[string]タイムオフセットトークン"
    }
}
action: Gs2Inventory:AcquireBigItemByUserId
request:
  namespaceName: "[string]ネームスペース名"
  inventoryName: "[string]巨大インベントリモデル名"
  userId: "[string]ユーザーID"
  itemName: "[string]巨大アイテムモデル名"
  acquireCount: "[string]巨大アイテムの入手数量"
  timeOffsetToken: "[string]タイムオフセットトークン"
transaction.service("inventory").acquire.acquire_big_item_by_user_id({
    namespaceName="[string]ネームスペース名",
    inventoryName="[string]巨大インベントリモデル名",
    userId="[string]ユーザーID",
    itemName="[string]巨大アイテムモデル名",
    acquireCount="[string]巨大アイテムの入手数量",
    timeOffsetToken="[string]タイムオフセットトークン",
})

Gs2Inventory:SetBigItemByUserId

ユーザーIDを指定して巨大アイテムを設定

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

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

有効化条件必須デフォルト値の制限説明
namespaceNamestring
~ 128文字ネームスペース名
ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。
inventoryNamestring
~ 128文字巨大インベントリモデル名
巨大インベントリモデル固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。
userIdstring
~ 128文字ユーザーID
#{userId} と設定することでログイン中のユーザーIDに置換されます。
itemNamestring
~ 128文字巨大アイテムモデル名
巨大アイテムモデル固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。
countstring
~ 1024文字巨大アイテムの数量
最大1024桁までの整数値文字列
timeOffsetTokenstring~ 1024文字タイムオフセットトークン
{
    "action": "Gs2Inventory:SetBigItemByUserId",
    "request": {
        "namespaceName": "[string]ネームスペース名",
        "inventoryName": "[string]巨大インベントリモデル名",
        "userId": "[string]ユーザーID",
        "itemName": "[string]巨大アイテムモデル名",
        "count": "[string]巨大アイテムの数量",
        "timeOffsetToken": "[string]タイムオフセットトークン"
    }
}
action: Gs2Inventory:SetBigItemByUserId
request:
  namespaceName: "[string]ネームスペース名"
  inventoryName: "[string]巨大インベントリモデル名"
  userId: "[string]ユーザーID"
  itemName: "[string]巨大アイテムモデル名"
  count: "[string]巨大アイテムの数量"
  timeOffsetToken: "[string]タイムオフセットトークン"
transaction.service("inventory").acquire.set_big_item_by_user_id({
    namespaceName="[string]ネームスペース名",
    inventoryName="[string]巨大インベントリモデル名",
    userId="[string]ユーザーID",
    itemName="[string]巨大アイテムモデル名",
    count="[string]巨大アイテムの数量",
    timeOffsetToken="[string]タイムオフセットトークン",
})