Campaigns

Overview

You can create campaigns where you distribute promotional codes that unlock items or other entitlements to your players. Codes can be redeemed in the Player Portal, Launcher, and in the game itself.

When you create a campaign, you can choose how many codes to create, how many times each code can be redeemed, and how many times each player can redeem a code. After the campaign has been launched, you can access the code redemption history in the Admin Portal.

Codes generated by 3rd party platforms such as Steam can also be listed for sale in your catalog.

Tutorials

Create a Campaign

You can create a Campaign in Admin Portal or use our Swagger. But, before creating a campaign, make sure you are authorized and have registered your clients.

Create a Campaign Using API

  1. Use the Create Campaign: POST /admin/namespaces/{namespace}/campaigns endpoint.

  2. Input the Publisher Namespace.

  3. Fill out the Request Body.

    • Input the campaign Type. The available campaign type is Redemption.
    • Input the campaign Name. For example, if you want to create a free coin campaign, you can input Free Coin May. This name will be visible to Players in Player Portal and Launcher to show that in May there will be a free coin campaign.
    • Input the Description of the campaign.
    • Input the Tags of the campaign with contextual information about the campaign.
    • Select the Status of the campaign. Choose Active to make the campaign active so players can participate in the campaign and Inactive to deactivate the campaign.
    • Input how many times each code can be redeemed in the maxRedeemCountPerCode field.
    • Input how many times each player can redeem a code in the maxRedeemCountPerCodePerUser field.
    • Input how many times each player will be able to redeem a code in the maxRedeemCountPerCampaignPerUser field.
    • Input the maxSaleCount.
    • Input the Redemption Type you want to create in the campaign. The available redemption type is Item.

    Fill in the information about the Items below.

    • Input the Item ID.
    • Input the Item Name.
    • Input the Quantity of the items you want to set in the campaign.
  4. On a successful request, you will be able to create a campaign.

Create a Campaign in Admin Portal

  1. In the Admin Portal, choose Publisher Namespace.

    campaign-management

  2. Go to the E-Commerce section and open the Campaigns menu.

    campaign-management

  3. In the Campaigns menu, click the Add Campaign button to create a new campaign.

    campaign-management

  4. The Add Campaign form will appear. Here, fill all the fields with the following information as reference.

    campaign-management

    • Input the Campaign Name.
    • Select the Status of your campaign.
    • Input the number of redemption for each code in the Max redeems per code field.
    • Input the number of redemptions for each Player in the Max redeems per user.
    • Choose the Redeem Type. The available Redemption type is Item.
  5. Once the campaign is added, the next thing you have to do is to add items that will be redeemed by the player.

Add an Item to a Campaign

Add an Item to a Campaign Using API

  1. Use the Update Campaign: PUT /admin/namespaces/{namespace}/campaigns/{campaignId} endpoint.
  2. Input the Namespace with the Publisher Namespace.
  3. Input the Campaign ID. The campaign ID is automatically created when you create a campaign.
  4. Fill out the Item section in the Request Body.
    • Input the Item ID.
    • Input the Item Name.
    • Input the Quantity of the Item.
  5. On a successful response, you will be able to add Item to a Campaign.

Add Item to a Campaign in Admin Portal

  1. Select the Campaign you want to add items from the campaign page.

    campaign-management

  2. In the Campaign Details page, Go to the Items section and click the Add button to add Item.

    campaign-management

  3. Choose the Item you want to add from the dropdown list and click Add.

    campaign-management

  4. Once added, the item will appear in the item list.

    campaign-management

Create a Code

Create a Code Using API

  1. Use the Create Campaign Codes: POST /admin/namespaces/{namespace}/codes/campaigns/{campaignId} endpoint.
  2. Input the Namespace with the Publisher Namespace.
  3. Input the Campaign ID. The campaign ID is automatically created when you create a campaign.
  4. Fill out the Request Body.
    • Input the Quantity of the code, define how many code you want to generate in a Campaign.
  5. On a successful request, you will be able to create a code.

Create a Code in Admin Portal

  1. In your campaign, go to the Codes section and click the Add Code button to add code to your campaign.

    campaign-management

  2. Input the Quantity of the code and click Add to add the amount of code.

    campaign-management

  3. Once your code is added, you can choose the Status of the code. If Enable is selected, the code can be redeemed by players, if it is Disable, the code will not be available for redeem. For example, if you are going to start the campaign, you need to Enable the status and when the campaign is over, you can Disable the code.

    campaign-management

Download Codes

Download Codes Using API

  1. Use the Download Codes: GET /admin/namespaces/{namespace}/codes/campaigns/{campaignId}/codes.csv endpoint.
  2. Input the Namespace.
  3. Input the Campaign ID.
  4. Input the Batch of the Campaign in the batchNo field. This field is optional.
  5. On a successful request, you will be able to download the code.

Download Codes in Admin Portal

  1. In the Campaign sidebar menu, go to the Codes section and click Download Codes. Then, the download process will start immediately.

    campaign-management

  2. After the download is complete, you can open the file and see the code list you have created. Here, the file will be in .csv format.

    campaign-management

Get Redeemed Code History

Get Redeemed Code History Using API

  1. Use the Query Redeem History: GET /admin/namespaces/{namespace}/codes/campaigns/{campaignId}/history endpoint.
  2. Input the Namespace with the Publisher Namespace.
  3. Input the Campaign ID, e.g. 63a635938ffc4560b5b23731150414a6.

These following fields are optional.

  1. Input the User ID if you want to get a list of Redeemed Code History of a specific Player.
  2. Input the Code if you want to get a record of Code Redeemed by Players.

You can fill it in if you want to display pagination.

  1. Input the Offset if you want to skip numbers of data before showing the records.
  2. Input the Limit of the displayed data.
  3. After a successful request, you can see the redeemed history.

Get Redeemed Code History in Admin Portal

  1. In the Campaign sidebar menu, go to the Redeem History section. Here, you can see a list of the Redeem History with the Code, Player ID, and the Redeemed Time.

    campaign-management

What’s Next?