Requesting A Brand Page

The Context

In order to request Brand Pages, you must provide a context.

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".

A Simple Context

This is a very basic brand page with a single banner and 3 Product Listing Ads

HTTP
cURL
HTTP
POST $BASE_URL/v1/ads/generate HTTP/1.1
accept: application/json
content-type: application/json
Authorization: Basic your_api_key_here
{
"catalogId": "string",
"customerId": "string",
"pageType": "string",
"contentStandardId": "string",
"brandPageId": ["string"],
"sessionId": "String"
}
cURL
curl -iX POST "$BASE_URL/v1/ads/generate" \
-H "accept: application/json" \
-H "content-type: application/json" \
-H "Authorization: Basic your_api_key_here" \
-d \
'{
"catalogId": "string",
"customerId": "string",
"pageType": "string",
"contentStandardId": "string",
"brandPageId": ["string"],
"sessionId": "String"
}'

A mock version can be seen below:

HTTP
cURL
HTTP
POST $BASE_URL/v1/ads/generate HTTP/1.1
accept: application/json
content-type: application/json
Authorization: Basic 4ww25f70-b52s-40de-8f29-07b139b5cdc8
{
"catalogId": "628dbe95-2ec9-4e07-881d-3e9f92ab2e0b",
"customerId": "3g4e33rr45s3",
"pageType": "Brand",
"contentStandardId": "3d65432510eb6-d9ead-4f45-b6e5-354565ce342534",
"brandPageId": ["3g4efew3rr45s3"],
"sessionId": "23dn3923-323d (this is a generated id that you control which identifies a user’s session). Optional"
}
cURL
curl -iX POST "$BASE_URL/v1/ads/generate" \
-H "accept: application/json" \
-H "content-type: application/json" \
-H "Authorization: Basic 4ww25f70-b52s-40de-8f29-07b139b5cdc8" \
-d \
'{
"catalogId": "628dbe95-2ec9-4e07-881d-3e9f92ab2e0b",
"customerId": "3g4e33rr45s3",
"pageType": "Brand",
"contentStandardId": "3d65432510eb6-d9ead-4f45-b6e5-354565ce342534",
"brandPageId": ["3g4efew3rr45s3"],
"sessionId": "23dn3923-323d (this is a generated id that you control which identifies a user’s session). Optional"
}'

What Happens when an Ad Is Successfully Requested

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

HTTP
cURL
HTTP
HTTP/2 200
{
"brandPage": {
"adId": "string",
"banners": [
{
"id": "string",
"slotId": "string",
"imageUrl": "string",
"linkUrl": "string",
"bannerText": "string",
"altText": "string",
"expiry": "string"
}
]
"ads": [
{
"id": "string",
"gtin": "string",
"expiry": "string",
}
{
"id": "string",
"gtin": "string",
"expiry": "string",
}
{
"id": "string",
"gtin": "string",
"expiry": "string",
}
]
}
}
cURL
{
"brandPage": {
"adId": "string",
"banners": [
{
"id": "string",
"slotId": "string",
"imageUrl": "string",
"linkUrl": "string",
"bannerText": "string",
"altText": "string",
"expiry": "string"
}
]
"ads": [
{
"id": "string",
"gtin": "string",
"expiry": "string",
}
{
"id": "string",
"gtin": "string",
"expiry": "string",
}
{
"id": "string",
"gtin": "string",
"expiry": "string",
}
]
}
}

A mock version can be seen below:

HTTP
cURL
HTTP
HTTP/2 200
{
"brandPage": {
"adId": "638dbe95-2ec9-4e07-881d-3e9f92axfec",
"banners": [
{
"id": "display_GPZmwLMUH9n0_zfZTfn8UcmAShRlZmx",
"slotId": "brand_Banner_1",
"imageUrl": "https://assets.example.com/q/mdNYanp7zYVG6h4zYlSduXfadhNUctYG_9gsNlPHQ9t=",
"linkUrl": "https://www.retailer.com/p/product-471697300-652936600",
"bannerText": "Brand xxx laptop: Now even better.",
"altText": "An image of a brand xxx laptop with price $990 and shop now button.",
"expiry": "2002-10-02T15:00:00.05Z"
}
]
"ads": [
{
"id": "34558f9b-bbb9-49fb-93fe-3ad481cr443",
"gtin": "88560901388694",
"expiry": "2018-04-30T01:14:99.832ZD",
}
{
"id": "34558f9b-bb9-49fb-93fe-3ad481cr1442",
"gtin": "82560901388345",
"expiry": "2018-04-30T01:14:99.832ZD",
}
{
"id": "324325f9b-bbb9-49fb-93fe-3ad481cr4432",
"gtin": "8856090692324",
"expiry": "2018-04-30T01:14:99.832ZD",
}
]
}
}
cURL
{
"brandPage": {
"adId": "638dbe95-2ec9-4e07-881d-3e9f92axfec",
"banners": [
{
"id": "display_GPZmwLMUH9n0_zfZTfn8UcmAShRlZmx",
"slotId": "brand_Banner_1",
"imageUrl": "https://assets.example.com/q/mdNYanp7zYVG6h4zYlSduXfadhNUctYG_9gsNlPHQ9t=",
"linkUrl": "https://www.retailer.com/p/product-471697300-652936600",
"bannerText": "Brand xxx laptop: Now even better.",
"altText": "An image of a brand xxx laptop with price $990 and shop now button.",
"expiry": "2002-10-02T15:00:00.05Z"
}
]
"ads": [
{
"id": "34558f9b-bbb9-49fb-93fe-3ad481cr443",
"gtin": "88560901388694",
"expiry": "2018-04-30T01:14:99.832ZD",
}
{
"id": "34558f9b-bb9-49fb-93fe-3ad481cr1442",
"gtin": "82560901388345",
"expiry": "2018-04-30T01:14:99.832ZD",
}
{
"id": "324325f9b-bbb9-49fb-93fe-3ad481cr4432",
"gtin": "8856090692324",
"expiry": "2018-04-30T01:14:99.832ZD",
}
]
}
}

