DSPAdResponse

The top-level bid response object. On success, seatbid contains ad markup. When FCC has no ads to serve, seatbid is absent and nbr is 0. When the request fails validation, seatbid is absent, nbr is 2, and FCC populates ext.errors.

idstringrequired

ID of the bid request to which this is a response. Reflects the bid request ID for logging purposes.

Example: a7sIT125

seatbid object[]

Array of SeatBid objects. Each SeatBid represents a different bidder seat and contains one or more Bid objects, each relating to a specific impression in the request.

Absent when FCC has no ads to serve. Check nbr when absent.

Array [

bid object[]required

Required. Array of Bid objects. Multiple bids can relate to the same impression.

Each Bid relates to a specific impression via impid and constitutes an offer to buy that impression.

Array [

idstringrequired

Bidder-generated bid ID to assist with logging and tracking.

Example: AL2PPRCAAAAAGIAAB_1_DF456GF5GD

impidstringrequired

ID of the Imp object in the related bid request.

Example: OSGMz25

admstringrequired

Ad markup for the served ad which will render on the publisher property. Format depends on the impression type.

Banner ads: a serialized JSON string. Parse before use. The parsed object contains:

Property	Type	Description
`version`	string	Native template version (e.g., `"1.0"`).
`assets`	array	Creative assets to render. See assets structure below.
`impUrls`	array[string]	Impression tracking URLs. Replace `[EVENTTIME]` with epoch milliseconds before firing.
`viewUrls`	array[string]	Viewability tracking URLs. Replace `[STARTTIME]` and `[ENDTIME]` with epoch milliseconds. `[STARTTIME]` and `[ENDTIME]` must differ by at least 1 ms.
`clickUrls`	array[string]	Click tracking URLs. Replace `[EVENTTIME]` with epoch milliseconds before firing.

All placeholder values are epoch milliseconds. See https://currentmillis.com/ for reference. Batch all tracking URLs for a given ad event in a single call where possible rather than firing them individually. For impression and engagement event tracking, see the Engagement Events API.

Assets structure (assets[]):

Property	Type	Description
`id`	integer	Unique asset identifier.
`img.url`	string	CDN URL of the creative image.
`img.width`	integer	Image width in pixels.
`img.height`	integer	Image height in pixels.
`img.type`	integer	Image layout/format type.
`native.value`	string	Custom asset value (e.g., landing page URL).
`native.type`	string	Type of the asset (e.g., `LP` for landing page).

Video ads: a VAST 4.2 XML string. Pass directly to a VAST-compatible video player. See the Display Ads Integration Guide for VAST structure, player requirements, and tracking details.

Example:

{"version":"1.0","assets":[{"id":-1156179165,"img":{"type":0,"url":"http://abc.com/flap-image/96d2660f51d748bf.jpg","width":640,"height":1440},"native":{"value":"http://xyz.com","type":"LP"}}],"impUrls":["http://abc.com/adImpression?pl=sgZUyf1P5jiFimOVV0hqmcm0sljwUuJBPIRFpFyVIqShpstMGcpzV4LIEKOjY72bSQOTwRwZ0EbrZRJX73x7LQQcvgV5TfCGeFgFSBdkLCMLTjiMQs3Lo4cVyS6vkrfGREzz3n6yrmAFwhbb68CQsnOsyYfdTe6WcjFJxqJUh08"],"viewUrls":["http://abc.com/adView?pl=sgZUyf1P5jiFimOVV0hqmcm0sljwUuJBPIRFpFyVIqShpstMGcpzV4LIEKOjY72bSQOTwRwZ0EbrZRJX73x7LQQcvgV5TfCGeFgFSBdkLCMLTjiMQs3Lo4cVyS6vkrfGREzz3n6yrmAFwhbb68CQsnOsyYfdTe6WcjFJxqJUh08&vst=[STARTTIME]&vet=[ENDTIME]"],"clickUrls":["http://abc.com/adClick?pl=sgZUyf1P5jiFimOVV0hqmcm0sljwUuJBPIRFpFyVIqShpstMGcpzV4LIEKOjY72bSQOTwRwZ0EbrZRJX73x7LQQcvgV5TfCGeFgFSBdkLCMLTjiMQs3Lo4cVyS6vkrfGREzz3n6yrmAFwhbb68CQsnOsyYfdTe6WcjFJxqJUh08&cet=[EVENTTIME]"]}

ext objectrequired

Extension object containing banner metadata such as slot ID, ad group ID, and rich media payload.

ad_group_idstringrequired

ID of the banner group this banner belongs to.

Example: FCCMMOKY988K234

slot_idstringrequired

The slot identifier echoed from the request.

Example: HOME-PAGE-DAILY-UAE5

rich_media_payloadobject

Required if you have configured custom template while creating ad banner. Key-value pairs of predefined asset IDs and values you set when creating the ad banner. Use these in your frontend to overlay custom CTA buttons, logos, and disclaimers natively on the page.

banner_idstring

ID of the ad banner FCC is serving.

Example: FCCOUIHGWI6WISQ

advertiser_idstring

ID of the advertiser account for this ad banner.

Example: FCCGB6FKTHJJU3A

]

nbrinteger

Present when seatbid is absent.

0: No ads available
1: Technical error
2: Validation failure; FCC populates ext.errors

Possible values: [0, 1, 2]

ext object

Optional. Extension object for listing response-level errors.

errorsstring[]

List of errors FCC returns with the response.

Example: ["Invalid Ext Block"]

DSPAdResponse
{
  "id": "a7sIT125",
  "seatbid": [
    {
      "bid": [
        {
          "id": "AL2PPRCAAAAAGIAAB_1_DF456GF5GD",
          "impid": "OSGMz25",
          "adm": "{\"version\":\"1.0\",\"assets\":[{\"id\":-1156179165,\"img\":{\"type\":0,\"url\":\"http://abc.com/flap-image/96d2660f51d748bf.jpg\",\"width\":640,\"height\":1440},\"native\":{\"value\":\"http://xyz.com\",\"type\":\"LP\"}}],\"impUrls\":[\"http://abc.com/adImpression?pl=sgZUyf1P5jiFimOVV0hqmcm0sljwUuJBPIRFpFyVIqShpstMGcpzV4LIEKOjY72bSQOTwRwZ0EbrZRJX73x7LQQcvgV5TfCGeFgFSBdkLCMLTjiMQs3Lo4cVyS6vkrfGREzz3n6yrmAFwhbb68CQsnOsyYfdTe6WcjFJxqJUh08\"],\"viewUrls\":[\"http://abc.com/adView?pl=sgZUyf1P5jiFimOVV0hqmcm0sljwUuJBPIRFpFyVIqShpstMGcpzV4LIEKOjY72bSQOTwRwZ0EbrZRJX73x7LQQcvgV5TfCGeFgFSBdkLCMLTjiMQs3Lo4cVyS6vkrfGREzz3n6yrmAFwhbb68CQsnOsyYfdTe6WcjFJxqJUh08&vst=[STARTTIME]&vet=[ENDTIME]\"],\"clickUrls\":[\"http://abc.com/adClick?pl=sgZUyf1P5jiFimOVV0hqmcm0sljwUuJBPIRFpFyVIqShpstMGcpzV4LIEKOjY72bSQOTwRwZ0EbrZRJX73x7LQQcvgV5TfCGeFgFSBdkLCMLTjiMQs3Lo4cVyS6vkrfGREzz3n6yrmAFwhbb68CQsnOsyYfdTe6WcjFJxqJUh08&cet=[EVENTTIME]\"]}",
          "ext": {
            "ad_group_id": "FCCMMOKY988K234",
            "slot_id": "HOME-PAGE-DAILY-UAE5",
            "rich_media_payload": {},
            "banner_id": "FCCOUIHGWI6WISQ",
            "advertiser_id": "FCCGB6FKTHJJU3A"
          }
        }
      ]
    }
  ],
  "nbr": 0,
  "ext": {
    "errors": [
      "Invalid Ext Block"
    ]
  }
}