Настройка акционных кампаний

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

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

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

1. Настроить для текущего проекта атрибуты пользователя.
2. Задать в разделе Авторизация схему атрибутов пользователя.

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

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

Для обеспечения целостности передаваемых данных вы можете задать правила валидации атрибутов в виде JSON-схемы в Личном кабинете. Вы можете управлять атрибутами с помощью методов Login API или вебхуков. Значения атрибутов пользователей можно редактировать в Личном кабинете. Используйте инструкцию по настройке атрибутов пользователя.

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

• пакет виртуальной валюты;
• виртуальный предмет.

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

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

Бонус предоставляется пользователю при покупке акционного товара. Пользователь может получить следующие бонусные предметы:

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

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

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

Кампания с купонами

Чтобы запустить кампанию с купонами:

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

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

1. Откройте ваш проект в Личном кабинете.
2. Нажмите Магазин в боковом меню и перейдите в раздел Акции.
3. Нажмите Создать акцию.
4. Задайте необходимые параметры:
   1. Укажите название акции.
   2. Выберите тип Купоны.
5. Выберите вознаграждение, которое получит пользователь при погашении купона:
   • Пакет виртуальной валюты.
   • Виртуальный предмет (один или несколько, в том числе бандлы и предметы с ограниченным сроком действия).
6. Добавьте:
   1. Идентификатор акции в поле Внешний ID.
   2. Бонусные товары, которые будут предоставлены пользователю при использовании купона.
   3. Типы товаров и их количество.
7. Нажмите Далее.
8. Укажите общее количество погашений и количество погашений для пользователя.
9. Укажите срок действия кампании.
10. Нажмите Далее.
11. Проверьте настройки и нажмите Сохранить и выйти.

12. Нажмите Магазин в боковом меню и перейдите в раздел Акции.
13. Выберите акцию, нажмите ••• и выберите Редактировать план.
14. Перейдите на вкладку Коды.
15. Выберите тип генерации купонов.
16. Сгенерируйте код купона или введите код вручную.
17. Активируйте акцию.

Погашение купона по коду

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

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

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

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

{
  {
    "items": [
    {
      "sku": "xsollus_gold_edition_steam",
      "name": "Xsollus: Gold Edition (steam)",
      "type": "game_key",
      "description": null,
      "image_url": "https:\/\/cdn3.xsolla.com\/img\/misc\/images\/9541470622d96a821a9a11ea7763ea4c.png",
      "attributes": [],
      "is_free": true,
      "groups": [],
      "price": null,
      "virtual_prices": [],
      "drm_name": "Steam",
      "drm_sku": "steam",
      "has_keys": false,
      "is_pre_order": true,
      "release_date": null,
      "quantity": 1
    },
    {
      "sku": "xsollus_bonus_pack_edition_origin",
      "name": "Xsollus: Bonus Pack (origin)",
      "type": "game_key",
      "description": null,
      "image_url": "https:\/\/cdn3.xsolla.com\/img\/misc\/images\/aa2efd78dfd4e5dda5293f8c8e49af6d.png",
      "attributes": [],
      "is_free": true,
      "groups": [],
      "price": null,
      "virtual_prices": [],
      "drm_name": "Origin",
      "drm_sku": "origin",
      "has_keys": false,
      "is_pre_order": true,
      "release_date": null,
      "quantity": 3
  }
  ]
}

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

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

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

1. Если в ответе 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_rockstar",
               "name": "Xsollus: Gold Edition (rockstar)",
               "type": "game_key",
               "drm_name": "Rockstar Games Launcher",
               "drm_sku": "rockstar"
           }]
       },
       "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_playstation",
               "name": "Xsollus: Bonus Pack (playstation)",
               "type": "game_key",
               "drm_name": "Playstation",
               "drm_sku": "playstation"
           }, {
               "sku": "xsollus_bonus_pack_edition_xbox",
               "name": "Xsollus: Bonus Pack (xbox)",
               "type": "game_key",
               "drm_name": "XBox",
               "drm_sku": "xbox"

           }]
       },
       "quantity": 3
   }],
   "is_selectable": true

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

Кампания с промокодами

Чтобы запустить кампанию с промокодами:

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

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

1. Откройте ваш проект в Личном кабинете.
2. Нажмите Магазин в боковом меню и перейдите в раздел Акции.
3. Нажмите Создать акцию.
4. Задайте необходимые параметры:
   1. Укажите название акции.
   2. Выберите тип Промокоды.
5. Выберите, что пользователь получит после погашения промокода: ничего, скидку на все товары в корзине, на определенные товары; бонусный товар. Вы можете выбрать несколько вариантов.
6. Укажите процент скидки по промокоду.
7. Нажмите Далее.
8. Укажите общее количество погашений и количество погашений для пользователя.
9. Нажмите Далее.
10. Укажите срок действия кампании.
11. Нажмите Далее.
12. Проверьте настройки и нажмите Сохранить и выйти.

13. Нажмите Магазин в боковом меню и перейдите в раздел Акции.
14. Выберите акцию, нажмите ••• и выберите Редактировать план.
15. Перейдите на вкладку Коды.
16. Выберите тип генерации промокодов.
17. Сгенерируйте код купона или введите код вручную.
18. Активируйте акцию.

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

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

