Pmp.private_auction

Whether the impression is restricted to the listed deals: 1 means only bids on those deals, under their terms, are accepted; 0 means open-market bids are accepted too. Default 0 since OpenRTB 2.4; 2.2 and 2.3 stated no default.

CurrentintegerOptionalSince 2.2

Field facts

Path: imp.pmp.private_auction
Object: Pmp
Type: integer
Default: 0
Requirement: Optional
Added: OpenRTB 2.2
Spec section: 3.2.11

How it is used

Buyers must read it before sending open-market bids. With 1, a bid without a matching Bid.dealid falls outside the terms and is likely to be rejected.

Allowed values

0, 1.

Example

Where the field sits in a payload, with everything else left out:

{
  "id": "req-1",
  "imp": [
    {
      "pmp": {
        "private_auction": 1
      }
    }
  ]
}

Common mistakes

Sending true or false. In spec JSON it is an integer flag, and the validator reports openrtb.dialect.bool_for_integer.
Sending privateAuction, the default protobuf JSON spelling. A JSON reader does not see it, so a private auction reads as open. In spec JSON the validator reports openrtb.field.undefined; with the proto-json dialect it reports openrtb.dialect.camel_case_name.
Setting 1 with no deals listed, which leaves no bid that can be accepted.

Version history

Added in OpenRTB 2.2, 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.2	integer	No	No
2.3 to 2.3.1	integer	No	No
2.4	integer, default 0	No	No
2.5 to 2.6-202606	integer, default 0	No	No

Related fields

Other Pmp fields

For a walkthrough of the whole object, read Deals and PMP.