Ad

Property Type Server Version Description
adId string 1.0+ The unique identifier for this ad
creatives Creative[] 1.0+ Contains all of the necessary information to render a specific manifestation of an ad. Currently all ads have exactly one visual representation and thus one element in the creatives array. However, this is subject to change in the future.
status AdStatus 1.0+ The status of the ad for this customer. See the AdStatus section for details
daysRemaining int 1.0+ The integral number of days remaining until the ad expires. For display use only
endDate string 1.0+ An ISO-8601 formatted date string representing the date the ad expires
isPercentageOffer boolean 1.0+ Whether or not the offer for this ad is percentage-based instead of dollar-amount based
merchantName string 1.0+ The name of the merchant this offer is for
offerAmount float 1.0+ The offer amount, either as a percentage or dollar amount, depending on percentage-offer
maxRewardAmount float 1.0+ The maximum allowed reward amount for the offer, specified in the reward program's currency. Can be undefined or null if an offer does not have a reward cap
minSpendAmount float 1.0+ The minimum transaction amount required to qualify for a reward, specified in monetary amount. Can be null, defined, or 0 if there is no minimum spend amount
adType int 1.0+ See the AdType section for more information
isMappable boolean 1.0+ Whether or not this ad has physical locations associated with it
isParked boolean 1.0+ Displays if an ad is parked or unparked
tags Tags[] 1.0+ Contains all the necessary tags associated with the ad. An ad can have multiple tags
position int 3.0+ Ad Position is zero based integer index of sorted list of ad returned by AdServer get response.
purchaseRequirement PurchaseRequirement 5.3+ Specifies any requirements or limitation on product(s) for the offer. For example, an offer may not be valid for gift card purchase, or it may only be valid for fuel purchases. A null or undefined value indicates no requirements.
purchaseChannels PurchaseChannel[] 5.3+ Indicates which purchase channels are allowed for this offer, such as in-store or online. An empty, null, or undefined value indicates there is no limitation to the purchase channel. The values are represented as strings within the array. See PurchaseChannel for possible values.
offerPromotions OfferPromotion[] 5.3+ Indicates any promotions that apply to this offer. An empty, null, or undefined value indicates there are no promotions. The values are represented as strings within the array. See OfferPromotion for possible values.
redemptions Redemption[] 1.0+ If this ad has been redeemed by the user, an array of such redemptions is included here
activatedDate string 3.3+ An ISO-8601 formatted date string representing the date the ad get activated. If the ad is not activated yet, its value will be null.

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
{
    "adId": "10132748",
    "status": 2,
    "creatives": [
        {
            "creativeId": "10132748-c",
            "shortPreMessage": "Get 10% back at Bob's",
            "thankYouMessage": "Thank you for shopping! You got $24.46 back!",
            "headline" : "10% back",
            "images": {
                "logo": {
                    "url": "https://images.cardlytics.com/ads/logo/10132748.png",
                    "text": "Bob's Logo"
                },
                "heroImage": {
                    "url": "https://images.cardlytics.com/ads/hero/warehouse.png",
                    "text": "Warehouse Storefront"
                }
            },
            "links" : {
                "callToActionLink": {
                    "url": "http://example.com/callToActionLink/WestRock%0D/?ot=testFI&xt=gF49Db7mM7CA%2BRSOOVBYwwYtmXqWcYpU9JSU%2BfgreARy1PeUKsES18FA8nrIplgPQqo01Z2%2BZ4PpzJLLNZkYBquYsvYVo%2FZYFfNftz8Q2u6VgCCBurtYJ%2BxUWS%2BV915aKb5sCf09xJ4n7YiykWyHViyWAxzko7qp9QWlsaFxRhQ%3D",
                    "text": "Shop Now"
                }
            },
            "beacons": {
                "preMessageImpression": "http://example.com/foo",
                "postMessageImpression": "http://example.com/bar"
            },
            "impressionToken": "CIy66gQoATAB",
            "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. <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."
        }
    ],
    "isParked": true,
    "categoryId": 3,
    "daysRemaining": 28,
    "endDate": "2019-03-22T09:39:25",
    "isPercentageOffer": true,
    "merchantName": "Bob's Warehouse",
    "offerAmount": 10.0,
    "maxRewardAmount": 30.0,
    "minSpendAmount": 5.0,
    "adType": 101,
    "isMappable": true,
    "redemptions": [
        {
            "redemptionId": 992745,
            "accountId": 25895672459,
            "adId": 2784221,
            "amount": 34.12,
            "date": "2019-03-21T12:58:34",
            "isMyReward": false,
            "paidAccountId": 388836454,
            "redeemingTransactionAmount": 34.46,
            "transactionId": 929994552,
            "rewardSettlementRunDate": "2019-03-21T23:59:50"
        }
    ],
    "tags": [
        {
            "key": "purchase-channel",
            "value": "In-Store"
        }
    ],
    "purchaseChannels": [
        "InStore"
    ],
    "purchaseRequirement" : {
        "requirementType" : "MustPurchase",
        "purchaseTypes" : [
            "Fuel"
        ]
    },
    "offerPromotions": [
        "FlashDeal"
    ],
    "position": 4,
    "activatedDate": "2021-10-26T19:11:27Z"
}