Атрибуты товара

Атрибуты — это характеристики товара, с помощью которых можно предоставить дополнительную информацию о нем пользователю.

Атрибутом может быть цвет и размер предмета, уровень пользователя, на котором предмет становится ему доступен, событие в игре.

Основные возможности:

  • фильтрация товаров в магазине;
  • определение вариантов товара (например, красный шлем, синий шлем) и отображение их на карточке товара;
  • назначение дополнительных характеристик для товара.

Примеры атрибутов товара и их значений:

Вид товараНазвание атрибута товараЗначения атрибута товара
Игровые ключиТип игрыНовая, Ранний доступ, Скоро, Особенное
Игровые ключиЖанрЭкшн, Приключения, Казуальная, Симулятор, Стратегия, RPG
Виртуальные предметыКачествоЭпик, Легендарный, Обычный
Виртуальные предметыКлассВоин, Паладин, Охотник, Шаман, Друид
Виртуальная валютаСобытиеНовый год
Виртуальная валютаКвестЗавершение квеста 1, Завершение квеста 2

Как это работает

  1. Вы создаете атрибуты товара и их значения и привязываете их к товару:
  • через Личный кабинет или через методы API с указанием External ID атрибутов товара и External ID значений;
  • через Личный кабинет c указанием атрибутов и их значений в формате JSON.
  1. Вы используете методы подраздела Catalog из группы методов Virtual Items & Currency или Game Keys для запроса каталога товаров. Данные по атрибутам возвращаются:
  • В массиве attributes, если атрибуты созданы через Личный кабинет или API с указанием External ID атрибутов товара и External ID значений.
  • В массиве custom_attributes, если атрибуты и значения добавлены через JSON. Для этого в запросе на получение каталога необходимо передать параметр additional_fields со значением custom_attributes.
  1. Пользователь совершает покупку. Если атрибуты и значения добавлены через JSON, данные об атрибутах товара передаются в вебхуках Успешная оплата заказа и Отмена заказа в массиве custom_attributes.

Сценарий интеграции

Вы можете создать атрибуты товара и их значения на своей стороне и добавить их к товару в формате JSON в Личном кабинете.

Также вы можете создать атрибуты и их значения на стороне Xsolla и добавить их к товарам. Для этого:

  1. Создайте атрибуты и их значения.
  2. Настройте связь между атрибутами и товарами.
Примечание

При добавлении атрибутов товара и их значений из JSON действует ограничение на длину JSON — 500 символов. Ограничения на количество атрибутов и значений отсутствуют.

При создании атрибутов и их значений в Личном кабинете или через методы API действуют следующие ограничения:

  • для одного атрибута товара может быть задано не более 20 значений;
  • для каждого товара может быть настроено не более 20 атрибутов;
  • одному товару может соответствовать несколько значений одного атрибута, но не более 6.

Создание и настройка атрибутов товара и их значений

Каждый атрибут товара имеет следующие параметры:

  • External ID — уникальный ID атрибута, который передается в параметре external_id в теле запроса. Укажите ID атрибута в вашей системе или создайте новый.
  • Название (указывается для каждого языка, настроенного в проекте).
  • Список значений.

Каждое значение атрибута товара имеет следующие параметры:
  • External ID родительского атрибута товара.
  • External ID значения — уникальный ID значения, который передается в параметре external_id в параметрах пути. Укажите ID значения в вашей системе или создайте новый.
  • Название (указывается для каждого языка, настроенного в проекте).

Создать атрибуты товара и их значения можно следующими способами:

Создание атрибутов и их значений в Личном кабинете

  1. Откройте проект в Личном кабинете.
  2. Перейдите в раздел Store > Управление каталогом.
  1. В разделе Атрибуты товара нажмите Настроить.
  2. Нажмите Создать атрибут товара.
  3. Укажите External ID и название атрибута товара.
  4. Нажмите Сохранить и продолжить.
  5. Задайте необходимые значения для созданного атрибута товара. Для каждого значения укажите External ID. Чтобы добавить еще одно значение, нажмите +.
  6. Нажмите Сохранить и продолжить.
Примечание

Количество атрибутов товара в проекте не ограничено.

