AdList

Property Type Description
ads Map with adId (string) keys and Ad objects as values Data for ads, keyed by adId to make referencing from ranking section simpler
rankings Map keyed by type of ranking returned Indicator for how to rank ads returned. If no sections are used, then use “ALL” section id
assets Creative[] Array of metadata for creatives. This is an optional response object that can be disabled through ad-metadata and creative-metadata caching integration.
storeLocations Map keyed by AdId, values: array of StoreLocation objects

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
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
{
   "ads":[
    {
        "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"
    }
   ],
   "categories":[
      {
         "name":"Shopping",
         "id":"9823782",
         "subcategories":[

         ],
         "adIds":[
            "10132748"
         ]
      }
   ],
   "collections" : [
      {
         "id" : "c122",
         "name" : "Holiday Gift Shopping",
         "tagLine" : "Gift yourself while gifting others.",
         "bannerImage" : {
            "url":"https://images.cardlytics.com/collections/banner/c122.png",
            "text":"wrapped presents"
         }
      },
      {
         "id" : "999888",
         "name" : "Local Businesses",
         "tagLine" : "Shop local and save!",
         "bannerImage" : {
            "url":"https://images.cardlytics.com/collections/banner/999888.png",
            "text":"storefront"
         }
      }
   ]
}