A Complex Context

This example context is a larger brand page with multiple Banner Ads and Product Listing Ads, you will notice the request is the same as the prior example. :

HTTP
cURL
HTTP
POST $BASE_URL/v1/ads/generate?teamId=your_teamId_goes_here HTTP/1.1
accept: application/json
content-type: application/json
Authorization: Basic your_api_key_here
{
"catalogId": "string",
"customerId": "string",
"pageType": "string",
"contentStandardId": "string",
"brandPageId": ["string"],
"sessionId": "String"
}
cURL
curl -iX POST "$BASE_URL/v1/ads/generate?teamId=your_teamId_goes_here" \
-H "accept: application/json" \
-H "content-type: application/json" \
-H "Authorization: Basic your_api_key_here" \
-d \
'{
"catalogId": "string",
"customerId": "string",
"pageType": "string",
"contentStandardId": "string",
"brandPageId": ["string"],
"sessionId": "String"
}'

A mock version can be seen below:

HTTP
cURL
HTTP
POST $BASE_URL/v1/ads/generate HTTP/1.1
accept: application/json
content-type: application/json
Authorization: Basic 4ww25f70-b52s-40de-8f29-07b139b5cdc8
{
"catalogId": "628dbe95-2ec9-4e07-881d-3e9f92ab2e0b",
"customerId": "3g4e33rr45s3",
"pageType": "Brand",
"contentStandardId": "3d65432510eb6-d9ead-4f45-b6e5-354565ce342534",
"brandPageId": ["3g4efew3rr45s3"],
"sessionId": "23dn3923-323d (this is a generated id that you control which identifies a user’s session). Optional"
}
cURL
curl -iX POST "$BASE_URL/v1/ads/generate" \
-H "accept: application/json" \
-H "content-type: application/json" \
-H "Authorization: Basic 4ww25f70-b52s-40de-8f29-07b139b5cdc8" \
-d \
'{
"catalogId": "628dbe95-2ec9-4e07-881d-3e9f92ab2e0b",
"customerId": "3g4e33rr45s3",
"pageType": "Brand",
"contentStandardId": "3d65432510eb6-d9ead-4f45-b6e5-354565ce342534",
"brandPageId": ["3g4efew3rr45s3"],
"sessionId": "23dn3923-323d (this is a generated id that you control which identifies a user’s session). Optional"
}'

What Happens when an Ad Is Successfully Requested

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

