Welcome to Monetizr Documentation!

Here you will find a comprehensive technical guide
to help you get started with Monetizr SDKs, Plugins,
API reference guide and Console.

Get Started    API Reference

Brand rewards and sponsored offers

Brand rewards and sponsored offers are claimable or free offers.

Monetizr will find the right brand that will suit the game's audience (You will need to contact us to get started with Brand sponsored rewards). The brand will provide an inventory of rewards, which then will be used as a reward that players can claim within the game's UI for free. Monetizr will set up the automation of the fulfillment of rewards.

Sponsored offers does not differ from brand rewards with functionality, the main difference is that game publisher can choose to reward his whale players and pre-purchase specific rewards from Monetizr console.

The only difference between sponsored offers and brand rewards is who receives the bill for rewards.
You can find information about converting offer to claimable at Offer claiming section.

To create claiming for sponsored offers or brand rewards you can use either:

  • Double validation : includes the validation process between Monetizr servers and game studio servers. This approach is for those who choose to create offers with multiple variants that require players input with selecting available options (example, a t-shirt reward would require size, color, gender specified upon claiming)
  • Simple claim : a quicker solution includes a claim with a single method, would still require webhook for validation (example, hand-written note or postcard).

The following steps are required to create brand rewards or sponsored offers:

  • Create and account
  • Contact us, so that Monetizr can prepare Brand rewards or sponsored offers for you. Once it will be done, offers will be available in Offer Manager ]. Or you can choose from catalog, convert offer to claimable and add required webhook for validation.
  • Follow claimable integration guides and use appropriate method for claiming. Double validation and Simple claiming are available for Brand rewards
  • For testing purposes Monetizr provides pre-prepared offers available for simple claiming process.

Adding brand rewards assets

Occasionally game developer has to add additional data for a reward. An example is a brand sponsored rewards representation image (token image) and notification text. In Monetizr infrastructure we reference the dataset as assets. You can see how those assets can be applied in game in the next two images.

Representation image example

Notification text example usage in game

To add those asset details, you will need to authorize in console, select an Offer and navigate to Assets tab. There you can add notification text as well as provide rewards token image. The token image can be anything of your choice, we do not limit token image size and dimensions. Just keep in mind, if you do need a small avatar image then you should not upload a large multi megabyte asset as that will slow down your request.

Offers assets in console

The rewards data then can be acquired through API Offers list endpoint or through Offers details endpoint. The data returned from API call will contain notification text and token image under asset property.

