Bid Response JSON Examples¶

If the Buyer opts to not bid on the bid request, it should respond with a HTTP 204 response. BidSwitch also accepts bid responses with an empty array of seatbid objects as valid nobid responses.

Banner Bid Response¶

The following example shows an ad being served from the adm field, with the bid price for the impression being $9.43 CPM.

 {
   "id": "1234567890",
   "ext": {
     "protocol": "5.3"
   },
   "seatbid": [
     {
       "bid": [
         {
           "id": "1",
           "impid": "102",
           "price": 9.43,
           "adid": "314",
           "cid": "42",
           "cat": ["IAB12"],
           "language": "en",
           "burl":"https://adserver.com/imp?impid=102&winprice=${AUCTION_PRICE}",
           "adm": "<a href=\"http://adserver.com/click?adid=12345&tracker=${CLICK_URL:URLENCODE}\"><img src=\"http://image1.cdn.com/impid=102\"/></a>",
           "nurl": "http://adserver.com/winnotice?impid=102&winprice=${AUCTION_PRICE}",
           "iurl": "http://adserver.com/preview?crid=314",
           "adomain": [
             "advertiserdomain.com"
           ],
           "ext": {
             "advertiser_name": "Coca-Cola",
             "agency_name": "CC-advertising"
           }
         }
       ],
       "seat": "4"
     }
   ]
 }

Secure Banner Bid Response¶

The following example shows an ad being served from the adm field, with the bid price for the impression being $9.43 CPM, and suitable for serving in HTTPS environment.

{
  "id":"1234567890",
  "ext":{
     "protocol":"5.3"
  },
  "seatbid":[
     {
        "bid":[
           {
              "id":"1",
              "impid":"102",
              "price":9.43,
              "adid":"314",
              "cid":"42",
              "language": "en",
              "burl":"https://adserver.com/imp?impid=102&winprice=${AUCTION_PRICE}",
              "cat":[
                 "IAB12"
              ],
              "adm":"<a href=\"https://adserver.com/clickadid=12345&tracker=${CLICK_URL:URLENCODE}\"><img src=\"https://image1.cdn.com/impid=102\"/></a>",
              "nurl":"https://adserver.com/winnotice?impid=102&winprice=${AUCTION_PRICE}",
              "iurl":"http://adserver.com/preview?crid=314",
              "adomain":[
                 "advertiserdomain.com"
              ],
              "ext":{
                 "advertiser_name":"Coca-Cola",
                 "agency_name":"CC-advertising"
              }
           }
        ],
        "seat":"8"
     }
  ]
}

Response to iOS 14¶

Note

See the highlighted lines that denote the iOS 14 fields, see the Protocol Release Notes for more details.

{
  "id": "1234567890",
  "ext": {
    "protocol": "5.3"
  },
  "seatbid": [
    {
      "bid": [
        {
          "id": "1",
          "impid": "102",
          "price": 9.43,
          "adid": "314",
          "cid": "42",
          "language": "en",
          "burl": "https://adserver.com/imp?impid=102&winprice=${AUCTION_PRICE}",
          "cat": [
            "IAB12"
          ],
          "adm": "<a href=\"https://adserver.com/clickadid=12345&tracker=${CLICK_URL:URLENCODE}\"><img src=\"https://image1.cdn.com/impid=102\"/></a>",
          "nurl": "https://adserver.com/winnotice?impid=102&winprice=${AUCTION_PRICE}",
          "iurl": "http://adserver.com/preview?crid=314",
          "adomain": [
            "advertiserdomain.com"
          ],
          "ext": {
            "advertiser_name": "Coca-Cola",
            "agency_name": "CC-advertising",
            "data": [
              {
                "name": "TUV",
                "value": "ABC123"
              }
            ],
            "skadn": {
              "network": "cDkw7geQsH.skadnetwork",
              "campaign": "45",
              "itunesitem": "880047117",
              "sourceapp": "123456789",
              "fidelities": [
                {
                  "timestamp": "1594406341",
                  "signature": "2RmFS7daRzSVZRVZ8RyMyUXg==",
                  "nonce": "473b1a16-b4ef-43ad-9591-fcf3aefa82a7",
                  "version": "2.2"
                }
              ]
            }
          }
        }
      ],
      "seat": "8"
    }
  ]
}

Video Bid Response¶

{
   "cur":"USD",
   "ext":{
      "protocol":"5.3"
   },
   "id":"e9c3e120-ffcb-4300-9c98-644cb26f95df",
   "seatbid":[
      {
         "bid":[
            {
               "adid":"3",
               "nurl":"http://adserver.com/winnotice?impid=102&winprice=${AUCTION_PRICE}",
               "adomain":[
                  "nokia.com"
               ],
               "cid":"11",
               "language": "en",
               "burl":"https://adserver.com/imp?impid=102&winprice=${AUCTION_PRICE}",
               "ext":{
                  "vast_url":"http://adserver.com/vast?impid=102",
                  "duration":15,
                  "advertiser_name":"Nokia"
               },
               "id":"1c3ff810-3623-4b04-8396-9e7ca071cb72",
               "impid":"1",
               "price":4.079077199308326
            }
         ],
         "seat":"1"
      }
   ]
}