HTTP
cURL
HTTP
HTTP/2 200
{
"brandPage": {
"adId": "string",
"banners": [
{
"id": "string",
"slotId": "string",
"imageUrl": "string",
"linkUrl": "string",
"bannerText": "string",
"altText": "string",
"expiry": "string"
}
{
"id": "string",
"slotId": "string",
"imageUrl": "string",
"linkUrl": "string",
"bannerText": "string",
"altText": "string",
"expiry": "string"
}
{
"id": "string",
"slotId": "string",
"imageUrl": "string",
"linkUrl": "string",
"bannerText": "string",
"altText": "string",
"expiry": "string"
}
{
"id": "string",
"slotId": "string",
"imageUrl": "string",
"linkUrl": "string",
"bannerText": "string",
"altText": "string",
"expiry": "string"
}
{
"id": "string",
"slotId": "string",
"imageUrl": "string",
"linkUrl": "string",
"bannerText": "string",
"altText": "string",
"expiry": "string"
}
{
"id": "string",
"slotId": "string",
"imageUrl": "string",
"linkUrl": "string",
"bannerText": "string",
"altText": "string",
"expiry": "string"
}
{
"id": "string",
"slotId": "string",
"imageUrl": "string",
"linkUrl": "string",
"bannerText": "string",
"altText": "string",
"expiry": "string"
}
]
"ads": [
{
"id": "string",
"gtin": "string",
"expiry": "string",
}
{
"id": "string",
"gtin": "string",
"expiry": "string",
}
{
"id": "string",
"gtin": "string",
"expiry": "string",
}
{
"id": "string",
"gtin": "string",
"expiry": "string",
}
{
"id": "string",
"gtin": "string",
"expiry": "string",
}
{
"id": "string",
"gtin": "string",
"expiry": "string",
}
{
"id": "string",
"gtin": "string",
"expiry": "string",
}
{
"id": "string",
"gtin": "string",
"expiry": "string",
}
]
}
}
cURL
{
"brandPage": {
"adId": "string",
"banners": [
{
"id": "string",
"slotId": "string",
"imageUrl": "string",
"linkUrl": "string",
"bannerText": "string",
"altText": "string",
"expiry": "string"
}
{
"id": "string",
"slotId": "string",
"imageUrl": "string",
"linkUrl": "string",
"bannerText": "string",
"altText": "string",
"expiry": "string"
}
{
"id": "string",
"slotId": "string",
"imageUrl": "string",
"linkUrl": "string",
"bannerText": "string",
"altText": "string",
"expiry": "string"
}
{
"id": "string",
"slotId": "string",
"imageUrl": "string",
"linkUrl": "string",
"bannerText": "string",
"altText": "string",
"expiry": "string"
}
{
"id": "string",
"slotId": "string",
"imageUrl": "string",
"linkUrl": "string",
"bannerText": "string",
"altText": "string",
"expiry": "string"
}
{
"id": "string",
"slotId": "string",
"imageUrl": "string",
"linkUrl": "string",
"bannerText": "string",
"altText": "string",
"expiry": "string"
}
{
"id": "string",
"slotId": "string",
"imageUrl": "string",
"linkUrl": "string",
"bannerText": "string",
"altText": "string",
"expiry": "string"
}
]
"ads": [
{
"id": "string",
"gtin": "string",
"expiry": "string",
}
{
"id": "string",
"gtin": "string",
"expiry": "string",
}
{
"id": "string",
"gtin": "string",
"expiry": "string",
}
{
"id": "string",
"gtin": "string",
"expiry": "string",
}
{
"id": "string",
"gtin": "string",
"expiry": "string",
}
{
"id": "string",
"gtin": "string",
"expiry": "string",
}
{
"id": "string",
"gtin": "string",
"expiry": "string",
}
{
"id": "string",
"gtin": "string",
"expiry": "string",
}
]
}
}

A mock version can be seen below:

HTTP
cURL
HTTP
HTTP/2 200
{
"brandPage": {
"adId": "628dbe95-2ec9-4e07-881d-3e9f92abfxrewc",
"banners": [
{
"id": "display_GPZmwLMUH9n0_zfZTfn8UcmAShRlZmx",
"slotId": "brand_Banner_1",
"imageUrl": "https://assets.example.com/q/mdNYanp7zYVG6h4zYlSduXfadhNUctYG_9gsNlPHQ9t=",
"linkUrl": "https://www.retailer.com/p/product-471697300-652936600",
"bannerText": "Brand xxx laptop: Now even better.",
"altText": "An image of a brand xxx laptop with price $990 and shop now button.",
"expiry": "2002-10-02T15:00:00.05Z"
}
{
"id": "display_GPZmwLMUH9n0_zfZTfn8Uc5432542dft423",
"slotId": "Row_Third_Banner_1",
"imageUrl": "https://assets.example.com/q/mdNYanp7zYVG6h4zYlSduXfadhNUvdrewt=",
"linkUrl": "https://www.retailer.com/p/product-471654396843000",
"bannerText": "Brand xxx laptop: With new processor.",
"altText": "An image of a brand xxx laptop with price $890 and shop now button.",
"expiry": "2002-10-02T15:00:00.05Z"
}
{
"id": "display_GPZmwLMUH9n0_zfZTfn8U52345",
"slotId": "Row_Third_Banner_2",
"imageUrl": "https://assets.example.com/q/mdNYanp7zYVG6h4zYlSduXdt4243wdtc",
"linkUrl": "https://www.retailer.com/p/product-47165433wt4968dt",
"bannerText": "Free hard drive upgrade.",
"altText": "An image of a brand xxx laptop with price $550 and shop now button.",
"expiry": "2002-10-02T15:00:00.05Z"
}
{
"id": "display_GPZmwLMUH9n0_zfZTfn8Uc5434eecxf",
"slotId": "Row_Third_Banner_3",
"imageUrl": "https://assets.example.com/q/mdNYanp7zYVG6h4zYlSduXfadhNUvdrewt=",
"linkUrl": "https://www.retailer.com/p/product-471654396843000",
"bannerText": "Brand xxx laptop: With new processor.",
"altText": "An image of a brand xxx laptop with price $690 and shop now button.",
"expiry": "2002-10-02T15:00:00.05Z"
}
{
"id": "display_GPZmwLMUH9n0_zfZTfnrewv4rwv",
"slotId": "Row_Third_Banner_4",
"imageUrl": "https://assets.example.com/q/mdNYanp7zYVG6h4zYlSduXdt42cfwcqwxc",
"linkUrl": "https://www.retailer.com/p/product-471f423xf4234xx31t",
"bannerText": "Buy one get one free.",
"altText": "An image of two brand xxx laptops with a shop now button.",
"expiry": "2002-10-02T15:00:00.05Z"
}
{
"id": "display_GPZmwLMUH9n0_zfZTf6543yc5v",
"slotId": "Row_Third_Banner_5",
"imageUrl": "https://assets.example.com/q/mdNYanp7zYVG6h4zYlSdew45d",
"linkUrl": "https://www.retailer.com/p/product-471f423xf423t4wc4w",
"bannerText": "Shop the school essentiala.",
"altText": "An image of three brand xxx laptops with a shop now button.",
"expiry": "2002-10-02T15:00:00.05Z"
}
{
"id": "display_GPZmwLMUH9n0_zfZTf6543yc5v",
"slotId": "Row_Third_Banner_5",
"imageUrl": "https://assets.example.com/q/mdNYanp7zYVG6h4zYlSdew45d",
"linkUrl": "https://www.retailer.com/p/product-471f423xf423t4wc4w",
"bannerText": "Shop the school essentiala.",
"altText": "An image of three brand xxx laptops with a shop now button.",
"expiry": "2002-10-02T15:00:00.05Z"
}
]
"ads": [
{
"id": "34558f9b-bbb9-49fb-93fe-3ad481cr443",
"gtin": "88560901388694",
"expiry": "2018-04-30T01:14:99.832ZD",
}
{
"id": "34558f9b-bb9-49fb-93fe-3ad481cr1442",
"gtin": "82560901388345",
"expiry": "2018-04-30T01:14:99.832ZD",
}
{
"id": "324325f9b-bbb9-49fb-93fe-3ad481cr4432",
"gtin": "8856090692324",
"expiry": "2018-04-30T01:14:99.832ZD",
}
{
"id": "34558f9b-bbb9-49fb-93fe-3ad482432rx",
"gtin": "88560901385434",
"expiry": "2018-04-30T01:14:99.832ZD",
}
{
"id": "34558f9b-bb9-49fb-93fe-35423cy53",
"gtin": "8256090138245",
"expiry": "2018-04-30T01:14:99.832ZD",
}
{
"id": "324325f9b-bbb9-49fb-93fe-3a4352t43",
"gtin": "8856090622341",
"expiry": "2018-04-30T01:14:99.832ZD",
}
{
"id": "324325f9b-bbb9-49fb-93fe-3ad4f3j90t34t4",
"gtin": "88560934546431",
"expiry": "2018-04-30T01:14:99.832ZD",
}
{
"id": "324325f9b-bbb9-49fb-93fe-3ad4542f3c2",
"gtin": "8856090623741",
"expiry": "2018-04-30T01:14:99.832ZD",
}
]
}
}
cURL
{
"brandPage": {
"adId": "628dbe95-2ec9-4e07-881d-3e9f92abfxrewc",
"banners": [
{
"id": "display_GPZmwLMUH9n0_zfZTfn8UcmAShRlZmx",
"slotId": "brand_Banner_1",
"imageUrl": "https://assets.example.com/q/mdNYanp7zYVG6h4zYlSduXfadhNUctYG_9gsNlPHQ9t=",
"linkUrl": "https://www.retailer.com/p/product-471697300-652936600",
"bannerText": "Brand xxx laptop: Now even better.",
"altText": "An image of a brand xxx laptop with price $990 and shop now button.",
"expiry": "2002-10-02T15:00:00.05Z"
}
{
"id": "display_GPZmwLMUH9n0_zfZTfn8Uc5432542dft423",
"slotId": "Row_Third_Banner_1",
"imageUrl": "https://assets.example.com/q/mdNYanp7zYVG6h4zYlSduXfadhNUvdrewt=",
"linkUrl": "https://www.retailer.com/p/product-471654396843000",
"bannerText": "Brand xxx laptop: With new processor.",
"altText": "An image of a brand xxx laptop with price $890 and shop now button.",
"expiry": "2002-10-02T15:00:00.05Z"
}
{
"id": "display_GPZmwLMUH9n0_zfZTfn8U52345",
"slotId": "Row_Third_Banner_2",
"imageUrl": "https://assets.example.com/q/mdNYanp7zYVG6h4zYlSduXdt4243wdtc",
"linkUrl": "https://www.retailer.com/p/product-47165433wt4968dt",
"bannerText": "Free hard drive upgrade.",
"altText": "An image of a brand xxx laptop with price $550 and shop now button.",
"expiry": "2002-10-02T15:00:00.05Z"
}
{
"id": "display_GPZmwLMUH9n0_zfZTfn8Uc5434eecxf",
"slotId": "Row_Third_Banner_3",
"imageUrl": "https://assets.example.com/q/mdNYanp7zYVG6h4zYlSduXfadhNUvdrewt=",
"linkUrl": "https://www.retailer.com/p/product-471654396843000",
"bannerText": "Brand xxx laptop: With new processor.",
"altText": "An image of a brand xxx laptop with price $690 and shop now button.",
"expiry": "2002-10-02T15:00:00.05Z"
}
{
"id": "display_GPZmwLMUH9n0_zfZTfnrewv4rwv",
"slotId": "Row_Third_Banner_4",
"imageUrl": "https://assets.example.com/q/mdNYanp7zYVG6h4zYlSduXdt42cfwcqwxc",
"linkUrl": "https://www.retailer.com/p/product-471f423xf4234xx31t",
"bannerText": "Buy one get one free.",
"altText": "An image of two brand xxx laptops with a shop now button.",
"expiry": "2002-10-02T15:00:00.05Z"
}
{
"id": "display_GPZmwLMUH9n0_zfZTf6543yc5v",
"slotId": "Row_Third_Banner_5",
"imageUrl": "https://assets.example.com/q/mdNYanp7zYVG6h4zYlSdew45d",
"linkUrl": "https://www.retailer.com/p/product-471f423xf423t4wc4w",
"bannerText": "Shop the school essentiala.",
"altText": "An image of three brand xxx laptops with a shop now button.",
"expiry": "2002-10-02T15:00:00.05Z"
}
{
"id": "display_GPZmwLMUH9n0_zfZTf6543yc5v",
"slotId": "Row_Third_Banner_5",
"imageUrl": "https://assets.example.com/q/mdNYanp7zYVG6h4zYlSdew45d",
"linkUrl": "https://www.retailer.com/p/product-471f423xf423t4wc4w",
"bannerText": "Shop the school essentiala.",
"altText": "An image of three brand xxx laptops with a shop now button.",
"expiry": "2002-10-02T15:00:00.05Z"
}
]
"ads": [
{
"id": "34558f9b-bbb9-49fb-93fe-3ad481cr443",
"gtin": "88560901388694",
"expiry": "2018-04-30T01:14:99.832ZD",
}
{
"id": "34558f9b-bb9-49fb-93fe-3ad481cr1442",
"gtin": "82560901388345",
"expiry": "2018-04-30T01:14:99.832ZD",
}
{
"id": "324325f9b-bbb9-49fb-93fe-3ad481cr4432",
"gtin": "8856090692324",
"expiry": "2018-04-30T01:14:99.832ZD",
}
{
"id": "34558f9b-bbb9-49fb-93fe-3ad482432rx",
"gtin": "88560901385434",
"expiry": "2018-04-30T01:14:99.832ZD",
}
{
"id": "34558f9b-bb9-49fb-93fe-35423cy53",
"gtin": "8256090138245",
"expiry": "2018-04-30T01:14:99.832ZD",
}
{
"id": "324325f9b-bbb9-49fb-93fe-3a4352t43",
"gtin": "8856090622341",
"expiry": "2018-04-30T01:14:99.832ZD",
}
{
"id": "324325f9b-bbb9-49fb-93fe-3ad4f3j90t34t4",
"gtin": "88560934546431",
"expiry": "2018-04-30T01:14:99.832ZD",
}
{
"id": "324325f9b-bbb9-49fb-93fe-3ad4542f3c2",
"gtin": "8856090623741",
"expiry": "2018-04-30T01:14:99.832ZD",
}
]
}
}

