User Level Promos

Overview

The User-level Promotions feature allows you to create targeted promotions for specific users or user segments, rather than applying a single promotion to everyone. This can be used to boost engagement for select cohorts, reward loyal users, or run A/B tests on promotional strategies.

The existing promotion system applies a uniform multiplier to all users over a set period. While effective for broad marketing campaigns like Halloween sales, it lacks personalization, such as offering unique promotions for birthdays. The key advantage of a more tailored approach is the ability to run multiple, distinct promotions simultaneously at the user level.

How It Works

The process involves two main steps:

1. Create a Promotion in the Monetize Dashboard: Define the promotion's parameters in the Monetize Dashboard. This will include promotion multipliers and a unique identifier.

2. Activate the Promotion via the SDK: Pass the unique identifier in the SDK to activate the specific promotion for the end-user.

If a general (app-wide) promotion and a user-level promotion are both active for a user, the user-level promotion takes priority.

1. Creating a User-Level Promotion

In the Monetize Dashboard, two new fields need to be configured when creating the promotion

1. Promotion Tag: A unique url-friendly string to identify specific promotion (e.g., BOOST20, special-offer-august). This tag is how the promotion is activated from the SDK. Allowed characters: a-z, A-Z, 0-9, -,_

• Install limit: a number that specifies how many times a user can trigger this promotion by installing a promoted game.

2. SDK Implementation

To activate a promotion for a user, the promotion_tag created in the dashboard is passed to the PlaytimeParams builder. This tells our system to apply the corresponding promotion to this user's session.

Android

            val playtimeParams = PlaytimeParams.Builder()
                .setUaNetwork("tiktok")
                .setUaChannel("video")
                .setUaSubPublisherCleartext("Example: Game 2")
                .setUaSubPublisherEncrypted("8bb1e7911818be32449f6726ff7ecd102ba1862b")
                .setPlacement("Main Screen")
                .setPromotionTag("test-promotion")
                .build()

iOS

        let params = PlaytimeParamsBuilder()
                .setUANetwork("uaNetwork")
                .setUAChannel("uaChannel")
                .setUASubPublisherCleartext("uaSubPublisherCleartext")
                .setUASubPublisherEncrypted("uaSubPublisherEncrypted")
                .setPlacement("placement")
                .setPromotionTag("test-promotion")
                .build()

3. Postback & Reporting Changes

To help track the performance of these promotions, the promotion_tag can be added to the S2S postback using the field promotion_tag .

4. Promotions API

Use the promotions API to get information about the promotions available for your application.

get

Returns all promotions.

Responses

200

OK

application/json

500

Internal Server Error

get

/v1/ssp-api/promotions

HTTPcURLJavaScriptPython

GET /v1/ssp-api/promotions HTTP/1.1
Accept: */*

{
  "Pagination": {
    "Limit": 1,
    "Offset": 1,
    "Total": 1
  },
  "Promotions": [
    {
      "Active": true,
      "AppCategory": "text",
      "EndsAt": "text",
      "ImageUrl": "text",
      "InstallLimit": 1,
      "IntervalDays": 1,
      "Multiplier": 1,
      "Name": "text",
      "PromotionTag": "text",
      "SDKs": [
        {
          "AppID": "text",
          "AppName": "text",
          "SDKHash": "text"
        }
      ],
      "StartsAt": "text",
      "TextTranslations": [
        {
          "ButtonCaption": "text",
          "Description": "text",
          "Language": "text",
          "Title": "text"
        }
      ],
      "Type": "",
      "UUID": "text"
    }
  ]
}

get

Returns individual promotion by promotion uuid.

Responses

200

OK

application/json

500

Internal Server Error

get

/v1/ssp-api/promotions/:promotion_uuid

HTTPcURLJavaScriptPython

GET /v1/ssp-api/promotions/:promotion_uuid HTTP/1.1
Accept: */*

{
  "Pagination": {
    "Limit": 1,
    "Offset": 1,
    "Total": 1
  },
  "Promotions": [
    {
      "Active": true,
      "AppCategory": "text",
      "EndsAt": "text",
      "ImageUrl": "text",
      "InstallLimit": 1,
      "IntervalDays": 1,
      "Multiplier": 1,
      "Name": "text",
      "PromotionTag": "text",
      "SDKs": [
        {
          "AppID": "text",
          "AppName": "text",
          "SDKHash": "text"
        }
      ],
      "StartsAt": "text",
      "TextTranslations": [
        {
          "ButtonCaption": "text",
          "Description": "text",
          "Language": "text",
          "Title": "text"
        }
      ],
      "Type": "",
      "UUID": "text"
    }
  ]
}