List of supported OpenRTB bid response fields for sellers

Index Exchange (Index) sends a bid response An OpenRTB response that is sent by the DSP in response to the SSP's or ad exchange's bid request. It is an event directed back to the seller expressing a valuation for the request and conditions of sale. after receiving a bid request from a seller A supply partner that sells their own inventory or on behalf of a publisher.. The response contains the bid price and the other details of the bid.

The following tables provide the fields that Index can include in the bid responses. All fields are case-sensitive.

Bid Response object

Attribute	Type	Description
`cur`	string; always sent	The currency of this bid.
`ext`	object; always sent	The Response Extension Object.
`id`	string; always sent	The unique identifier for the bid response. This value is equal to the `id` field value of the bid request An OpenRTB request that is sent from a supply-side platform (SSP) or ad exchange to the DSP requesting a bid response for potential impressions. A bid request contains information about the impression that allows the DSP to decide whether to bid on the impression.'s top-level Bid Request Object.
`seatbid`	object; always sent	The Seat Bid Object. See the table below.

Seat Bid object

Attribute	Type	Description
`bid`	object array; always sent	One or more Bid Objects
`seat`	string; always sent	A unique identifier of the trading desk A buyer in the RTB exchange. Trading desks integrate with DSPs to participate in the auctions that occur each time an impression is served. A single trading desk may be connected to one or more DSPs. The pairing of a single trading desk with a single DSP represents an advertiser user in our system. that entered this bid (also known as a buyer identifier). The identifier could be in one of the following formats: mediumintunsigne 0 to 16777215

Bid object

Attribute	Type	Description
`adid`	string; always sent	The ID of a preloaded ad to be served if the bid wins.
`adm`	string; always sent	The actual ad markup. XHTML, if responding to a Banner Object, VAST Video ad-serving template (VAST). A communication standard between ad servers and video players in XML-format that describes the video player's expected behavior. XML if responding to a Video Object, and JSON if responding to a Native Object. For native ads, the contents of the `adm` are to be sent as an outer native wrapper object. For more information about the supported bid response fields, see List of supported OpenRTB bid response fields for native ads for Sellers Note: This value must include the notification macro.
`adomain`	string array; always sent	A single-element array of the domain/landing page/brand to identify the advertiser (buyer). The value is limited to 128 characters.
`ext`	object; always sent	A custom Index Exchange Bid extension object which always contains the DSP Demand-Side Platform (DSP). A software platform that automates bidding decisions in real-time and efficiently connects buyers and audiences through an ad exchange or SSP. Also known as a buy-side platform. ID and may additionally contain deal A private auction that allows publishers to offer specific inventory directly to selected buyers identified by a deal ID. Terms are negotiated and are agreed upon before the auction occurs.-based information for this bid.
`id`	string; always sent	The unique identifier assigned by Index for this bid.
`impid`	string; always sent	The unique identifier for this impression. This value is equal to the `id` field value in the bid request Impression Object.
`price`	float; always sent	The bid price in CPM Cost Per Thousand (CPM). A pricing structure for buying impressions and is the cost of serving an advertisement 1,000 times. Also known as Cost Per Mille (where M represents 1,000 in Roman numerals) or Cents Per Mille., in dollars. The CPM value respects the following format: One or more numeric digits Optional period followed by one or two digits Note: If requested during integration, the bid price could be sent in cents.
`bundle`	string; sometimes sent	The bundle or package name (for example, `com.foo.mygame`) of the app being advertised, if applicable; it is intended to be a unique ID across exchanges.
`crid`	string; sometimes sent	An identifier used to reference the creative A digital ad made available in various creative types, defined by their size in pixels such as 300x250px. in the bid response.
`dealid`	string; sometimes sent	The unique identifier for the direct deal associated with this bid. If in response to a direct deal, the value of this field is equal to the `id` provided in the bid request Deal Object. Note: This value is equal to `deal` in the Bid Extension Object.
`dur`	integer; sometimes sent	The duration, in seconds, of the video or audio creative.
`burl`	string; sometimes sent	The billing notice URL called by a publisher The owner of a website or app where advertisements are served. when a winning bid becomes billable based on the publisher's billing counting logic. To learn more about the `burl` workflow at Index, see Using burl to send billing notifications. Note: Not enabled by default. Contact an Index Representative if you support `burl` and want to enable it with Index. For non-app requests, Index appends the `burl` into the `adm` field.
`exp`	integer; optional	The number of seconds the bidder is willing to wait between the auction and the actual impression.

Bid Extension object