{
    "count": 11,
    "next": null,
    "previous": null,
    "results": [
        {
            "id": 973,
            "name": "Boost Day 5 retention by rewarding players with a free McFlurry by McDonald's",
            "offer_tag": "copy_394180C9_free_mccafe",
            "is_active": true,
            "claimable": true,
            "offer_thumbnail": "",
            "description": "\nYour progress will be updated within seconds of playing a game match. When you finish 5 game matches, you will be able to claim a free beverage from McDonald's.\n\n \n- Digital voucher.\n- Ready to use immediately.\n- Offer valid at participating McDonald's restaurants.",
            "description_html": "<meta charset=\"utf-8\">\n<p>Your progress will be updated within seconds of playing a game match. When you finish 5 game matches, you will be able to claim a free beverage from McDonald's.</p>\n<p><br><br></p>\n<p> </p>\n<p>- Digital voucher.</p>\n<p>- Ready to use immediately.</p>\n<p>- Offer valid at participating McDonald's restaurants.</p>",
            "category": "Brand rewards",
            "type": "Giveaway",
            "retail_value": null,
            "asset": {
                "title": "Congrats!",
                "asset_image": "https://image.themonetizr.com/offer_asset/2021/01/11/McFlurry.png"
            },
            "prices": [
                {
                    "amount": "0.00",
                    "currency_code": "USD",
                    "compare_amount": "0.00",
                    "compare_currency_code": ""
                }
            ]
        },.....
      ]
}
{
    "data": {
        "productByHandle": {
            "id": "Z2lkOi8vc2hvcGlmeS9Qcm9kdWN0LzYxNDYxNjE0MTAyNDQ=",
            "title": "Copy of Free McCafe by McDonald's",
            "description": "Your progress will be updated within seconds of playing a game match. When you finish 5 game matches, you will be able to claim a free beverage from McDonald's. - Digital voucher. - Ready to use immediately. - Offer valid at participating McDonald's restaurants.",
            "descriptionHtml": "<meta charset=\"utf-8\">\n<p>Your progress will be updated within seconds of playing a game match. When you finish 5 game matches, you will be able to claim a free beverage from McDonald's.</p>\n<p><br><br></p>\n<p> </p>\n<p>- Digital voucher.</p>\n<p>- Ready to use immediately.</p>\n<p>- Offer valid at participating McDonald's restaurants.</p>",
            "availableForSale": true,
            "onlineStoreUrl": "https://gear.themonetizr.com/products/copy-of-free-mccafe-by-mcdonalds-6",
            "options": [
                {
                    "name": "Title",
                    "values": [
                        "Default Title"
                    ]
                }
            ],
            "images": {
                "edges": [
                    {
                        "node": {
                            "transformedSrc": "https://cdn.shopify.com/s/files/1/0330/7788/7116/products/McFlurry-GIF_41642511-366f-4284-beae-f15220d947bb_350x350.gif?v=1610369472"
                        }
                    },
                ]
            },
            "variants": {
                "edges": [
                    {
                        "node": {
                            "id": "Z2lkOi8vc2hvcGlmeS9Qcm9kdWN0VmFyaWFudC8zNzg2MTE1MTUwNjYyOA==",
                            "product": {
                                "title": "Copy of Free McCafe by McDonald's",
                                "description": "Your progress will be updated within seconds of playing a game match. When you finish 5 game matches, you will be able to claim a free beverage from McDonald's. - Digital voucher. - Ready to use immediately. - Offer valid at participating McDonald's restaurants.",
                                "descriptionHtml": "<meta charset=\"utf-8\">\n<p>Your progress will be updated within seconds of playing a game match. When you finish 5 game matches, you will be able to claim a free beverage from McDonald's.</p>\n<p><br><br></p>\n<p> </p>\n<p>- Digital voucher.</p>\n<p>- Ready to use immediately.</p>\n<p>- Offer valid at participating McDonald's restaurants.</p>",
                                "description_ios": "\nYour progress will be updated within seconds of playing a game match. When you finish 5 game matches, you will be able to claim a free beverage from McDonald's.\n\n \n- Digital voucher.\n- Ready to use immediately.\n- Offer valid at participating McDonald's restaurants."
                            },
                            "title": "Default Title",
                            "selectedOptions": [
                                {
                                    "name": "Title",
                                    "value": "Default Title"
                                }
                            ],
                            "priceV2": {
                                "currencyCode": "$",
                                "amount": "0.0",
                                "currency": "USD"
                            },
                            "compareAtPriceV2": null,
                            "image": {
                                "transformedSrc": "https://cdn.shopify.com/s/files/1/0330/7788/7116/products/McFlurry-GIF_41642511-366f-4284-beae-f15220d947bb_350x350.gif?v=1610369472"
                            }
                        }
                    }
                ]
            },
            "description_ios": "\nYour progress will be updated within seconds of playing a game match. When you finish 5 game matches, you will be able to claim a free beverage from McDonald's.\n\n \n- Digital voucher.\n- Ready to use immediately.\n- Offer valid at participating McDonald's restaurants.",
            "button_title": "Checkout",
            "claimable": false,
            "retail_value": null,
            "asset": {
                "title": "Congrats!",
                "asset_image": "https://image.themonetizr.com/offer_asset/2021/01/11/McFlurry.png"
            }
        }
    }
}

How to add brand reward to a condition in game?

Monetizr provides rewarding system and fulfillment platform and we cannot change gameplay and game design. The implementation choices are entirely defined by game designers. As an example implementation we can provide a video shown below.

Updated 7 days ago


Brand rewards and sponsored offers


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.