A Full Page Context

This example context is a larger brand page with multiple Banner Ads and Product Listing Ads, with the addition of non-advertising content. This allows retailers to have Citrus serve an entire brand page of content instead of only ads. You will notice the request is the same as the prior examples :

HTTP
cURL
HTTP
POST $BASE_URL/v1/ads/generate HTTP/1.1
accept: application/json
content-type: application/json
Authorization: Basic your_api_key_here
{
"catalogId": "string",
"customerId": "string",
"pageType": "string",
"contentStandardId": "string",
"brandPageId": ["string"],
"sessionId": "String"
}
cURL
curl -iX POST "$BASE_URL/v1/ads/generate" \
-H "accept: application/json" \
-H "content-type: application/json" \
-H "Authorization: Basic your_api_key_here" \
-d \
'{
"catalogId": "string",
"customerId": "string",
"pageType": "string",
"contentStandardId": "string",
"brandPageId": ["string"],
"sessionId": "String"
}'

A mock version can be seen below:

HTTP
cURL
HTTP
POST $BASE_URL/v1/ads/generate HTTP/1.1
accept: application/json
content-type: application/json
Authorization: Basic 4ww25f70-b52s-40de-8f29-07b139b5cdc8
{
"catalogId": "628dbe95-2ec9-4e07-881d-3e9f92ab2e0b",
"customerId": "3g4e33rr45s3",
"pageType": "Brand",
"contentStandardId": "3d65432510eb6-d9ead-4f45-b6e5-354565ce342534",
"brandPageId": ["3g4efew3rr45s3"],
"sessionId": "23dn3923-323d (this is a generated id that you control which identifies a user’s session). Optional"
}
cURL
curl -iX POST "$BASE_URL/v1/ads/generate" \
-H "accept: application/json" \
-H "content-type: application/json" \
-H "Authorization: Basic 4ww25f70-b52s-40de-8f29-07b139b5cdc8" \
-d \
'{
"catalogId": "628dbe95-2ec9-4e07-881d-3e9f92ab2e0b",
"customerId": "3g4e33rr45s3",
"pageType": "Brand",
"contentStandardId": "3d65432510eb6-d9ead-4f45-b6e5-354565ce342534",
"brandPageId": ["3g4efew3rr45s3"],
"sessionId": "23dn3923-323d (this is a generated id that you control which identifies a user’s session). Optional"
}'

