Create and manage code redemption campaigns

Last updated on October 23, 2024

Overview

This article walks you through how to:

• View code redemption campaigns
• Activate or deactivate code redemption campaigns
• Create a code redemption campaign
  • Create an item code redemption campaign
  • Create a discount code redemption campaign
• Add items to a code redemption campaign
• Add subscription plans to an item redemption campaign
• Create and manage codes in a code redemption campaign
• Download codes from a code redemption campaign
• View code redemption history

Prerequisites

• Admin access to the AccelByte Gaming Services (AGS) Admin Portal.
• A published store in your namespace with active items or other entitlements and active subscription plans (if you want to add subscription plans). To learn more about setting up a store in your game namespace, see Manage stores and store items.

View code redemption campaigns

1. In the Admin Portal, go to your game namespace.
2. On the sidebar, go to Commerce > Redemptions > Code Redemptions.
3. On the Code Redemptions page, find the campaign you want to activate or deactivate, then click on its corresponding View button. The details page of the campaign appears. On this page, you can view the configuration details, codes, and redemption history of the campaign.

Activate or deactivate code redemption campaigns

1. In the Admin Portal, go to your game namespace.
2. On the sidebar, go to Commerce > Redemptions > Code Redemptions.
3. On the Code Redemptions page, find the campaign you want to activate or deactivate, then click on its corresponding View button.
4. On the details page of the campaign, click on the Activate or Deactivate button. The campaign is immediately activated or deactivated.

Create code redemption campaigns

This section covers how to create an item code redemption campaign and a discount code redemption campaign.

Create an item code redemption campaign

1. In the Admin Portal, go to your game namespace.
2. On the sidebar, go to Commerce > Redemptions > Code Redemptions.
3. On the Code Redemptions page, click on the + Create Redemption Code. On the Create Code Redemption form appears.
4. Fill in the required information on the form.
   • Basic Information
     • Code Redemption Name: type in a name for the campaign.
     • Start Time and End Time: set the start and end date and time for the campaign.
     • Redemption Type: set to Item.
     • (Optional) Description: provide a brief description of the campaign.
   • Redemption Rules
     • Redemption Limit per Code: specify the maximum number of times a single code in this campaign can be redeemed, or set this to unlimited by ticking the Set as Unlimited checkbox. For instance, a limit of 1 ensures that each code can only be redeemed once.
     • Redemption Limit per Account: specify the maximum number of times a single code in this campaign can be redeemed by a single player, or set this to unlimited by ticking the Set as Unlimited checkbox. For example, a limit of 1 ensures that a single code can only be redeemed once by a single player.
     • Multiple Code Redemption Limit per Account: specify the maximum number of codes a single player can redeem in the campaign, or set this to unlimited by ticking the Set as Unlimited checkbox. For example, a limit of 3 ensures that a player can only redeem up to three different codes in the campaign, after which they will be ineligible for further redemptions.
5. Click Create. By default, code redemption campaigns are active upon creation.
6. Add items to the campaign. See Add items to a code redemption campaign. For item code redemption campaigns, you also have the option to add subscription plans on top of (as add-on benefits) or instead of items in the campaign. See Add subscription plans to an item code redemption campaign. See Add subscription plans to an item redemption campaign.
7. Create or generate codes for the campaign.

Create a discount code redemption campaign

1. In the Admin Portal, go to your game namespace.
2. On the sidebar, go to Commerce > Redemptions > Code Redemptions.
3. On the Code Redemptions page, click on the + Create Redemption Code. On the Create Code Redemption form appears.
4. Fill in the required information on the form.
   • Basic Information
     • Code Redemption Name: type in a name for the campaign.
     • Start Time and End Time: set the start and end date and time for the campaign.
     • Redemption Type: set to Discount.
     • (Optional) Description: provide a brief description of the campaign.
   • Redemption Rules
     • Redemption Limit per Code: specify the maximum number of times a single code in this campaign can be redeemed, or set this to unlimited by ticking the Set as Unlimited checkbox. For instance, a limit of 1 ensures that each code can only be redeemed once.
     • Redemption Limit per Account: specify the maximum number of times a single code in this campaign can be redeemed by a single player, or set this to unlimited by ticking the Set as Unlimited checkbox. For example, a limit of 1 ensures that a single code can only be redeemed once by a single player.
     • Multiple Code Redemption Limit per Account: specify the maximum number of codes a single player can redeem in the campaign, or set this to unlimited by ticking the Set as Unlimited checkbox. For example, a limit of 3 ensures that a player can only redeem up to three different codes in the campaign, after which they will be ineligible for further redemptions.
   • Discount Configuration
     • Currency Namespace: this cannot be edited.
     • Currency: from the dropdown, select the currency that will be used for the campaign.
     • Discount Type: set to Percentage to use a percentage discount or to Amount to use a fixed discount amount.
     • Discount Amount: type in the discount amount based on what you selected for Discount Type.
     • Discount Application: set to All Items or to Specific Items.
     • Stackable Discounts: turn on this toggle if you want the discount code to be applied with other stackable discount codes at the same time.
5. Click Create. By default, code redemptions are active upon creation.
6. Add items to the campaign. See Add items to a code redemption campaign.
7. Create or generate codes for the campaign.

Add items to a code redemption campaign

You can add items to a newly created or to an existing and ongoing item or discount code redemption campaign.

important

Only add active items to the campaign. If inactive items are added to the campaign, the codes in the campaign will not work and cannot be redeemed by players.

