ゲームサーバーを使用してプレイヤーインベントリを管理する

Last updated on February 4, 2026

注釈：本資料はAI技術を用いて翻訳されています。

注記

インベントリサービスはリクエストに応じて利用可能です。このサービスを環境に統合するには、AccelByte カスタマーサポートポータルからリクエストを開いてください。

概要

AccelByte Gaming Service (AGS) インベントリサービスを使用すると、ゲームサーバーから直接プレイヤーのインベントリとアイテムを管理でき、インベントリとアイテムの管理、整理、または操作が可能になります。

この記事では、ゲームサーバーがプレイヤーが所有するインベントリを管理できるようにする方法を示します。

前提条件

• AGS 管理者ポータルへのアクセス。
• パブリッシャーまたはゲームネームスペース。
• インベントリサービスの主要な概念とインベントリサービス API ドキュメントを確認していること。
• AccelByte SDK をゲームに統合していること。次の権限を含む：
  • Client ID
  • Client Secret

プレイヤーにインベントリを付与する

ゲームサーバーが、プレイヤーが達成を達成したり、ゲーム内で特定のアクションを完了した後にインベントリを付与できるようにしたい場合、このアクションを使用できます。例えば、プレイヤーがレベル20に達成した後に新しいインベントリを付与します。

インベントリ設定で設定された "maxInstancesPerUser" を超えない限り、ゲームサーバーがプレイヤーに新しいインベントリを付与できるようにすることができます。

参照用にこの関数を使用します。

Unreal Engine

// The code snippet will be available on the future update

Unity

string userId = "registeredUserId";
Result<UserInventory> createInventoryResult = null;
ServerCreateInventoryRequest request = new ServerCreateInventoryRequest
{
    UserId = userId,
    InventoryConfigurationCode = inventoryConfigCode
};

createInventoryResult = null;
AccelByteSDK.GetServerRegistry().GetApi()
    .GetInventory()
    .CreateUserInventory(request, result =>
{
    if (result.IsError)
    {
        // Do something if CreateUserInventory is failed
        UnityEngine.Debug.Log($"Failed to CreateUserInventory [{result.Error.Code}]:{result.Error.Message}");
        return;
    }

    // Do something if CreateUserInventory is success
    createInventoryResult = result;
});

C# Extend SDK

AccelByteSDK sdk = AccelByteSDK.Builder
    .UseDefaultHttpClient()
    .SetConfigRepository()
    .UseDefaultTokenRepository()
    .EnableLog() // Optional
    .Build();


string gameNamespace = "gameNamespace";
string inventoryConfigurationCode = "SomeConfigurationCode";
string userId = "userId";


ApimodelsCreateInventoryReq body = new ApimodelsCreateInventoryReq()                
{
    InventoryConfigurationCode = inventoryConfigurationCode,
    UserId = userId
};
 
var response = sdk.Inventory.AdminInventories.AdminCreateInventoryOp
    .Execute(body, gameNamespace);
if (response == null)
    return "No response from server.";


// Do something with the response

Go Extend SDK

adminInventoriesService := &inventory.AdminInventoriesService{
    Client:          factory.NewInventoryClient(&repository.ConfigRepositoryImpl{}),
    TokenRepository: &repository.TokenRepositoryImpl{},
}
inventoryConfigurationCode := "someConfigurationCode"
userId := "userId"
body := &inventoryclientmodels.ApimodelsCreateInventoryReq {
    InventoryConfigurationCode: &inventoryConfigurationCode,
    UserID: &userId,
}
namespace := "gameNamespace"
input := &admin_inventories.AdminCreateInventoryParams{
    Body:      body,
    Namespace: namespace,
}
result, err := adminInventoriesService.AdminCreateInventoryShort(input)

Java Extend SDK

final AccelByteSDK sdk = new AccelByteSDK(httpClient, tokenRepository, configRepository);
AdminInventories AdminInventoriesWrapper = new AdminInventories(sdk);

String gameNamespace = "gameNamespace";
String userId = "<user-id>";
String inventoryConfigurationCode = "SomeConfigurationCode";
ApimodelsInventoryResp response;
try {
    ApimodelsCreateInventoryReq reqBody = ApimodelsCreateInventoryReq.builder()
        .userId(userId)
        .inventoryConfigurationCode(inventoryConfigurationCode)
        .build();
    response = AdminInventoriesWrapper.adminCreateInventory(AdminCreateInventory.builder()
        .namespace(gameNamespace)
        .body(reqBody)
        .build());
} catch (Exception e) {
    // Do something when failed
    return;
}

if (response == null) {
    // Null response from server
} else {
    // Do something when successful
}

Python Extend SDK

import accelbyte_py_sdk.api.inventory as inventory_service
import accelbyte_py_sdk.api.inventory.models as inventory_models

result, error = inventory_service.admin_create_inventory(
    body=inventory_models.ApimodelsCreateInventoryReq()
        .with_inventory_configuration_code("SomeConfigurationCode")
        .with_user_id("********************************"),
    namespace=namespace,  # optional, gets the value from the global instance if unspecified
    sdk=sdk,  # optional, gets the global instance  if unspecified
)
if error:
    exit(error)

プレイヤーインベントリのリストを取得する

プレイヤーインベントリのリストを取得すると、inventoryId や inventoryConfigurationId など、プレイヤーのインベントリに関する情報を取得できます。

ゲームサーバー経由でプレイヤーインベントリのリストを取得するには、参照用にこの関数を使用します。

Unreal Engine

// The code snippet will be available on the future update

Unity

Result<UserInventoriesPagingResponse> getUserInventoryResult = null;
AccelByteSDK.GetServerRegistry().GetApi()
    .GetInventory()
    .GetUserInventories(result =>
{
    if (result.IsError)
    {
        // Do something if GetUserInventories is failed
        UnityEngine.Debug.Log($"Failed to GetUserInventories [{result.Error.Code}]:{result.Error.Message}");
        return;
    }

    // Do something if GetUserInventories is success
    getUserInventoryResult = result;
});