1. Если 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"
}

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

{
  {
    "items": [
    {
      "sku": "xsollus_gold_edition_steam",
      "name": "Xsollus: Gold Edition (steam)",
      "type": "game_key",
      "description": null,
      "image_url": "https:\/\/cdn3.xsolla.com\/img\/misc\/images\/9541470622d96a821a9a11ea7763ea4c.png",
      "attributes": [],
      "is_free": true,
      "groups": [],
      "price": null,
      "virtual_prices": [],
      "drm_name": "Steam",
      "drm_sku": "steam",
      "has_keys": false,
      "is_pre_order": true,
      "release_date": null,
      "quantity": 1
    },
    {
      "sku": "xsollus_bonus_pack_edition_origin",
      "name": "Xsollus: Bonus Pack (origin)",
      "type": "game_key",
      "description": null,
      "image_url": "https:\/\/cdn3.xsolla.com\/img\/misc\/images\/aa2efd78dfd4e5dda5293f8c8e49af6d.png",
      "attributes": [],
      "is_free": true,
      "groups": [],
      "price": null,
      "virtual_prices": [],
      "drm_name": "Origin",
      "drm_sku": "origin",
      "has_keys": false,
      "is_pre_order": true,
      "release_date": null,
      "quantity": 3
    }
    ]
}

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

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

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

1. Если в ответе 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

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

Кампания с бонусами

Чтобы настроить акционную кампанию с бонусом:

1. Откройте ваш проект в Личном кабинете.
2. Нажмите Магазин в боковом меню и перейдите в раздел Акции.
3. Нажмите Создать акцию.
4. Задайте необходимые параметры:
   1. Укажите название акции.
   2. Выберите тип Бонус.
5. Укажите акционные товары.
6. Укажите товар, который будет предоставляться пользователю при покупке акционного предмета.
7. Нажмите Далее.
8. Если вы хотите, чтобы акция распространялась только на определенных пользователей, переведите переключатель Акция для определенных пользователей в положение Вкл и укажите параметры условия.
9. Если вы хотите, чтобы пользователь мог купить товары по акции ограниченное количество раз, переведите переключатель Ограничивать использование акции пользователем в положение Вкл и укажите количество использований.
10. Нажмите Далее.
11. Укажите срок действия кампании.
12. Нажмите Далее.
13. Проверьте настройки и нажмите Сохранить и выйти.

14. Нажмите Магазин в боковом меню и перейдите в раздел Акции.
15. Выберите акцию, нажмите ••• и выберите Редактировать план.
16. Активируйте акцию.

Скидочная кампания

Настройка скидочной кампании через Личный кабинет

Чтобы настроить акцию со скидкой:

1. Откройте ваш проект в Личном кабинете.
2. Нажмите Магазин в боковом меню и перейдите в раздел Акции.
3. Нажмите Создать акцию.
4. Задайте необходимые параметры:
   1. Укажите название акции.
   2. Выберите тип Скидка.
5. Выберите один или несколько товаров, на которые будет распространяться скидка.
6. Укажите процент скидки.
7. Нажмите Далее.
8. Если вы хотите, чтобы акция распространялась только на определенных пользователей, переведите переключатель Акция для определенных пользователей в положение Вкл и укажите параметры условия.
9. Если вы хотите, чтобы пользователь мог купить товары по акции ограниченное количество раз, переведите переключатель Ограничивать использование акции пользователем в положение Вкл и укажите количество использований.
10. Нажмите Далее.
11. Укажите срок действия кампании.
12. Нажмите Далее.
13. Проверьте настройки и нажмите Сохранить и выйти.

14. Нажмите Магазин в боковом меню и перейдите в раздел Акции.
15. Выберите акцию, нажмите ••• и выберите Редактировать план.
16. Активируйте акцию.

Настройка скидочной кампании через методы API

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

Чтобы создать акцию через методы API:

1. Вызовите метод Create discount promotion for item с необходимыми параметрами.
2. Вызовите метод Update item promotion с параметром “is_enabled”:true, чтобы активировать акцию.

Чтобы отредактировать акцию через метод API, вызовите метод Update item promotion с новыми параметрами акции. Редактирование акции также доступно для акций со статусом Active.

При создании или редактировании скидочной акции через методы API вы также можете:

• Настроить действие скидки на все товары проекта. Передайте в метод Create discount promotion for item или Update item promotion параметр “items”:null.

• Настроить скидку на физические товары. Передайте в метод Create discount promotion for item или Update item promotion массив объектов с артикулами физических товаров.

• Настроить скидку с дробными процентами. Передайте в метод Create discount promotion for item или Update item promotion параметр discount.percent с дробной скидкой.

• Настроить скидку на товары разных категорий. Передайте в метод Create discount promotion for item или Update item promotion массив объектов с артикулами нужных товаров.

• Настроить скидку на отдельные DRM для игры. Передайте в метод Create discount promotion for item или Update item promotion массив объектов с артикулами нужных DRM.

• Настроить бессрочную акцию. Передайте в метод Create discount promotion for item или Update item promotion параметр “date_end”:null.