To add items to an item or discount code redemption campaign, follow these steps:

1. In the Admin Portal, go to your game namespace.

2. On the sidebar, go to Commerce > Redemptions > Code Redemptions.

3. On the Code Redemptions page, find the code redemption campaign you want to update and click on its View button. The campaign's details page appears.

4. On the details page, open the Details tab and scroll down to the Items section.

5. Click on + Add Item. The Add items window appears.

6. Search and select the active items that you want to add to the campaign.

   注記

   The items that you can add to a campaign are from your game's active or published store, which is managed through the AGS Store service. To learn more about creating subscription packages, see Create store items.

7. After selecting the items you want to add, click on Add. The items are automatically added to the campaign. If the campaign is active and ongoing, the items are also immediately available for redemption in the campaign.

8. You also have the option to add subscription plans on top of (as add-on benefits) or instead of items in the campaign. See Add subscription plans to an item code redemption campaign.

9. Create or generate codes for the campaign.

Add and manage subscription plans in an item code redemption campaign

You also have the option to add subscription plans on top of (as add-on benefits) or instead of items in an item code redemption campaign.

Add a subscription plan

1. In the Admin Portal, go to your game namespace.

2. On the sidebar, go to Commerce > Redemptions > Code Redemptions.

3. On the Code Redemptions page, find the item code redemption campaign you want to update and click on its View button. The campaign's details page appears.

4. On the campaign's details page, open the Details tab and scroll down to the Subscription Time section.

5. Click on + Add Subscription. The Add Subscription form appears.

6. In the Subscription field, search for the subscription type that you want to add to the campaign.

   注記

   The subscription plans that you can add to a campaign are from your game's active or published store, which is managed through the AGS Store service. To learn more about creating subscription plans, see Create store items.

7. In the Duration field, specify the number of days the subscription will be granted to players. The maximum limit for this option is 2,147,483,647 days.

8. Click Add to add the subscription plan to the campaign. The subscription plan is immediately active and available in the campaign. If the campaign is active and ongoing, the subscription plans you added are also immediately available for redemption in the campaign.

Remove subscription plans

1. In the Admin Portal, go to your game namespace.
2. On the sidebar, go to Commerce > Redemptions > Code Redemptions.
3. On the Code Redemptions page, find the item code redemption campaign you want to update and click on its View button. The campaign's details page appears.
4. On the details page, go to the Details tab and scroll down to the Subscription Time section.
5. Click on the Remove option of the subscription plan that you want to remove from the campaign and click on Confirm on the pop-up that appears. The subscription plan is immediately removed from the campaign.

Create and manage codes in a code redemption campaign

This section covers how to manage codes in a code redemption campaign.

View codes

1. In the Admin Portal, go to your game namespace.
2. On the sidebar, go to Commerce > Redemptions > Code Redemptions.
3. On the Code Redemptions page, click on the View button of the campaign with the codes you want to view. The campaign's details page appears.
4. On the details page, open the Codes tab. The Codes page appears, showing a table of active and deactivated codes in the campaign. You can search for specific codes in the table.

Create or generate codes

1. In the Admin Portal, go to your game namespace.

2. On the sidebar, go to Commerce > Redemptions > Code Redemptions.

3. On the Code Redemptions page, click on the View button of the campaign you want to create codes for. The campaign's details page appears.

4. On the campaign's details page, open the Codes tab. The Codes page appears.

5. Click on the Generate Codes button. The Generate Codes form appears.

6. On the form, do one of the following:

   • Select Random-Generated Code to generate random codes. With this option, you can specify the number of random codes you want to generate for the campaign in in the Code Amount field. You can generate up to 999 codes at once.
   • Select Custom Code to manually create a code for the campaign. Then, in the Code Name field, type in your custom code.
   important

   Custom codes cannot be edited or deleted after creation.

7. Click Generate. The codes you generated or manually created are added and activated in the campaign. At any time, you can repeat these steps to create or generate more codes for the campaign.

Activate or deactivate codes

1. In the Admin Portal, go to your game namespace.
2. On the sidebar, go to Commerce > Redemptions > Code Redemptions.
3. On the Code Redemptions page, click on the View button of the campaign you want to create codes for. The campaign's details page appears.
4. On the campaign's details page, open the Codes tab. The Codes page appears, showing a list of the active and inactive codes in the campaign.
5. From the list, find the code that you want to activate or deactivate and click on its Activate or Deactivate option. Then, click on Confirm on the pop-up window that appears. The code is immediately activated or deactivated in the campaign.

Download campaign codes

1. In the Admin Portal, go to your game namespace.
2. On the sidebar, go to Commerce > Redemptions > Code Redemptions.
3. On the Code Redemptions page, click on the View button of the campaign you want to create codes for. The campaign's details page appears.
4. On the campaign's details page, open the Codes page. The Codes page appears, showing a list of the active and inactive codes in the campaign.
5. To download all the codes in the campaign, click on the Download Code button at the top of the list. A CSV file containing all the codes in the campaign is downloaded.

View code redemption history

1. In the Admin Portal, go to your game namespace.
2. On the sidebar, go to Commerce > Redemptions > Code Redemptions.
3. On the Code Redemptions page, click on the View button of the campaign with the redemption history you want to view. The campaign's details page appears.
4. On the campaign's details page, open the Redeem History tab. The Redeem History page appears, showing a list of codes that have been redeemed in the campaign.
5. On the page, you can search the redemption history by user ID or by code ID.