C# Extend SDK

AccelByteSDK sdk = AccelByteSDK.Builder
    .UseDefaultHttpClient()
    .SetConfigRepository()
    .UseDefaultTokenRepository()
    .EnableLog() // Optional
    .Build();


string gameNamespace = "gameNamespace";
string inventoryConfigurationCode = "SomeConfigurationCode";
long limit = 10;
long offset = 0;
string userId = "userId";


var response = sdk.Inventory.AdminInventories.AdminListInventoriesOp
    .SetLimit(limit)
    .SetOffset(offset)
    .SetSortBy(AdminListInventoriesSortBy.CreatedAt)
    .SetInventoryConfigurationCode(inventoryConfigurationCode)
    .SetUserId(userId)
    .Execute(gameNamespace);
if (response == null)
    return "No response from server.";


// Do something with the response

Go Extend SDK

adminInventoriesService := &inventory.AdminInventoriesService{
    Client:          factory.NewInventoryClient(&repository.ConfigRepositoryImpl{}),
    TokenRepository: &repository.TokenRepositoryImpl{},
}
namespace := "gameNamespace"
inventoryConfigurationCode := "SomeConfigurationCode"
limit := int64(10)
offset := int64(0)
sortBy := admin_inventories.AdminListInventoriesCreatedAtConstant
userId, _ := cmd.Flags().GetString("userId")
input := &admin_inventories.AdminListInventoriesParams{
    Namespace:                  namespace,
    InventoryConfigurationCode: &inventoryConfigurationCode,
    Limit:                      &limit,
    Offset:                     &offset,
    SortBy:                     &sortBy,
    UserID:                     &userId,
}
result, err := adminInventoriesService.AdminListInventoriesShort(input)

Java Extend SDK

final AccelByteSDK sdk = new AccelByteSDK(httpClient, tokenRepository, configRepository);
AdminInventories AdminInventoriesWrapper = new AdminInventories(sdk);

String gameNamespace = "gameNamespace";
String inventoryConfigurationCode = "SomeConfigurationCode";
int limit = 10;
int offset = 0;
String userId = "userId";
ApimodelsListInventoryResp response;
try {
    response = AdminInventoriesWrapper.adminListInventories(AdminListInventories.builder()
        .namespace(gameNamespace)
            .limit(limit)
            .offset(offset)
            .sortBy(AdminListInventories.SortBy.CreatedAt.toString())
            .inventoryConfigurationCode(inventoryConfigurationCode)
            .userId(userId)
        .build());
} catch (Exception e) {
    // Do something when failed
    return;
}

if (response == null) {
    // No response from server
} else {
    // Do something when successful
}

Python Extend SDK

import accelbyte_py_sdk.api.inventory as inventory_service
import accelbyte_py_sdk.api.inventory.models as inventory_models

result, error = inventory_service.admin_list_inventories(
    inventory_configuration_code="SomeConfigurationCode",
    limit=10,
    offset=0,
    sort_by="createdAt",
    user_id="********************************",
    namespace=namespace,  # optional, gets the value from the global instance if unspecified
    sdk=sdk,  # optional, gets the global instance  if unspecified
)
if error:
    exit(error)

プレイヤーインベントリのスロット制限を更新する

このアクションを使用して、インベントリ ID と実装される新しいスロット数を提供することで、特定のプレイヤーのインベントリの最大スロット制限を更新します。

ゲームサーバー経由でプレイヤーのインベントリスロット制限を更新するには、参照用にこの関数を使用します。

Unreal Engine

// The code snippet will be available on the future update

Unity

string inventoryId = "someInventoryId";
Result<UserInventory> updateUserInventoryResult = null;
ServerUpdateInventoryRequest request = new ServerUpdateInventoryRequest
{
    IncMaxSlots = 3
};

AccelByteSDK.GetServerRegistry().GetApi()
    .GetInventory()
    .UpdateUserInventory(inventoryId, request, result =>
{
    if (result.IsError)
    {
        // Do something if UpdateUserInventory is failed
        UnityEngine.Debug.Log($"Failed to UpdateUserInventory [{result.Error.Code}]:{result.Error.Message}");
        return;
    }

    // Do something if UpdateUserInventory is success
    updateUserInventoryResult = result;
});

C# Extend SDK

AccelByteSDK sdk = AccelByteSDK.Builder
    .UseDefaultHttpClient()
    .SetConfigRepository()
    .UseDefaultTokenRepository()
    .EnableLog() // Optional
    .Build();


string gameNamespace = "gameNamespace";
string inventoryId = "inventoryId";
int incMaxSlots = 10;


ApimodelsUpdateInventoryReq body = new ApimodelsUpdateInventoryReq()
{
    IncMaxSlots = incMaxSlots
};


var response = sdk.Inventory.AdminInventories.AdminUpdateInventoryOp
    .Execute(body, inventoryId, gameNamespace);
if (response == null)
    return "No response from server.";


// Do something with the response

Go Extend SDK

adminInventoriesService := &inventory.AdminInventoriesService{
    Client:          factory.NewInventoryClient(&repository.ConfigRepositoryImpl{}),
    TokenRepository: &repository.TokenRepositoryImpl{},
}
incMaxSlots := int32(10)
body := &inventoryclientmodels.ApimodelsUpdateInventoryReq {
    IncMaxSlots: &incMaxSlots,
}
inventoryId := "inventoryId"
namespace := "gameNamespace"
input := &admin_inventories.AdminUpdateInventoryParams{
    Body:        body,
    InventoryID: inventoryId,
    Namespace:   namespace,
}
result, err := adminInventoriesService.AdminUpdateInventoryShort(input)

Java Extend SDK

final AccelByteSDK sdk = new AccelByteSDK(httpClient, tokenRepository, configRepository);
AdminInventories AdminInventoriesWrapper = new AdminInventories(sdk);

