Бесплатные товары

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

Бесплатные товары — это вид товаров, которые пользователь может получить, не тратя виртуальную или реальную валюту.

Бесплатные товары доступны в следующих сценариях:

• продажа внутриигровых товаров — виртуальные предметы, пакеты виртуальной валюты и бандлы
• продажа игр и DLC через ключи игры

Примеры использования:

• Бесплатные товары, приуроченные к важным этапам проекта или особым датам (например, к годовщине), как награда за лояльность.
• Бесплатные дополнения для пользователей, которые уже купили базовую игру, как награда за лояльность.
• Бесплатные стартовые наборы, доступные в веб‑магазине, чтобы привлечь новых пользователей в игру.

Бесплатные виртуальные предметы, валюта и бандлы доступны для получения только авторизованным пользователям. Бесплатные игровые ключи доступны как авторизованным, так и неавторизованным пользователям. Лимит на количество бесплатных товаров можно настроить только для авторизованных пользователей.

Настройка бесплатных товаров

2. Нажмите Create manually и выберите Virtual item из выпадающего списка.

3. В разделе General settings укажите следующее:
   • SKU
   • одну или несколько групп, к которым должен относиться товар (опционально)
   • название
   • краткое описание
   • расширенное описание — чтобы добавить его, включите соответствующий переключатель (опционально)

4. В разделе Media загрузите одно или несколько изображений или видео (необязательно) — с вашего устройства или по ссылке. В Магазине, созданном с помощью Xsolla site editor, все карточки товаров отображают файл, помеченный как Main, а остальные файлы доступны только в карточках с медиагалереей. Файл, помеченный как Main, также возвращается в ответах методов API получения каталога.

5. В разделе Price settings выберите Free item.

6. Чтобы ограничить количество доступных к покупке товаров:
   1. Включите переключатель в разделе Limits и укажите количество.
   2. Настройте частоту сброса лимита. Для этого выберите период из выпадающего списка:
      1. Daily.
      2. Weekly.
      3. Monthly.
      4. Custom interval. Интервал рассчитывается от даты начала отображения предмета в магазине.
      5. No regular refresh.
   3. Настройте расписание сброса, указав параметры, которые соответствуют выбранному периоду.

7. Чтобы настроить лимит времени отображения товара (опционально):

   1. Включите переключатель в разделе Add specific display period.
   2. Укажите часовой пояс, начало и конец периода.

   Чтобы не указывать конец периода отображения товара, включите переключатель No end date.

8. Настройте атрибуты одним из способов (необязательно):
   1. Добавьте атрибуты и их значения в формате JSON.
   2. Создайте атрибуты и их значения вручную и привяжите их к товарам.

9. Нажмите кнопку Create.
10. В открывшемся окне выберите статус товара и нажмите Continue.

Созданный предмет появится в разделе All items.

Настройка через API

Чтобы сделать товар бесплатным, передайте в теле запроса “is_free”: true в методы API подраздела Admin:

• Create virtual item or Update virtual item
• Create game, Update game by ID or Update game by SKU
• Create virtual currency or Update virtual currency
• Create virtual currency package or Update virtual currency package
• Create bundle or Update bundle Если вы хотите ограничить число бесплатных товаров, которые пользователь может получить, передайте в методах создания или обновления товара следующие параметры:
  • limits с указанием количества
  • limits.recurrent_schedule с указанием частоты сброса лимита

Также вы можете настроить лимит времени отображения товара в магазине и задать региональные ограничения.

Отображение бесплатных товаров в каталоге

Отображение бесплатных товаров в каталоге зависит от способа реализации — через конструктор сайтов или через API.

Отображение через site builder

Чтобы бесплатные товары отобразились на вашем сайте:

1. Создайте бесплатные товары.

2. В проекте в Личном кабинете перейдите в раздел Storefronts > Websites.
3. В панели нужного сайта нажмите Open Site Builder.

2. В проекте в аккаунте для мобильных игр перейдите в раздел Web Shop.
3. Нажмите панель нужного сайта.