What Happens when an Ad Is Successfully Requested

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

HTTP
cURL
HTTP
HTTP/2 200
{
"brandPage": {
"adId": "string",
"brandText": "string",
"brandVideoUrl": "string",
"banners": [
{
"id": "string",
"slotId": "string",
"imageUrl": "string",
"linkUrl": "string",
"bannerText": "string",
"altText": "string",
"expiry": "string"
}
{
"id": "string",
"slotId": "string",
"imageUrl": "string",
"linkUrl": "string",
"bannerText": "string",
"altText": "string",
"expiry": "string"
}
{
"id": "string",
"slotId": "string",
"imageUrl": "string",
"linkUrl": "string",
"bannerText": "string",
"altText": "string",
"expiry": "string"
}
{
"id": "string",
"slotId": "string",
"imageUrl": "string",
"linkUrl": "string",
"bannerText": "string",
"altText": "string",
"expiry": "string"
}
{
"id": "string",
"slotId": "string",
"imageUrl": "string",
"linkUrl": "string",
"bannerText": "string",
"altText": "string",
"expiry": "string"
}
{
"id": "string",
"slotId": "string",
"imageUrl": "string",
"linkUrl": "string",
"bannerText": "string",
"altText": "string",
"expiry": "string"
}
{
"id": "string",
"slotId": "string",
"imageUrl": "string",
"linkUrl": "string",
"bannerText": "string",
"altText": "string",
"expiry": "string"
}
]
"ads": [
{
"id": "string",
"gtin": "string",
"expiry": "string",
}
{
"id": "string",
"gtin": "string",
"expiry": "string",
}
{
"id": "string",
"gtin": "string",
"expiry": "string",
}
{
"id": "string",
"gtin": "string",
"expiry": "string",
}
{
"id": "string",
"gtin": "string",
"expiry": "string",
}
{
"id": "string",
"gtin": "string",
"expiry": "string",
}
{
"id": "string",
"gtin": "string",
"expiry": "string",
}
{
"id": "string",
"gtin": "string",
"expiry": "string",
}
]
}
}
cURL
{
"brandPage": {
"adId": "string",
"brandText": "string",
"brandVideoUrl": "string",
"banners": [
{
"id": "string",
"slotId": "string",
"imageUrl": "string",
"linkUrl": "string",
"bannerText": "string",
"altText": "string",
"expiry": "string"
}
{
"id": "string",
"slotId": "string",
"imageUrl": "string",
"linkUrl": "string",
"bannerText": "string",
"altText": "string",
"expiry": "string"
}
{
"id": "string",
"slotId": "string",
"imageUrl": "string",
"linkUrl": "string",
"bannerText": "string",
"altText": "string",
"expiry": "string"
}
{
"id": "string",
"slotId": "string",
"imageUrl": "string",
"linkUrl": "string",
"bannerText": "string",
"altText": "string",
"expiry": "string"
}
{
"id": "string",
"slotId": "string",
"imageUrl": "string",
"linkUrl": "string",
"bannerText": "string",
"altText": "string",
"expiry": "string"
}
{
"id": "string",
"slotId": "string",
"imageUrl": "string",
"linkUrl": "string",
"bannerText": "string",
"altText": "string",
"expiry": "string"
}
{
"id": "string",
"slotId": "string",
"imageUrl": "string",
"linkUrl": "string",
"bannerText": "string",
"altText": "string",
"expiry": "string"
}
]
"ads": [
{
"id": "string",
"gtin": "string",
"expiry": "string",
}
{
"id": "string",
"gtin": "string",
"expiry": "string",
}
{
"id": "string",
"gtin": "string",
"expiry": "string",
}
{
"id": "string",
"gtin": "string",
"expiry": "string",
}
{
"id": "string",
"gtin": "string",
"expiry": "string",
}
{
"id": "string",
"gtin": "string",
"expiry": "string",
}
{
"id": "string",
"gtin": "string",
"expiry": "string",
}
{
"id": "string",
"gtin": "string",
"expiry": "string",
}
]
}
}

A mock version can be seen below:

HTTP
cURL
HTTP
HTTP/2 200
{
"brandPage": {
"adId": "628dbe95-2ec9-4e07-881d-3e9f92abfxrewc",
"brandText": "string",
"brandVideoUrl": "string",
"banners": [
{
"id": "display_GPZmwLMUH9n0_zfZTfn8UcmAShRlZmx",
"slotId": "brand_Banner_1",
"imageUrl": "https://assets.example.com/q/mdNYanp7zYVG6h4zYlSduXfadhNUctYG_9gsNlPHQ9t=",
"linkUrl": "https://www.retailer.com/p/product-471697300-652936600",
"bannerText": "Brand xxx laptop: Now even better.",
"altText": "An image of a brand xxx laptop with price $990 and shop now button.",
"expiry": "2002-10-02T15:00:00.05Z"
}
{
"id": "display_GPZmwLMUH9n0_zfZTfn8Uc5432542dft423",
"slotId": "Row_Third_Banner_1",
"imageUrl": "https://assets.example.com/q/mdNYanp7zYVG6h4zYlSduXfadhNUvdrewt=",
"linkUrl": "https://www.retailer.com/p/product-471654396843000",
"bannerText": "Brand xxx laptop: With new processor.",
"altText": "An image of a brand xxx laptop with price $890 and shop now button.",
"expiry": "2002-10-02T15:00:00.05Z"
}
{
"id": "display_GPZmwLMUH9n0_zfZTfn8U52345",
"slotId": "Row_Third_Banner_2",
"imageUrl": "https://assets.example.com/q/mdNYanp7zYVG6h4zYlSduXdt4243wdtc",
"linkUrl": "https://www.retailer.com/p/product-47165433wt4968dt",
"bannerText": "Free hard drive upgrade.",
"altText": "An image of a brand xxx laptop with price $550 and shop now button.",
"expiry": "2002-10-02T15:00:00.05Z"
}
{
"id": "display_GPZmwLMUH9n0_zfZTfn8Uc5434eecxf",
"slotId": "Row_Third_Banner_3",
"imageUrl": "https://assets.example.com/q/mdNYanp7zYVG6h4zYlSduXfadhNUvdrewt=",
"linkUrl": "https://www.retailer.com/p/product-471654396843000",
"bannerText": "Brand xxx laptop: With new processor.",
"altText": "An image of a brand xxx laptop with price $690 and shop now button.",
"expiry": "2002-10-02T15:00:00.05Z"
}
{
"id": "display_GPZmwLMUH9n0_zfZTfnrewv4rwv",
"slotId": "Row_Third_Banner_4",
"imageUrl": "https://assets.example.com/q/mdNYanp7zYVG6h4zYlSduXdt42cfwcqwxc",
"linkUrl": "https://www.retailer.com/p/product-471f423xf4234xx31t",
"bannerText": "Buy one get one free.",
"altText": "An image of two brand xxx laptops with a shop now button.",
"expiry": "2002-10-02T15:00:00.05Z"
}
{
"id": "display_GPZmwLMUH9n0_zfZTf6543yc5v",
"slotId": "Row_Third_Banner_5",
"imageUrl": "https://assets.example.com/q/mdNYanp7zYVG6h4zYlSdew45d",
"linkUrl": "https://www.retailer.com/p/product-471f423xf423t4wc4w",
"bannerText": "Shop the school essentiala.",
"altText": "An image of three brand xxx laptops with a shop now button.",
"expiry": "2002-10-02T15:00:00.05Z"
}
{
"id": "display_GPZmwLMUH9n0_zfZTf6543yc5v",
"slotId": "Row_Third_Banner_5",
"imageUrl": "https://assets.example.com/q/mdNYanp7zYVG6h4zYlSdew45d",
"linkUrl": "https://www.retailer.com/p/product-471f423xf423t4wc4w",
"bannerText": "Shop the school essentiala.",
"altText": "An image of three brand xxx laptops with a shop now button.",
"expiry": "2002-10-02T15:00:00.05Z"
}
]
"ads": [
{
"id": "34558f9b-bbb9-49fb-93fe-3ad481cr443",
"gtin": "88560901388694",
"expiry": "2018-04-30T01:14:99.832ZD",
}
{
"id": "34558f9b-bb9-49fb-93fe-3ad481cr1442",
"gtin": "82560901388345",
"expiry": "2018-04-30T01:14:99.832ZD",
}
{
"id": "324325f9b-bbb9-49fb-93fe-3ad481cr4432",
"gtin": "8856090692324",
"expiry": "2018-04-30T01:14:99.832ZD",
}
{
"id": "34558f9b-bbb9-49fb-93fe-3ad482432rx",
"gtin": "88560901385434",
"expiry": "2018-04-30T01:14:99.832ZD",
}
{
"id": "34558f9b-bb9-49fb-93fe-35423cy53",
"gtin": "8256090138245",
"expiry": "2018-04-30T01:14:99.832ZD",
}
{
"id": "324325f9b-bbb9-49fb-93fe-3a4352t43",
"gtin": "8856090622341",
"expiry": "2018-04-30T01:14:99.832ZD",
}
{
"id": "324325f9b-bbb9-49fb-93fe-3ad4f3j90t34t4",
"gtin": "88560934546431",
"expiry": "2018-04-30T01:14:99.832ZD",
}
{
"id": "324325f9b-bbb9-49fb-93fe-3ad4542f3c2",
"gtin": "8856090623741",
"expiry": "2018-04-30T01:14:99.832ZD",
}
]
}
}
cURL
{
"brandPage": {
"adId": "628dbe95-2ec9-4e07-881d-3e9f92abfxrewc",
"brandText": "string",
"brandVideoUrl": "string",
"banners": [
{
"id": "display_GPZmwLMUH9n0_zfZTfn8UcmAShRlZmx",
"slotId": "brand_Banner_1",
"imageUrl": "https://assets.example.com/q/mdNYanp7zYVG6h4zYlSduXfadhNUctYG_9gsNlPHQ9t=",
"linkUrl": "https://www.retailer.com/p/product-471697300-652936600",
"bannerText": "Brand xxx laptop: Now even better.",
"altText": "An image of a brand xxx laptop with price $990 and shop now button.",
"expiry": "2002-10-02T15:00:00.05Z"
}
{
"id": "display_GPZmwLMUH9n0_zfZTfn8Uc5432542dft423",
"slotId": "Row_Third_Banner_1",
"imageUrl": "https://assets.example.com/q/mdNYanp7zYVG6h4zYlSduXfadhNUvdrewt=",
"linkUrl": "https://www.retailer.com/p/product-471654396843000",
"bannerText": "Brand xxx laptop: With new processor.",
"altText": "An image of a brand xxx laptop with price $890 and shop now button.",
"expiry": "2002-10-02T15:00:00.05Z"
}
{
"id": "display_GPZmwLMUH9n0_zfZTfn8U52345",
"slotId": "Row_Third_Banner_2",
"imageUrl": "https://assets.example.com/q/mdNYanp7zYVG6h4zYlSduXdt4243wdtc",
"linkUrl": "https://www.retailer.com/p/product-47165433wt4968dt",
"bannerText": "Free hard drive upgrade.",
"altText": "An image of a brand xxx laptop with price $550 and shop now button.",
"expiry": "2002-10-02T15:00:00.05Z"
}
{
"id": "display_GPZmwLMUH9n0_zfZTfn8Uc5434eecxf",
"slotId": "Row_Third_Banner_3",
"imageUrl": "https://assets.example.com/q/mdNYanp7zYVG6h4zYlSduXfadhNUvdrewt=",
"linkUrl": "https://www.retailer.com/p/product-471654396843000",
"bannerText": "Brand xxx laptop: With new processor.",
"altText": "An image of a brand xxx laptop with price $690 and shop now button.",
"expiry": "2002-10-02T15:00:00.05Z"
}
{
"id": "display_GPZmwLMUH9n0_zfZTfnrewv4rwv",
"slotId": "Row_Third_Banner_4",
"imageUrl": "https://assets.example.com/q/mdNYanp7zYVG6h4zYlSduXdt42cfwcqwxc",
"linkUrl": "https://www.retailer.com/p/product-471f423xf4234xx31t",
"bannerText": "Buy one get one free.",
"altText": "An image of two brand xxx laptops with a shop now button.",
"expiry": "2002-10-02T15:00:00.05Z"
}
{
"id": "display_GPZmwLMUH9n0_zfZTf6543yc5v",
"slotId": "Row_Third_Banner_5",
"imageUrl": "https://assets.example.com/q/mdNYanp7zYVG6h4zYlSdew45d",
"linkUrl": "https://www.retailer.com/p/product-471f423xf423t4wc4w",
"bannerText": "Shop the school essentiala.",
"altText": "An image of three brand xxx laptops with a shop now button.",
"expiry": "2002-10-02T15:00:00.05Z"
}
{
"id": "display_GPZmwLMUH9n0_zfZTf6543yc5v",
"slotId": "Row_Third_Banner_5",
"imageUrl": "https://assets.example.com/q/mdNYanp7zYVG6h4zYlSdew45d",
"linkUrl": "https://www.retailer.com/p/product-471f423xf423t4wc4w",
"bannerText": "Shop the school essentiala.",
"altText": "An image of three brand xxx laptops with a shop now button.",
"expiry": "2002-10-02T15:00:00.05Z"
}
]
"ads": [
{
"id": "34558f9b-bbb9-49fb-93fe-3ad481cr443",
"gtin": "88560901388694",
"expiry": "2018-04-30T01:14:99.832ZD",
}
{
"id": "34558f9b-bb9-49fb-93fe-3ad481cr1442",
"gtin": "82560901388345",
"expiry": "2018-04-30T01:14:99.832ZD",
}
{
"id": "324325f9b-bbb9-49fb-93fe-3ad481cr4432",
"gtin": "8856090692324",
"expiry": "2018-04-30T01:14:99.832ZD",
}
{
"id": "34558f9b-bbb9-49fb-93fe-3ad482432rx",
"gtin": "88560901385434",
"expiry": "2018-04-30T01:14:99.832ZD",
}
{
"id": "34558f9b-bb9-49fb-93fe-35423cy53",
"gtin": "8256090138245",
"expiry": "2018-04-30T01:14:99.832ZD",
}
{
"id": "324325f9b-bbb9-49fb-93fe-3a4352t43",
"gtin": "8856090622341",
"expiry": "2018-04-30T01:14:99.832ZD",
}
{
"id": "324325f9b-bbb9-49fb-93fe-3ad4f3j90t34t4",
"gtin": "88560934546431",
"expiry": "2018-04-30T01:14:99.832ZD",
}
{
"id": "324325f9b-bbb9-49fb-93fe-3ad4542f3c2",
"gtin": "8856090623741",
"expiry": "2018-04-30T01:14:99.832ZD",
}
]
}
}

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