String gameNamespace = "gameNamespace";
String inventoryId = "inventoryId";
int incMaxSlots = 10;
ApimodelsInventoryResp response;
try {
    ApimodelsUpdateInventoryReq reqBody = ApimodelsUpdateInventoryReq.builder().incMaxSlots(incMaxSlots).build();
    response = AdminInventoriesWrapper.adminUpdateInventory(AdminUpdateInventory.builder()
        .namespace(gameNamespace)
        .body(reqBody)
        .inventoryId(inventoryId)
        .build());
} catch (Exception e) {
    // Do something when failed
    return;
}

if (response == null) {
    // No response from server
} else {
    // Do something when successful
}

Python Extend SDK

import accelbyte_py_sdk.api.inventory as inventory_service
import accelbyte_py_sdk.api.inventory.models as inventory_models

result, error = inventory_service.admin_update_inventory(
    body=inventory_models.ApimodelsUpdateInventoryReq().with_inc_max_slots(10),
    inventory_id="inventoryId",
    namespace=namespace,  # optional, gets the value from the global instance if unspecified
    sdk=sdk,  # optional, gets the global instance  if unspecified
)
if error:
    exit(error)

プレイヤーインベントリを削除する

プレイヤーインベントリは、空の場合にのみ削除できます。削除する前に、プレイヤーのインベントリからすべてのアイテムを削除してください。

ゲームサーバー経由でプレイヤーのインベントリを削除するには、参照用にこの関数を使用します。

Unreal Engine

// The code snippet will be available on the future update

Unity

string targetUserId = "userId";
ServerDeleteInventoryRequest request = new ServerDeleteInventoryRequest
{
    Message = "deletion message"
};

AccelByte.Core.Result deleteResult = null;
AccelByteSDK.GetServerRegistry().GetApi()
    .GetInventory()
    .DeleteUserInventory(targetUserId, request, result =>
{
    if (result.IsError)
    {
        // Do something if DeleteUserInventory is failed
        UnityEngine.Debug.Log($"Failed to DeleteUserInventory [{result.Error.Code}]:{result.Error.Message}");
        return;
    }

    // Do something if DeleteUserInventory is success
    deleteResult = result;
});

C# Extend SDK

AccelByteSDK sdk = AccelByteSDK.Builder
    .UseDefaultHttpClient()
    .SetConfigRepository()
    .UseDefaultTokenRepository()
    .EnableLog() // Optional
    .Build();


string gameNamespace = "gameNamespace";
string inventoryId = "inventoryId";


ApimodelsDeleteInventoryReq body = new ApimodelsDeleteInventoryReq()
{
    Message = "message"
};


sdk.Inventory.AdminInventories.DeleteInventoryOp
    .Execute(body, inventoryId, gameNamespace);

Go Extend SDK

adminInventoriesService := &inventory.AdminInventoriesService{
    Client:          factory.NewInventoryClient(&repository.ConfigRepositoryImpl{}),
    TokenRepository: &repository.TokenRepositoryImpl{},
}
message := "message"
body := &inventoryclientmodels.ApimodelsDeleteInventoryReq {
    Message: &message,
}
inventoryId := "inventoryId"
namespace := "gameNamespace"
input := &admin_inventories.DeleteInventoryParams{
    Body:        body,
    InventoryID: inventoryId,
    Namespace:   namespace,
}
err := adminInventoriesService.DeleteInventoryShort(input)

Java Extend SDK

final AccelByteSDK sdk = new AccelByteSDK(httpClient, tokenRepository, configRepository);
AdminInventories AdminInventoriesWrapper = new AdminInventories(sdk);

String gameNamespace = "gameNamespace";
String inventoryId = "inventoryId";
try {
    ApimodelsDeleteInventoryReq reqBody = ApimodelsDeleteInventoryReq.builder().message("message").build();
    AdminInventoriesWrapper.deleteInventory(DeleteInventory.builder()
        .namespace(gameNamespace)
        .inventoryId(inventoryId)
        .body(reqBody)
        .build());
} catch (Exception e) {
    // Do something when failed
    return;
}

Python Extend SDK

import accelbyte_py_sdk.api.inventory as inventory_service
import accelbyte_py_sdk.api.inventory.models as inventory_models

result, error = inventory_service.delete_inventory(
    body=inventory_models.ApimodelsDeleteInventoryReq().with_message("message"),
    inventory_id="inventoryId",
    namespace=namespace,  # optional, gets the value from the global instance if unspecified
    sdk=sdk,  # optional, gets the global instance  if unspecified
)
if error:
    exit(error)

inventoryId を使用してプレイヤーインベントリにアイテムを追加する

このアクションを使用して、プレイヤーのインベントリにアイテムを追加します。これには、プレイヤーインベントリのリストを取得するから取得できる情報であるプレイヤーの inventoryId を提供する必要があります。

参照用にこの関数を使用します。

Unreal Engine

// The code snippet will be available on the future update

Unity

//Please refer to GetUserInventoryAllItems() result to make sure the correct values
string slotId = "slot-1"; // it can be anything, if null it will be set "default"
Dictionary<string, object> customAttributes = new Dictionary<string, object>()
{
    {"durability", 150},
    {"damageGiven", 120.5f},
    {"ability", "Sunder Armor"}
};
Dictionary<string, object> serverCustomAttributes = new Dictionary<string, object>()
{
    {"someInt", 111},
    {"someFloat", 1.2f},
    {"someString", "myString"}
};
uint quantity = 1;
string source = "ECOMMERCE"; // supported values are OTHER and ECOMMERCE
string sourceItemId = "source-item-id"; // if the source is ECOMMERCE, fill this value as item Id from the store
string itemType = "INGAMEITEM"; // if the source is ECOMMERCE, fill this value as item Type from the store
string[] tags = new string[]{"weapon", "melee"};
string targetUserId = "someAccelByteUserId";
string inventoryCode = "someInventoryConfigCode"; // Please refer to GetUserInventories() result to get this value