Для одного атрибута товара может быть задано не более 20 значений.

После создания атрибутов и значений вы можете добавить их к товарам через API или через Личный кабинет.

Создание атрибутов и их значений через методы API

Для создания и управления атрибутами товара и их значениями используйте методы подраздела Admin из группы методов Item attributes.

Методы для создания атрибутов и управления ими:

Методы для создания значений атрибутов и управления ими:
Внимание

При удалении атрибута товара удаляются значения атрибута и связи с товарами.

При удалении значения атрибута удаляются его связи с товарами.

После выполнения операции восстановление этих данных невозможно.

После создания атрибутов и значений вы можете добавить их к товарам через API или через Личный кабинет.

Добавление атрибутов к товару

Добавьте созданные атрибуты и значения к товарам:

Добавление существующих атрибутов через Личный кабинет

Чтобы добавить атрибут к товару:
  1. Откройте проект в Личном кабинете.
  2. В боковом меню нажмите Store.
  3. Перейдите в раздел с нужным типом товаров:
    • Виртуальные предметы;
    • Виртуальная валюта;
    • Игровые ключи;
    • Бандлы.
  4. Создайте новый товар или отредактируйте существующий.
  5. В разделе Атрибуты товара установите переключатель Выбрать существующие атрибуты или создать новые в положение Вкл.
  6. В появившемся поле Атрибут товара выберите ID, соответствующий нужному атрибуту товара.
  7. В появившемся поле Значение выберите ID, соответствующий нужному значению атрибута товара.
Примечание

Для каждого товара может быть настроено не более 20 атрибутов.

Одному товару может соответствовать несколько значений одного атрибута, но не более 6.

Добавление существующих атрибутов через методы API

В метод Create virtual item или Update virtual item передайте массив объектов с External ID атрибутов товара и External ID их значений, которые требуется привязать.

Пример массива с атрибутами и их значениями:

Copy
Full screen
Small screen
  "attributes": [
    {
      "external_id": "craft-materials",
      "name": {
        "en": "Craft materials"
      },
      "values": [
        {
          "external_id": "steel",
          "value": {
            "en-US": "5"
          }
        },
        {
          "external_id": "leather",
          "value": {
            "en-US": "1"
          }
        }
      ]
    }
  ],
Примечание
При запросе каталога товаров с использованием методов подраздела Catalog из группы методов Virtual Items & Currency или Game Keys в ответе также возвращается список соответствующих атрибутов и их значений в массиве attributes.
Примечание

Для каждого товара может быть настроено не более 20 атрибутов.

Одному товару может соответствовать несколько значений одного атрибута, но не более 6.

Добавление атрибутов из JSON через Личный кабинет

Вы можете добавить атрибуты и их значения в формате JSON при создании или редактировании всех типов товаров, таких как:

Для этого:

  1. Откройте проект в Личном кабинете.
  2. В боковом меню нажмите Store.
  3. Перейдите в раздел с нужным типом товаров:
    • Виртуальные предметы;
    • Виртуальная валюта;
    • Игровые ключи;
    • Бандлы.
  4. Создайте новый товар или отредактируйте существующий.
  5. В блоке Атрибуты товара установите переключатель Добавить атрибуты из JSON в положение Вкл.
  1. В отобразившуюся текстовую область добавьте перечень атрибутов и их значений в формате JSON.
Примечание

При добавлении в формате JSON количество атрибутов и их значений не ограничено.

Действует ограничение на максимальную длину JSON — 500 символов.

Была ли статья полезна?
Спасибо!
Что может сделать страницу еще лучше? Сообщение
Жаль, что так произошло
Расскажите, почему статья не была полезна. Сообщение
Спасибо за обратную связь!
Ваши мысли и идеи помогут нам улучшить ваш пользовательский опыт.
Последнее обновление: 10 октября 2023

Нашли опечатку или ошибку в тексте? Выделите ее и нажмите Ctrl+Enter.

Сообщите о проблеме
Мы постоянно улучшаем качество нашей документации. Ваш отзыв поможет нам в этом.
Укажите email-адрес, чтобы мы могли связаться с вами
Спасибо за обратную связь!