Skip to content

Collection

Added in server version 3.3.

The Collection object contains the details of a collection, the collection's ads, and any sub-collections. See also: GET /collection.

Property Type Description
metadata CollectionMetadata The metadata for the collection.
ads Ad[] The ads within the collection.
It is not uncommon for this array to be empty if all ads belong to the sub-collections.
subCollections SubCollection[] The sub-collections within this collection, if any.
categories CategoryGroup[] An array of ad category groups covering the ads in this collection and sub-collections. The categories reference ads in the ads arrays via their ad ID, similar to the categories list in AdList


SubCollection

The SubCollection object contains the details of a sub-collection and the ads it contains. It is essentially a tuple of CollectionMetadata and an array of Ads.

Property Type Description
metadata CollectionMetadata The metadata for the sub-collection.
Note: CollectionMetadata.bannerImage is null for sub-collection.
ads Ad[] The ads within the sub-collection.

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
117
118
119
120
121
122
123
124
125
{
   "metadata": {
      "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"
      }
   },
   "ads" : [ /* Empty in this example, as all ads are part of sub-collections instead */ ],
   "subCollections" : [
      {
         "metadata" : {
            "id" : "111222333",
            "name" : "Last-Minute Gift Ideas",
            "tagLine" : "Stores open on holidays.",
            "bannerImage" : null /* Will be null for Sub-Collection */
         }
         "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"
               }
            ]
      },
      {
         "metadata" : {
            "id" : "F009A",
            "name" : "Holiday Gifts for Kids",
            "tagLine" : "Shop for the little ones this holiday season",
            "bannerImage" : null /* Will be null for Sub-Collection */
            }
            "ads" : [
               // Omitted for brevity
            ]
      }
   ],
   "categories":[
      {
         "name":"Shopping",
         "id":"Shopping-123",
         "adIds":[
            "10132748",
            "11244212"
         ]
      }
   ]
}