Secure Video Bid Response¶

{
  "cur":"USD",
  "ext":{
     "protocol":"5.3"
  },
  "id":"e9c3e120-ffcb-4300-9c98-644cb26f95df",
  "seatbid":[
     {
        "bid":[
           {
              "adid":"3",
              "language": "en",
              "burl":"https://adserver.com/imp?impid=102&winprice=${AUCTION_PRICE}",
              "nurl":"https://adserver.com/winnotice?impid=102&winprice=${AUCTION_PRICE}",
              "adomain":[
                 "nokia.com"
              ],
              "cid":"11",
              "ext":{
                 "vast_url":"https://adserver.com/vast?impid=102",
                 "duration":15,
                 "advertiser_name":"Nokia"
              },
              "id":"1c3ff810-3623-4b04-8396-9e7ca071cb72",
              "impid":"1",
              "price":4.079077199308326
           }
        ],
        "seat":"1"
     }
  ]
}

Secure Audio Bid Response¶

{
  "cur":"USD",
  "ext":{
     "protocol":"5.3"
  },
  "id":"e9c3e120-ffcb-4300-9c98-644cb26f95df",
  "seatbid":[
     {
        "bid":[
           {
              "adid":"3",
              "burl":"https://adserver.com/imp?impid=102&winprice=${AUCTION_PRICE}",
              "nurl":"https://adserver.com/winnotice?impid=102&winprice=${AUCTION_PRICE}",
              "adomain":[
                 "nokia.com"
              ],
              "cid":"11",
              "language": "en",
              "ext":{
                 "daast_url":"https://adserver.com/daast?impid=102",
                 "duration":15,
                 "advertiser_name":"Nokia"
              },
              "id":"1c3ff810-3623-4b04-8396-9e7ca071cb72",
              "impid":"1",
              "price":4.079077199308326
           }
        ],
        "seat":"1"
     }
  ]
}

Native Bid Response¶

The following example shows a native bid response

{
   "id":"1234567890",
   "ext":{
      "protocol":"5.3"
   },
   "seatbid":[
      {
         "bid":[
            {
               "id":"1",
               "impid":"102",
               "price":9.43,
               "adid":"314",
               "cid":"42",
               "language":"en",
               "burl":"https://adserver.com/imp?impid=102&winprice=${AUCTION_PRICE}",
               "cat":[
                  "IAB12"
               ],
               "nurl":"http://adserver.com/winnotice?impid=102&winprice=${AUCTION_PRICE}",
               "adomain":[
                  "advertiserdomain.com"
               ],
               "ext":{
                  "advertiser_name":"Coca-Cola",
                  "agency_name":"CC-advertising",
                  "native":{
                     "ver":"1",
                     "eventtrackers":[
                        {
                           "event":1,
                           "method":2,
                           "url":"http://www.mytracker.com/tracker.js"
                        },
                        {
                           "event":2,
                           "method":1,
                           "url":"http://www.example.com/tracker.php"
                        }
                     ],
                     "link":{
                        "url":"http://adserver.com/click?impid=102"
                     },
                     "assets":[
                        {
                           "id":1,
                           "required":1,
                           "title":{
                              "text":"A test Native Ad"
                           }
                        },
                        {

                        }
                     ]
                  }
               }
            }
         ],
         "seat":"58"
      }
   ]
}

Secure Native Bid Response¶

The following example shows a native bid response with the title and image asset specified for serving in an HTTPS environment.

{
   "id":"1234567890",
   "ext":{
      "protocol":"5.3",
      "id":3,
      "required":1,
      "img":{
         "url":"https://adserver.com/image?crid=314"
      }
   },
   "seatbid":[
      {
         "bid":[
            {
               "id":"1",
               "impid":"102",
               "price":9.43,
               "adid":"314",
               "cid":"42",
               "cat":[
                  "IAB12"
               ],
               "nurl":"https://adserver.com/winnotice?impid=102&winprice=${AUCTION_PRICE}",
               "adomain":[
                  "advertiserdomain.com"
               ],
               "language":"en",
               "burl":"https://adserver.com/imp?impid=102&winprice=${AUCTION_PRICE}",
               "ext":{
                  "advertiser_name":"Coca-Cola",
                  "agency_name":"CC-advertising",
                  "native":{
                     "ver":"1",
                     "link":{
                        "url":"https://adserver.com/click?impid=102"
                     },
                     "eventtrackers":[
                        {
                           "event":1,
                           "method":2,
                           "url":"http://www.mytracker.com/tracker.js"
                        },
                        {
                           "event":2,
                           "method":1,
                           "url":"http://www.example.com/tracker.php"
                        }
                     ],
                     "assets":[
                        {
                           "id":1,
                           "required":1,
                           "title":{
                              "text":"A test Native Ad"
                           }
                        },
                        {

                        }
                     ]
                  }
               }
            }
         ],
         "seat":"1"
      }
   ]
}