var optionalParam = new SaveUserInventoryItemOptionalParameters
{
    Tags = tags,
    CustomAttributes = customAttributes,
    ServerCustomAttributes = serverCustomAttributes,
    SlotId = slotId,
};

Result<UserItem> saveItemToUserResult = null;
AccelByteSDK.GetServerRegistry().GetApi().GetInventory().SaveUserInventoryItem(targetUserId
        , inventoryCode
        , source
        , sourceItemId
        , itemType
        , quantity
        , optionalParam
        , result =>
{
    if (result.IsError)
    {
        //Do something if SaveUserInventoryItem is failed
        UnityEngine.Debug.Log($"failed to save item [{result.Error.Code}]:{result.Error.Message}");
        return;
    }
                        
    //Do something if SaveUserInventoryItem is success
    saveItemToUserResult = result;
});

C# Extend SDK

AccelByteSDK sdk = AccelByteSDK.Builder
    .UseDefaultHttpClient()
    .SetConfigRepository()
    .UseDefaultTokenRepository()
    .EnableLog() // Optional
    .Build();
   
string gameNamespace = "gameNamespace";
string inventoryId = "inventoryId";
string userId = "userId";
Dictionary<string, object> customAttributes = new Dictionary<string, object>();
Dictionary<string, object> serverCustomAttributes = new Dictionary<string, object>();


ApimodelsSaveItemToInventoryReq body = new ApimodelsSaveItemToInventoryReq()
{
    CustomAttributes = customAttributes,
    SlotId = "slot-1",
    SlotUsed = 1,
    Qty = 1,
    ServerCustomAttributes = serverCustomAttributes,
    SourceItemId = "source item id",
    Tags = new List<string>() { "weapon" },
    Type = "ingame"
};


var response = sdk.Inventory.AdminItems.AdminSaveItemToInventoryOp
    .Execute(body, inventoryId, gameNamespace, userId);
if (response == null)
    return "No response from server.";


// Do something with the response

Go Extend SDK

adminItemsService := &inventory.AdminItemsService{
    Client:          factory.NewInventoryClient(&repository.ConfigRepositoryImpl{}),
    TokenRepository: &repository.TokenRepositoryImpl{},
}
slotId := "slot-1"
slotUsed := int32(1)
qty := int32(1)
sourceItemId := "source item id"
type_ := "ingame"
body := &inventoryclientmodels.ApimodelsSaveItemToInventoryReq {
    CustomAttributes: map[string]interface{}{},
    SlotID: &slotId,
    SlotUsed: &slotUsed,
    Qty: &qty,
    ServerCustomAttributes: map[string]interface{}{},
    SourceItemID:&sourceItemId,
    Tags: []string{"weapon"},
    Type: &type_,
}
inventoryId := "inventoryId"
namespace := "gameNamespace"
userId := "userId"
input := &admin_items.AdminSaveItemToInventoryParams{
    Body:        body,
    InventoryID: inventoryId,
    Namespace:   namespace,
    UserID:      userId,
}
result, err := adminItemsService.AdminSaveItemToInventoryShort(input)

Java Extend SDK

final AccelByteSDK sdk = new AccelByteSDK(httpClient, tokenRepository, configRepository);
AdminItems adminItemsWrapper = new AdminItems(sdk);

String gameNamespace = "gameNamespace";
String inventoryId = "inventoryId";
String userId = "userId";
Map<String, Object> customAttributes = Collections.emptyMap();
Map<String, Object>  serverCustomAttributes = Collections.emptyMap();
ApimodelsItemResp response;
try {
    ApimodelsSaveItemToInventoryReq reqBody = ApimodelsSaveItemToInventoryReq.builder()
        .customAttributes(customAttributes)
        .slotId("slot-1")
        .slotUsed(1)
        .qty(1)
        .serverCustomAttributes(serverCustomAttributes)
        .sourceItemId("source item id")
        .tags(List.of("weapon"))
        .type("ingame")
        .build();
    response = adminItemsWrapper.adminSaveItemToInventory(AdminSaveItemToInventory.builder()
        .namespace(gameNamespace)
        .userId(userId)
        .inventoryId(inventoryId)
        .body(reqBody)
        .build());
} catch (Exception e) {
    // Do something when failed
    return;
}

if (response == null) {
    // null response from server
} else {
    // Do something when successful
}

Python Extend SDK

import accelbyte_py_sdk.api.inventory as inventory_service
import accelbyte_py_sdk.api.inventory.models as inventory_models

result, error = inventory_service.admin_save_item_to_inventory(
    body=inventory_models.ApimodelsSaveItemToInventoryReq()
        .with_custom_attributes({})
        .with_qty(1)
        .with_server_custom_attributes({})
        .with_slot_id("slot-1")
        .with_slot_used(1)
        .with_source("source")
        .with_source_item_id("source-item-id")
        .with_tags(["weapon"])
        .with_type("ingame"),
    inventory_id="inventoryId",
    user_id="********************************",
    namespace=namespace,  # optional, gets the value from the global instance if unspecified
    sdk=sdk,  # optional, gets the global instance  if unspecified
)
if error:
    exit(error)

inventoryConfigurationCode を使用してプレイヤーインベントリにアイテムを追加する

このアクションを使用して、プレイヤーの特定のインベントリ設定にアイテムを追加します。このアクションには、プレイヤーインベントリのリストを取得するから取得できる情報である inventoryConfigurationCode を提供する必要があります。

参照用にこの関数を使用します。

Unreal Engine

// The code snippet will be available on the future update

Unity

string inventoryId = "someInventoryId";
string targetUserId = "someAccelByteUserId";
string slotId = "slot-1"; // it can be anything, if null it will be set "default"
string source = "ECOMMERCE"; // supported values are OTHER and ECOMMERCE
string sourceItemId = "source-item-id"; // if the source is ECOMMERCE, fill this value as item Id from the store
string itemType = "INGAMEITEM"; // if the source is ECOMMERCE, fill this value as item Type from the store 
uint quantity = 1;
Dictionary<string, object> customAttributes = new Dictionary<string, object>()
{
    {"someInt", 111},
    {"someFloat", 1.2f},
    {"someString", "myString"}
};