4. Если на сайте несколько страниц, выберите нужную:
   1. Нажмите на название текущей страницы в верхней части конструктора.
   2. Выберите нужную страницу из выпадающего списка.
5. В разделе Store в поле Item type выберите тип бесплатного товара и укажите его группу, если нужно.
6. Настройте макет карточки товара.
7. После внесения всех изменений и подготовки сайта к публикации:
   1. В правом верхнем углу конструктора нажмите Publish.
   2. Отметьте флажками страницы, которые нужно опубликовать.
   3. Нажмите Publish.

После публикации на сайте станет доступен раздел с бесплатными товарами. Если товары не отображаются, убедитесь, что для них установлен статус Доступно и не задан лимит по времени отображения.

Получение информации о бесплатных товарах через API

Если ваш каталог настроен с помощью API, данные о бесплатных товарах возвращаются в методах из подраздела Catalog:

• Get virtual items list
• Get virtual currency list
• Get virtual currency packages list
• Get bundles list
• Get games list

Выдача бесплатных товаров пользователям

Способ оформления заказа с бесплатными товарами зависит от того, используется ли корзина при покупке.

Если пользователь покупает товар без использования корзины, используйте метод API Create order with specified free item.

Если пользователь использует покупку через корзину, возможны следующие сценарии:

• Если в корзине пользователя есть платные и бесплатные товары, используйте методы создания заказа Create order with all items from particular cart или Create order with all items from current cart. В этом случае пользователь завершает оплату через платежный интерфейс.
• Если в корзине пользователя только бесплатные товары, используйте методы API Create order with free cart или Create order with particular free cart. В этом случае платежный интерфейс не используется.

  В обоих случаях Xsolla отправляет вебхук Successful payment for order с данными о товарах, которые используются для выдачи пользователю. Для бесплатных товаров параметр order.invoice_id в вебхуке равен null.

Пример объекта order для бесплатных товаров:

 1{
 2  "method": "POST",
 3  "url": "https://mybestgame.com/xsolla/notification",
 4  "body": {
 5    "items": [
 6      {
 7        "sku": "gift_direct_game_reward-supercoin",
 8        "type": "virtual_currency",
 9        "is_pre_order": false,
10        "quantity": 500,
11        "amount": "0",
12        "promotions": [
13
14        ]
15      },
16      {
17        "sku": "package-500_supercoin",
18        "type": "bundle",
19        "is_pre_order": false,
20        "quantity": 1,
21        "amount": "0",
22        "promotions": [
23
24        ]
25      },
26      {
27        "sku": "xsolla-giveaway_offer_11_14_22",
28        "type": "bundle",
29        "is_pre_order": false,
30        "quantity": 1,
31        "amount": "0",
32        "promotions": [
33
34        ]
35      }
36    ],
37    "notification_type": "order_paid",
38    "order": {
39      "id": 12345678,
40      "mode": "default",
41      "currency_type": "unknown",
42      "currency": null,
43      "amount": "0",
44      "status": "paid",
45      "platform": "xsolla",
46      "comment": null,
47      "invoice_id": null,
48      "promotions": [
49
50      ]
51    },
52    "user": {
53      "external_id": "1234567812345678",
54      "email": null
55    }
56  },
57  "headers": {
58    "Authorization": "Signature 3b840ccefea111dcdfd111db1fdc6df969a3ec11",
59    "Accept": "application/json",
60    "Content-Type": "application/json"
61  },
62  "type": "webhook_payment",
63  "callback_parameters": {
64    "order_id": 12345678
65  }
66}

Способ начисления товаров зависит от настроек интеграции в вашем проекте:

• Если вы интегрировали PlayFab, виртуальная валюта и предметы автоматически зачисляются в инвентарь пользователя в PlayFab.
• Если вы используете собственную систему выдачи, все виртуальные предметы и валюту вы выдаете на своей стороне. Рекомендуем настроить обработчик вебхуков, чтобы получать данные о заказе на вашем бэкенде. Необходимые данные содержатся в вебхуке Successful payment for order.

Подробная информация об этом и других способах получения данных о покупке приведена в разделе Отслеживание статуса заказа.