Промокоды

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

Акции с промокодами — маркетинговый инструмент для привлечения внимания потенциальных пользователей к продукту и повышения уровня продаж. После активации промокода и оплаты товаров в корзине пользователь получает один из вариантов вознаграждения:

скидку, которая применяется к корзине пользователя;
бонусный предмет:
- пакет виртуальной валюты;
- игровой ключ;
- виртуальный предмет — в том числе бандл или непродлеваемую подписку.

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

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

Ограничения:

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

Сценарий пользователя:

Пользователь вводит промокод в соответствующее поле в интерфейсе корзины.
Стоимость корзины пересчитывается.
Пользователь совершает оплату покупки, после чего промокод считается погашенным.
Если промокод содержал бонусные предметы, они доставляются пользователю одним из способов:

в инвентарь (виртуальный предмет или пакет виртуальной валюты);
на email-адрес (игровой ключ);
в систему владения играми (игровой ключ).

Для кого подходит

Для партнеров, у которых подключен один из следующих продуктов (или оба):
- Внутриигровой магазин
- Buy Button
Для партнеров, которые хотят увеличить продажи с помощью акций с промокодами.

Как настроить

Предварительные действия

Зарегистрируйтесь в Личном кабинете Иксолла.
Подключите Магазин к вашему проекту.

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

Настройте акционную кампанию с промокодами.
Реализуйте методы получения вознаграждения по промокоду.
Реализуйте методы погашения промокода.

Настройка кампании с промокодами

В разделе Магазин > Акции в Личном кабинете создайте акцию.
Задайте необходимые параметры:

Укажите название акции.
Выберите тип Промокоды.

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

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

Укажите общее количество погашений и количество погашений на пользователя.
Укажите срок действия кампании.
Проверьте настройки и сохраните акцию.
Перейдите в раздел редактирования акции.
На вкладке Коды выберите тип генерации промокодов.
Сгенерируйте или введите вручную промокод.
Сохраните изменения.
Активируйте акцию.

Промокод с пакетом виртуальной валюты

Для промокода с пакетом виртуальной валюты необходимо указать пакет. Чтобы создать пакеты:

Перейдите в настройки модуля Виртуальная валюта и задайте следующие параметры:

изображение;
артикул;
название;
стоимость за единицу;
валюта по умолчанию.

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

изображение;
артикул;
название;
описание;
используемая валюта;
количество валюты в пакете;
цена;
валюта по умолчанию.

Включите отображение пакетов в Магазине.

Промокод с игровым ключом

Для промокода с игровым ключом необходимо указать артикул ключа и способ выбора DRM:

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

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

Промокод с виртуальным предметом

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

Генерация промокодов

В кампании может быть множество промокодов. Формат промокода может быть представлен в следующих вариантах:

Введенная вручную строка (максимум 128 символов). Подходит для кампании из единственного промокода с многократным использованием.
Сгенерированная строка — строка из цифр и букв латинского алфавита длиной 10 символов. Подходит для кампании с большим количеством промокодов.

Промокоды генерируются в редакторе акции после создания акционной кампании. Возможна многократная генерация промокодов. Загрузка введенных вручную промокодов выполняется по запросу.

Note:

Промокод чувствителен к регистру. Например, winter2021 и WINTER2021 — разные промокоды.

Региональные ограничения

Региональные ограничения устанавливаются на всю акционную кампанию. Установка региональных ограничений выполняется по запросу.

Получение вознаграждения по промокоду

Реализуйте вызов метода Get promo code rewards для получения списка предметов, которые могут быть начислены пользователю при погашении промокода. В зависимости от значения параметра is_selectable в ответе, возможны два сценария:

Если в ответе is_selectable=true, для каждого элемента item с type=unit необходимо отобразить форму выбора элементов из объекта unit_items, в которой пользователь сможет выбрать только один элемент для каждого типа unit.

Пример ответа:

{
   "bonus": [{
       "item": {
           "sku": "xsollus_gold_edition",
           "name": "Xsollus: Gold Edition",
           "type": "unit",
           "description": null,
           "image_url": "https:\/\/cdn3.xsolla.com\/img\/misc\/images\/9541470622d96a821a9a11ea7763ea4c.png",
           "unit_items": [{
               "sku": "xsollus_gold_edition_steam",
               "name": "Xsollus: Gold Edition (steam)",
               "type": "game_key",
               "drm_name": "Steam",
               "drm_sku": "steam"
           }, {
               "sku": "xsollus_gold_edition_playstation",
               "name": "Xsollus: Gold Edition (playstation)",
               "type": "game_key",
               "drm_name": "Playstation",
               "drm_sku": "playstation"
           }, {
               "sku": "xsollus_gold_edition_xbox",
               "name": "Xsollus: Gold Edition (xbox)",
               "type": "game_key",
               "drm_name": "XBox",
               "drm_sku": "xbox"
           }, {
               "sku": "xsollus_gold_edition_nintendo_eshop",
               "name": "Xsollus: Gold Edition (nintendo_eshop)",
               "type": "game_key",
               "drm_name": "Nintendo Switch eShop",
               "drm_sku": "nintendo_eshop"
           }]
       },
       "quantity": 1
   }, {
       "item": {
           "sku": "xsollus_bonus_pack_edition",
           "name": "Xsollus: Bonus Pack",
           "type": "unit",
           "description": null,
           "image_url": "https:\/\/cdn3.xsolla.com\/img\/misc\/images\/aa2efd78dfd4e5dda5293f8c8e49af6d.png",
           "unit_items": [{
               "sku": "xsollus_bonus_pack_edition_steam",
               "name": "Xsollus: Bonus Pack (steam)",
               "type": "game_key",
               "drm_name": "Steam",
               "drm_sku": "steam"
           }, {
               "sku": "xsollus_bonus_pack_edition_origin",
               "name": "Xsollus: Bonus Pack (origin)",
               "type": "game_key",
               "drm_name": "Origin",
               "drm_sku": "origin"
           }, {
               "sku": "xsollus_bonus_pack_edition_drmfree",
               "name": "Xsollus: Bonus Pack (drmfree)",
               "type": "game_key",
               "drm_name": "DRM Free",
               "drm_sku": "drmfree"
           }, {
               "sku": "xsollus_bonus_pack_edition_gog",
               "name": "Xsollus: Bonus Pack (gog)",
               "type": "game_key",
               "drm_name": "GOG",
               "drm_sku": "gog"
           }, {
               "sku": "xsollus_bonus_pack_edition_rockstar",
               "name": "Xsollus: Bonus Pack (rockstar)",
               "type": "game_key",
               "drm_name": "Rockstar Games Launcher",
               "drm_sku": "rockstar"
           }]
       },
       "quantity": 3
   }],
   "discount": {
       "percent": null
   },
   "is_selectable": true

Если is_selectable=false, дополнительные параметры в запросе передавать не нужно.

Погашение промокода

Реализуйте вызов метода Redeem promo code, чтобы использовать промокод. В зависимости от значения параметра is_selectable в ответе метода Get promo code rewards, возможны два сценария:

Если is_selectable=true, при вызове метода Redeem promo code необходимо передать объект selected_unit_items в следующем формате:

selected_unit_items:{
      unit_1_sku: "selected_unit_item_sku",
      unit_2_sku: "selected_unit_item_sku"
}