var optionalParameters = new SaveUserInventoryItemToInventoryOptionalParameters()
{
    SlotId = slotId,
    CustomAttributes = customAttributes,
};

Result<UserItem> saveItemToUserResult = null;
AccelByteSDK.GetServerRegistry().GetApi().GetInventory().SaveUserInventoryItemToInventory(inventoryId
    , targetUserId
    , source
    , sourceItemId
    , itemType
    , quantity
    , optionalParameters
    , result =>
{
    if (result.IsError)
    {
        //Do something if SaveUserInventoryItemToInventory is failed
        UnityEngine.Debug.Log($"failed to SaveUserInventoryItemToInventory [{result.Error.Code}]:{result.Error.Message}");
        return;
    }

    //Do something if SaveUserInventoryItemToInventory is failed
    saveItemToUserResult = result;
});

C# Extend SDK

AccelByteSDK sdk = AccelByteSDK.Builder
    .UseDefaultHttpClient()
    .SetConfigRepository()
    .UseDefaultTokenRepository()
    .EnableLog() // Optional
    .Build();


string gameNamespace = "gameNamespace";
string userId = "userId";
Dictionary<string, object> customAttributes = new Dictionary<string, object>();
Dictionary<string, object> serverCustomAttributes = new Dictionary<string, object>()
ApimodelsSaveItemReq body = new ApimodelsSaveItemReq()
{
    CustomAttributes = customAttributes,
    InventoryConfigurationCode = "SomeConfigurationCode",
    SlotId = "slot-1",
    SlotUsed = 1,
    Qty = 1,
    ServerCustomAttributes = serverCustomAttributes,
    SourceItemId = "source item id",
    Tags = new List<string>() { "weapon" },
    Type = "ingame"
};


var response = sdk.Inventory.AdminItems.AdminSaveItemOp
    .Execute(body, gameNamespace, userId);
if (response == null)
    return "No response from server.";


// Do something with the response

Go Extend SDK

adminItemsService := &inventory.AdminItemsService{
    Client:          factory.NewInventoryClient(&repository.ConfigRepositoryImpl{}),
    TokenRepository: &repository.TokenRepositoryImpl{},
}
slotId := "slot-1"
slotUsed := int32(1)
qty := int32(1)
sourceItemId := "source item id"
type_ := "ingame"
body := &inventoryclientmodels.ApimodelsSaveItemReq {
    CustomAttributes: map[string]interface{}{},
    SlotID: &slotId,
    SlotUsed: &slotUsed,
    Qty: &qty,
    ServerCustomAttributes: map[string]interface{}{},
    SourceItemID:&sourceItemId,
    Tags: []string{"weapon"},
    Type: &type_,
}
namespace, _ := cmd.Flags().GetString("namespace")
userId, _ := cmd.Flags().GetString("userId")
input := &admin_items.AdminSaveItemParams{
    Body:      body,
    Namespace: namespace,
    UserID:    userId,
}
result, err := adminItemsService.AdminSaveItemShort(input)

Java Extend SDK

final AccelByteSDK sdk = new AccelByteSDK(httpClient, tokenRepository, configRepository);
AdminItems adminItemsWrapper = new AdminItems(sdk);

String gameNamespace = "gameNamespace";
String userId = "userId";
Map<String, Object> customAttributes = Collections.emptyMap();
Map<String, Object>  serverCustomAttributes = Collections.emptyMap();
ApimodelsItemResp response;
try {
    ApimodelsSaveItemReq reqBody = ApimodelsSaveItemReq.builder()
        .customAttributes(customAttributes)
        .slotId("slot-1")
        .slotUsed(1)
        .qty(1)
        .serverCustomAttributes(serverCustomAttributes)
        .sourceItemId("source item id")
        .tags(List.of("weapon"))
        .type("ingame")
        .build();
    response = adminItemsWrapper.adminSaveItem(AdminSaveItem.builder()
        .namespace(gameNamespace)
        .userId(userId)
        .body(reqBody)
        .build());
} catch (Exception e) {
    // Do something when failed
    return;
}

if (response == null) {
    // null response from server
} else {
    // Do something when successful
}

Python Extend SDK

import accelbyte_py_sdk.api.inventory as inventory_service
import accelbyte_py_sdk.api.inventory.models as inventory_models

result, error = inventory_service.admin_save_item(
    body=inventory_models.ApimodelsSaveItemReq()
        .with_custom_attributes({})
        .with_inventory_configuration_code("SomeConfigurationCode")
        .with_qty(1)
        .with_server_custom_attributes({})
        .with_slot_id("slot-1")
        .with_slot_used(1)
        .with_source("source")
        .with_source_item_id("source-item-id")
        .with_tags(["weapon"])
        .with_type("ingame"),
    user_id="********************************",
    namespace=namespace,  # optional, gets the value from the global instance if unspecified
    sdk=sdk,  # optional, gets the global instance  if unspecified
)
if error:
    exit(error)

プレイヤーのインベントリからアイテムのリストを取得する

参照用にこの関数を使用します。

Unreal Engine

// The code snippet will be available on the future update

Unity

string inventoryId = "someInventoryId";
Result<UserItemsPagingResponse> getUserItemResult = null;
AccelByteSDK.GetServerRegistry().GetApi().GetInventory().GetUserInventoryAllItems(inventoryId, result =>
{
    if (result.IsError)
    {
        //Do something if GetUserInventoryAllItems is failed
        UnityEngine.Debug.Log($"failed to get item [{result.Error.Code}]:{result.Error.Message}");
        return;
    }
                        
    //Do something if GetUserInventoryAllItems is success
    getUserItemResult = result;
});

C# Extend SDK

AccelByteSDK sdk = AccelByteSDK.Builder
    .UseDefaultHttpClient()
    .SetConfigRepository()
    .UseDefaultTokenRepository()
    .EnableLog() // Optional
    .Build();

