Note: This reference applies whether your container is hosted in Index Cloud or on your own infrastructure (partner-hosted). The fields and privacy rules described here are the same for both deployment models.
This reference describes the fields included in the outbound request at 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. 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. extension point, and how privacy settings affect each field. For the shading logic that consumes these fields, see Implementing bid shading.
RTBRequest
The outbound request contains the following top-level fields:
| Field | Notes |
|---|---|
| Time budget for the request, in milliseconds |
| Identifies the originator type as DSP - |
| Index's interpretation used to identify the DSP |
| Identifies the request as a DSP bid response request - |
| UUID generated for the request |
| Contains the bid response payload that was returned to the DSP for the |
| Contains the bid request |
| List of intents applicable to this request - |
How privacy settings affect this data
Specific fields containing personally identifiable information (PII) are anonymized, masked, or omitted based on the request user's consent status.
DPA opt-out: Providers that opt out of the data provider agreement are opted out of receiving PII entirely.
Consent anonymization: This applies when the provider is not registered in the CMP, or if the user has not provided consent to share data with that provider.
RTBRequest.bid_request
The bid_request object contains the following fields:
| Field | Notes |
|---|---|
| As provided |
| As provided. Page URL is sanitized - query string, fragment, and embedded credentials are removed |
| As provided |
| As provided, if |
| May be partially masked or withheld depending on privacy settings |
| May be partially masked depending on privacy settings |
| May be withheld depending on privacy settings |
| May be withheld depending on privacy settings |
| May be withheld depending on privacy settings |
| May be withheld depending on privacy settings |
| May be withheld depending on privacy settings |
| As provided, if |
| As provided, if |
| As provided, if |
| As provided, if |
| As provided, if |
| As provided, if |
| As provided, if |
| As provided, if |
| As provided, if |
| As provided, if |
| As provided, if |
| As provided, if |
| As provided, if |
| As provided, if |
| As provided, if |
| As provided, if |
| As provided, if |
| As provided, if |
| As provided, if |
| As provided, if |
| As provided, if |
| As provided, if |
| As provided, if |
| May be rounded or withheld depending on privacy settings |
| May be rounded or withheld depending on privacy settings |
| May be withheld depending on privacy settings |
| May be withheld depending on privacy settings |
| May be withheld depending on privacy settings |
| May be withheld depending on privacy settings |
| May be withheld depending on privacy settings |
| May be partially masked or withheld depending on privacy settings |
| As provided, if |
| As provided, if |
| As provided, if |
| May be withheld entirely depending on privacy settings |
| As provided, if |
| As provided, if |
| May be withheld depending on privacy settings |
| As provided, if |
| As provided, if |
| As provided, if |
| As provided, if |
| As provided, if |
| As provided, if |
| As provided, if |
| As provided |
| As provided |
| As provided |
| As provided |
| As provided |
| As provided |
| As provided |
| As provided |
RTBRequest.bid_response
The bid_response object contains the following fields:
| Field | Notes |
|---|---|
| As provided |
| As provided |
| As provided |
| As provided |
| As provided |
| As provided |
| As provided |
| As provided |
| As provided |
| As provided |
| As provided |
| As provided |