List of supported OpenRTB bid response fields for sellers

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's top-level Bid Request object.

bid

Array of objects; always sent

One or more Bid objects.

seat

String; always sent

A unique identifier of the trading desk that entered this bid (also known as a buyer identifier). The identifier could be in one of the following formats:

• mediumintunsigne
• 0 to 16777215

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 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

Array of strings; 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 ID and may additionally contain deal-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, 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 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 when a winning bid becomes billable based on the Media Owner'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.

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. For more information, see the SKAdNetwork extension object.

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 information.

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.

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, and anti-fraud.

• 3 = Precise geolocation. The precise real-time geolocation of the user, i.e. GPS coordinates within 500 meter radius precision.

version

String; sometimes sent

The version of SKAdNetwork. 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 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.

Array of objects; 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 media owner’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.

fidelity

Integer; optional

The fidelity-type of the attribution to track. For 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. For example, "timestamp": "1594406341".

signature

String; optional

SKAdNetwork signature as specified by Apple. For example, "signature": "MEQCIEQlmZRNfYzK…".

ext

Object; optional

Placeholder for Index-specific extensions.

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 and using Index's outstream 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.