Bonuses
How it works
Overview
Bonus campaigns are a marketing tool that allows you to increase sales through bonuses awarded to users along with their purchase. You can run campaigns on significant dates, such as your project anniversary, or offer bonuses only to players of a certain level. Bonus items are granted to users in the same way as when purchasing items.
The following items can be used as bonuses:
- virtual currency packages
- game keys
- virtual items
- bundles
Key features:
- A user can get an unlimited number of bonuses when purchasing an item.
- One item can be granted as a bonus in an unlimited number of bonus campaigns.
- You can set up limits on the number of times a bonus is available to a user.
- You can set up personalized bonus promotions.
User flow
The user flow when purchasing an item on the site created with Xsolla site builder:
- The user goes to the store.
- The user chooses an item with the Bonus label.
- In the item card, the user sees bonus items.
- The user adds items to the cart or proceeds to purchase a selected item directly.
- The user completes the payment.
- The items are granted to the user.
Limits logic
If there is a limit set on purchasing a bonus item, and the user has received all available items within that limit, the promotional item won’t be available for purchase.
If a bonus promotion has a usage limit, and the remaining number of promotions available to the user is zero, the promotional item will be displayed in the catalog without the bonus item.
Depending on the limits that are set, there are different scenarios for purchasing promotional items with bonuses. For example, when there are limits on purchasing bonus items, the logic will be the following:
- The Booster item has a purchase limit — no more than 2 times per user.
- Booster is a bonus item for Empire Lootbox.
- A user bought Booster 1 time and also bought Empire Lootbox 1 time, receiving Booster as a bonus. When they try to buy Empire Lootbox again, the response to the order creation call will indicate that the user has exceeded the purchase limit for the Booster item. As a result, the user won’t be able to receive Booster in any way.
Other examples
Example of limits on using bonus promotions:- The bonus promotion has a usage limit — no more than 1 time per user.
- Booster is a bonus item for Empire Lootbox.
- A user bought Empire Lootbox 1 time and received Booster as a bonus.
- When they try to buy Empire Lootbox again, the bonus item Booster won’t be displayed to the user.
- The Booster item has a purchase limit — no more than 1 time per user.
- Booster is a bonus item for Empire Lootbox.
- The bonus promotion has a usage limit — no more than 2 times per user.
- A user bought Empire Lootbox 1 time and received Booster as a bonus.
- When they try to buy Empire Lootbox again, the response to the order creation call will indicate that the user has exceeded the purchase limit for the Booster item. As a result, the user won’t be able to receive Booster in any way.
Set up campaign with bonuses
To create a promotion with bonus items, you need to first configure these items and then proceed to the promotion setup.
To create items manually in your project in Publisher Account, go to Items catalog > All items. Detailed information about this and other methods for creating items is available in the Items catalog documentation section.
Configure in Publisher Account
To create a new campaign with bonuses:
- In your project in Publisher Account, go to the LiveOps > Promotions section.
- On the Promotions tab, click Create promotion.
- Specify the main promotion parameters:
- Specify Promotion name.
- In the Promotion type drop-down list, select Bonus.
- Configure promotional items:
- In the Promotional items drop-down list, select an item type for the purchase of which users will get bonus items.
An item type is available for selection only if at least one item of that type has been created in your project.
This also applies to bonus items.
- Select the items.
You can select different types of items. To switch between different item types, use the Promotional items field. Information about all selected items is displayed in the List of promotional items area.
To configure different bonus item types, use the Bonus items field.
- Configure bonus items:
- In the Bonus items drop-down list, select an item type that users will get when purchasing promotional items.
- Select the items.
- Click Next.
- Configure discount limits:
- To limit the promotion to a user’s first purchase only, turn on the Trigger promotion only for first-time buyers toggle. When this setting is enabled, you can’t configure other limits.
- To limit the number of times a single user can get a bonus, turn on the Limit number of times one user can use promotion toggle and specify the necessary value.
- To apply the promotion to users whose attributes match specified conditions, turn on the Trigger promotion only for specific users toggle and define the attribute validation conditions.
- Click Next.
- Specify the campaign’s validity period: a time zone, start date, and end date. To create a campaign without an end date, check the No end date box.
- Click Next.
- Review the promotion settings and click Save and exit.
To make the promotion available to users, you must activate it. To do this:
- In your project in Publisher Account, go to the LiveOps > Promotions section.
- In the row with a promotion, click ••• and choose Edit promotion in the drop-down list.
- In the drop-down list in the upper-right corner, select Activate promotion.
Configure via API
- the required parameters
- the parameters you want to change
- all other parameters returned by the promotion retrieval call
To set up and manage bonus campaigns via API, use the following calls:
| Task | API call |
|---|---|
| Create a promotion. | Create bonus promotion. To apply the promotion to all items in your project, pass “condition”: null. |
| Activate a promotion. | Pass the “is_enabled”: true parameter in the Update bonus promotion call or use the Activate promotion call. |
| Update a promotion. | Update bonus promotion. To apply the changes to all items in your project, pass “condition”: null. |
| Deactivate a promotion. | Deactivate promotion. |
| Set up an indefinite promotion. | Create bonus promotion or Update bonus promotion. Pass the “date_end”:null parameter to the listed calls. |
| Delete a promotion. | Delete bonus promotion. |
Display bonus items in store
If you sell items through your own interface, you can retrieve item information by calling client API methods to get an item catalog (calls from the Common > Catalog, Virtual Items and Currency > Catalog, and Bundles > Catalog subsections).
If your site is created using Xsolla site builder, a timer appears on an item’s card 30 days before the end of the promotion to show the remaining time:
- If the end of the promotion is in more than a week, the timer shows days and hours.
- If the end of the promotion is in more than one day, the timer shows hours and minutes.
- If the end of the promotion is in less than a day, the timer shows minutes and seconds.
To change the color of the timer and Bonus label:
- In your project in Publisher Account, go to the Storefronts > Websites section.
- Select your site and click Open Site Builder.
- In the side menu, go to the Theme section.
- Select a new color in the Secondary field.
- To apply changes, publish the website:
- In the upper-right corner of the site builder, click Publish.
- Check the boxes next to the pages you want to publish.
- Click Publish.
If site publication is not available, make sure all the conditions are met:
- There are no empty sections in the builder (marked with a red indicator).
- The licensing agreement with Xsolla has been signed.
- The main page is published or selected for publication. You can’t publish child pages before the main page.
Found a typo or other text error? Select the text and press Ctrl+Enter.