Response Ext Object

Note

Fields marked with asterisk (*) are optional.

Response Ext Object Properties

Value	Type	Description
igbid*	array of objects	An array of Interest group bid objects. The length of the array can be either 1+ (for yes-bid) or 0 (for no-bid). Can be present even if seatbid object is empty or missing

Interest Group Bids Object

Interest Group Bids Object Properties

Value	Type	Description
impid	string	Refers to the adslot being bid on, the ID should match original request imp.id field
igbuyer	array of objects	Contains data specific to each buyer participating in this interest group impression opportunity
ignurl	string	The Interest Group based impression notification URL provided by BidSwitch, see the Impression counting section

Interest Group Buyer Object

Interest Group Buyer Object Properties

Value	Type	Description
origin	string	The origin domain of the owner of the interest group. It should match the origins where the generateBid() functions are hosted
buyerdata*	json	Buyer-specific signals used by the buyer’s interest group bidding function. Can be left empty if perBuyerSignals are not required by the buyer bidding function
seat*	string	The seat ID of the bidder on whose behalf this bid is made. Required for multishot bidding
maxbid*	double	Maximum Interest Group bid price expressed in CPM currency that a bidder agrees to pay if they win an in-browser Interest Group auction expressed expressed in the currency denoted by the cur attribute. Actual winning bid in the in-browser auction that determines the amount a bidder pays for the impression may be lower than this amount. This constraint reduces the risks from in-browser auction bids submitted in error or reported due to fraud and abuse.
cur*	string	Indicates the currency in which Interest Group bids will be placed. The maxbid field should always match the cur value. Value must be a three digit ISO 4217 alpha currency code. The default value is USD.
ps*	object	The buyer’s priority signals, an object mapping string keys to Javascript numbers.

{
  "id": "1234567890",
  "ext": {
    "protocol": "5.3",
    "true_price_opt_out": 1
    "igbid":[
      {
        "impid":"adslot ID",
        "ignurl":"https://example.bidswitch.net/imp_paapi/${AUCTION_PRICE}/_HsPFfA4ea_O5Gpq_0KlrFEZ",
        "igbuyer":[
          {
            "origin":"https://fledge.example.com",
            "buyerdata":{
              "custom_field_1":"value_1"
            },
            "seat":"123",
            "maxbid": 0.75,
            "cur": "USD",
            "ps":{
              "custom_field_3": 1
            }
          }
        ]
      }
    ]
  }
}