AdReward

Important

The max amount is per offer.

PropertyTypeDescription
purchaseRequirementPurchaseRequirementPurchase requirement information associated with a redemption
rewardAmountfloatEither a fixed amount or a percentage, depending on rewardType
maxRewardAmountfloatMaximum allowable redemption amount
rewardTypeRewardTypeThe type of reward yielded by a redemption
isMultiRedemptionbooleanIndicates whether a multiple number of redemptions is allowed for this offer
maxNumRedemptionsint1 when isMultiRedemption=false,
null or omitted when isMultiRedemption=true
isMultiTierbooleanIndicates whether the reward is tiered
activationModelActivationModelActivation requirements for the CLO offer. Default value is "ACTIVATABLE". For auto-activated, the value is "AUTO_ACTIVATED".
publisherAnnonationsPublisherAnnonationsA set of indicators that shows different types of offers based on billing and user segments.

PERCENT_AMOUNT_PURCHASE Ad Reward example

The following example depicts a 5% cash back in-store offer.

        "rewardType": "FIXED_AMOUNT_PURCHASE",
        "rewardAmount": 10.0,
        "maxRewardAmount": 10.0,
        "isMultiRedemption": false,
        "maxNumRedemptions": 1,
        "isMultiTier": false,
        "purchaseRequirement": {
          "minSpendAmount": 100.0,
          "purchaseChannels": [
            "Online"
          ],
          "merchantUrlLinkClickRequired": false
        },
        "activationModel": "ACTIVATABLE",
        "publisherAnnotations": ["WELCOME_BASKET", "PUBLISHER_FUNDED"]

FIXED_AMOUNT_PURCHASE Ad Reward example

The following example depicts a fixed $10 cash back online offer, which is also auto-activated

        "rewardType": "FIXED_AMOUNT_PURCHASE",
        "rewardAmount": 50.0,
        "maxRewardAmount": 50.0,
        "isMultiRedemption": false,
        "maxNumRedemptions": 1,
        "isMultiTier": false,
        "purchaseRequirement": {
          "minSpendAmount": 75.0,
          "purchaseChannels": [
            "Online",
            "InStore"
          ],
          "purchaseTypes": [
            "Subscription"
          ],
          "merchantUrlLinkClickRequired": false
        },
        "activationModel": "ACTIVATABLE",
        "publisherAnnotations": ["PUBLISHER_FUNDED"]