Attribute	Type	Description
`dsa`	Object; optional	A DSA object that contains Digital Services Act (DSA) transparency information, in response to what was requested in the bid request. For more information about the DSA, see the Digital Services Act (DSA) documentation. For more information about how Index supports the DSA, see Policy and regulations.
`dspid`	integer; always sent	The unique identifier assigned to the DSP entering the bid.
`advbrand`	string; sometimes sent	The brand name of the advertiser entering the bid.
`advbrandid`	integer; sometimes sent	The unique identifier for the advertiser brand.
`deal`	integer; sometimes sent	The unique identifier for the deal used. Note: This value is equal to `dealid` in the Bid Extension Object. See the `dealid` field below.
`dealid`	string; sometimes sent	The unique identifier for the direct deal associated with this bid. If it is sent in response to a direct deal, the value of this field is equal to the `id` provided in the bid request Deal Object. Note: This value is equal to `deal` in the Bid Extension Object. See the `deal` field above.
`dealname`	string; sometimes sent	The name of the deal used in the bid. Index uses Punycode to encode all deal names containing UTF-8 characters. We also add the `xn--` prefix. For example, a deal name prior to Punycode encoding is: `TestDeal – TestDSP – 5,00 €`. The same deal name after Punycode encoding, with the `xn--` prefix is: `xn--TestDeal TestDSP 5,00 -jaj4d11aka17ev5clai`.
`skadn`	object; sometimes sent	A `skadn` object passed as received from the DSP. See SKAdNetwork extension object below.

DSA object

Attribute	Type	Description
`adrender`	Integer; optional	A flag that specifies if the buyer/advertiser will render their own DSA transparency information inside the creative, where: `0` = The buyer/advertiser will not render DSA information. `1` = The buyer/advertiser will render DSA ifnormation.
`behalf`	String; optional	A UNICODE text string with the name of the advertiser/buyer on whose behalf the ad is displayed, up to a maximum of 100 characters. For example, `"Advertiser1"`.
`paid`	String; optional	A UNICODE text string with the name of the advertiser/buyer who paid for the ad, up to a maximum of 100 characters. For example, `"Advertiser1"`. Note: This field must always be included for DSA-related responses, even if the value is the same as what is included in the `behalf` field.
`transparency`	Array of objects; optional	An array of Transparency objects that contain the entities that applied user parameters and the parameters they applied.

Transparency object

Field Type Description

Field	Type	Description
`domain`	String; optional	The domain of the entity that applied the user parameters in the `dsaparams` field for targeting. For example, `"platform1domain.com"`.
`dsaparams`	Array of integers; optional	An array of any buy-side applied user parameters that were used in targeting this user, where: `1` = Profiling. Includes information about the user, collected and used across contexts, that is about the user's activity, interests, demographic information, or other characteristics. `2` = Basic advertising. Includes the use of real-time information about the context in which the ad will be shown, including information about the content and the device, such as: device type and capabilities, user agent, URL, IP address, and non-precise geolocation data. Additionally, any use of basic cross-context information that is not based on user behavior or user characteristics, for uses such as frequency capping, sequencing, brand safety A safe environment for advertising. Brand safety involves not depicting a brand on a site that contains controversial and/or extremist content, regardless of user engagement., and anti-fraud. `3` = Precise geolocation. The precise real-time geolocation of the user, i.e. GPS coordinates within 500 meter radius precision.

domain

String; optional

The domain of the entity that applied the user parameters in the dsaparams field for targeting. For example, "platform1domain.com".

dsaparams

Array of integers; optional

An array of any buy-side applied user parameters that were used in targeting this user, where:

1 = Profiling. Includes information about the user, collected and used across contexts, that is about the user's activity, interests, demographic information, or other characteristics.
2 = Basic advertising. Includes the use of real-time information about the context in which the ad will be shown, including information about the content and the device, such as: device type and capabilities, user agent, URL, IP address, and non-precise geolocation data. Additionally, any use of basic cross-context information that is not based on user behavior or user characteristics, for uses such as frequency capping, sequencing, brand safety A safe environment for advertising. Brand safety involves not depicting a brand on a site that contains controversial and/or extremist content, regardless of user engagement., and anti-fraud.
3 = Precise geolocation. The precise real-time geolocation of the user, i.e. GPS coordinates within 500 meter radius precision.

SKAdNetwork extension object

If the bid request included the BidRequest.imp.ext.skadn object, then a DSP could include the following object in their bid response. For more information on submitting the correctly formatted values, see Apple’s documentation. If the object is present in the response, then the SSP Supply-Side Platform (SSP). A software platform used by publishers to automate real-time inventory sales to advertisers through an ad exchange or DSP. Also known as the sell-side. would submit the click data and signature to loadProduct() for attribution.