Multi-bid Response¶

Please pay attention to the following conditions:

The total size of your response should not exceed 50 kb
There can be 2 seatbid.bid objects within 1 seatbid object
A response containing two bids for the same impression should contain both bid objects within the same seatbid.bid array of objects

The following bid response example contains two bids, one for $9.43 CPM and one for $5.50 CPM. Both bids target the same ad slot, both would take part in the auction and if the first one is discarded due to publisher-side blocklist then the second one would be able to win the auction.

 {
    "id":"1234567890",
    "ext":{
       "protocol":"5.3"
    },
    "seatbid":[
       {
          "bid":[
             {
                "id":"1",
                "impid":"102",
                "price":9.43,
                "adid":"314",
                "cid":"42",
                "cat":[
                   "IAB12"
                ],
                "adm":"<a href=\"http://adserver.com/click?adid=12345&tracker=${CLICK_URL:URLENCODE}\"><img src=\"http://image1.cdn.com/impid=102\"/></a>",
                "nurl":"http://adserver.com/winnotice?impid=102&winprice=${AUCTION_PRICE}",
                "iurl":"http://adserver.com/preview?crid=314",
                "adomain":[
                   "advertiserdomain.com"
                ],
                "language":"en",
                "burl":"https://adserver.com/imp?impid=102&winprice=${AUCTION_PRICE}",
                "ext":{
                   "advertiser_name":"Coca-Cola",
                   "agency_name":"CC-advertising"
                }
             },
             {
                "id":"2",
                "impid":"102",
                "price":5.5,
                "adid":"413",
                "cid":"43",
                "cat":[
                   "IAB12"
                ],
                "adm":"<a href=\"http://adserver.com/click?adid=12345&tracker=${CLICK_URL:URLENCODE}\"><img src=\"http://image1.cdn.com/impid=102\"/></a>",
                "nurl":"http://adserver.com/winnotice?impid=413&winprice=${AUCTION_PRICE}",
                "iurl":"http://adserver.com/preview?crid=413",
                "burl":"https://adserver.com/imp?impid=102&winprice=${AUCTION_PRICE}",
                "adomain":[
                   "advertiserdomain.com"
                ],
                "ext":{
                   "advertiser_name":"Coca-Cola",
                   "agency_name":"CC-advertising"
                }
             }
          ],
          "seat":"1"
       }
    ]
 }

Private Deal Bid Response¶

{
  "id":"1234567892",
  "ext":{
     "protocol":"5.3"
  },
  "cur":"USD",
  "seatbid":[
     {
        "bid":[
           {
              "id":"1114125-afaff2f-af2251",
              "impid":"1",
              "price":9.43,
              "adid":"314",
              "burl":"https://adserver.com/imp?impid=102&winprice=${AUCTION_PRICE}",
              "dealid":"deal-1",
              "adm":"<a href=\"http://adserver.com/click?adid=12345&tracker=${CLICK_URL:URLENCODE}\"> <img src=\"http://image1.cdn.com/impid=102\"/></a>",
              "nurl":"http://adserver.com/winnotice?impid=102&winprice=${AUCTION_PRICE}",
              "adomain":[
                 "advertiserdomain.com"
              ]
           }
        ],
        "seat":"58"
     }
  ]
}

Buyer No Bid Response¶

The following example shows a No Bid Response coming from a Buyer, which is an empty bid response.

Note

The preferred No Bid Response format is an empty HTTP 204 response.

{
  "id": "1234567891",
  "ext": {
    "protocol": "5.3"
  },
   "seatbid": []
}

No Bid Reason¶

The following example shows a No Bid Reason response, which includes the reason code in the nbr field. See the Buyer No-bid Response / Reason section for more information.

{
   "id":"1234567890",
   "seatbid":[

   ],
   "nbr":11
}

TV/DOOH Bid Response¶

{
   "cur":"USD",
   "ext":{
      "protocol":"5.3"
   },
   "id":"e9c3e120-ffcb-4300-9c98-644cb26f95df",
   "seatbid":[
      {
         "bid":[
            {
               "adid":"3",
               "burl":"https://adserver.com/imp?impid=102&winprice=${AUCTION_PRICE}",
               "nurl":"http://adserver.com/winnotice?impid=102&winprice=${AUCTION_PRICE}",
               "adomain":[
                  "nokia.com"
               ],
               "cid":"11",
               "language":"en",
               "ext":{
                  "vast_url":"http://adserver.com/vast?impid=102",
                  "duration":15,
                  "advertiser_name":"Nokia"
               },
               "id":"1c3ff810-3623-4b04-8396-9e7ca071cb72",
               "impid":"1",
               "price":4.079077199308326
            }
         ],
         "seat":"1"
      }
   ]
}