Response Bid Object¶

Note

(*) Fields marked with an asterisk are optional.
While individually neither of the following fields is required, one of them must be in the response: adm, adm_native.

Bid Object Properties¶
Value	Type	Description
id	string	A bidder generated ID for the bid object, used for tracking and debugging purposes, for example `3`.
impid	string	The ID of the impression object (`imp`) from the bid request to which this bid response applies, for example `"1"`
price	float	The bid price as a float value, expressed as CPM. All prices assumed to be in USD if the `cur` parameter is omitted, for example `1.23`
protocol*	integer	The Video response protocol of the markup if applicable, see the Video Response Protocols table for the valid values. Note: This field is required in video responses.
adm*	string	Used to pass creative markup for display (banner), video, or audio ads. One of either `adm` or `adm_native` should be present in the response. This field can contain the win price macro. This field is not used for native bid responses. `<a href=\"http://adserver.com/click?adid=125\"> <img src=\"http://image1.cdn.com/impid=102\"/></a>`
adm_native*	object	Used for native bid responses, see the Native Response Object for the data it contains. One of either `adm` or `adm_native` should be present in the response.
burl	string	The Billing notice URL called by the exchange using a server-to-server call when a winning bid becomes billable based on exchange-specific business policy (e.g., typically delivered, viewed, etc.).” This field should contain the win price macro, see the Macros section. `"burl":"https://adserver.com/winnotice?impid=102&winprice=${AUCTION_PRICE}"`
iurl*	string	Sample image URL (without cache busting) for content checking. REQUIRED when bidding on on banner bid requests. `"http://adserver.com/preview?impid=102"`
language*	string	The Alpha-2 ISO 639-1 code for the creative’s language, for example, `ja`. The nonstandard code `"xx"` may also be used if the creative has no linguistic content (e.g., a banner with just a company logo).
adomain	array of strings	Advertiser’s primary or top-level domain for advertiser checking. This can be a list of domains if there is a rotating creative. Note that some Suppliers allow only one domain. To those Suppliers BidSwitch only sends the first domain from the list, for example, `["advertiser.com"]`
cat*	array of strings	Array of IAB content categories, for example, `["IAB1", "IAB2-3"]`. Based on the IAB taxonomy, and extended with additional sensitive categories listed in the Sensitive Categories and Rich Media section.
cid*	string	Campaign ID or similar that is used by the Buyer to track and organize their campaigns, for example, `102`.
crid	string	Creative ID to assist with ad quality checking, for example `“3021”`
attr*	array of integers	Creative attributes as defined in the OpenRTB protocol, for example, `[1,3]`.
dealid*	string	Reference to the `deal.id` from the bid request, if this bid pertains to a private marketplace direct deal, for example, `"AA-1234"`
h*	integer	The height of the creative in pixels when an alternative ad size is used, relevant for banner ads only. `250`
w*	integer	The width of the creative in pixels when an alternative ad size is used, relevant for banner ads only. `300`
ext*	object	This field can be used to supply information about the creative agency for whom the Buyer is working, see the Bid Ext Object section below for details.

Bid Ext Object¶

Bid Ext Object Properties¶
Value	Type	Description
advertiser_name*	string	The name of the advertiser serving the creative, for example, `"Coca-Cola"`
agency_name*	string	The name of the agency representing the advertiser, for example, `"CCA"`
agency_id*	string	ID of the agency representing the advertiser, for example, `“123”`
data*	array of object	Returns arbitrary data from the Buyer, each object can take data.name and data.value to describe the data, see the Data Response Object for more details.
skadn*	object	Apple Ad Network Object, this will be used to pass app data from iOS 14 and newer releases. See SkAdNetwork Extension

SkAdNetwork Extension¶

skadn Ext Object Properties¶
Value	Type	Description
version*	str	Version of SKAdNetwork desired. Must be “2.0” or above.
network*	str	Ad network identifier used in signature. Should match one of the items in the `imp.ext.skadnetids` array in the request
campaign*	str	Campaign ID compatible with Apple’s spec. As of 2.0, this should be an integer between 1 and 100, expressed as a string, e.g. `"45"`
itunesitem*	str	ID of advertiser’s app in Apple’s app store. Should match the `app.bundle` request field e.g `"880047117"`
nonce*	str	An ID unique to each ad response (GUID/UUID) e.g. `"beeeb65e-b3de-02420004"`
sourceapp*	str	ID of publisher’s app in Apple’s app store, this should match the `imp.ext.skadn.sourceapp` value
timestamp*	str	Unix time in millis string used at the time of signature
signature*	str	SKAdNetwork signature as specified by Apple e.g. `"MEQCIEQZRRyMyUXg=="`

{
  "ext":{
    "advertiser_name":"Coca-Cola",
    "agency_name":"CC-advertising",
    "data":[
      {
        "name":"TUV",
        "value":"ABC123"
      }
    ],
    "skadn":{
      "version":"2.0",
      "network":"cDkw7geQsH.skadnetwork",
      "campaign":"45",
      "itunesitem":"880047117",
      "nonce":"473b1a16-b4ef-43ad-9591-fcf3aefa82a7",
      "sourceapp":"123456789",
      "timestamp":"1594406341",
      "signature":"2RmFS7daRzSVZRVZ8RyMyUXg=="
    }
  }
}

Video Response Protocols¶

Video Response Protocols¶
Value	Type
1	VAST 1.0
2	VAST 2.0
3	VAST 3.0
4	VAST 1.0 Wrapper
5	VAST 2.0 Wrapper
6	VAST 3.0 Wrapper
7	VAST 4.0
8	VAST 4.0 Wrapper
9	DAAST 1.0
10	DAAST 1.0 Wrapper