Attribute	Type	Description
`version`	string; sometimes sent	The version of SKAdNetwork desired. Must be 2.0 or above.
`network`	string; sometimes sent	The ad network identifier used in the signature. It should match one of the items in the `skadnetids` array in the request.
`campaign`	string; sometimes sent	The campaign A collection of multiple ads in different formats. ID compatible with Apple’s spec. In version 2.0, it should be an integer between 1 and 100, expressed as a string.
`itunesitem`	string; sometimes sent	The ID of advertiser’s app in Apple’s app store. It should match `BidResponse.seatbid.bid.bundle`.
`fidelities`	Objects array; optional	An object containing the multiple fidelity types introduced in SKAdNetwork v2. See the Fidelities object table below.
`nonce`	string; sometimes sent	An id unique to each ad response. To learn more, see Apple’s documentation for the proper UUID format requirements.
`sourceapp`	string; sometimes sent	The ID of publisher’s app in Apple’s app store. It should match `BidRequest.imp.ext.skad.sourceapp`.
`timestamp`	string; sometimes sent	The unix time in millis string used at the time of signature.
`signature`	string; sometimes sent	The SKAdNetwork signature as specified by Apple.

Fidelities object

Fields that should have different values for the different fidelity types such as fidelity, nonce, and signature are wrapped into an array of objects.

Attribute	Type	Description
`fidelity`	Integer; optional	The fidelity-type of the attribution to track. Example: "fidelity": 0
`nonce`	String; optional	An ID unique to each ad response. For more information, see Apple’s documentation for the proper UUID format requirements.
`timestamp`	String; optional	The Unix time in millis string used at the time of signature. Example: "timestamp": "1594406341"
`signature`	String; optional	SKAdNetwork signature as specified by Apple. Example: "signature": "MEQCIEQlmZRNfYzK…"
`ext`	Object; optional	Placeholder for Index-specific extensions.

Response Extension object

Attribute Type Description

Attribute	Type	Description
`protectedAudienceAuctionConfigs`	Object; optional	Info: Starting in June 2025, Index has paused support for the Protected Audience API. As a result an on-device auction won't be performed. If you are using the Protected Audience API, this field includes a list of bid IDs and the auction configuration object that specifies the parameters of the auction for a given seller. For information about the parameters that are passed in this object, see Google’s TURTLEDOVE Protected Audience API documentation. To see an example of the fields included in the `protectedAudienceAuctionConfigs` object, see Examples of OpenRTB bid requests and responses. For more information about using the Protected Audience API with Index, see Receive Protected Audience API demand from Index using Prebid.js.
`ssl`	Integer; always sent	Specifies that the bid response contains secure HTTPS URL creative assets and markup, where: `1` = response contains secure assets and markup `0` = response is not secure
`videoplayerurl`	String; optional	If you are using Index as a bidding adapter in Prebid.js An open-source library for publishers to implement header bidding on their websites and manage multiple header bidding partners. and using Index's outstream An ad placement where the video is not the focal point of the screen and plays with sound-off by default. They can display before, between, or after text, or accompanying streaming content (pre-roll, mid-roll, and post-roll ads), as an interstitial ad, or display as a standalone ad such as slideshows or native feeds. ad unit to render outstream video ads, the `videoplayerurl` is Index's video player URL that displays the video ad on the user's device. For more information about Index's outstream ad unit, see Configure outstream video ads in Prebid.js using Index's outstream ad unit .

protectedAudienceAuctionConfigs

Object; optional

Info: Starting in June 2025, Index has paused support for the Protected Audience API. As a result an on-device auction won't be performed.

If you are using the Protected Audience API, this field includes a list of bid IDs and the auction configuration object that specifies the parameters of the auction for a given seller. For information about the parameters that are passed in this object, see Google’s TURTLEDOVE Protected Audience API documentation. To see an example of the fields included in the protectedAudienceAuctionConfigs object, see Examples of OpenRTB bid requests and responses.

For more information about using the Protected Audience API with Index, see Receive Protected Audience API demand from Index using Prebid.js.

ssl

Integer; always sent

Specifies that the bid response contains secure HTTPS URL creative assets and markup, where:

1 = response contains secure assets and markup
0 = response is not secure

videoplayerurl

String; optional

If you are using Index as a bidding adapter in Prebid.js An open-source library for publishers to implement header bidding on their websites and manage multiple header bidding partners. and using Index's outstream An ad placement where the video is not the focal point of the screen and plays with sound-off by default. They can display before, between, or after text, or accompanying streaming content (pre-roll, mid-roll, and post-roll ads), as an interstitial ad, or display as a standalone ad such as slideshows or native feeds. ad unit to render outstream video ads, the videoplayerurl is Index's video player URL that displays the video ad on the user's device. For more information about Index's outstream ad unit, see Configure outstream video ads in Prebid.js using Index's outstream ad unit .