string gameNamespace = "gameNamespace";
string inventoryId = "inventoryId";
long limit = 10;
long offset = 0;


var response = sdk.Inventory.AdminItems.AdminListItemsOp
    .SetLimit(limit)
    .SetOffset(offset)
    .SetSortBy(AdminListItemsSortBy.CreatedAt)
    .SetSourceItemId("sourceItemId")
    .SetTags("weapon")
    .Execute(inventoryId, gameNamespace);
if (response == null)
    return "No response from server.";


// Do something with the response

Go Extend SDK

adminItemsService := &inventory.AdminItemsService{
    Client:          factory.NewInventoryClient(&repository.ConfigRepositoryImpl{}),
    TokenRepository: &repository.TokenRepositoryImpl{},
}
inventoryId := "inventoryId"
namespace := "gameNamespace"
limit := int64(10)
offset := int64(0)
qtyGte := int64(1)
sortBy := admin_items.AdminListItemsCreatedAtConstant
sourceItemId := "source item ids"
tags := "weapon"
input := &admin_items.AdminListItemsParams{
    InventoryID:  inventoryId,
    Namespace:    namespace,
    Limit:        &limit,
    Offset:       &offset,
    QtyGte:       &qtyGte,
    SortBy:       &sortBy,
    SourceItemID: &sourceItemId,
    Tags:         &tags,
}
result, err := adminItemsService.AdminListItemsShort(input)

Java Extend SDK

final AccelByteSDK sdk = new AccelByteSDK(httpClient, tokenRepository, configRepository);
AdminItems adminItemsWrapper = new AdminItems(sdk);

String gameNamespace = "gameNamespace";
String inventoryId = "inventoryId";
int limit = 10;
int offset = 0;
ApimodelsListItemResp response;
try {
    response = adminItemsWrapper.adminListItems(AdminListItems.builder()
        .namespace(gameNamespace)
        .inventoryId(inventoryId)
        .limit(limit)
        .offset(offset)
        .sortBy(AdminListItems.SortBy.CreatedAt.toString())
        .sourceItemId("sourceItemId")
        .tags("weapon")
        .build());
} catch (Exception e) {
    // Do something when failed
    return;
}

if (response == null) {
    // Null response from server
} else {
    // Do something when successful
}

Python Extend SDK

import accelbyte_py_sdk.api.inventory as inventory_service
import accelbyte_py_sdk.api.inventory.models as inventory_models

result, error = inventory_service.admin_list_items(
    inventory_id="inventoryId",
    limit=10,
    offset=0,
    qty_gte=1,
    sort_by="createdAt",
    source_item_id="source-item-id",
    tags="weapon",
    namespace=namespace,  # optional, gets the value from the global instance if unspecified
    sdk=sdk,  # optional, gets the global instance  if unspecified
)
if error:
    exit(error)

アイテムの属性とタグを更新する

ゲームクライアントとは異なり、ゲームサーバーには追加の属性とタグを追加するより多くの機能があります。

カスタム属性を更新する

ゲームサーバーを使用して、プレイヤーが書き込んだカスタム属性と、必要な権限を持つサーバーによってのみ変更できる属性を更新できます。このアクションを使用して、アイテムの統計修飾子など、ゲームプレイ体験に影響を与える属性を更新できます。この属性は serverCustomAttributes フィールドに保存されます。例えば、追加ダメージ、クリティカル、耐久性などを持つアイテムです。

タグを更新する

ゲームサーバーを使用して、タグ付けとグループ化の目的でアイテムにタグを追加できます。ゲームサーバーはアイテムにタグを追加でき、プレイヤーが更新することはできません。

次の画像は、タグを持つサンプルアイテムを示しています。

参照用にこの関数を使用します。

Unreal Engine

// The code snippet will be available on the future update

Unity

string inventoryId = "someInventoryId";
string targetUserId = "someAccelByteUserId";
string sourceItemId = "source-item-id"; // if the source is ECOMMERCE, fill this value as item Id from the store
Dictionary<string, object> customAttributes = new Dictionary<string, object>()
{
    {"durability", 150},
    {"damageGiven", 120.5f},
    {"ability", "Sunder Armor"}
};
string[] tags = new string[] { "weapon", "melee" };

var payload = new ServerUpdateUserInventoryItemPayload[]
{
    new ServerUpdateUserInventoryItemPayload(sourceItemId)
    {
        CustomAttributes = customAttributes,
        Tags = tags
    }
};

Result<UpdateUserInventoryItemResponse[]> updateInventoryItemResult = null;
AccelByteSDK.GetServerRegistry().GetApi().GetInventory().BulkUpdateUserInventoryItems(inventoryId
    , targetUserId
    , payload
    , result =>
{
    if (result.IsError)
    {
        //Do something if BulkUpdateUserInventoryItems is failed
        UnityEngine.Debug.Log($"failed to update [{result.Error.Code}]:{result.Error.Message}");
        return;
    }
                        
    //Do something if BulkUpdateUserInventoryItems is success
    updateInventoryItemResult = result;
});

C# Extend SDK

AccelByteSDK sdk = AccelByteSDK.Builder
    .UseDefaultHttpClient()
    .SetConfigRepository()
    .UseDefaultTokenRepository()
    .EnableLog() // Optional
    .Build();


string gameNamespace = "gameNamespace";
string inventoryId = "inventoryId";
string userId = "userId";
Dictionary<string, object> customAttributes = new Dictionary<string, object>();
Dictionary<string, object> serverCustomAttributes = new Dictionary<string, object>();


List<ApimodelsAdminUpdateItemReq> body = new List<ApimodelsAdminUpdateItemReq>()
{
    new  ApimodelsAdminUpdateItemReq()
    {
        CustomAttributes = customAttributes,
        SlotId = "slot id",
        SourceItemId = "sourceItemId",
        ServerCustomAttributes = serverCustomAttributes,
        Tags = new List<string>() { "Axe" },
        Type = "ingame"
    }
};


