Requesting an Email Banner Ad

The context to serve Email Banner Ads.

The Context

In order to request Banner Ads, you must provide a context. Unlike Banner Ad contexts, we use EventIDs to identify specific Emails.

An example of a context is shown below. In this example, the type of each kind of data is shown. For example, "string" means an alphanumeric string. "number" means a number like "1" or "950.49". Integer means a whole number, like "1" or "25".

{
“eventId”: "string",
"catalogId": "string",
“productFilters”: "string",
"slotIds": [
{
"slotId": "string",
"maxNumberOfAds": "number"
},
}
],
"customerId": "string",
}
}

A mock version can be seen below:

{
“eventId”: "HBE934u-Fefre-fr34a-92kdf",
"catalogId": "628dbe95-2ec9-4e07-881d-3e9f92ab2e0b",
“productFilters”: "BeautySubscribers",
"slotIds": [
{
"slotId": "mid_section_banner",
"maxNumberOfAds": 1
},
}
],
"customerId": "3g4e33rr45s3",
}
}

A Successfully Requested Ad

When you successfully request an ad, you receive the following object:

{
"bannerResult": [
{
"slotId": "string",
"banners": [
{
“adId": "string",
"contentStandardId": "string",
“slotId": "string",
“expiry": "string",
“imageUrl”: "string",
“destinationUrl”: "string",
“altText": "string",
"text”: "string",
}
]
}
]
}

A mock version can be seen below:

{
"bannerResult": [
{
"slotId": "mid_section_banner",
"banners": [
{
“adId": "67s8be95-2ec9-r4e07-881d-3hdi8s2ab2e0b",
"contentStandardId": "2ec9ee-4etrs06-8sfgdg1d-3e9f92",
“slotId": "mid_section_banner",
“expiry": "2002-10-02T15:00:00.05Z",
“imageUrl”: "https://retailer-media.com/wcsstore/RetailerCatalogAssetStore/images/15/151/1635/720/31/586008640/586008640_2_720x928.jpg",
“destinationUrl”: "https://www.retailer.com/p/perfume-sauvage-edp",
“altText": "Dior Sauvage EDP 100ml",
"text”: "Dior Sauvage EDP",
}
]
}
]
}

Requesting Multiple Email Banner Ads

You are able to request multiple Email Banner Ads in a single request. This is done by adding additional slotId fields under the slotIds section

{
“eventId”: "string",
"catalogId": "string",
“productFilters”: "string",
"slotIds": [
{
"slotId": "string",
"maxNumberOfAds": "number"
},
{
"slotId": "string",
"maxNumberOfAds": "number"
},
{
"slotId": "string",
"maxNumberOfAds": "number"
}
}
],
"customerId": "string",
}
}

A mock version can be seen below:

{
“eventId”: "HBE934u-Fefre-fr34a-92kdf",
"catalogId": "628dbe95-2ec9-4e07-881d-3e9f92ab2e0b",
“productFilters”: "BeautySubscribers",
"slotIds": [
{
"slotId": "header_banner",
"maxNumberOfAds": 1
},
{
"slotId": "mid_breaker_banner",
"maxNumberOfAds": 1
},
{
"slotId": "footer_banners",
"maxNumberOfAds": 1
}
}
],
"customerId": "3g4e33rr45s3",
}
}

A Successfully Requested Ad

When you successfully request an ad, you receive the following object:

{
"bannerResult": [
{
"slotId": "string",
"banners": [
{
“adId": "string",
"contentStandardId": "string",
“slotId": "string",
“expiry": "string",
“imageUrl”: "string",
“destinationUrl”: "string",
“altText": "string",
"text”: "string",
}
]
}
{
"slotId": "string",
"banners": [
{
“adId": "string",
"contentStandardId": "string",
“slotId": "string",
“expiry": "string",
“imageUrl”: "string",
“destinationUrl”: "string",
“altText": "string",
"text”: "string",
}
]
}
{
"slotId": "string",
"banners": [
{
“adId": "string",
"contentStandardId": "string",
“slotId": "string",
“expiry": "string",
“imageUrl”: "string",
“destinationUrl”: "string",
“altText": "string",
"text”: "string",
}
]
}
]
}

A mock version can be seen below:

{
"bannerResult": [
{
"slotId": "header_banner",
"banners": [
{
“adId": "9sb3be95-7ems-r4e07-881d-dby47823owrwe",
"contentStandardId": "2ec9ee-4etrs06-8sfgdg1d-3e9f92",
“slotId": "header_banner",
“expiry": "2002-10-02T15:00:00.05Z",
“imageUrl”: "https://retailer-media.com/wcsstore/RetailerCatalogAssetStore/images/12/154/1135/430/01/583458640/583458640_2_720x928.jpg",
“destinationUrl”: "https://www.retailer.com/p/revlon-super-lustrous-matte-is-everything-lipstick",
“altText": "Revlon Super Lustrous Matte is Everything Lipstick Audacious Mauve",
"text”: "Revlon Super Lustrous Matte is Everything Liptick",
}
]
}
{
"slotId": "mid_section_banner",
"banners": [
{
“adId": "67s8be95-2ec9-r4e07-881d-3hdi8s2ab2e0b",
"contentStandardId": "2ec9ee-4etrs06-8sfgdg1d-3e9f92",
“slotId": "mid_section_banner",
“expiry": "2002-10-02T15:00:00.05Z",
“imageUrl”: "https://retailer-media.com/wcsstore/RetailerCatalogAssetStore/images/15/151/1635/720/31/586008640/586008640_2_720x928.jpg",
“destinationUrl”: "https://www.retailer.com/p/perfume-sauvage-edp",
“altText": "Dior Sauvage EDP 100ml",
"text”: "Dior Sauvage EDP", }
]
}
{
"slotId": "footer_banner",
"banners": [
{
“adId": "84nfu54532f54f-5svthrd-r4e07-881d-9dnrt",
"contentStandardId": "2ec9ee-4etrs06-8sfgdg1d-3e9f92",
“slotId": "footer_banner",
“expiry": "2002-10-02T15:00:00.05Z",
“imageUrl”: "https://retailer-media.com/wcsstore/RetailerCatalogAssetStore/images/19/105/1265/820/31/533208640/533208640_2_720x928.jpg",
“destinationUrl”: "https://www.retailer.com/p/jurlique-rose-body-oil-limited-edition",
“altText": "Jurlique Rose Body Oil Limited Edition 100ml",
"text”: "Jurlique Rose Body Oil",
}
]
}
]
}

A Complex Multiple Banner Email Ad Request

You are able to request multiple Email Banner Ads in a single request. This is done by adding additional slotId fields under the slotIds section.

An email request like as shown below can be utilised when using Citrus to serve the majority of your email marketing content.

{
“eventId”: "string",
"catalogId": "string",
“productFilters”: "string",
"slotIds": [
{
"slotId": "string",
"maxNumberOfAds": "number"
},
{
"slotId": "string",
"maxNumberOfAds": "number"
},
{
"slotId": "string",
"maxNumberOfAds": "number"
}
}
],
"customerId": "string",
}
}

A mock version can be seen below:

{
“eventId”: "HBE934u-Fefre-fr34a-92kdf",
"catalogId": "628dbe95-2ec9-4e07-881d-3e9f92ab2e0b",
“productFilters”: "BeautySubscribers",
"slotIds": [
{
"slotId": "header_banner",
"maxNumberOfAds": 1
},
{
"slotId": "mid_breaker_banner",
"maxNumberOfAds": 2
},
{
"slotId": "footer_banners",
"maxNumberOfAds": 4
}
}
],
"customerId": "3g4e33rr45s3",
}
}

A Successfully Requested Ad

When you successfully request an ad using an object like as shown above, you receive the following object:

{
"bannerResult": [
{
"slotId": "string",
"banners": [
{
“adId": "string",
"contentStandardId": "string",
“slotId": "string",
“expiry": "string",
“imageUrl”: "string",
“destinationUrl”: "string",
“altText": "string",
"text”: "string",
}
]
}
{
"slotId": "string",
"banners": [
{
“adId": "string",
"contentStandardId": "string",
“slotId": "string",
“expiry": "string",
“imageUrl”: "string",
“destinationUrl”: "string",
“altText": "string",
"text”: "string",
}
{
“adId": "string",
"contentStandardId": "string",
“slotId": "string",
“expiry": "string",
“imageUrl”: "string",
“destinationUrl”: "string",
“altText": "string",
"text”: "string",
}
]
}
{
"slotId": "sting",
"banners": [
{
“adId": "string",
"contentStandardId": "string",
“slotId": "string",
“expiry": "string",
“imageUrl”: "string",
“destinationUrl”: "string",
“altText": "string",
"text”: "string",
}
{
“adId": "string",
"contentStandardId": "string",
“slotId": "string",
“expiry": "string",
“imageUrl”: "string",
“destinationUrl”: "string",
“altText": "string",
"text”: "string",
}
{
“adId": "string",
"contentStandardId": "string",
“slotId": "string",
“expiry": "string",
“imageUrl”: "string",
“destinationUrl”: "string",
“altText": "string",
"text”: "string",
}
{
“adId": "string",
"contentStandardId": "string",
“slotId": "string",
“expiry": "string",
“imageUrl”: "string",
“destinationUrl”: "string",
“altText": "string",
"text”: "string",
}
]
}
]
}

A mock version can be seen below:

{
"bannerResult": [
{
"slotId": "header_banner",
"banners": [
{
“adId": "9sb3be95-7ems-r4e07-881d-dby47823owrwe",
"contentStandardId": "2ec9ee-4etrs06-8sfgdg1d-3e9f92",
“slotId": "header_banner",
“expiry": "2002-10-02T15:00:00.05Z",
“imageUrl”: "https://retailer-media.com/wcsstore/RetailerCatalogAssetStore/images/12/154/1135/430/01/583458640/583458640_2_720x928.jpg",
“destinationUrl”: "https://www.retailer.com/p/revlon-super-lustrous-matte-is-everything-lipstick",
“altText": "Revlon Super Lustrous Matte is Everything Lipstick Audacious Mauve",
"text”: "Revlon Super Lustrous Matte is Everything Liptick",
}
]
}
{
"slotId": "mid_section_banner",
"banners": [
{
“adId": "67s8be95-2ec9-r4e07-881d-3hdi8s2ab2e0b",
"contentStandardId": "2ec9ee-4etrs06-8sfgdg1d-3e9f92",
“slotId": "mid_section_banner",
“expiry": "2002-10-02T15:00:00.05Z",
“imageUrl”: "https://retailer-media.com/wcsstore/RetailerCatalogAssetStore/images/15/151/1635/720/31/586008640/586008640_2_720x928.jpg",
“destinationUrl”: "https://www.retailer.com/p/perfume-sauvage-edp",
“altText": "Dior Sauvage EDP 100ml",
"text”: "Dior Sauvage EDP",
}
{
“adId": "3bdstx03-9m2b-0x3d0-93mn-hfu439orh4389",
"contentStandardId": "2ec9ee-4etrs06-8sfgdg1d-3e9f92",
“slotId": "mid_section_banner",
“expiry": "2002-10-02T15:00:00.05Z",
“imageUrl”: "https://retailer-media.com/wcsstore/RetailerCatalogAssetStore/images/15/151/1627/720/53/667148050/667148050_1_720x928.jpg",
“destinationUrl”: "https://www.retailer.com/p/emporio-armani-because-its-you-emporio-armani-in-love-with-you-intense-100ml",
“altText": "Emporio Armani In Love With You Intense Bottle 50ml",
"text”: "Emporio Armani In Love With You Intense",
}
]
}
{
"slotId": "footer_banner",
"banners": [
{
“adId": "84nfu54532f54f-5svthrd-r4e07-881d-9dnrt",
"contentStandardId": "2ec9ee-4etrs06-8sfgdg1d-3e9f92",
“slotId": "footer_banner",
“expiry": "2002-10-02T15:00:00.05Z",
“imageUrl”: "https://retailer-media.com/wcsstore/RetailerCatalogAssetStore/images/19/105/1265/820/31/533208640/533208640_2_720x928.jpg",
“destinationUrl”: "https://www.retailer.com/p/jurlique-rose-body-oil-limited-edition",
“altText": "Jurlique Rose Body Oil Limited Edition 100ml",
"text”: "Jurlique Rose Body Oil",
}
{
“adId": "9xneuwf54f-ctr2g2r-5edte-5etf-6heet",
"contentStandardId": "2ec9ee-4etrs06-8sfgdg1d-3e9f92",
“slotId": "footer_banner",
“expiry": "2002-10-02T15:00:00.05Z",
“imageUrl”: "https://retailer-media.com/wcsstore/RetailerCatalogAssetStore/images/15/154/1616/38/3/548126650/548126650_1_1_720x928.jpg",
“destinationUrl”: "https://www.retailer.com/p/sohum-sohum-royal-frangipani-candle",
“altText": "Sohum Royal Frangipani Candle",
"text”: "Sohum Royal Frangipani Candle",
}
{
“adId": "f18943pfncn-djsy34-fx3de-ct42-fe3cr",
"contentStandardId": "2ec9ee-4etrs06-8sfgdg1d-3e9f92",
“slotId": "footer_banner",
“expiry": "2002-10-02T15:00:00.05Z",
“imageUrl”: "https://retailer-media.com/wcsstore/RetailerCatalogAssetStore/images/15/150/1653/11/3/563362930/563362930_1_1_720x928.jpg",
“destinationUrl”: "https://www.retailer.com/p/sachajuan-sachajuan-moisturizing-shampoo-250ml",
“altText": "Sachajuan Moisturizing Shampoo 250ml",
"text”: "Sachajuan Moisturizing Shampoo",
}
{
“adId": "h0sc45uy58oiu-h45ew8t-cv53d-34hy-tr34w",
"contentStandardId": "2ec9ee-4etrs06-8sfgdg1d-3e9f92",
“slotId": "footer_banner",
“expiry": "2002-10-02T15:00:00.05Z",
“imageUrl”: "https://retailer-media.com/wcsstore/RetailerCatalogAssetStore/images/15/150/1653/11/3/656039800/656039800_1_720x928.jpg",
“destinationUrl”: "https://www.retailer.com/p//olive-moisturising-day-cream",
“altText": "Olive Moisturising Day Cream 45ml",
"text”: "Olive Moisturising Day Cream",
}
]
}
]
}

If you are unsure of the strings displayed on this page. Take a look at the Reference page.