BidRequest.allimps
Flag for whether the impressions in this request are all the impressions available in that context, such as every slot on a page or every spot in a video break: 1 means yes, 0, the default, means no or unknown.
Field facts
- Path
allimps- Object
- BidRequest
- Type
- integer
- Default
0- Requirement
- Optional
- Added
- OpenRTB 2.0
- Spec section
- 3.2.1
How it is used
Roadblock buyers need to know they are seeing the whole set before bidding to win every placement, usually with SeatBid.group set to 1. Set 1 only when the exchange can actually verify that nothing else is on offer.
Allowed values
0, 1.
Example
Where the field sits in a payload, with everything else left out:
{
"id": "req-1",
"allimps": 1
}Common mistakes
- Setting 1 when other slots on the same page are sold through a different path, which misleads roadblock buyers.
Version history
Added in OpenRTB 2.0, and present in the latest snapshot. The table shows how each version's spec text types the field.
| Versions | Type in the spec | Required | Deprecated |
|---|---|---|---|
| 2.0 | integer E i o c a i [ t v e i p e m r a | No | No |
| 2.1 to 2.2 | integer E i o c a i [ e t i i p e m r a | No | No |
| 2.3 to 2.4 | integer, default 0 | No | No |
| 2.5 | integer | No | No |
| 2.6-202210 to 2.6-202606 | integer, default 0 | No | No |
Related fields
Other BidRequest fields
For a walkthrough of the whole object, read Bid request anatomy.