var response = sdk.Inventory.AdminItems.AdminBulkUpdateMyItemsOp
    .Execute(body, inventoryId, gameNamespace, userId);
if (response == null)
    return "No response from server.";


// Do something with the response

Go Extend SDK

adminItemsService := &inventory.AdminItemsService{
    Client:          factory.NewInventoryClient(&repository.ConfigRepositoryImpl{}),
    TokenRepository: &repository.TokenRepositoryImpl{},
}
slotId := "slot id"
sourceItemId := "sourceItemId"
type_ := "ingame"
item := inventoryclientmodels.ApimodelsAdminUpdateItemReq{
    CustomAttributes: map[string]interface{}{},
    SlotID: &slotId,
    SourceItemID: &sourceItemId,
    ServerCustomAttributes: map[string]interface{}{},
    Tags : []string{"Axe"},
    Type: &type_,
}
body := []*inventoryclientmodels.ApimodelsAdminUpdateItemReq{
    &item,
}
inventoryId := "inventoryId"
namespace := "gameNamespace"
userId := "userId"
input := &admin_items.AdminBulkUpdateMyItemsParams{
    Body:        body,
    InventoryID: inventoryId,
    Namespace:   namespace,
    UserID:      userId,
}
result, err := adminItemsService.AdminBulkUpdateMyItemsShort(input)

Java Extend SDK

final AccelByteSDK sdk = new AccelByteSDK(httpClient, tokenRepository, configRepository);
AdminItems adminItemsWrapper = new AdminItems(sdk);

String gameNamespace = "gameNamespace";
String inventoryId = "inventoryId";
String userId = "userId";
Map<String, Object> customAttributes = Collections.emptyMap();
Map<String, Object> serverCustomAttributes = Collections.emptyMap();

List<ApimodelsUpdateItemResp> response;
try {
    final List<ApimodelsAdminUpdateItemReq> reqBody = Arrays.asList(ApimodelsAdminUpdateItemReq.builder()
        .customAttributes(customAttributes)
        .slotId("slot id")
        .sourceItemId("sourceItemId")
        .serverCustomAttributes(serverCustomAttributes)
        .tags(Arrays.asList("Axe"))
        .type("ingame")
        .build());
    response = adminItemsWrapper.adminBulkUpdateMyItems(AdminBulkUpdateMyItems.builder()
        .namespace(gameNamespace)
        .inventoryId(inventoryId)
        .userId(userId)
        .body(reqBody)
        .build());
} catch (Exception e) {
    // Do something when failed
    return;
}

if (response == null) {
    // Null response from server
} else {
    // Do something when successful
}

Python Extend SDK

import accelbyte_py_sdk.api.inventory as inventory_service
import accelbyte_py_sdk.api.inventory.models as inventory_models

result, error = inventory_service.admin_bulk_update_my_items(
    body=[
        ApimodelsAdminUpdateItemReq().
            .with_custom_attributes({})
            .with_server_custom_attributes({})
            .with_slot_id("slot-1")
            .with_source_item_id("source-item-id")
            .with_tags(["Axe"])
            .with_type("ingame")
    ],
    inventory_id="inventoryId",
    user_id="********************************",
    namespace=namespace,  # optional, gets the value from the global instance if unspecified
    sdk=sdk,  # optional, gets the global instance  if unspecified
)
if error:
    exit(error)

アイテムを消費する

ゲームサーバー経由でプレイヤーが所有するアイテムを消費するには、参照用にこの関数を使用します。

Unreal Engine

// The code snippet will be available on the future update

Unity

// Use the result from GetUserInventoryAllItems() to make sure the values
string slotId = "slot-1";
string inventoryId = "someInventoryId";
string targetUserId = "someAccelByteUserId";
string sourceItemId = "sourceItemId";
int quantity = 1;

Result<UserItem> consumeInventoryItemResult = null;
AccelByteSDK.GetServerRegistry().GetApi(apiId).GetInventory().ConsumeUserInventoryItem(inventoryId
        , targetUserId
        , quantity
        , sourceItemId
        , result =>
{
    if (result.IsError)
    {
        //Do something if ConsumeUserInventoryItem is failed
        UnityEngine.Debug.Log($"failed to consume [{result.Error.Code}]:{result.Error.Message}");
        return;
    }
                        
    //Do something if ConsumeUserInventoryItem is success
    consumeInventoryItemResult = result;
});

C# Extend SDK

AccelByteSDK sdk = AccelByteSDK.Builder
    .UseDefaultHttpClient()
    .SetConfigRepository()
    .UseDefaultTokenRepository()
    .EnableLog() // Optional
    .Build();


string gameNamespace = "gameNamespace";
string inventoryId = "inventoryId";
string userId = "userId";


ApimodelsConsumeItemReq body = new ApimodelsConsumeItemReq()
{
    Qty = 1,
    SlotId = "slotId",
    SourceItemId = "source item id"
};


var response = sdk.Inventory.AdminItems.AdminConsumeUserItemOp
    .Execute(body, inventoryId, gameNamespace, userId);
if (response == null)
    return "No response from server.";


// Do something with the response

Go Extend SDK

adminItemsService := &inventory.AdminItemsService{
    Client:          factory.NewInventoryClient(&repository.ConfigRepositoryImpl{}),
    TokenRepository: &repository.TokenRepositoryImpl{},
}
qty := int32(1)
slotId := "slotId"
sourceItemId := "sourceItemId"
body := inventoryclientmodels.ApimodelsConsumeItemReq {
    Qty: &qty,
    SlotID: &slotId,
    SourceItemID: &sourceItemId,
}
inventoryId := "inventoryId"
namespace := "gameNamespace"
userId := "userId"
input := &admin_items.AdminConsumeUserItemParams{
    Body:        &body,
    InventoryID: inventoryId,
    Namespace:   namespace,
    UserID:      userId,
}
result, err := adminItemsService.AdminConsumeUserItemShort(input)

Java Extend SDK

