Ad

Property Type Description
adType AdType The ad type
adServeToken string A unique token associated with the ad's serve event
startDate string Campaign start date
endDate string Campaign end date
activationDate string Activation date of the ad
merchantName string Merchant name for the ad
reward AdReward Object which models the ad's reward potential
activationState AdActivationState Activation state of the ad, relative to the customer
visibilityState AdVisibilityState Indicates whether the ad is visible to the customer
redemptionState AdRedemptionState Redemption state of the ad, relative to the customer
assets AdAssetList ad asset
isAffiliateMarketing boolean if the ad (a CLO or not CLO ad) is associated with an affiliate program

Example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
{
    "adId": "111111",
    "adType": "CASH_BACK_OFFER",
    "adServeToken": "encodedData",
    "activationDate": "2023-01-01T08:00:00Z",
    "merchantName": "Joe's",
    "isAffiliateMarketing": true,
    "reward": {
        "rewardType": "PERCENT_AMOUNT_PURCHASE",
        "rewardAmount": 5.0,
        "maxRewardAmount": 25.0,
        "isMultiRedemption": true,
        "purchaseRequirement": {
            "minSpendAmount": 1.0,
            "purchaseChannels": ["InStore"],
            "merchantUrlLinkClickRequired": true
        },
        "activationModel": "AUTO_ACTIVATED"
    },
    "activationState": "ACTIVATED",
    "visibilityState": "VISIBLE",
    "redemptionState": "PROCESSING",
    "assets": {
        "logo": {
            "type": "IMAGE_URL",
            "value": {
                "large": {
                    "url": "https://www.example.com/creative1.jpg",
                    "width": 100,
                    "height": 100
                },
                "mobile": {
                    "url": "https://www.example.com/creative1.jpg",
                    "width": 500,
                    "height": 500
                }
            }
        },
        "annotatedLogo": {
            "type": "IMAGE_URL",
            "value": {
                "large": {
                    "url": "https://www.example.com/creative1.jpg",
                    "width": 100,
                    "height": 100
                },
                "mobile": {
                    "url": "https://www.example.com/creative1.jpg",
                    "width": 50,
                    "height": 40
                }
            }
        },
        "heroImage": {
            "type": "IMAGE_URL",
            "value": {
                "large": {
                    "url": "https://www.example.com/creative1.jpg",
                    "width": 100,
                    "height": 100
                }
            }
        },
        "copy": {
            "type": "AD_COPY",
            "value": {
                "value": {
                    "headline": "10% back",
                    "subheadline": "Subscriptions",
                    "shortPreMessage": "Get 10% back at Bob's",
                    "thankYouMessage": "Thank you for shopping! You got $24.46 back!",
                    "marketingCopy": "Terms and conditions apply. Offer only applies to some locations.",
                    "rewardCopy": "Get 10% back on any purchase of $5 or more at Bob's Warehouse. Maximum of $30 back. Minimum transaction of $5 required.",
                    "preMessage": "Get 10% back on any purchase of $5 or more at Bob's Warehouse.",
                    "postMessage": "Time and inventory is limited. Maximum of $30 back. Minimum transaction of $5 required. Terms and conditions apply. Offer only applies to some locations. <a class='cardlytics_anchor_styling cardlytics_anchor_target' target='_blank' href='http://example.com' aria-label='here'>Please click here </a> to find a location near you. Offer expires 1/19/2024. <b>Offer only valid on purchases made directly with the merchant.</b> Offer not valid on purchases made using third-party services, delivery services, or a third-party payment account (e.g., buy now pay later). Payment must be made on or before offer expiration date.",
                    "termsAndConditions": "Offer expires 1/19/2024. <b>Offer only valid on purchases made directly with the merchant.</b> Offer not valid on purchases made using third-party services, delivery services, or a third-party payment account (e.g., buy now pay later). Payment must be made on or before offer expiration date."
                }
            }
        },
        "callsToAction": {
            "type": "CALL_TO_ACTION_LINKS",
            "value": {
                "buyNow": {
                    "type": "WEB_LINK",
                    "value": "https://www.example.com/shopping?productId=4"
                }
            }
        }
    }
}