CollectionMetadata

Added in server version 3.3.

The CollectionMetadata object contains the details of a collection but does not include the ads within. See Get /ads and the Collection object for more details.

Property	Type	Description
id	string	The unique identifier for this collection
name	string	Consumer-friendly name of this collection. Not guaranteed to be unique nor unchanging.
tagLine	string	A brief consumer-friendly description of the collection.
bannerImage	AdImage	The banner image of the collection. Note: If this collection is a sub-collection of another collection, `bannerImage` will be `null` or `undefined`.

Example

The below example is of a full Collection showing the use of metadata:

{
   "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" : [
               "ad.json"
            ]
      },
      {
         "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"
         ]
      }
   ]
}