final AccelByteSDK sdk = new AccelByteSDK(httpClient, tokenRepository, configRepository);
AdminItems adminItemsWrapper = new AdminItems(sdk);

String gameNamespace = "gameNamespace";
String inventoryId = "inventoryId";
String userId = "userId";
ApimodelsItemResp response;
try {
    final ApimodelsConsumeItemReq reqBody = ApimodelsConsumeItemReq.builder()
            .qty(1)
            .slotId("slotId")
            .sourceItemId("source item id")
            .build());
    response = adminItemsWrapper.adminConsumeUserItem(AdminConsumeUserItem.builder()
            .namespace(gameNamespace)
            .inventoryId(inventoryId)
            .userId(userId)
            .body(reqBody)
            .build());
} catch (Exception e) {
    // Do something when failed
    return;
}

if (response == null) {
    // Null response from server
} else {
    // Do something when successful
}

Python Extend SDK

import accelbyte_py_sdk.api.inventory as inventory_service
import accelbyte_py_sdk.api.inventory.models as inventory_models

result, error = inventory_service.admin_consume_user_item(
    body=ApimodelsConsumeItemReq()
        .with_qty(1)
        .with_slot_id("slot-1")
        .with_source_item_id("source-item-id"),
    inventory_id="inventoryId",
    user_id="********************************",
    namespace=namespace,  # optional, gets the value from the global instance if unspecified
    sdk=sdk,  # optional, gets the global instance  if unspecified
)
if error:
    exit(error)

プレイヤーのインベントリからアイテムを削除する

ゲームサーバー経由でプレイヤーが所有するアイテムをインベントリから削除するには、参照用にこの関数を使用します。

Unreal Engine

// The code snippet will be available on the future update

Unity

// Use the result from GetUserInventoryAllItems() to make sure the values
string slotId = "slot-1";
string sourceItemId = "store-item-id";
string inventoryId = "someInventoryId";
string targetUserId = "someAccelByteUserId";

var payload = new BulkDeleteUserInventoryItemsPayload[]
{
    new BulkDeleteUserInventoryItemsPayload(sourceItemId)
    {
        SlotId = slotId
    }
};

Result<DeleteUserInventoryItemResponse[]> deleteResult = null;
AccelByteSDK.GetServerRegistry().GetApi().GetInventory().BulkDeleteUserInventoryItems(inventoryId
    , targetUserId
    , payload
    , result =>
{
    if (result.IsError)
    {
        //Do something if BulkDeleteUserInventoryItems is failed
        UnityEngine.Debug.Log($"failed to BulkDeleteUserInventoryItems [{result.Error.Code}]:{result.Error.Message}");
        return;
    }

    //Do something if BulkDeleteUserInventoryItems is success
    deleteResult = result;
});

C# Extend SDK

AccelByteSDK sdk = AccelByteSDK.Builder
    .UseDefaultHttpClient()
    .SetConfigRepository()
    .UseDefaultTokenRepository()
    .EnableLog() // Optional
    .Build();


string gameNamespace = "gameNamespace";
string inventoryId = "inventoryId";
string userId = "userId";


List<ApimodelsRemoveInventoryItemReq> body = new List<ApimodelsRemoveInventoryItemReq>()
{
    new  ApimodelsRemoveInventoryItemReq()
    {
        SlotId = "slot id",
        SourceItemId = "source item id"
    }
};


var response = sdk.Inventory.AdminItems.AdminBulkRemoveItemsOp
    .Execute(body, inventoryId, gameNamespace, userId);
if (response == null)
    return "No response from server.";


// Do something with the response

Go Extend SDK

adminItemsService := &inventory.AdminItemsService{
    Client:          factory.NewInventoryClient(&repository.ConfigRepositoryImpl{}),
    TokenRepository: &repository.TokenRepositoryImpl{},
}
slotId := "slot id"
sourceItemId := "source item id"
item := inventoryclientmodels.ApimodelsRemoveInventoryItemReq {
    SlotID: &slotId,
    SourceItemID: &sourceItemId,
}
body := []*inventoryclientmodels.ApimodelsRemoveInventoryItemReq {
    &item,
}
inventoryId := "inventoryId"
namespace := "gameNamespace"
userId := "userId"
input := &admin_items.AdminBulkRemoveItemsParams{
    Body:        body,
    InventoryID: inventoryId,
    Namespace:   namespace,
    UserID:      userId,
}
result, err := adminItemsService.AdminBulkRemoveItemsShort(input)

Java Extend SDK

final AccelByteSDK sdk = new AccelByteSDK(httpClient, tokenRepository, configRepository);
AdminItems adminItemsWrapper = new AdminItems(sdk);

String gameNamespace = "gameNamespace";
String inventoryId = "inventoryId";
String userId = "userId";
List<ApimodelsUpdateItemResp> response;
try {
    final List<ApimodelsRemoveInventoryItemReq> reqBody = Arrays.asList(ApimodelsRemoveInventoryItemReq.builder()
        .slotId("slot id")
        .sourceItemId("source item id")
        .build());
    response = adminItemsWrapper.adminBulkRemoveItems(AdminBulkRemoveItems.builder()
        .namespace(gameNamespace)
        .inventoryId(inventoryId)
        .userId(userId)
        .body(reqBody)
        .build());
} catch (Exception e) {
    // Do something when failed
    return;
}

if (response == null) {
    // Null response from server
} else {
    // Do something when successful
}

Python Extend SDK

import accelbyte_py_sdk.api.inventory as inventory_service
import accelbyte_py_sdk.api.inventory.models as inventory_models

result, error = inventory_service.admin_bulk_remove_items(
    body=[
        ApimodelsRemoveInventoryItemReq()
            .with_slot_id("slot-1")
            .with_source_item_id("source-item-id")
    ],
    inventory_id="inventoryId",
    user_id="********************************",
    namespace=namespace,  # optional, gets the value from the global instance if unspecified
    sdk=sdk,  # optional, gets the global instance  if unspecified
)
if error:
    exit(error)