Implement Fluid Ad Server

﻿
Ad Request/Response Protocol
The Pentaleap Fluid Relevancy Engine is an adserver API is used to request and receive ads from connected demand sources.  
Ad unit IDs are provided to you from your own Publisher Manager UI. Page context is passed by sharing information such as organic products, search queries and categories as relevant; you may also specify additional products and categories to be in scope for sponsorship.
Multiple Ad Units can be called in a single request, and Sponsored Product and Display/Sponsored Brand-type units are also called in the same request format.
For full specification, please check out the API specifications with examples for Sponsored Products and Display Ads in the respective sections. 
IMPORTANT: Please check out the Adserver FAQ section to understand some common behaviours and rules of the ad response. 
Sample request structure - the response includes both Sponsored Product and Display ads:
JS
{
  "user": {
    "id": "string",
  },
  "adUnits": [
    {
      "adUnitId": "string",
      "searchQuery": "string",
      "products": [
        {
          "gtin": "string",
          "ignoreBid": false,
          "pinned": false,
          "ext": {
            "attr1": "val1",
            "attr2": "val2"
          }
        }
      ],
      "categories": {
        "current": "string",
        "additional": [
          "string"
        ]
      },
      "additionalProducts": [
        {
          "gtin": "string"
        }
      ],
      "demandSources": {
        "spa": {
          "demand_source_1": {
            "947081": {
              "bid": 2.3,
              "beaconUrls": [
                "https://demand_source_1.com/tracking/impression/947081"
              ],
              "clickUrls": [
                "https://demand_source_1.com/tracking/click/947081"
              ]
            }
          }
        }
      },
      }
    }
  ]
}
{
  "user": {
    "id": "string",
  },
  "adUnits": [
    {
      "adUnitId": "string",
      "searchQuery": "string",
      "products": [
        {
          "gtin": "string",
          "ignoreBid": false,
          "pinned": false,
          "ext": {
            "attr1": "val1",
            "attr2": "val2"
          }
        }
      ],
      "categories": {
        "current": "string",
        "additional": [
          "string"
        ]
      },
      "additionalProducts": [
        {
          "gtin": "string"
        }
      ],
      "demandSources": {
        "spa": {
          "demand_source_1": {
            "947081": {
              "bid": 2.3,
              "beaconUrls": [
                "https://demand_source_1.com/tracking/impression/947081"
              ],
              "clickUrls": [
                "https://demand_source_1.com/tracking/click/947081"
              ]
            }
          }
        }
      },
      }
    }
  ]
}
﻿
The response returns sponsored and in some cases organic content to be rendered, plus additional information required for rendering and reporting.
Sample response:
JS
{
  "adUnits": [
    {
      "adUnitId": "string",
      "positions": [
        {
          "gtin": "string",
          "sponsored": false,
          "kind": "string",
          "ext": {
            "attr1": "val1",
            "attr2": "val2"
          }
        },
        {
          "gtin": "string",
          "sponsored": true,
          "kind": "string",
          "beaconUrls": [
            "string"
          ],
          "clickUrls": [
            "string"
          ],
          "ext": {
            "attr1": "val1",
            "attr2": "val2"
          }
        },
        {
          "sponsored": true,
          "kind": "string",
          "targetUrl": "https://www.example.com",
          "banner": {
            "300x250": {
              "assetUrl": "https://www.example.com/image_300x250.jpg",
              "beaconUrls": [
                "https://www.example.com/tracking/impression/image_300x250"
              ],
              "clickUrls": [
                "https://www.example.com/tracking/click/image_300x250"
              ]
            },
            "728x90": {
              "assetUrl": "https://www.example.com/image_728x90.jpg",
              "beaconUrls": [
                "https://www.example.com/tracking/impression/image_728x90"
              ],
              "clickUrls": [
                "https://www.example.com/tracking/click/image_728x90"
              ]
            }
          },
          "ext": {
            "attr1": "val1",
            "attr2": "val2"
          }
        }
      ]
    }
  ]
}
{
  "adUnits": [
    {
      "adUnitId": "string",
      "positions": [
        {
          "gtin": "string",
          "sponsored": false,
          "kind": "string",
          "ext": {
            "attr1": "val1",
            "attr2": "val2"
          }
        },
        {
          "gtin": "string",
          "sponsored": true,
          "kind": "string",
          "beaconUrls": [
            "string"
          ],
          "clickUrls": [
            "string"
          ],
          "ext": {
            "attr1": "val1",
            "attr2": "val2"
          }
        },
        {
          "sponsored": true,
          "kind": "string",
          "targetUrl": "https://www.example.com",
          "banner": {
            "300x250": {
              "assetUrl": "https://www.example.com/image_300x250.jpg",
              "beaconUrls": [
                "https://www.example.com/tracking/impression/image_300x250"
              ],
              "clickUrls": [
                "https://www.example.com/tracking/click/image_300x250"
              ]
            },
            "728x90": {
              "assetUrl": "https://www.example.com/image_728x90.jpg",
              "beaconUrls": [
                "https://www.example.com/tracking/impression/image_728x90"
              ],
              "clickUrls": [
                "https://www.example.com/tracking/click/image_728x90"
              ]
            }
          },
          "ext": {
            "attr1": "val1",
            "attr2": "val2"
          }
        }
      ]
    }
  ]
}
﻿
﻿
Minimum Specifications
FAQs about the ad response